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 const struct nfs_fh * fh;
383 nfs4_stateid * stateid;
384 struct nfs_seqid * seqid;
387 struct nfs_open_confirmres {
388 nfs4_stateid stateid;
389 struct nfs_seqid * seqid;
393 * Arguments to the close call.
395 struct nfs_closeargs {
396 struct nfs4_sequence_args seq_args;
398 nfs4_stateid * stateid;
399 struct nfs_seqid * seqid;
404 struct nfs_closeres {
405 struct nfs4_sequence_res seq_res;
406 nfs4_stateid stateid;
407 struct nfs_fattr * fattr;
408 struct nfs_seqid * seqid;
409 const struct nfs_server *server;
412 * * Arguments to the lock,lockt, and locku call.
420 struct nfs_lock_args {
421 struct nfs4_sequence_args seq_args;
423 struct file_lock * fl;
424 struct nfs_seqid * lock_seqid;
425 nfs4_stateid * lock_stateid;
426 struct nfs_seqid * open_seqid;
427 nfs4_stateid * open_stateid;
428 struct nfs_lowner lock_owner;
429 unsigned char block : 1;
430 unsigned char reclaim : 1;
431 unsigned char new_lock_owner : 1;
434 struct nfs_lock_res {
435 struct nfs4_sequence_res seq_res;
436 nfs4_stateid stateid;
437 struct nfs_seqid * lock_seqid;
438 struct nfs_seqid * open_seqid;
441 struct nfs_locku_args {
442 struct nfs4_sequence_args seq_args;
444 struct file_lock * fl;
445 struct nfs_seqid * seqid;
446 nfs4_stateid * stateid;
449 struct nfs_locku_res {
450 struct nfs4_sequence_res seq_res;
451 nfs4_stateid stateid;
452 struct nfs_seqid * seqid;
455 struct nfs_lockt_args {
456 struct nfs4_sequence_args seq_args;
458 struct file_lock * fl;
459 struct nfs_lowner lock_owner;
462 struct nfs_lockt_res {
463 struct nfs4_sequence_res seq_res;
464 struct file_lock * denied; /* LOCK, LOCKT failed */
467 struct nfs_release_lockowner_args {
468 struct nfs_lowner lock_owner;
471 struct nfs4_delegreturnargs {
472 struct nfs4_sequence_args seq_args;
473 const struct nfs_fh *fhandle;
474 const nfs4_stateid *stateid;
478 struct nfs4_delegreturnres {
479 struct nfs4_sequence_res seq_res;
480 struct nfs_fattr * fattr;
481 const struct nfs_server *server;
485 * Arguments to the read call.
487 struct nfs_readargs {
488 struct nfs4_sequence_args seq_args;
490 struct nfs_open_context *context;
491 struct nfs_lock_context *lock_context;
492 nfs4_stateid stateid;
496 struct page ** pages;
500 struct nfs4_sequence_res seq_res;
501 struct nfs_fattr * fattr;
507 * Arguments to the write call.
509 struct nfs_writeargs {
510 struct nfs4_sequence_args seq_args;
512 struct nfs_open_context *context;
513 struct nfs_lock_context *lock_context;
514 nfs4_stateid stateid;
517 enum nfs3_stable_how stable;
519 struct page ** pages;
523 struct nfs_write_verifier {
527 struct nfs_writeverf {
528 struct nfs_write_verifier verifier;
529 enum nfs3_stable_how committed;
532 struct nfs_writeres {
533 struct nfs4_sequence_res seq_res;
534 struct nfs_fattr * fattr;
535 struct nfs_writeverf * verf;
537 const struct nfs_server *server;
541 * Arguments to the commit call.
543 struct nfs_commitargs {
544 struct nfs4_sequence_args seq_args;
551 struct nfs_commitres {
552 struct nfs4_sequence_res seq_res;
553 struct nfs_fattr *fattr;
554 struct nfs_writeverf *verf;
555 const struct nfs_server *server;
559 * Common arguments to the unlink call
561 struct nfs_removeargs {
562 struct nfs4_sequence_args seq_args;
563 const struct nfs_fh *fh;
567 struct nfs_removeres {
568 struct nfs4_sequence_res seq_res;
569 const struct nfs_server *server;
570 struct nfs_fattr *dir_attr;
571 struct nfs4_change_info cinfo;
575 * Common arguments to the rename call
577 struct nfs_renameargs {
578 struct nfs4_sequence_args seq_args;
579 const struct nfs_fh *old_dir;
580 const struct nfs_fh *new_dir;
581 const struct qstr *old_name;
582 const struct qstr *new_name;
585 struct nfs_renameres {
586 struct nfs4_sequence_res seq_res;
587 const struct nfs_server *server;
588 struct nfs4_change_info old_cinfo;
589 struct nfs_fattr *old_fattr;
590 struct nfs4_change_info new_cinfo;
591 struct nfs_fattr *new_fattr;
594 /* parsed sec= options */
595 #define NFS_AUTH_INFO_MAX_FLAVORS 12 /* see fs/nfs/super.c */
596 struct nfs_auth_info {
597 unsigned int flavor_len;
598 rpc_authflavor_t flavors[NFS_AUTH_INFO_MAX_FLAVORS];
602 * Argument struct for decode_entry function
612 struct nfs_fattr * fattr;
613 struct nfs4_label *label;
614 unsigned char d_type;
615 struct nfs_server * server;
619 * The following types are for NFSv2 only.
621 struct nfs_sattrargs {
623 struct iattr * sattr;
626 struct nfs_diropargs {
632 struct nfs_createargs {
636 struct iattr * sattr;
639 struct nfs_setattrargs {
640 struct nfs4_sequence_args seq_args;
642 nfs4_stateid stateid;
644 const struct nfs_server * server; /* Needed for name mapping */
646 const struct nfs4_label *label;
649 struct nfs_setaclargs {
650 struct nfs4_sequence_args seq_args;
653 unsigned int acl_pgbase;
654 struct page ** acl_pages;
657 struct nfs_setaclres {
658 struct nfs4_sequence_res seq_res;
661 struct nfs_getaclargs {
662 struct nfs4_sequence_args seq_args;
665 unsigned int acl_pgbase;
666 struct page ** acl_pages;
669 /* getxattr ACL interface flags */
670 #define NFS4_ACL_TRUNC 0x0001 /* ACL was truncated */
671 struct nfs_getaclres {
672 struct nfs4_sequence_res seq_res;
674 size_t acl_data_offset;
676 struct page * acl_scratch;
679 struct nfs_setattrres {
680 struct nfs4_sequence_res seq_res;
681 struct nfs_fattr * fattr;
682 struct nfs4_label *label;
683 const struct nfs_server * server;
686 struct nfs_linkargs {
687 struct nfs_fh * fromfh;
688 struct nfs_fh * tofh;
693 struct nfs_symlinkargs {
694 struct nfs_fh * fromfh;
695 const char * fromname;
696 unsigned int fromlen;
697 struct page ** pages;
698 unsigned int pathlen;
699 struct iattr * sattr;
702 struct nfs_readdirargs {
706 struct page ** pages;
709 struct nfs3_getaclargs {
712 struct page ** pages;
715 struct nfs3_setaclargs {
716 struct inode * inode;
718 struct posix_acl * acl_access;
719 struct posix_acl * acl_default;
722 struct page ** pages;
727 struct nfs_fattr * fattr;
730 struct nfs_readlinkargs {
734 struct page ** pages;
737 struct nfs3_sattrargs {
739 struct iattr * sattr;
741 struct timespec guardtime;
744 struct nfs3_diropargs {
750 struct nfs3_accessargs {
755 struct nfs3_createargs {
759 struct iattr * sattr;
760 enum nfs3_createmode createmode;
764 struct nfs3_mkdirargs {
768 struct iattr * sattr;
771 struct nfs3_symlinkargs {
772 struct nfs_fh * fromfh;
773 const char * fromname;
774 unsigned int fromlen;
775 struct page ** pages;
776 unsigned int pathlen;
777 struct iattr * sattr;
780 struct nfs3_mknodargs {
784 enum nfs3_ftype type;
785 struct iattr * sattr;
789 struct nfs3_linkargs {
790 struct nfs_fh * fromfh;
791 struct nfs_fh * tofh;
796 struct nfs3_readdirargs {
802 struct page ** pages;
805 struct nfs3_diropres {
806 struct nfs_fattr * dir_attr;
808 struct nfs_fattr * fattr;
811 struct nfs3_accessres {
812 struct nfs_fattr * fattr;
816 struct nfs3_readlinkargs {
820 struct page ** pages;
823 struct nfs3_linkres {
824 struct nfs_fattr * dir_attr;
825 struct nfs_fattr * fattr;
828 struct nfs3_readdirres {
829 struct nfs_fattr * dir_attr;
834 struct nfs3_getaclres {
835 struct nfs_fattr * fattr;
837 unsigned int acl_access_count;
838 unsigned int acl_default_count;
839 struct posix_acl * acl_access;
840 struct posix_acl * acl_default;
843 #if IS_ENABLED(CONFIG_NFS_V4)
845 typedef u64 clientid4;
847 struct nfs4_accessargs {
848 struct nfs4_sequence_args seq_args;
849 const struct nfs_fh * fh;
854 struct nfs4_accessres {
855 struct nfs4_sequence_res seq_res;
856 const struct nfs_server * server;
857 struct nfs_fattr * fattr;
862 struct nfs4_create_arg {
863 struct nfs4_sequence_args seq_args;
867 struct page ** pages;
869 } symlink; /* NF4LNK */
873 } device; /* NF4BLK, NF4CHR */
875 const struct qstr * name;
876 const struct nfs_server * server;
877 const struct iattr * attrs;
878 const struct nfs_fh * dir_fh;
880 const struct nfs4_label *label;
883 struct nfs4_create_res {
884 struct nfs4_sequence_res seq_res;
885 const struct nfs_server * server;
887 struct nfs_fattr * fattr;
888 struct nfs4_label *label;
889 struct nfs4_change_info dir_cinfo;
892 struct nfs4_fsinfo_arg {
893 struct nfs4_sequence_args seq_args;
894 const struct nfs_fh * fh;
898 struct nfs4_fsinfo_res {
899 struct nfs4_sequence_res seq_res;
900 struct nfs_fsinfo *fsinfo;
903 struct nfs4_getattr_arg {
904 struct nfs4_sequence_args seq_args;
905 const struct nfs_fh * fh;
909 struct nfs4_getattr_res {
910 struct nfs4_sequence_res seq_res;
911 const struct nfs_server * server;
912 struct nfs_fattr * fattr;
913 struct nfs4_label *label;
916 struct nfs4_link_arg {
917 struct nfs4_sequence_args seq_args;
918 const struct nfs_fh * fh;
919 const struct nfs_fh * dir_fh;
920 const struct qstr * name;
924 struct nfs4_link_res {
925 struct nfs4_sequence_res seq_res;
926 const struct nfs_server * server;
927 struct nfs_fattr * fattr;
928 struct nfs4_label *label;
929 struct nfs4_change_info cinfo;
930 struct nfs_fattr * dir_attr;
934 struct nfs4_lookup_arg {
935 struct nfs4_sequence_args seq_args;
936 const struct nfs_fh * dir_fh;
937 const struct qstr * name;
941 struct nfs4_lookup_res {
942 struct nfs4_sequence_res seq_res;
943 const struct nfs_server * server;
944 struct nfs_fattr * fattr;
946 struct nfs4_label *label;
949 struct nfs4_lookup_root_arg {
950 struct nfs4_sequence_args seq_args;
954 struct nfs4_pathconf_arg {
955 struct nfs4_sequence_args seq_args;
956 const struct nfs_fh * fh;
960 struct nfs4_pathconf_res {
961 struct nfs4_sequence_res seq_res;
962 struct nfs_pathconf *pathconf;
965 struct nfs4_readdir_arg {
966 struct nfs4_sequence_args seq_args;
967 const struct nfs_fh * fh;
969 nfs4_verifier verifier;
971 struct page ** pages; /* zero-copy data */
972 unsigned int pgbase; /* zero-copy data */
977 struct nfs4_readdir_res {
978 struct nfs4_sequence_res seq_res;
979 nfs4_verifier verifier;
983 struct nfs4_readlink {
984 struct nfs4_sequence_args seq_args;
985 const struct nfs_fh * fh;
987 unsigned int pglen; /* zero-copy data */
988 struct page ** pages; /* zero-copy data */
991 struct nfs4_readlink_res {
992 struct nfs4_sequence_res seq_res;
995 #define NFS4_SETCLIENTID_NAMELEN (127)
996 struct nfs4_setclientid {
997 const nfs4_verifier * sc_verifier;
998 unsigned int sc_name_len;
999 char sc_name[NFS4_SETCLIENTID_NAMELEN + 1];
1001 unsigned int sc_netid_len;
1002 char sc_netid[RPCBIND_MAXNETIDLEN + 1];
1003 unsigned int sc_uaddr_len;
1004 char sc_uaddr[RPCBIND_MAXUADDRLEN + 1];
1008 struct nfs4_setclientid_res {
1010 nfs4_verifier confirm;
1013 struct nfs4_statfs_arg {
1014 struct nfs4_sequence_args seq_args;
1015 const struct nfs_fh * fh;
1016 const u32 * bitmask;
1019 struct nfs4_statfs_res {
1020 struct nfs4_sequence_res seq_res;
1021 struct nfs_fsstat *fsstat;
1024 struct nfs4_server_caps_arg {
1025 struct nfs4_sequence_args seq_args;
1026 struct nfs_fh *fhandle;
1029 struct nfs4_server_caps_res {
1030 struct nfs4_sequence_res seq_res;
1031 u32 attr_bitmask[3];
1038 #define NFS4_PATHNAME_MAXCOMPONENTS 512
1039 struct nfs4_pathname {
1040 unsigned int ncomponents;
1041 struct nfs4_string components[NFS4_PATHNAME_MAXCOMPONENTS];
1044 #define NFS4_FS_LOCATION_MAXSERVERS 10
1045 struct nfs4_fs_location {
1046 unsigned int nservers;
1047 struct nfs4_string servers[NFS4_FS_LOCATION_MAXSERVERS];
1048 struct nfs4_pathname rootpath;
1051 #define NFS4_FS_LOCATIONS_MAXENTRIES 10
1052 struct nfs4_fs_locations {
1053 struct nfs_fattr fattr;
1054 const struct nfs_server *server;
1055 struct nfs4_pathname fs_path;
1057 struct nfs4_fs_location locations[NFS4_FS_LOCATIONS_MAXENTRIES];
1060 struct nfs4_fs_locations_arg {
1061 struct nfs4_sequence_args seq_args;
1062 const struct nfs_fh *dir_fh;
1063 const struct nfs_fh *fh;
1064 const struct qstr *name;
1068 unsigned char migration:1, renew:1;
1071 struct nfs4_fs_locations_res {
1072 struct nfs4_sequence_res seq_res;
1073 struct nfs4_fs_locations *fs_locations;
1074 unsigned char migration:1, renew:1;
1077 struct nfs4_secinfo4 {
1079 struct rpcsec_gss_info flavor_info;
1082 struct nfs4_secinfo_flavors {
1083 unsigned int num_flavors;
1084 struct nfs4_secinfo4 flavors[0];
1087 struct nfs4_secinfo_arg {
1088 struct nfs4_sequence_args seq_args;
1089 const struct nfs_fh *dir_fh;
1090 const struct qstr *name;
1093 struct nfs4_secinfo_res {
1094 struct nfs4_sequence_res seq_res;
1095 struct nfs4_secinfo_flavors *flavors;
1098 struct nfs4_fsid_present_arg {
1099 struct nfs4_sequence_args seq_args;
1100 const struct nfs_fh *fh;
1102 unsigned char renew:1;
1105 struct nfs4_fsid_present_res {
1106 struct nfs4_sequence_res seq_res;
1108 unsigned char renew:1;
1111 #endif /* CONFIG_NFS_V4 */
1118 #ifdef CONFIG_NFS_V4_1
1120 struct pnfs_commit_bucket {
1121 struct list_head written;
1122 struct list_head committing;
1123 struct pnfs_layout_segment *wlseg;
1124 struct pnfs_layout_segment *clseg;
1127 struct pnfs_ds_commit_info {
1131 struct pnfs_commit_bucket *buckets;
1134 #define NFS4_OP_MAP_NUM_LONGS \
1135 DIV_ROUND_UP(LAST_NFS4_OP, 8 * sizeof(unsigned long))
1136 #define NFS4_OP_MAP_NUM_WORDS \
1137 (NFS4_OP_MAP_NUM_LONGS * sizeof(unsigned long) / sizeof(u32))
1138 struct nfs4_op_map {
1140 unsigned long longs[NFS4_OP_MAP_NUM_LONGS];
1141 u32 words[NFS4_OP_MAP_NUM_WORDS];
1145 struct nfs41_state_protection {
1147 struct nfs4_op_map enforce;
1148 struct nfs4_op_map allow;
1151 #define NFS4_EXCHANGE_ID_LEN (48)
1152 struct nfs41_exchange_id_args {
1153 struct nfs_client *client;
1154 nfs4_verifier *verifier;
1155 unsigned int id_len;
1156 char id[NFS4_EXCHANGE_ID_LEN];
1158 struct nfs41_state_protection state_protect;
1161 struct nfs41_server_owner {
1163 uint32_t major_id_sz;
1164 char major_id[NFS4_OPAQUE_LIMIT];
1167 struct nfs41_server_scope {
1168 uint32_t server_scope_sz;
1169 char server_scope[NFS4_OPAQUE_LIMIT];
1172 struct nfs41_impl_id {
1173 char domain[NFS4_OPAQUE_LIMIT + 1];
1174 char name[NFS4_OPAQUE_LIMIT + 1];
1175 struct nfstime4 date;
1178 struct nfs41_bind_conn_to_session_res {
1179 struct nfs4_session *session;
1181 bool use_conn_in_rdma_mode;
1184 struct nfs41_exchange_id_res {
1188 struct nfs41_server_owner *server_owner;
1189 struct nfs41_server_scope *server_scope;
1190 struct nfs41_impl_id *impl_id;
1191 struct nfs41_state_protection state_protect;
1194 struct nfs41_create_session_args {
1195 struct nfs_client *client;
1197 uint32_t cb_program;
1198 struct nfs4_channel_attrs fc_attrs; /* Fore Channel */
1199 struct nfs4_channel_attrs bc_attrs; /* Back Channel */
1202 struct nfs41_create_session_res {
1203 struct nfs_client *client;
1206 struct nfs41_reclaim_complete_args {
1207 struct nfs4_sequence_args seq_args;
1208 /* In the future extend to include curr_fh for use with migration */
1209 unsigned char one_fs:1;
1212 struct nfs41_reclaim_complete_res {
1213 struct nfs4_sequence_res seq_res;
1216 #define SECINFO_STYLE_CURRENT_FH 0
1217 #define SECINFO_STYLE_PARENT 1
1218 struct nfs41_secinfo_no_name_args {
1219 struct nfs4_sequence_args seq_args;
1223 struct nfs41_test_stateid_args {
1224 struct nfs4_sequence_args seq_args;
1225 nfs4_stateid *stateid;
1228 struct nfs41_test_stateid_res {
1229 struct nfs4_sequence_res seq_res;
1230 unsigned int status;
1233 struct nfs41_free_stateid_args {
1234 struct nfs4_sequence_args seq_args;
1235 nfs4_stateid stateid;
1238 struct nfs41_free_stateid_res {
1239 struct nfs4_sequence_res seq_res;
1240 unsigned int status;
1245 struct pnfs_ds_commit_info {
1248 #endif /* CONFIG_NFS_V4_1 */
1252 #define NFS_PAGEVEC_SIZE (8U)
1254 struct nfs_page_array {
1255 struct page **pagevec;
1256 unsigned int npages; /* Max length of pagevec */
1257 struct page *page_array[NFS_PAGEVEC_SIZE];
1260 struct nfs_read_data {
1261 struct nfs_pgio_header *header;
1262 struct list_head list;
1263 struct rpc_task task;
1264 struct nfs_fattr fattr; /* fattr storage */
1265 struct nfs_readargs args;
1266 struct nfs_readres res;
1267 unsigned long timestamp; /* For lease renewal */
1268 int (*read_done_cb) (struct rpc_task *task, struct nfs_read_data *data);
1270 struct nfs_page_array pages;
1271 struct nfs_client *ds_clp; /* pNFS data server */
1274 /* used as flag bits in nfs_pgio_header */
1276 NFS_IOHDR_ERROR = 0,
1279 NFS_IOHDR_NEED_COMMIT,
1280 NFS_IOHDR_NEED_RESCHED,
1283 struct nfs_pgio_header {
1284 struct inode *inode;
1285 struct rpc_cred *cred;
1286 struct list_head pages;
1287 struct list_head rpc_list;
1289 struct nfs_page *req;
1290 struct nfs_writeverf *verf;
1291 struct pnfs_layout_segment *lseg;
1293 const struct rpc_call_ops *mds_ops;
1294 void (*release) (struct nfs_pgio_header *hdr);
1295 const struct nfs_pgio_completion_ops *completion_ops;
1296 struct nfs_direct_req *dreq;
1297 void *layout_private;
1299 /* fields protected by lock */
1301 int error; /* merge with pnfs_error */
1302 unsigned long good_bytes; /* boundary of good data */
1303 unsigned long flags;
1306 struct nfs_read_header {
1307 struct nfs_pgio_header header;
1308 struct nfs_read_data rpc_data;
1311 struct nfs_write_data {
1312 struct nfs_pgio_header *header;
1313 struct list_head list;
1314 struct rpc_task task;
1315 struct nfs_fattr fattr;
1316 struct nfs_writeverf verf;
1317 struct nfs_writeargs args; /* argument struct */
1318 struct nfs_writeres res; /* result struct */
1319 unsigned long timestamp; /* For lease renewal */
1320 int (*write_done_cb) (struct rpc_task *task, struct nfs_write_data *data);
1321 __u64 mds_offset; /* Filelayout dense stripe */
1322 struct nfs_page_array pages;
1323 struct nfs_client *ds_clp; /* pNFS data server */
1326 struct nfs_write_header {
1327 struct nfs_pgio_header header;
1328 struct nfs_write_data rpc_data;
1329 struct nfs_writeverf verf;
1332 struct nfs_mds_commit_info {
1334 unsigned long ncommit;
1335 struct list_head list;
1338 struct nfs_commit_data;
1340 struct nfs_commit_completion_ops {
1341 void (*error_cleanup) (struct nfs_inode *nfsi);
1342 void (*completion) (struct nfs_commit_data *data);
1345 struct nfs_commit_info {
1347 struct nfs_mds_commit_info *mds;
1348 struct pnfs_ds_commit_info *ds;
1349 struct nfs_direct_req *dreq; /* O_DIRECT request */
1350 const struct nfs_commit_completion_ops *completion_ops;
1353 struct nfs_commit_data {
1354 struct rpc_task task;
1355 struct inode *inode;
1356 struct rpc_cred *cred;
1357 struct nfs_fattr fattr;
1358 struct nfs_writeverf verf;
1359 struct list_head pages; /* Coalesced requests we wish to flush */
1360 struct list_head list; /* lists of struct nfs_write_data */
1361 struct nfs_direct_req *dreq; /* O_DIRECT request */
1362 struct nfs_commitargs args; /* argument struct */
1363 struct nfs_commitres res; /* result struct */
1364 struct nfs_open_context *context;
1365 struct pnfs_layout_segment *lseg;
1366 struct nfs_client *ds_clp; /* pNFS data server */
1367 int ds_commit_index;
1368 const struct rpc_call_ops *mds_ops;
1369 const struct nfs_commit_completion_ops *completion_ops;
1370 int (*commit_done_cb) (struct rpc_task *task, struct nfs_commit_data *data);
1373 struct nfs_pgio_completion_ops {
1374 void (*error_cleanup)(struct list_head *head);
1375 void (*init_hdr)(struct nfs_pgio_header *hdr);
1376 void (*completion)(struct nfs_pgio_header *hdr);
1379 struct nfs_unlinkdata {
1380 struct hlist_node list;
1381 struct nfs_removeargs args;
1382 struct nfs_removeres res;
1384 struct rpc_cred *cred;
1385 struct nfs_fattr dir_attr;
1388 struct nfs_renamedata {
1389 struct nfs_renameargs args;
1390 struct nfs_renameres res;
1391 struct rpc_cred *cred;
1392 struct inode *old_dir;
1393 struct dentry *old_dentry;
1394 struct nfs_fattr old_fattr;
1395 struct inode *new_dir;
1396 struct dentry *new_dentry;
1397 struct nfs_fattr new_fattr;
1400 struct nfs_access_entry;
1403 struct nfs_subversion;
1404 struct nfs_mount_info;
1405 struct nfs_client_initdata;
1406 struct nfs_pageio_descriptor;
1409 * RPC procedure vector for NFSv2/NFSv3 demuxing
1411 struct nfs_rpc_ops {
1412 u32 version; /* Protocol version */
1413 const struct dentry_operations *dentry_ops;
1414 const struct inode_operations *dir_inode_ops;
1415 const struct inode_operations *file_inode_ops;
1416 const struct file_operations *file_ops;
1418 int (*getroot) (struct nfs_server *, struct nfs_fh *,
1419 struct nfs_fsinfo *);
1420 struct vfsmount *(*submount) (struct nfs_server *, struct dentry *,
1421 struct nfs_fh *, struct nfs_fattr *);
1422 struct dentry *(*try_mount) (int, const char *, struct nfs_mount_info *,
1423 struct nfs_subversion *);
1424 int (*getattr) (struct nfs_server *, struct nfs_fh *,
1425 struct nfs_fattr *, struct nfs4_label *);
1426 int (*setattr) (struct dentry *, struct nfs_fattr *,
1428 int (*lookup) (struct inode *, struct qstr *,
1429 struct nfs_fh *, struct nfs_fattr *,
1430 struct nfs4_label *);
1431 int (*access) (struct inode *, struct nfs_access_entry *);
1432 int (*readlink)(struct inode *, struct page *, unsigned int,
1434 int (*create) (struct inode *, struct dentry *,
1435 struct iattr *, int);
1436 int (*remove) (struct inode *, struct qstr *);
1437 void (*unlink_setup) (struct rpc_message *, struct inode *dir);
1438 void (*unlink_rpc_prepare) (struct rpc_task *, struct nfs_unlinkdata *);
1439 int (*unlink_done) (struct rpc_task *, struct inode *);
1440 int (*rename) (struct inode *, struct qstr *,
1441 struct inode *, struct qstr *);
1442 void (*rename_setup) (struct rpc_message *msg, struct inode *dir);
1443 void (*rename_rpc_prepare)(struct rpc_task *task, struct nfs_renamedata *);
1444 int (*rename_done) (struct rpc_task *task, struct inode *old_dir, struct inode *new_dir);
1445 int (*link) (struct inode *, struct inode *, struct qstr *);
1446 int (*symlink) (struct inode *, struct dentry *, struct page *,
1447 unsigned int, struct iattr *);
1448 int (*mkdir) (struct inode *, struct dentry *, struct iattr *);
1449 int (*rmdir) (struct inode *, struct qstr *);
1450 int (*readdir) (struct dentry *, struct rpc_cred *,
1451 u64, struct page **, unsigned int, int);
1452 int (*mknod) (struct inode *, struct dentry *, struct iattr *,
1454 int (*statfs) (struct nfs_server *, struct nfs_fh *,
1455 struct nfs_fsstat *);
1456 int (*fsinfo) (struct nfs_server *, struct nfs_fh *,
1457 struct nfs_fsinfo *);
1458 int (*pathconf) (struct nfs_server *, struct nfs_fh *,
1459 struct nfs_pathconf *);
1460 int (*set_capabilities)(struct nfs_server *, struct nfs_fh *);
1461 int (*decode_dirent)(struct xdr_stream *, struct nfs_entry *, int);
1462 void (*read_setup) (struct nfs_read_data *, struct rpc_message *);
1463 void (*read_pageio_init)(struct nfs_pageio_descriptor *, struct inode *,
1464 const struct nfs_pgio_completion_ops *);
1465 int (*read_rpc_prepare)(struct rpc_task *, struct nfs_read_data *);
1466 int (*read_done) (struct rpc_task *, struct nfs_read_data *);
1467 void (*write_setup) (struct nfs_write_data *, struct rpc_message *);
1468 void (*write_pageio_init)(struct nfs_pageio_descriptor *, struct inode *, int,
1469 const struct nfs_pgio_completion_ops *);
1470 int (*write_rpc_prepare)(struct rpc_task *, struct nfs_write_data *);
1471 int (*write_done) (struct rpc_task *, struct nfs_write_data *);
1472 void (*commit_setup) (struct nfs_commit_data *, struct rpc_message *);
1473 void (*commit_rpc_prepare)(struct rpc_task *, struct nfs_commit_data *);
1474 int (*commit_done) (struct rpc_task *, struct nfs_commit_data *);
1475 int (*lock)(struct file *, int, struct file_lock *);
1476 int (*lock_check_bounds)(const struct file_lock *);
1477 void (*clear_acl_cache)(struct inode *);
1478 void (*close_context)(struct nfs_open_context *ctx, int);
1479 struct inode * (*open_context) (struct inode *dir,
1480 struct nfs_open_context *ctx,
1482 struct iattr *iattr,
1484 int (*have_delegation)(struct inode *, fmode_t);
1485 int (*return_delegation)(struct inode *);
1486 struct nfs_client *(*alloc_client) (const struct nfs_client_initdata *);
1488 (*init_client) (struct nfs_client *, const struct rpc_timeout *,
1490 void (*free_client) (struct nfs_client *);
1491 struct nfs_server *(*create_server)(struct nfs_mount_info *, struct nfs_subversion *);
1492 struct nfs_server *(*clone_server)(struct nfs_server *, struct nfs_fh *,
1493 struct nfs_fattr *, rpc_authflavor_t);
1497 * NFS_CALL(getattr, inode, (fattr));
1499 * NFS_PROTO(inode)->getattr(fattr);
1501 #define NFS_CALL(op, inode, args) NFS_PROTO(inode)->op args
1504 * Function vectors etc. for the NFS client
1506 extern const struct nfs_rpc_ops nfs_v2_clientops;
1507 extern const struct nfs_rpc_ops nfs_v3_clientops;
1508 extern const struct nfs_rpc_ops nfs_v4_clientops;
1509 extern const struct rpc_version nfs_version2;
1510 extern const struct rpc_version nfs_version3;
1511 extern const struct rpc_version nfs_version4;
1513 extern const struct rpc_version nfsacl_version3;
1514 extern const struct rpc_program nfsacl_program;