1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef _LINUX_NFS_XDR_H
3 #define _LINUX_NFS_XDR_H
5 #include <linux/nfsacl.h>
6 #include <linux/sunrpc/gss_api.h>
9 * To change the maximum rsize and wsize supported by the NFS client, adjust
10 * NFS_MAX_FILE_IO_SIZE. 64KB is a typical maximum, but some servers can
11 * support a megabyte or more. The default is left at 4096 bytes, which is
12 * reasonable for NFS over UDP.
14 #define NFS_MAX_FILE_IO_SIZE (1048576U)
15 #define NFS_DEF_FILE_IO_SIZE (4096U)
16 #define NFS_MIN_FILE_IO_SIZE (1024U)
18 #define NFS_BITMASK_SZ 3
31 * Helper for checking equality between 2 fsids.
33 static inline int nfs_fsid_equal(const struct nfs_fsid *a, const struct nfs_fsid *b)
35 return a->major == b->major && a->minor == b->minor;
38 struct nfs4_threshold {
48 unsigned int valid; /* which fields are valid */
66 __u64 mounted_on_fileid;
67 struct timespec64 atime;
68 struct timespec64 mtime;
69 struct timespec64 ctime;
70 __u64 change_attr; /* NFSv4 change attribute */
71 __u64 pre_change_attr;/* pre-op NFSv4 change attribute */
72 __u64 pre_size; /* pre_op_attr.size */
73 struct timespec64 pre_mtime; /* pre_op_attr.mtime */
74 struct timespec64 pre_ctime; /* pre_op_attr.ctime */
75 unsigned long time_start;
76 unsigned long gencount;
77 struct nfs4_string *owner_name;
78 struct nfs4_string *group_name;
79 struct nfs4_threshold *mdsthreshold; /* pNFS threshold hints */
80 struct nfs4_label *label;
83 #define NFS_ATTR_FATTR_TYPE (1U << 0)
84 #define NFS_ATTR_FATTR_MODE (1U << 1)
85 #define NFS_ATTR_FATTR_NLINK (1U << 2)
86 #define NFS_ATTR_FATTR_OWNER (1U << 3)
87 #define NFS_ATTR_FATTR_GROUP (1U << 4)
88 #define NFS_ATTR_FATTR_RDEV (1U << 5)
89 #define NFS_ATTR_FATTR_SIZE (1U << 6)
90 #define NFS_ATTR_FATTR_PRESIZE (1U << 7)
91 #define NFS_ATTR_FATTR_BLOCKS_USED (1U << 8)
92 #define NFS_ATTR_FATTR_SPACE_USED (1U << 9)
93 #define NFS_ATTR_FATTR_FSID (1U << 10)
94 #define NFS_ATTR_FATTR_FILEID (1U << 11)
95 #define NFS_ATTR_FATTR_ATIME (1U << 12)
96 #define NFS_ATTR_FATTR_MTIME (1U << 13)
97 #define NFS_ATTR_FATTR_CTIME (1U << 14)
98 #define NFS_ATTR_FATTR_PREMTIME (1U << 15)
99 #define NFS_ATTR_FATTR_PRECTIME (1U << 16)
100 #define NFS_ATTR_FATTR_CHANGE (1U << 17)
101 #define NFS_ATTR_FATTR_PRECHANGE (1U << 18)
102 #define NFS_ATTR_FATTR_V4_LOCATIONS (1U << 19)
103 #define NFS_ATTR_FATTR_V4_REFERRAL (1U << 20)
104 #define NFS_ATTR_FATTR_MOUNTPOINT (1U << 21)
105 #define NFS_ATTR_FATTR_MOUNTED_ON_FILEID (1U << 22)
106 #define NFS_ATTR_FATTR_OWNER_NAME (1U << 23)
107 #define NFS_ATTR_FATTR_GROUP_NAME (1U << 24)
108 #define NFS_ATTR_FATTR_V4_SECURITY_LABEL (1U << 25)
110 #define NFS_ATTR_FATTR (NFS_ATTR_FATTR_TYPE \
111 | NFS_ATTR_FATTR_MODE \
112 | NFS_ATTR_FATTR_NLINK \
113 | NFS_ATTR_FATTR_OWNER \
114 | NFS_ATTR_FATTR_GROUP \
115 | NFS_ATTR_FATTR_RDEV \
116 | NFS_ATTR_FATTR_SIZE \
117 | NFS_ATTR_FATTR_FSID \
118 | NFS_ATTR_FATTR_FILEID \
119 | NFS_ATTR_FATTR_ATIME \
120 | NFS_ATTR_FATTR_MTIME \
121 | NFS_ATTR_FATTR_CTIME \
122 | NFS_ATTR_FATTR_CHANGE)
123 #define NFS_ATTR_FATTR_V2 (NFS_ATTR_FATTR \
124 | NFS_ATTR_FATTR_BLOCKS_USED)
125 #define NFS_ATTR_FATTR_V3 (NFS_ATTR_FATTR \
126 | NFS_ATTR_FATTR_SPACE_USED)
127 #define NFS_ATTR_FATTR_V4 (NFS_ATTR_FATTR \
128 | NFS_ATTR_FATTR_SPACE_USED \
129 | NFS_ATTR_FATTR_V4_SECURITY_LABEL)
132 * Maximal number of supported layout drivers.
134 #define NFS_MAX_LAYOUT_TYPES 8
137 * Info on the file system
140 struct nfs_fattr *fattr; /* Post-op attributes */
141 __u32 rtmax; /* max. read transfer size */
142 __u32 rtpref; /* pref. read transfer size */
143 __u32 rtmult; /* reads should be multiple of this */
144 __u32 wtmax; /* max. write transfer size */
145 __u32 wtpref; /* pref. write transfer size */
146 __u32 wtmult; /* writes should be multiple of this */
147 __u32 dtpref; /* pref. readdir transfer size */
149 struct timespec64 time_delta; /* server time granularity */
150 __u32 lease_time; /* in seconds */
151 __u32 nlayouttypes; /* number of layouttypes */
152 __u32 layouttype[NFS_MAX_LAYOUT_TYPES]; /* supported pnfs layout driver */
153 __u32 blksize; /* preferred pnfs io block size */
154 __u32 clone_blksize; /* granularity of a CLONE operation */
155 enum nfs4_change_attr_type
156 change_attr_type; /* Info about change attr */
157 __u32 xattr_support; /* User xattrs supported */
161 struct nfs_fattr *fattr; /* Post-op attributes */
162 __u64 tbytes; /* total size in bytes */
163 __u64 fbytes; /* # of free bytes */
164 __u64 abytes; /* # of bytes available to user */
165 __u64 tfiles; /* # of files */
166 __u64 ffiles; /* # of free files */
167 __u64 afiles; /* # of files available to user */
171 __u32 tsize; /* Server transfer size */
172 __u32 bsize; /* Filesystem block size */
173 __u32 blocks; /* No. of "bsize" blocks on filesystem */
174 __u32 bfree; /* No. of free "bsize" blocks */
175 __u32 bavail; /* No. of available "bsize" blocks */
178 struct nfs_pathconf {
179 struct nfs_fattr *fattr; /* Post-op attributes */
180 __u32 max_link; /* max # of hard links */
181 __u32 max_namelen; /* max name length */
184 struct nfs4_change_info {
192 /* nfs41 sessions channel attributes */
193 struct nfs4_channel_attrs {
196 u32 max_resp_sz_cached;
202 struct nfs4_sequence_args {
203 struct nfs4_slot *sa_slot;
204 u8 sa_cache_this : 1,
208 struct nfs4_sequence_res {
209 struct nfs4_slot *sr_slot; /* slot used to send request */
210 unsigned long sr_timestamp;
211 int sr_status; /* sequence operation status */
213 u32 sr_highest_slotid;
214 u32 sr_target_highest_slotid;
217 struct nfs4_get_lease_time_args {
218 struct nfs4_sequence_args la_seq_args;
221 struct nfs4_get_lease_time_res {
222 struct nfs4_sequence_res lr_seq_res;
223 struct nfs_fsinfo *lr_fsinfo;
227 struct nfs4_xdr_opaque_data;
229 struct nfs4_xdr_opaque_ops {
230 void (*encode)(struct xdr_stream *, const void *args,
231 const struct nfs4_xdr_opaque_data *);
232 void (*free)(struct nfs4_xdr_opaque_data *);
235 struct nfs4_xdr_opaque_data {
236 const struct nfs4_xdr_opaque_ops *ops;
240 #define PNFS_LAYOUT_MAXSIZE 4096
242 struct nfs4_layoutdriver_data {
248 struct pnfs_layout_range {
254 struct nfs4_layoutget_args {
255 struct nfs4_sequence_args seq_args;
257 struct pnfs_layout_range range;
261 struct nfs_open_context *ctx;
262 nfs4_stateid stateid;
263 struct nfs4_layoutdriver_data layout;
266 struct nfs4_layoutget_res {
267 struct nfs4_sequence_res seq_res;
269 __u32 return_on_close;
270 struct pnfs_layout_range range;
272 nfs4_stateid stateid;
273 struct nfs4_layoutdriver_data *layoutp;
276 struct nfs4_layoutget {
277 struct nfs4_layoutget_args args;
278 struct nfs4_layoutget_res res;
279 const struct cred *cred;
280 struct pnfs_layout_hdr *lo;
284 struct nfs4_getdeviceinfo_args {
285 struct nfs4_sequence_args seq_args;
286 struct pnfs_device *pdev;
290 struct nfs4_getdeviceinfo_res {
291 struct nfs4_sequence_res seq_res;
292 struct pnfs_device *pdev;
296 struct nfs4_layoutcommit_args {
297 struct nfs4_sequence_args seq_args;
298 nfs4_stateid stateid;
299 __u64 lastbytewritten;
302 size_t layoutupdate_len;
303 struct page *layoutupdate_page;
304 struct page **layoutupdate_pages;
308 struct nfs4_layoutcommit_res {
309 struct nfs4_sequence_res seq_res;
310 struct nfs_fattr *fattr;
311 const struct nfs_server *server;
315 struct nfs4_layoutcommit_data {
316 struct rpc_task task;
317 struct nfs_fattr fattr;
318 struct list_head lseg_list;
319 const struct cred *cred;
321 struct nfs4_layoutcommit_args args;
322 struct nfs4_layoutcommit_res res;
325 struct nfs4_layoutreturn_args {
326 struct nfs4_sequence_args seq_args;
327 struct pnfs_layout_hdr *layout;
329 struct pnfs_layout_range range;
330 nfs4_stateid stateid;
332 struct nfs4_xdr_opaque_data *ld_private;
335 struct nfs4_layoutreturn_res {
336 struct nfs4_sequence_res seq_res;
338 nfs4_stateid stateid;
341 struct nfs4_layoutreturn {
342 struct nfs4_layoutreturn_args args;
343 struct nfs4_layoutreturn_res res;
344 const struct cred *cred;
345 struct nfs_client *clp;
348 struct nfs4_xdr_opaque_data ld_private;
351 #define PNFS_LAYOUTSTATS_MAXSIZE 256
353 struct nfs42_layoutstat_args;
354 struct nfs42_layoutstat_devinfo;
355 typedef void (*layoutstats_encode_t)(struct xdr_stream *,
356 struct nfs42_layoutstat_args *,
357 struct nfs42_layoutstat_devinfo *);
359 /* Per file per deviceid layoutstats */
360 struct nfs42_layoutstat_devinfo {
361 struct nfs4_deviceid dev_id;
369 struct nfs4_xdr_opaque_data ld_private;
372 struct nfs42_layoutstat_args {
373 struct nfs4_sequence_args seq_args;
376 nfs4_stateid stateid;
378 struct nfs42_layoutstat_devinfo *devinfo;
381 struct nfs42_layoutstat_res {
382 struct nfs4_sequence_res seq_res;
387 struct nfs42_layoutstat_data {
389 struct nfs42_layoutstat_args args;
390 struct nfs42_layoutstat_res res;
393 struct nfs42_device_error {
394 struct nfs4_deviceid dev_id;
396 enum nfs_opnum4 opnum;
399 struct nfs42_layout_error {
402 nfs4_stateid stateid;
403 struct nfs42_device_error errors[1];
406 #define NFS42_LAYOUTERROR_MAX 5
408 struct nfs42_layouterror_args {
409 struct nfs4_sequence_args seq_args;
411 unsigned int num_errors;
412 struct nfs42_layout_error errors[NFS42_LAYOUTERROR_MAX];
415 struct nfs42_layouterror_res {
416 struct nfs4_sequence_res seq_res;
417 unsigned int num_errors;
421 struct nfs42_layouterror_data {
422 struct nfs42_layouterror_args args;
423 struct nfs42_layouterror_res res;
425 struct pnfs_layout_segment *lseg;
428 struct nfs42_clone_args {
429 struct nfs4_sequence_args seq_args;
430 struct nfs_fh *src_fh;
431 struct nfs_fh *dst_fh;
432 nfs4_stateid src_stateid;
433 nfs4_stateid dst_stateid;
437 const u32 *dst_bitmask;
440 struct nfs42_clone_res {
441 struct nfs4_sequence_res seq_res;
442 unsigned int rpc_status;
443 struct nfs_fattr *dst_fattr;
444 const struct nfs_server *server;
447 struct stateowner_id {
453 * Arguments to the open call.
455 struct nfs_openargs {
456 struct nfs4_sequence_args seq_args;
457 const struct nfs_fh * fh;
458 struct nfs_seqid * seqid;
464 struct stateowner_id id;
467 struct iattr * attrs; /* UNCHECKED, GUARDED, EXCLUSIVE4_1 */
468 nfs4_verifier verifier; /* EXCLUSIVE */
470 nfs4_stateid delegation; /* CLAIM_DELEGATE_CUR */
471 fmode_t delegation_type; /* CLAIM_PREVIOUS */
473 const struct qstr * name;
474 const struct nfs_server *server; /* Needed for ID mapping */
476 const u32 * open_bitmap;
477 enum open_claim_type4 claim;
478 enum createmode4 createmode;
479 const struct nfs4_label *label;
481 struct nfs4_layoutget_args *lg_args;
485 struct nfs4_sequence_res seq_res;
486 nfs4_stateid stateid;
488 struct nfs4_change_info cinfo;
490 struct nfs_fattr * f_attr;
491 struct nfs_seqid * seqid;
492 const struct nfs_server *server;
493 fmode_t delegation_type;
494 nfs4_stateid delegation;
495 unsigned long pagemod_limit;
497 __u32 attrset[NFS4_BITMAP_SIZE];
498 struct nfs4_string *owner;
499 struct nfs4_string *group_owner;
500 __u32 access_request;
501 __u32 access_supported;
503 struct nfs4_layoutget_res *lg_res;
507 * Arguments to the open_confirm call.
509 struct nfs_open_confirmargs {
510 struct nfs4_sequence_args seq_args;
511 const struct nfs_fh * fh;
512 nfs4_stateid * stateid;
513 struct nfs_seqid * seqid;
516 struct nfs_open_confirmres {
517 struct nfs4_sequence_res seq_res;
518 nfs4_stateid stateid;
519 struct nfs_seqid * seqid;
523 * Arguments to the close call.
525 struct nfs_closeargs {
526 struct nfs4_sequence_args seq_args;
528 nfs4_stateid stateid;
529 struct nfs_seqid * seqid;
533 u32 bitmask_store[NFS_BITMASK_SZ];
534 struct nfs4_layoutreturn_args *lr_args;
537 struct nfs_closeres {
538 struct nfs4_sequence_res seq_res;
539 nfs4_stateid stateid;
540 struct nfs_fattr * fattr;
541 struct nfs_seqid * seqid;
542 const struct nfs_server *server;
543 struct nfs4_layoutreturn_res *lr_res;
547 * * Arguments to the lock,lockt, and locku call.
555 struct nfs_lock_args {
556 struct nfs4_sequence_args seq_args;
558 struct file_lock * fl;
559 struct nfs_seqid * lock_seqid;
560 nfs4_stateid lock_stateid;
561 struct nfs_seqid * open_seqid;
562 nfs4_stateid open_stateid;
563 struct nfs_lowner lock_owner;
564 unsigned char block : 1;
565 unsigned char reclaim : 1;
566 unsigned char new_lock : 1;
567 unsigned char new_lock_owner : 1;
570 struct nfs_lock_res {
571 struct nfs4_sequence_res seq_res;
572 nfs4_stateid stateid;
573 struct nfs_seqid * lock_seqid;
574 struct nfs_seqid * open_seqid;
577 struct nfs_locku_args {
578 struct nfs4_sequence_args seq_args;
580 struct file_lock * fl;
581 struct nfs_seqid * seqid;
582 nfs4_stateid stateid;
585 struct nfs_locku_res {
586 struct nfs4_sequence_res seq_res;
587 nfs4_stateid stateid;
588 struct nfs_seqid * seqid;
591 struct nfs_lockt_args {
592 struct nfs4_sequence_args seq_args;
594 struct file_lock * fl;
595 struct nfs_lowner lock_owner;
598 struct nfs_lockt_res {
599 struct nfs4_sequence_res seq_res;
600 struct file_lock * denied; /* LOCK, LOCKT failed */
603 struct nfs_release_lockowner_args {
604 struct nfs4_sequence_args seq_args;
605 struct nfs_lowner lock_owner;
608 struct nfs_release_lockowner_res {
609 struct nfs4_sequence_res seq_res;
612 struct nfs4_delegreturnargs {
613 struct nfs4_sequence_args seq_args;
614 const struct nfs_fh *fhandle;
615 const nfs4_stateid *stateid;
617 u32 bitmask_store[NFS_BITMASK_SZ];
618 struct nfs4_layoutreturn_args *lr_args;
621 struct nfs4_delegreturnres {
622 struct nfs4_sequence_res seq_res;
623 struct nfs_fattr * fattr;
624 struct nfs_server *server;
625 struct nfs4_layoutreturn_res *lr_res;
630 * Arguments to the write call.
632 struct nfs_write_verifier {
636 struct nfs_writeverf {
637 struct nfs_write_verifier verifier;
638 enum nfs3_stable_how committed;
642 * Arguments shared by the read and write call.
644 struct nfs_pgio_args {
645 struct nfs4_sequence_args seq_args;
647 struct nfs_open_context *context;
648 struct nfs_lock_context *lock_context;
649 nfs4_stateid stateid;
653 struct page ** pages;
655 unsigned int replen; /* used by read */
657 const u32 * bitmask; /* used by write */
658 u32 bitmask_store[NFS_BITMASK_SZ]; /* used by write */
659 enum nfs3_stable_how stable; /* used by write */
664 struct nfs_pgio_res {
665 struct nfs4_sequence_res seq_res;
666 struct nfs_fattr * fattr;
671 unsigned int replen; /* used by read */
672 int eof; /* used by read */
675 struct nfs_writeverf * verf; /* used by write */
676 const struct nfs_server *server; /* used by write */
682 * Arguments to the commit call.
684 struct nfs_commitargs {
685 struct nfs4_sequence_args seq_args;
692 struct nfs_commitres {
693 struct nfs4_sequence_res seq_res;
695 struct nfs_fattr *fattr;
696 struct nfs_writeverf *verf;
697 const struct nfs_server *server;
701 * Common arguments to the unlink call
703 struct nfs_removeargs {
704 struct nfs4_sequence_args seq_args;
705 const struct nfs_fh *fh;
709 struct nfs_removeres {
710 struct nfs4_sequence_res seq_res;
711 struct nfs_server *server;
712 struct nfs_fattr *dir_attr;
713 struct nfs4_change_info cinfo;
717 * Common arguments to the rename call
719 struct nfs_renameargs {
720 struct nfs4_sequence_args seq_args;
721 const struct nfs_fh *old_dir;
722 const struct nfs_fh *new_dir;
723 const struct qstr *old_name;
724 const struct qstr *new_name;
727 struct nfs_renameres {
728 struct nfs4_sequence_res seq_res;
729 struct nfs_server *server;
730 struct nfs4_change_info old_cinfo;
731 struct nfs_fattr *old_fattr;
732 struct nfs4_change_info new_cinfo;
733 struct nfs_fattr *new_fattr;
736 /* parsed sec= options */
737 #define NFS_AUTH_INFO_MAX_FLAVORS 12 /* see fs/nfs/super.c */
738 struct nfs_auth_info {
739 unsigned int flavor_len;
740 rpc_authflavor_t flavors[NFS_AUTH_INFO_MAX_FLAVORS];
744 * Argument struct for decode_entry function
753 struct nfs_fattr * fattr;
754 unsigned char d_type;
755 struct nfs_server * server;
758 struct nfs_readdir_arg {
759 struct dentry *dentry;
760 const struct cred *cred;
764 unsigned int page_len;
768 struct nfs_readdir_res {
773 * The following types are for NFSv2 only.
775 struct nfs_sattrargs {
777 struct iattr * sattr;
780 struct nfs_diropargs {
786 struct nfs_createargs {
790 struct iattr * sattr;
793 struct nfs_setattrargs {
794 struct nfs4_sequence_args seq_args;
796 nfs4_stateid stateid;
798 const struct nfs_server * server; /* Needed for name mapping */
800 const struct nfs4_label *label;
803 struct nfs_setaclargs {
804 struct nfs4_sequence_args seq_args;
807 struct page ** acl_pages;
810 struct nfs_setaclres {
811 struct nfs4_sequence_res seq_res;
814 struct nfs_getaclargs {
815 struct nfs4_sequence_args seq_args;
818 struct page ** acl_pages;
821 /* getxattr ACL interface flags */
822 #define NFS4_ACL_TRUNC 0x0001 /* ACL was truncated */
823 struct nfs_getaclres {
824 struct nfs4_sequence_res seq_res;
826 size_t acl_data_offset;
828 struct page * acl_scratch;
831 struct nfs_setattrres {
832 struct nfs4_sequence_res seq_res;
833 struct nfs_fattr * fattr;
834 const struct nfs_server * server;
837 struct nfs_linkargs {
838 struct nfs_fh * fromfh;
839 struct nfs_fh * tofh;
844 struct nfs_symlinkargs {
845 struct nfs_fh * fromfh;
846 const char * fromname;
847 unsigned int fromlen;
848 struct page ** pages;
849 unsigned int pathlen;
850 struct iattr * sattr;
853 struct nfs_readdirargs {
857 struct page ** pages;
860 struct nfs3_getaclargs {
863 struct page ** pages;
866 struct nfs3_setaclargs {
867 struct inode * inode;
869 struct posix_acl * acl_access;
870 struct posix_acl * acl_default;
873 struct page ** pages;
878 struct nfs_fattr * fattr;
881 struct nfs_readlinkargs {
885 struct page ** pages;
888 struct nfs3_sattrargs {
890 struct iattr * sattr;
892 struct timespec64 guardtime;
895 struct nfs3_diropargs {
901 struct nfs3_accessargs {
906 struct nfs3_createargs {
910 struct iattr * sattr;
911 enum nfs3_createmode createmode;
915 struct nfs3_mkdirargs {
919 struct iattr * sattr;
922 struct nfs3_symlinkargs {
923 struct nfs_fh * fromfh;
924 const char * fromname;
925 unsigned int fromlen;
926 struct page ** pages;
927 unsigned int pathlen;
928 struct iattr * sattr;
931 struct nfs3_mknodargs {
935 enum nfs3_ftype type;
936 struct iattr * sattr;
940 struct nfs3_linkargs {
941 struct nfs_fh * fromfh;
942 struct nfs_fh * tofh;
947 struct nfs3_readdirargs {
953 struct page ** pages;
956 struct nfs3_diropres {
957 struct nfs_fattr * dir_attr;
959 struct nfs_fattr * fattr;
962 struct nfs3_accessres {
963 struct nfs_fattr * fattr;
967 struct nfs3_readlinkargs {
971 struct page ** pages;
974 struct nfs3_linkres {
975 struct nfs_fattr * dir_attr;
976 struct nfs_fattr * fattr;
979 struct nfs3_readdirres {
980 struct nfs_fattr * dir_attr;
985 struct nfs3_getaclres {
986 struct nfs_fattr * fattr;
988 unsigned int acl_access_count;
989 unsigned int acl_default_count;
990 struct posix_acl * acl_access;
991 struct posix_acl * acl_default;
994 #if IS_ENABLED(CONFIG_NFS_V4)
996 typedef u64 clientid4;
998 struct nfs4_accessargs {
999 struct nfs4_sequence_args seq_args;
1000 const struct nfs_fh * fh;
1001 const u32 * bitmask;
1005 struct nfs4_accessres {
1006 struct nfs4_sequence_res seq_res;
1007 const struct nfs_server * server;
1008 struct nfs_fattr * fattr;
1013 struct nfs4_create_arg {
1014 struct nfs4_sequence_args seq_args;
1018 struct page ** pages;
1020 } symlink; /* NF4LNK */
1024 } device; /* NF4BLK, NF4CHR */
1026 const struct qstr * name;
1027 const struct nfs_server * server;
1028 const struct iattr * attrs;
1029 const struct nfs_fh * dir_fh;
1030 const u32 * bitmask;
1031 const struct nfs4_label *label;
1035 struct nfs4_create_res {
1036 struct nfs4_sequence_res seq_res;
1037 const struct nfs_server * server;
1039 struct nfs_fattr * fattr;
1040 struct nfs4_change_info dir_cinfo;
1043 struct nfs4_fsinfo_arg {
1044 struct nfs4_sequence_args seq_args;
1045 const struct nfs_fh * fh;
1046 const u32 * bitmask;
1049 struct nfs4_fsinfo_res {
1050 struct nfs4_sequence_res seq_res;
1051 struct nfs_fsinfo *fsinfo;
1054 struct nfs4_getattr_arg {
1055 struct nfs4_sequence_args seq_args;
1056 const struct nfs_fh * fh;
1057 const u32 * bitmask;
1060 struct nfs4_getattr_res {
1061 struct nfs4_sequence_res seq_res;
1062 const struct nfs_server * server;
1063 struct nfs_fattr * fattr;
1066 struct nfs4_link_arg {
1067 struct nfs4_sequence_args seq_args;
1068 const struct nfs_fh * fh;
1069 const struct nfs_fh * dir_fh;
1070 const struct qstr * name;
1071 const u32 * bitmask;
1074 struct nfs4_link_res {
1075 struct nfs4_sequence_res seq_res;
1076 const struct nfs_server * server;
1077 struct nfs_fattr * fattr;
1078 struct nfs4_change_info cinfo;
1079 struct nfs_fattr * dir_attr;
1082 struct nfs4_lookup_arg {
1083 struct nfs4_sequence_args seq_args;
1084 const struct nfs_fh * dir_fh;
1085 const struct qstr * name;
1086 const u32 * bitmask;
1089 struct nfs4_lookup_res {
1090 struct nfs4_sequence_res seq_res;
1091 const struct nfs_server * server;
1092 struct nfs_fattr * fattr;
1096 struct nfs4_lookupp_arg {
1097 struct nfs4_sequence_args seq_args;
1098 const struct nfs_fh *fh;
1102 struct nfs4_lookupp_res {
1103 struct nfs4_sequence_res seq_res;
1104 const struct nfs_server *server;
1105 struct nfs_fattr *fattr;
1109 struct nfs4_lookup_root_arg {
1110 struct nfs4_sequence_args seq_args;
1111 const u32 * bitmask;
1114 struct nfs4_pathconf_arg {
1115 struct nfs4_sequence_args seq_args;
1116 const struct nfs_fh * fh;
1117 const u32 * bitmask;
1120 struct nfs4_pathconf_res {
1121 struct nfs4_sequence_res seq_res;
1122 struct nfs_pathconf *pathconf;
1125 struct nfs4_readdir_arg {
1126 struct nfs4_sequence_args seq_args;
1127 const struct nfs_fh * fh;
1129 nfs4_verifier verifier;
1131 struct page ** pages; /* zero-copy data */
1132 unsigned int pgbase; /* zero-copy data */
1133 const u32 * bitmask;
1137 struct nfs4_readdir_res {
1138 struct nfs4_sequence_res seq_res;
1139 nfs4_verifier verifier;
1140 unsigned int pgbase;
1143 struct nfs4_readlink {
1144 struct nfs4_sequence_args seq_args;
1145 const struct nfs_fh * fh;
1146 unsigned int pgbase;
1147 unsigned int pglen; /* zero-copy data */
1148 struct page ** pages; /* zero-copy data */
1151 struct nfs4_readlink_res {
1152 struct nfs4_sequence_res seq_res;
1155 struct nfs4_setclientid {
1156 const nfs4_verifier * sc_verifier;
1158 unsigned int sc_netid_len;
1159 char sc_netid[RPCBIND_MAXNETIDLEN + 1];
1160 unsigned int sc_uaddr_len;
1161 char sc_uaddr[RPCBIND_MAXUADDRLEN + 1];
1162 struct nfs_client *sc_clnt;
1163 struct rpc_cred *sc_cred;
1166 struct nfs4_setclientid_res {
1168 nfs4_verifier confirm;
1171 struct nfs4_statfs_arg {
1172 struct nfs4_sequence_args seq_args;
1173 const struct nfs_fh * fh;
1174 const u32 * bitmask;
1177 struct nfs4_statfs_res {
1178 struct nfs4_sequence_res seq_res;
1179 struct nfs_fsstat *fsstat;
1182 struct nfs4_server_caps_arg {
1183 struct nfs4_sequence_args seq_args;
1184 struct nfs_fh *fhandle;
1185 const u32 * bitmask;
1188 struct nfs4_server_caps_res {
1189 struct nfs4_sequence_res seq_res;
1190 u32 attr_bitmask[3];
1191 u32 exclcreat_bitmask[3];
1196 u32 case_insensitive;
1197 u32 case_preserving;
1200 #define NFS4_PATHNAME_MAXCOMPONENTS 512
1201 struct nfs4_pathname {
1202 unsigned int ncomponents;
1203 struct nfs4_string components[NFS4_PATHNAME_MAXCOMPONENTS];
1206 #define NFS4_FS_LOCATION_MAXSERVERS 10
1207 struct nfs4_fs_location {
1208 unsigned int nservers;
1209 struct nfs4_string servers[NFS4_FS_LOCATION_MAXSERVERS];
1210 struct nfs4_pathname rootpath;
1213 #define NFS4_FS_LOCATIONS_MAXENTRIES 10
1214 struct nfs4_fs_locations {
1215 struct nfs_fattr fattr;
1216 const struct nfs_server *server;
1217 struct nfs4_pathname fs_path;
1219 struct nfs4_fs_location locations[NFS4_FS_LOCATIONS_MAXENTRIES];
1222 struct nfs4_fs_locations_arg {
1223 struct nfs4_sequence_args seq_args;
1224 const struct nfs_fh *dir_fh;
1225 const struct nfs_fh *fh;
1226 const struct qstr *name;
1230 unsigned char migration:1, renew:1;
1233 struct nfs4_fs_locations_res {
1234 struct nfs4_sequence_res seq_res;
1235 struct nfs4_fs_locations *fs_locations;
1236 unsigned char migration:1, renew:1;
1239 struct nfs4_secinfo4 {
1241 struct rpcsec_gss_info flavor_info;
1244 struct nfs4_secinfo_flavors {
1245 unsigned int num_flavors;
1246 struct nfs4_secinfo4 flavors[];
1249 struct nfs4_secinfo_arg {
1250 struct nfs4_sequence_args seq_args;
1251 const struct nfs_fh *dir_fh;
1252 const struct qstr *name;
1255 struct nfs4_secinfo_res {
1256 struct nfs4_sequence_res seq_res;
1257 struct nfs4_secinfo_flavors *flavors;
1260 struct nfs4_fsid_present_arg {
1261 struct nfs4_sequence_args seq_args;
1262 const struct nfs_fh *fh;
1264 unsigned char renew:1;
1267 struct nfs4_fsid_present_res {
1268 struct nfs4_sequence_res seq_res;
1270 unsigned char renew:1;
1273 #endif /* CONFIG_NFS_V4 */
1280 #ifdef CONFIG_NFS_V4_1
1282 struct pnfs_commit_bucket {
1283 struct list_head written;
1284 struct list_head committing;
1285 struct pnfs_layout_segment *lseg;
1286 struct nfs_writeverf direct_verf;
1289 struct pnfs_commit_array {
1290 struct list_head cinfo_list;
1291 struct list_head lseg_list;
1292 struct pnfs_layout_segment *lseg;
1293 struct rcu_head rcu;
1294 refcount_t refcount;
1295 unsigned int nbuckets;
1296 struct pnfs_commit_bucket buckets[];
1299 struct pnfs_ds_commit_info {
1300 struct list_head commits;
1301 unsigned int nwritten;
1302 unsigned int ncommitting;
1303 const struct pnfs_commit_ops *ops;
1306 struct nfs41_state_protection {
1308 struct nfs4_op_map enforce;
1309 struct nfs4_op_map allow;
1312 struct nfs41_exchange_id_args {
1313 struct nfs_client *client;
1314 nfs4_verifier verifier;
1316 struct nfs41_state_protection state_protect;
1319 struct nfs41_server_owner {
1321 uint32_t major_id_sz;
1322 char major_id[NFS4_OPAQUE_LIMIT];
1325 struct nfs41_server_scope {
1326 uint32_t server_scope_sz;
1327 char server_scope[NFS4_OPAQUE_LIMIT];
1330 struct nfs41_impl_id {
1331 char domain[NFS4_OPAQUE_LIMIT + 1];
1332 char name[NFS4_OPAQUE_LIMIT + 1];
1333 struct nfstime4 date;
1336 #define MAX_BIND_CONN_TO_SESSION_RETRIES 3
1337 struct nfs41_bind_conn_to_session_args {
1338 struct nfs_client *client;
1339 struct nfs4_sessionid sessionid;
1341 bool use_conn_in_rdma_mode;
1345 struct nfs41_bind_conn_to_session_res {
1346 struct nfs4_sessionid sessionid;
1348 bool use_conn_in_rdma_mode;
1351 struct nfs41_exchange_id_res {
1355 struct nfs41_server_owner *server_owner;
1356 struct nfs41_server_scope *server_scope;
1357 struct nfs41_impl_id *impl_id;
1358 struct nfs41_state_protection state_protect;
1361 struct nfs41_create_session_args {
1362 struct nfs_client *client;
1366 uint32_t cb_program;
1367 struct nfs4_channel_attrs fc_attrs; /* Fore Channel */
1368 struct nfs4_channel_attrs bc_attrs; /* Back Channel */
1371 struct nfs41_create_session_res {
1372 struct nfs4_sessionid sessionid;
1375 struct nfs4_channel_attrs fc_attrs; /* Fore Channel */
1376 struct nfs4_channel_attrs bc_attrs; /* Back Channel */
1379 struct nfs41_reclaim_complete_args {
1380 struct nfs4_sequence_args seq_args;
1381 /* In the future extend to include curr_fh for use with migration */
1382 unsigned char one_fs:1;
1385 struct nfs41_reclaim_complete_res {
1386 struct nfs4_sequence_res seq_res;
1389 #define SECINFO_STYLE_CURRENT_FH 0
1390 #define SECINFO_STYLE_PARENT 1
1391 struct nfs41_secinfo_no_name_args {
1392 struct nfs4_sequence_args seq_args;
1396 struct nfs41_test_stateid_args {
1397 struct nfs4_sequence_args seq_args;
1398 nfs4_stateid *stateid;
1401 struct nfs41_test_stateid_res {
1402 struct nfs4_sequence_res seq_res;
1403 unsigned int status;
1406 struct nfs41_free_stateid_args {
1407 struct nfs4_sequence_args seq_args;
1408 nfs4_stateid stateid;
1411 struct nfs41_free_stateid_res {
1412 struct nfs4_sequence_res seq_res;
1413 unsigned int status;
1418 struct pnfs_ds_commit_info {
1421 #endif /* CONFIG_NFS_V4_1 */
1423 #ifdef CONFIG_NFS_V4_2
1424 struct nfs42_falloc_args {
1425 struct nfs4_sequence_args seq_args;
1427 struct nfs_fh *falloc_fh;
1428 nfs4_stateid falloc_stateid;
1431 const u32 *falloc_bitmask;
1434 struct nfs42_falloc_res {
1435 struct nfs4_sequence_res seq_res;
1436 unsigned int status;
1438 struct nfs_fattr *falloc_fattr;
1439 const struct nfs_server *falloc_server;
1442 struct nfs42_copy_args {
1443 struct nfs4_sequence_args seq_args;
1445 struct nfs_fh *src_fh;
1446 nfs4_stateid src_stateid;
1449 struct nfs_fh *dst_fh;
1450 nfs4_stateid dst_stateid;
1455 struct nl4_server *cp_src;
1458 struct nfs42_write_res {
1459 nfs4_stateid stateid;
1461 struct nfs_writeverf verifier;
1464 struct nfs42_copy_res {
1465 struct nfs4_sequence_res seq_res;
1466 struct nfs42_write_res write_res;
1469 struct nfs_commitres commit_res;
1472 struct nfs42_offload_status_args {
1473 struct nfs4_sequence_args osa_seq_args;
1474 struct nfs_fh *osa_src_fh;
1475 nfs4_stateid osa_stateid;
1478 struct nfs42_offload_status_res {
1479 struct nfs4_sequence_res osr_seq_res;
1484 struct nfs42_copy_notify_args {
1485 struct nfs4_sequence_args cna_seq_args;
1487 struct nfs_fh *cna_src_fh;
1488 nfs4_stateid cna_src_stateid;
1489 struct nl4_server cna_dst;
1492 struct nfs42_copy_notify_res {
1493 struct nfs4_sequence_res cnr_seq_res;
1495 struct nfstime4 cnr_lease_time;
1496 nfs4_stateid cnr_stateid;
1497 struct nl4_server cnr_src;
1500 struct nfs42_seek_args {
1501 struct nfs4_sequence_args seq_args;
1503 struct nfs_fh *sa_fh;
1504 nfs4_stateid sa_stateid;
1509 struct nfs42_seek_res {
1510 struct nfs4_sequence_res seq_res;
1511 unsigned int status;
1517 struct nfs42_setxattrargs {
1518 struct nfs4_sequence_args seq_args;
1520 const char *xattr_name;
1523 struct page **xattr_pages;
1526 struct nfs42_setxattrres {
1527 struct nfs4_sequence_res seq_res;
1528 struct nfs4_change_info cinfo;
1531 struct nfs42_getxattrargs {
1532 struct nfs4_sequence_args seq_args;
1534 const char *xattr_name;
1536 struct page **xattr_pages;
1539 struct nfs42_getxattrres {
1540 struct nfs4_sequence_res seq_res;
1544 struct nfs42_listxattrsargs {
1545 struct nfs4_sequence_args seq_args;
1549 struct page **xattr_pages;
1552 struct nfs42_listxattrsres {
1553 struct nfs4_sequence_res seq_res;
1554 struct page *scratch;
1562 struct nfs42_removexattrargs {
1563 struct nfs4_sequence_args seq_args;
1565 const char *xattr_name;
1568 struct nfs42_removexattrres {
1569 struct nfs4_sequence_res seq_res;
1570 struct nfs4_change_info cinfo;
1573 #endif /* CONFIG_NFS_V4_2 */
1577 #define NFS_PAGEVEC_SIZE (8U)
1579 struct nfs_page_array {
1580 struct page **pagevec;
1581 unsigned int npages; /* Max length of pagevec */
1582 struct page *page_array[NFS_PAGEVEC_SIZE];
1585 /* used as flag bits in nfs_pgio_header */
1587 NFS_IOHDR_ERROR = 0,
1591 NFS_IOHDR_RESEND_PNFS,
1592 NFS_IOHDR_RESEND_MDS,
1595 struct nfs_io_completion;
1596 struct nfs_pgio_header {
1597 struct inode *inode;
1598 const struct cred *cred;
1599 struct list_head pages;
1600 struct nfs_page *req;
1601 struct nfs_writeverf verf; /* Used for writes */
1603 struct pnfs_layout_segment *lseg;
1605 const struct rpc_call_ops *mds_ops;
1606 void (*release) (struct nfs_pgio_header *hdr);
1607 const struct nfs_pgio_completion_ops *completion_ops;
1608 const struct nfs_rw_ops *rw_ops;
1609 struct nfs_io_completion *io_completion;
1610 struct nfs_direct_req *dreq;
1613 int error; /* merge with pnfs_error */
1614 unsigned int good_bytes; /* boundary of good data */
1615 unsigned long flags;
1620 struct rpc_task task;
1621 struct nfs_fattr fattr;
1622 struct nfs_pgio_args args; /* argument struct */
1623 struct nfs_pgio_res res; /* result struct */
1624 unsigned long timestamp; /* For lease renewal */
1625 int (*pgio_done_cb)(struct rpc_task *, struct nfs_pgio_header *);
1626 __u64 mds_offset; /* Filelayout dense stripe */
1627 struct nfs_page_array page_array;
1628 struct nfs_client *ds_clp; /* pNFS data server */
1629 u32 ds_commit_idx; /* ds index if ds_clp is set */
1630 u32 pgio_mirror_idx;/* mirror index in pgio layer */
1633 struct nfs_mds_commit_info {
1635 atomic_long_t ncommit;
1636 struct list_head list;
1639 struct nfs_commit_info;
1640 struct nfs_commit_data;
1642 struct nfs_commit_completion_ops {
1643 void (*completion) (struct nfs_commit_data *data);
1644 void (*resched_write) (struct nfs_commit_info *, struct nfs_page *);
1647 struct nfs_commit_info {
1648 struct inode *inode; /* Needed for inode->i_lock */
1649 struct nfs_mds_commit_info *mds;
1650 struct pnfs_ds_commit_info *ds;
1651 struct nfs_direct_req *dreq; /* O_DIRECT request */
1652 const struct nfs_commit_completion_ops *completion_ops;
1655 struct nfs_commit_data {
1656 struct rpc_task task;
1657 struct inode *inode;
1658 const struct cred *cred;
1659 struct nfs_fattr fattr;
1660 struct nfs_writeverf verf;
1661 struct list_head pages; /* Coalesced requests we wish to flush */
1662 struct list_head list; /* lists of struct nfs_write_data */
1663 struct nfs_direct_req *dreq; /* O_DIRECT request */
1664 struct nfs_commitargs args; /* argument struct */
1665 struct nfs_commitres res; /* result struct */
1666 struct nfs_open_context *context;
1667 struct pnfs_layout_segment *lseg;
1668 struct nfs_client *ds_clp; /* pNFS data server */
1669 int ds_commit_index;
1671 const struct rpc_call_ops *mds_ops;
1672 const struct nfs_commit_completion_ops *completion_ops;
1673 int (*commit_done_cb) (struct rpc_task *task, struct nfs_commit_data *data);
1674 unsigned long flags;
1677 struct nfs_pgio_completion_ops {
1678 void (*error_cleanup)(struct list_head *head, int);
1679 void (*init_hdr)(struct nfs_pgio_header *hdr);
1680 void (*completion)(struct nfs_pgio_header *hdr);
1681 void (*reschedule_io)(struct nfs_pgio_header *hdr);
1684 struct nfs_unlinkdata {
1685 struct nfs_removeargs args;
1686 struct nfs_removeres res;
1687 struct dentry *dentry;
1688 wait_queue_head_t wq;
1689 const struct cred *cred;
1690 struct nfs_fattr dir_attr;
1694 struct nfs_renamedata {
1695 struct nfs_renameargs args;
1696 struct nfs_renameres res;
1697 struct rpc_task task;
1698 const struct cred *cred;
1699 struct inode *old_dir;
1700 struct dentry *old_dentry;
1701 struct nfs_fattr old_fattr;
1702 struct inode *new_dir;
1703 struct dentry *new_dentry;
1704 struct nfs_fattr new_fattr;
1705 void (*complete)(struct rpc_task *, struct nfs_renamedata *);
1710 struct nfs_access_entry;
1713 struct nfs_subversion;
1714 struct nfs_mount_info;
1715 struct nfs_client_initdata;
1716 struct nfs_pageio_descriptor;
1720 * RPC procedure vector for NFSv2/NFSv3 demuxing
1722 struct nfs_rpc_ops {
1723 u32 version; /* Protocol version */
1724 const struct dentry_operations *dentry_ops;
1725 const struct inode_operations *dir_inode_ops;
1726 const struct inode_operations *file_inode_ops;
1727 const struct file_operations *file_ops;
1728 const struct nlmclnt_operations *nlmclnt_ops;
1730 int (*getroot) (struct nfs_server *, struct nfs_fh *,
1731 struct nfs_fsinfo *);
1732 int (*submount) (struct fs_context *, struct nfs_server *);
1733 int (*try_get_tree) (struct fs_context *);
1734 int (*getattr) (struct nfs_server *, struct nfs_fh *,
1735 struct nfs_fattr *, struct inode *);
1736 int (*setattr) (struct dentry *, struct nfs_fattr *,
1738 int (*lookup) (struct inode *, struct dentry *,
1739 struct nfs_fh *, struct nfs_fattr *);
1740 int (*lookupp) (struct inode *, struct nfs_fh *,
1741 struct nfs_fattr *);
1742 int (*access) (struct inode *, struct nfs_access_entry *, const struct cred *);
1743 int (*readlink)(struct inode *, struct page *, unsigned int,
1745 int (*create) (struct inode *, struct dentry *,
1746 struct iattr *, int);
1747 int (*remove) (struct inode *, struct dentry *);
1748 void (*unlink_setup) (struct rpc_message *, struct dentry *, struct inode *);
1749 void (*unlink_rpc_prepare) (struct rpc_task *, struct nfs_unlinkdata *);
1750 int (*unlink_done) (struct rpc_task *, struct inode *);
1751 void (*rename_setup) (struct rpc_message *msg,
1752 struct dentry *old_dentry,
1753 struct dentry *new_dentry);
1754 void (*rename_rpc_prepare)(struct rpc_task *task, struct nfs_renamedata *);
1755 int (*rename_done) (struct rpc_task *task, struct inode *old_dir, struct inode *new_dir);
1756 int (*link) (struct inode *, struct inode *, const struct qstr *);
1757 int (*symlink) (struct inode *, struct dentry *, struct page *,
1758 unsigned int, struct iattr *);
1759 int (*mkdir) (struct inode *, struct dentry *, struct iattr *);
1760 int (*rmdir) (struct inode *, const struct qstr *);
1761 int (*readdir) (struct nfs_readdir_arg *, struct nfs_readdir_res *);
1762 int (*mknod) (struct inode *, struct dentry *, struct iattr *,
1764 int (*statfs) (struct nfs_server *, struct nfs_fh *,
1765 struct nfs_fsstat *);
1766 int (*fsinfo) (struct nfs_server *, struct nfs_fh *,
1767 struct nfs_fsinfo *);
1768 int (*pathconf) (struct nfs_server *, struct nfs_fh *,
1769 struct nfs_pathconf *);
1770 int (*set_capabilities)(struct nfs_server *, struct nfs_fh *);
1771 int (*decode_dirent)(struct xdr_stream *, struct nfs_entry *, bool);
1772 int (*pgio_rpc_prepare)(struct rpc_task *,
1773 struct nfs_pgio_header *);
1774 void (*read_setup)(struct nfs_pgio_header *, struct rpc_message *);
1775 int (*read_done)(struct rpc_task *, struct nfs_pgio_header *);
1776 void (*write_setup)(struct nfs_pgio_header *, struct rpc_message *,
1777 struct rpc_clnt **);
1778 int (*write_done)(struct rpc_task *, struct nfs_pgio_header *);
1779 void (*commit_setup) (struct nfs_commit_data *, struct rpc_message *,
1780 struct rpc_clnt **);
1781 void (*commit_rpc_prepare)(struct rpc_task *, struct nfs_commit_data *);
1782 int (*commit_done) (struct rpc_task *, struct nfs_commit_data *);
1783 int (*lock)(struct file *, int, struct file_lock *);
1784 int (*lock_check_bounds)(const struct file_lock *);
1785 void (*clear_acl_cache)(struct inode *);
1786 void (*close_context)(struct nfs_open_context *ctx, int);
1787 struct inode * (*open_context) (struct inode *dir,
1788 struct nfs_open_context *ctx,
1790 struct iattr *iattr,
1792 int (*have_delegation)(struct inode *, fmode_t);
1793 struct nfs_client *(*alloc_client) (const struct nfs_client_initdata *);
1794 struct nfs_client *(*init_client) (struct nfs_client *,
1795 const struct nfs_client_initdata *);
1796 void (*free_client) (struct nfs_client *);
1797 struct nfs_server *(*create_server)(struct fs_context *);
1798 struct nfs_server *(*clone_server)(struct nfs_server *, struct nfs_fh *,
1799 struct nfs_fattr *, rpc_authflavor_t);
1800 int (*discover_trunking)(struct nfs_server *, struct nfs_fh *);
1801 void (*enable_swap)(struct inode *inode);
1802 void (*disable_swap)(struct inode *inode);
1806 * NFS_CALL(getattr, inode, (fattr));
1808 * NFS_PROTO(inode)->getattr(fattr);
1810 #define NFS_CALL(op, inode, args) NFS_PROTO(inode)->op args
1813 * Function vectors etc. for the NFS client
1815 extern const struct nfs_rpc_ops nfs_v2_clientops;
1816 extern const struct nfs_rpc_ops nfs_v3_clientops;
1817 extern const struct nfs_rpc_ops nfs_v4_clientops;
1818 extern const struct rpc_version nfs_version2;
1819 extern const struct rpc_version nfs_version3;
1820 extern const struct rpc_version nfs_version4;
1822 extern const struct rpc_version nfsacl_version3;
1823 extern const struct rpc_program nfsacl_program;