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 */
31 enum nfs_ftype type; /* always use NFSv2 types */
49 struct timespec atime;
50 struct timespec mtime;
51 struct timespec ctime;
52 __u64 change_attr; /* NFSv4 change attribute */
53 __u64 pre_change_attr;/* pre-op NFSv4 change attribute */
54 __u64 pre_size; /* pre_op_attr.size */
55 struct timespec pre_mtime; /* pre_op_attr.mtime */
56 struct timespec pre_ctime; /* pre_op_attr.ctime */
57 unsigned long time_start;
58 unsigned long gencount;
61 #define NFS_ATTR_FATTR_TYPE (1U << 0)
62 #define NFS_ATTR_FATTR_MODE (1U << 1)
63 #define NFS_ATTR_FATTR_NLINK (1U << 2)
64 #define NFS_ATTR_FATTR_OWNER (1U << 3)
65 #define NFS_ATTR_FATTR_GROUP (1U << 4)
66 #define NFS_ATTR_FATTR_RDEV (1U << 5)
67 #define NFS_ATTR_FATTR_SIZE (1U << 6)
68 #define NFS_ATTR_FATTR_PRESIZE (1U << 7)
69 #define NFS_ATTR_FATTR_BLOCKS_USED (1U << 8)
70 #define NFS_ATTR_FATTR_SPACE_USED (1U << 9)
71 #define NFS_ATTR_FATTR_FSID (1U << 10)
72 #define NFS_ATTR_FATTR_FILEID (1U << 11)
73 #define NFS_ATTR_FATTR_ATIME (1U << 12)
74 #define NFS_ATTR_FATTR_MTIME (1U << 13)
75 #define NFS_ATTR_FATTR_CTIME (1U << 14)
76 #define NFS_ATTR_FATTR_PREMTIME (1U << 15)
77 #define NFS_ATTR_FATTR_PRECTIME (1U << 16)
78 #define NFS_ATTR_FATTR_CHANGE (1U << 17)
79 #define NFS_ATTR_FATTR_PRECHANGE (1U << 18)
80 #define NFS_ATTR_FATTR_V4_REFERRAL (1U << 19) /* NFSv4 referral */
82 #define NFS_ATTR_FATTR (NFS_ATTR_FATTR_TYPE \
83 | NFS_ATTR_FATTR_MODE \
84 | NFS_ATTR_FATTR_NLINK \
85 | NFS_ATTR_FATTR_OWNER \
86 | NFS_ATTR_FATTR_GROUP \
87 | NFS_ATTR_FATTR_RDEV \
88 | NFS_ATTR_FATTR_SIZE \
89 | NFS_ATTR_FATTR_FSID \
90 | NFS_ATTR_FATTR_FILEID \
91 | NFS_ATTR_FATTR_ATIME \
92 | NFS_ATTR_FATTR_MTIME \
93 | NFS_ATTR_FATTR_CTIME)
94 #define NFS_ATTR_FATTR_V2 (NFS_ATTR_FATTR \
95 | NFS_ATTR_FATTR_BLOCKS_USED)
96 #define NFS_ATTR_FATTR_V3 (NFS_ATTR_FATTR \
97 | NFS_ATTR_FATTR_SPACE_USED)
98 #define NFS_ATTR_FATTR_V4 (NFS_ATTR_FATTR \
99 | NFS_ATTR_FATTR_SPACE_USED \
100 | NFS_ATTR_FATTR_CHANGE)
103 * Info on the file system
106 struct nfs_fattr *fattr; /* Post-op attributes */
107 __u32 rtmax; /* max. read transfer size */
108 __u32 rtpref; /* pref. read transfer size */
109 __u32 rtmult; /* reads should be multiple of this */
110 __u32 wtmax; /* max. write transfer size */
111 __u32 wtpref; /* pref. write transfer size */
112 __u32 wtmult; /* writes should be multiple of this */
113 __u32 dtpref; /* pref. readdir transfer size */
115 __u32 lease_time; /* in seconds */
119 struct nfs_fattr *fattr; /* Post-op attributes */
120 __u64 tbytes; /* total size in bytes */
121 __u64 fbytes; /* # of free bytes */
122 __u64 abytes; /* # of bytes available to user */
123 __u64 tfiles; /* # of files */
124 __u64 ffiles; /* # of free files */
125 __u64 afiles; /* # of files available to user */
129 __u32 tsize; /* Server transfer size */
130 __u32 bsize; /* Filesystem block size */
131 __u32 blocks; /* No. of "bsize" blocks on filesystem */
132 __u32 bfree; /* No. of free "bsize" blocks */
133 __u32 bavail; /* No. of available "bsize" blocks */
136 struct nfs_pathconf {
137 struct nfs_fattr *fattr; /* Post-op attributes */
138 __u32 max_link; /* max # of hard links */
139 __u32 max_namelen; /* max name length */
142 struct nfs4_change_info {
150 * Arguments to the open call.
152 struct nfs_openargs {
153 const struct nfs_fh * fh;
154 struct nfs_seqid * seqid;
160 struct iattr * attrs; /* UNCHECKED, GUARDED */
161 nfs4_verifier verifier; /* EXCLUSIVE */
162 nfs4_stateid delegation; /* CLAIM_DELEGATE_CUR */
163 fmode_t delegation_type; /* CLAIM_PREVIOUS */
165 const struct qstr * name;
166 const struct nfs_server *server; /* Needed for ID mapping */
172 nfs4_stateid stateid;
174 struct nfs4_change_info cinfo;
176 struct nfs_fattr * f_attr;
177 struct nfs_fattr * dir_attr;
178 struct nfs_seqid * seqid;
179 const struct nfs_server *server;
180 fmode_t delegation_type;
181 nfs4_stateid delegation;
184 __u32 attrset[NFS4_BITMAP_SIZE];
188 * Arguments to the open_confirm call.
190 struct nfs_open_confirmargs {
191 const struct nfs_fh * fh;
192 nfs4_stateid * stateid;
193 struct nfs_seqid * seqid;
196 struct nfs_open_confirmres {
197 nfs4_stateid stateid;
198 struct nfs_seqid * seqid;
202 * Arguments to the close call.
204 struct nfs_closeargs {
206 nfs4_stateid * stateid;
207 struct nfs_seqid * seqid;
212 struct nfs_closeres {
213 nfs4_stateid stateid;
214 struct nfs_fattr * fattr;
215 struct nfs_seqid * seqid;
216 const struct nfs_server *server;
219 * * Arguments to the lock,lockt, and locku call.
226 struct nfs_lock_args {
228 struct file_lock * fl;
229 struct nfs_seqid * lock_seqid;
230 nfs4_stateid * lock_stateid;
231 struct nfs_seqid * open_seqid;
232 nfs4_stateid * open_stateid;
233 struct nfs_lowner lock_owner;
234 unsigned char block : 1;
235 unsigned char reclaim : 1;
236 unsigned char new_lock_owner : 1;
239 struct nfs_lock_res {
240 nfs4_stateid stateid;
241 struct nfs_seqid * lock_seqid;
242 struct nfs_seqid * open_seqid;
245 struct nfs_locku_args {
247 struct file_lock * fl;
248 struct nfs_seqid * seqid;
249 nfs4_stateid * stateid;
252 struct nfs_locku_res {
253 nfs4_stateid stateid;
254 struct nfs_seqid * seqid;
257 struct nfs_lockt_args {
259 struct file_lock * fl;
260 struct nfs_lowner lock_owner;
263 struct nfs_lockt_res {
264 struct file_lock * denied; /* LOCK, LOCKT failed */
267 struct nfs4_delegreturnargs {
268 const struct nfs_fh *fhandle;
269 const nfs4_stateid *stateid;
273 struct nfs4_delegreturnres {
274 struct nfs_fattr * fattr;
275 const struct nfs_server *server;
279 * Arguments to the read call.
281 struct nfs_readargs {
283 struct nfs_open_context *context;
287 struct page ** pages;
291 struct nfs_fattr * fattr;
297 * Arguments to the write call.
299 struct nfs_writeargs {
301 struct nfs_open_context *context;
304 enum nfs3_stable_how stable;
306 struct page ** pages;
310 struct nfs_writeverf {
311 enum nfs3_stable_how committed;
315 struct nfs_writeres {
316 struct nfs_fattr * fattr;
317 struct nfs_writeverf * verf;
319 const struct nfs_server *server;
323 * Common arguments to the unlink call
325 struct nfs_removeargs {
326 const struct nfs_fh *fh;
331 struct nfs_removeres {
332 const struct nfs_server *server;
333 struct nfs4_change_info cinfo;
334 struct nfs_fattr dir_attr;
338 * Argument struct for decode_entry function
348 struct nfs_fattr * fattr;
352 * The following types are for NFSv2 only.
354 struct nfs_sattrargs {
356 struct iattr * sattr;
359 struct nfs_diropargs {
365 struct nfs_createargs {
369 struct iattr * sattr;
372 struct nfs_renameargs {
373 struct nfs_fh * fromfh;
374 const char * fromname;
375 unsigned int fromlen;
376 struct nfs_fh * tofh;
381 struct nfs_setattrargs {
383 nfs4_stateid stateid;
385 const struct nfs_server * server; /* Needed for name mapping */
389 struct nfs_setaclargs {
392 unsigned int acl_pgbase;
393 struct page ** acl_pages;
396 struct nfs_getaclargs {
399 unsigned int acl_pgbase;
400 struct page ** acl_pages;
403 struct nfs_setattrres {
404 struct nfs_fattr * fattr;
405 const struct nfs_server * server;
408 struct nfs_linkargs {
409 struct nfs_fh * fromfh;
410 struct nfs_fh * tofh;
415 struct nfs_symlinkargs {
416 struct nfs_fh * fromfh;
417 const char * fromname;
418 unsigned int fromlen;
419 struct page ** pages;
420 unsigned int pathlen;
421 struct iattr * sattr;
424 struct nfs_readdirargs {
428 struct page ** pages;
431 struct nfs3_getaclargs {
434 struct page ** pages;
437 struct nfs3_setaclargs {
438 struct inode * inode;
440 struct posix_acl * acl_access;
441 struct posix_acl * acl_default;
444 struct page ** pages;
449 struct nfs_fattr * fattr;
452 struct nfs_readlinkargs {
456 struct page ** pages;
459 struct nfs3_sattrargs {
461 struct iattr * sattr;
463 struct timespec guardtime;
466 struct nfs3_diropargs {
472 struct nfs3_accessargs {
477 struct nfs3_createargs {
481 struct iattr * sattr;
482 enum nfs3_createmode createmode;
486 struct nfs3_mkdirargs {
490 struct iattr * sattr;
493 struct nfs3_symlinkargs {
494 struct nfs_fh * fromfh;
495 const char * fromname;
496 unsigned int fromlen;
497 struct page ** pages;
498 unsigned int pathlen;
499 struct iattr * sattr;
502 struct nfs3_mknodargs {
506 enum nfs3_ftype type;
507 struct iattr * sattr;
511 struct nfs3_renameargs {
512 struct nfs_fh * fromfh;
513 const char * fromname;
514 unsigned int fromlen;
515 struct nfs_fh * tofh;
520 struct nfs3_linkargs {
521 struct nfs_fh * fromfh;
522 struct nfs_fh * tofh;
527 struct nfs3_readdirargs {
533 struct page ** pages;
536 struct nfs3_diropres {
537 struct nfs_fattr * dir_attr;
539 struct nfs_fattr * fattr;
542 struct nfs3_accessres {
543 struct nfs_fattr * fattr;
547 struct nfs3_readlinkargs {
551 struct page ** pages;
554 struct nfs3_renameres {
555 struct nfs_fattr * fromattr;
556 struct nfs_fattr * toattr;
559 struct nfs3_linkres {
560 struct nfs_fattr * dir_attr;
561 struct nfs_fattr * fattr;
564 struct nfs3_readdirres {
565 struct nfs_fattr * dir_attr;
570 struct nfs3_getaclres {
571 struct nfs_fattr * fattr;
573 unsigned int acl_access_count;
574 unsigned int acl_default_count;
575 struct posix_acl * acl_access;
576 struct posix_acl * acl_default;
581 typedef u64 clientid4;
583 struct nfs4_accessargs {
584 const struct nfs_fh * fh;
589 struct nfs4_accessres {
590 const struct nfs_server * server;
591 struct nfs_fattr * fattr;
596 struct nfs4_create_arg {
600 struct page ** pages;
602 } symlink; /* NF4LNK */
606 } device; /* NF4BLK, NF4CHR */
608 const struct qstr * name;
609 const struct nfs_server * server;
610 const struct iattr * attrs;
611 const struct nfs_fh * dir_fh;
615 struct nfs4_create_res {
616 const struct nfs_server * server;
618 struct nfs_fattr * fattr;
619 struct nfs4_change_info dir_cinfo;
620 struct nfs_fattr * dir_fattr;
623 struct nfs4_fsinfo_arg {
624 const struct nfs_fh * fh;
628 struct nfs4_getattr_arg {
629 const struct nfs_fh * fh;
633 struct nfs4_getattr_res {
634 const struct nfs_server * server;
635 struct nfs_fattr * fattr;
638 struct nfs4_link_arg {
639 const struct nfs_fh * fh;
640 const struct nfs_fh * dir_fh;
641 const struct qstr * name;
645 struct nfs4_link_res {
646 const struct nfs_server * server;
647 struct nfs_fattr * fattr;
648 struct nfs4_change_info cinfo;
649 struct nfs_fattr * dir_attr;
653 struct nfs4_lookup_arg {
654 const struct nfs_fh * dir_fh;
655 const struct qstr * name;
659 struct nfs4_lookup_res {
660 const struct nfs_server * server;
661 struct nfs_fattr * fattr;
665 struct nfs4_lookup_root_arg {
669 struct nfs4_pathconf_arg {
670 const struct nfs_fh * fh;
674 struct nfs4_readdir_arg {
675 const struct nfs_fh * fh;
677 nfs4_verifier verifier;
679 struct page ** pages; /* zero-copy data */
680 unsigned int pgbase; /* zero-copy data */
684 struct nfs4_readdir_res {
685 nfs4_verifier verifier;
689 struct nfs4_readlink {
690 const struct nfs_fh * fh;
692 unsigned int pglen; /* zero-copy data */
693 struct page ** pages; /* zero-copy data */
696 struct nfs4_rename_arg {
697 const struct nfs_fh * old_dir;
698 const struct nfs_fh * new_dir;
699 const struct qstr * old_name;
700 const struct qstr * new_name;
704 struct nfs4_rename_res {
705 const struct nfs_server * server;
706 struct nfs4_change_info old_cinfo;
707 struct nfs_fattr * old_fattr;
708 struct nfs4_change_info new_cinfo;
709 struct nfs_fattr * new_fattr;
712 #define NFS4_SETCLIENTID_NAMELEN (127)
713 struct nfs4_setclientid {
714 const nfs4_verifier * sc_verifier;
715 unsigned int sc_name_len;
716 char sc_name[NFS4_SETCLIENTID_NAMELEN + 1];
718 unsigned int sc_netid_len;
719 char sc_netid[RPCBIND_MAXNETIDLEN + 1];
720 unsigned int sc_uaddr_len;
721 char sc_uaddr[RPCBIND_MAXUADDRLEN + 1];
725 struct nfs4_statfs_arg {
726 const struct nfs_fh * fh;
730 struct nfs4_server_caps_res {
742 #define NFS4_PATHNAME_MAXCOMPONENTS 512
743 struct nfs4_pathname {
744 unsigned int ncomponents;
745 struct nfs4_string components[NFS4_PATHNAME_MAXCOMPONENTS];
748 #define NFS4_FS_LOCATION_MAXSERVERS 10
749 struct nfs4_fs_location {
750 unsigned int nservers;
751 struct nfs4_string servers[NFS4_FS_LOCATION_MAXSERVERS];
752 struct nfs4_pathname rootpath;
755 #define NFS4_FS_LOCATIONS_MAXENTRIES 10
756 struct nfs4_fs_locations {
757 struct nfs_fattr fattr;
758 const struct nfs_server *server;
759 struct nfs4_pathname fs_path;
761 struct nfs4_fs_location locations[NFS4_FS_LOCATIONS_MAXENTRIES];
764 struct nfs4_fs_locations_arg {
765 const struct nfs_fh *dir_fh;
766 const struct qstr *name;
771 #endif /* CONFIG_NFS_V4 */
775 #define NFS_PAGEVEC_SIZE (8U)
777 struct nfs_read_data {
779 struct rpc_task task;
781 struct rpc_cred *cred;
782 struct nfs_fattr fattr; /* fattr storage */
783 struct list_head pages; /* Coalesced read requests */
784 struct nfs_page *req; /* multi ops per nfs_page */
785 struct page **pagevec;
786 unsigned int npages; /* Max length of pagevec */
787 struct nfs_readargs args;
788 struct nfs_readres res;
790 unsigned long timestamp; /* For lease renewal */
792 struct page *page_array[NFS_PAGEVEC_SIZE];
795 struct nfs_write_data {
797 struct rpc_task task;
799 struct rpc_cred *cred;
800 struct nfs_fattr fattr;
801 struct nfs_writeverf verf;
802 struct list_head pages; /* Coalesced requests we wish to flush */
803 struct nfs_page *req; /* multi ops per nfs_page */
804 struct page **pagevec;
805 unsigned int npages; /* Max length of pagevec */
806 struct nfs_writeargs args; /* argument struct */
807 struct nfs_writeres res; /* result struct */
809 unsigned long timestamp; /* For lease renewal */
811 struct page *page_array[NFS_PAGEVEC_SIZE];
814 struct nfs_access_entry;
817 * RPC procedure vector for NFSv2/NFSv3 demuxing
820 u32 version; /* Protocol version */
821 struct dentry_operations *dentry_ops;
822 const struct inode_operations *dir_inode_ops;
823 const struct inode_operations *file_inode_ops;
825 int (*getroot) (struct nfs_server *, struct nfs_fh *,
826 struct nfs_fsinfo *);
827 int (*lookupfh)(struct nfs_server *, struct nfs_fh *,
828 struct qstr *, struct nfs_fh *,
830 int (*getattr) (struct nfs_server *, struct nfs_fh *,
832 int (*setattr) (struct dentry *, struct nfs_fattr *,
834 int (*lookup) (struct inode *, struct qstr *,
835 struct nfs_fh *, struct nfs_fattr *);
836 int (*access) (struct inode *, struct nfs_access_entry *);
837 int (*readlink)(struct inode *, struct page *, unsigned int,
839 int (*create) (struct inode *, struct dentry *,
840 struct iattr *, int, struct nameidata *);
841 int (*remove) (struct inode *, struct qstr *);
842 void (*unlink_setup) (struct rpc_message *, struct inode *dir);
843 int (*unlink_done) (struct rpc_task *, struct inode *);
844 int (*rename) (struct inode *, struct qstr *,
845 struct inode *, struct qstr *);
846 int (*link) (struct inode *, struct inode *, struct qstr *);
847 int (*symlink) (struct inode *, struct dentry *, struct page *,
848 unsigned int, struct iattr *);
849 int (*mkdir) (struct inode *, struct dentry *, struct iattr *);
850 int (*rmdir) (struct inode *, struct qstr *);
851 int (*readdir) (struct dentry *, struct rpc_cred *,
852 u64, struct page *, unsigned int, int);
853 int (*mknod) (struct inode *, struct dentry *, struct iattr *,
855 int (*statfs) (struct nfs_server *, struct nfs_fh *,
856 struct nfs_fsstat *);
857 int (*fsinfo) (struct nfs_server *, struct nfs_fh *,
858 struct nfs_fsinfo *);
859 int (*pathconf) (struct nfs_server *, struct nfs_fh *,
860 struct nfs_pathconf *);
861 int (*set_capabilities)(struct nfs_server *, struct nfs_fh *);
862 __be32 *(*decode_dirent)(__be32 *, struct nfs_entry *, int plus);
863 void (*read_setup) (struct nfs_read_data *, struct rpc_message *);
864 int (*read_done) (struct rpc_task *, struct nfs_read_data *);
865 void (*write_setup) (struct nfs_write_data *, struct rpc_message *);
866 int (*write_done) (struct rpc_task *, struct nfs_write_data *);
867 void (*commit_setup) (struct nfs_write_data *, struct rpc_message *);
868 int (*commit_done) (struct rpc_task *, struct nfs_write_data *);
869 int (*lock)(struct file *, int, struct file_lock *);
870 int (*lock_check_bounds)(const struct file_lock *);
871 void (*clear_acl_cache)(struct inode *);
875 * NFS_CALL(getattr, inode, (fattr));
877 * NFS_PROTO(inode)->getattr(fattr);
879 #define NFS_CALL(op, inode, args) NFS_PROTO(inode)->op args
882 * Function vectors etc. for the NFS client
884 extern const struct nfs_rpc_ops nfs_v2_clientops;
885 extern const struct nfs_rpc_ops nfs_v3_clientops;
886 extern const struct nfs_rpc_ops nfs_v4_clientops;
887 extern struct rpc_version nfs_version2;
888 extern struct rpc_version nfs_version3;
889 extern struct rpc_version nfs_version4;
891 extern struct rpc_version nfsacl_version3;
892 extern struct rpc_program nfsacl_program;