Merge tag 'for-5.4-rc1-tag' of git://git.kernel.org/pub/scm/linux/kernel/git/kdave...
[linux-2.6-block.git] / fs / nfsd / xdr4.h
CommitLineData
1da177e4 1/*
1da177e4
LT
2 * 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
9a74af21
BH
40#include "state.h"
41#include "nfsd.h"
1da177e4
LT
42
43#define NFSD4_MAX_TAGLEN 128
44#define XDR_LEN(n) (((n) + 3) & ~3)
45
37c593c5
TM
46#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
ca364317 53struct nfsd4_compound_state {
e354d571
AA
54 struct svc_fh current_fh;
55 struct svc_fh save_fh;
56 struct nfs4_stateowner *replay_owner;
4b24ca7d 57 struct nfs4_client *clp;
b85d4c01
BH
58 /* For sessions DRC */
59 struct nfsd4_session *session;
60 struct nfsd4_slot *slot;
f5236013 61 int data_offset;
ed941643 62 bool spo_must_allowed;
da3846a2 63 size_t iovlen;
d87a8ade 64 u32 minorversion;
57b7b43b 65 __be32 status;
37c593c5
TM
66 stateid_t current_stateid;
67 stateid_t save_stateid;
68 /* to indicate current and saved state id presents */
69 u32 sid_flags;
ca364317
BF
70};
71
6668958f
AA
72static inline bool nfsd4_has_session(struct nfsd4_compound_state *cs)
73{
74 return cs->slot != NULL;
75}
76
1da177e4
LT
77struct nfsd4_change_info {
78 u32 atomic;
c654b8a9 79 bool change_supported;
1da177e4
LT
80 u32 before_ctime_sec;
81 u32 before_ctime_nsec;
c654b8a9 82 u64 before_change;
1da177e4
LT
83 u32 after_ctime_sec;
84 u32 after_ctime_nsec;
c654b8a9 85 u64 after_change;
1da177e4
LT
86};
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 */
1da177e4
LT
97};
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 {
7fb84306
BF
111 u32 datalen;
112 char *data;
38a70315 113 struct kvec first;
1da177e4
LT
114 } link; /* NF4LNK */
115 struct {
116 u32 specdata1;
117 u32 specdata2;
118 } dev; /* NF4BLK, NF4CHR */
119 } u;
7e705706 120 u32 cr_bmval[3]; /* request */
1da177e4 121 struct iattr cr_iattr; /* request */
880a3a53 122 int cr_umask; /* request */
1da177e4
LT
123 struct nfsd4_change_info cr_cinfo; /* response */
124 struct nfs4_acl *cr_acl;
18032ca0 125 struct xdr_netobj cr_label;
1da177e4 126};
7fb84306
BF
127#define cr_datalen u.link.datalen
128#define cr_data u.link.data
38a70315 129#define cr_first u.link.first
1da177e4
LT
130#define cr_specdata1 u.dev.specdata1
131#define cr_specdata2 u.dev.specdata2
132
133struct nfsd4_delegreturn {
134 stateid_t dr_stateid;
135};
136
137struct nfsd4_getattr {
7e705706 138 u32 ga_bmval[3]; /* request */
1da177e4
LT
139 struct svc_fh *ga_fhp; /* response */
140};
141
142struct nfsd4_link {
143 u32 li_namelen; /* request */
144 char * li_name; /* request */
145 struct nfsd4_change_info li_cinfo; /* response */
146};
147
148struct nfsd4_lock_denied {
149 clientid_t ld_clientid;
7c13f344 150 struct xdr_netobj ld_owner;
1da177e4
LT
151 u64 ld_start;
152 u64 ld_length;
153 u32 ld_type;
154};
155
156struct nfsd4_lock {
157 /* request */
158 u32 lk_type;
159 u32 lk_reclaim; /* boolean */
160 u64 lk_offset;
161 u64 lk_length;
162 u32 lk_is_new;
163 union {
164 struct {
165 u32 open_seqid;
166 stateid_t open_stateid;
167 u32 lock_seqid;
168 clientid_t clientid;
169 struct xdr_netobj owner;
170 } new;
171 struct {
172 stateid_t lock_stateid;
173 u32 lock_seqid;
174 } old;
175 } v;
176
177 /* response */
178 union {
179 struct {
180 stateid_t stateid;
181 } ok;
182 struct nfsd4_lock_denied denied;
183 } u;
1da177e4
LT
184};
185#define lk_new_open_seqid v.new.open_seqid
186#define lk_new_open_stateid v.new.open_stateid
187#define lk_new_lock_seqid v.new.lock_seqid
188#define lk_new_clientid v.new.clientid
189#define lk_new_owner v.new.owner
190#define lk_old_lock_stateid v.old.lock_stateid
191#define lk_old_lock_seqid v.old.lock_seqid
192
1da177e4
LT
193#define lk_resp_stateid u.ok.stateid
194#define lk_denied u.denied
195
196
197struct nfsd4_lockt {
198 u32 lt_type;
199 clientid_t lt_clientid;
200 struct xdr_netobj lt_owner;
201 u64 lt_offset;
202 u64 lt_length;
1da177e4
LT
203 struct nfsd4_lock_denied lt_denied;
204};
205
206
207struct nfsd4_locku {
208 u32 lu_type;
209 u32 lu_seqid;
210 stateid_t lu_stateid;
211 u64 lu_offset;
212 u64 lu_length;
1da177e4
LT
213};
214
215
216struct nfsd4_lookup {
217 u32 lo_len; /* request */
218 char * lo_name; /* request */
219};
220
221struct nfsd4_putfh {
222 u32 pf_fhlen; /* request */
223 char *pf_fhval; /* request */
224};
225
226struct nfsd4_open {
227 u32 op_claim_type; /* request */
228 struct xdr_netobj op_fname; /* request - everything but CLAIM_PREV */
229 u32 op_delegate_type; /* request - CLAIM_PREV only */
230 stateid_t op_delegate_stateid; /* request - response */
d24433cd 231 u32 op_why_no_deleg; /* response - DELEG_NONE_EXT only */
1da177e4
LT
232 u32 op_create; /* request */
233 u32 op_createmode; /* request */
880a3a53 234 int op_umask; /* request */
7e705706 235 u32 op_bmval[3]; /* request */
3ff69309 236 struct iattr op_iattr; /* UNCHECKED4, GUARDED4, EXCLUSIVE4_1 */
ab4684d1
CL
237 nfs4_verifier op_verf __attribute__((aligned(32)));
238 /* EXCLUSIVE4 */
1da177e4
LT
239 clientid_t op_clientid; /* request */
240 struct xdr_netobj op_owner; /* request */
241 u32 op_seqid; /* request */
242 u32 op_share_access; /* request */
243 u32 op_share_deny; /* request */
2c8bd7e0 244 u32 op_deleg_want; /* request */
1da177e4 245 stateid_t op_stateid; /* response */
9d313b17 246 __be32 op_xdr_error; /* see nfsd4_open_omfg() */
7b190fec 247 u32 op_recall; /* recall */
1da177e4
LT
248 struct nfsd4_change_info op_cinfo; /* response */
249 u32 op_rflags; /* response */
856121b2
BF
250 bool op_truncate; /* used during processing */
251 bool op_created; /* used during processing */
fe0750e5 252 struct nfs4_openowner *op_openowner; /* used during processing */
32513b40 253 struct nfs4_file *op_file; /* used during processing */
4cdc951b 254 struct nfs4_ol_stateid *op_stp; /* used during processing */
8287f009 255 struct nfs4_clnt_odstate *op_odstate; /* used during processing */
1da177e4 256 struct nfs4_acl *op_acl;
18032ca0 257 struct xdr_netobj op_label;
1da177e4 258};
1da177e4
LT
259
260struct nfsd4_open_confirm {
261 stateid_t oc_req_stateid /* request */;
262 u32 oc_seqid /* request */;
263 stateid_t oc_resp_stateid /* response */;
1da177e4
LT
264};
265
266struct nfsd4_open_downgrade {
267 stateid_t od_stateid;
268 u32 od_seqid;
2c8bd7e0
BH
269 u32 od_share_access; /* request */
270 u32 od_deleg_want; /* request */
271 u32 od_share_deny; /* request */
1da177e4
LT
272};
273
274
275struct nfsd4_read {
5c4583b2
JL
276 stateid_t rd_stateid; /* request */
277 u64 rd_offset; /* request */
278 u32 rd_length; /* request */
279 int rd_vlen;
280 struct nfsd_file *rd_nf;
1da177e4 281
5c4583b2
JL
282 struct svc_rqst *rd_rqstp; /* response */
283 struct svc_fh *rd_fhp; /* response */
1da177e4
LT
284};
285
286struct nfsd4_readdir {
287 u64 rd_cookie; /* request */
288 nfs4_verifier rd_verf; /* request */
289 u32 rd_dircount; /* request */
290 u32 rd_maxcount; /* request */
7e705706 291 u32 rd_bmval[3]; /* request */
1da177e4
LT
292 struct svc_rqst *rd_rqstp; /* response */
293 struct svc_fh * rd_fhp; /* response */
294
295 struct readdir_cd common;
561f0ed4
BF
296 struct xdr_stream *xdr;
297 int cookie_offset;
1da177e4
LT
298};
299
300struct nfsd4_release_lockowner {
301 clientid_t rl_clientid;
302 struct xdr_netobj rl_owner;
303};
304struct nfsd4_readlink {
305 struct svc_rqst *rl_rqstp; /* request */
306 struct svc_fh * rl_fhp; /* request */
307};
308
309struct nfsd4_remove {
310 u32 rm_namelen; /* request */
311 char * rm_name; /* request */
312 struct nfsd4_change_info rm_cinfo; /* response */
313};
314
315struct nfsd4_rename {
316 u32 rn_snamelen; /* request */
317 char * rn_sname; /* request */
318 u32 rn_tnamelen; /* request */
319 char * rn_tname; /* request */
320 struct nfsd4_change_info rn_sinfo; /* response */
321 struct nfsd4_change_info rn_tinfo; /* response */
322};
323
dcb488a3
AA
324struct nfsd4_secinfo {
325 u32 si_namelen; /* request */
326 char *si_name; /* request */
327 struct svc_export *si_exp; /* response */
328};
329
04f4ad16
BF
330struct nfsd4_secinfo_no_name {
331 u32 sin_style; /* request */
332 struct svc_export *sin_exp; /* response */
333};
334
1da177e4
LT
335struct nfsd4_setattr {
336 stateid_t sa_stateid; /* request */
7e705706 337 u32 sa_bmval[3]; /* request */
1da177e4
LT
338 struct iattr sa_iattr; /* request */
339 struct nfs4_acl *sa_acl;
18032ca0 340 struct xdr_netobj sa_label;
1da177e4
LT
341};
342
343struct nfsd4_setclientid {
344 nfs4_verifier se_verf; /* request */
a084daf5 345 struct xdr_netobj se_name;
1da177e4
LT
346 u32 se_callback_prog; /* request */
347 u32 se_callback_netid_len; /* request */
348 char * se_callback_netid_val; /* request */
349 u32 se_callback_addr_len; /* request */
350 char * se_callback_addr_val; /* request */
351 u32 se_callback_ident; /* request */
352 clientid_t se_clientid; /* response */
353 nfs4_verifier se_confirm; /* response */
354};
355
356struct nfsd4_setclientid_confirm {
357 clientid_t sc_clientid;
358 nfs4_verifier sc_confirm;
359};
360
17456804
BS
361struct nfsd4_saved_compoundargs {
362 __be32 *p;
363 __be32 *end;
364 int pagelen;
365 struct page **pagelist;
366};
367
03cfb420
BS
368struct nfsd4_test_stateid_id {
369 __be32 ts_id_status;
370 stateid_t ts_id_stateid;
371 struct list_head ts_id_list;
372};
373
17456804 374struct nfsd4_test_stateid {
57b7b43b 375 u32 ts_num_ids;
03cfb420 376 struct list_head ts_stateid_list;
17456804
BS
377};
378
e1ca12df
BS
379struct nfsd4_free_stateid {
380 stateid_t fr_stateid; /* request */
e1ca12df
BS
381};
382
1da177e4
LT
383/* also used for NVERIFY */
384struct nfsd4_verify {
7e705706 385 u32 ve_bmval[3]; /* request */
1da177e4
LT
386 u32 ve_attrlen; /* request */
387 char * ve_attrval; /* request */
388};
389
390struct nfsd4_write {
391 stateid_t wr_stateid; /* request */
392 u64 wr_offset; /* request */
393 u32 wr_stable_how; /* request */
394 u32 wr_buflen; /* request */
70cc7f75
BF
395 struct kvec wr_head;
396 struct page ** wr_pagelist; /* request */
1da177e4
LT
397
398 u32 wr_bytes_written; /* response */
399 u32 wr_how_written; /* response */
400 nfs4_verifier wr_verifier; /* response */
401};
402
2db134eb 403struct nfsd4_exchange_id {
0733d213
AA
404 nfs4_verifier verifier;
405 struct xdr_netobj clname;
406 u32 flags;
407 clientid_t clientid;
408 u32 seqid;
409 int spa_how;
ed941643
AE
410 u32 spo_must_enforce[3];
411 u32 spo_must_allow[3];
79123444
BF
412 struct xdr_netobj nii_domain;
413 struct xdr_netobj nii_name;
414 struct timespec64 nii_time;
2db134eb
AA
415};
416
2db134eb 417struct nfsd4_sequence {
b85d4c01
BH
418 struct nfs4_sessionid sessionid; /* request/response */
419 u32 seqid; /* request/response */
420 u32 slotid; /* request/response */
421 u32 maxslots; /* request/response */
422 u32 cachethis; /* request */
423#if 0
424 u32 target_maxslots; /* response */
b85d4c01 425#endif /* not yet */
0d7bb719 426 u32 status_flags; /* response */
2db134eb
AA
427};
428
429struct nfsd4_destroy_session {
e10e0cfc 430 struct nfs4_sessionid sessionid;
2db134eb
AA
431};
432
345c2842
MJ
433struct nfsd4_destroy_clientid {
434 clientid_t clientid;
435};
436
4dc6ec00
BF
437struct nfsd4_reclaim_complete {
438 u32 rca_one_fs;
439};
440
9cf514cc
CH
441struct nfsd4_deviceid {
442 u64 fsid_idx;
443 u32 generation;
444 u32 pad;
445};
446
447struct nfsd4_layout_seg {
448 u32 iomode;
449 u64 offset;
450 u64 length;
451};
452
453struct nfsd4_getdeviceinfo {
454 struct nfsd4_deviceid gd_devid; /* request */
455 u32 gd_layout_type; /* request */
456 u32 gd_maxcount; /* request */
457 u32 gd_notify_types;/* request - response */
458 void *gd_device; /* response */
459};
460
461struct nfsd4_layoutget {
462 u64 lg_minlength; /* request */
463 u32 lg_signal; /* request */
464 u32 lg_layout_type; /* request */
465 u32 lg_maxcount; /* request */
466 stateid_t lg_sid; /* request/response */
467 struct nfsd4_layout_seg lg_seg; /* request/response */
468 void *lg_content; /* response */
469};
470
471struct nfsd4_layoutcommit {
472 stateid_t lc_sid; /* request */
473 struct nfsd4_layout_seg lc_seg; /* request */
474 u32 lc_reclaim; /* request */
475 u32 lc_newoffset; /* request */
476 u64 lc_last_wr; /* request */
bdba5368 477 struct timespec64 lc_mtime; /* request */
9cf514cc
CH
478 u32 lc_layout_type; /* request */
479 u32 lc_up_len; /* layout length */
480 void *lc_up_layout; /* decoded by callback */
481 u32 lc_size_chg; /* boolean for response */
482 u64 lc_newsize; /* response */
483};
484
485struct nfsd4_layoutreturn {
486 u32 lr_return_type; /* request */
487 u32 lr_layout_type; /* request */
488 struct nfsd4_layout_seg lr_seg; /* request */
489 u32 lr_reclaim; /* request */
490 u32 lrf_body_len; /* request */
491 void *lrf_body; /* request */
492 stateid_t lr_sid; /* request/response */
493 u32 lrs_present; /* response */
494};
495
95d871f0
AS
496struct nfsd4_fallocate {
497 /* request */
498 stateid_t falloc_stateid;
499 loff_t falloc_offset;
500 u64 falloc_length;
501};
502
ffa0160a
CH
503struct nfsd4_clone {
504 /* request */
505 stateid_t cl_src_stateid;
506 stateid_t cl_dst_stateid;
507 u64 cl_src_pos;
508 u64 cl_dst_pos;
509 u64 cl_count;
510};
511
29ae7f9d
AS
512struct nfsd42_write_res {
513 u64 wr_bytes_written;
514 u32 wr_stable_how;
515 nfs4_verifier wr_verifier;
9eb190fc 516 stateid_t cb_stateid;
29ae7f9d
AS
517};
518
519struct nfsd4_copy {
520 /* request */
521 stateid_t cp_src_stateid;
522 stateid_t cp_dst_stateid;
523 u64 cp_src_pos;
524 u64 cp_dst_pos;
525 u64 cp_count;
526
527 /* both */
29ae7f9d
AS
528 bool cp_synchronous;
529
530 /* response */
531 struct nfsd42_write_res cp_res;
9eb190fc
OK
532
533 /* for cb_offload */
534 struct nfsd4_callback cp_cb;
535 __be32 nfserr;
536 struct knfsd_fh fh;
e0639dc5
OK
537
538 struct nfs4_client *cp_clp;
539
5c4583b2
JL
540 struct nfsd_file *nf_src;
541 struct nfsd_file *nf_dst;
e0639dc5
OK
542
543 stateid_t cp_stateid;
544
545 struct list_head copies;
546 struct task_struct *copy_task;
547 refcount_t refcount;
548 bool stopped;
29ae7f9d
AS
549};
550
24bab491
AS
551struct nfsd4_seek {
552 /* request */
553 stateid_t seek_stateid;
554 loff_t seek_offset;
555 u32 seek_whence;
556
557 /* response */
558 u32 seek_eof;
559 loff_t seek_pos;
560};
561
6308bc98
OK
562struct nfsd4_offload_status {
563 /* request */
564 stateid_t stateid;
565
566 /* response */
567 u64 count;
568 u32 status;
569};
570
1da177e4
LT
571struct nfsd4_op {
572 int opnum;
f4f9ef4a 573 const struct nfsd4_operation * opdesc;
b37ad28b 574 __be32 status;
b60e9859 575 union nfsd4_op_u {
1da177e4
LT
576 struct nfsd4_access access;
577 struct nfsd4_close close;
578 struct nfsd4_commit commit;
579 struct nfsd4_create create;
580 struct nfsd4_delegreturn delegreturn;
581 struct nfsd4_getattr getattr;
582 struct svc_fh * getfh;
583 struct nfsd4_link link;
584 struct nfsd4_lock lock;
585 struct nfsd4_lockt lockt;
586 struct nfsd4_locku locku;
587 struct nfsd4_lookup lookup;
588 struct nfsd4_verify nverify;
589 struct nfsd4_open open;
590 struct nfsd4_open_confirm open_confirm;
591 struct nfsd4_open_downgrade open_downgrade;
592 struct nfsd4_putfh putfh;
593 struct nfsd4_read read;
594 struct nfsd4_readdir readdir;
595 struct nfsd4_readlink readlink;
596 struct nfsd4_remove remove;
597 struct nfsd4_rename rename;
598 clientid_t renew;
dcb488a3 599 struct nfsd4_secinfo secinfo;
1da177e4
LT
600 struct nfsd4_setattr setattr;
601 struct nfsd4_setclientid setclientid;
602 struct nfsd4_setclientid_confirm setclientid_confirm;
603 struct nfsd4_verify verify;
604 struct nfsd4_write write;
605 struct nfsd4_release_lockowner release_lockowner;
2db134eb
AA
606
607 /* NFSv4.1 */
608 struct nfsd4_exchange_id exchange_id;
cb73a9f4 609 struct nfsd4_backchannel_ctl backchannel_ctl;
1d1bc8f2 610 struct nfsd4_bind_conn_to_session bind_conn_to_session;
2db134eb
AA
611 struct nfsd4_create_session create_session;
612 struct nfsd4_destroy_session destroy_session;
eb69853d 613 struct nfsd4_destroy_clientid destroy_clientid;
2db134eb 614 struct nfsd4_sequence sequence;
4dc6ec00 615 struct nfsd4_reclaim_complete reclaim_complete;
17456804 616 struct nfsd4_test_stateid test_stateid;
e1ca12df 617 struct nfsd4_free_stateid free_stateid;
9cf514cc
CH
618 struct nfsd4_getdeviceinfo getdeviceinfo;
619 struct nfsd4_layoutget layoutget;
620 struct nfsd4_layoutcommit layoutcommit;
621 struct nfsd4_layoutreturn layoutreturn;
eb69853d 622 struct nfsd4_secinfo_no_name secinfo_no_name;
24bab491
AS
623
624 /* NFSv4.2 */
95d871f0 625 struct nfsd4_fallocate allocate;
b0cb9085 626 struct nfsd4_fallocate deallocate;
ffa0160a 627 struct nfsd4_clone clone;
29ae7f9d 628 struct nfsd4_copy copy;
6308bc98 629 struct nfsd4_offload_status offload_status;
24bab491 630 struct nfsd4_seek seek;
1da177e4
LT
631 } u;
632 struct nfs4_replay * replay;
633};
634
1091006c
BF
635bool nfsd4_cache_this_op(struct nfsd4_op *);
636
d5e23383
BF
637/*
638 * Memory needed just for the duration of processing one compound:
639 */
640struct svcxdr_tmpbuf {
641 struct svcxdr_tmpbuf *next;
642 char buf[];
643};
644
1da177e4
LT
645struct nfsd4_compoundargs {
646 /* scratch variables for XDR decode */
2ebbc012
AV
647 __be32 * p;
648 __be32 * end;
1da177e4
LT
649 struct page ** pagelist;
650 int pagelen;
eae03e2a 651 bool tail;
2ebbc012
AV
652 __be32 tmp[8];
653 __be32 * tmpp;
d5e23383 654 struct svcxdr_tmpbuf *to_free;
1da177e4
LT
655
656 struct svc_rqst *rqstp;
657
658 u32 taglen;
659 char * tag;
660 u32 minorversion;
661 u32 opcnt;
662 struct nfsd4_op *ops;
663 struct nfsd4_op iops[8];
1091006c 664 int cachetype;
1da177e4
LT
665};
666
667struct nfsd4_compoundres {
668 /* scratch variables for XDR encode */
4aea24b2 669 struct xdr_stream xdr;
1da177e4
LT
670 struct svc_rqst * rqstp;
671
672 u32 taglen;
673 char * tag;
674 u32 opcnt;
e354d571
AA
675 __be32 * tagp; /* tag, opcount encode location */
676 struct nfsd4_compound_state cstate;
1da177e4
LT
677};
678
bf864a31
AA
679static inline bool nfsd4_is_solo_sequence(struct nfsd4_compoundres *resp)
680{
681 struct nfsd4_compoundargs *args = resp->rqstp->rq_argp;
468de9e5 682 return resp->opcnt == 1 && args->ops[0].opnum == OP_SEQUENCE;
bf864a31
AA
683}
684
085def3a
BF
685/*
686 * The session reply cache only needs to cache replies that the client
687 * actually asked us to. But it's almost free for us to cache compounds
688 * consisting of only a SEQUENCE op, so we may as well cache those too.
689 * Also, the protocol doesn't give us a convenient response in the case
690 * of a replay of a solo SEQUENCE op that wasn't cached
691 * (RETRY_UNCACHED_REP can only be returned in the second op of a
692 * compound).
693 */
694static inline bool nfsd4_cache_this(struct nfsd4_compoundres *resp)
bf864a31 695{
085def3a 696 return (resp->cstate.slot->sl_flags & NFSD4_SLOT_CACHETHIS)
73e79482 697 || nfsd4_is_solo_sequence(resp);
bf864a31
AA
698}
699
9b3234b9
BF
700static inline bool nfsd4_last_compound_op(struct svc_rqst *rqstp)
701{
702 struct nfsd4_compoundres *resp = rqstp->rq_resp;
703 struct nfsd4_compoundargs *argp = rqstp->rq_argp;
704
705 return argp->opcnt == resp->opcnt;
706}
707
f4f9ef4a 708const struct nfsd4_operation *OPDESC(struct nfsd4_op *op);
4f0cefbf 709int nfsd4_max_reply(struct svc_rqst *rqstp, struct nfsd4_op *op);
07d1f802
BF
710void warn_on_nonidempotent_op(struct nfsd4_op *op);
711
1da177e4
LT
712#define NFS4_SVC_XDRSIZE sizeof(struct nfsd4_compoundargs)
713
714static inline void
715set_change_info(struct nfsd4_change_info *cinfo, struct svc_fh *fhp)
716{
c1ac3ffc 717 BUG_ON(!fhp->fh_pre_saved);
aaf91ec1 718 cinfo->atomic = (u32)fhp->fh_post_saved;
2b0143b5 719 cinfo->change_supported = IS_I_VERSION(d_inode(fhp->fh_dentry));
c1ac3ffc
NB
720
721 cinfo->before_change = fhp->fh_pre_change;
722 cinfo->after_change = fhp->fh_post_change;
723 cinfo->before_ctime_sec = fhp->fh_pre_ctime.tv_sec;
724 cinfo->before_ctime_nsec = fhp->fh_pre_ctime.tv_nsec;
725 cinfo->after_ctime_sec = fhp->fh_post_attr.ctime.tv_sec;
726 cinfo->after_ctime_nsec = fhp->fh_post_attr.ctime.tv_nsec;
727
1da177e4
LT
728}
729
dedeb13f
AE
730
731bool nfsd4_mach_creds_match(struct nfs4_client *cl, struct svc_rqst *rqstp);
63f8de37 732int nfs4svc_encode_voidres(struct svc_rqst *, __be32 *);
026fec7e 733int nfs4svc_decode_compoundargs(struct svc_rqst *, __be32 *);
63f8de37 734int nfs4svc_encode_compoundres(struct svc_rqst *, __be32 *);
57b7b43b 735__be32 nfsd4_check_resp_size(struct nfsd4_compoundres *, u32);
1da177e4 736void nfsd4_encode_operation(struct nfsd4_compoundres *, struct nfsd4_op *);
d0a381dd 737void nfsd4_encode_replay(struct xdr_stream *xdr, struct nfsd4_op *op);
d5184658
BF
738__be32 nfsd4_encode_fattr_to_buf(__be32 **p, int words,
739 struct svc_fh *fhp, struct svc_export *exp,
740 struct dentry *dentry,
741 u32 *bmval, struct svc_rqst *, int ignore_crossmnt);
b37ad28b 742extern __be32 nfsd4_setclientid(struct svc_rqst *rqstp,
eb69853d 743 struct nfsd4_compound_state *, union nfsd4_op_u *u);
b37ad28b 744extern __be32 nfsd4_setclientid_confirm(struct svc_rqst *rqstp,
eb69853d 745 struct nfsd4_compound_state *, union nfsd4_op_u *u);
069b6ad4 746extern __be32 nfsd4_exchange_id(struct svc_rqst *rqstp,
eb69853d
CH
747 struct nfsd4_compound_state *, union nfsd4_op_u *u);
748extern __be32 nfsd4_backchannel_ctl(struct svc_rqst *,
749 struct nfsd4_compound_state *, union nfsd4_op_u *u);
750extern __be32 nfsd4_bind_conn_to_session(struct svc_rqst *,
751 struct nfsd4_compound_state *, union nfsd4_op_u *u);
3c4ab2aa 752extern __be32 nfsd4_create_session(struct svc_rqst *,
eb69853d 753 struct nfsd4_compound_state *, union nfsd4_op_u *u);
069b6ad4 754extern __be32 nfsd4_sequence(struct svc_rqst *,
eb69853d 755 struct nfsd4_compound_state *, union nfsd4_op_u *u);
b607664e 756extern void nfsd4_sequence_done(struct nfsd4_compoundres *resp);
069b6ad4 757extern __be32 nfsd4_destroy_session(struct svc_rqst *,
eb69853d
CH
758 struct nfsd4_compound_state *, union nfsd4_op_u *u);
759extern __be32 nfsd4_destroy_clientid(struct svc_rqst *, struct nfsd4_compound_state *,
760 union nfsd4_op_u *u);
761__be32 nfsd4_reclaim_complete(struct svc_rqst *, struct nfsd4_compound_state *,
762 union nfsd4_op_u *u);
6668958f 763extern __be32 nfsd4_process_open1(struct nfsd4_compound_state *,
3320fef1 764 struct nfsd4_open *open, struct nfsd_net *nn);
b37ad28b 765extern __be32 nfsd4_process_open2(struct svc_rqst *rqstp,
1da177e4 766 struct svc_fh *current_fh, struct nfsd4_open *open);
58fb12e6
JL
767extern void nfsd4_cstate_clear_replay(struct nfsd4_compound_state *cstate);
768extern void nfsd4_cleanup_open_state(struct nfsd4_compound_state *cstate,
42297899 769 struct nfsd4_open *open);
b37ad28b 770extern __be32 nfsd4_open_confirm(struct svc_rqst *rqstp,
eb69853d
CH
771 struct nfsd4_compound_state *, union nfsd4_op_u *u);
772extern __be32 nfsd4_close(struct svc_rqst *rqstp, struct nfsd4_compound_state *,
773 union nfsd4_op_u *u);
b37ad28b 774extern __be32 nfsd4_open_downgrade(struct svc_rqst *rqstp,
eb69853d 775 struct nfsd4_compound_state *, union nfsd4_op_u *u);
ca364317 776extern __be32 nfsd4_lock(struct svc_rqst *rqstp, struct nfsd4_compound_state *,
eb69853d
CH
777 union nfsd4_op_u *u);
778extern __be32 nfsd4_lockt(struct svc_rqst *rqstp, struct nfsd4_compound_state *,
779 union nfsd4_op_u *u);
780extern __be32 nfsd4_locku(struct svc_rqst *rqstp, struct nfsd4_compound_state *,
781 union nfsd4_op_u *u);
b37ad28b 782extern __be32
1da177e4 783nfsd4_release_lockowner(struct svc_rqst *rqstp,
eb69853d 784 struct nfsd4_compound_state *, union nfsd4_op_u *u);
8537488b 785extern void nfsd4_release_compoundargs(struct svc_rqst *rqstp);
b37ad28b 786extern __be32 nfsd4_delegreturn(struct svc_rqst *rqstp,
eb69853d
CH
787 struct nfsd4_compound_state *, union nfsd4_op_u *u);
788extern __be32 nfsd4_renew(struct svc_rqst *rqstp, struct nfsd4_compound_state *,
789 union nfsd4_op_u *u);
17456804 790extern __be32 nfsd4_test_stateid(struct svc_rqst *rqstp,
eb69853d 791 struct nfsd4_compound_state *, union nfsd4_op_u *);
e1ca12df 792extern __be32 nfsd4_free_stateid(struct svc_rqst *rqstp,
eb69853d 793 struct nfsd4_compound_state *, union nfsd4_op_u *);
9411b1d4 794extern void nfsd4_bump_seqid(struct nfsd4_compound_state *, __be32 nfserr);
58fb12e6 795
0020939f
BF
796enum nfsd4_op_flags {
797 ALLOWED_WITHOUT_FH = 1 << 0, /* No current filehandle required */
798 ALLOWED_ON_ABSENT_FS = 1 << 1, /* ops processed on absent fs */
799 ALLOWED_AS_FIRST_OP = 1 << 2, /* ops reqired first in compound */
800 /* For rfc 5661 section 2.6.3.1.1: */
801 OP_HANDLES_WRONGSEC = 1 << 3,
802 OP_IS_PUTFH_LIKE = 1 << 4,
803 /*
804 * These are the ops whose result size we estimate before
805 * encoding, to avoid performing an op then not being able to
806 * respond or cache a response. This includes writes and setattrs
807 * as well as the operations usually called "nonidempotent":
808 */
809 OP_MODIFIES_SOMETHING = 1 << 5,
810 /*
811 * Cache compounds containing these ops in the xid-based drc:
812 * We use the DRC for compounds containing non-idempotent
813 * operations, *except* those that are 4.1-specific (since
814 * sessions provide their own EOS), and except for stateful
815 * operations other than setclientid and setclientid_confirm
816 * (since sequence numbers provide EOS for open, lock, etc in
817 * the v4.0 case).
818 */
819 OP_CACHEME = 1 << 6,
820 /*
821 * These are ops which clear current state id.
822 */
823 OP_CLEAR_STATEID = 1 << 7,
b7571e4c
BF
824 /* Most ops return only an error on failure; some may do more: */
825 OP_NONTRIVIAL_ERROR_ENCODE = 1 << 8,
0020939f
BF
826};
827
828struct nfsd4_operation {
829 __be32 (*op_func)(struct svc_rqst *, struct nfsd4_compound_state *,
830 union nfsd4_op_u *);
34b1744c 831 void (*op_release)(union nfsd4_op_u *);
0020939f
BF
832 u32 op_flags;
833 char *op_name;
834 /* Try to get response size before operation */
835 u32 (*op_rsize_bop)(struct svc_rqst *, struct nfsd4_op *);
836 void (*op_get_currentstateid)(struct nfsd4_compound_state *,
837 union nfsd4_op_u *);
838 void (*op_set_currentstateid)(struct nfsd4_compound_state *,
839 union nfsd4_op_u *);
840};
841
842
1da177e4
LT
843#endif
844
845/*
846 * Local variables:
847 * c-basic-offset: 8
848 * End:
849 */