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 * Arguments to the open call.
151 struct nfs_openargs
{
152 const struct nfs_fh
* fh
;
153 struct nfs_seqid
* seqid
;
159 struct iattr
* attrs
; /* UNCHECKED, GUARDED */
160 nfs4_verifier verifier
; /* EXCLUSIVE */
161 nfs4_stateid delegation
; /* CLAIM_DELEGATE_CUR */
162 fmode_t delegation_type
; /* CLAIM_PREVIOUS */
164 const struct qstr
* name
;
165 const struct nfs_server
*server
; /* Needed for ID mapping */
171 nfs4_stateid stateid
;
173 struct nfs4_change_info cinfo
;
175 struct nfs_fattr
* f_attr
;
176 struct nfs_fattr
* dir_attr
;
177 struct nfs_seqid
* seqid
;
178 const struct nfs_server
*server
;
179 fmode_t delegation_type
;
180 nfs4_stateid delegation
;
183 __u32 attrset
[NFS4_BITMAP_SIZE
];
187 * Arguments to the open_confirm call.
189 struct nfs_open_confirmargs
{
190 const struct nfs_fh
* fh
;
191 nfs4_stateid
* stateid
;
192 struct nfs_seqid
* seqid
;
195 struct nfs_open_confirmres
{
196 nfs4_stateid stateid
;
197 struct nfs_seqid
* seqid
;
201 * Arguments to the close call.
203 struct nfs_closeargs
{
205 nfs4_stateid
* stateid
;
206 struct nfs_seqid
* seqid
;
211 struct nfs_closeres
{
212 nfs4_stateid stateid
;
213 struct nfs_fattr
* fattr
;
214 struct nfs_seqid
* seqid
;
215 const struct nfs_server
*server
;
218 * * Arguments to the lock,lockt, and locku call.
225 struct nfs_lock_args
{
227 struct file_lock
* fl
;
228 struct nfs_seqid
* lock_seqid
;
229 nfs4_stateid
* lock_stateid
;
230 struct nfs_seqid
* open_seqid
;
231 nfs4_stateid
* open_stateid
;
232 struct nfs_lowner lock_owner
;
233 unsigned char block
: 1;
234 unsigned char reclaim
: 1;
235 unsigned char new_lock_owner
: 1;
238 struct nfs_lock_res
{
239 nfs4_stateid stateid
;
240 struct nfs_seqid
* lock_seqid
;
241 struct nfs_seqid
* open_seqid
;
244 struct nfs_locku_args
{
246 struct file_lock
* fl
;
247 struct nfs_seqid
* seqid
;
248 nfs4_stateid
* stateid
;
251 struct nfs_locku_res
{
252 nfs4_stateid stateid
;
253 struct nfs_seqid
* seqid
;
256 struct nfs_lockt_args
{
258 struct file_lock
* fl
;
259 struct nfs_lowner lock_owner
;
262 struct nfs_lockt_res
{
263 struct file_lock
* denied
; /* LOCK, LOCKT failed */
266 struct nfs4_delegreturnargs
{
267 const struct nfs_fh
*fhandle
;
268 const nfs4_stateid
*stateid
;
272 struct nfs4_delegreturnres
{
273 struct nfs_fattr
* fattr
;
274 const struct nfs_server
*server
;
278 * Arguments to the read call.
280 struct nfs_readargs
{
282 struct nfs_open_context
*context
;
286 struct page
** pages
;
290 struct nfs_fattr
* fattr
;
296 * Arguments to the write call.
298 struct nfs_writeargs
{
300 struct nfs_open_context
*context
;
303 enum nfs3_stable_how stable
;
305 struct page
** pages
;
309 struct nfs_writeverf
{
310 enum nfs3_stable_how committed
;
314 struct nfs_writeres
{
315 struct nfs_fattr
* fattr
;
316 struct nfs_writeverf
* verf
;
318 const struct nfs_server
*server
;
322 * Common arguments to the unlink call
324 struct nfs_removeargs
{
325 const struct nfs_fh
*fh
;
330 struct nfs_removeres
{
331 const struct nfs_server
*server
;
332 struct nfs4_change_info cinfo
;
333 struct nfs_fattr dir_attr
;
337 * Argument struct for decode_entry function
347 struct nfs_fattr
* fattr
;
351 * The following types are for NFSv2 only.
353 struct nfs_sattrargs
{
355 struct iattr
* sattr
;
358 struct nfs_diropargs
{
364 struct nfs_createargs
{
368 struct iattr
* sattr
;
371 struct nfs_renameargs
{
372 struct nfs_fh
* fromfh
;
373 const char * fromname
;
374 unsigned int fromlen
;
375 struct nfs_fh
* tofh
;
380 struct nfs_setattrargs
{
382 nfs4_stateid stateid
;
384 const struct nfs_server
* server
; /* Needed for name mapping */
388 struct nfs_setaclargs
{
391 unsigned int acl_pgbase
;
392 struct page
** acl_pages
;
395 struct nfs_getaclargs
{
398 unsigned int acl_pgbase
;
399 struct page
** acl_pages
;
402 struct nfs_setattrres
{
403 struct nfs_fattr
* fattr
;
404 const struct nfs_server
* server
;
407 struct nfs_linkargs
{
408 struct nfs_fh
* fromfh
;
409 struct nfs_fh
* tofh
;
414 struct nfs_symlinkargs
{
415 struct nfs_fh
* fromfh
;
416 const char * fromname
;
417 unsigned int fromlen
;
418 struct page
** pages
;
419 unsigned int pathlen
;
420 struct iattr
* sattr
;
423 struct nfs_readdirargs
{
427 struct page
** pages
;
430 struct nfs3_getaclargs
{
433 struct page
** pages
;
436 struct nfs3_setaclargs
{
437 struct inode
* inode
;
439 struct posix_acl
* acl_access
;
440 struct posix_acl
* acl_default
;
443 struct page
** pages
;
448 struct nfs_fattr
* fattr
;
451 struct nfs_readlinkargs
{
455 struct page
** pages
;
458 struct nfs3_sattrargs
{
460 struct iattr
* sattr
;
462 struct timespec guardtime
;
465 struct nfs3_diropargs
{
471 struct nfs3_accessargs
{
476 struct nfs3_createargs
{
480 struct iattr
* sattr
;
481 enum nfs3_createmode createmode
;
485 struct nfs3_mkdirargs
{
489 struct iattr
* sattr
;
492 struct nfs3_symlinkargs
{
493 struct nfs_fh
* fromfh
;
494 const char * fromname
;
495 unsigned int fromlen
;
496 struct page
** pages
;
497 unsigned int pathlen
;
498 struct iattr
* sattr
;
501 struct nfs3_mknodargs
{
505 enum nfs3_ftype type
;
506 struct iattr
* sattr
;
510 struct nfs3_renameargs
{
511 struct nfs_fh
* fromfh
;
512 const char * fromname
;
513 unsigned int fromlen
;
514 struct nfs_fh
* tofh
;
519 struct nfs3_linkargs
{
520 struct nfs_fh
* fromfh
;
521 struct nfs_fh
* tofh
;
526 struct nfs3_readdirargs
{
532 struct page
** pages
;
535 struct nfs3_diropres
{
536 struct nfs_fattr
* dir_attr
;
538 struct nfs_fattr
* fattr
;
541 struct nfs3_accessres
{
542 struct nfs_fattr
* fattr
;
546 struct nfs3_readlinkargs
{
550 struct page
** pages
;
553 struct nfs3_renameres
{
554 struct nfs_fattr
* fromattr
;
555 struct nfs_fattr
* toattr
;
558 struct nfs3_linkres
{
559 struct nfs_fattr
* dir_attr
;
560 struct nfs_fattr
* fattr
;
563 struct nfs3_readdirres
{
564 struct nfs_fattr
* dir_attr
;
569 struct nfs3_getaclres
{
570 struct nfs_fattr
* fattr
;
572 unsigned int acl_access_count
;
573 unsigned int acl_default_count
;
574 struct posix_acl
* acl_access
;
575 struct posix_acl
* acl_default
;
580 typedef u64 clientid4
;
582 struct nfs4_accessargs
{
583 const struct nfs_fh
* fh
;
588 struct nfs4_accessres
{
589 const struct nfs_server
* server
;
590 struct nfs_fattr
* fattr
;
595 struct nfs4_create_arg
{
599 struct page
** pages
;
601 } symlink
; /* NF4LNK */
605 } device
; /* NF4BLK, NF4CHR */
607 const struct qstr
* name
;
608 const struct nfs_server
* server
;
609 const struct iattr
* attrs
;
610 const struct nfs_fh
* dir_fh
;
614 struct nfs4_create_res
{
615 const struct nfs_server
* server
;
617 struct nfs_fattr
* fattr
;
618 struct nfs4_change_info dir_cinfo
;
619 struct nfs_fattr
* dir_fattr
;
622 struct nfs4_fsinfo_arg
{
623 const struct nfs_fh
* fh
;
627 struct nfs4_getattr_arg
{
628 const struct nfs_fh
* fh
;
632 struct nfs4_getattr_res
{
633 const struct nfs_server
* server
;
634 struct nfs_fattr
* fattr
;
637 struct nfs4_link_arg
{
638 const struct nfs_fh
* fh
;
639 const struct nfs_fh
* dir_fh
;
640 const struct qstr
* name
;
644 struct nfs4_link_res
{
645 const struct nfs_server
* server
;
646 struct nfs_fattr
* fattr
;
647 struct nfs4_change_info cinfo
;
648 struct nfs_fattr
* dir_attr
;
652 struct nfs4_lookup_arg
{
653 const struct nfs_fh
* dir_fh
;
654 const struct qstr
* name
;
658 struct nfs4_lookup_res
{
659 const struct nfs_server
* server
;
660 struct nfs_fattr
* fattr
;
664 struct nfs4_lookup_root_arg
{
668 struct nfs4_pathconf_arg
{
669 const struct nfs_fh
* fh
;
673 struct nfs4_readdir_arg
{
674 const struct nfs_fh
* fh
;
676 nfs4_verifier verifier
;
678 struct page
** pages
; /* zero-copy data */
679 unsigned int pgbase
; /* zero-copy data */
683 struct nfs4_readdir_res
{
684 nfs4_verifier verifier
;
688 struct nfs4_readlink
{
689 const struct nfs_fh
* fh
;
691 unsigned int pglen
; /* zero-copy data */
692 struct page
** pages
; /* zero-copy data */
695 struct nfs4_rename_arg
{
696 const struct nfs_fh
* old_dir
;
697 const struct nfs_fh
* new_dir
;
698 const struct qstr
* old_name
;
699 const struct qstr
* new_name
;
703 struct nfs4_rename_res
{
704 const struct nfs_server
* server
;
705 struct nfs4_change_info old_cinfo
;
706 struct nfs_fattr
* old_fattr
;
707 struct nfs4_change_info new_cinfo
;
708 struct nfs_fattr
* new_fattr
;
711 #define NFS4_SETCLIENTID_NAMELEN (127)
712 struct nfs4_setclientid
{
713 const nfs4_verifier
* sc_verifier
;
714 unsigned int sc_name_len
;
715 char sc_name
[NFS4_SETCLIENTID_NAMELEN
+ 1];
717 unsigned int sc_netid_len
;
718 char sc_netid
[RPCBIND_MAXNETIDLEN
+ 1];
719 unsigned int sc_uaddr_len
;
720 char sc_uaddr
[RPCBIND_MAXUADDRLEN
+ 1];
724 struct nfs4_statfs_arg
{
725 const struct nfs_fh
* fh
;
729 struct nfs4_server_caps_res
{
741 #define NFS4_PATHNAME_MAXCOMPONENTS 512
742 struct nfs4_pathname
{
743 unsigned int ncomponents
;
744 struct nfs4_string components
[NFS4_PATHNAME_MAXCOMPONENTS
];
747 #define NFS4_FS_LOCATION_MAXSERVERS 10
748 struct nfs4_fs_location
{
749 unsigned int nservers
;
750 struct nfs4_string servers
[NFS4_FS_LOCATION_MAXSERVERS
];
751 struct nfs4_pathname rootpath
;
754 #define NFS4_FS_LOCATIONS_MAXENTRIES 10
755 struct nfs4_fs_locations
{
756 struct nfs_fattr fattr
;
757 const struct nfs_server
*server
;
758 struct nfs4_pathname fs_path
;
760 struct nfs4_fs_location locations
[NFS4_FS_LOCATIONS_MAXENTRIES
];
763 struct nfs4_fs_locations_arg
{
764 const struct nfs_fh
*dir_fh
;
765 const struct qstr
*name
;
770 #endif /* CONFIG_NFS_V4 */
774 #define NFS_PAGEVEC_SIZE (8U)
776 struct nfs_read_data
{
778 struct rpc_task task
;
780 struct rpc_cred
*cred
;
781 struct nfs_fattr fattr
; /* fattr storage */
782 struct list_head pages
; /* Coalesced read requests */
783 struct nfs_page
*req
; /* multi ops per nfs_page */
784 struct page
**pagevec
;
785 unsigned int npages
; /* Max length of pagevec */
786 struct nfs_readargs args
;
787 struct nfs_readres res
;
789 unsigned long timestamp
; /* For lease renewal */
791 struct page
*page_array
[NFS_PAGEVEC_SIZE
];
794 struct nfs_write_data
{
796 struct rpc_task task
;
798 struct rpc_cred
*cred
;
799 struct nfs_fattr fattr
;
800 struct nfs_writeverf verf
;
801 struct list_head pages
; /* Coalesced requests we wish to flush */
802 struct nfs_page
*req
; /* multi ops per nfs_page */
803 struct page
**pagevec
;
804 unsigned int npages
; /* Max length of pagevec */
805 struct nfs_writeargs args
; /* argument struct */
806 struct nfs_writeres res
; /* result struct */
808 unsigned long timestamp
; /* For lease renewal */
810 struct page
*page_array
[NFS_PAGEVEC_SIZE
];
813 struct nfs_access_entry
;
816 * RPC procedure vector for NFSv2/NFSv3 demuxing
819 u32 version
; /* Protocol version */
820 const struct dentry_operations
*dentry_ops
;
821 const struct inode_operations
*dir_inode_ops
;
822 const struct inode_operations
*file_inode_ops
;
824 int (*getroot
) (struct nfs_server
*, struct nfs_fh
*,
825 struct nfs_fsinfo
*);
826 int (*lookupfh
)(struct nfs_server
*, struct nfs_fh
*,
827 struct qstr
*, struct nfs_fh
*,
829 int (*getattr
) (struct nfs_server
*, struct nfs_fh
*,
831 int (*setattr
) (struct dentry
*, struct nfs_fattr
*,
833 int (*lookup
) (struct inode
*, struct qstr
*,
834 struct nfs_fh
*, struct nfs_fattr
*);
835 int (*access
) (struct inode
*, struct nfs_access_entry
*);
836 int (*readlink
)(struct inode
*, struct page
*, unsigned int,
838 int (*create
) (struct inode
*, struct dentry
*,
839 struct iattr
*, int, struct nameidata
*);
840 int (*remove
) (struct inode
*, struct qstr
*);
841 void (*unlink_setup
) (struct rpc_message
*, struct inode
*dir
);
842 int (*unlink_done
) (struct rpc_task
*, struct inode
*);
843 int (*rename
) (struct inode
*, struct qstr
*,
844 struct inode
*, struct qstr
*);
845 int (*link
) (struct inode
*, struct inode
*, struct qstr
*);
846 int (*symlink
) (struct inode
*, struct dentry
*, struct page
*,
847 unsigned int, struct iattr
*);
848 int (*mkdir
) (struct inode
*, struct dentry
*, struct iattr
*);
849 int (*rmdir
) (struct inode
*, struct qstr
*);
850 int (*readdir
) (struct dentry
*, struct rpc_cred
*,
851 u64
, struct page
*, unsigned int, int);
852 int (*mknod
) (struct inode
*, struct dentry
*, struct iattr
*,
854 int (*statfs
) (struct nfs_server
*, struct nfs_fh
*,
855 struct nfs_fsstat
*);
856 int (*fsinfo
) (struct nfs_server
*, struct nfs_fh
*,
857 struct nfs_fsinfo
*);
858 int (*pathconf
) (struct nfs_server
*, struct nfs_fh
*,
859 struct nfs_pathconf
*);
860 int (*set_capabilities
)(struct nfs_server
*, struct nfs_fh
*);
861 __be32
*(*decode_dirent
)(__be32
*, struct nfs_entry
*, int plus
);
862 void (*read_setup
) (struct nfs_read_data
*, struct rpc_message
*);
863 int (*read_done
) (struct rpc_task
*, struct nfs_read_data
*);
864 void (*write_setup
) (struct nfs_write_data
*, struct rpc_message
*);
865 int (*write_done
) (struct rpc_task
*, struct nfs_write_data
*);
866 void (*commit_setup
) (struct nfs_write_data
*, struct rpc_message
*);
867 int (*commit_done
) (struct rpc_task
*, struct nfs_write_data
*);
868 int (*lock
)(struct file
*, int, struct file_lock
*);
869 int (*lock_check_bounds
)(const struct file_lock
*);
870 void (*clear_acl_cache
)(struct inode
*);
871 void (*close_context
)(struct nfs_open_context
*ctx
, int);
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
;