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 short valid
; /* which fields are valid */
31 __u64 pre_size
; /* pre_op_attr.size */
32 struct timespec pre_mtime
; /* pre_op_attr.mtime */
33 struct timespec pre_ctime
; /* pre_op_attr.ctime */
34 enum nfs_ftype type
; /* always use NFSv2 types */
52 struct timespec atime
;
53 struct timespec mtime
;
54 struct timespec ctime
;
55 __u32 bitmap
[2]; /* NFSv4 returned attribute bitmap */
56 __u64 change_attr
; /* NFSv4 change attribute */
57 __u64 pre_change_attr
;/* pre-op NFSv4 change attribute */
58 unsigned long time_start
;
61 #define NFS_ATTR_WCC 0x0001 /* pre-op WCC data */
62 #define NFS_ATTR_FATTR 0x0002 /* post-op attributes */
63 #define NFS_ATTR_FATTR_V3 0x0004 /* NFSv3 attributes */
64 #define NFS_ATTR_FATTR_V4 0x0008 /* NFSv4 change attribute */
65 #define NFS_ATTR_FATTR_V4_REFERRAL 0x0010 /* NFSv4 referral */
68 * Info on the file system
71 struct nfs_fattr
*fattr
; /* Post-op attributes */
72 __u32 rtmax
; /* max. read transfer size */
73 __u32 rtpref
; /* pref. read transfer size */
74 __u32 rtmult
; /* reads should be multiple of this */
75 __u32 wtmax
; /* max. write transfer size */
76 __u32 wtpref
; /* pref. write transfer size */
77 __u32 wtmult
; /* writes should be multiple of this */
78 __u32 dtpref
; /* pref. readdir transfer size */
80 __u32 lease_time
; /* in seconds */
84 struct nfs_fattr
*fattr
; /* Post-op attributes */
85 __u64 tbytes
; /* total size in bytes */
86 __u64 fbytes
; /* # of free bytes */
87 __u64 abytes
; /* # of bytes available to user */
88 __u64 tfiles
; /* # of files */
89 __u64 ffiles
; /* # of free files */
90 __u64 afiles
; /* # of files available to user */
94 __u32 tsize
; /* Server transfer size */
95 __u32 bsize
; /* Filesystem block size */
96 __u32 blocks
; /* No. of "bsize" blocks on filesystem */
97 __u32 bfree
; /* No. of free "bsize" blocks */
98 __u32 bavail
; /* No. of available "bsize" blocks */
101 struct nfs_pathconf
{
102 struct nfs_fattr
*fattr
; /* Post-op attributes */
103 __u32 max_link
; /* max # of hard links */
104 __u32 max_namelen
; /* max name length */
107 struct nfs4_change_info
{
115 * Arguments to the open call.
117 struct nfs_openargs
{
118 const struct nfs_fh
* fh
;
119 struct nfs_seqid
* seqid
;
124 struct iattr
* attrs
; /* UNCHECKED, GUARDED */
125 nfs4_verifier verifier
; /* EXCLUSIVE */
126 nfs4_stateid delegation
; /* CLAIM_DELEGATE_CUR */
127 int delegation_type
; /* CLAIM_PREVIOUS */
129 const struct qstr
* name
;
130 const struct nfs_server
*server
; /* Needed for ID mapping */
136 nfs4_stateid stateid
;
138 struct nfs4_change_info cinfo
;
140 struct nfs_fattr
* f_attr
;
141 struct nfs_fattr
* dir_attr
;
142 const struct nfs_server
*server
;
144 nfs4_stateid delegation
;
147 __u32 attrset
[NFS4_BITMAP_SIZE
];
151 * Arguments to the open_confirm call.
153 struct nfs_open_confirmargs
{
154 const struct nfs_fh
* fh
;
155 nfs4_stateid
* stateid
;
156 struct nfs_seqid
* seqid
;
159 struct nfs_open_confirmres
{
160 nfs4_stateid stateid
;
164 * Arguments to the close call.
166 struct nfs_closeargs
{
168 nfs4_stateid
* stateid
;
169 struct nfs_seqid
* seqid
;
174 struct nfs_closeres
{
175 nfs4_stateid stateid
;
176 struct nfs_fattr
* fattr
;
177 const struct nfs_server
*server
;
180 * * Arguments to the lock,lockt, and locku call.
187 struct nfs_lock_args
{
189 struct file_lock
* fl
;
190 struct nfs_seqid
* lock_seqid
;
191 nfs4_stateid
* lock_stateid
;
192 struct nfs_seqid
* open_seqid
;
193 nfs4_stateid
* open_stateid
;
194 struct nfs_lowner lock_owner
;
195 unsigned char block
: 1;
196 unsigned char reclaim
: 1;
197 unsigned char new_lock_owner
: 1;
200 struct nfs_lock_res
{
201 nfs4_stateid stateid
;
204 struct nfs_locku_args
{
206 struct file_lock
* fl
;
207 struct nfs_seqid
* seqid
;
208 nfs4_stateid
* stateid
;
211 struct nfs_locku_res
{
212 nfs4_stateid stateid
;
215 struct nfs_lockt_args
{
217 struct file_lock
* fl
;
218 struct nfs_lowner lock_owner
;
221 struct nfs_lockt_res
{
222 struct file_lock
* denied
; /* LOCK, LOCKT failed */
225 struct nfs4_delegreturnargs
{
226 const struct nfs_fh
*fhandle
;
227 const nfs4_stateid
*stateid
;
231 struct nfs4_delegreturnres
{
232 struct nfs_fattr
* fattr
;
233 const struct nfs_server
*server
;
237 * Arguments to the read call.
239 struct nfs_readargs
{
241 struct nfs_open_context
*context
;
245 struct page
** pages
;
249 struct nfs_fattr
* fattr
;
255 * Arguments to the write call.
257 struct nfs_writeargs
{
259 struct nfs_open_context
*context
;
262 enum nfs3_stable_how stable
;
264 struct page
** pages
;
268 struct nfs_writeverf
{
269 enum nfs3_stable_how committed
;
273 struct nfs_writeres
{
274 struct nfs_fattr
* fattr
;
275 struct nfs_writeverf
* verf
;
277 const struct nfs_server
*server
;
281 * Common arguments to the unlink call
283 struct nfs_removeargs
{
284 const struct nfs_fh
*fh
;
289 struct nfs_removeres
{
290 const struct nfs_server
*server
;
291 struct nfs4_change_info cinfo
;
292 struct nfs_fattr dir_attr
;
296 * Argument struct for decode_entry function
306 struct nfs_fattr
* fattr
;
310 * The following types are for NFSv2 only.
312 struct nfs_sattrargs
{
314 struct iattr
* sattr
;
317 struct nfs_diropargs
{
323 struct nfs_createargs
{
327 struct iattr
* sattr
;
330 struct nfs_renameargs
{
331 struct nfs_fh
* fromfh
;
332 const char * fromname
;
333 unsigned int fromlen
;
334 struct nfs_fh
* tofh
;
339 struct nfs_setattrargs
{
341 nfs4_stateid stateid
;
343 const struct nfs_server
* server
; /* Needed for name mapping */
347 struct nfs_setaclargs
{
350 unsigned int acl_pgbase
;
351 struct page
** acl_pages
;
354 struct nfs_getaclargs
{
357 unsigned int acl_pgbase
;
358 struct page
** acl_pages
;
361 struct nfs_setattrres
{
362 struct nfs_fattr
* fattr
;
363 const struct nfs_server
* server
;
366 struct nfs_linkargs
{
367 struct nfs_fh
* fromfh
;
368 struct nfs_fh
* tofh
;
373 struct nfs_symlinkargs
{
374 struct nfs_fh
* fromfh
;
375 const char * fromname
;
376 unsigned int fromlen
;
377 struct page
** pages
;
378 unsigned int pathlen
;
379 struct iattr
* sattr
;
382 struct nfs_readdirargs
{
386 struct page
** pages
;
389 struct nfs3_getaclargs
{
392 struct page
** pages
;
395 struct nfs3_setaclargs
{
396 struct inode
* inode
;
398 struct posix_acl
* acl_access
;
399 struct posix_acl
* acl_default
;
400 struct page
** pages
;
405 struct nfs_fattr
* fattr
;
408 struct nfs_readlinkargs
{
412 struct page
** pages
;
415 struct nfs3_sattrargs
{
417 struct iattr
* sattr
;
419 struct timespec guardtime
;
422 struct nfs3_diropargs
{
428 struct nfs3_accessargs
{
433 struct nfs3_createargs
{
437 struct iattr
* sattr
;
438 enum nfs3_createmode createmode
;
442 struct nfs3_mkdirargs
{
446 struct iattr
* sattr
;
449 struct nfs3_symlinkargs
{
450 struct nfs_fh
* fromfh
;
451 const char * fromname
;
452 unsigned int fromlen
;
453 struct page
** pages
;
454 unsigned int pathlen
;
455 struct iattr
* sattr
;
458 struct nfs3_mknodargs
{
462 enum nfs3_ftype type
;
463 struct iattr
* sattr
;
467 struct nfs3_renameargs
{
468 struct nfs_fh
* fromfh
;
469 const char * fromname
;
470 unsigned int fromlen
;
471 struct nfs_fh
* tofh
;
476 struct nfs3_linkargs
{
477 struct nfs_fh
* fromfh
;
478 struct nfs_fh
* tofh
;
483 struct nfs3_readdirargs
{
489 struct page
** pages
;
492 struct nfs3_diropres
{
493 struct nfs_fattr
* dir_attr
;
495 struct nfs_fattr
* fattr
;
498 struct nfs3_accessres
{
499 struct nfs_fattr
* fattr
;
503 struct nfs3_readlinkargs
{
507 struct page
** pages
;
510 struct nfs3_renameres
{
511 struct nfs_fattr
* fromattr
;
512 struct nfs_fattr
* toattr
;
515 struct nfs3_linkres
{
516 struct nfs_fattr
* dir_attr
;
517 struct nfs_fattr
* fattr
;
520 struct nfs3_readdirres
{
521 struct nfs_fattr
* dir_attr
;
526 struct nfs3_getaclres
{
527 struct nfs_fattr
* fattr
;
529 unsigned int acl_access_count
;
530 unsigned int acl_default_count
;
531 struct posix_acl
* acl_access
;
532 struct posix_acl
* acl_default
;
537 typedef u64 clientid4
;
539 struct nfs4_accessargs
{
540 const struct nfs_fh
* fh
;
544 struct nfs4_accessres
{
549 struct nfs4_create_arg
{
553 struct page
** pages
;
555 } symlink
; /* NF4LNK */
559 } device
; /* NF4BLK, NF4CHR */
561 const struct qstr
* name
;
562 const struct nfs_server
* server
;
563 const struct iattr
* attrs
;
564 const struct nfs_fh
* dir_fh
;
568 struct nfs4_create_res
{
569 const struct nfs_server
* server
;
571 struct nfs_fattr
* fattr
;
572 struct nfs4_change_info dir_cinfo
;
573 struct nfs_fattr
* dir_fattr
;
576 struct nfs4_fsinfo_arg
{
577 const struct nfs_fh
* fh
;
581 struct nfs4_getattr_arg
{
582 const struct nfs_fh
* fh
;
586 struct nfs4_getattr_res
{
587 const struct nfs_server
* server
;
588 struct nfs_fattr
* fattr
;
591 struct nfs4_link_arg
{
592 const struct nfs_fh
* fh
;
593 const struct nfs_fh
* dir_fh
;
594 const struct qstr
* name
;
598 struct nfs4_link_res
{
599 const struct nfs_server
* server
;
600 struct nfs_fattr
* fattr
;
601 struct nfs4_change_info cinfo
;
602 struct nfs_fattr
* dir_attr
;
606 struct nfs4_lookup_arg
{
607 const struct nfs_fh
* dir_fh
;
608 const struct qstr
* name
;
612 struct nfs4_lookup_res
{
613 const struct nfs_server
* server
;
614 struct nfs_fattr
* fattr
;
618 struct nfs4_lookup_root_arg
{
622 struct nfs4_pathconf_arg
{
623 const struct nfs_fh
* fh
;
627 struct nfs4_readdir_arg
{
628 const struct nfs_fh
* fh
;
630 nfs4_verifier verifier
;
632 struct page
** pages
; /* zero-copy data */
633 unsigned int pgbase
; /* zero-copy data */
637 struct nfs4_readdir_res
{
638 nfs4_verifier verifier
;
642 struct nfs4_readlink
{
643 const struct nfs_fh
* fh
;
645 unsigned int pglen
; /* zero-copy data */
646 struct page
** pages
; /* zero-copy data */
649 struct nfs4_rename_arg
{
650 const struct nfs_fh
* old_dir
;
651 const struct nfs_fh
* new_dir
;
652 const struct qstr
* old_name
;
653 const struct qstr
* new_name
;
657 struct nfs4_rename_res
{
658 const struct nfs_server
* server
;
659 struct nfs4_change_info old_cinfo
;
660 struct nfs_fattr
* old_fattr
;
661 struct nfs4_change_info new_cinfo
;
662 struct nfs_fattr
* new_fattr
;
665 struct nfs4_setclientid
{
666 const nfs4_verifier
* sc_verifier
; /* request */
667 unsigned int sc_name_len
;
668 char sc_name
[48]; /* request */
669 u32 sc_prog
; /* request */
670 unsigned int sc_netid_len
;
671 char sc_netid
[4]; /* request */
672 unsigned int sc_uaddr_len
;
673 char sc_uaddr
[24]; /* request */
674 u32 sc_cb_ident
; /* request */
677 struct nfs4_statfs_arg
{
678 const struct nfs_fh
* fh
;
682 struct nfs4_server_caps_res
{
694 #define NFS4_PATHNAME_MAXCOMPONENTS 512
695 struct nfs4_pathname
{
696 unsigned int ncomponents
;
697 struct nfs4_string components
[NFS4_PATHNAME_MAXCOMPONENTS
];
700 #define NFS4_FS_LOCATION_MAXSERVERS 10
701 struct nfs4_fs_location
{
702 unsigned int nservers
;
703 struct nfs4_string servers
[NFS4_FS_LOCATION_MAXSERVERS
];
704 struct nfs4_pathname rootpath
;
707 #define NFS4_FS_LOCATIONS_MAXENTRIES 10
708 struct nfs4_fs_locations
{
709 struct nfs_fattr fattr
;
710 const struct nfs_server
*server
;
711 struct nfs4_pathname fs_path
;
713 struct nfs4_fs_location locations
[NFS4_FS_LOCATIONS_MAXENTRIES
];
716 struct nfs4_fs_locations_arg
{
717 const struct nfs_fh
*dir_fh
;
718 const struct qstr
*name
;
723 #endif /* CONFIG_NFS_V4 */
727 #define NFS_PAGEVEC_SIZE (8U)
729 struct nfs_read_data
{
731 struct rpc_task task
;
733 struct rpc_cred
*cred
;
734 struct nfs_fattr fattr
; /* fattr storage */
735 struct list_head pages
; /* Coalesced read requests */
736 struct nfs_page
*req
; /* multi ops per nfs_page */
737 struct page
**pagevec
;
738 unsigned int npages
; /* Max length of pagevec */
739 struct nfs_readargs args
;
740 struct nfs_readres res
;
742 unsigned long timestamp
; /* For lease renewal */
744 struct page
*page_array
[NFS_PAGEVEC_SIZE
];
747 struct nfs_write_data
{
749 struct rpc_task task
;
751 struct rpc_cred
*cred
;
752 struct nfs_fattr fattr
;
753 struct nfs_writeverf verf
;
754 struct list_head pages
; /* Coalesced requests we wish to flush */
755 struct nfs_page
*req
; /* multi ops per nfs_page */
756 struct page
**pagevec
;
757 unsigned int npages
; /* Max length of pagevec */
758 struct nfs_writeargs args
; /* argument struct */
759 struct nfs_writeres res
; /* result struct */
761 unsigned long timestamp
; /* For lease renewal */
763 struct page
*page_array
[NFS_PAGEVEC_SIZE
];
766 struct nfs_access_entry
;
769 * RPC procedure vector for NFSv2/NFSv3 demuxing
772 int version
; /* Protocol version */
773 struct dentry_operations
*dentry_ops
;
774 const struct inode_operations
*dir_inode_ops
;
775 const struct inode_operations
*file_inode_ops
;
777 int (*getroot
) (struct nfs_server
*, struct nfs_fh
*,
778 struct nfs_fsinfo
*);
779 int (*lookupfh
)(struct nfs_server
*, struct nfs_fh
*,
780 struct qstr
*, struct nfs_fh
*,
782 int (*getattr
) (struct nfs_server
*, struct nfs_fh
*,
784 int (*setattr
) (struct dentry
*, struct nfs_fattr
*,
786 int (*lookup
) (struct inode
*, struct qstr
*,
787 struct nfs_fh
*, struct nfs_fattr
*);
788 int (*access
) (struct inode
*, struct nfs_access_entry
*);
789 int (*readlink
)(struct inode
*, struct page
*, unsigned int,
791 int (*create
) (struct inode
*, struct dentry
*,
792 struct iattr
*, int, struct nameidata
*);
793 int (*remove
) (struct inode
*, struct qstr
*);
794 void (*unlink_setup
) (struct rpc_message
*, struct inode
*dir
);
795 int (*unlink_done
) (struct rpc_task
*, struct inode
*);
796 int (*rename
) (struct inode
*, struct qstr
*,
797 struct inode
*, struct qstr
*);
798 int (*link
) (struct inode
*, struct inode
*, struct qstr
*);
799 int (*symlink
) (struct inode
*, struct dentry
*, struct page
*,
800 unsigned int, struct iattr
*);
801 int (*mkdir
) (struct inode
*, struct dentry
*, struct iattr
*);
802 int (*rmdir
) (struct inode
*, struct qstr
*);
803 int (*readdir
) (struct dentry
*, struct rpc_cred
*,
804 u64
, struct page
*, unsigned int, int);
805 int (*mknod
) (struct inode
*, struct dentry
*, struct iattr
*,
807 int (*statfs
) (struct nfs_server
*, struct nfs_fh
*,
808 struct nfs_fsstat
*);
809 int (*fsinfo
) (struct nfs_server
*, struct nfs_fh
*,
810 struct nfs_fsinfo
*);
811 int (*pathconf
) (struct nfs_server
*, struct nfs_fh
*,
812 struct nfs_pathconf
*);
813 int (*set_capabilities
)(struct nfs_server
*, struct nfs_fh
*);
814 __be32
*(*decode_dirent
)(__be32
*, struct nfs_entry
*, int plus
);
815 void (*read_setup
) (struct nfs_read_data
*);
816 int (*read_done
) (struct rpc_task
*, struct nfs_read_data
*);
817 void (*write_setup
) (struct nfs_write_data
*, int how
);
818 int (*write_done
) (struct rpc_task
*, struct nfs_write_data
*);
819 void (*commit_setup
) (struct nfs_write_data
*, int how
);
820 int (*commit_done
) (struct rpc_task
*, struct nfs_write_data
*);
821 int (*file_open
) (struct inode
*, struct file
*);
822 int (*file_release
) (struct inode
*, struct file
*);
823 int (*lock
)(struct file
*, int, struct file_lock
*);
824 void (*clear_acl_cache
)(struct inode
*);
828 * NFS_CALL(getattr, inode, (fattr));
830 * NFS_PROTO(inode)->getattr(fattr);
832 #define NFS_CALL(op, inode, args) NFS_PROTO(inode)->op args
835 * Function vectors etc. for the NFS client
837 extern const struct nfs_rpc_ops nfs_v2_clientops
;
838 extern const struct nfs_rpc_ops nfs_v3_clientops
;
839 extern const struct nfs_rpc_ops nfs_v4_clientops
;
840 extern struct rpc_version nfs_version2
;
841 extern struct rpc_version nfs_version3
;
842 extern struct rpc_version nfs_version4
;
844 extern struct rpc_version nfsacl_version3
;
845 extern struct rpc_program nfsacl_program
;