1 #ifndef _LINUX_NFS_XDR_H
2 #define _LINUX_NFS_XDR_H
4 #include <linux/nfsacl.h>
5 #include <linux/sunrpc/gss_api.h>
8 * To change the maximum rsize and wsize supported by the NFS client, adjust
9 * NFS_MAX_FILE_IO_SIZE. 64KB is a typical maximum, but some servers can
10 * support a megabyte or more. The default is left at 4096 bytes, which is
11 * reasonable for NFS over UDP.
13 #define NFS_MAX_FILE_IO_SIZE (1048576U)
14 #define NFS_DEF_FILE_IO_SIZE (4096U)
15 #define NFS_MIN_FILE_IO_SIZE (1024U)
28 * Helper for checking equality between 2 fsids.
30 static inline int nfs_fsid_equal(const struct nfs_fsid *a, const struct nfs_fsid *b)
32 return a->major == b->major && a->minor == b->minor;
35 struct nfs4_threshold {
45 unsigned int valid; /* which fields are valid */
63 __u64 mounted_on_fileid;
64 struct timespec atime;
65 struct timespec mtime;
66 struct timespec ctime;
67 __u64 change_attr; /* NFSv4 change attribute */
68 __u64 pre_change_attr;/* pre-op NFSv4 change attribute */
69 __u64 pre_size; /* pre_op_attr.size */
70 struct timespec pre_mtime; /* pre_op_attr.mtime */
71 struct timespec pre_ctime; /* pre_op_attr.ctime */
72 unsigned long time_start;
73 unsigned long gencount;
74 struct nfs4_string *owner_name;
75 struct nfs4_string *group_name;
76 struct nfs4_threshold *mdsthreshold; /* pNFS threshold hints */
79 #define NFS_ATTR_FATTR_TYPE (1U << 0)
80 #define NFS_ATTR_FATTR_MODE (1U << 1)
81 #define NFS_ATTR_FATTR_NLINK (1U << 2)
82 #define NFS_ATTR_FATTR_OWNER (1U << 3)
83 #define NFS_ATTR_FATTR_GROUP (1U << 4)
84 #define NFS_ATTR_FATTR_RDEV (1U << 5)
85 #define NFS_ATTR_FATTR_SIZE (1U << 6)
86 #define NFS_ATTR_FATTR_PRESIZE (1U << 7)
87 #define NFS_ATTR_FATTR_BLOCKS_USED (1U << 8)
88 #define NFS_ATTR_FATTR_SPACE_USED (1U << 9)
89 #define NFS_ATTR_FATTR_FSID (1U << 10)
90 #define NFS_ATTR_FATTR_FILEID (1U << 11)
91 #define NFS_ATTR_FATTR_ATIME (1U << 12)
92 #define NFS_ATTR_FATTR_MTIME (1U << 13)
93 #define NFS_ATTR_FATTR_CTIME (1U << 14)
94 #define NFS_ATTR_FATTR_PREMTIME (1U << 15)
95 #define NFS_ATTR_FATTR_PRECTIME (1U << 16)
96 #define NFS_ATTR_FATTR_CHANGE (1U << 17)
97 #define NFS_ATTR_FATTR_PRECHANGE (1U << 18)
98 #define NFS_ATTR_FATTR_V4_LOCATIONS (1U << 19)
99 #define NFS_ATTR_FATTR_V4_REFERRAL (1U << 20)
100 #define NFS_ATTR_FATTR_MOUNTPOINT (1U << 21)
101 #define NFS_ATTR_FATTR_MOUNTED_ON_FILEID (1U << 22)
102 #define NFS_ATTR_FATTR_OWNER_NAME (1U << 23)
103 #define NFS_ATTR_FATTR_GROUP_NAME (1U << 24)
104 #define NFS_ATTR_FATTR_V4_SECURITY_LABEL (1U << 25)
106 #define NFS_ATTR_FATTR (NFS_ATTR_FATTR_TYPE \
107 | NFS_ATTR_FATTR_MODE \
108 | NFS_ATTR_FATTR_NLINK \
109 | NFS_ATTR_FATTR_OWNER \
110 | NFS_ATTR_FATTR_GROUP \
111 | NFS_ATTR_FATTR_RDEV \
112 | NFS_ATTR_FATTR_SIZE \
113 | NFS_ATTR_FATTR_FSID \
114 | NFS_ATTR_FATTR_FILEID \
115 | NFS_ATTR_FATTR_ATIME \
116 | NFS_ATTR_FATTR_MTIME \
117 | NFS_ATTR_FATTR_CTIME \
118 | NFS_ATTR_FATTR_CHANGE)
119 #define NFS_ATTR_FATTR_V2 (NFS_ATTR_FATTR \
120 | NFS_ATTR_FATTR_BLOCKS_USED)
121 #define NFS_ATTR_FATTR_V3 (NFS_ATTR_FATTR \
122 | NFS_ATTR_FATTR_SPACE_USED)
123 #define NFS_ATTR_FATTR_V4 (NFS_ATTR_FATTR \
124 | NFS_ATTR_FATTR_SPACE_USED \
125 | NFS_ATTR_FATTR_V4_SECURITY_LABEL)
128 * Info on the file system
131 struct nfs_fattr *fattr; /* Post-op attributes */
132 __u32 rtmax; /* max. read transfer size */
133 __u32 rtpref; /* pref. read transfer size */
134 __u32 rtmult; /* reads should be multiple of this */
135 __u32 wtmax; /* max. write transfer size */
136 __u32 wtpref; /* pref. write transfer size */
137 __u32 wtmult; /* writes should be multiple of this */
138 __u32 dtpref; /* pref. readdir transfer size */
140 struct timespec time_delta; /* server time granularity */
141 __u32 lease_time; /* in seconds */
142 __u32 layouttype; /* supported pnfs layout driver */
143 __u32 blksize; /* preferred pnfs io block size */
147 struct nfs_fattr *fattr; /* Post-op attributes */
148 __u64 tbytes; /* total size in bytes */
149 __u64 fbytes; /* # of free bytes */
150 __u64 abytes; /* # of bytes available to user */
151 __u64 tfiles; /* # of files */
152 __u64 ffiles; /* # of free files */
153 __u64 afiles; /* # of files available to user */
157 __u32 tsize; /* Server transfer size */
158 __u32 bsize; /* Filesystem block size */
159 __u32 blocks; /* No. of "bsize" blocks on filesystem */
160 __u32 bfree; /* No. of free "bsize" blocks */
161 __u32 bavail; /* No. of available "bsize" blocks */
164 struct nfs_pathconf {
165 struct nfs_fattr *fattr; /* Post-op attributes */
166 __u32 max_link; /* max # of hard links */
167 __u32 max_namelen; /* max name length */
170 struct nfs4_change_info {
178 /* nfs41 sessions channel attributes */
179 struct nfs4_channel_attrs {
182 u32 max_resp_sz_cached;
188 struct nfs4_sequence_args {
189 struct nfs4_slot *sa_slot;
190 u8 sa_cache_this : 1,
194 struct nfs4_sequence_res {
195 struct nfs4_slot *sr_slot; /* slot used to send request */
196 unsigned long sr_timestamp;
197 int sr_status; /* sequence operation status */
199 u32 sr_highest_slotid;
200 u32 sr_target_highest_slotid;
203 struct nfs4_get_lease_time_args {
204 struct nfs4_sequence_args la_seq_args;
207 struct nfs4_get_lease_time_res {
208 struct nfs4_sequence_res lr_seq_res;
209 struct nfs_fsinfo *lr_fsinfo;
212 #define PNFS_LAYOUT_MAXSIZE 4096
214 struct nfs4_layoutdriver_data {
220 struct pnfs_layout_range {
226 struct nfs4_layoutget_args {
227 struct nfs4_sequence_args seq_args;
229 struct pnfs_layout_range range;
233 struct nfs_open_context *ctx;
234 nfs4_stateid stateid;
235 unsigned long timestamp;
236 struct nfs4_layoutdriver_data layout;
239 struct nfs4_layoutget_res {
240 struct nfs4_sequence_res seq_res;
241 __u32 return_on_close;
242 struct pnfs_layout_range range;
244 nfs4_stateid stateid;
245 struct nfs4_layoutdriver_data *layoutp;
248 struct nfs4_layoutget {
249 struct nfs4_layoutget_args args;
250 struct nfs4_layoutget_res res;
251 struct rpc_cred *cred;
255 struct nfs4_getdevicelist_args {
256 struct nfs4_sequence_args seq_args;
257 const struct nfs_fh *fh;
261 struct nfs4_getdevicelist_res {
262 struct nfs4_sequence_res seq_res;
263 struct pnfs_devicelist *devlist;
266 struct nfs4_getdeviceinfo_args {
267 struct nfs4_sequence_args seq_args;
268 struct pnfs_device *pdev;
271 struct nfs4_getdeviceinfo_res {
272 struct nfs4_sequence_res seq_res;
273 struct pnfs_device *pdev;
276 struct nfs4_layoutcommit_args {
277 struct nfs4_sequence_args seq_args;
278 nfs4_stateid stateid;
279 __u64 lastbytewritten;
284 struct nfs4_layoutcommit_res {
285 struct nfs4_sequence_res seq_res;
286 struct nfs_fattr *fattr;
287 const struct nfs_server *server;
291 struct nfs4_layoutcommit_data {
292 struct rpc_task task;
293 struct nfs_fattr fattr;
294 struct list_head lseg_list;
295 struct rpc_cred *cred;
296 struct nfs4_layoutcommit_args args;
297 struct nfs4_layoutcommit_res res;
300 struct nfs4_layoutreturn_args {
301 struct nfs4_sequence_args seq_args;
302 struct pnfs_layout_hdr *layout;
304 nfs4_stateid stateid;
308 struct nfs4_layoutreturn_res {
309 struct nfs4_sequence_res seq_res;
311 nfs4_stateid stateid;
314 struct nfs4_layoutreturn {
315 struct nfs4_layoutreturn_args args;
316 struct nfs4_layoutreturn_res res;
317 struct rpc_cred *cred;
318 struct nfs_client *clp;
322 struct stateowner_id {
328 * Arguments to the open call.
330 struct nfs_openargs {
331 struct nfs4_sequence_args seq_args;
332 const struct nfs_fh * fh;
333 struct nfs_seqid * seqid;
338 struct stateowner_id id;
341 struct iattr * attrs; /* UNCHECKED, GUARDED */
342 nfs4_verifier verifier; /* EXCLUSIVE */
344 nfs4_stateid delegation; /* CLAIM_DELEGATE_CUR */
345 fmode_t delegation_type; /* CLAIM_PREVIOUS */
347 const struct qstr * name;
348 const struct nfs_server *server; /* Needed for ID mapping */
350 const u32 * open_bitmap;
352 enum createmode4 createmode;
353 const struct nfs4_label *label;
357 struct nfs4_sequence_res seq_res;
358 nfs4_stateid stateid;
360 struct nfs4_change_info cinfo;
362 struct nfs_fattr * f_attr;
363 struct nfs4_label *f_label;
364 struct nfs_seqid * seqid;
365 const struct nfs_server *server;
366 fmode_t delegation_type;
367 nfs4_stateid delegation;
370 __u32 attrset[NFS4_BITMAP_SIZE];
371 struct nfs4_string *owner;
372 struct nfs4_string *group_owner;
373 __u32 access_request;
374 __u32 access_supported;
379 * Arguments to the open_confirm call.
381 struct nfs_open_confirmargs {
382 struct nfs4_sequence_args seq_args;
383 const struct nfs_fh * fh;
384 nfs4_stateid * stateid;
385 struct nfs_seqid * seqid;
388 struct nfs_open_confirmres {
389 struct nfs4_sequence_res seq_res;
390 nfs4_stateid stateid;
391 struct nfs_seqid * seqid;
395 * Arguments to the close call.
397 struct nfs_closeargs {
398 struct nfs4_sequence_args seq_args;
400 nfs4_stateid * stateid;
401 struct nfs_seqid * seqid;
406 struct nfs_closeres {
407 struct nfs4_sequence_res seq_res;
408 nfs4_stateid stateid;
409 struct nfs_fattr * fattr;
410 struct nfs_seqid * seqid;
411 const struct nfs_server *server;
414 * * Arguments to the lock,lockt, and locku call.
422 struct nfs_lock_args {
423 struct nfs4_sequence_args seq_args;
425 struct file_lock * fl;
426 struct nfs_seqid * lock_seqid;
427 nfs4_stateid * lock_stateid;
428 struct nfs_seqid * open_seqid;
429 nfs4_stateid * open_stateid;
430 struct nfs_lowner lock_owner;
431 unsigned char block : 1;
432 unsigned char reclaim : 1;
433 unsigned char new_lock_owner : 1;
436 struct nfs_lock_res {
437 struct nfs4_sequence_res seq_res;
438 nfs4_stateid stateid;
439 struct nfs_seqid * lock_seqid;
440 struct nfs_seqid * open_seqid;
443 struct nfs_locku_args {
444 struct nfs4_sequence_args seq_args;
446 struct file_lock * fl;
447 struct nfs_seqid * seqid;
448 nfs4_stateid * stateid;
451 struct nfs_locku_res {
452 struct nfs4_sequence_res seq_res;
453 nfs4_stateid stateid;
454 struct nfs_seqid * seqid;
457 struct nfs_lockt_args {
458 struct nfs4_sequence_args seq_args;
460 struct file_lock * fl;
461 struct nfs_lowner lock_owner;
464 struct nfs_lockt_res {
465 struct nfs4_sequence_res seq_res;
466 struct file_lock * denied; /* LOCK, LOCKT failed */
469 struct nfs_release_lockowner_args {
470 struct nfs4_sequence_args seq_args;
471 struct nfs_lowner lock_owner;
474 struct nfs_release_lockowner_res {
475 struct nfs4_sequence_res seq_res;
478 struct nfs4_delegreturnargs {
479 struct nfs4_sequence_args seq_args;
480 const struct nfs_fh *fhandle;
481 const nfs4_stateid *stateid;
485 struct nfs4_delegreturnres {
486 struct nfs4_sequence_res seq_res;
487 struct nfs_fattr * fattr;
488 const struct nfs_server *server;
492 * Arguments to the read call.
495 struct nfs4_sequence_res seq_res;
496 struct nfs_fattr * fattr;
502 * Arguments to the write call.
504 struct nfs_write_verifier {
508 struct nfs_writeverf {
509 struct nfs_write_verifier verifier;
510 enum nfs3_stable_how committed;
513 struct nfs_writeres {
514 struct nfs4_sequence_res seq_res;
515 struct nfs_fattr * fattr;
516 struct nfs_writeverf * verf;
518 const struct nfs_server *server;
522 * Arguments shared by the read and write call.
524 struct nfs_pgio_args {
525 struct nfs4_sequence_args seq_args;
527 struct nfs_open_context *context;
528 struct nfs_lock_context *lock_context;
529 nfs4_stateid stateid;
533 struct page ** pages;
534 const u32 * bitmask; /* used by write */
535 enum nfs3_stable_how stable; /* used by write */
539 * Arguments to the commit call.
541 struct nfs_commitargs {
542 struct nfs4_sequence_args seq_args;
549 struct nfs_commitres {
550 struct nfs4_sequence_res seq_res;
551 struct nfs_fattr *fattr;
552 struct nfs_writeverf *verf;
553 const struct nfs_server *server;
557 * Common arguments to the unlink call
559 struct nfs_removeargs {
560 struct nfs4_sequence_args seq_args;
561 const struct nfs_fh *fh;
565 struct nfs_removeres {
566 struct nfs4_sequence_res seq_res;
567 const struct nfs_server *server;
568 struct nfs_fattr *dir_attr;
569 struct nfs4_change_info cinfo;
573 * Common arguments to the rename call
575 struct nfs_renameargs {
576 struct nfs4_sequence_args seq_args;
577 const struct nfs_fh *old_dir;
578 const struct nfs_fh *new_dir;
579 const struct qstr *old_name;
580 const struct qstr *new_name;
583 struct nfs_renameres {
584 struct nfs4_sequence_res seq_res;
585 const struct nfs_server *server;
586 struct nfs4_change_info old_cinfo;
587 struct nfs_fattr *old_fattr;
588 struct nfs4_change_info new_cinfo;
589 struct nfs_fattr *new_fattr;
592 /* parsed sec= options */
593 #define NFS_AUTH_INFO_MAX_FLAVORS 12 /* see fs/nfs/super.c */
594 struct nfs_auth_info {
595 unsigned int flavor_len;
596 rpc_authflavor_t flavors[NFS_AUTH_INFO_MAX_FLAVORS];
600 * Argument struct for decode_entry function
610 struct nfs_fattr * fattr;
611 struct nfs4_label *label;
612 unsigned char d_type;
613 struct nfs_server * server;
617 * The following types are for NFSv2 only.
619 struct nfs_sattrargs {
621 struct iattr * sattr;
624 struct nfs_diropargs {
630 struct nfs_createargs {
634 struct iattr * sattr;
637 struct nfs_setattrargs {
638 struct nfs4_sequence_args seq_args;
640 nfs4_stateid stateid;
642 const struct nfs_server * server; /* Needed for name mapping */
644 const struct nfs4_label *label;
647 struct nfs_setaclargs {
648 struct nfs4_sequence_args seq_args;
651 unsigned int acl_pgbase;
652 struct page ** acl_pages;
655 struct nfs_setaclres {
656 struct nfs4_sequence_res seq_res;
659 struct nfs_getaclargs {
660 struct nfs4_sequence_args seq_args;
663 unsigned int acl_pgbase;
664 struct page ** acl_pages;
667 /* getxattr ACL interface flags */
668 #define NFS4_ACL_TRUNC 0x0001 /* ACL was truncated */
669 struct nfs_getaclres {
670 struct nfs4_sequence_res seq_res;
672 size_t acl_data_offset;
674 struct page * acl_scratch;
677 struct nfs_setattrres {
678 struct nfs4_sequence_res seq_res;
679 struct nfs_fattr * fattr;
680 struct nfs4_label *label;
681 const struct nfs_server * server;
684 struct nfs_linkargs {
685 struct nfs_fh * fromfh;
686 struct nfs_fh * tofh;
691 struct nfs_symlinkargs {
692 struct nfs_fh * fromfh;
693 const char * fromname;
694 unsigned int fromlen;
695 struct page ** pages;
696 unsigned int pathlen;
697 struct iattr * sattr;
700 struct nfs_readdirargs {
704 struct page ** pages;
707 struct nfs3_getaclargs {
710 struct page ** pages;
713 struct nfs3_setaclargs {
714 struct inode * inode;
716 struct posix_acl * acl_access;
717 struct posix_acl * acl_default;
720 struct page ** pages;
725 struct nfs_fattr * fattr;
728 struct nfs_readlinkargs {
732 struct page ** pages;
735 struct nfs3_sattrargs {
737 struct iattr * sattr;
739 struct timespec guardtime;
742 struct nfs3_diropargs {
748 struct nfs3_accessargs {
753 struct nfs3_createargs {
757 struct iattr * sattr;
758 enum nfs3_createmode createmode;
762 struct nfs3_mkdirargs {
766 struct iattr * sattr;
769 struct nfs3_symlinkargs {
770 struct nfs_fh * fromfh;
771 const char * fromname;
772 unsigned int fromlen;
773 struct page ** pages;
774 unsigned int pathlen;
775 struct iattr * sattr;
778 struct nfs3_mknodargs {
782 enum nfs3_ftype type;
783 struct iattr * sattr;
787 struct nfs3_linkargs {
788 struct nfs_fh * fromfh;
789 struct nfs_fh * tofh;
794 struct nfs3_readdirargs {
800 struct page ** pages;
803 struct nfs3_diropres {
804 struct nfs_fattr * dir_attr;
806 struct nfs_fattr * fattr;
809 struct nfs3_accessres {
810 struct nfs_fattr * fattr;
814 struct nfs3_readlinkargs {
818 struct page ** pages;
821 struct nfs3_linkres {
822 struct nfs_fattr * dir_attr;
823 struct nfs_fattr * fattr;
826 struct nfs3_readdirres {
827 struct nfs_fattr * dir_attr;
832 struct nfs3_getaclres {
833 struct nfs_fattr * fattr;
835 unsigned int acl_access_count;
836 unsigned int acl_default_count;
837 struct posix_acl * acl_access;
838 struct posix_acl * acl_default;
841 #if IS_ENABLED(CONFIG_NFS_V4)
843 typedef u64 clientid4;
845 struct nfs4_accessargs {
846 struct nfs4_sequence_args seq_args;
847 const struct nfs_fh * fh;
852 struct nfs4_accessres {
853 struct nfs4_sequence_res seq_res;
854 const struct nfs_server * server;
855 struct nfs_fattr * fattr;
860 struct nfs4_create_arg {
861 struct nfs4_sequence_args seq_args;
865 struct page ** pages;
867 } symlink; /* NF4LNK */
871 } device; /* NF4BLK, NF4CHR */
873 const struct qstr * name;
874 const struct nfs_server * server;
875 const struct iattr * attrs;
876 const struct nfs_fh * dir_fh;
878 const struct nfs4_label *label;
881 struct nfs4_create_res {
882 struct nfs4_sequence_res seq_res;
883 const struct nfs_server * server;
885 struct nfs_fattr * fattr;
886 struct nfs4_label *label;
887 struct nfs4_change_info dir_cinfo;
890 struct nfs4_fsinfo_arg {
891 struct nfs4_sequence_args seq_args;
892 const struct nfs_fh * fh;
896 struct nfs4_fsinfo_res {
897 struct nfs4_sequence_res seq_res;
898 struct nfs_fsinfo *fsinfo;
901 struct nfs4_getattr_arg {
902 struct nfs4_sequence_args seq_args;
903 const struct nfs_fh * fh;
907 struct nfs4_getattr_res {
908 struct nfs4_sequence_res seq_res;
909 const struct nfs_server * server;
910 struct nfs_fattr * fattr;
911 struct nfs4_label *label;
914 struct nfs4_link_arg {
915 struct nfs4_sequence_args seq_args;
916 const struct nfs_fh * fh;
917 const struct nfs_fh * dir_fh;
918 const struct qstr * name;
922 struct nfs4_link_res {
923 struct nfs4_sequence_res seq_res;
924 const struct nfs_server * server;
925 struct nfs_fattr * fattr;
926 struct nfs4_label *label;
927 struct nfs4_change_info cinfo;
928 struct nfs_fattr * dir_attr;
932 struct nfs4_lookup_arg {
933 struct nfs4_sequence_args seq_args;
934 const struct nfs_fh * dir_fh;
935 const struct qstr * name;
939 struct nfs4_lookup_res {
940 struct nfs4_sequence_res seq_res;
941 const struct nfs_server * server;
942 struct nfs_fattr * fattr;
944 struct nfs4_label *label;
947 struct nfs4_lookup_root_arg {
948 struct nfs4_sequence_args seq_args;
952 struct nfs4_pathconf_arg {
953 struct nfs4_sequence_args seq_args;
954 const struct nfs_fh * fh;
958 struct nfs4_pathconf_res {
959 struct nfs4_sequence_res seq_res;
960 struct nfs_pathconf *pathconf;
963 struct nfs4_readdir_arg {
964 struct nfs4_sequence_args seq_args;
965 const struct nfs_fh * fh;
967 nfs4_verifier verifier;
969 struct page ** pages; /* zero-copy data */
970 unsigned int pgbase; /* zero-copy data */
975 struct nfs4_readdir_res {
976 struct nfs4_sequence_res seq_res;
977 nfs4_verifier verifier;
981 struct nfs4_readlink {
982 struct nfs4_sequence_args seq_args;
983 const struct nfs_fh * fh;
985 unsigned int pglen; /* zero-copy data */
986 struct page ** pages; /* zero-copy data */
989 struct nfs4_readlink_res {
990 struct nfs4_sequence_res seq_res;
993 #define NFS4_SETCLIENTID_NAMELEN (127)
994 struct nfs4_setclientid {
995 const nfs4_verifier * sc_verifier;
996 unsigned int sc_name_len;
997 char sc_name[NFS4_SETCLIENTID_NAMELEN + 1];
999 unsigned int sc_netid_len;
1000 char sc_netid[RPCBIND_MAXNETIDLEN + 1];
1001 unsigned int sc_uaddr_len;
1002 char sc_uaddr[RPCBIND_MAXUADDRLEN + 1];
1006 struct nfs4_setclientid_res {
1008 nfs4_verifier confirm;
1011 struct nfs4_statfs_arg {
1012 struct nfs4_sequence_args seq_args;
1013 const struct nfs_fh * fh;
1014 const u32 * bitmask;
1017 struct nfs4_statfs_res {
1018 struct nfs4_sequence_res seq_res;
1019 struct nfs_fsstat *fsstat;
1022 struct nfs4_server_caps_arg {
1023 struct nfs4_sequence_args seq_args;
1024 struct nfs_fh *fhandle;
1027 struct nfs4_server_caps_res {
1028 struct nfs4_sequence_res seq_res;
1029 u32 attr_bitmask[3];
1036 #define NFS4_PATHNAME_MAXCOMPONENTS 512
1037 struct nfs4_pathname {
1038 unsigned int ncomponents;
1039 struct nfs4_string components[NFS4_PATHNAME_MAXCOMPONENTS];
1042 #define NFS4_FS_LOCATION_MAXSERVERS 10
1043 struct nfs4_fs_location {
1044 unsigned int nservers;
1045 struct nfs4_string servers[NFS4_FS_LOCATION_MAXSERVERS];
1046 struct nfs4_pathname rootpath;
1049 #define NFS4_FS_LOCATIONS_MAXENTRIES 10
1050 struct nfs4_fs_locations {
1051 struct nfs_fattr fattr;
1052 const struct nfs_server *server;
1053 struct nfs4_pathname fs_path;
1055 struct nfs4_fs_location locations[NFS4_FS_LOCATIONS_MAXENTRIES];
1058 struct nfs4_fs_locations_arg {
1059 struct nfs4_sequence_args seq_args;
1060 const struct nfs_fh *dir_fh;
1061 const struct nfs_fh *fh;
1062 const struct qstr *name;
1066 unsigned char migration:1, renew:1;
1069 struct nfs4_fs_locations_res {
1070 struct nfs4_sequence_res seq_res;
1071 struct nfs4_fs_locations *fs_locations;
1072 unsigned char migration:1, renew:1;
1075 struct nfs4_secinfo4 {
1077 struct rpcsec_gss_info flavor_info;
1080 struct nfs4_secinfo_flavors {
1081 unsigned int num_flavors;
1082 struct nfs4_secinfo4 flavors[0];
1085 struct nfs4_secinfo_arg {
1086 struct nfs4_sequence_args seq_args;
1087 const struct nfs_fh *dir_fh;
1088 const struct qstr *name;
1091 struct nfs4_secinfo_res {
1092 struct nfs4_sequence_res seq_res;
1093 struct nfs4_secinfo_flavors *flavors;
1096 struct nfs4_fsid_present_arg {
1097 struct nfs4_sequence_args seq_args;
1098 const struct nfs_fh *fh;
1100 unsigned char renew:1;
1103 struct nfs4_fsid_present_res {
1104 struct nfs4_sequence_res seq_res;
1106 unsigned char renew:1;
1109 #endif /* CONFIG_NFS_V4 */
1116 #ifdef CONFIG_NFS_V4_1
1118 struct pnfs_commit_bucket {
1119 struct list_head written;
1120 struct list_head committing;
1121 struct pnfs_layout_segment *wlseg;
1122 struct pnfs_layout_segment *clseg;
1125 struct pnfs_ds_commit_info {
1129 struct pnfs_commit_bucket *buckets;
1132 #define NFS4_OP_MAP_NUM_LONGS \
1133 DIV_ROUND_UP(LAST_NFS4_OP, 8 * sizeof(unsigned long))
1134 #define NFS4_OP_MAP_NUM_WORDS \
1135 (NFS4_OP_MAP_NUM_LONGS * sizeof(unsigned long) / sizeof(u32))
1136 struct nfs4_op_map {
1138 unsigned long longs[NFS4_OP_MAP_NUM_LONGS];
1139 u32 words[NFS4_OP_MAP_NUM_WORDS];
1143 struct nfs41_state_protection {
1145 struct nfs4_op_map enforce;
1146 struct nfs4_op_map allow;
1149 #define NFS4_EXCHANGE_ID_LEN (48)
1150 struct nfs41_exchange_id_args {
1151 struct nfs_client *client;
1152 nfs4_verifier *verifier;
1153 unsigned int id_len;
1154 char id[NFS4_EXCHANGE_ID_LEN];
1156 struct nfs41_state_protection state_protect;
1159 struct nfs41_server_owner {
1161 uint32_t major_id_sz;
1162 char major_id[NFS4_OPAQUE_LIMIT];
1165 struct nfs41_server_scope {
1166 uint32_t server_scope_sz;
1167 char server_scope[NFS4_OPAQUE_LIMIT];
1170 struct nfs41_impl_id {
1171 char domain[NFS4_OPAQUE_LIMIT + 1];
1172 char name[NFS4_OPAQUE_LIMIT + 1];
1173 struct nfstime4 date;
1176 struct nfs41_bind_conn_to_session_res {
1177 struct nfs4_session *session;
1179 bool use_conn_in_rdma_mode;
1182 struct nfs41_exchange_id_res {
1186 struct nfs41_server_owner *server_owner;
1187 struct nfs41_server_scope *server_scope;
1188 struct nfs41_impl_id *impl_id;
1189 struct nfs41_state_protection state_protect;
1192 struct nfs41_create_session_args {
1193 struct nfs_client *client;
1195 uint32_t cb_program;
1196 struct nfs4_channel_attrs fc_attrs; /* Fore Channel */
1197 struct nfs4_channel_attrs bc_attrs; /* Back Channel */
1200 struct nfs41_create_session_res {
1201 struct nfs_client *client;
1204 struct nfs41_reclaim_complete_args {
1205 struct nfs4_sequence_args seq_args;
1206 /* In the future extend to include curr_fh for use with migration */
1207 unsigned char one_fs:1;
1210 struct nfs41_reclaim_complete_res {
1211 struct nfs4_sequence_res seq_res;
1214 #define SECINFO_STYLE_CURRENT_FH 0
1215 #define SECINFO_STYLE_PARENT 1
1216 struct nfs41_secinfo_no_name_args {
1217 struct nfs4_sequence_args seq_args;
1221 struct nfs41_test_stateid_args {
1222 struct nfs4_sequence_args seq_args;
1223 nfs4_stateid *stateid;
1226 struct nfs41_test_stateid_res {
1227 struct nfs4_sequence_res seq_res;
1228 unsigned int status;
1231 struct nfs41_free_stateid_args {
1232 struct nfs4_sequence_args seq_args;
1233 nfs4_stateid stateid;
1236 struct nfs41_free_stateid_res {
1237 struct nfs4_sequence_res seq_res;
1238 unsigned int status;
1243 struct pnfs_ds_commit_info {
1246 #endif /* CONFIG_NFS_V4_1 */
1250 #define NFS_PAGEVEC_SIZE (8U)
1252 struct nfs_page_array {
1253 struct page **pagevec;
1254 unsigned int npages; /* Max length of pagevec */
1255 struct page *page_array[NFS_PAGEVEC_SIZE];
1258 struct nfs_read_data {
1259 struct nfs_pgio_header *header;
1260 struct list_head list;
1261 struct rpc_task task;
1262 struct nfs_fattr fattr; /* fattr storage */
1263 struct nfs_pgio_args args;
1264 struct nfs_readres res;
1265 unsigned long timestamp; /* For lease renewal */
1266 int (*read_done_cb) (struct rpc_task *task, struct nfs_read_data *data);
1268 struct nfs_page_array pages;
1269 struct nfs_client *ds_clp; /* pNFS data server */
1272 /* used as flag bits in nfs_pgio_header */
1274 NFS_IOHDR_ERROR = 0,
1277 NFS_IOHDR_NEED_COMMIT,
1278 NFS_IOHDR_NEED_RESCHED,
1281 struct nfs_pgio_header {
1282 struct inode *inode;
1283 struct rpc_cred *cred;
1284 struct list_head pages;
1285 struct list_head rpc_list;
1287 struct nfs_page *req;
1288 struct nfs_writeverf *verf;
1289 struct pnfs_layout_segment *lseg;
1291 const struct rpc_call_ops *mds_ops;
1292 void (*release) (struct nfs_pgio_header *hdr);
1293 const struct nfs_pgio_completion_ops *completion_ops;
1294 struct nfs_direct_req *dreq;
1295 void *layout_private;
1297 /* fields protected by lock */
1299 int error; /* merge with pnfs_error */
1300 unsigned long good_bytes; /* boundary of good data */
1301 unsigned long flags;
1304 struct nfs_read_header {
1305 struct nfs_pgio_header header;
1306 struct nfs_read_data rpc_data;
1309 struct nfs_write_data {
1310 struct nfs_pgio_header *header;
1311 struct list_head list;
1312 struct rpc_task task;
1313 struct nfs_fattr fattr;
1314 struct nfs_writeverf verf;
1315 struct nfs_pgio_args args; /* argument struct */
1316 struct nfs_writeres res; /* result struct */
1317 unsigned long timestamp; /* For lease renewal */
1318 int (*write_done_cb) (struct rpc_task *task, struct nfs_write_data *data);
1319 __u64 mds_offset; /* Filelayout dense stripe */
1320 struct nfs_page_array pages;
1321 struct nfs_client *ds_clp; /* pNFS data server */
1324 struct nfs_write_header {
1325 struct nfs_pgio_header header;
1326 struct nfs_write_data rpc_data;
1327 struct nfs_writeverf verf;
1330 struct nfs_mds_commit_info {
1332 unsigned long ncommit;
1333 struct list_head list;
1336 struct nfs_commit_data;
1338 struct nfs_commit_completion_ops {
1339 void (*error_cleanup) (struct nfs_inode *nfsi);
1340 void (*completion) (struct nfs_commit_data *data);
1343 struct nfs_commit_info {
1345 struct nfs_mds_commit_info *mds;
1346 struct pnfs_ds_commit_info *ds;
1347 struct nfs_direct_req *dreq; /* O_DIRECT request */
1348 const struct nfs_commit_completion_ops *completion_ops;
1351 struct nfs_commit_data {
1352 struct rpc_task task;
1353 struct inode *inode;
1354 struct rpc_cred *cred;
1355 struct nfs_fattr fattr;
1356 struct nfs_writeverf verf;
1357 struct list_head pages; /* Coalesced requests we wish to flush */
1358 struct list_head list; /* lists of struct nfs_write_data */
1359 struct nfs_direct_req *dreq; /* O_DIRECT request */
1360 struct nfs_commitargs args; /* argument struct */
1361 struct nfs_commitres res; /* result struct */
1362 struct nfs_open_context *context;
1363 struct pnfs_layout_segment *lseg;
1364 struct nfs_client *ds_clp; /* pNFS data server */
1365 int ds_commit_index;
1366 const struct rpc_call_ops *mds_ops;
1367 const struct nfs_commit_completion_ops *completion_ops;
1368 int (*commit_done_cb) (struct rpc_task *task, struct nfs_commit_data *data);
1371 struct nfs_pgio_completion_ops {
1372 void (*error_cleanup)(struct list_head *head);
1373 void (*init_hdr)(struct nfs_pgio_header *hdr);
1374 void (*completion)(struct nfs_pgio_header *hdr);
1377 struct nfs_unlinkdata {
1378 struct hlist_node list;
1379 struct nfs_removeargs args;
1380 struct nfs_removeres res;
1382 struct rpc_cred *cred;
1383 struct nfs_fattr dir_attr;
1386 struct nfs_renamedata {
1387 struct nfs_renameargs args;
1388 struct nfs_renameres res;
1389 struct rpc_cred *cred;
1390 struct inode *old_dir;
1391 struct dentry *old_dentry;
1392 struct nfs_fattr old_fattr;
1393 struct inode *new_dir;
1394 struct dentry *new_dentry;
1395 struct nfs_fattr new_fattr;
1396 void (*complete)(struct rpc_task *, struct nfs_renamedata *);
1399 struct nfs_access_entry;
1402 struct nfs_subversion;
1403 struct nfs_mount_info;
1404 struct nfs_client_initdata;
1405 struct nfs_pageio_descriptor;
1408 * RPC procedure vector for NFSv2/NFSv3 demuxing
1410 struct nfs_rpc_ops {
1411 u32 version; /* Protocol version */
1412 const struct dentry_operations *dentry_ops;
1413 const struct inode_operations *dir_inode_ops;
1414 const struct inode_operations *file_inode_ops;
1415 const struct file_operations *file_ops;
1417 int (*getroot) (struct nfs_server *, struct nfs_fh *,
1418 struct nfs_fsinfo *);
1419 struct vfsmount *(*submount) (struct nfs_server *, struct dentry *,
1420 struct nfs_fh *, struct nfs_fattr *);
1421 struct dentry *(*try_mount) (int, const char *, struct nfs_mount_info *,
1422 struct nfs_subversion *);
1423 int (*getattr) (struct nfs_server *, struct nfs_fh *,
1424 struct nfs_fattr *, struct nfs4_label *);
1425 int (*setattr) (struct dentry *, struct nfs_fattr *,
1427 int (*lookup) (struct inode *, struct qstr *,
1428 struct nfs_fh *, struct nfs_fattr *,
1429 struct nfs4_label *);
1430 int (*access) (struct inode *, struct nfs_access_entry *);
1431 int (*readlink)(struct inode *, struct page *, unsigned int,
1433 int (*create) (struct inode *, struct dentry *,
1434 struct iattr *, int);
1435 int (*remove) (struct inode *, struct qstr *);
1436 void (*unlink_setup) (struct rpc_message *, struct inode *dir);
1437 void (*unlink_rpc_prepare) (struct rpc_task *, struct nfs_unlinkdata *);
1438 int (*unlink_done) (struct rpc_task *, struct inode *);
1439 void (*rename_setup) (struct rpc_message *msg, struct inode *dir);
1440 void (*rename_rpc_prepare)(struct rpc_task *task, struct nfs_renamedata *);
1441 int (*rename_done) (struct rpc_task *task, struct inode *old_dir, struct inode *new_dir);
1442 int (*link) (struct inode *, struct inode *, struct qstr *);
1443 int (*symlink) (struct inode *, struct dentry *, struct page *,
1444 unsigned int, struct iattr *);
1445 int (*mkdir) (struct inode *, struct dentry *, struct iattr *);
1446 int (*rmdir) (struct inode *, struct qstr *);
1447 int (*readdir) (struct dentry *, struct rpc_cred *,
1448 u64, struct page **, unsigned int, int);
1449 int (*mknod) (struct inode *, struct dentry *, struct iattr *,
1451 int (*statfs) (struct nfs_server *, struct nfs_fh *,
1452 struct nfs_fsstat *);
1453 int (*fsinfo) (struct nfs_server *, struct nfs_fh *,
1454 struct nfs_fsinfo *);
1455 int (*pathconf) (struct nfs_server *, struct nfs_fh *,
1456 struct nfs_pathconf *);
1457 int (*set_capabilities)(struct nfs_server *, struct nfs_fh *);
1458 int (*decode_dirent)(struct xdr_stream *, struct nfs_entry *, int);
1459 void (*read_setup) (struct nfs_read_data *, struct rpc_message *);
1460 int (*read_rpc_prepare)(struct rpc_task *, struct nfs_read_data *);
1461 int (*read_done) (struct rpc_task *, struct nfs_read_data *);
1462 void (*write_setup) (struct nfs_write_data *, struct rpc_message *);
1463 int (*write_rpc_prepare)(struct rpc_task *, struct nfs_write_data *);
1464 int (*write_done) (struct rpc_task *, struct nfs_write_data *);
1465 void (*commit_setup) (struct nfs_commit_data *, struct rpc_message *);
1466 void (*commit_rpc_prepare)(struct rpc_task *, struct nfs_commit_data *);
1467 int (*commit_done) (struct rpc_task *, struct nfs_commit_data *);
1468 int (*lock)(struct file *, int, struct file_lock *);
1469 int (*lock_check_bounds)(const struct file_lock *);
1470 void (*clear_acl_cache)(struct inode *);
1471 void (*close_context)(struct nfs_open_context *ctx, int);
1472 struct inode * (*open_context) (struct inode *dir,
1473 struct nfs_open_context *ctx,
1475 struct iattr *iattr,
1477 int (*have_delegation)(struct inode *, fmode_t);
1478 int (*return_delegation)(struct inode *);
1479 struct nfs_client *(*alloc_client) (const struct nfs_client_initdata *);
1481 (*init_client) (struct nfs_client *, const struct rpc_timeout *,
1483 void (*free_client) (struct nfs_client *);
1484 struct nfs_server *(*create_server)(struct nfs_mount_info *, struct nfs_subversion *);
1485 struct nfs_server *(*clone_server)(struct nfs_server *, struct nfs_fh *,
1486 struct nfs_fattr *, rpc_authflavor_t);
1490 * NFS_CALL(getattr, inode, (fattr));
1492 * NFS_PROTO(inode)->getattr(fattr);
1494 #define NFS_CALL(op, inode, args) NFS_PROTO(inode)->op args
1497 * Function vectors etc. for the NFS client
1499 extern const struct nfs_rpc_ops nfs_v2_clientops;
1500 extern const struct nfs_rpc_ops nfs_v3_clientops;
1501 extern const struct nfs_rpc_ops nfs_v4_clientops;
1502 extern const struct rpc_version nfs_version2;
1503 extern const struct rpc_version nfs_version3;
1504 extern const struct rpc_version nfs_version4;
1506 extern const struct rpc_version nfsacl_version3;
1507 extern const struct rpc_program nfsacl_program;