]> git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/blame - include/linux/nfsd/xdr4.h
nfsd41: SUPPATTR_EXCLCREAT attribute
[mirror_ubuntu-jammy-kernel.git] / include / linux / nfsd / xdr4.h
CommitLineData
1da177e4
LT
1/*
2 * include/linux/nfsd/xdr4.h
3 *
4 * Server-side types for NFSv4.
5 *
6 * Copyright (c) 2002 The Regents of the University of Michigan.
7 * All rights reserved.
8 *
9 * Kendrick Smith <kmsmith@umich.edu>
10 * Andy Adamson <andros@umich.edu>
11 *
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
14 * are met:
15 *
16 * 1. Redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer.
18 * 2. Redistributions in binary form must reproduce the above copyright
19 * notice, this list of conditions and the following disclaimer in the
20 * documentation and/or other materials provided with the distribution.
21 * 3. Neither the name of the University nor the names of its
22 * contributors may be used to endorse or promote products derived
23 * from this software without specific prior written permission.
24 *
25 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED
26 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
27 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
28 * DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
29 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
30 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
31 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
32 * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 *
37 */
38
39#ifndef _LINUX_NFSD_XDR4_H
40#define _LINUX_NFSD_XDR4_H
41
42#include <linux/nfs4.h>
43
44#define NFSD4_MAX_TAGLEN 128
45#define XDR_LEN(n) (((n) + 3) & ~3)
46
ca364317 47struct nfsd4_compound_state {
e354d571
AA
48 struct svc_fh current_fh;
49 struct svc_fh save_fh;
50 struct nfs4_stateowner *replay_owner;
b85d4c01
BH
51 /* For sessions DRC */
52 struct nfsd4_session *session;
53 struct nfsd4_slot *slot;
074fe897 54 __be32 *statp;
da3846a2 55 size_t iovlen;
d87a8ade 56 u32 minorversion;
074fe897 57 u32 status;
ca364317
BF
58};
59
6668958f
AA
60static inline bool nfsd4_has_session(struct nfsd4_compound_state *cs)
61{
62 return cs->slot != NULL;
63}
64
1da177e4
LT
65struct nfsd4_change_info {
66 u32 atomic;
67 u32 before_ctime_sec;
68 u32 before_ctime_nsec;
69 u32 after_ctime_sec;
70 u32 after_ctime_nsec;
71};
72
73struct nfsd4_access {
74 u32 ac_req_access; /* request */
75 u32 ac_supported; /* response */
76 u32 ac_resp_access; /* response */
77};
78
79struct nfsd4_close {
80 u32 cl_seqid; /* request */
81 stateid_t cl_stateid; /* request+response */
82 struct nfs4_stateowner * cl_stateowner; /* response */
83};
84
85struct nfsd4_commit {
86 u64 co_offset; /* request */
87 u32 co_count; /* request */
88 nfs4_verifier co_verf; /* response */
89};
90
91struct nfsd4_create {
92 u32 cr_namelen; /* request */
93 char * cr_name; /* request */
94 u32 cr_type; /* request */
95 union { /* request */
96 struct {
97 u32 namelen;
98 char *name;
99 } link; /* NF4LNK */
100 struct {
101 u32 specdata1;
102 u32 specdata2;
103 } dev; /* NF4BLK, NF4CHR */
104 } u;
7e705706 105 u32 cr_bmval[3]; /* request */
1da177e4
LT
106 struct iattr cr_iattr; /* request */
107 struct nfsd4_change_info cr_cinfo; /* response */
108 struct nfs4_acl *cr_acl;
109};
110#define cr_linklen u.link.namelen
111#define cr_linkname u.link.name
112#define cr_specdata1 u.dev.specdata1
113#define cr_specdata2 u.dev.specdata2
114
115struct nfsd4_delegreturn {
116 stateid_t dr_stateid;
117};
118
119struct nfsd4_getattr {
7e705706 120 u32 ga_bmval[3]; /* request */
1da177e4
LT
121 struct svc_fh *ga_fhp; /* response */
122};
123
124struct nfsd4_link {
125 u32 li_namelen; /* request */
126 char * li_name; /* request */
127 struct nfsd4_change_info li_cinfo; /* response */
128};
129
130struct nfsd4_lock_denied {
131 clientid_t ld_clientid;
132 struct nfs4_stateowner *ld_sop;
133 u64 ld_start;
134 u64 ld_length;
135 u32 ld_type;
136};
137
138struct nfsd4_lock {
139 /* request */
140 u32 lk_type;
141 u32 lk_reclaim; /* boolean */
142 u64 lk_offset;
143 u64 lk_length;
144 u32 lk_is_new;
145 union {
146 struct {
147 u32 open_seqid;
148 stateid_t open_stateid;
149 u32 lock_seqid;
150 clientid_t clientid;
151 struct xdr_netobj owner;
152 } new;
153 struct {
154 stateid_t lock_stateid;
155 u32 lock_seqid;
156 } old;
157 } v;
158
159 /* response */
160 union {
161 struct {
162 stateid_t stateid;
163 } ok;
164 struct nfsd4_lock_denied denied;
165 } u;
3a65588a
BF
166 /* The lk_replay_owner is the open owner in the open_to_lock_owner
167 * case and the lock owner otherwise: */
168 struct nfs4_stateowner *lk_replay_owner;
1da177e4
LT
169};
170#define lk_new_open_seqid v.new.open_seqid
171#define lk_new_open_stateid v.new.open_stateid
172#define lk_new_lock_seqid v.new.lock_seqid
173#define lk_new_clientid v.new.clientid
174#define lk_new_owner v.new.owner
175#define lk_old_lock_stateid v.old.lock_stateid
176#define lk_old_lock_seqid v.old.lock_seqid
177
178#define lk_rflags u.ok.rflags
179#define lk_resp_stateid u.ok.stateid
180#define lk_denied u.denied
181
182
183struct nfsd4_lockt {
184 u32 lt_type;
185 clientid_t lt_clientid;
186 struct xdr_netobj lt_owner;
187 u64 lt_offset;
188 u64 lt_length;
189 struct nfs4_stateowner * lt_stateowner;
190 struct nfsd4_lock_denied lt_denied;
191};
192
193
194struct nfsd4_locku {
195 u32 lu_type;
196 u32 lu_seqid;
197 stateid_t lu_stateid;
198 u64 lu_offset;
199 u64 lu_length;
200 struct nfs4_stateowner *lu_stateowner;
201};
202
203
204struct nfsd4_lookup {
205 u32 lo_len; /* request */
206 char * lo_name; /* request */
207};
208
209struct nfsd4_putfh {
210 u32 pf_fhlen; /* request */
211 char *pf_fhval; /* request */
212};
213
214struct nfsd4_open {
215 u32 op_claim_type; /* request */
216 struct xdr_netobj op_fname; /* request - everything but CLAIM_PREV */
217 u32 op_delegate_type; /* request - CLAIM_PREV only */
218 stateid_t op_delegate_stateid; /* request - response */
219 u32 op_create; /* request */
220 u32 op_createmode; /* request */
7e705706 221 u32 op_bmval[3]; /* request */
1da177e4
LT
222 union { /* request */
223 struct iattr iattr; /* UNCHECKED4,GUARDED4 */
224 nfs4_verifier verf; /* EXCLUSIVE4 */
225 } u;
226 clientid_t op_clientid; /* request */
227 struct xdr_netobj op_owner; /* request */
228 u32 op_seqid; /* request */
229 u32 op_share_access; /* request */
230 u32 op_share_deny; /* request */
231 stateid_t op_stateid; /* response */
7b190fec 232 u32 op_recall; /* recall */
1da177e4
LT
233 struct nfsd4_change_info op_cinfo; /* response */
234 u32 op_rflags; /* response */
235 int op_truncate; /* used during processing */
236 struct nfs4_stateowner *op_stateowner; /* used during processing */
237 struct nfs4_acl *op_acl;
238};
239#define op_iattr u.iattr
240#define op_verf u.verf
241
242struct nfsd4_open_confirm {
243 stateid_t oc_req_stateid /* request */;
244 u32 oc_seqid /* request */;
245 stateid_t oc_resp_stateid /* response */;
246 struct nfs4_stateowner * oc_stateowner; /* response */
247};
248
249struct nfsd4_open_downgrade {
250 stateid_t od_stateid;
251 u32 od_seqid;
252 u32 od_share_access;
253 u32 od_share_deny;
254 struct nfs4_stateowner *od_stateowner;
255};
256
257
258struct nfsd4_read {
259 stateid_t rd_stateid; /* request */
260 u64 rd_offset; /* request */
261 u32 rd_length; /* request */
1da177e4
LT
262 int rd_vlen;
263 struct file *rd_filp;
264
265 struct svc_rqst *rd_rqstp; /* response */
266 struct svc_fh * rd_fhp; /* response */
267};
268
269struct nfsd4_readdir {
270 u64 rd_cookie; /* request */
271 nfs4_verifier rd_verf; /* request */
272 u32 rd_dircount; /* request */
273 u32 rd_maxcount; /* request */
7e705706 274 u32 rd_bmval[3]; /* request */
1da177e4
LT
275 struct svc_rqst *rd_rqstp; /* response */
276 struct svc_fh * rd_fhp; /* response */
277
278 struct readdir_cd common;
2ebbc012 279 __be32 * buffer;
1da177e4 280 int buflen;
2ebbc012 281 __be32 * offset;
1da177e4
LT
282};
283
284struct nfsd4_release_lockowner {
285 clientid_t rl_clientid;
286 struct xdr_netobj rl_owner;
287};
288struct nfsd4_readlink {
289 struct svc_rqst *rl_rqstp; /* request */
290 struct svc_fh * rl_fhp; /* request */
291};
292
293struct nfsd4_remove {
294 u32 rm_namelen; /* request */
295 char * rm_name; /* request */
296 struct nfsd4_change_info rm_cinfo; /* response */
297};
298
299struct nfsd4_rename {
300 u32 rn_snamelen; /* request */
301 char * rn_sname; /* request */
302 u32 rn_tnamelen; /* request */
303 char * rn_tname; /* request */
304 struct nfsd4_change_info rn_sinfo; /* response */
305 struct nfsd4_change_info rn_tinfo; /* response */
306};
307
dcb488a3
AA
308struct nfsd4_secinfo {
309 u32 si_namelen; /* request */
310 char *si_name; /* request */
311 struct svc_export *si_exp; /* response */
312};
313
1da177e4
LT
314struct nfsd4_setattr {
315 stateid_t sa_stateid; /* request */
7e705706 316 u32 sa_bmval[3]; /* request */
1da177e4
LT
317 struct iattr sa_iattr; /* request */
318 struct nfs4_acl *sa_acl;
319};
320
321struct nfsd4_setclientid {
322 nfs4_verifier se_verf; /* request */
323 u32 se_namelen; /* request */
324 char * se_name; /* request */
325 u32 se_callback_prog; /* request */
326 u32 se_callback_netid_len; /* request */
327 char * se_callback_netid_val; /* request */
328 u32 se_callback_addr_len; /* request */
329 char * se_callback_addr_val; /* request */
330 u32 se_callback_ident; /* request */
331 clientid_t se_clientid; /* response */
332 nfs4_verifier se_confirm; /* response */
333};
334
335struct nfsd4_setclientid_confirm {
336 clientid_t sc_clientid;
337 nfs4_verifier sc_confirm;
338};
339
340/* also used for NVERIFY */
341struct nfsd4_verify {
7e705706 342 u32 ve_bmval[3]; /* request */
1da177e4
LT
343 u32 ve_attrlen; /* request */
344 char * ve_attrval; /* request */
345};
346
347struct nfsd4_write {
348 stateid_t wr_stateid; /* request */
349 u64 wr_offset; /* request */
350 u32 wr_stable_how; /* request */
351 u32 wr_buflen; /* request */
1da177e4
LT
352 int wr_vlen;
353
354 u32 wr_bytes_written; /* response */
355 u32 wr_how_written; /* response */
356 nfs4_verifier wr_verifier; /* response */
357};
358
2db134eb 359struct nfsd4_exchange_id {
0733d213
AA
360 nfs4_verifier verifier;
361 struct xdr_netobj clname;
362 u32 flags;
363 clientid_t clientid;
364 u32 seqid;
365 int spa_how;
2db134eb
AA
366};
367
ec6b5d7b
AA
368struct nfsd4_channel_attrs {
369 u32 headerpadsz;
370 u32 maxreq_sz;
371 u32 maxresp_sz;
372 u32 maxresp_cached;
373 u32 maxops;
374 u32 maxreqs;
375 u32 nr_rdma_attrs;
376 u32 rdma_attrs;
377};
378
2db134eb 379struct nfsd4_create_session {
ec6b5d7b
AA
380 clientid_t clientid;
381 struct nfs4_sessionid sessionid;
382 u32 seqid;
383 u32 flags;
384 struct nfsd4_channel_attrs fore_channel;
385 struct nfsd4_channel_attrs back_channel;
386 u32 callback_prog;
387 u32 uid;
388 u32 gid;
2db134eb
AA
389};
390
391struct nfsd4_sequence {
b85d4c01
BH
392 struct nfs4_sessionid sessionid; /* request/response */
393 u32 seqid; /* request/response */
394 u32 slotid; /* request/response */
395 u32 maxslots; /* request/response */
396 u32 cachethis; /* request */
397#if 0
398 u32 target_maxslots; /* response */
399 u32 status_flags; /* response */
400#endif /* not yet */
2db134eb
AA
401};
402
403struct nfsd4_destroy_session {
e10e0cfc 404 struct nfs4_sessionid sessionid;
2db134eb
AA
405};
406
1da177e4
LT
407struct nfsd4_op {
408 int opnum;
b37ad28b 409 __be32 status;
1da177e4
LT
410 union {
411 struct nfsd4_access access;
412 struct nfsd4_close close;
413 struct nfsd4_commit commit;
414 struct nfsd4_create create;
415 struct nfsd4_delegreturn delegreturn;
416 struct nfsd4_getattr getattr;
417 struct svc_fh * getfh;
418 struct nfsd4_link link;
419 struct nfsd4_lock lock;
420 struct nfsd4_lockt lockt;
421 struct nfsd4_locku locku;
422 struct nfsd4_lookup lookup;
423 struct nfsd4_verify nverify;
424 struct nfsd4_open open;
425 struct nfsd4_open_confirm open_confirm;
426 struct nfsd4_open_downgrade open_downgrade;
427 struct nfsd4_putfh putfh;
428 struct nfsd4_read read;
429 struct nfsd4_readdir readdir;
430 struct nfsd4_readlink readlink;
431 struct nfsd4_remove remove;
432 struct nfsd4_rename rename;
433 clientid_t renew;
dcb488a3 434 struct nfsd4_secinfo secinfo;
1da177e4
LT
435 struct nfsd4_setattr setattr;
436 struct nfsd4_setclientid setclientid;
437 struct nfsd4_setclientid_confirm setclientid_confirm;
438 struct nfsd4_verify verify;
439 struct nfsd4_write write;
440 struct nfsd4_release_lockowner release_lockowner;
2db134eb
AA
441
442 /* NFSv4.1 */
443 struct nfsd4_exchange_id exchange_id;
444 struct nfsd4_create_session create_session;
445 struct nfsd4_destroy_session destroy_session;
446 struct nfsd4_sequence sequence;
1da177e4
LT
447 } u;
448 struct nfs4_replay * replay;
449};
450
451struct nfsd4_compoundargs {
452 /* scratch variables for XDR decode */
2ebbc012
AV
453 __be32 * p;
454 __be32 * end;
1da177e4
LT
455 struct page ** pagelist;
456 int pagelen;
2ebbc012
AV
457 __be32 tmp[8];
458 __be32 * tmpp;
1da177e4
LT
459 struct tmpbuf {
460 struct tmpbuf *next;
461 void (*release)(const void *);
462 void *buf;
463 } *to_free;
464
465 struct svc_rqst *rqstp;
466
467 u32 taglen;
468 char * tag;
469 u32 minorversion;
470 u32 opcnt;
471 struct nfsd4_op *ops;
472 struct nfsd4_op iops[8];
473};
474
475struct nfsd4_compoundres {
476 /* scratch variables for XDR encode */
2ebbc012
AV
477 __be32 * p;
478 __be32 * end;
1da177e4
LT
479 struct xdr_buf * xbuf;
480 struct svc_rqst * rqstp;
481
482 u32 taglen;
483 char * tag;
484 u32 opcnt;
e354d571
AA
485 __be32 * tagp; /* tag, opcount encode location */
486 struct nfsd4_compound_state cstate;
1da177e4
LT
487};
488
bf864a31
AA
489static inline bool nfsd4_is_solo_sequence(struct nfsd4_compoundres *resp)
490{
491 struct nfsd4_compoundargs *args = resp->rqstp->rq_argp;
492 return args->opcnt == 1;
493}
494
495static inline bool nfsd4_not_cached(struct nfsd4_compoundres *resp)
496{
497 return !resp->cstate.slot->sl_cache_entry.ce_cachethis ||
498 nfsd4_is_solo_sequence(resp);
499}
500
1da177e4
LT
501#define NFS4_SVC_XDRSIZE sizeof(struct nfsd4_compoundargs)
502
503static inline void
504set_change_info(struct nfsd4_change_info *cinfo, struct svc_fh *fhp)
505{
506 BUG_ON(!fhp->fh_pre_saved || !fhp->fh_post_saved);
507 cinfo->atomic = 1;
508 cinfo->before_ctime_sec = fhp->fh_pre_ctime.tv_sec;
509 cinfo->before_ctime_nsec = fhp->fh_pre_ctime.tv_nsec;
40ee5dc6
PS
510 cinfo->after_ctime_sec = fhp->fh_post_attr.ctime.tv_sec;
511 cinfo->after_ctime_nsec = fhp->fh_post_attr.ctime.tv_nsec;
1da177e4
LT
512}
513
2ebbc012
AV
514int nfs4svc_encode_voidres(struct svc_rqst *, __be32 *, void *);
515int nfs4svc_decode_compoundargs(struct svc_rqst *, __be32 *,
1da177e4 516 struct nfsd4_compoundargs *);
2ebbc012 517int nfs4svc_encode_compoundres(struct svc_rqst *, __be32 *,
1da177e4
LT
518 struct nfsd4_compoundres *);
519void nfsd4_encode_operation(struct nfsd4_compoundres *, struct nfsd4_op *);
520void nfsd4_encode_replay(struct nfsd4_compoundres *resp, struct nfsd4_op *op);
b37ad28b
AV
521__be32 nfsd4_encode_fattr(struct svc_fh *fhp, struct svc_export *exp,
522 struct dentry *dentry, __be32 *buffer, int *countp,
406a7ea9 523 u32 *bmval, struct svc_rqst *, int ignore_crossmnt);
b37ad28b 524extern __be32 nfsd4_setclientid(struct svc_rqst *rqstp,
b591480b 525 struct nfsd4_compound_state *,
1da177e4 526 struct nfsd4_setclientid *setclid);
b37ad28b 527extern __be32 nfsd4_setclientid_confirm(struct svc_rqst *rqstp,
b591480b 528 struct nfsd4_compound_state *,
1da177e4 529 struct nfsd4_setclientid_confirm *setclientid_confirm);
074fe897 530extern void nfsd4_store_cache_entry(struct nfsd4_compoundres *resp);
bf864a31
AA
531extern __be32 nfsd4_replay_cache_entry(struct nfsd4_compoundres *resp,
532 struct nfsd4_sequence *seq);
069b6ad4
AA
533extern __be32 nfsd4_exchange_id(struct svc_rqst *rqstp,
534 struct nfsd4_compound_state *,
535struct nfsd4_exchange_id *);
536 extern __be32 nfsd4_create_session(struct svc_rqst *,
537 struct nfsd4_compound_state *,
538 struct nfsd4_create_session *);
539extern __be32 nfsd4_sequence(struct svc_rqst *,
540 struct nfsd4_compound_state *,
541 struct nfsd4_sequence *);
542extern __be32 nfsd4_destroy_session(struct svc_rqst *,
543 struct nfsd4_compound_state *,
544 struct nfsd4_destroy_session *);
6668958f
AA
545extern __be32 nfsd4_process_open1(struct nfsd4_compound_state *,
546 struct nfsd4_open *open);
b37ad28b 547extern __be32 nfsd4_process_open2(struct svc_rqst *rqstp,
1da177e4 548 struct svc_fh *current_fh, struct nfsd4_open *open);
b37ad28b 549extern __be32 nfsd4_open_confirm(struct svc_rqst *rqstp,
a4f1706a 550 struct nfsd4_compound_state *, struct nfsd4_open_confirm *oc);
ca364317
BF
551extern __be32 nfsd4_close(struct svc_rqst *rqstp,
552 struct nfsd4_compound_state *,
a4f1706a 553 struct nfsd4_close *close);
b37ad28b 554extern __be32 nfsd4_open_downgrade(struct svc_rqst *rqstp,
a4f1706a
BF
555 struct nfsd4_compound_state *,
556 struct nfsd4_open_downgrade *od);
ca364317 557extern __be32 nfsd4_lock(struct svc_rqst *rqstp, struct nfsd4_compound_state *,
a4f1706a 558 struct nfsd4_lock *lock);
ca364317
BF
559extern __be32 nfsd4_lockt(struct svc_rqst *rqstp,
560 struct nfsd4_compound_state *,
1da177e4 561 struct nfsd4_lockt *lockt);
ca364317
BF
562extern __be32 nfsd4_locku(struct svc_rqst *rqstp,
563 struct nfsd4_compound_state *,
a4f1706a 564 struct nfsd4_locku *locku);
b37ad28b 565extern __be32
1da177e4 566nfsd4_release_lockowner(struct svc_rqst *rqstp,
b591480b 567 struct nfsd4_compound_state *,
1da177e4
LT
568 struct nfsd4_release_lockowner *rlockowner);
569extern void nfsd4_release_compoundargs(struct nfsd4_compoundargs *);
b37ad28b 570extern __be32 nfsd4_delegreturn(struct svc_rqst *rqstp,
ca364317 571 struct nfsd4_compound_state *, struct nfsd4_delegreturn *dr);
b591480b
BF
572extern __be32 nfsd4_renew(struct svc_rqst *rqstp,
573 struct nfsd4_compound_state *, clientid_t *clid);
1da177e4
LT
574#endif
575
576/*
577 * Local variables:
578 * c-basic-offset: 8
579 * End:
580 */