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 struct rpc_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 struct rpc_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 struct rpc_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_clone_args {
387 struct nfs4_sequence_args seq_args;
388 struct nfs_fh *src_fh;
389 struct nfs_fh *dst_fh;
390 nfs4_stateid src_stateid;
391 nfs4_stateid dst_stateid;
395 const u32 *dst_bitmask;
398 struct nfs42_clone_res {
399 struct nfs4_sequence_res seq_res;
400 unsigned int rpc_status;
401 struct nfs_fattr *dst_fattr;
402 const struct nfs_server *server;
405 struct stateowner_id {
411 * Arguments to the open call.
413 struct nfs_openargs {
414 struct nfs4_sequence_args seq_args;
415 const struct nfs_fh * fh;
416 struct nfs_seqid * seqid;
422 struct stateowner_id id;
425 struct iattr * attrs; /* UNCHECKED, GUARDED, EXCLUSIVE4_1 */
426 nfs4_verifier verifier; /* EXCLUSIVE */
428 nfs4_stateid delegation; /* CLAIM_DELEGATE_CUR */
429 fmode_t delegation_type; /* CLAIM_PREVIOUS */
431 const struct qstr * name;
432 const struct nfs_server *server; /* Needed for ID mapping */
434 const u32 * open_bitmap;
435 enum open_claim_type4 claim;
436 enum createmode4 createmode;
437 const struct nfs4_label *label;
439 struct nfs4_layoutget_args *lg_args;
443 struct nfs4_sequence_res seq_res;
444 nfs4_stateid stateid;
446 struct nfs4_change_info cinfo;
448 struct nfs_fattr * f_attr;
449 struct nfs4_label *f_label;
450 struct nfs_seqid * seqid;
451 const struct nfs_server *server;
452 fmode_t delegation_type;
453 nfs4_stateid delegation;
454 unsigned long pagemod_limit;
456 __u32 attrset[NFS4_BITMAP_SIZE];
457 struct nfs4_string *owner;
458 struct nfs4_string *group_owner;
459 __u32 access_request;
460 __u32 access_supported;
462 struct nfs4_layoutget_res *lg_res;
466 * Arguments to the open_confirm call.
468 struct nfs_open_confirmargs {
469 struct nfs4_sequence_args seq_args;
470 const struct nfs_fh * fh;
471 nfs4_stateid * stateid;
472 struct nfs_seqid * seqid;
475 struct nfs_open_confirmres {
476 struct nfs4_sequence_res seq_res;
477 nfs4_stateid stateid;
478 struct nfs_seqid * seqid;
482 * Arguments to the close call.
484 struct nfs_closeargs {
485 struct nfs4_sequence_args seq_args;
487 nfs4_stateid stateid;
488 struct nfs_seqid * seqid;
492 struct nfs4_layoutreturn_args *lr_args;
495 struct nfs_closeres {
496 struct nfs4_sequence_res seq_res;
497 nfs4_stateid stateid;
498 struct nfs_fattr * fattr;
499 struct nfs_seqid * seqid;
500 const struct nfs_server *server;
501 struct nfs4_layoutreturn_res *lr_res;
505 * * Arguments to the lock,lockt, and locku call.
513 struct nfs_lock_args {
514 struct nfs4_sequence_args seq_args;
516 struct file_lock * fl;
517 struct nfs_seqid * lock_seqid;
518 nfs4_stateid lock_stateid;
519 struct nfs_seqid * open_seqid;
520 nfs4_stateid open_stateid;
521 struct nfs_lowner lock_owner;
522 unsigned char block : 1;
523 unsigned char reclaim : 1;
524 unsigned char new_lock : 1;
525 unsigned char new_lock_owner : 1;
528 struct nfs_lock_res {
529 struct nfs4_sequence_res seq_res;
530 nfs4_stateid stateid;
531 struct nfs_seqid * lock_seqid;
532 struct nfs_seqid * open_seqid;
535 struct nfs_locku_args {
536 struct nfs4_sequence_args seq_args;
538 struct file_lock * fl;
539 struct nfs_seqid * seqid;
540 nfs4_stateid stateid;
543 struct nfs_locku_res {
544 struct nfs4_sequence_res seq_res;
545 nfs4_stateid stateid;
546 struct nfs_seqid * seqid;
549 struct nfs_lockt_args {
550 struct nfs4_sequence_args seq_args;
552 struct file_lock * fl;
553 struct nfs_lowner lock_owner;
556 struct nfs_lockt_res {
557 struct nfs4_sequence_res seq_res;
558 struct file_lock * denied; /* LOCK, LOCKT failed */
561 struct nfs_release_lockowner_args {
562 struct nfs4_sequence_args seq_args;
563 struct nfs_lowner lock_owner;
566 struct nfs_release_lockowner_res {
567 struct nfs4_sequence_res seq_res;
570 struct nfs4_delegreturnargs {
571 struct nfs4_sequence_args seq_args;
572 const struct nfs_fh *fhandle;
573 const nfs4_stateid *stateid;
575 struct nfs4_layoutreturn_args *lr_args;
578 struct nfs4_delegreturnres {
579 struct nfs4_sequence_res seq_res;
580 struct nfs_fattr * fattr;
581 struct nfs_server *server;
582 struct nfs4_layoutreturn_res *lr_res;
587 * Arguments to the write call.
589 struct nfs_write_verifier {
593 struct nfs_writeverf {
594 struct nfs_write_verifier verifier;
595 enum nfs3_stable_how committed;
599 * Arguments shared by the read and write call.
601 struct nfs_pgio_args {
602 struct nfs4_sequence_args seq_args;
604 struct nfs_open_context *context;
605 struct nfs_lock_context *lock_context;
606 nfs4_stateid stateid;
610 struct page ** pages;
611 const u32 * bitmask; /* used by write */
612 enum nfs3_stable_how stable; /* used by write */
615 struct nfs_pgio_res {
616 struct nfs4_sequence_res seq_res;
617 struct nfs_fattr * fattr;
620 int eof; /* used by read */
621 struct nfs_writeverf * verf; /* used by write */
622 const struct nfs_server *server; /* used by write */
627 * Arguments to the commit call.
629 struct nfs_commitargs {
630 struct nfs4_sequence_args seq_args;
637 struct nfs_commitres {
638 struct nfs4_sequence_res seq_res;
640 struct nfs_fattr *fattr;
641 struct nfs_writeverf *verf;
642 const struct nfs_server *server;
646 * Common arguments to the unlink call
648 struct nfs_removeargs {
649 struct nfs4_sequence_args seq_args;
650 const struct nfs_fh *fh;
654 struct nfs_removeres {
655 struct nfs4_sequence_res seq_res;
656 struct nfs_server *server;
657 struct nfs_fattr *dir_attr;
658 struct nfs4_change_info cinfo;
662 * Common arguments to the rename call
664 struct nfs_renameargs {
665 struct nfs4_sequence_args seq_args;
666 const struct nfs_fh *old_dir;
667 const struct nfs_fh *new_dir;
668 const struct qstr *old_name;
669 const struct qstr *new_name;
672 struct nfs_renameres {
673 struct nfs4_sequence_res seq_res;
674 struct nfs_server *server;
675 struct nfs4_change_info old_cinfo;
676 struct nfs_fattr *old_fattr;
677 struct nfs4_change_info new_cinfo;
678 struct nfs_fattr *new_fattr;
681 /* parsed sec= options */
682 #define NFS_AUTH_INFO_MAX_FLAVORS 12 /* see fs/nfs/super.c */
683 struct nfs_auth_info {
684 unsigned int flavor_len;
685 rpc_authflavor_t flavors[NFS_AUTH_INFO_MAX_FLAVORS];
689 * Argument struct for decode_entry function
699 struct nfs_fattr * fattr;
700 struct nfs4_label *label;
701 unsigned char d_type;
702 struct nfs_server * server;
706 * The following types are for NFSv2 only.
708 struct nfs_sattrargs {
710 struct iattr * sattr;
713 struct nfs_diropargs {
719 struct nfs_createargs {
723 struct iattr * sattr;
726 struct nfs_setattrargs {
727 struct nfs4_sequence_args seq_args;
729 nfs4_stateid stateid;
731 const struct nfs_server * server; /* Needed for name mapping */
733 const struct nfs4_label *label;
736 struct nfs_setaclargs {
737 struct nfs4_sequence_args seq_args;
740 struct page ** acl_pages;
743 struct nfs_setaclres {
744 struct nfs4_sequence_res seq_res;
747 struct nfs_getaclargs {
748 struct nfs4_sequence_args seq_args;
751 struct page ** acl_pages;
754 /* getxattr ACL interface flags */
755 #define NFS4_ACL_TRUNC 0x0001 /* ACL was truncated */
756 struct nfs_getaclres {
757 struct nfs4_sequence_res seq_res;
759 size_t acl_data_offset;
761 struct page * acl_scratch;
764 struct nfs_setattrres {
765 struct nfs4_sequence_res seq_res;
766 struct nfs_fattr * fattr;
767 struct nfs4_label *label;
768 const struct nfs_server * server;
771 struct nfs_linkargs {
772 struct nfs_fh * fromfh;
773 struct nfs_fh * tofh;
778 struct nfs_symlinkargs {
779 struct nfs_fh * fromfh;
780 const char * fromname;
781 unsigned int fromlen;
782 struct page ** pages;
783 unsigned int pathlen;
784 struct iattr * sattr;
787 struct nfs_readdirargs {
791 struct page ** pages;
794 struct nfs3_getaclargs {
797 struct page ** pages;
800 struct nfs3_setaclargs {
801 struct inode * inode;
803 struct posix_acl * acl_access;
804 struct posix_acl * acl_default;
807 struct page ** pages;
812 struct nfs_fattr * fattr;
815 struct nfs_readlinkargs {
819 struct page ** pages;
822 struct nfs3_sattrargs {
824 struct iattr * sattr;
826 struct timespec guardtime;
829 struct nfs3_diropargs {
835 struct nfs3_accessargs {
840 struct nfs3_createargs {
844 struct iattr * sattr;
845 enum nfs3_createmode createmode;
849 struct nfs3_mkdirargs {
853 struct iattr * sattr;
856 struct nfs3_symlinkargs {
857 struct nfs_fh * fromfh;
858 const char * fromname;
859 unsigned int fromlen;
860 struct page ** pages;
861 unsigned int pathlen;
862 struct iattr * sattr;
865 struct nfs3_mknodargs {
869 enum nfs3_ftype type;
870 struct iattr * sattr;
874 struct nfs3_linkargs {
875 struct nfs_fh * fromfh;
876 struct nfs_fh * tofh;
881 struct nfs3_readdirargs {
887 struct page ** pages;
890 struct nfs3_diropres {
891 struct nfs_fattr * dir_attr;
893 struct nfs_fattr * fattr;
896 struct nfs3_accessres {
897 struct nfs_fattr * fattr;
901 struct nfs3_readlinkargs {
905 struct page ** pages;
908 struct nfs3_linkres {
909 struct nfs_fattr * dir_attr;
910 struct nfs_fattr * fattr;
913 struct nfs3_readdirres {
914 struct nfs_fattr * dir_attr;
919 struct nfs3_getaclres {
920 struct nfs_fattr * fattr;
922 unsigned int acl_access_count;
923 unsigned int acl_default_count;
924 struct posix_acl * acl_access;
925 struct posix_acl * acl_default;
928 #if IS_ENABLED(CONFIG_NFS_V4)
930 typedef u64 clientid4;
932 struct nfs4_accessargs {
933 struct nfs4_sequence_args seq_args;
934 const struct nfs_fh * fh;
939 struct nfs4_accessres {
940 struct nfs4_sequence_res seq_res;
941 const struct nfs_server * server;
942 struct nfs_fattr * fattr;
947 struct nfs4_create_arg {
948 struct nfs4_sequence_args seq_args;
952 struct page ** pages;
954 } symlink; /* NF4LNK */
958 } device; /* NF4BLK, NF4CHR */
960 const struct qstr * name;
961 const struct nfs_server * server;
962 const struct iattr * attrs;
963 const struct nfs_fh * dir_fh;
965 const struct nfs4_label *label;
969 struct nfs4_create_res {
970 struct nfs4_sequence_res seq_res;
971 const struct nfs_server * server;
973 struct nfs_fattr * fattr;
974 struct nfs4_label *label;
975 struct nfs4_change_info dir_cinfo;
978 struct nfs4_fsinfo_arg {
979 struct nfs4_sequence_args seq_args;
980 const struct nfs_fh * fh;
984 struct nfs4_fsinfo_res {
985 struct nfs4_sequence_res seq_res;
986 struct nfs_fsinfo *fsinfo;
989 struct nfs4_getattr_arg {
990 struct nfs4_sequence_args seq_args;
991 const struct nfs_fh * fh;
995 struct nfs4_getattr_res {
996 struct nfs4_sequence_res seq_res;
997 const struct nfs_server * server;
998 struct nfs_fattr * fattr;
999 struct nfs4_label *label;
1002 struct nfs4_link_arg {
1003 struct nfs4_sequence_args seq_args;
1004 const struct nfs_fh * fh;
1005 const struct nfs_fh * dir_fh;
1006 const struct qstr * name;
1007 const u32 * bitmask;
1010 struct nfs4_link_res {
1011 struct nfs4_sequence_res seq_res;
1012 const struct nfs_server * server;
1013 struct nfs_fattr * fattr;
1014 struct nfs4_label *label;
1015 struct nfs4_change_info cinfo;
1016 struct nfs_fattr * dir_attr;
1019 struct nfs4_lookup_arg {
1020 struct nfs4_sequence_args seq_args;
1021 const struct nfs_fh * dir_fh;
1022 const struct qstr * name;
1023 const u32 * bitmask;
1026 struct nfs4_lookup_res {
1027 struct nfs4_sequence_res seq_res;
1028 const struct nfs_server * server;
1029 struct nfs_fattr * fattr;
1031 struct nfs4_label *label;
1034 struct nfs4_lookupp_arg {
1035 struct nfs4_sequence_args seq_args;
1036 const struct nfs_fh *fh;
1040 struct nfs4_lookupp_res {
1041 struct nfs4_sequence_res seq_res;
1042 const struct nfs_server *server;
1043 struct nfs_fattr *fattr;
1045 struct nfs4_label *label;
1048 struct nfs4_lookup_root_arg {
1049 struct nfs4_sequence_args seq_args;
1050 const u32 * bitmask;
1053 struct nfs4_pathconf_arg {
1054 struct nfs4_sequence_args seq_args;
1055 const struct nfs_fh * fh;
1056 const u32 * bitmask;
1059 struct nfs4_pathconf_res {
1060 struct nfs4_sequence_res seq_res;
1061 struct nfs_pathconf *pathconf;
1064 struct nfs4_readdir_arg {
1065 struct nfs4_sequence_args seq_args;
1066 const struct nfs_fh * fh;
1068 nfs4_verifier verifier;
1070 struct page ** pages; /* zero-copy data */
1071 unsigned int pgbase; /* zero-copy data */
1072 const u32 * bitmask;
1076 struct nfs4_readdir_res {
1077 struct nfs4_sequence_res seq_res;
1078 nfs4_verifier verifier;
1079 unsigned int pgbase;
1082 struct nfs4_readlink {
1083 struct nfs4_sequence_args seq_args;
1084 const struct nfs_fh * fh;
1085 unsigned int pgbase;
1086 unsigned int pglen; /* zero-copy data */
1087 struct page ** pages; /* zero-copy data */
1090 struct nfs4_readlink_res {
1091 struct nfs4_sequence_res seq_res;
1094 struct nfs4_setclientid {
1095 const nfs4_verifier * sc_verifier;
1097 unsigned int sc_netid_len;
1098 char sc_netid[RPCBIND_MAXNETIDLEN + 1];
1099 unsigned int sc_uaddr_len;
1100 char sc_uaddr[RPCBIND_MAXUADDRLEN + 1];
1101 struct nfs_client *sc_clnt;
1102 struct rpc_cred *sc_cred;
1105 struct nfs4_setclientid_res {
1107 nfs4_verifier confirm;
1110 struct nfs4_statfs_arg {
1111 struct nfs4_sequence_args seq_args;
1112 const struct nfs_fh * fh;
1113 const u32 * bitmask;
1116 struct nfs4_statfs_res {
1117 struct nfs4_sequence_res seq_res;
1118 struct nfs_fsstat *fsstat;
1121 struct nfs4_server_caps_arg {
1122 struct nfs4_sequence_args seq_args;
1123 struct nfs_fh *fhandle;
1124 const u32 * bitmask;
1127 struct nfs4_server_caps_res {
1128 struct nfs4_sequence_res seq_res;
1129 u32 attr_bitmask[3];
1130 u32 exclcreat_bitmask[3];
1137 #define NFS4_PATHNAME_MAXCOMPONENTS 512
1138 struct nfs4_pathname {
1139 unsigned int ncomponents;
1140 struct nfs4_string components[NFS4_PATHNAME_MAXCOMPONENTS];
1143 #define NFS4_FS_LOCATION_MAXSERVERS 10
1144 struct nfs4_fs_location {
1145 unsigned int nservers;
1146 struct nfs4_string servers[NFS4_FS_LOCATION_MAXSERVERS];
1147 struct nfs4_pathname rootpath;
1150 #define NFS4_FS_LOCATIONS_MAXENTRIES 10
1151 struct nfs4_fs_locations {
1152 struct nfs_fattr fattr;
1153 const struct nfs_server *server;
1154 struct nfs4_pathname fs_path;
1156 struct nfs4_fs_location locations[NFS4_FS_LOCATIONS_MAXENTRIES];
1159 struct nfs4_fs_locations_arg {
1160 struct nfs4_sequence_args seq_args;
1161 const struct nfs_fh *dir_fh;
1162 const struct nfs_fh *fh;
1163 const struct qstr *name;
1167 unsigned char migration:1, renew:1;
1170 struct nfs4_fs_locations_res {
1171 struct nfs4_sequence_res seq_res;
1172 struct nfs4_fs_locations *fs_locations;
1173 unsigned char migration:1, renew:1;
1176 struct nfs4_secinfo4 {
1178 struct rpcsec_gss_info flavor_info;
1181 struct nfs4_secinfo_flavors {
1182 unsigned int num_flavors;
1183 struct nfs4_secinfo4 flavors[0];
1186 struct nfs4_secinfo_arg {
1187 struct nfs4_sequence_args seq_args;
1188 const struct nfs_fh *dir_fh;
1189 const struct qstr *name;
1192 struct nfs4_secinfo_res {
1193 struct nfs4_sequence_res seq_res;
1194 struct nfs4_secinfo_flavors *flavors;
1197 struct nfs4_fsid_present_arg {
1198 struct nfs4_sequence_args seq_args;
1199 const struct nfs_fh *fh;
1201 unsigned char renew:1;
1204 struct nfs4_fsid_present_res {
1205 struct nfs4_sequence_res seq_res;
1207 unsigned char renew:1;
1210 #endif /* CONFIG_NFS_V4 */
1217 #ifdef CONFIG_NFS_V4_1
1219 struct pnfs_commit_bucket {
1220 struct list_head written;
1221 struct list_head committing;
1222 struct pnfs_layout_segment *wlseg;
1223 struct pnfs_layout_segment *clseg;
1224 struct nfs_writeverf direct_verf;
1227 struct pnfs_ds_commit_info {
1231 struct pnfs_commit_bucket *buckets;
1234 struct nfs41_state_protection {
1236 struct nfs4_op_map enforce;
1237 struct nfs4_op_map allow;
1240 struct nfs41_exchange_id_args {
1241 struct nfs_client *client;
1242 nfs4_verifier verifier;
1244 struct nfs41_state_protection state_protect;
1247 struct nfs41_server_owner {
1249 uint32_t major_id_sz;
1250 char major_id[NFS4_OPAQUE_LIMIT];
1253 struct nfs41_server_scope {
1254 uint32_t server_scope_sz;
1255 char server_scope[NFS4_OPAQUE_LIMIT];
1258 struct nfs41_impl_id {
1259 char domain[NFS4_OPAQUE_LIMIT + 1];
1260 char name[NFS4_OPAQUE_LIMIT + 1];
1261 struct nfstime4 date;
1264 struct nfs41_bind_conn_to_session_args {
1265 struct nfs_client *client;
1266 struct nfs4_sessionid sessionid;
1268 bool use_conn_in_rdma_mode;
1271 struct nfs41_bind_conn_to_session_res {
1272 struct nfs4_sessionid sessionid;
1274 bool use_conn_in_rdma_mode;
1277 struct nfs41_exchange_id_res {
1281 struct nfs41_server_owner *server_owner;
1282 struct nfs41_server_scope *server_scope;
1283 struct nfs41_impl_id *impl_id;
1284 struct nfs41_state_protection state_protect;
1287 struct nfs41_create_session_args {
1288 struct nfs_client *client;
1292 uint32_t cb_program;
1293 struct nfs4_channel_attrs fc_attrs; /* Fore Channel */
1294 struct nfs4_channel_attrs bc_attrs; /* Back Channel */
1297 struct nfs41_create_session_res {
1298 struct nfs4_sessionid sessionid;
1301 struct nfs4_channel_attrs fc_attrs; /* Fore Channel */
1302 struct nfs4_channel_attrs bc_attrs; /* Back Channel */
1305 struct nfs41_reclaim_complete_args {
1306 struct nfs4_sequence_args seq_args;
1307 /* In the future extend to include curr_fh for use with migration */
1308 unsigned char one_fs:1;
1311 struct nfs41_reclaim_complete_res {
1312 struct nfs4_sequence_res seq_res;
1315 #define SECINFO_STYLE_CURRENT_FH 0
1316 #define SECINFO_STYLE_PARENT 1
1317 struct nfs41_secinfo_no_name_args {
1318 struct nfs4_sequence_args seq_args;
1322 struct nfs41_test_stateid_args {
1323 struct nfs4_sequence_args seq_args;
1324 nfs4_stateid *stateid;
1327 struct nfs41_test_stateid_res {
1328 struct nfs4_sequence_res seq_res;
1329 unsigned int status;
1332 struct nfs41_free_stateid_args {
1333 struct nfs4_sequence_args seq_args;
1334 nfs4_stateid stateid;
1337 struct nfs41_free_stateid_res {
1338 struct nfs4_sequence_res seq_res;
1339 unsigned int status;
1343 nfs_free_pnfs_ds_cinfo(struct pnfs_ds_commit_info *cinfo)
1345 kfree(cinfo->buckets);
1350 struct pnfs_ds_commit_info {
1354 nfs_free_pnfs_ds_cinfo(struct pnfs_ds_commit_info *cinfo)
1358 #endif /* CONFIG_NFS_V4_1 */
1360 #ifdef CONFIG_NFS_V4_2
1361 struct nfs42_falloc_args {
1362 struct nfs4_sequence_args seq_args;
1364 struct nfs_fh *falloc_fh;
1365 nfs4_stateid falloc_stateid;
1368 const u32 *falloc_bitmask;
1371 struct nfs42_falloc_res {
1372 struct nfs4_sequence_res seq_res;
1373 unsigned int status;
1375 struct nfs_fattr *falloc_fattr;
1376 const struct nfs_server *falloc_server;
1379 struct nfs42_copy_args {
1380 struct nfs4_sequence_args seq_args;
1382 struct nfs_fh *src_fh;
1383 nfs4_stateid src_stateid;
1386 struct nfs_fh *dst_fh;
1387 nfs4_stateid dst_stateid;
1394 struct nfs42_write_res {
1395 nfs4_stateid stateid;
1397 struct nfs_writeverf verifier;
1400 struct nfs42_copy_res {
1401 struct nfs4_sequence_res seq_res;
1402 struct nfs42_write_res write_res;
1405 struct nfs_commitres commit_res;
1408 struct nfs42_offload_status_args {
1409 struct nfs4_sequence_args osa_seq_args;
1410 struct nfs_fh *osa_src_fh;
1411 nfs4_stateid osa_stateid;
1414 struct nfs42_offload_status_res {
1415 struct nfs4_sequence_res osr_seq_res;
1420 struct nfs42_seek_args {
1421 struct nfs4_sequence_args seq_args;
1423 struct nfs_fh *sa_fh;
1424 nfs4_stateid sa_stateid;
1429 struct nfs42_seek_res {
1430 struct nfs4_sequence_res seq_res;
1431 unsigned int status;
1440 #define NFS_PAGEVEC_SIZE (8U)
1442 struct nfs_page_array {
1443 struct page **pagevec;
1444 unsigned int npages; /* Max length of pagevec */
1445 struct page *page_array[NFS_PAGEVEC_SIZE];
1448 /* used as flag bits in nfs_pgio_header */
1450 NFS_IOHDR_ERROR = 0,
1454 NFS_IOHDR_RESEND_PNFS,
1455 NFS_IOHDR_RESEND_MDS,
1458 struct nfs_io_completion;
1459 struct nfs_pgio_header {
1460 struct inode *inode;
1461 struct rpc_cred *cred;
1462 struct list_head pages;
1463 struct nfs_page *req;
1464 struct nfs_writeverf verf; /* Used for writes */
1466 struct pnfs_layout_segment *lseg;
1468 const struct rpc_call_ops *mds_ops;
1469 void (*release) (struct nfs_pgio_header *hdr);
1470 const struct nfs_pgio_completion_ops *completion_ops;
1471 const struct nfs_rw_ops *rw_ops;
1472 struct nfs_io_completion *io_completion;
1473 struct nfs_direct_req *dreq;
1475 /* fields protected by lock */
1477 int error; /* merge with pnfs_error */
1478 unsigned long good_bytes; /* boundary of good data */
1479 unsigned long flags;
1484 struct rpc_task task;
1485 struct nfs_fattr fattr;
1486 struct nfs_pgio_args args; /* argument struct */
1487 struct nfs_pgio_res res; /* result struct */
1488 unsigned long timestamp; /* For lease renewal */
1489 int (*pgio_done_cb)(struct rpc_task *, struct nfs_pgio_header *);
1490 __u64 mds_offset; /* Filelayout dense stripe */
1491 struct nfs_page_array page_array;
1492 struct nfs_client *ds_clp; /* pNFS data server */
1493 int ds_commit_idx; /* ds index if ds_clp is set */
1494 int pgio_mirror_idx;/* mirror index in pgio layer */
1497 struct nfs_mds_commit_info {
1499 atomic_long_t ncommit;
1500 struct list_head list;
1503 struct nfs_commit_info;
1504 struct nfs_commit_data;
1506 struct nfs_commit_completion_ops {
1507 void (*completion) (struct nfs_commit_data *data);
1508 void (*resched_write) (struct nfs_commit_info *, struct nfs_page *);
1511 struct nfs_commit_info {
1512 struct inode *inode; /* Needed for inode->i_lock */
1513 struct nfs_mds_commit_info *mds;
1514 struct pnfs_ds_commit_info *ds;
1515 struct nfs_direct_req *dreq; /* O_DIRECT request */
1516 const struct nfs_commit_completion_ops *completion_ops;
1519 struct nfs_commit_data {
1520 struct rpc_task task;
1521 struct inode *inode;
1522 struct rpc_cred *cred;
1523 struct nfs_fattr fattr;
1524 struct nfs_writeverf verf;
1525 struct list_head pages; /* Coalesced requests we wish to flush */
1526 struct list_head list; /* lists of struct nfs_write_data */
1527 struct nfs_direct_req *dreq; /* O_DIRECT request */
1528 struct nfs_commitargs args; /* argument struct */
1529 struct nfs_commitres res; /* result struct */
1530 struct nfs_open_context *context;
1531 struct pnfs_layout_segment *lseg;
1532 struct nfs_client *ds_clp; /* pNFS data server */
1533 int ds_commit_index;
1535 const struct rpc_call_ops *mds_ops;
1536 const struct nfs_commit_completion_ops *completion_ops;
1537 int (*commit_done_cb) (struct rpc_task *task, struct nfs_commit_data *data);
1538 unsigned long flags;
1541 struct nfs_pgio_completion_ops {
1542 void (*error_cleanup)(struct list_head *head, int);
1543 void (*init_hdr)(struct nfs_pgio_header *hdr);
1544 void (*completion)(struct nfs_pgio_header *hdr);
1545 void (*reschedule_io)(struct nfs_pgio_header *hdr);
1548 struct nfs_unlinkdata {
1549 struct nfs_removeargs args;
1550 struct nfs_removeres res;
1551 struct dentry *dentry;
1552 wait_queue_head_t wq;
1553 struct rpc_cred *cred;
1554 struct nfs_fattr dir_attr;
1558 struct nfs_renamedata {
1559 struct nfs_renameargs args;
1560 struct nfs_renameres res;
1561 struct rpc_cred *cred;
1562 struct inode *old_dir;
1563 struct dentry *old_dentry;
1564 struct nfs_fattr old_fattr;
1565 struct inode *new_dir;
1566 struct dentry *new_dentry;
1567 struct nfs_fattr new_fattr;
1568 void (*complete)(struct rpc_task *, struct nfs_renamedata *);
1573 struct nfs_access_entry;
1576 struct nfs_subversion;
1577 struct nfs_mount_info;
1578 struct nfs_client_initdata;
1579 struct nfs_pageio_descriptor;
1582 * RPC procedure vector for NFSv2/NFSv3 demuxing
1584 struct nfs_rpc_ops {
1585 u32 version; /* Protocol version */
1586 const struct dentry_operations *dentry_ops;
1587 const struct inode_operations *dir_inode_ops;
1588 const struct inode_operations *file_inode_ops;
1589 const struct file_operations *file_ops;
1590 const struct nlmclnt_operations *nlmclnt_ops;
1592 int (*getroot) (struct nfs_server *, struct nfs_fh *,
1593 struct nfs_fsinfo *);
1594 struct vfsmount *(*submount) (struct nfs_server *, struct dentry *,
1595 struct nfs_fh *, struct nfs_fattr *);
1596 struct dentry *(*try_mount) (int, const char *, struct nfs_mount_info *,
1597 struct nfs_subversion *);
1598 int (*getattr) (struct nfs_server *, struct nfs_fh *,
1599 struct nfs_fattr *, struct nfs4_label *,
1601 int (*setattr) (struct dentry *, struct nfs_fattr *,
1603 int (*lookup) (struct inode *, const struct qstr *,
1604 struct nfs_fh *, struct nfs_fattr *,
1605 struct nfs4_label *);
1606 int (*lookupp) (struct inode *, struct nfs_fh *,
1607 struct nfs_fattr *, struct nfs4_label *);
1608 int (*access) (struct inode *, struct nfs_access_entry *);
1609 int (*readlink)(struct inode *, struct page *, unsigned int,
1611 int (*create) (struct inode *, struct dentry *,
1612 struct iattr *, int);
1613 int (*remove) (struct inode *, struct dentry *);
1614 void (*unlink_setup) (struct rpc_message *, struct dentry *, struct inode *);
1615 void (*unlink_rpc_prepare) (struct rpc_task *, struct nfs_unlinkdata *);
1616 int (*unlink_done) (struct rpc_task *, struct inode *);
1617 void (*rename_setup) (struct rpc_message *msg,
1618 struct dentry *old_dentry,
1619 struct dentry *new_dentry);
1620 void (*rename_rpc_prepare)(struct rpc_task *task, struct nfs_renamedata *);
1621 int (*rename_done) (struct rpc_task *task, struct inode *old_dir, struct inode *new_dir);
1622 int (*link) (struct inode *, struct inode *, const struct qstr *);
1623 int (*symlink) (struct inode *, struct dentry *, struct page *,
1624 unsigned int, struct iattr *);
1625 int (*mkdir) (struct inode *, struct dentry *, struct iattr *);
1626 int (*rmdir) (struct inode *, const struct qstr *);
1627 int (*readdir) (struct dentry *, struct rpc_cred *,
1628 u64, struct page **, unsigned int, bool);
1629 int (*mknod) (struct inode *, struct dentry *, struct iattr *,
1631 int (*statfs) (struct nfs_server *, struct nfs_fh *,
1632 struct nfs_fsstat *);
1633 int (*fsinfo) (struct nfs_server *, struct nfs_fh *,
1634 struct nfs_fsinfo *);
1635 int (*pathconf) (struct nfs_server *, struct nfs_fh *,
1636 struct nfs_pathconf *);
1637 int (*set_capabilities)(struct nfs_server *, struct nfs_fh *);
1638 int (*decode_dirent)(struct xdr_stream *, struct nfs_entry *, bool);
1639 int (*pgio_rpc_prepare)(struct rpc_task *,
1640 struct nfs_pgio_header *);
1641 void (*read_setup)(struct nfs_pgio_header *, struct rpc_message *);
1642 int (*read_done)(struct rpc_task *, struct nfs_pgio_header *);
1643 void (*write_setup)(struct nfs_pgio_header *, struct rpc_message *,
1644 struct rpc_clnt **);
1645 int (*write_done)(struct rpc_task *, struct nfs_pgio_header *);
1646 void (*commit_setup) (struct nfs_commit_data *, struct rpc_message *,
1647 struct rpc_clnt **);
1648 void (*commit_rpc_prepare)(struct rpc_task *, struct nfs_commit_data *);
1649 int (*commit_done) (struct rpc_task *, struct nfs_commit_data *);
1650 int (*lock)(struct file *, int, struct file_lock *);
1651 int (*lock_check_bounds)(const struct file_lock *);
1652 void (*clear_acl_cache)(struct inode *);
1653 void (*close_context)(struct nfs_open_context *ctx, int);
1654 struct inode * (*open_context) (struct inode *dir,
1655 struct nfs_open_context *ctx,
1657 struct iattr *iattr,
1659 int (*have_delegation)(struct inode *, fmode_t);
1660 struct nfs_client *(*alloc_client) (const struct nfs_client_initdata *);
1661 struct nfs_client *(*init_client) (struct nfs_client *,
1662 const struct nfs_client_initdata *);
1663 void (*free_client) (struct nfs_client *);
1664 struct nfs_server *(*create_server)(struct nfs_mount_info *, struct nfs_subversion *);
1665 struct nfs_server *(*clone_server)(struct nfs_server *, struct nfs_fh *,
1666 struct nfs_fattr *, rpc_authflavor_t);
1670 * NFS_CALL(getattr, inode, (fattr));
1672 * NFS_PROTO(inode)->getattr(fattr);
1674 #define NFS_CALL(op, inode, args) NFS_PROTO(inode)->op args
1677 * Function vectors etc. for the NFS client
1679 extern const struct nfs_rpc_ops nfs_v2_clientops;
1680 extern const struct nfs_rpc_ops nfs_v3_clientops;
1681 extern const struct nfs_rpc_ops nfs_v4_clientops;
1682 extern const struct rpc_version nfs_version2;
1683 extern const struct rpc_version nfs_version3;
1684 extern const struct rpc_version nfs_version4;
1686 extern const struct rpc_version nfsacl_version3;
1687 extern const struct rpc_program nfsacl_program;