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)
29 * Helper for checking equality between 2 fsids.
31 static inline int nfs_fsid_equal(const struct nfs_fsid *a, const struct nfs_fsid *b)
33 return a->major == b->major && a->minor == b->minor;
36 struct nfs4_threshold {
46 unsigned int valid; /* which fields are valid */
64 __u64 mounted_on_fileid;
65 struct timespec atime;
66 struct timespec mtime;
67 struct timespec ctime;
68 __u64 change_attr; /* NFSv4 change attribute */
69 __u64 pre_change_attr;/* pre-op NFSv4 change attribute */
70 __u64 pre_size; /* pre_op_attr.size */
71 struct timespec pre_mtime; /* pre_op_attr.mtime */
72 struct timespec pre_ctime; /* pre_op_attr.ctime */
73 unsigned long time_start;
74 unsigned long gencount;
75 struct nfs4_string *owner_name;
76 struct nfs4_string *group_name;
77 struct nfs4_threshold *mdsthreshold; /* pNFS threshold hints */
80 #define NFS_ATTR_FATTR_TYPE (1U << 0)
81 #define NFS_ATTR_FATTR_MODE (1U << 1)
82 #define NFS_ATTR_FATTR_NLINK (1U << 2)
83 #define NFS_ATTR_FATTR_OWNER (1U << 3)
84 #define NFS_ATTR_FATTR_GROUP (1U << 4)
85 #define NFS_ATTR_FATTR_RDEV (1U << 5)
86 #define NFS_ATTR_FATTR_SIZE (1U << 6)
87 #define NFS_ATTR_FATTR_PRESIZE (1U << 7)
88 #define NFS_ATTR_FATTR_BLOCKS_USED (1U << 8)
89 #define NFS_ATTR_FATTR_SPACE_USED (1U << 9)
90 #define NFS_ATTR_FATTR_FSID (1U << 10)
91 #define NFS_ATTR_FATTR_FILEID (1U << 11)
92 #define NFS_ATTR_FATTR_ATIME (1U << 12)
93 #define NFS_ATTR_FATTR_MTIME (1U << 13)
94 #define NFS_ATTR_FATTR_CTIME (1U << 14)
95 #define NFS_ATTR_FATTR_PREMTIME (1U << 15)
96 #define NFS_ATTR_FATTR_PRECTIME (1U << 16)
97 #define NFS_ATTR_FATTR_CHANGE (1U << 17)
98 #define NFS_ATTR_FATTR_PRECHANGE (1U << 18)
99 #define NFS_ATTR_FATTR_V4_LOCATIONS (1U << 19)
100 #define NFS_ATTR_FATTR_V4_REFERRAL (1U << 20)
101 #define NFS_ATTR_FATTR_MOUNTPOINT (1U << 21)
102 #define NFS_ATTR_FATTR_MOUNTED_ON_FILEID (1U << 22)
103 #define NFS_ATTR_FATTR_OWNER_NAME (1U << 23)
104 #define NFS_ATTR_FATTR_GROUP_NAME (1U << 24)
105 #define NFS_ATTR_FATTR_V4_SECURITY_LABEL (1U << 25)
107 #define NFS_ATTR_FATTR (NFS_ATTR_FATTR_TYPE \
108 | NFS_ATTR_FATTR_MODE \
109 | NFS_ATTR_FATTR_NLINK \
110 | NFS_ATTR_FATTR_OWNER \
111 | NFS_ATTR_FATTR_GROUP \
112 | NFS_ATTR_FATTR_RDEV \
113 | NFS_ATTR_FATTR_SIZE \
114 | NFS_ATTR_FATTR_FSID \
115 | NFS_ATTR_FATTR_FILEID \
116 | NFS_ATTR_FATTR_ATIME \
117 | NFS_ATTR_FATTR_MTIME \
118 | NFS_ATTR_FATTR_CTIME \
119 | NFS_ATTR_FATTR_CHANGE)
120 #define NFS_ATTR_FATTR_V2 (NFS_ATTR_FATTR \
121 | NFS_ATTR_FATTR_BLOCKS_USED)
122 #define NFS_ATTR_FATTR_V3 (NFS_ATTR_FATTR \
123 | NFS_ATTR_FATTR_SPACE_USED)
124 #define NFS_ATTR_FATTR_V4 (NFS_ATTR_FATTR \
125 | NFS_ATTR_FATTR_SPACE_USED \
126 | NFS_ATTR_FATTR_V4_SECURITY_LABEL)
129 * Maximal number of supported layout drivers.
131 #define NFS_MAX_LAYOUT_TYPES 8
134 * Info on the file system
137 struct nfs_fattr *fattr; /* Post-op attributes */
138 __u32 rtmax; /* max. read transfer size */
139 __u32 rtpref; /* pref. read transfer size */
140 __u32 rtmult; /* reads should be multiple of this */
141 __u32 wtmax; /* max. write transfer size */
142 __u32 wtpref; /* pref. write transfer size */
143 __u32 wtmult; /* writes should be multiple of this */
144 __u32 dtpref; /* pref. readdir transfer size */
146 struct timespec time_delta; /* server time granularity */
147 __u32 lease_time; /* in seconds */
148 __u32 nlayouttypes; /* number of layouttypes */
149 __u32 layouttype[NFS_MAX_LAYOUT_TYPES]; /* supported pnfs layout driver */
150 __u32 blksize; /* preferred pnfs io block size */
151 __u32 clone_blksize; /* granularity of a CLONE operation */
155 struct nfs_fattr *fattr; /* Post-op attributes */
156 __u64 tbytes; /* total size in bytes */
157 __u64 fbytes; /* # of free bytes */
158 __u64 abytes; /* # of bytes available to user */
159 __u64 tfiles; /* # of files */
160 __u64 ffiles; /* # of free files */
161 __u64 afiles; /* # of files available to user */
165 __u32 tsize; /* Server transfer size */
166 __u32 bsize; /* Filesystem block size */
167 __u32 blocks; /* No. of "bsize" blocks on filesystem */
168 __u32 bfree; /* No. of free "bsize" blocks */
169 __u32 bavail; /* No. of available "bsize" blocks */
172 struct nfs_pathconf {
173 struct nfs_fattr *fattr; /* Post-op attributes */
174 __u32 max_link; /* max # of hard links */
175 __u32 max_namelen; /* max name length */
178 struct nfs4_change_info {
186 /* nfs41 sessions channel attributes */
187 struct nfs4_channel_attrs {
190 u32 max_resp_sz_cached;
196 struct nfs4_sequence_args {
197 struct nfs4_slot *sa_slot;
198 u8 sa_cache_this : 1,
202 struct nfs4_sequence_res {
203 struct nfs4_slot *sr_slot; /* slot used to send request */
204 unsigned long sr_timestamp;
205 int sr_status; /* sequence operation status */
207 u32 sr_highest_slotid;
208 u32 sr_target_highest_slotid;
211 struct nfs4_get_lease_time_args {
212 struct nfs4_sequence_args la_seq_args;
215 struct nfs4_get_lease_time_res {
216 struct nfs4_sequence_res lr_seq_res;
217 struct nfs_fsinfo *lr_fsinfo;
221 struct nfs4_xdr_opaque_data;
223 struct nfs4_xdr_opaque_ops {
224 void (*encode)(struct xdr_stream *, const void *args,
225 const struct nfs4_xdr_opaque_data *);
226 void (*free)(struct nfs4_xdr_opaque_data *);
229 struct nfs4_xdr_opaque_data {
230 const struct nfs4_xdr_opaque_ops *ops;
234 #define PNFS_LAYOUT_MAXSIZE 4096
236 struct nfs4_layoutdriver_data {
242 struct pnfs_layout_range {
248 struct nfs4_layoutget_args {
249 struct nfs4_sequence_args seq_args;
251 struct pnfs_layout_range range;
255 struct nfs_open_context *ctx;
256 nfs4_stateid stateid;
257 struct nfs4_layoutdriver_data layout;
260 struct nfs4_layoutget_res {
261 struct nfs4_sequence_res seq_res;
263 __u32 return_on_close;
264 struct pnfs_layout_range range;
266 nfs4_stateid stateid;
267 struct nfs4_layoutdriver_data *layoutp;
270 struct nfs4_layoutget {
271 struct nfs4_layoutget_args args;
272 struct nfs4_layoutget_res res;
273 const struct cred *cred;
277 struct nfs4_getdeviceinfo_args {
278 struct nfs4_sequence_args seq_args;
279 struct pnfs_device *pdev;
283 struct nfs4_getdeviceinfo_res {
284 struct nfs4_sequence_res seq_res;
285 struct pnfs_device *pdev;
289 struct nfs4_layoutcommit_args {
290 struct nfs4_sequence_args seq_args;
291 nfs4_stateid stateid;
292 __u64 lastbytewritten;
295 size_t layoutupdate_len;
296 struct page *layoutupdate_page;
297 struct page **layoutupdate_pages;
301 struct nfs4_layoutcommit_res {
302 struct nfs4_sequence_res seq_res;
303 struct nfs_fattr *fattr;
304 const struct nfs_server *server;
308 struct nfs4_layoutcommit_data {
309 struct rpc_task task;
310 struct nfs_fattr fattr;
311 struct list_head lseg_list;
312 const struct cred *cred;
314 struct nfs4_layoutcommit_args args;
315 struct nfs4_layoutcommit_res res;
318 struct nfs4_layoutreturn_args {
319 struct nfs4_sequence_args seq_args;
320 struct pnfs_layout_hdr *layout;
322 struct pnfs_layout_range range;
323 nfs4_stateid stateid;
325 struct nfs4_xdr_opaque_data *ld_private;
328 struct nfs4_layoutreturn_res {
329 struct nfs4_sequence_res seq_res;
331 nfs4_stateid stateid;
334 struct nfs4_layoutreturn {
335 struct nfs4_layoutreturn_args args;
336 struct nfs4_layoutreturn_res res;
337 const struct cred *cred;
338 struct nfs_client *clp;
341 struct nfs4_xdr_opaque_data ld_private;
344 #define PNFS_LAYOUTSTATS_MAXSIZE 256
346 struct nfs42_layoutstat_args;
347 struct nfs42_layoutstat_devinfo;
348 typedef void (*layoutstats_encode_t)(struct xdr_stream *,
349 struct nfs42_layoutstat_args *,
350 struct nfs42_layoutstat_devinfo *);
352 /* Per file per deviceid layoutstats */
353 struct nfs42_layoutstat_devinfo {
354 struct nfs4_deviceid dev_id;
362 struct nfs4_xdr_opaque_data ld_private;
365 struct nfs42_layoutstat_args {
366 struct nfs4_sequence_args seq_args;
369 nfs4_stateid stateid;
371 struct nfs42_layoutstat_devinfo *devinfo;
374 struct nfs42_layoutstat_res {
375 struct nfs4_sequence_res seq_res;
380 struct nfs42_layoutstat_data {
382 struct nfs42_layoutstat_args args;
383 struct nfs42_layoutstat_res res;
386 struct nfs42_device_error {
387 struct nfs4_deviceid dev_id;
389 enum nfs_opnum4 opnum;
392 struct nfs42_layout_error {
395 nfs4_stateid stateid;
396 struct nfs42_device_error errors[1];
399 #define NFS42_LAYOUTERROR_MAX 5
401 struct nfs42_layouterror_args {
402 struct nfs4_sequence_args seq_args;
404 unsigned int num_errors;
405 struct nfs42_layout_error errors[NFS42_LAYOUTERROR_MAX];
408 struct nfs42_layouterror_res {
409 struct nfs4_sequence_res seq_res;
410 unsigned int num_errors;
414 struct nfs42_layouterror_data {
415 struct nfs42_layouterror_args args;
416 struct nfs42_layouterror_res res;
418 struct pnfs_layout_segment *lseg;
421 struct nfs42_clone_args {
422 struct nfs4_sequence_args seq_args;
423 struct nfs_fh *src_fh;
424 struct nfs_fh *dst_fh;
425 nfs4_stateid src_stateid;
426 nfs4_stateid dst_stateid;
430 const u32 *dst_bitmask;
433 struct nfs42_clone_res {
434 struct nfs4_sequence_res seq_res;
435 unsigned int rpc_status;
436 struct nfs_fattr *dst_fattr;
437 const struct nfs_server *server;
440 struct stateowner_id {
446 * Arguments to the open call.
448 struct nfs_openargs {
449 struct nfs4_sequence_args seq_args;
450 const struct nfs_fh * fh;
451 struct nfs_seqid * seqid;
457 struct stateowner_id id;
460 struct iattr * attrs; /* UNCHECKED, GUARDED, EXCLUSIVE4_1 */
461 nfs4_verifier verifier; /* EXCLUSIVE */
463 nfs4_stateid delegation; /* CLAIM_DELEGATE_CUR */
464 fmode_t delegation_type; /* CLAIM_PREVIOUS */
466 const struct qstr * name;
467 const struct nfs_server *server; /* Needed for ID mapping */
469 const u32 * open_bitmap;
470 enum open_claim_type4 claim;
471 enum createmode4 createmode;
472 const struct nfs4_label *label;
474 struct nfs4_layoutget_args *lg_args;
478 struct nfs4_sequence_res seq_res;
479 nfs4_stateid stateid;
481 struct nfs4_change_info cinfo;
483 struct nfs_fattr * f_attr;
484 struct nfs4_label *f_label;
485 struct nfs_seqid * seqid;
486 const struct nfs_server *server;
487 fmode_t delegation_type;
488 nfs4_stateid delegation;
489 unsigned long pagemod_limit;
491 __u32 attrset[NFS4_BITMAP_SIZE];
492 struct nfs4_string *owner;
493 struct nfs4_string *group_owner;
494 __u32 access_request;
495 __u32 access_supported;
497 struct nfs4_layoutget_res *lg_res;
501 * Arguments to the open_confirm call.
503 struct nfs_open_confirmargs {
504 struct nfs4_sequence_args seq_args;
505 const struct nfs_fh * fh;
506 nfs4_stateid * stateid;
507 struct nfs_seqid * seqid;
510 struct nfs_open_confirmres {
511 struct nfs4_sequence_res seq_res;
512 nfs4_stateid stateid;
513 struct nfs_seqid * seqid;
517 * Arguments to the close call.
519 struct nfs_closeargs {
520 struct nfs4_sequence_args seq_args;
522 nfs4_stateid stateid;
523 struct nfs_seqid * seqid;
527 struct nfs4_layoutreturn_args *lr_args;
530 struct nfs_closeres {
531 struct nfs4_sequence_res seq_res;
532 nfs4_stateid stateid;
533 struct nfs_fattr * fattr;
534 struct nfs_seqid * seqid;
535 const struct nfs_server *server;
536 struct nfs4_layoutreturn_res *lr_res;
540 * * Arguments to the lock,lockt, and locku call.
548 struct nfs_lock_args {
549 struct nfs4_sequence_args seq_args;
551 struct file_lock * fl;
552 struct nfs_seqid * lock_seqid;
553 nfs4_stateid lock_stateid;
554 struct nfs_seqid * open_seqid;
555 nfs4_stateid open_stateid;
556 struct nfs_lowner lock_owner;
557 unsigned char block : 1;
558 unsigned char reclaim : 1;
559 unsigned char new_lock : 1;
560 unsigned char new_lock_owner : 1;
563 struct nfs_lock_res {
564 struct nfs4_sequence_res seq_res;
565 nfs4_stateid stateid;
566 struct nfs_seqid * lock_seqid;
567 struct nfs_seqid * open_seqid;
570 struct nfs_locku_args {
571 struct nfs4_sequence_args seq_args;
573 struct file_lock * fl;
574 struct nfs_seqid * seqid;
575 nfs4_stateid stateid;
578 struct nfs_locku_res {
579 struct nfs4_sequence_res seq_res;
580 nfs4_stateid stateid;
581 struct nfs_seqid * seqid;
584 struct nfs_lockt_args {
585 struct nfs4_sequence_args seq_args;
587 struct file_lock * fl;
588 struct nfs_lowner lock_owner;
591 struct nfs_lockt_res {
592 struct nfs4_sequence_res seq_res;
593 struct file_lock * denied; /* LOCK, LOCKT failed */
596 struct nfs_release_lockowner_args {
597 struct nfs4_sequence_args seq_args;
598 struct nfs_lowner lock_owner;
601 struct nfs_release_lockowner_res {
602 struct nfs4_sequence_res seq_res;
605 struct nfs4_delegreturnargs {
606 struct nfs4_sequence_args seq_args;
607 const struct nfs_fh *fhandle;
608 const nfs4_stateid *stateid;
610 struct nfs4_layoutreturn_args *lr_args;
613 struct nfs4_delegreturnres {
614 struct nfs4_sequence_res seq_res;
615 struct nfs_fattr * fattr;
616 struct nfs_server *server;
617 struct nfs4_layoutreturn_res *lr_res;
622 * Arguments to the write call.
624 struct nfs_write_verifier {
628 struct nfs_writeverf {
629 struct nfs_write_verifier verifier;
630 enum nfs3_stable_how committed;
634 * Arguments shared by the read and write call.
636 struct nfs_pgio_args {
637 struct nfs4_sequence_args seq_args;
639 struct nfs_open_context *context;
640 struct nfs_lock_context *lock_context;
641 nfs4_stateid stateid;
645 struct page ** pages;
647 unsigned int replen; /* used by read */
649 const u32 * bitmask; /* used by write */
650 enum nfs3_stable_how stable; /* used by write */
655 struct nfs_pgio_res {
656 struct nfs4_sequence_res seq_res;
657 struct nfs_fattr * fattr;
662 unsigned int replen; /* used by read */
663 int eof; /* used by read */
666 struct nfs_writeverf * verf; /* used by write */
667 const struct nfs_server *server; /* used by write */
673 * Arguments to the commit call.
675 struct nfs_commitargs {
676 struct nfs4_sequence_args seq_args;
683 struct nfs_commitres {
684 struct nfs4_sequence_res seq_res;
686 struct nfs_fattr *fattr;
687 struct nfs_writeverf *verf;
688 const struct nfs_server *server;
692 * Common arguments to the unlink call
694 struct nfs_removeargs {
695 struct nfs4_sequence_args seq_args;
696 const struct nfs_fh *fh;
700 struct nfs_removeres {
701 struct nfs4_sequence_res seq_res;
702 struct nfs_server *server;
703 struct nfs_fattr *dir_attr;
704 struct nfs4_change_info cinfo;
708 * Common arguments to the rename call
710 struct nfs_renameargs {
711 struct nfs4_sequence_args seq_args;
712 const struct nfs_fh *old_dir;
713 const struct nfs_fh *new_dir;
714 const struct qstr *old_name;
715 const struct qstr *new_name;
718 struct nfs_renameres {
719 struct nfs4_sequence_res seq_res;
720 struct nfs_server *server;
721 struct nfs4_change_info old_cinfo;
722 struct nfs_fattr *old_fattr;
723 struct nfs4_change_info new_cinfo;
724 struct nfs_fattr *new_fattr;
727 /* parsed sec= options */
728 #define NFS_AUTH_INFO_MAX_FLAVORS 12 /* see fs/nfs/super.c */
729 struct nfs_auth_info {
730 unsigned int flavor_len;
731 rpc_authflavor_t flavors[NFS_AUTH_INFO_MAX_FLAVORS];
735 * Argument struct for decode_entry function
745 struct nfs_fattr * fattr;
746 struct nfs4_label *label;
747 unsigned char d_type;
748 struct nfs_server * server;
752 * The following types are for NFSv2 only.
754 struct nfs_sattrargs {
756 struct iattr * sattr;
759 struct nfs_diropargs {
765 struct nfs_createargs {
769 struct iattr * sattr;
772 struct nfs_setattrargs {
773 struct nfs4_sequence_args seq_args;
775 nfs4_stateid stateid;
777 const struct nfs_server * server; /* Needed for name mapping */
779 const struct nfs4_label *label;
782 struct nfs_setaclargs {
783 struct nfs4_sequence_args seq_args;
786 struct page ** acl_pages;
789 struct nfs_setaclres {
790 struct nfs4_sequence_res seq_res;
793 struct nfs_getaclargs {
794 struct nfs4_sequence_args seq_args;
797 struct page ** acl_pages;
800 /* getxattr ACL interface flags */
801 #define NFS4_ACL_TRUNC 0x0001 /* ACL was truncated */
802 struct nfs_getaclres {
803 struct nfs4_sequence_res seq_res;
805 size_t acl_data_offset;
807 struct page * acl_scratch;
810 struct nfs_setattrres {
811 struct nfs4_sequence_res seq_res;
812 struct nfs_fattr * fattr;
813 struct nfs4_label *label;
814 const struct nfs_server * server;
817 struct nfs_linkargs {
818 struct nfs_fh * fromfh;
819 struct nfs_fh * tofh;
824 struct nfs_symlinkargs {
825 struct nfs_fh * fromfh;
826 const char * fromname;
827 unsigned int fromlen;
828 struct page ** pages;
829 unsigned int pathlen;
830 struct iattr * sattr;
833 struct nfs_readdirargs {
837 struct page ** pages;
840 struct nfs3_getaclargs {
843 struct page ** pages;
846 struct nfs3_setaclargs {
847 struct inode * inode;
849 struct posix_acl * acl_access;
850 struct posix_acl * acl_default;
853 struct page ** pages;
858 struct nfs_fattr * fattr;
861 struct nfs_readlinkargs {
865 struct page ** pages;
868 struct nfs3_sattrargs {
870 struct iattr * sattr;
872 struct timespec guardtime;
875 struct nfs3_diropargs {
881 struct nfs3_accessargs {
886 struct nfs3_createargs {
890 struct iattr * sattr;
891 enum nfs3_createmode createmode;
895 struct nfs3_mkdirargs {
899 struct iattr * sattr;
902 struct nfs3_symlinkargs {
903 struct nfs_fh * fromfh;
904 const char * fromname;
905 unsigned int fromlen;
906 struct page ** pages;
907 unsigned int pathlen;
908 struct iattr * sattr;
911 struct nfs3_mknodargs {
915 enum nfs3_ftype type;
916 struct iattr * sattr;
920 struct nfs3_linkargs {
921 struct nfs_fh * fromfh;
922 struct nfs_fh * tofh;
927 struct nfs3_readdirargs {
933 struct page ** pages;
936 struct nfs3_diropres {
937 struct nfs_fattr * dir_attr;
939 struct nfs_fattr * fattr;
942 struct nfs3_accessres {
943 struct nfs_fattr * fattr;
947 struct nfs3_readlinkargs {
951 struct page ** pages;
954 struct nfs3_linkres {
955 struct nfs_fattr * dir_attr;
956 struct nfs_fattr * fattr;
959 struct nfs3_readdirres {
960 struct nfs_fattr * dir_attr;
965 struct nfs3_getaclres {
966 struct nfs_fattr * fattr;
968 unsigned int acl_access_count;
969 unsigned int acl_default_count;
970 struct posix_acl * acl_access;
971 struct posix_acl * acl_default;
974 #if IS_ENABLED(CONFIG_NFS_V4)
976 typedef u64 clientid4;
978 struct nfs4_accessargs {
979 struct nfs4_sequence_args seq_args;
980 const struct nfs_fh * fh;
985 struct nfs4_accessres {
986 struct nfs4_sequence_res seq_res;
987 const struct nfs_server * server;
988 struct nfs_fattr * fattr;
993 struct nfs4_create_arg {
994 struct nfs4_sequence_args seq_args;
998 struct page ** pages;
1000 } symlink; /* NF4LNK */
1004 } device; /* NF4BLK, NF4CHR */
1006 const struct qstr * name;
1007 const struct nfs_server * server;
1008 const struct iattr * attrs;
1009 const struct nfs_fh * dir_fh;
1010 const u32 * bitmask;
1011 const struct nfs4_label *label;
1015 struct nfs4_create_res {
1016 struct nfs4_sequence_res seq_res;
1017 const struct nfs_server * server;
1019 struct nfs_fattr * fattr;
1020 struct nfs4_label *label;
1021 struct nfs4_change_info dir_cinfo;
1024 struct nfs4_fsinfo_arg {
1025 struct nfs4_sequence_args seq_args;
1026 const struct nfs_fh * fh;
1027 const u32 * bitmask;
1030 struct nfs4_fsinfo_res {
1031 struct nfs4_sequence_res seq_res;
1032 struct nfs_fsinfo *fsinfo;
1035 struct nfs4_getattr_arg {
1036 struct nfs4_sequence_args seq_args;
1037 const struct nfs_fh * fh;
1038 const u32 * bitmask;
1041 struct nfs4_getattr_res {
1042 struct nfs4_sequence_res seq_res;
1043 const struct nfs_server * server;
1044 struct nfs_fattr * fattr;
1045 struct nfs4_label *label;
1048 struct nfs4_link_arg {
1049 struct nfs4_sequence_args seq_args;
1050 const struct nfs_fh * fh;
1051 const struct nfs_fh * dir_fh;
1052 const struct qstr * name;
1053 const u32 * bitmask;
1056 struct nfs4_link_res {
1057 struct nfs4_sequence_res seq_res;
1058 const struct nfs_server * server;
1059 struct nfs_fattr * fattr;
1060 struct nfs4_label *label;
1061 struct nfs4_change_info cinfo;
1062 struct nfs_fattr * dir_attr;
1065 struct nfs4_lookup_arg {
1066 struct nfs4_sequence_args seq_args;
1067 const struct nfs_fh * dir_fh;
1068 const struct qstr * name;
1069 const u32 * bitmask;
1072 struct nfs4_lookup_res {
1073 struct nfs4_sequence_res seq_res;
1074 const struct nfs_server * server;
1075 struct nfs_fattr * fattr;
1077 struct nfs4_label *label;
1080 struct nfs4_lookupp_arg {
1081 struct nfs4_sequence_args seq_args;
1082 const struct nfs_fh *fh;
1086 struct nfs4_lookupp_res {
1087 struct nfs4_sequence_res seq_res;
1088 const struct nfs_server *server;
1089 struct nfs_fattr *fattr;
1091 struct nfs4_label *label;
1094 struct nfs4_lookup_root_arg {
1095 struct nfs4_sequence_args seq_args;
1096 const u32 * bitmask;
1099 struct nfs4_pathconf_arg {
1100 struct nfs4_sequence_args seq_args;
1101 const struct nfs_fh * fh;
1102 const u32 * bitmask;
1105 struct nfs4_pathconf_res {
1106 struct nfs4_sequence_res seq_res;
1107 struct nfs_pathconf *pathconf;
1110 struct nfs4_readdir_arg {
1111 struct nfs4_sequence_args seq_args;
1112 const struct nfs_fh * fh;
1114 nfs4_verifier verifier;
1116 struct page ** pages; /* zero-copy data */
1117 unsigned int pgbase; /* zero-copy data */
1118 const u32 * bitmask;
1122 struct nfs4_readdir_res {
1123 struct nfs4_sequence_res seq_res;
1124 nfs4_verifier verifier;
1125 unsigned int pgbase;
1128 struct nfs4_readlink {
1129 struct nfs4_sequence_args seq_args;
1130 const struct nfs_fh * fh;
1131 unsigned int pgbase;
1132 unsigned int pglen; /* zero-copy data */
1133 struct page ** pages; /* zero-copy data */
1136 struct nfs4_readlink_res {
1137 struct nfs4_sequence_res seq_res;
1140 struct nfs4_setclientid {
1141 const nfs4_verifier * sc_verifier;
1143 unsigned int sc_netid_len;
1144 char sc_netid[RPCBIND_MAXNETIDLEN + 1];
1145 unsigned int sc_uaddr_len;
1146 char sc_uaddr[RPCBIND_MAXUADDRLEN + 1];
1147 struct nfs_client *sc_clnt;
1148 struct rpc_cred *sc_cred;
1151 struct nfs4_setclientid_res {
1153 nfs4_verifier confirm;
1156 struct nfs4_statfs_arg {
1157 struct nfs4_sequence_args seq_args;
1158 const struct nfs_fh * fh;
1159 const u32 * bitmask;
1162 struct nfs4_statfs_res {
1163 struct nfs4_sequence_res seq_res;
1164 struct nfs_fsstat *fsstat;
1167 struct nfs4_server_caps_arg {
1168 struct nfs4_sequence_args seq_args;
1169 struct nfs_fh *fhandle;
1170 const u32 * bitmask;
1173 struct nfs4_server_caps_res {
1174 struct nfs4_sequence_res seq_res;
1175 u32 attr_bitmask[3];
1176 u32 exclcreat_bitmask[3];
1183 #define NFS4_PATHNAME_MAXCOMPONENTS 512
1184 struct nfs4_pathname {
1185 unsigned int ncomponents;
1186 struct nfs4_string components[NFS4_PATHNAME_MAXCOMPONENTS];
1189 #define NFS4_FS_LOCATION_MAXSERVERS 10
1190 struct nfs4_fs_location {
1191 unsigned int nservers;
1192 struct nfs4_string servers[NFS4_FS_LOCATION_MAXSERVERS];
1193 struct nfs4_pathname rootpath;
1196 #define NFS4_FS_LOCATIONS_MAXENTRIES 10
1197 struct nfs4_fs_locations {
1198 struct nfs_fattr fattr;
1199 const struct nfs_server *server;
1200 struct nfs4_pathname fs_path;
1202 struct nfs4_fs_location locations[NFS4_FS_LOCATIONS_MAXENTRIES];
1205 struct nfs4_fs_locations_arg {
1206 struct nfs4_sequence_args seq_args;
1207 const struct nfs_fh *dir_fh;
1208 const struct nfs_fh *fh;
1209 const struct qstr *name;
1213 unsigned char migration:1, renew:1;
1216 struct nfs4_fs_locations_res {
1217 struct nfs4_sequence_res seq_res;
1218 struct nfs4_fs_locations *fs_locations;
1219 unsigned char migration:1, renew:1;
1222 struct nfs4_secinfo4 {
1224 struct rpcsec_gss_info flavor_info;
1227 struct nfs4_secinfo_flavors {
1228 unsigned int num_flavors;
1229 struct nfs4_secinfo4 flavors[0];
1232 struct nfs4_secinfo_arg {
1233 struct nfs4_sequence_args seq_args;
1234 const struct nfs_fh *dir_fh;
1235 const struct qstr *name;
1238 struct nfs4_secinfo_res {
1239 struct nfs4_sequence_res seq_res;
1240 struct nfs4_secinfo_flavors *flavors;
1243 struct nfs4_fsid_present_arg {
1244 struct nfs4_sequence_args seq_args;
1245 const struct nfs_fh *fh;
1247 unsigned char renew:1;
1250 struct nfs4_fsid_present_res {
1251 struct nfs4_sequence_res seq_res;
1253 unsigned char renew:1;
1256 #endif /* CONFIG_NFS_V4 */
1263 #ifdef CONFIG_NFS_V4_1
1265 struct pnfs_commit_bucket {
1266 struct list_head written;
1267 struct list_head committing;
1268 struct pnfs_layout_segment *wlseg;
1269 struct pnfs_layout_segment *clseg;
1270 struct nfs_writeverf direct_verf;
1273 struct pnfs_ds_commit_info {
1277 struct pnfs_commit_bucket *buckets;
1280 struct nfs41_state_protection {
1282 struct nfs4_op_map enforce;
1283 struct nfs4_op_map allow;
1286 struct nfs41_exchange_id_args {
1287 struct nfs_client *client;
1288 nfs4_verifier verifier;
1290 struct nfs41_state_protection state_protect;
1293 struct nfs41_server_owner {
1295 uint32_t major_id_sz;
1296 char major_id[NFS4_OPAQUE_LIMIT];
1299 struct nfs41_server_scope {
1300 uint32_t server_scope_sz;
1301 char server_scope[NFS4_OPAQUE_LIMIT];
1304 struct nfs41_impl_id {
1305 char domain[NFS4_OPAQUE_LIMIT + 1];
1306 char name[NFS4_OPAQUE_LIMIT + 1];
1307 struct nfstime4 date;
1310 struct nfs41_bind_conn_to_session_args {
1311 struct nfs_client *client;
1312 struct nfs4_sessionid sessionid;
1314 bool use_conn_in_rdma_mode;
1317 struct nfs41_bind_conn_to_session_res {
1318 struct nfs4_sessionid sessionid;
1320 bool use_conn_in_rdma_mode;
1323 struct nfs41_exchange_id_res {
1327 struct nfs41_server_owner *server_owner;
1328 struct nfs41_server_scope *server_scope;
1329 struct nfs41_impl_id *impl_id;
1330 struct nfs41_state_protection state_protect;
1333 struct nfs41_create_session_args {
1334 struct nfs_client *client;
1338 uint32_t cb_program;
1339 struct nfs4_channel_attrs fc_attrs; /* Fore Channel */
1340 struct nfs4_channel_attrs bc_attrs; /* Back Channel */
1343 struct nfs41_create_session_res {
1344 struct nfs4_sessionid sessionid;
1347 struct nfs4_channel_attrs fc_attrs; /* Fore Channel */
1348 struct nfs4_channel_attrs bc_attrs; /* Back Channel */
1351 struct nfs41_reclaim_complete_args {
1352 struct nfs4_sequence_args seq_args;
1353 /* In the future extend to include curr_fh for use with migration */
1354 unsigned char one_fs:1;
1357 struct nfs41_reclaim_complete_res {
1358 struct nfs4_sequence_res seq_res;
1361 #define SECINFO_STYLE_CURRENT_FH 0
1362 #define SECINFO_STYLE_PARENT 1
1363 struct nfs41_secinfo_no_name_args {
1364 struct nfs4_sequence_args seq_args;
1368 struct nfs41_test_stateid_args {
1369 struct nfs4_sequence_args seq_args;
1370 nfs4_stateid *stateid;
1373 struct nfs41_test_stateid_res {
1374 struct nfs4_sequence_res seq_res;
1375 unsigned int status;
1378 struct nfs41_free_stateid_args {
1379 struct nfs4_sequence_args seq_args;
1380 nfs4_stateid stateid;
1383 struct nfs41_free_stateid_res {
1384 struct nfs4_sequence_res seq_res;
1385 unsigned int status;
1389 nfs_free_pnfs_ds_cinfo(struct pnfs_ds_commit_info *cinfo)
1391 kfree(cinfo->buckets);
1396 struct pnfs_ds_commit_info {
1400 nfs_free_pnfs_ds_cinfo(struct pnfs_ds_commit_info *cinfo)
1404 #endif /* CONFIG_NFS_V4_1 */
1406 #ifdef CONFIG_NFS_V4_2
1407 struct nfs42_falloc_args {
1408 struct nfs4_sequence_args seq_args;
1410 struct nfs_fh *falloc_fh;
1411 nfs4_stateid falloc_stateid;
1414 const u32 *falloc_bitmask;
1417 struct nfs42_falloc_res {
1418 struct nfs4_sequence_res seq_res;
1419 unsigned int status;
1421 struct nfs_fattr *falloc_fattr;
1422 const struct nfs_server *falloc_server;
1425 struct nfs42_copy_args {
1426 struct nfs4_sequence_args seq_args;
1428 struct nfs_fh *src_fh;
1429 nfs4_stateid src_stateid;
1432 struct nfs_fh *dst_fh;
1433 nfs4_stateid dst_stateid;
1440 struct nfs42_write_res {
1441 nfs4_stateid stateid;
1443 struct nfs_writeverf verifier;
1446 struct nfs42_copy_res {
1447 struct nfs4_sequence_res seq_res;
1448 struct nfs42_write_res write_res;
1451 struct nfs_commitres commit_res;
1454 struct nfs42_offload_status_args {
1455 struct nfs4_sequence_args osa_seq_args;
1456 struct nfs_fh *osa_src_fh;
1457 nfs4_stateid osa_stateid;
1460 struct nfs42_offload_status_res {
1461 struct nfs4_sequence_res osr_seq_res;
1466 struct nfs42_seek_args {
1467 struct nfs4_sequence_args seq_args;
1469 struct nfs_fh *sa_fh;
1470 nfs4_stateid sa_stateid;
1475 struct nfs42_seek_res {
1476 struct nfs4_sequence_res seq_res;
1477 unsigned int status;
1486 #define NFS_PAGEVEC_SIZE (8U)
1488 struct nfs_page_array {
1489 struct page **pagevec;
1490 unsigned int npages; /* Max length of pagevec */
1491 struct page *page_array[NFS_PAGEVEC_SIZE];
1494 /* used as flag bits in nfs_pgio_header */
1496 NFS_IOHDR_ERROR = 0,
1500 NFS_IOHDR_RESEND_PNFS,
1501 NFS_IOHDR_RESEND_MDS,
1504 struct nfs_io_completion;
1505 struct nfs_pgio_header {
1506 struct inode *inode;
1507 const struct cred *cred;
1508 struct list_head pages;
1509 struct nfs_page *req;
1510 struct nfs_writeverf verf; /* Used for writes */
1512 struct pnfs_layout_segment *lseg;
1514 const struct rpc_call_ops *mds_ops;
1515 void (*release) (struct nfs_pgio_header *hdr);
1516 const struct nfs_pgio_completion_ops *completion_ops;
1517 const struct nfs_rw_ops *rw_ops;
1518 struct nfs_io_completion *io_completion;
1519 struct nfs_direct_req *dreq;
1522 int error; /* merge with pnfs_error */
1523 unsigned int good_bytes; /* boundary of good data */
1524 unsigned long flags;
1529 struct rpc_task task;
1530 struct nfs_fattr fattr;
1531 struct nfs_pgio_args args; /* argument struct */
1532 struct nfs_pgio_res res; /* result struct */
1533 unsigned long timestamp; /* For lease renewal */
1534 int (*pgio_done_cb)(struct rpc_task *, struct nfs_pgio_header *);
1535 __u64 mds_offset; /* Filelayout dense stripe */
1536 struct nfs_page_array page_array;
1537 struct nfs_client *ds_clp; /* pNFS data server */
1538 int ds_commit_idx; /* ds index if ds_clp is set */
1539 int pgio_mirror_idx;/* mirror index in pgio layer */
1542 struct nfs_mds_commit_info {
1544 atomic_long_t ncommit;
1545 struct list_head list;
1548 struct nfs_commit_info;
1549 struct nfs_commit_data;
1551 struct nfs_commit_completion_ops {
1552 void (*completion) (struct nfs_commit_data *data);
1553 void (*resched_write) (struct nfs_commit_info *, struct nfs_page *);
1556 struct nfs_commit_info {
1557 struct inode *inode; /* Needed for inode->i_lock */
1558 struct nfs_mds_commit_info *mds;
1559 struct pnfs_ds_commit_info *ds;
1560 struct nfs_direct_req *dreq; /* O_DIRECT request */
1561 const struct nfs_commit_completion_ops *completion_ops;
1564 struct nfs_commit_data {
1565 struct rpc_task task;
1566 struct inode *inode;
1567 const struct cred *cred;
1568 struct nfs_fattr fattr;
1569 struct nfs_writeverf verf;
1570 struct list_head pages; /* Coalesced requests we wish to flush */
1571 struct list_head list; /* lists of struct nfs_write_data */
1572 struct nfs_direct_req *dreq; /* O_DIRECT request */
1573 struct nfs_commitargs args; /* argument struct */
1574 struct nfs_commitres res; /* result struct */
1575 struct nfs_open_context *context;
1576 struct pnfs_layout_segment *lseg;
1577 struct nfs_client *ds_clp; /* pNFS data server */
1578 int ds_commit_index;
1580 const struct rpc_call_ops *mds_ops;
1581 const struct nfs_commit_completion_ops *completion_ops;
1582 int (*commit_done_cb) (struct rpc_task *task, struct nfs_commit_data *data);
1583 unsigned long flags;
1586 struct nfs_pgio_completion_ops {
1587 void (*error_cleanup)(struct list_head *head, int);
1588 void (*init_hdr)(struct nfs_pgio_header *hdr);
1589 void (*completion)(struct nfs_pgio_header *hdr);
1590 void (*reschedule_io)(struct nfs_pgio_header *hdr);
1593 struct nfs_unlinkdata {
1594 struct nfs_removeargs args;
1595 struct nfs_removeres res;
1596 struct dentry *dentry;
1597 wait_queue_head_t wq;
1598 const struct cred *cred;
1599 struct nfs_fattr dir_attr;
1603 struct nfs_renamedata {
1604 struct nfs_renameargs args;
1605 struct nfs_renameres res;
1606 const struct cred *cred;
1607 struct inode *old_dir;
1608 struct dentry *old_dentry;
1609 struct nfs_fattr old_fattr;
1610 struct inode *new_dir;
1611 struct dentry *new_dentry;
1612 struct nfs_fattr new_fattr;
1613 void (*complete)(struct rpc_task *, struct nfs_renamedata *);
1618 struct nfs_access_entry;
1621 struct nfs_subversion;
1622 struct nfs_mount_info;
1623 struct nfs_client_initdata;
1624 struct nfs_pageio_descriptor;
1627 * RPC procedure vector for NFSv2/NFSv3 demuxing
1629 struct nfs_rpc_ops {
1630 u32 version; /* Protocol version */
1631 const struct dentry_operations *dentry_ops;
1632 const struct inode_operations *dir_inode_ops;
1633 const struct inode_operations *file_inode_ops;
1634 const struct file_operations *file_ops;
1635 const struct nlmclnt_operations *nlmclnt_ops;
1637 int (*getroot) (struct nfs_server *, struct nfs_fh *,
1638 struct nfs_fsinfo *);
1639 struct vfsmount *(*submount) (struct nfs_server *, struct dentry *,
1640 struct nfs_fh *, struct nfs_fattr *);
1641 struct dentry *(*try_mount) (int, const char *, struct nfs_mount_info *,
1642 struct nfs_subversion *);
1643 int (*getattr) (struct nfs_server *, struct nfs_fh *,
1644 struct nfs_fattr *, struct nfs4_label *,
1646 int (*setattr) (struct dentry *, struct nfs_fattr *,
1648 int (*lookup) (struct inode *, const struct qstr *,
1649 struct nfs_fh *, struct nfs_fattr *,
1650 struct nfs4_label *);
1651 int (*lookupp) (struct inode *, struct nfs_fh *,
1652 struct nfs_fattr *, struct nfs4_label *);
1653 int (*access) (struct inode *, struct nfs_access_entry *);
1654 int (*readlink)(struct inode *, struct page *, unsigned int,
1656 int (*create) (struct inode *, struct dentry *,
1657 struct iattr *, int);
1658 int (*remove) (struct inode *, struct dentry *);
1659 void (*unlink_setup) (struct rpc_message *, struct dentry *, struct inode *);
1660 void (*unlink_rpc_prepare) (struct rpc_task *, struct nfs_unlinkdata *);
1661 int (*unlink_done) (struct rpc_task *, struct inode *);
1662 void (*rename_setup) (struct rpc_message *msg,
1663 struct dentry *old_dentry,
1664 struct dentry *new_dentry);
1665 void (*rename_rpc_prepare)(struct rpc_task *task, struct nfs_renamedata *);
1666 int (*rename_done) (struct rpc_task *task, struct inode *old_dir, struct inode *new_dir);
1667 int (*link) (struct inode *, struct inode *, const struct qstr *);
1668 int (*symlink) (struct inode *, struct dentry *, struct page *,
1669 unsigned int, struct iattr *);
1670 int (*mkdir) (struct inode *, struct dentry *, struct iattr *);
1671 int (*rmdir) (struct inode *, const struct qstr *);
1672 int (*readdir) (struct dentry *, const struct cred *,
1673 u64, struct page **, unsigned int, bool);
1674 int (*mknod) (struct inode *, struct dentry *, struct iattr *,
1676 int (*statfs) (struct nfs_server *, struct nfs_fh *,
1677 struct nfs_fsstat *);
1678 int (*fsinfo) (struct nfs_server *, struct nfs_fh *,
1679 struct nfs_fsinfo *);
1680 int (*pathconf) (struct nfs_server *, struct nfs_fh *,
1681 struct nfs_pathconf *);
1682 int (*set_capabilities)(struct nfs_server *, struct nfs_fh *);
1683 int (*decode_dirent)(struct xdr_stream *, struct nfs_entry *, bool);
1684 int (*pgio_rpc_prepare)(struct rpc_task *,
1685 struct nfs_pgio_header *);
1686 void (*read_setup)(struct nfs_pgio_header *, struct rpc_message *);
1687 int (*read_done)(struct rpc_task *, struct nfs_pgio_header *);
1688 void (*write_setup)(struct nfs_pgio_header *, struct rpc_message *,
1689 struct rpc_clnt **);
1690 int (*write_done)(struct rpc_task *, struct nfs_pgio_header *);
1691 void (*commit_setup) (struct nfs_commit_data *, struct rpc_message *,
1692 struct rpc_clnt **);
1693 void (*commit_rpc_prepare)(struct rpc_task *, struct nfs_commit_data *);
1694 int (*commit_done) (struct rpc_task *, struct nfs_commit_data *);
1695 int (*lock)(struct file *, int, struct file_lock *);
1696 int (*lock_check_bounds)(const struct file_lock *);
1697 void (*clear_acl_cache)(struct inode *);
1698 void (*close_context)(struct nfs_open_context *ctx, int);
1699 struct inode * (*open_context) (struct inode *dir,
1700 struct nfs_open_context *ctx,
1702 struct iattr *iattr,
1704 int (*have_delegation)(struct inode *, fmode_t);
1705 struct nfs_client *(*alloc_client) (const struct nfs_client_initdata *);
1706 struct nfs_client *(*init_client) (struct nfs_client *,
1707 const struct nfs_client_initdata *);
1708 void (*free_client) (struct nfs_client *);
1709 struct nfs_server *(*create_server)(struct nfs_mount_info *, struct nfs_subversion *);
1710 struct nfs_server *(*clone_server)(struct nfs_server *, struct nfs_fh *,
1711 struct nfs_fattr *, rpc_authflavor_t);
1715 * NFS_CALL(getattr, inode, (fattr));
1717 * NFS_PROTO(inode)->getattr(fattr);
1719 #define NFS_CALL(op, inode, args) NFS_PROTO(inode)->op args
1722 * Function vectors etc. for the NFS client
1724 extern const struct nfs_rpc_ops nfs_v2_clientops;
1725 extern const struct nfs_rpc_ops nfs_v3_clientops;
1726 extern const struct nfs_rpc_ops nfs_v4_clientops;
1727 extern const struct rpc_version nfs_version2;
1728 extern const struct rpc_version nfs_version3;
1729 extern const struct rpc_version nfs_version4;
1731 extern const struct rpc_version nfsacl_version3;
1732 extern const struct rpc_program nfsacl_program;