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 */
144 __u32 clone_blksize; /* granularity of a CLONE operation */
148 struct nfs_fattr *fattr; /* Post-op attributes */
149 __u64 tbytes; /* total size in bytes */
150 __u64 fbytes; /* # of free bytes */
151 __u64 abytes; /* # of bytes available to user */
152 __u64 tfiles; /* # of files */
153 __u64 ffiles; /* # of free files */
154 __u64 afiles; /* # of files available to user */
158 __u32 tsize; /* Server transfer size */
159 __u32 bsize; /* Filesystem block size */
160 __u32 blocks; /* No. of "bsize" blocks on filesystem */
161 __u32 bfree; /* No. of free "bsize" blocks */
162 __u32 bavail; /* No. of available "bsize" blocks */
165 struct nfs_pathconf {
166 struct nfs_fattr *fattr; /* Post-op attributes */
167 __u32 max_link; /* max # of hard links */
168 __u32 max_namelen; /* max name length */
171 struct nfs4_change_info {
179 /* nfs41 sessions channel attributes */
180 struct nfs4_channel_attrs {
183 u32 max_resp_sz_cached;
189 struct nfs4_sequence_args {
190 struct nfs4_slot *sa_slot;
191 u8 sa_cache_this : 1,
195 struct nfs4_sequence_res {
196 struct nfs4_slot *sr_slot; /* slot used to send request */
197 unsigned long sr_timestamp;
198 int sr_status; /* sequence operation status */
200 u32 sr_highest_slotid;
201 u32 sr_target_highest_slotid;
204 struct nfs4_get_lease_time_args {
205 struct nfs4_sequence_args la_seq_args;
208 struct nfs4_get_lease_time_res {
209 struct nfs4_sequence_res lr_seq_res;
210 struct nfs_fsinfo *lr_fsinfo;
213 #define PNFS_LAYOUT_MAXSIZE 4096
215 struct nfs4_layoutdriver_data {
221 struct pnfs_layout_range {
227 struct nfs4_layoutget_args {
228 struct nfs4_sequence_args seq_args;
230 struct pnfs_layout_range range;
234 struct nfs_open_context *ctx;
235 nfs4_stateid stateid;
236 unsigned long timestamp;
237 struct nfs4_layoutdriver_data layout;
240 struct nfs4_layoutget_res {
241 struct nfs4_sequence_res seq_res;
242 __u32 return_on_close;
243 struct pnfs_layout_range range;
245 nfs4_stateid stateid;
246 struct nfs4_layoutdriver_data *layoutp;
249 struct nfs4_layoutget {
250 struct nfs4_layoutget_args args;
251 struct nfs4_layoutget_res res;
252 struct rpc_cred *cred;
256 struct nfs4_getdeviceinfo_args {
257 struct nfs4_sequence_args seq_args;
258 struct pnfs_device *pdev;
262 struct nfs4_getdeviceinfo_res {
263 struct nfs4_sequence_res seq_res;
264 struct pnfs_device *pdev;
268 struct nfs4_layoutcommit_args {
269 struct nfs4_sequence_args seq_args;
270 nfs4_stateid stateid;
271 __u64 lastbytewritten;
274 size_t layoutupdate_len;
275 struct page *layoutupdate_page;
276 struct page **layoutupdate_pages;
279 struct nfs4_layoutcommit_res {
280 struct nfs4_sequence_res seq_res;
281 struct nfs_fattr *fattr;
282 const struct nfs_server *server;
286 struct nfs4_layoutcommit_data {
287 struct rpc_task task;
288 struct nfs_fattr fattr;
289 struct list_head lseg_list;
290 struct rpc_cred *cred;
292 struct nfs4_layoutcommit_args args;
293 struct nfs4_layoutcommit_res res;
296 struct nfs4_layoutreturn_args {
297 struct nfs4_sequence_args seq_args;
298 struct pnfs_layout_hdr *layout;
300 struct pnfs_layout_range range;
301 nfs4_stateid stateid;
305 struct nfs4_layoutreturn_res {
306 struct nfs4_sequence_res seq_res;
308 nfs4_stateid stateid;
311 struct nfs4_layoutreturn {
312 struct nfs4_layoutreturn_args args;
313 struct nfs4_layoutreturn_res res;
314 struct rpc_cred *cred;
315 struct nfs_client *clp;
320 #define PNFS_LAYOUTSTATS_MAXSIZE 256
322 struct nfs42_layoutstat_args;
323 struct nfs42_layoutstat_devinfo;
324 typedef void (*layoutstats_encode_t)(struct xdr_stream *,
325 struct nfs42_layoutstat_args *,
326 struct nfs42_layoutstat_devinfo *);
328 /* Per file per deviceid layoutstats */
329 struct nfs42_layoutstat_devinfo {
330 struct nfs4_deviceid dev_id;
338 layoutstats_encode_t layoutstats_encode;
339 void *layout_private;
342 struct nfs42_layoutstat_args {
343 struct nfs4_sequence_args seq_args;
346 nfs4_stateid stateid;
348 struct nfs42_layoutstat_devinfo *devinfo;
351 struct nfs42_layoutstat_res {
352 struct nfs4_sequence_res seq_res;
357 struct nfs42_layoutstat_data {
359 struct nfs42_layoutstat_args args;
360 struct nfs42_layoutstat_res res;
363 struct nfs42_clone_args {
364 struct nfs4_sequence_args seq_args;
365 struct nfs_fh *src_fh;
366 struct nfs_fh *dst_fh;
367 nfs4_stateid src_stateid;
368 nfs4_stateid dst_stateid;
372 const u32 *dst_bitmask;
375 struct nfs42_clone_res {
376 struct nfs4_sequence_res seq_res;
377 unsigned int rpc_status;
378 struct nfs_fattr *dst_fattr;
379 const struct nfs_server *server;
382 struct stateowner_id {
388 * Arguments to the open call.
390 struct nfs_openargs {
391 struct nfs4_sequence_args seq_args;
392 const struct nfs_fh * fh;
393 struct nfs_seqid * seqid;
399 struct stateowner_id id;
402 struct iattr * attrs; /* UNCHECKED, GUARDED, EXCLUSIVE4_1 */
403 nfs4_verifier verifier; /* EXCLUSIVE */
405 nfs4_stateid delegation; /* CLAIM_DELEGATE_CUR */
406 fmode_t delegation_type; /* CLAIM_PREVIOUS */
408 const struct qstr * name;
409 const struct nfs_server *server; /* Needed for ID mapping */
411 const u32 * open_bitmap;
412 enum open_claim_type4 claim;
413 enum createmode4 createmode;
414 const struct nfs4_label *label;
418 struct nfs4_sequence_res seq_res;
419 nfs4_stateid stateid;
421 struct nfs4_change_info cinfo;
423 struct nfs_fattr * f_attr;
424 struct nfs4_label *f_label;
425 struct nfs_seqid * seqid;
426 const struct nfs_server *server;
427 fmode_t delegation_type;
428 nfs4_stateid delegation;
429 unsigned long pagemod_limit;
431 __u32 attrset[NFS4_BITMAP_SIZE];
432 struct nfs4_string *owner;
433 struct nfs4_string *group_owner;
434 __u32 access_request;
435 __u32 access_supported;
440 * Arguments to the open_confirm call.
442 struct nfs_open_confirmargs {
443 struct nfs4_sequence_args seq_args;
444 const struct nfs_fh * fh;
445 nfs4_stateid * stateid;
446 struct nfs_seqid * seqid;
449 struct nfs_open_confirmres {
450 struct nfs4_sequence_res seq_res;
451 nfs4_stateid stateid;
452 struct nfs_seqid * seqid;
456 * Arguments to the close call.
458 struct nfs_closeargs {
459 struct nfs4_sequence_args seq_args;
461 nfs4_stateid stateid;
462 struct nfs_seqid * seqid;
468 struct nfs_closeres {
469 struct nfs4_sequence_res seq_res;
470 nfs4_stateid stateid;
471 struct nfs_fattr * fattr;
472 struct nfs_seqid * seqid;
473 const struct nfs_server *server;
476 * * Arguments to the lock,lockt, and locku call.
484 struct nfs_lock_args {
485 struct nfs4_sequence_args seq_args;
487 struct file_lock * fl;
488 struct nfs_seqid * lock_seqid;
489 nfs4_stateid lock_stateid;
490 struct nfs_seqid * open_seqid;
491 nfs4_stateid open_stateid;
492 struct nfs_lowner lock_owner;
493 unsigned char block : 1;
494 unsigned char reclaim : 1;
495 unsigned char new_lock : 1;
496 unsigned char new_lock_owner : 1;
499 struct nfs_lock_res {
500 struct nfs4_sequence_res seq_res;
501 nfs4_stateid stateid;
502 struct nfs_seqid * lock_seqid;
503 struct nfs_seqid * open_seqid;
506 struct nfs_locku_args {
507 struct nfs4_sequence_args seq_args;
509 struct file_lock * fl;
510 struct nfs_seqid * seqid;
511 nfs4_stateid stateid;
514 struct nfs_locku_res {
515 struct nfs4_sequence_res seq_res;
516 nfs4_stateid stateid;
517 struct nfs_seqid * seqid;
520 struct nfs_lockt_args {
521 struct nfs4_sequence_args seq_args;
523 struct file_lock * fl;
524 struct nfs_lowner lock_owner;
527 struct nfs_lockt_res {
528 struct nfs4_sequence_res seq_res;
529 struct file_lock * denied; /* LOCK, LOCKT failed */
532 struct nfs_release_lockowner_args {
533 struct nfs4_sequence_args seq_args;
534 struct nfs_lowner lock_owner;
537 struct nfs_release_lockowner_res {
538 struct nfs4_sequence_res seq_res;
541 struct nfs4_delegreturnargs {
542 struct nfs4_sequence_args seq_args;
543 const struct nfs_fh *fhandle;
544 const nfs4_stateid *stateid;
548 struct nfs4_delegreturnres {
549 struct nfs4_sequence_res seq_res;
550 struct nfs_fattr * fattr;
551 struct nfs_server *server;
555 * Arguments to the write call.
557 struct nfs_write_verifier {
561 struct nfs_writeverf {
562 struct nfs_write_verifier verifier;
563 enum nfs3_stable_how committed;
567 * Arguments shared by the read and write call.
569 struct nfs_pgio_args {
570 struct nfs4_sequence_args seq_args;
572 struct nfs_open_context *context;
573 struct nfs_lock_context *lock_context;
574 nfs4_stateid stateid;
578 struct page ** pages;
579 const u32 * bitmask; /* used by write */
580 enum nfs3_stable_how stable; /* used by write */
583 struct nfs_pgio_res {
584 struct nfs4_sequence_res seq_res;
585 struct nfs_fattr * fattr;
588 int eof; /* used by read */
589 struct nfs_writeverf * verf; /* used by write */
590 const struct nfs_server *server; /* used by write */
595 * Arguments to the commit call.
597 struct nfs_commitargs {
598 struct nfs4_sequence_args seq_args;
605 struct nfs_commitres {
606 struct nfs4_sequence_res seq_res;
608 struct nfs_fattr *fattr;
609 struct nfs_writeverf *verf;
610 const struct nfs_server *server;
614 * Common arguments to the unlink call
616 struct nfs_removeargs {
617 struct nfs4_sequence_args seq_args;
618 const struct nfs_fh *fh;
622 struct nfs_removeres {
623 struct nfs4_sequence_res seq_res;
624 struct nfs_server *server;
625 struct nfs_fattr *dir_attr;
626 struct nfs4_change_info cinfo;
630 * Common arguments to the rename call
632 struct nfs_renameargs {
633 struct nfs4_sequence_args seq_args;
634 const struct nfs_fh *old_dir;
635 const struct nfs_fh *new_dir;
636 const struct qstr *old_name;
637 const struct qstr *new_name;
640 struct nfs_renameres {
641 struct nfs4_sequence_res seq_res;
642 struct nfs_server *server;
643 struct nfs4_change_info old_cinfo;
644 struct nfs_fattr *old_fattr;
645 struct nfs4_change_info new_cinfo;
646 struct nfs_fattr *new_fattr;
649 /* parsed sec= options */
650 #define NFS_AUTH_INFO_MAX_FLAVORS 12 /* see fs/nfs/super.c */
651 struct nfs_auth_info {
652 unsigned int flavor_len;
653 rpc_authflavor_t flavors[NFS_AUTH_INFO_MAX_FLAVORS];
657 * Argument struct for decode_entry function
667 struct nfs_fattr * fattr;
668 struct nfs4_label *label;
669 unsigned char d_type;
670 struct nfs_server * server;
674 * The following types are for NFSv2 only.
676 struct nfs_sattrargs {
678 struct iattr * sattr;
681 struct nfs_diropargs {
687 struct nfs_createargs {
691 struct iattr * sattr;
694 struct nfs_setattrargs {
695 struct nfs4_sequence_args seq_args;
697 nfs4_stateid stateid;
699 const struct nfs_server * server; /* Needed for name mapping */
701 const struct nfs4_label *label;
704 struct nfs_setaclargs {
705 struct nfs4_sequence_args seq_args;
708 unsigned int acl_pgbase;
709 struct page ** acl_pages;
712 struct nfs_setaclres {
713 struct nfs4_sequence_res seq_res;
716 struct nfs_getaclargs {
717 struct nfs4_sequence_args seq_args;
720 unsigned int acl_pgbase;
721 struct page ** acl_pages;
724 /* getxattr ACL interface flags */
725 #define NFS4_ACL_TRUNC 0x0001 /* ACL was truncated */
726 struct nfs_getaclres {
727 struct nfs4_sequence_res seq_res;
729 size_t acl_data_offset;
731 struct page * acl_scratch;
734 struct nfs_setattrres {
735 struct nfs4_sequence_res seq_res;
736 struct nfs_fattr * fattr;
737 struct nfs4_label *label;
738 const struct nfs_server * server;
741 struct nfs_linkargs {
742 struct nfs_fh * fromfh;
743 struct nfs_fh * tofh;
748 struct nfs_symlinkargs {
749 struct nfs_fh * fromfh;
750 const char * fromname;
751 unsigned int fromlen;
752 struct page ** pages;
753 unsigned int pathlen;
754 struct iattr * sattr;
757 struct nfs_readdirargs {
761 struct page ** pages;
764 struct nfs3_getaclargs {
767 struct page ** pages;
770 struct nfs3_setaclargs {
771 struct inode * inode;
773 struct posix_acl * acl_access;
774 struct posix_acl * acl_default;
777 struct page ** pages;
782 struct nfs_fattr * fattr;
785 struct nfs_readlinkargs {
789 struct page ** pages;
792 struct nfs3_sattrargs {
794 struct iattr * sattr;
796 struct timespec guardtime;
799 struct nfs3_diropargs {
805 struct nfs3_accessargs {
810 struct nfs3_createargs {
814 struct iattr * sattr;
815 enum nfs3_createmode createmode;
819 struct nfs3_mkdirargs {
823 struct iattr * sattr;
826 struct nfs3_symlinkargs {
827 struct nfs_fh * fromfh;
828 const char * fromname;
829 unsigned int fromlen;
830 struct page ** pages;
831 unsigned int pathlen;
832 struct iattr * sattr;
835 struct nfs3_mknodargs {
839 enum nfs3_ftype type;
840 struct iattr * sattr;
844 struct nfs3_linkargs {
845 struct nfs_fh * fromfh;
846 struct nfs_fh * tofh;
851 struct nfs3_readdirargs {
857 struct page ** pages;
860 struct nfs3_diropres {
861 struct nfs_fattr * dir_attr;
863 struct nfs_fattr * fattr;
866 struct nfs3_accessres {
867 struct nfs_fattr * fattr;
871 struct nfs3_readlinkargs {
875 struct page ** pages;
878 struct nfs3_linkres {
879 struct nfs_fattr * dir_attr;
880 struct nfs_fattr * fattr;
883 struct nfs3_readdirres {
884 struct nfs_fattr * dir_attr;
889 struct nfs3_getaclres {
890 struct nfs_fattr * fattr;
892 unsigned int acl_access_count;
893 unsigned int acl_default_count;
894 struct posix_acl * acl_access;
895 struct posix_acl * acl_default;
898 #if IS_ENABLED(CONFIG_NFS_V4)
900 typedef u64 clientid4;
902 struct nfs4_accessargs {
903 struct nfs4_sequence_args seq_args;
904 const struct nfs_fh * fh;
909 struct nfs4_accessres {
910 struct nfs4_sequence_res seq_res;
911 const struct nfs_server * server;
912 struct nfs_fattr * fattr;
917 struct nfs4_create_arg {
918 struct nfs4_sequence_args seq_args;
922 struct page ** pages;
924 } symlink; /* NF4LNK */
928 } device; /* NF4BLK, NF4CHR */
930 const struct qstr * name;
931 const struct nfs_server * server;
932 const struct iattr * attrs;
933 const struct nfs_fh * dir_fh;
935 const struct nfs4_label *label;
938 struct nfs4_create_res {
939 struct nfs4_sequence_res seq_res;
940 const struct nfs_server * server;
942 struct nfs_fattr * fattr;
943 struct nfs4_label *label;
944 struct nfs4_change_info dir_cinfo;
947 struct nfs4_fsinfo_arg {
948 struct nfs4_sequence_args seq_args;
949 const struct nfs_fh * fh;
953 struct nfs4_fsinfo_res {
954 struct nfs4_sequence_res seq_res;
955 struct nfs_fsinfo *fsinfo;
958 struct nfs4_getattr_arg {
959 struct nfs4_sequence_args seq_args;
960 const struct nfs_fh * fh;
964 struct nfs4_getattr_res {
965 struct nfs4_sequence_res seq_res;
966 const struct nfs_server * server;
967 struct nfs_fattr * fattr;
968 struct nfs4_label *label;
971 struct nfs4_link_arg {
972 struct nfs4_sequence_args seq_args;
973 const struct nfs_fh * fh;
974 const struct nfs_fh * dir_fh;
975 const struct qstr * name;
979 struct nfs4_link_res {
980 struct nfs4_sequence_res seq_res;
981 const struct nfs_server * server;
982 struct nfs_fattr * fattr;
983 struct nfs4_label *label;
984 struct nfs4_change_info cinfo;
985 struct nfs_fattr * dir_attr;
989 struct nfs4_lookup_arg {
990 struct nfs4_sequence_args seq_args;
991 const struct nfs_fh * dir_fh;
992 const struct qstr * name;
996 struct nfs4_lookup_res {
997 struct nfs4_sequence_res seq_res;
998 const struct nfs_server * server;
999 struct nfs_fattr * fattr;
1001 struct nfs4_label *label;
1004 struct nfs4_lookup_root_arg {
1005 struct nfs4_sequence_args seq_args;
1006 const u32 * bitmask;
1009 struct nfs4_pathconf_arg {
1010 struct nfs4_sequence_args seq_args;
1011 const struct nfs_fh * fh;
1012 const u32 * bitmask;
1015 struct nfs4_pathconf_res {
1016 struct nfs4_sequence_res seq_res;
1017 struct nfs_pathconf *pathconf;
1020 struct nfs4_readdir_arg {
1021 struct nfs4_sequence_args seq_args;
1022 const struct nfs_fh * fh;
1024 nfs4_verifier verifier;
1026 struct page ** pages; /* zero-copy data */
1027 unsigned int pgbase; /* zero-copy data */
1028 const u32 * bitmask;
1032 struct nfs4_readdir_res {
1033 struct nfs4_sequence_res seq_res;
1034 nfs4_verifier verifier;
1035 unsigned int pgbase;
1038 struct nfs4_readlink {
1039 struct nfs4_sequence_args seq_args;
1040 const struct nfs_fh * fh;
1041 unsigned int pgbase;
1042 unsigned int pglen; /* zero-copy data */
1043 struct page ** pages; /* zero-copy data */
1046 struct nfs4_readlink_res {
1047 struct nfs4_sequence_res seq_res;
1050 struct nfs4_setclientid {
1051 const nfs4_verifier * sc_verifier;
1053 unsigned int sc_netid_len;
1054 char sc_netid[RPCBIND_MAXNETIDLEN + 1];
1055 unsigned int sc_uaddr_len;
1056 char sc_uaddr[RPCBIND_MAXUADDRLEN + 1];
1057 struct nfs_client *sc_clnt;
1058 struct rpc_cred *sc_cred;
1061 struct nfs4_setclientid_res {
1063 nfs4_verifier confirm;
1066 struct nfs4_statfs_arg {
1067 struct nfs4_sequence_args seq_args;
1068 const struct nfs_fh * fh;
1069 const u32 * bitmask;
1072 struct nfs4_statfs_res {
1073 struct nfs4_sequence_res seq_res;
1074 struct nfs_fsstat *fsstat;
1077 struct nfs4_server_caps_arg {
1078 struct nfs4_sequence_args seq_args;
1079 struct nfs_fh *fhandle;
1080 const u32 * bitmask;
1083 struct nfs4_server_caps_res {
1084 struct nfs4_sequence_res seq_res;
1085 u32 attr_bitmask[3];
1086 u32 exclcreat_bitmask[3];
1093 #define NFS4_PATHNAME_MAXCOMPONENTS 512
1094 struct nfs4_pathname {
1095 unsigned int ncomponents;
1096 struct nfs4_string components[NFS4_PATHNAME_MAXCOMPONENTS];
1099 #define NFS4_FS_LOCATION_MAXSERVERS 10
1100 struct nfs4_fs_location {
1101 unsigned int nservers;
1102 struct nfs4_string servers[NFS4_FS_LOCATION_MAXSERVERS];
1103 struct nfs4_pathname rootpath;
1106 #define NFS4_FS_LOCATIONS_MAXENTRIES 10
1107 struct nfs4_fs_locations {
1108 struct nfs_fattr fattr;
1109 const struct nfs_server *server;
1110 struct nfs4_pathname fs_path;
1112 struct nfs4_fs_location locations[NFS4_FS_LOCATIONS_MAXENTRIES];
1115 struct nfs4_fs_locations_arg {
1116 struct nfs4_sequence_args seq_args;
1117 const struct nfs_fh *dir_fh;
1118 const struct nfs_fh *fh;
1119 const struct qstr *name;
1123 unsigned char migration:1, renew:1;
1126 struct nfs4_fs_locations_res {
1127 struct nfs4_sequence_res seq_res;
1128 struct nfs4_fs_locations *fs_locations;
1129 unsigned char migration:1, renew:1;
1132 struct nfs4_secinfo4 {
1134 struct rpcsec_gss_info flavor_info;
1137 struct nfs4_secinfo_flavors {
1138 unsigned int num_flavors;
1139 struct nfs4_secinfo4 flavors[0];
1142 struct nfs4_secinfo_arg {
1143 struct nfs4_sequence_args seq_args;
1144 const struct nfs_fh *dir_fh;
1145 const struct qstr *name;
1148 struct nfs4_secinfo_res {
1149 struct nfs4_sequence_res seq_res;
1150 struct nfs4_secinfo_flavors *flavors;
1153 struct nfs4_fsid_present_arg {
1154 struct nfs4_sequence_args seq_args;
1155 const struct nfs_fh *fh;
1157 unsigned char renew:1;
1160 struct nfs4_fsid_present_res {
1161 struct nfs4_sequence_res seq_res;
1163 unsigned char renew:1;
1166 #endif /* CONFIG_NFS_V4 */
1173 #ifdef CONFIG_NFS_V4_1
1175 struct pnfs_commit_bucket {
1176 struct list_head written;
1177 struct list_head committing;
1178 struct pnfs_layout_segment *wlseg;
1179 struct pnfs_layout_segment *clseg;
1180 struct nfs_writeverf direct_verf;
1183 struct pnfs_ds_commit_info {
1187 struct pnfs_commit_bucket *buckets;
1190 #define NFS4_OP_MAP_NUM_LONGS \
1191 DIV_ROUND_UP(LAST_NFS4_OP, 8 * sizeof(unsigned long))
1192 #define NFS4_OP_MAP_NUM_WORDS \
1193 (NFS4_OP_MAP_NUM_LONGS * sizeof(unsigned long) / sizeof(u32))
1194 struct nfs4_op_map {
1196 unsigned long longs[NFS4_OP_MAP_NUM_LONGS];
1197 u32 words[NFS4_OP_MAP_NUM_WORDS];
1201 struct nfs41_state_protection {
1203 struct nfs4_op_map enforce;
1204 struct nfs4_op_map allow;
1207 struct nfs41_exchange_id_args {
1208 struct nfs_client *client;
1209 nfs4_verifier *verifier;
1211 struct nfs41_state_protection state_protect;
1214 struct nfs41_server_owner {
1216 uint32_t major_id_sz;
1217 char major_id[NFS4_OPAQUE_LIMIT];
1220 struct nfs41_server_scope {
1221 uint32_t server_scope_sz;
1222 char server_scope[NFS4_OPAQUE_LIMIT];
1225 struct nfs41_impl_id {
1226 char domain[NFS4_OPAQUE_LIMIT + 1];
1227 char name[NFS4_OPAQUE_LIMIT + 1];
1228 struct nfstime4 date;
1231 struct nfs41_bind_conn_to_session_args {
1232 struct nfs_client *client;
1233 struct nfs4_sessionid sessionid;
1235 bool use_conn_in_rdma_mode;
1238 struct nfs41_bind_conn_to_session_res {
1239 struct nfs4_sessionid sessionid;
1241 bool use_conn_in_rdma_mode;
1244 struct nfs41_exchange_id_res {
1248 struct nfs41_server_owner *server_owner;
1249 struct nfs41_server_scope *server_scope;
1250 struct nfs41_impl_id *impl_id;
1251 struct nfs41_state_protection state_protect;
1254 struct nfs41_create_session_args {
1255 struct nfs_client *client;
1259 uint32_t cb_program;
1260 struct nfs4_channel_attrs fc_attrs; /* Fore Channel */
1261 struct nfs4_channel_attrs bc_attrs; /* Back Channel */
1264 struct nfs41_create_session_res {
1265 struct nfs4_sessionid sessionid;
1268 struct nfs4_channel_attrs fc_attrs; /* Fore Channel */
1269 struct nfs4_channel_attrs bc_attrs; /* Back Channel */
1272 struct nfs41_reclaim_complete_args {
1273 struct nfs4_sequence_args seq_args;
1274 /* In the future extend to include curr_fh for use with migration */
1275 unsigned char one_fs:1;
1278 struct nfs41_reclaim_complete_res {
1279 struct nfs4_sequence_res seq_res;
1282 #define SECINFO_STYLE_CURRENT_FH 0
1283 #define SECINFO_STYLE_PARENT 1
1284 struct nfs41_secinfo_no_name_args {
1285 struct nfs4_sequence_args seq_args;
1289 struct nfs41_test_stateid_args {
1290 struct nfs4_sequence_args seq_args;
1291 nfs4_stateid *stateid;
1294 struct nfs41_test_stateid_res {
1295 struct nfs4_sequence_res seq_res;
1296 unsigned int status;
1299 struct nfs41_free_stateid_args {
1300 struct nfs4_sequence_args seq_args;
1301 nfs4_stateid stateid;
1304 struct nfs41_free_stateid_res {
1305 struct nfs4_sequence_res seq_res;
1306 unsigned int status;
1310 nfs_free_pnfs_ds_cinfo(struct pnfs_ds_commit_info *cinfo)
1312 kfree(cinfo->buckets);
1317 struct pnfs_ds_commit_info {
1321 nfs_free_pnfs_ds_cinfo(struct pnfs_ds_commit_info *cinfo)
1325 #endif /* CONFIG_NFS_V4_1 */
1327 #ifdef CONFIG_NFS_V4_2
1328 struct nfs42_falloc_args {
1329 struct nfs4_sequence_args seq_args;
1331 struct nfs_fh *falloc_fh;
1332 nfs4_stateid falloc_stateid;
1335 const u32 *falloc_bitmask;
1338 struct nfs42_falloc_res {
1339 struct nfs4_sequence_res seq_res;
1340 unsigned int status;
1342 struct nfs_fattr *falloc_fattr;
1343 const struct nfs_server *falloc_server;
1346 struct nfs42_seek_args {
1347 struct nfs4_sequence_args seq_args;
1349 struct nfs_fh *sa_fh;
1350 nfs4_stateid sa_stateid;
1355 struct nfs42_seek_res {
1356 struct nfs4_sequence_res seq_res;
1357 unsigned int status;
1366 #define NFS_PAGEVEC_SIZE (8U)
1368 struct nfs_page_array {
1369 struct page **pagevec;
1370 unsigned int npages; /* Max length of pagevec */
1371 struct page *page_array[NFS_PAGEVEC_SIZE];
1374 /* used as flag bits in nfs_pgio_header */
1376 NFS_IOHDR_ERROR = 0,
1381 struct nfs_pgio_header {
1382 struct inode *inode;
1383 struct rpc_cred *cred;
1384 struct list_head pages;
1385 struct nfs_page *req;
1386 struct nfs_writeverf verf; /* Used for writes */
1387 struct pnfs_layout_segment *lseg;
1389 const struct rpc_call_ops *mds_ops;
1390 void (*release) (struct nfs_pgio_header *hdr);
1391 const struct nfs_pgio_completion_ops *completion_ops;
1392 const struct nfs_rw_ops *rw_ops;
1393 struct nfs_direct_req *dreq;
1394 void *layout_private;
1396 /* fields protected by lock */
1398 int error; /* merge with pnfs_error */
1399 unsigned long good_bytes; /* boundary of good data */
1400 unsigned long flags;
1405 struct rpc_task task;
1406 struct nfs_fattr fattr;
1407 struct nfs_pgio_args args; /* argument struct */
1408 struct nfs_pgio_res res; /* result struct */
1409 unsigned long timestamp; /* For lease renewal */
1410 int (*pgio_done_cb)(struct rpc_task *, struct nfs_pgio_header *);
1411 __u64 mds_offset; /* Filelayout dense stripe */
1412 struct nfs_page_array page_array;
1413 struct nfs_client *ds_clp; /* pNFS data server */
1414 int ds_commit_idx; /* ds index if ds_clp is set */
1415 int pgio_mirror_idx;/* mirror index in pgio layer */
1418 struct nfs_mds_commit_info {
1420 unsigned long ncommit;
1421 struct list_head list;
1424 struct nfs_commit_data;
1426 struct nfs_commit_completion_ops {
1427 void (*error_cleanup) (struct nfs_inode *nfsi);
1428 void (*completion) (struct nfs_commit_data *data);
1431 struct nfs_commit_info {
1432 spinlock_t *lock; /* inode->i_lock */
1433 struct nfs_mds_commit_info *mds;
1434 struct pnfs_ds_commit_info *ds;
1435 struct nfs_direct_req *dreq; /* O_DIRECT request */
1436 const struct nfs_commit_completion_ops *completion_ops;
1439 struct nfs_commit_data {
1440 struct rpc_task task;
1441 struct inode *inode;
1442 struct rpc_cred *cred;
1443 struct nfs_fattr fattr;
1444 struct nfs_writeverf verf;
1445 struct list_head pages; /* Coalesced requests we wish to flush */
1446 struct list_head list; /* lists of struct nfs_write_data */
1447 struct nfs_direct_req *dreq; /* O_DIRECT request */
1448 struct nfs_commitargs args; /* argument struct */
1449 struct nfs_commitres res; /* result struct */
1450 struct nfs_open_context *context;
1451 struct pnfs_layout_segment *lseg;
1452 struct nfs_client *ds_clp; /* pNFS data server */
1453 int ds_commit_index;
1455 const struct rpc_call_ops *mds_ops;
1456 const struct nfs_commit_completion_ops *completion_ops;
1457 int (*commit_done_cb) (struct rpc_task *task, struct nfs_commit_data *data);
1460 struct nfs_pgio_completion_ops {
1461 void (*error_cleanup)(struct list_head *head);
1462 void (*init_hdr)(struct nfs_pgio_header *hdr);
1463 void (*completion)(struct nfs_pgio_header *hdr);
1466 struct nfs_unlinkdata {
1467 struct hlist_node list;
1468 struct nfs_removeargs args;
1469 struct nfs_removeres res;
1471 struct rpc_cred *cred;
1472 struct nfs_fattr dir_attr;
1476 struct nfs_renamedata {
1477 struct nfs_renameargs args;
1478 struct nfs_renameres res;
1479 struct rpc_cred *cred;
1480 struct inode *old_dir;
1481 struct dentry *old_dentry;
1482 struct nfs_fattr old_fattr;
1483 struct inode *new_dir;
1484 struct dentry *new_dentry;
1485 struct nfs_fattr new_fattr;
1486 void (*complete)(struct rpc_task *, struct nfs_renamedata *);
1490 struct nfs_access_entry;
1493 struct nfs_subversion;
1494 struct nfs_mount_info;
1495 struct nfs_client_initdata;
1496 struct nfs_pageio_descriptor;
1499 * RPC procedure vector for NFSv2/NFSv3 demuxing
1501 struct nfs_rpc_ops {
1502 u32 version; /* Protocol version */
1503 const struct dentry_operations *dentry_ops;
1504 const struct inode_operations *dir_inode_ops;
1505 const struct inode_operations *file_inode_ops;
1506 const struct file_operations *file_ops;
1508 int (*getroot) (struct nfs_server *, struct nfs_fh *,
1509 struct nfs_fsinfo *);
1510 struct vfsmount *(*submount) (struct nfs_server *, struct dentry *,
1511 struct nfs_fh *, struct nfs_fattr *);
1512 struct dentry *(*try_mount) (int, const char *, struct nfs_mount_info *,
1513 struct nfs_subversion *);
1514 int (*getattr) (struct nfs_server *, struct nfs_fh *,
1515 struct nfs_fattr *, struct nfs4_label *);
1516 int (*setattr) (struct dentry *, struct nfs_fattr *,
1518 int (*lookup) (struct inode *, struct qstr *,
1519 struct nfs_fh *, struct nfs_fattr *,
1520 struct nfs4_label *);
1521 int (*access) (struct inode *, struct nfs_access_entry *);
1522 int (*readlink)(struct inode *, struct page *, unsigned int,
1524 int (*create) (struct inode *, struct dentry *,
1525 struct iattr *, int);
1526 int (*remove) (struct inode *, struct qstr *);
1527 void (*unlink_setup) (struct rpc_message *, struct inode *dir);
1528 void (*unlink_rpc_prepare) (struct rpc_task *, struct nfs_unlinkdata *);
1529 int (*unlink_done) (struct rpc_task *, struct inode *);
1530 void (*rename_setup) (struct rpc_message *msg, struct inode *dir);
1531 void (*rename_rpc_prepare)(struct rpc_task *task, struct nfs_renamedata *);
1532 int (*rename_done) (struct rpc_task *task, struct inode *old_dir, struct inode *new_dir);
1533 int (*link) (struct inode *, struct inode *, struct qstr *);
1534 int (*symlink) (struct inode *, struct dentry *, struct page *,
1535 unsigned int, struct iattr *);
1536 int (*mkdir) (struct inode *, struct dentry *, struct iattr *);
1537 int (*rmdir) (struct inode *, struct qstr *);
1538 int (*readdir) (struct dentry *, struct rpc_cred *,
1539 u64, struct page **, unsigned int, int);
1540 int (*mknod) (struct inode *, struct dentry *, struct iattr *,
1542 int (*statfs) (struct nfs_server *, struct nfs_fh *,
1543 struct nfs_fsstat *);
1544 int (*fsinfo) (struct nfs_server *, struct nfs_fh *,
1545 struct nfs_fsinfo *);
1546 int (*pathconf) (struct nfs_server *, struct nfs_fh *,
1547 struct nfs_pathconf *);
1548 int (*set_capabilities)(struct nfs_server *, struct nfs_fh *);
1549 int (*decode_dirent)(struct xdr_stream *, struct nfs_entry *, int);
1550 int (*pgio_rpc_prepare)(struct rpc_task *,
1551 struct nfs_pgio_header *);
1552 void (*read_setup)(struct nfs_pgio_header *, struct rpc_message *);
1553 int (*read_done)(struct rpc_task *, struct nfs_pgio_header *);
1554 void (*write_setup)(struct nfs_pgio_header *, struct rpc_message *);
1555 int (*write_done)(struct rpc_task *, struct nfs_pgio_header *);
1556 void (*commit_setup) (struct nfs_commit_data *, struct rpc_message *);
1557 void (*commit_rpc_prepare)(struct rpc_task *, struct nfs_commit_data *);
1558 int (*commit_done) (struct rpc_task *, struct nfs_commit_data *);
1559 int (*lock)(struct file *, int, struct file_lock *);
1560 int (*lock_check_bounds)(const struct file_lock *);
1561 void (*clear_acl_cache)(struct inode *);
1562 void (*close_context)(struct nfs_open_context *ctx, int);
1563 struct inode * (*open_context) (struct inode *dir,
1564 struct nfs_open_context *ctx,
1566 struct iattr *iattr,
1568 int (*have_delegation)(struct inode *, fmode_t);
1569 int (*return_delegation)(struct inode *);
1570 struct nfs_client *(*alloc_client) (const struct nfs_client_initdata *);
1572 (*init_client) (struct nfs_client *, const struct rpc_timeout *,
1574 void (*free_client) (struct nfs_client *);
1575 struct nfs_server *(*create_server)(struct nfs_mount_info *, struct nfs_subversion *);
1576 struct nfs_server *(*clone_server)(struct nfs_server *, struct nfs_fh *,
1577 struct nfs_fattr *, rpc_authflavor_t);
1581 * NFS_CALL(getattr, inode, (fattr));
1583 * NFS_PROTO(inode)->getattr(fattr);
1585 #define NFS_CALL(op, inode, args) NFS_PROTO(inode)->op args
1588 * Function vectors etc. for the NFS client
1590 extern const struct nfs_rpc_ops nfs_v2_clientops;
1591 extern const struct nfs_rpc_ops nfs_v3_clientops;
1592 extern const struct nfs_rpc_ops nfs_v4_clientops;
1593 extern const struct rpc_version nfs_version2;
1594 extern const struct rpc_version nfs_version3;
1595 extern const struct rpc_version nfs_version4;
1597 extern const struct rpc_version nfsacl_version3;
1598 extern const struct rpc_program nfsacl_program;