blob: 1e4edbf70052bf5f6c8c0af06e0d7bf1812e80a5 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07002 * Server-side types for NFSv4.
3 *
4 * Copyright (c) 2002 The Regents of the University of Michigan.
5 * All rights reserved.
6 *
7 * Kendrick Smith <kmsmith@umich.edu>
8 * Andy Adamson <andros@umich.edu>
9 *
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 *
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in the
18 * documentation and/or other materials provided with the distribution.
19 * 3. Neither the name of the University nor the names of its
20 * contributors may be used to endorse or promote products derived
21 * from this software without specific prior written permission.
22 *
23 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED
24 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
25 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
26 * DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
29 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
30 * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
31 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
32 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
33 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 *
35 */
36
37#ifndef _LINUX_NFSD_XDR4_H
38#define _LINUX_NFSD_XDR4_H
39
Boaz Harrosh9a74af22009-12-03 20:30:56 +020040#include "state.h"
41#include "nfsd.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070042
43#define NFSD4_MAX_TAGLEN 128
44#define XDR_LEN(n) (((n) + 3) & ~3)
45
Tigran Mkrtchyan37c593c2012-02-13 22:55:32 +010046#define CURRENT_STATE_ID_FLAG (1<<0)
47#define SAVED_STATE_ID_FLAG (1<<1)
48
49#define SET_STATE_ID(c, f) ((c)->sid_flags |= (f))
50#define HAS_STATE_ID(c, f) ((c)->sid_flags & (f))
51#define CLEAR_STATE_ID(c, f) ((c)->sid_flags &= ~(f))
52
J.Bruce Fieldsca364312006-12-13 00:35:27 -080053struct nfsd4_compound_state {
Andy Adamsone354d572009-03-28 11:30:52 +030054 struct svc_fh current_fh;
55 struct svc_fh save_fh;
56 struct nfs4_stateowner *replay_owner;
Jeff Layton4b24ca72014-06-30 11:48:44 -040057 struct nfs4_client *clp;
Benny Halevyb85d4c02009-04-03 08:28:08 +030058 /* For sessions DRC */
59 struct nfsd4_session *session;
60 struct nfsd4_slot *slot;
J. Bruce Fieldsf5236012014-03-21 17:57:57 -040061 int data_offset;
Andrew Elbleed941642016-06-15 12:52:09 -040062 bool spo_must_allowed;
Andy Adamsonda3846a2009-04-03 08:28:22 +030063 size_t iovlen;
Andy Adamsond87a8ad2009-04-03 08:28:53 +030064 u32 minorversion;
J. Bruce Fields57b7b432012-04-25 17:58:50 -040065 __be32 status;
Tigran Mkrtchyan37c593c2012-02-13 22:55:32 +010066 stateid_t current_stateid;
67 stateid_t save_stateid;
68 /* to indicate current and saved state id presents */
69 u32 sid_flags;
J.Bruce Fieldsca364312006-12-13 00:35:27 -080070};
71
Andy Adamson66689582009-04-03 08:28:45 +030072static inline bool nfsd4_has_session(struct nfsd4_compound_state *cs)
73{
74 return cs->slot != NULL;
75}
76
Linus Torvalds1da177e2005-04-16 15:20:36 -070077struct nfsd4_change_info {
78 u32 atomic;
J. Bruce Fieldsc654b8a2009-04-16 17:33:25 -040079 bool change_supported;
Linus Torvalds1da177e2005-04-16 15:20:36 -070080 u32 before_ctime_sec;
81 u32 before_ctime_nsec;
J. Bruce Fieldsc654b8a2009-04-16 17:33:25 -040082 u64 before_change;
Linus Torvalds1da177e2005-04-16 15:20:36 -070083 u32 after_ctime_sec;
84 u32 after_ctime_nsec;
J. Bruce Fieldsc654b8a2009-04-16 17:33:25 -040085 u64 after_change;
Linus Torvalds1da177e2005-04-16 15:20:36 -070086};
87
88struct nfsd4_access {
89 u32 ac_req_access; /* request */
90 u32 ac_supported; /* response */
91 u32 ac_resp_access; /* response */
92};
93
94struct nfsd4_close {
95 u32 cl_seqid; /* request */
96 stateid_t cl_stateid; /* request+response */
Linus Torvalds1da177e2005-04-16 15:20:36 -070097};
98
99struct nfsd4_commit {
100 u64 co_offset; /* request */
101 u32 co_count; /* request */
102 nfs4_verifier co_verf; /* response */
103};
104
105struct nfsd4_create {
106 u32 cr_namelen; /* request */
107 char * cr_name; /* request */
108 u32 cr_type; /* request */
109 union { /* request */
110 struct {
J. Bruce Fields7fb84302014-06-24 15:06:41 -0400111 u32 datalen;
112 char *data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113 } link; /* NF4LNK */
114 struct {
115 u32 specdata1;
116 u32 specdata2;
117 } dev; /* NF4BLK, NF4CHR */
118 } u;
Andy Adamson7e705702009-04-03 08:29:11 +0300119 u32 cr_bmval[3]; /* request */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120 struct iattr cr_iattr; /* request */
121 struct nfsd4_change_info cr_cinfo; /* response */
122 struct nfs4_acl *cr_acl;
David Quigley18032ca2013-05-02 13:19:10 -0400123 struct xdr_netobj cr_label;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124};
J. Bruce Fields7fb84302014-06-24 15:06:41 -0400125#define cr_datalen u.link.datalen
126#define cr_data u.link.data
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127#define cr_specdata1 u.dev.specdata1
128#define cr_specdata2 u.dev.specdata2
129
130struct nfsd4_delegreturn {
131 stateid_t dr_stateid;
132};
133
134struct nfsd4_getattr {
Andy Adamson7e705702009-04-03 08:29:11 +0300135 u32 ga_bmval[3]; /* request */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136 struct svc_fh *ga_fhp; /* response */
137};
138
139struct nfsd4_link {
140 u32 li_namelen; /* request */
141 char * li_name; /* request */
142 struct nfsd4_change_info li_cinfo; /* response */
143};
144
145struct nfsd4_lock_denied {
146 clientid_t ld_clientid;
J. Bruce Fields7c13f342011-08-30 22:15:47 -0400147 struct xdr_netobj ld_owner;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148 u64 ld_start;
149 u64 ld_length;
150 u32 ld_type;
151};
152
153struct nfsd4_lock {
154 /* request */
155 u32 lk_type;
156 u32 lk_reclaim; /* boolean */
157 u64 lk_offset;
158 u64 lk_length;
159 u32 lk_is_new;
160 union {
161 struct {
162 u32 open_seqid;
163 stateid_t open_stateid;
164 u32 lock_seqid;
165 clientid_t clientid;
166 struct xdr_netobj owner;
167 } new;
168 struct {
169 stateid_t lock_stateid;
170 u32 lock_seqid;
171 } old;
172 } v;
173
174 /* response */
175 union {
176 struct {
177 stateid_t stateid;
178 } ok;
179 struct nfsd4_lock_denied denied;
180 } u;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700181};
182#define lk_new_open_seqid v.new.open_seqid
183#define lk_new_open_stateid v.new.open_stateid
184#define lk_new_lock_seqid v.new.lock_seqid
185#define lk_new_clientid v.new.clientid
186#define lk_new_owner v.new.owner
187#define lk_old_lock_stateid v.old.lock_stateid
188#define lk_old_lock_seqid v.old.lock_seqid
189
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190#define lk_resp_stateid u.ok.stateid
191#define lk_denied u.denied
192
193
194struct nfsd4_lockt {
195 u32 lt_type;
196 clientid_t lt_clientid;
197 struct xdr_netobj lt_owner;
198 u64 lt_offset;
199 u64 lt_length;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200 struct nfsd4_lock_denied lt_denied;
201};
202
203
204struct nfsd4_locku {
205 u32 lu_type;
206 u32 lu_seqid;
207 stateid_t lu_stateid;
208 u64 lu_offset;
209 u64 lu_length;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700210};
211
212
213struct nfsd4_lookup {
214 u32 lo_len; /* request */
215 char * lo_name; /* request */
216};
217
218struct nfsd4_putfh {
219 u32 pf_fhlen; /* request */
220 char *pf_fhval; /* request */
221};
222
223struct nfsd4_open {
224 u32 op_claim_type; /* request */
225 struct xdr_netobj op_fname; /* request - everything but CLAIM_PREV */
226 u32 op_delegate_type; /* request - CLAIM_PREV only */
227 stateid_t op_delegate_stateid; /* request - response */
Benny Halevyd24433c2012-02-16 20:57:17 +0200228 u32 op_why_no_deleg; /* response - DELEG_NONE_EXT only */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700229 u32 op_create; /* request */
230 u32 op_createmode; /* request */
Andy Adamson7e705702009-04-03 08:29:11 +0300231 u32 op_bmval[3]; /* request */
Kinglong Mee3ff69302013-12-05 10:41:40 +0800232 struct iattr op_iattr; /* UNCHECKED4, GUARDED4, EXCLUSIVE4_1 */
Chuck Leverab4684d2012-03-02 17:13:50 -0500233 nfs4_verifier op_verf __attribute__((aligned(32)));
234 /* EXCLUSIVE4 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235 clientid_t op_clientid; /* request */
236 struct xdr_netobj op_owner; /* request */
237 u32 op_seqid; /* request */
238 u32 op_share_access; /* request */
239 u32 op_share_deny; /* request */
Benny Halevy2c8bd7e2012-02-16 20:57:09 +0200240 u32 op_deleg_want; /* request */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241 stateid_t op_stateid; /* response */
J. Bruce Fields9d313b12013-02-28 12:51:49 -0800242 __be32 op_xdr_error; /* see nfsd4_open_omfg() */
NeilBrown7b190fe2005-06-23 22:03:23 -0700243 u32 op_recall; /* recall */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700244 struct nfsd4_change_info op_cinfo; /* response */
245 u32 op_rflags; /* response */
J. Bruce Fields856121b2011-10-13 11:37:11 -0400246 bool op_truncate; /* used during processing */
247 bool op_created; /* used during processing */
J. Bruce Fieldsfe0750e2011-07-30 23:33:59 -0400248 struct nfs4_openowner *op_openowner; /* used during processing */
J. Bruce Fields32513b42011-10-13 16:00:16 -0400249 struct nfs4_file *op_file; /* used during processing */
J. Bruce Fields4cdc9512011-10-17 15:57:47 -0400250 struct nfs4_ol_stateid *op_stp; /* used during processing */
Sachin Bhamare8287f002015-04-27 14:50:14 +0200251 struct nfs4_clnt_odstate *op_odstate; /* used during processing */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252 struct nfs4_acl *op_acl;
David Quigley18032ca2013-05-02 13:19:10 -0400253 struct xdr_netobj op_label;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255
256struct nfsd4_open_confirm {
257 stateid_t oc_req_stateid /* request */;
258 u32 oc_seqid /* request */;
259 stateid_t oc_resp_stateid /* response */;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260};
261
262struct nfsd4_open_downgrade {
263 stateid_t od_stateid;
264 u32 od_seqid;
Benny Halevy2c8bd7e2012-02-16 20:57:09 +0200265 u32 od_share_access; /* request */
266 u32 od_deleg_want; /* request */
267 u32 od_share_deny; /* request */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268};
269
270
271struct nfsd4_read {
272 stateid_t rd_stateid; /* request */
273 u64 rd_offset; /* request */
274 u32 rd_length; /* request */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275 int rd_vlen;
276 struct file *rd_filp;
Christoph Hellwigaf90f702015-06-18 16:45:00 +0200277 bool rd_tmp_file;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700278
279 struct svc_rqst *rd_rqstp; /* response */
280 struct svc_fh * rd_fhp; /* response */
281};
282
283struct nfsd4_readdir {
284 u64 rd_cookie; /* request */
285 nfs4_verifier rd_verf; /* request */
286 u32 rd_dircount; /* request */
287 u32 rd_maxcount; /* request */
Andy Adamson7e705702009-04-03 08:29:11 +0300288 u32 rd_bmval[3]; /* request */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700289 struct svc_rqst *rd_rqstp; /* response */
290 struct svc_fh * rd_fhp; /* response */
291
292 struct readdir_cd common;
J. Bruce Fields561f0ed2014-01-20 16:37:11 -0500293 struct xdr_stream *xdr;
294 int cookie_offset;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700295};
296
297struct nfsd4_release_lockowner {
298 clientid_t rl_clientid;
299 struct xdr_netobj rl_owner;
300};
301struct nfsd4_readlink {
302 struct svc_rqst *rl_rqstp; /* request */
303 struct svc_fh * rl_fhp; /* request */
304};
305
306struct nfsd4_remove {
307 u32 rm_namelen; /* request */
308 char * rm_name; /* request */
309 struct nfsd4_change_info rm_cinfo; /* response */
310};
311
312struct nfsd4_rename {
313 u32 rn_snamelen; /* request */
314 char * rn_sname; /* request */
315 u32 rn_tnamelen; /* request */
316 char * rn_tname; /* request */
317 struct nfsd4_change_info rn_sinfo; /* response */
318 struct nfsd4_change_info rn_tinfo; /* response */
319};
320
Andy Adamsondcb488a32007-07-17 04:04:51 -0700321struct nfsd4_secinfo {
322 u32 si_namelen; /* request */
323 char *si_name; /* request */
324 struct svc_export *si_exp; /* response */
325};
326
J. Bruce Fields04f4ad12010-12-16 09:51:13 -0500327struct nfsd4_secinfo_no_name {
328 u32 sin_style; /* request */
329 struct svc_export *sin_exp; /* response */
330};
331
Linus Torvalds1da177e2005-04-16 15:20:36 -0700332struct nfsd4_setattr {
333 stateid_t sa_stateid; /* request */
Andy Adamson7e705702009-04-03 08:29:11 +0300334 u32 sa_bmval[3]; /* request */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700335 struct iattr sa_iattr; /* request */
336 struct nfs4_acl *sa_acl;
David Quigley18032ca2013-05-02 13:19:10 -0400337 struct xdr_netobj sa_label;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700338};
339
340struct nfsd4_setclientid {
341 nfs4_verifier se_verf; /* request */
J. Bruce Fieldsa084daf2011-10-10 15:07:40 -0400342 struct xdr_netobj se_name;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700343 u32 se_callback_prog; /* request */
344 u32 se_callback_netid_len; /* request */
345 char * se_callback_netid_val; /* request */
346 u32 se_callback_addr_len; /* request */
347 char * se_callback_addr_val; /* request */
348 u32 se_callback_ident; /* request */
349 clientid_t se_clientid; /* response */
350 nfs4_verifier se_confirm; /* response */
351};
352
353struct nfsd4_setclientid_confirm {
354 clientid_t sc_clientid;
355 nfs4_verifier sc_confirm;
356};
357
Bryan Schumaker17456802011-07-13 10:50:48 -0400358struct nfsd4_saved_compoundargs {
359 __be32 *p;
360 __be32 *end;
361 int pagelen;
362 struct page **pagelist;
363};
364
Bryan Schumaker03cfb422012-01-27 10:22:49 -0500365struct nfsd4_test_stateid_id {
366 __be32 ts_id_status;
367 stateid_t ts_id_stateid;
368 struct list_head ts_id_list;
369};
370
Bryan Schumaker17456802011-07-13 10:50:48 -0400371struct nfsd4_test_stateid {
J. Bruce Fields57b7b432012-04-25 17:58:50 -0400372 u32 ts_num_ids;
Bryan Schumaker03cfb422012-01-27 10:22:49 -0500373 struct list_head ts_stateid_list;
Bryan Schumaker17456802011-07-13 10:50:48 -0400374};
375
Bryan Schumakere1ca12d2011-07-13 11:04:21 -0400376struct nfsd4_free_stateid {
377 stateid_t fr_stateid; /* request */
Bryan Schumakere1ca12d2011-07-13 11:04:21 -0400378};
379
Linus Torvalds1da177e2005-04-16 15:20:36 -0700380/* also used for NVERIFY */
381struct nfsd4_verify {
Andy Adamson7e705702009-04-03 08:29:11 +0300382 u32 ve_bmval[3]; /* request */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383 u32 ve_attrlen; /* request */
384 char * ve_attrval; /* request */
385};
386
387struct nfsd4_write {
388 stateid_t wr_stateid; /* request */
389 u64 wr_offset; /* request */
390 u32 wr_stable_how; /* request */
391 u32 wr_buflen; /* request */
J. Bruce Fields70cc7f72012-11-16 14:16:46 -0500392 struct kvec wr_head;
393 struct page ** wr_pagelist; /* request */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394
395 u32 wr_bytes_written; /* response */
396 u32 wr_how_written; /* response */
397 nfs4_verifier wr_verifier; /* response */
398};
399
Andy Adamson2db134e2009-04-03 08:27:55 +0300400struct nfsd4_exchange_id {
Andy Adamson0733d212009-04-03 08:28:01 +0300401 nfs4_verifier verifier;
402 struct xdr_netobj clname;
403 u32 flags;
404 clientid_t clientid;
405 u32 seqid;
406 int spa_how;
Andrew Elbleed941642016-06-15 12:52:09 -0400407 u32 spo_must_enforce[3];
408 u32 spo_must_allow[3];
Andy Adamson2db134e2009-04-03 08:27:55 +0300409};
410
Andy Adamson2db134e2009-04-03 08:27:55 +0300411struct nfsd4_sequence {
Benny Halevyb85d4c02009-04-03 08:28:08 +0300412 struct nfs4_sessionid sessionid; /* request/response */
413 u32 seqid; /* request/response */
414 u32 slotid; /* request/response */
415 u32 maxslots; /* request/response */
416 u32 cachethis; /* request */
417#if 0
418 u32 target_maxslots; /* response */
Benny Halevyb85d4c02009-04-03 08:28:08 +0300419#endif /* not yet */
J. Bruce Fields0d7bb712010-11-18 08:30:33 -0500420 u32 status_flags; /* response */
Andy Adamson2db134e2009-04-03 08:27:55 +0300421};
422
423struct nfsd4_destroy_session {
Benny Halevye10e0cf2009-04-03 08:28:38 +0300424 struct nfs4_sessionid sessionid;
Andy Adamson2db134e2009-04-03 08:27:55 +0300425};
426
Mi Jinlong345c2842011-10-20 17:51:39 +0800427struct nfsd4_destroy_clientid {
428 clientid_t clientid;
429};
430
J. Bruce Fields4dc6ec02010-04-19 15:11:28 -0400431struct nfsd4_reclaim_complete {
432 u32 rca_one_fs;
433};
434
Christoph Hellwig9cf514c2014-05-05 13:11:59 +0200435struct nfsd4_deviceid {
436 u64 fsid_idx;
437 u32 generation;
438 u32 pad;
439};
440
441struct nfsd4_layout_seg {
442 u32 iomode;
443 u64 offset;
444 u64 length;
445};
446
447struct nfsd4_getdeviceinfo {
448 struct nfsd4_deviceid gd_devid; /* request */
449 u32 gd_layout_type; /* request */
450 u32 gd_maxcount; /* request */
451 u32 gd_notify_types;/* request - response */
452 void *gd_device; /* response */
453};
454
455struct nfsd4_layoutget {
456 u64 lg_minlength; /* request */
457 u32 lg_signal; /* request */
458 u32 lg_layout_type; /* request */
459 u32 lg_maxcount; /* request */
460 stateid_t lg_sid; /* request/response */
461 struct nfsd4_layout_seg lg_seg; /* request/response */
462 void *lg_content; /* response */
463};
464
465struct nfsd4_layoutcommit {
466 stateid_t lc_sid; /* request */
467 struct nfsd4_layout_seg lc_seg; /* request */
468 u32 lc_reclaim; /* request */
469 u32 lc_newoffset; /* request */
470 u64 lc_last_wr; /* request */
471 struct timespec lc_mtime; /* request */
472 u32 lc_layout_type; /* request */
473 u32 lc_up_len; /* layout length */
474 void *lc_up_layout; /* decoded by callback */
475 u32 lc_size_chg; /* boolean for response */
476 u64 lc_newsize; /* response */
477};
478
479struct nfsd4_layoutreturn {
480 u32 lr_return_type; /* request */
481 u32 lr_layout_type; /* request */
482 struct nfsd4_layout_seg lr_seg; /* request */
483 u32 lr_reclaim; /* request */
484 u32 lrf_body_len; /* request */
485 void *lrf_body; /* request */
486 stateid_t lr_sid; /* request/response */
487 u32 lrs_present; /* response */
488};
489
Anna Schumaker95d871f2014-11-07 14:44:26 -0500490struct nfsd4_fallocate {
491 /* request */
492 stateid_t falloc_stateid;
493 loff_t falloc_offset;
494 u64 falloc_length;
495};
496
Christoph Hellwigffa01602015-12-03 12:59:52 +0100497struct nfsd4_clone {
498 /* request */
499 stateid_t cl_src_stateid;
500 stateid_t cl_dst_stateid;
501 u64 cl_src_pos;
502 u64 cl_dst_pos;
503 u64 cl_count;
504};
505
Anna Schumaker29ae7f92016-09-07 15:57:30 -0400506struct nfsd42_write_res {
507 u64 wr_bytes_written;
508 u32 wr_stable_how;
509 nfs4_verifier wr_verifier;
510};
511
512struct nfsd4_copy {
513 /* request */
514 stateid_t cp_src_stateid;
515 stateid_t cp_dst_stateid;
516 u64 cp_src_pos;
517 u64 cp_dst_pos;
518 u64 cp_count;
519
520 /* both */
521 bool cp_consecutive;
522 bool cp_synchronous;
523
524 /* response */
525 struct nfsd42_write_res cp_res;
526};
527
Anna Schumaker24bab492014-09-26 13:58:27 -0400528struct nfsd4_seek {
529 /* request */
530 stateid_t seek_stateid;
531 loff_t seek_offset;
532 u32 seek_whence;
533
534 /* response */
535 u32 seek_eof;
536 loff_t seek_pos;
537};
538
Linus Torvalds1da177e2005-04-16 15:20:36 -0700539struct nfsd4_op {
540 int opnum;
J. Bruce Fieldsf4f9ef42017-07-06 17:51:29 -0400541 const struct nfsd4_operation * opdesc;
Al Virob37ad282006-10-19 23:28:59 -0700542 __be32 status;
Christoph Hellwigb60e9852017-05-08 20:03:15 +0200543 union nfsd4_op_u {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700544 struct nfsd4_access access;
545 struct nfsd4_close close;
546 struct nfsd4_commit commit;
547 struct nfsd4_create create;
548 struct nfsd4_delegreturn delegreturn;
549 struct nfsd4_getattr getattr;
550 struct svc_fh * getfh;
551 struct nfsd4_link link;
552 struct nfsd4_lock lock;
553 struct nfsd4_lockt lockt;
554 struct nfsd4_locku locku;
555 struct nfsd4_lookup lookup;
556 struct nfsd4_verify nverify;
557 struct nfsd4_open open;
558 struct nfsd4_open_confirm open_confirm;
559 struct nfsd4_open_downgrade open_downgrade;
560 struct nfsd4_putfh putfh;
561 struct nfsd4_read read;
562 struct nfsd4_readdir readdir;
563 struct nfsd4_readlink readlink;
564 struct nfsd4_remove remove;
565 struct nfsd4_rename rename;
566 clientid_t renew;
Andy Adamsondcb488a32007-07-17 04:04:51 -0700567 struct nfsd4_secinfo secinfo;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700568 struct nfsd4_setattr setattr;
569 struct nfsd4_setclientid setclientid;
570 struct nfsd4_setclientid_confirm setclientid_confirm;
571 struct nfsd4_verify verify;
572 struct nfsd4_write write;
573 struct nfsd4_release_lockowner release_lockowner;
Andy Adamson2db134e2009-04-03 08:27:55 +0300574
575 /* NFSv4.1 */
576 struct nfsd4_exchange_id exchange_id;
J. Bruce Fieldscb73a9f2012-11-01 18:09:48 -0400577 struct nfsd4_backchannel_ctl backchannel_ctl;
J. Bruce Fields1d1bc8f2010-10-04 23:12:59 -0400578 struct nfsd4_bind_conn_to_session bind_conn_to_session;
Andy Adamson2db134e2009-04-03 08:27:55 +0300579 struct nfsd4_create_session create_session;
580 struct nfsd4_destroy_session destroy_session;
Christoph Hellwigeb698532017-05-08 20:58:35 +0200581 struct nfsd4_destroy_clientid destroy_clientid;
Andy Adamson2db134e2009-04-03 08:27:55 +0300582 struct nfsd4_sequence sequence;
J. Bruce Fields4dc6ec02010-04-19 15:11:28 -0400583 struct nfsd4_reclaim_complete reclaim_complete;
Bryan Schumaker17456802011-07-13 10:50:48 -0400584 struct nfsd4_test_stateid test_stateid;
Bryan Schumakere1ca12d2011-07-13 11:04:21 -0400585 struct nfsd4_free_stateid free_stateid;
Christoph Hellwig9cf514c2014-05-05 13:11:59 +0200586 struct nfsd4_getdeviceinfo getdeviceinfo;
587 struct nfsd4_layoutget layoutget;
588 struct nfsd4_layoutcommit layoutcommit;
589 struct nfsd4_layoutreturn layoutreturn;
Christoph Hellwigeb698532017-05-08 20:58:35 +0200590 struct nfsd4_secinfo_no_name secinfo_no_name;
Anna Schumaker24bab492014-09-26 13:58:27 -0400591
592 /* NFSv4.2 */
Anna Schumaker95d871f2014-11-07 14:44:26 -0500593 struct nfsd4_fallocate allocate;
Anna Schumakerb0cb9082014-11-07 14:44:27 -0500594 struct nfsd4_fallocate deallocate;
Christoph Hellwigffa01602015-12-03 12:59:52 +0100595 struct nfsd4_clone clone;
Anna Schumaker29ae7f92016-09-07 15:57:30 -0400596 struct nfsd4_copy copy;
Anna Schumaker24bab492014-09-26 13:58:27 -0400597 struct nfsd4_seek seek;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700598 } u;
599 struct nfs4_replay * replay;
600};
601
J. Bruce Fields10910062011-01-24 12:11:02 -0500602bool nfsd4_cache_this_op(struct nfsd4_op *);
603
J. Bruce Fieldsd5e23382014-06-24 17:43:45 -0400604/*
605 * Memory needed just for the duration of processing one compound:
606 */
607struct svcxdr_tmpbuf {
608 struct svcxdr_tmpbuf *next;
609 char buf[];
610};
611
Linus Torvalds1da177e2005-04-16 15:20:36 -0700612struct nfsd4_compoundargs {
613 /* scratch variables for XDR decode */
Al Viro2ebbc012006-10-19 23:28:58 -0700614 __be32 * p;
615 __be32 * end;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700616 struct page ** pagelist;
617 int pagelen;
Chuck Levereae03e22017-08-18 11:12:27 -0400618 bool tail;
Al Viro2ebbc012006-10-19 23:28:58 -0700619 __be32 tmp[8];
620 __be32 * tmpp;
J. Bruce Fieldsd5e23382014-06-24 17:43:45 -0400621 struct svcxdr_tmpbuf *to_free;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700622
623 struct svc_rqst *rqstp;
624
625 u32 taglen;
626 char * tag;
627 u32 minorversion;
628 u32 opcnt;
629 struct nfsd4_op *ops;
630 struct nfsd4_op iops[8];
J. Bruce Fields10910062011-01-24 12:11:02 -0500631 int cachetype;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700632};
633
634struct nfsd4_compoundres {
635 /* scratch variables for XDR encode */
J. Bruce Fields4aea24b2014-01-15 15:17:58 -0500636 struct xdr_stream xdr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700637 struct svc_rqst * rqstp;
638
639 u32 taglen;
640 char * tag;
641 u32 opcnt;
Andy Adamsone354d572009-03-28 11:30:52 +0300642 __be32 * tagp; /* tag, opcount encode location */
643 struct nfsd4_compound_state cstate;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700644};
645
Andy Adamsonbf864a32009-04-03 08:28:35 +0300646static inline bool nfsd4_is_solo_sequence(struct nfsd4_compoundres *resp)
647{
648 struct nfsd4_compoundargs *args = resp->rqstp->rq_argp;
Andy Adamson468de9e2009-08-27 12:07:40 -0400649 return resp->opcnt == 1 && args->ops[0].opnum == OP_SEQUENCE;
Andy Adamsonbf864a32009-04-03 08:28:35 +0300650}
651
652static inline bool nfsd4_not_cached(struct nfsd4_compoundres *resp)
653{
J. Bruce Fields73e79482012-02-13 16:39:00 -0500654 return !(resp->cstate.slot->sl_flags & NFSD4_SLOT_CACHETHIS)
655 || nfsd4_is_solo_sequence(resp);
Andy Adamsonbf864a32009-04-03 08:28:35 +0300656}
657
J. Bruce Fields9b3234b2012-12-04 18:03:46 -0500658static inline bool nfsd4_last_compound_op(struct svc_rqst *rqstp)
659{
660 struct nfsd4_compoundres *resp = rqstp->rq_resp;
661 struct nfsd4_compoundargs *argp = rqstp->rq_argp;
662
663 return argp->opcnt == resp->opcnt;
664}
665
J. Bruce Fieldsf4f9ef42017-07-06 17:51:29 -0400666const struct nfsd4_operation *OPDESC(struct nfsd4_op *op);
J. Bruce Fields4f0cefb2014-03-11 15:39:13 -0400667int nfsd4_max_reply(struct svc_rqst *rqstp, struct nfsd4_op *op);
J. Bruce Fields07d1f802014-03-06 20:39:29 -0500668void warn_on_nonidempotent_op(struct nfsd4_op *op);
669
Linus Torvalds1da177e2005-04-16 15:20:36 -0700670#define NFS4_SVC_XDRSIZE sizeof(struct nfsd4_compoundargs)
671
672static inline void
673set_change_info(struct nfsd4_change_info *cinfo, struct svc_fh *fhp)
674{
Neil Brownc1ac3ff2010-12-02 11:14:30 +1100675 BUG_ON(!fhp->fh_pre_saved);
Jeff Laytonaaf91ec2015-09-17 08:28:39 -0400676 cinfo->atomic = (u32)fhp->fh_post_saved;
David Howells2b0143b2015-03-17 22:25:59 +0000677 cinfo->change_supported = IS_I_VERSION(d_inode(fhp->fh_dentry));
Neil Brownc1ac3ff2010-12-02 11:14:30 +1100678
679 cinfo->before_change = fhp->fh_pre_change;
680 cinfo->after_change = fhp->fh_post_change;
681 cinfo->before_ctime_sec = fhp->fh_pre_ctime.tv_sec;
682 cinfo->before_ctime_nsec = fhp->fh_pre_ctime.tv_nsec;
683 cinfo->after_ctime_sec = fhp->fh_post_attr.ctime.tv_sec;
684 cinfo->after_ctime_nsec = fhp->fh_post_attr.ctime.tv_nsec;
685
Linus Torvalds1da177e2005-04-16 15:20:36 -0700686}
687
Andrew Elblededeb132016-06-15 12:52:08 -0400688
689bool nfsd4_mach_creds_match(struct nfs4_client *cl, struct svc_rqst *rqstp);
Christoph Hellwig63f8de32017-05-08 19:42:02 +0200690int nfs4svc_encode_voidres(struct svc_rqst *, __be32 *);
Christoph Hellwig026fec72017-05-08 19:01:48 +0200691int nfs4svc_decode_compoundargs(struct svc_rqst *, __be32 *);
Christoph Hellwig63f8de32017-05-08 19:42:02 +0200692int nfs4svc_encode_compoundres(struct svc_rqst *, __be32 *);
J. Bruce Fields57b7b432012-04-25 17:58:50 -0400693__be32 nfsd4_check_resp_size(struct nfsd4_compoundres *, u32);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700694void nfsd4_encode_operation(struct nfsd4_compoundres *, struct nfsd4_op *);
J. Bruce Fieldsd0a381d2014-01-30 17:18:38 -0500695void nfsd4_encode_replay(struct xdr_stream *xdr, struct nfsd4_op *op);
J. Bruce Fieldsd5184652013-08-26 16:04:46 -0400696__be32 nfsd4_encode_fattr_to_buf(__be32 **p, int words,
697 struct svc_fh *fhp, struct svc_export *exp,
698 struct dentry *dentry,
699 u32 *bmval, struct svc_rqst *, int ignore_crossmnt);
Al Virob37ad282006-10-19 23:28:59 -0700700extern __be32 nfsd4_setclientid(struct svc_rqst *rqstp,
Christoph Hellwigeb698532017-05-08 20:58:35 +0200701 struct nfsd4_compound_state *, union nfsd4_op_u *u);
Al Virob37ad282006-10-19 23:28:59 -0700702extern __be32 nfsd4_setclientid_confirm(struct svc_rqst *rqstp,
Christoph Hellwigeb698532017-05-08 20:58:35 +0200703 struct nfsd4_compound_state *, union nfsd4_op_u *u);
Andy Adamson069b6ad2009-04-03 08:27:58 +0300704extern __be32 nfsd4_exchange_id(struct svc_rqst *rqstp,
Christoph Hellwigeb698532017-05-08 20:58:35 +0200705 struct nfsd4_compound_state *, union nfsd4_op_u *u);
706extern __be32 nfsd4_backchannel_ctl(struct svc_rqst *,
707 struct nfsd4_compound_state *, union nfsd4_op_u *u);
708extern __be32 nfsd4_bind_conn_to_session(struct svc_rqst *,
709 struct nfsd4_compound_state *, union nfsd4_op_u *u);
J. Bruce Fields3c4ab2a2010-04-19 15:12:51 -0400710extern __be32 nfsd4_create_session(struct svc_rqst *,
Christoph Hellwigeb698532017-05-08 20:58:35 +0200711 struct nfsd4_compound_state *, union nfsd4_op_u *u);
Andy Adamson069b6ad2009-04-03 08:27:58 +0300712extern __be32 nfsd4_sequence(struct svc_rqst *,
Christoph Hellwigeb698532017-05-08 20:58:35 +0200713 struct nfsd4_compound_state *, union nfsd4_op_u *u);
Trond Myklebustb6076642014-06-30 11:48:35 -0400714extern void nfsd4_sequence_done(struct nfsd4_compoundres *resp);
Andy Adamson069b6ad2009-04-03 08:27:58 +0300715extern __be32 nfsd4_destroy_session(struct svc_rqst *,
Christoph Hellwigeb698532017-05-08 20:58:35 +0200716 struct nfsd4_compound_state *, union nfsd4_op_u *u);
717extern __be32 nfsd4_destroy_clientid(struct svc_rqst *, struct nfsd4_compound_state *,
718 union nfsd4_op_u *u);
719__be32 nfsd4_reclaim_complete(struct svc_rqst *, struct nfsd4_compound_state *,
720 union nfsd4_op_u *u);
Andy Adamson66689582009-04-03 08:28:45 +0300721extern __be32 nfsd4_process_open1(struct nfsd4_compound_state *,
Stanislav Kinsbursky3320fef192012-11-14 18:22:07 +0300722 struct nfsd4_open *open, struct nfsd_net *nn);
Al Virob37ad282006-10-19 23:28:59 -0700723extern __be32 nfsd4_process_open2(struct svc_rqst *rqstp,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700724 struct svc_fh *current_fh, struct nfsd4_open *open);
Jeff Layton58fb12e2014-07-29 21:34:27 -0400725extern void nfsd4_cstate_clear_replay(struct nfsd4_compound_state *cstate);
726extern void nfsd4_cleanup_open_state(struct nfsd4_compound_state *cstate,
Jeff Layton42297892015-03-23 10:53:44 -0400727 struct nfsd4_open *open);
Al Virob37ad282006-10-19 23:28:59 -0700728extern __be32 nfsd4_open_confirm(struct svc_rqst *rqstp,
Christoph Hellwigeb698532017-05-08 20:58:35 +0200729 struct nfsd4_compound_state *, union nfsd4_op_u *u);
730extern __be32 nfsd4_close(struct svc_rqst *rqstp, struct nfsd4_compound_state *,
731 union nfsd4_op_u *u);
Al Virob37ad282006-10-19 23:28:59 -0700732extern __be32 nfsd4_open_downgrade(struct svc_rqst *rqstp,
Christoph Hellwigeb698532017-05-08 20:58:35 +0200733 struct nfsd4_compound_state *, union nfsd4_op_u *u);
J.Bruce Fieldsca364312006-12-13 00:35:27 -0800734extern __be32 nfsd4_lock(struct svc_rqst *rqstp, struct nfsd4_compound_state *,
Christoph Hellwigeb698532017-05-08 20:58:35 +0200735 union nfsd4_op_u *u);
736extern __be32 nfsd4_lockt(struct svc_rqst *rqstp, struct nfsd4_compound_state *,
737 union nfsd4_op_u *u);
738extern __be32 nfsd4_locku(struct svc_rqst *rqstp, struct nfsd4_compound_state *,
739 union nfsd4_op_u *u);
Al Virob37ad282006-10-19 23:28:59 -0700740extern __be32
Linus Torvalds1da177e2005-04-16 15:20:36 -0700741nfsd4_release_lockowner(struct svc_rqst *rqstp,
Christoph Hellwigeb698532017-05-08 20:58:35 +0200742 struct nfsd4_compound_state *, union nfsd4_op_u *u);
Christoph Hellwig85374882017-05-08 18:48:24 +0200743extern void nfsd4_release_compoundargs(struct svc_rqst *rqstp);
Al Virob37ad282006-10-19 23:28:59 -0700744extern __be32 nfsd4_delegreturn(struct svc_rqst *rqstp,
Christoph Hellwigeb698532017-05-08 20:58:35 +0200745 struct nfsd4_compound_state *, union nfsd4_op_u *u);
746extern __be32 nfsd4_renew(struct svc_rqst *rqstp, struct nfsd4_compound_state *,
747 union nfsd4_op_u *u);
Bryan Schumaker17456802011-07-13 10:50:48 -0400748extern __be32 nfsd4_test_stateid(struct svc_rqst *rqstp,
Christoph Hellwigeb698532017-05-08 20:58:35 +0200749 struct nfsd4_compound_state *, union nfsd4_op_u *);
Bryan Schumakere1ca12d2011-07-13 11:04:21 -0400750extern __be32 nfsd4_free_stateid(struct svc_rqst *rqstp,
Christoph Hellwigeb698532017-05-08 20:58:35 +0200751 struct nfsd4_compound_state *, union nfsd4_op_u *);
J. Bruce Fields9411b1d2013-04-01 16:37:12 -0400752extern void nfsd4_bump_seqid(struct nfsd4_compound_state *, __be32 nfserr);
Jeff Layton58fb12e2014-07-29 21:34:27 -0400753
J. Bruce Fields00209392017-05-06 10:38:39 -0400754enum nfsd4_op_flags {
755 ALLOWED_WITHOUT_FH = 1 << 0, /* No current filehandle required */
756 ALLOWED_ON_ABSENT_FS = 1 << 1, /* ops processed on absent fs */
757 ALLOWED_AS_FIRST_OP = 1 << 2, /* ops reqired first in compound */
758 /* For rfc 5661 section 2.6.3.1.1: */
759 OP_HANDLES_WRONGSEC = 1 << 3,
760 OP_IS_PUTFH_LIKE = 1 << 4,
761 /*
762 * These are the ops whose result size we estimate before
763 * encoding, to avoid performing an op then not being able to
764 * respond or cache a response. This includes writes and setattrs
765 * as well as the operations usually called "nonidempotent":
766 */
767 OP_MODIFIES_SOMETHING = 1 << 5,
768 /*
769 * Cache compounds containing these ops in the xid-based drc:
770 * We use the DRC for compounds containing non-idempotent
771 * operations, *except* those that are 4.1-specific (since
772 * sessions provide their own EOS), and except for stateful
773 * operations other than setclientid and setclientid_confirm
774 * (since sequence numbers provide EOS for open, lock, etc in
775 * the v4.0 case).
776 */
777 OP_CACHEME = 1 << 6,
778 /*
779 * These are ops which clear current state id.
780 */
781 OP_CLEAR_STATEID = 1 << 7,
J. Bruce Fieldsb7571e42017-05-06 10:49:21 -0400782 /* Most ops return only an error on failure; some may do more: */
783 OP_NONTRIVIAL_ERROR_ENCODE = 1 << 8,
J. Bruce Fields00209392017-05-06 10:38:39 -0400784};
785
786struct nfsd4_operation {
787 __be32 (*op_func)(struct svc_rqst *, struct nfsd4_compound_state *,
788 union nfsd4_op_u *);
J. Bruce Fields34b1744c2017-05-05 17:09:37 -0400789 void (*op_release)(union nfsd4_op_u *);
J. Bruce Fields00209392017-05-06 10:38:39 -0400790 u32 op_flags;
791 char *op_name;
792 /* Try to get response size before operation */
793 u32 (*op_rsize_bop)(struct svc_rqst *, struct nfsd4_op *);
794 void (*op_get_currentstateid)(struct nfsd4_compound_state *,
795 union nfsd4_op_u *);
796 void (*op_set_currentstateid)(struct nfsd4_compound_state *,
797 union nfsd4_op_u *);
798};
799
800
Linus Torvalds1da177e2005-04-16 15:20:36 -0700801#endif
802
803/*
804 * Local variables:
805 * c-basic-offset: 8
806 * End:
807 */