1 #ifndef _LINUX_NFS_XDR_H
2 #define _LINUX_NFS_XDR_H
4 #include <linux/nfsacl.h>
7 * To change the maximum rsize and wsize supported by the NFS client, adjust
8 * NFS_MAX_FILE_IO_SIZE. 64KB is a typical maximum, but some servers can
9 * support a megabyte or more. The default is left at 4096 bytes, which is
10 * reasonable for NFS over UDP.
12 #define NFS_MAX_FILE_IO_SIZE (1048576U)
13 #define NFS_DEF_FILE_IO_SIZE (4096U)
14 #define NFS_MIN_FILE_IO_SIZE (1024U)
22 * Helper for checking equality between 2 fsids.
24 static inline int nfs_fsid_equal(const struct nfs_fsid *a, const struct nfs_fsid *b)
26 return a->major == b->major && a->minor == b->minor;
30 unsigned int valid; /* which fields are valid */
48 struct timespec atime;
49 struct timespec mtime;
50 struct timespec ctime;
51 __u64 change_attr; /* NFSv4 change attribute */
52 __u64 pre_change_attr;/* pre-op NFSv4 change attribute */
53 __u64 pre_size; /* pre_op_attr.size */
54 struct timespec pre_mtime; /* pre_op_attr.mtime */
55 struct timespec pre_ctime; /* pre_op_attr.ctime */
56 unsigned long time_start;
57 unsigned long gencount;
60 #define NFS_ATTR_FATTR_TYPE (1U << 0)
61 #define NFS_ATTR_FATTR_MODE (1U << 1)
62 #define NFS_ATTR_FATTR_NLINK (1U << 2)
63 #define NFS_ATTR_FATTR_OWNER (1U << 3)
64 #define NFS_ATTR_FATTR_GROUP (1U << 4)
65 #define NFS_ATTR_FATTR_RDEV (1U << 5)
66 #define NFS_ATTR_FATTR_SIZE (1U << 6)
67 #define NFS_ATTR_FATTR_PRESIZE (1U << 7)
68 #define NFS_ATTR_FATTR_BLOCKS_USED (1U << 8)
69 #define NFS_ATTR_FATTR_SPACE_USED (1U << 9)
70 #define NFS_ATTR_FATTR_FSID (1U << 10)
71 #define NFS_ATTR_FATTR_FILEID (1U << 11)
72 #define NFS_ATTR_FATTR_ATIME (1U << 12)
73 #define NFS_ATTR_FATTR_MTIME (1U << 13)
74 #define NFS_ATTR_FATTR_CTIME (1U << 14)
75 #define NFS_ATTR_FATTR_PREMTIME (1U << 15)
76 #define NFS_ATTR_FATTR_PRECTIME (1U << 16)
77 #define NFS_ATTR_FATTR_CHANGE (1U << 17)
78 #define NFS_ATTR_FATTR_PRECHANGE (1U << 18)
79 #define NFS_ATTR_FATTR_V4_REFERRAL (1U << 19) /* NFSv4 referral */
81 #define NFS_ATTR_FATTR (NFS_ATTR_FATTR_TYPE \
82 | NFS_ATTR_FATTR_MODE \
83 | NFS_ATTR_FATTR_NLINK \
84 | NFS_ATTR_FATTR_OWNER \
85 | NFS_ATTR_FATTR_GROUP \
86 | NFS_ATTR_FATTR_RDEV \
87 | NFS_ATTR_FATTR_SIZE \
88 | NFS_ATTR_FATTR_FSID \
89 | NFS_ATTR_FATTR_FILEID \
90 | NFS_ATTR_FATTR_ATIME \
91 | NFS_ATTR_FATTR_MTIME \
92 | NFS_ATTR_FATTR_CTIME)
93 #define NFS_ATTR_FATTR_V2 (NFS_ATTR_FATTR \
94 | NFS_ATTR_FATTR_BLOCKS_USED)
95 #define NFS_ATTR_FATTR_V3 (NFS_ATTR_FATTR \
96 | NFS_ATTR_FATTR_SPACE_USED)
97 #define NFS_ATTR_FATTR_V4 (NFS_ATTR_FATTR \
98 | NFS_ATTR_FATTR_SPACE_USED \
99 | NFS_ATTR_FATTR_CHANGE)
102 * Info on the file system
105 struct nfs_fattr *fattr; /* Post-op attributes */
106 __u32 rtmax; /* max. read transfer size */
107 __u32 rtpref; /* pref. read transfer size */
108 __u32 rtmult; /* reads should be multiple of this */
109 __u32 wtmax; /* max. write transfer size */
110 __u32 wtpref; /* pref. write transfer size */
111 __u32 wtmult; /* writes should be multiple of this */
112 __u32 dtpref; /* pref. readdir transfer size */
114 __u32 lease_time; /* in seconds */
118 struct nfs_fattr *fattr; /* Post-op attributes */
119 __u64 tbytes; /* total size in bytes */
120 __u64 fbytes; /* # of free bytes */
121 __u64 abytes; /* # of bytes available to user */
122 __u64 tfiles; /* # of files */
123 __u64 ffiles; /* # of free files */
124 __u64 afiles; /* # of files available to user */
128 __u32 tsize; /* Server transfer size */
129 __u32 bsize; /* Filesystem block size */
130 __u32 blocks; /* No. of "bsize" blocks on filesystem */
131 __u32 bfree; /* No. of free "bsize" blocks */
132 __u32 bavail; /* No. of available "bsize" blocks */
135 struct nfs_pathconf {
136 struct nfs_fattr *fattr; /* Post-op attributes */
137 __u32 max_link; /* max # of hard links */
138 __u32 max_namelen; /* max name length */
141 struct nfs4_change_info {
149 /* nfs41 sessions channel attributes */
150 struct nfs4_channel_attrs {
154 u32 max_resp_sz_cached;
159 /* nfs41 sessions slot seqid */
164 struct nfs4_sequence_args {
168 struct nfs4_sequence_res {
173 * Arguments to the open call.
175 struct nfs_openargs {
176 const struct nfs_fh * fh;
177 struct nfs_seqid * seqid;
183 struct iattr * attrs; /* UNCHECKED, GUARDED */
184 nfs4_verifier verifier; /* EXCLUSIVE */
185 nfs4_stateid delegation; /* CLAIM_DELEGATE_CUR */
186 fmode_t delegation_type; /* CLAIM_PREVIOUS */
188 const struct qstr * name;
189 const struct nfs_server *server; /* Needed for ID mapping */
192 struct nfs4_sequence_args seq_args;
196 nfs4_stateid stateid;
198 struct nfs4_change_info cinfo;
200 struct nfs_fattr * f_attr;
201 struct nfs_fattr * dir_attr;
202 struct nfs_seqid * seqid;
203 const struct nfs_server *server;
204 fmode_t delegation_type;
205 nfs4_stateid delegation;
208 __u32 attrset[NFS4_BITMAP_SIZE];
209 struct nfs4_sequence_res seq_res;
213 * Arguments to the open_confirm call.
215 struct nfs_open_confirmargs {
216 const struct nfs_fh * fh;
217 nfs4_stateid * stateid;
218 struct nfs_seqid * seqid;
221 struct nfs_open_confirmres {
222 nfs4_stateid stateid;
223 struct nfs_seqid * seqid;
227 * Arguments to the close call.
229 struct nfs_closeargs {
231 nfs4_stateid * stateid;
232 struct nfs_seqid * seqid;
235 struct nfs4_sequence_args seq_args;
238 struct nfs_closeres {
239 nfs4_stateid stateid;
240 struct nfs_fattr * fattr;
241 struct nfs_seqid * seqid;
242 const struct nfs_server *server;
243 struct nfs4_sequence_res seq_res;
246 * * Arguments to the lock,lockt, and locku call.
253 struct nfs_lock_args {
255 struct file_lock * fl;
256 struct nfs_seqid * lock_seqid;
257 nfs4_stateid * lock_stateid;
258 struct nfs_seqid * open_seqid;
259 nfs4_stateid * open_stateid;
260 struct nfs_lowner lock_owner;
261 unsigned char block : 1;
262 unsigned char reclaim : 1;
263 unsigned char new_lock_owner : 1;
264 struct nfs4_sequence_args seq_args;
267 struct nfs_lock_res {
268 nfs4_stateid stateid;
269 struct nfs_seqid * lock_seqid;
270 struct nfs_seqid * open_seqid;
271 struct nfs4_sequence_res seq_res;
274 struct nfs_locku_args {
276 struct file_lock * fl;
277 struct nfs_seqid * seqid;
278 nfs4_stateid * stateid;
279 struct nfs4_sequence_args seq_args;
282 struct nfs_locku_res {
283 nfs4_stateid stateid;
284 struct nfs_seqid * seqid;
285 struct nfs4_sequence_res seq_res;
288 struct nfs_lockt_args {
290 struct file_lock * fl;
291 struct nfs_lowner lock_owner;
292 struct nfs4_sequence_args seq_args;
295 struct nfs_lockt_res {
296 struct file_lock * denied; /* LOCK, LOCKT failed */
297 struct nfs4_sequence_res seq_res;
300 struct nfs4_delegreturnargs {
301 const struct nfs_fh *fhandle;
302 const nfs4_stateid *stateid;
304 struct nfs4_sequence_args seq_args;
307 struct nfs4_delegreturnres {
308 struct nfs_fattr * fattr;
309 const struct nfs_server *server;
310 struct nfs4_sequence_res seq_res;
314 * Arguments to the read call.
316 struct nfs_readargs {
318 struct nfs_open_context *context;
322 struct page ** pages;
323 struct nfs4_sequence_args seq_args;
327 struct nfs_fattr * fattr;
330 struct nfs4_sequence_res seq_res;
334 * Arguments to the write call.
336 struct nfs_writeargs {
338 struct nfs_open_context *context;
341 enum nfs3_stable_how stable;
343 struct page ** pages;
345 struct nfs4_sequence_args seq_args;
348 struct nfs_writeverf {
349 enum nfs3_stable_how committed;
353 struct nfs_writeres {
354 struct nfs_fattr * fattr;
355 struct nfs_writeverf * verf;
357 const struct nfs_server *server;
358 struct nfs4_sequence_res seq_res;
362 * Common arguments to the unlink call
364 struct nfs_removeargs {
365 const struct nfs_fh *fh;
368 struct nfs4_sequence_args seq_args;
371 struct nfs_removeres {
372 const struct nfs_server *server;
373 struct nfs4_change_info cinfo;
374 struct nfs_fattr dir_attr;
375 struct nfs4_sequence_res seq_res;
379 * Argument struct for decode_entry function
389 struct nfs_fattr * fattr;
393 * The following types are for NFSv2 only.
395 struct nfs_sattrargs {
397 struct iattr * sattr;
400 struct nfs_diropargs {
406 struct nfs_createargs {
410 struct iattr * sattr;
413 struct nfs_renameargs {
414 struct nfs_fh * fromfh;
415 const char * fromname;
416 unsigned int fromlen;
417 struct nfs_fh * tofh;
422 struct nfs_setattrargs {
424 nfs4_stateid stateid;
426 const struct nfs_server * server; /* Needed for name mapping */
428 struct nfs4_sequence_args seq_args;
431 struct nfs_setaclargs {
434 unsigned int acl_pgbase;
435 struct page ** acl_pages;
436 struct nfs4_sequence_args seq_args;
439 struct nfs_getaclargs {
442 unsigned int acl_pgbase;
443 struct page ** acl_pages;
444 struct nfs4_sequence_args seq_args;
447 struct nfs_setattrres {
448 struct nfs_fattr * fattr;
449 const struct nfs_server * server;
450 struct nfs4_sequence_res seq_res;
453 struct nfs_linkargs {
454 struct nfs_fh * fromfh;
455 struct nfs_fh * tofh;
460 struct nfs_symlinkargs {
461 struct nfs_fh * fromfh;
462 const char * fromname;
463 unsigned int fromlen;
464 struct page ** pages;
465 unsigned int pathlen;
466 struct iattr * sattr;
469 struct nfs_readdirargs {
473 struct page ** pages;
476 struct nfs3_getaclargs {
479 struct page ** pages;
482 struct nfs3_setaclargs {
483 struct inode * inode;
485 struct posix_acl * acl_access;
486 struct posix_acl * acl_default;
489 struct page ** pages;
494 struct nfs_fattr * fattr;
497 struct nfs_readlinkargs {
501 struct page ** pages;
504 struct nfs3_sattrargs {
506 struct iattr * sattr;
508 struct timespec guardtime;
511 struct nfs3_diropargs {
517 struct nfs3_accessargs {
522 struct nfs3_createargs {
526 struct iattr * sattr;
527 enum nfs3_createmode createmode;
531 struct nfs3_mkdirargs {
535 struct iattr * sattr;
538 struct nfs3_symlinkargs {
539 struct nfs_fh * fromfh;
540 const char * fromname;
541 unsigned int fromlen;
542 struct page ** pages;
543 unsigned int pathlen;
544 struct iattr * sattr;
547 struct nfs3_mknodargs {
551 enum nfs3_ftype type;
552 struct iattr * sattr;
556 struct nfs3_renameargs {
557 struct nfs_fh * fromfh;
558 const char * fromname;
559 unsigned int fromlen;
560 struct nfs_fh * tofh;
565 struct nfs3_linkargs {
566 struct nfs_fh * fromfh;
567 struct nfs_fh * tofh;
572 struct nfs3_readdirargs {
578 struct page ** pages;
581 struct nfs3_diropres {
582 struct nfs_fattr * dir_attr;
584 struct nfs_fattr * fattr;
587 struct nfs3_accessres {
588 struct nfs_fattr * fattr;
592 struct nfs3_readlinkargs {
596 struct page ** pages;
599 struct nfs3_renameres {
600 struct nfs_fattr * fromattr;
601 struct nfs_fattr * toattr;
604 struct nfs3_linkres {
605 struct nfs_fattr * dir_attr;
606 struct nfs_fattr * fattr;
609 struct nfs3_readdirres {
610 struct nfs_fattr * dir_attr;
615 struct nfs3_getaclres {
616 struct nfs_fattr * fattr;
618 unsigned int acl_access_count;
619 unsigned int acl_default_count;
620 struct posix_acl * acl_access;
621 struct posix_acl * acl_default;
626 typedef u64 clientid4;
628 struct nfs4_accessargs {
629 const struct nfs_fh * fh;
632 struct nfs4_sequence_args seq_args;
635 struct nfs4_accessres {
636 const struct nfs_server * server;
637 struct nfs_fattr * fattr;
640 struct nfs4_sequence_res seq_res;
643 struct nfs4_create_arg {
647 struct page ** pages;
649 } symlink; /* NF4LNK */
653 } device; /* NF4BLK, NF4CHR */
655 const struct qstr * name;
656 const struct nfs_server * server;
657 const struct iattr * attrs;
658 const struct nfs_fh * dir_fh;
660 struct nfs4_sequence_args seq_args;
663 struct nfs4_create_res {
664 const struct nfs_server * server;
666 struct nfs_fattr * fattr;
667 struct nfs4_change_info dir_cinfo;
668 struct nfs_fattr * dir_fattr;
669 struct nfs4_sequence_res seq_res;
672 struct nfs4_fsinfo_arg {
673 const struct nfs_fh * fh;
675 struct nfs4_sequence_args seq_args;
678 struct nfs4_getattr_arg {
679 const struct nfs_fh * fh;
681 struct nfs4_sequence_args seq_args;
684 struct nfs4_getattr_res {
685 const struct nfs_server * server;
686 struct nfs_fattr * fattr;
687 struct nfs4_sequence_res seq_res;
690 struct nfs4_link_arg {
691 const struct nfs_fh * fh;
692 const struct nfs_fh * dir_fh;
693 const struct qstr * name;
695 struct nfs4_sequence_args seq_args;
698 struct nfs4_link_res {
699 const struct nfs_server * server;
700 struct nfs_fattr * fattr;
701 struct nfs4_change_info cinfo;
702 struct nfs_fattr * dir_attr;
703 struct nfs4_sequence_res seq_res;
707 struct nfs4_lookup_arg {
708 const struct nfs_fh * dir_fh;
709 const struct qstr * name;
711 struct nfs4_sequence_args seq_args;
714 struct nfs4_lookup_res {
715 const struct nfs_server * server;
716 struct nfs_fattr * fattr;
718 struct nfs4_sequence_res seq_res;
721 struct nfs4_lookup_root_arg {
723 struct nfs4_sequence_args seq_args;
726 struct nfs4_pathconf_arg {
727 const struct nfs_fh * fh;
729 struct nfs4_sequence_args seq_args;
732 struct nfs4_readdir_arg {
733 const struct nfs_fh * fh;
735 nfs4_verifier verifier;
737 struct page ** pages; /* zero-copy data */
738 unsigned int pgbase; /* zero-copy data */
740 struct nfs4_sequence_args seq_args;
743 struct nfs4_readdir_res {
744 nfs4_verifier verifier;
746 struct nfs4_sequence_res seq_res;
749 struct nfs4_readlink {
750 const struct nfs_fh * fh;
752 unsigned int pglen; /* zero-copy data */
753 struct page ** pages; /* zero-copy data */
754 struct nfs4_sequence_args seq_args;
757 struct nfs4_rename_arg {
758 const struct nfs_fh * old_dir;
759 const struct nfs_fh * new_dir;
760 const struct qstr * old_name;
761 const struct qstr * new_name;
763 struct nfs4_sequence_args seq_args;
766 struct nfs4_rename_res {
767 const struct nfs_server * server;
768 struct nfs4_change_info old_cinfo;
769 struct nfs_fattr * old_fattr;
770 struct nfs4_change_info new_cinfo;
771 struct nfs_fattr * new_fattr;
772 struct nfs4_sequence_res seq_res;
775 #define NFS4_SETCLIENTID_NAMELEN (127)
776 struct nfs4_setclientid {
777 const nfs4_verifier * sc_verifier;
778 unsigned int sc_name_len;
779 char sc_name[NFS4_SETCLIENTID_NAMELEN + 1];
781 unsigned int sc_netid_len;
782 char sc_netid[RPCBIND_MAXNETIDLEN + 1];
783 unsigned int sc_uaddr_len;
784 char sc_uaddr[RPCBIND_MAXUADDRLEN + 1];
788 struct nfs4_statfs_arg {
789 const struct nfs_fh * fh;
791 struct nfs4_sequence_args seq_args;
794 struct nfs4_server_caps_res {
799 struct nfs4_sequence_res seq_res;
807 #define NFS4_PATHNAME_MAXCOMPONENTS 512
808 struct nfs4_pathname {
809 unsigned int ncomponents;
810 struct nfs4_string components[NFS4_PATHNAME_MAXCOMPONENTS];
813 #define NFS4_FS_LOCATION_MAXSERVERS 10
814 struct nfs4_fs_location {
815 unsigned int nservers;
816 struct nfs4_string servers[NFS4_FS_LOCATION_MAXSERVERS];
817 struct nfs4_pathname rootpath;
820 #define NFS4_FS_LOCATIONS_MAXENTRIES 10
821 struct nfs4_fs_locations {
822 struct nfs_fattr fattr;
823 const struct nfs_server *server;
824 struct nfs4_pathname fs_path;
826 struct nfs4_fs_location locations[NFS4_FS_LOCATIONS_MAXENTRIES];
829 struct nfs4_fs_locations_arg {
830 const struct nfs_fh *dir_fh;
831 const struct qstr *name;
834 struct nfs4_sequence_args seq_args;
837 #endif /* CONFIG_NFS_V4 */
841 #define NFS_PAGEVEC_SIZE (8U)
843 struct nfs_read_data {
845 struct rpc_task task;
847 struct rpc_cred *cred;
848 struct nfs_fattr fattr; /* fattr storage */
849 struct list_head pages; /* Coalesced read requests */
850 struct nfs_page *req; /* multi ops per nfs_page */
851 struct page **pagevec;
852 unsigned int npages; /* Max length of pagevec */
853 struct nfs_readargs args;
854 struct nfs_readres res;
856 unsigned long timestamp; /* For lease renewal */
858 struct page *page_array[NFS_PAGEVEC_SIZE];
861 struct nfs_write_data {
863 struct rpc_task task;
865 struct rpc_cred *cred;
866 struct nfs_fattr fattr;
867 struct nfs_writeverf verf;
868 struct list_head pages; /* Coalesced requests we wish to flush */
869 struct nfs_page *req; /* multi ops per nfs_page */
870 struct page **pagevec;
871 unsigned int npages; /* Max length of pagevec */
872 struct nfs_writeargs args; /* argument struct */
873 struct nfs_writeres res; /* result struct */
875 unsigned long timestamp; /* For lease renewal */
877 struct page *page_array[NFS_PAGEVEC_SIZE];
880 struct nfs_access_entry;
883 * RPC procedure vector for NFSv2/NFSv3 demuxing
886 u32 version; /* Protocol version */
887 const struct dentry_operations *dentry_ops;
888 const struct inode_operations *dir_inode_ops;
889 const struct inode_operations *file_inode_ops;
891 int (*getroot) (struct nfs_server *, struct nfs_fh *,
892 struct nfs_fsinfo *);
893 int (*lookupfh)(struct nfs_server *, struct nfs_fh *,
894 struct qstr *, struct nfs_fh *,
896 int (*getattr) (struct nfs_server *, struct nfs_fh *,
898 int (*setattr) (struct dentry *, struct nfs_fattr *,
900 int (*lookup) (struct inode *, struct qstr *,
901 struct nfs_fh *, struct nfs_fattr *);
902 int (*access) (struct inode *, struct nfs_access_entry *);
903 int (*readlink)(struct inode *, struct page *, unsigned int,
905 int (*create) (struct inode *, struct dentry *,
906 struct iattr *, int, struct nameidata *);
907 int (*remove) (struct inode *, struct qstr *);
908 void (*unlink_setup) (struct rpc_message *, struct inode *dir);
909 int (*unlink_done) (struct rpc_task *, struct inode *);
910 int (*rename) (struct inode *, struct qstr *,
911 struct inode *, struct qstr *);
912 int (*link) (struct inode *, struct inode *, struct qstr *);
913 int (*symlink) (struct inode *, struct dentry *, struct page *,
914 unsigned int, struct iattr *);
915 int (*mkdir) (struct inode *, struct dentry *, struct iattr *);
916 int (*rmdir) (struct inode *, struct qstr *);
917 int (*readdir) (struct dentry *, struct rpc_cred *,
918 u64, struct page *, unsigned int, int);
919 int (*mknod) (struct inode *, struct dentry *, struct iattr *,
921 int (*statfs) (struct nfs_server *, struct nfs_fh *,
922 struct nfs_fsstat *);
923 int (*fsinfo) (struct nfs_server *, struct nfs_fh *,
924 struct nfs_fsinfo *);
925 int (*pathconf) (struct nfs_server *, struct nfs_fh *,
926 struct nfs_pathconf *);
927 int (*set_capabilities)(struct nfs_server *, struct nfs_fh *);
928 __be32 *(*decode_dirent)(__be32 *, struct nfs_entry *, int plus);
929 void (*read_setup) (struct nfs_read_data *, struct rpc_message *);
930 int (*read_done) (struct rpc_task *, struct nfs_read_data *);
931 void (*write_setup) (struct nfs_write_data *, struct rpc_message *);
932 int (*write_done) (struct rpc_task *, struct nfs_write_data *);
933 void (*commit_setup) (struct nfs_write_data *, struct rpc_message *);
934 int (*commit_done) (struct rpc_task *, struct nfs_write_data *);
935 int (*lock)(struct file *, int, struct file_lock *);
936 int (*lock_check_bounds)(const struct file_lock *);
937 void (*clear_acl_cache)(struct inode *);
938 void (*close_context)(struct nfs_open_context *ctx, int);
942 * NFS_CALL(getattr, inode, (fattr));
944 * NFS_PROTO(inode)->getattr(fattr);
946 #define NFS_CALL(op, inode, args) NFS_PROTO(inode)->op args
949 * Function vectors etc. for the NFS client
951 extern const struct nfs_rpc_ops nfs_v2_clientops;
952 extern const struct nfs_rpc_ops nfs_v3_clientops;
953 extern const struct nfs_rpc_ops nfs_v4_clientops;
954 extern struct rpc_version nfs_version2;
955 extern struct rpc_version nfs_version3;
956 extern struct rpc_version nfs_version4;
958 extern struct rpc_version nfsacl_version3;
959 extern struct rpc_program nfsacl_program;