2 * NFS internal definitions
6 #include <linux/mount.h>
7 #include <linux/security.h>
9 #define NFS_MS_MASK (MS_RDONLY|MS_NOSUID|MS_NODEV|MS_NOEXEC|MS_SYNCHRONOUS)
13 /* Maximum number of readahead requests
14 * FIXME: this should really be a sysctl so that users may tune it to suit
15 * their needs. People that do NFS over a slow network, might for
16 * instance want to reduce it to something closer to 1 for improved
17 * interactive response.
19 #define NFS_MAX_READAHEAD (RPC_DEF_SLOT_TABLE - 1)
21 static inline void nfs_attr_check_mountpoint(struct super_block
*parent
, struct nfs_fattr
*fattr
)
23 if (!nfs_fsid_equal(&NFS_SB(parent
)->fsid
, &fattr
->fsid
))
24 fattr
->valid
|= NFS_ATTR_FATTR_MOUNTPOINT
;
27 static inline int nfs_attr_use_mounted_on_fileid(struct nfs_fattr
*fattr
)
29 if (((fattr
->valid
& NFS_ATTR_FATTR_MOUNTED_ON_FILEID
) == 0) ||
30 (((fattr
->valid
& NFS_ATTR_FATTR_MOUNTPOINT
) == 0) &&
31 ((fattr
->valid
& NFS_ATTR_FATTR_V4_REFERRAL
) == 0)))
34 fattr
->fileid
= fattr
->mounted_on_fileid
;
38 struct nfs_clone_mount
{
39 const struct super_block
*sb
;
40 const struct dentry
*dentry
;
42 struct nfs_fattr
*fattr
;
45 struct sockaddr
*addr
;
47 rpc_authflavor_t authflavor
;
51 * Note: RFC 1813 doesn't limit the number of auth flavors that
52 * a server can return, so make something up.
54 #define NFS_MAX_SECFLAVORS (12)
57 * Value used if the user did not specify a port value.
59 #define NFS_UNSPEC_PORT (-1)
62 * Maximum number of pages that readdir can use for creating
63 * a vmapped array of pages.
65 #define NFS_MAX_READDIR_PAGES 8
67 struct nfs_client_initdata
{
68 unsigned long init_flags
;
70 const struct sockaddr
*addr
;
72 struct nfs_subversion
*nfs_mod
;
79 * In-kernel mount arguments
81 struct nfs_parsed_mount_data
{
83 unsigned int rsize
, wsize
;
84 unsigned int timeo
, retrans
;
85 unsigned int acregmin
, acregmax
,
90 unsigned int auth_flavor_len
;
91 rpc_authflavor_t auth_flavors
[1];
94 unsigned int minorversion
;
99 struct sockaddr_storage address
;
104 unsigned short protocol
;
108 struct sockaddr_storage address
;
113 unsigned short protocol
;
116 struct security_mnt_opts lsm_opts
;
121 struct nfs_mount_request
{
122 struct sockaddr
*sap
;
127 unsigned short protocol
;
130 unsigned int *auth_flav_len
;
131 rpc_authflavor_t
*auth_flavs
;
135 struct nfs_mount_info
{
136 void (*fill_super
)(struct super_block
*, struct nfs_mount_info
*);
137 int (*set_security
)(struct super_block
*, struct dentry
*, struct nfs_mount_info
*);
138 struct nfs_parsed_mount_data
*parsed
;
139 struct nfs_clone_mount
*cloned
;
140 struct nfs_fh
*mntfh
;
143 extern int nfs_mount(struct nfs_mount_request
*info
);
144 extern void nfs_umount(const struct nfs_mount_request
*info
);
147 extern const struct rpc_program nfs_program
;
148 extern void nfs_clients_init(struct net
*net
);
149 extern struct nfs_client
*nfs_alloc_client(const struct nfs_client_initdata
*);
150 int nfs_create_rpc_client(struct nfs_client
*, const struct rpc_timeout
*, rpc_authflavor_t
);
151 struct nfs_client
*nfs_get_client(const struct nfs_client_initdata
*,
152 const struct rpc_timeout
*, const char *,
154 int nfs_probe_fsinfo(struct nfs_server
*server
, struct nfs_fh
*, struct nfs_fattr
*);
155 void nfs_server_insert_lists(struct nfs_server
*);
156 void nfs_init_timeout_values(struct rpc_timeout
*, int, unsigned int, unsigned int);
157 int nfs_init_server_rpcclient(struct nfs_server
*, const struct rpc_timeout
*t
,
159 struct nfs_server
*nfs_alloc_server(void);
160 void nfs_server_copy_userdata(struct nfs_server
*, struct nfs_server
*);
162 extern void nfs_cleanup_cb_ident_idr(struct net
*);
163 extern void nfs_put_client(struct nfs_client
*);
164 extern void nfs_free_client(struct nfs_client
*);
165 extern struct nfs_client
*nfs4_find_client_ident(struct net
*, int);
166 extern struct nfs_client
*
167 nfs4_find_client_sessionid(struct net
*, const struct sockaddr
*,
168 struct nfs4_sessionid
*);
169 extern struct nfs_server
*nfs_create_server(struct nfs_mount_info
*,
170 struct nfs_subversion
*);
171 extern struct nfs_server
*nfs4_create_server(
172 struct nfs_mount_info
*,
173 struct nfs_subversion
*);
174 extern struct nfs_server
*nfs4_create_referral_server(struct nfs_clone_mount
*,
176 extern void nfs_free_server(struct nfs_server
*server
);
177 extern struct nfs_server
*nfs_clone_server(struct nfs_server
*,
181 extern int nfs_wait_client_init_complete(const struct nfs_client
*clp
);
182 extern void nfs_mark_client_ready(struct nfs_client
*clp
, int state
);
183 extern struct nfs_client
*nfs4_set_ds_client(struct nfs_client
* mds_clp
,
184 const struct sockaddr
*ds_addr
,
185 int ds_addrlen
, int ds_proto
,
186 unsigned int ds_timeo
,
187 unsigned int ds_retrans
);
188 #ifdef CONFIG_PROC_FS
189 extern int __init
nfs_fs_proc_init(void);
190 extern void nfs_fs_proc_exit(void);
192 static inline int nfs_fs_proc_init(void)
196 static inline void nfs_fs_proc_exit(void)
201 #ifdef CONFIG_NFS_V4_1
202 int nfs_sockaddr_match_ipaddr(const struct sockaddr
*, const struct sockaddr
*);
206 #if IS_ENABLED(CONFIG_NFS_V3)
207 struct nfs_server
*nfs3_create_server(struct nfs_mount_info
*, struct nfs_subversion
*);
208 struct nfs_server
*nfs3_clone_server(struct nfs_server
*, struct nfs_fh
*,
209 struct nfs_fattr
*, rpc_authflavor_t
);
213 extern struct svc_version nfs4_callback_version1
;
214 extern struct svc_version nfs4_callback_version4
;
216 struct nfs_pageio_descriptor
;
218 extern int __init
nfs_init_nfspagecache(void);
219 extern void nfs_destroy_nfspagecache(void);
220 extern int __init
nfs_init_readpagecache(void);
221 extern void nfs_destroy_readpagecache(void);
222 extern int __init
nfs_init_writepagecache(void);
223 extern void nfs_destroy_writepagecache(void);
225 extern int __init
nfs_init_directcache(void);
226 extern void nfs_destroy_directcache(void);
227 extern bool nfs_pgarray_set(struct nfs_page_array
*p
, unsigned int pagecount
);
228 extern void nfs_pgheader_init(struct nfs_pageio_descriptor
*desc
,
229 struct nfs_pgio_header
*hdr
,
230 void (*release
)(struct nfs_pgio_header
*hdr
));
231 void nfs_set_pgio_error(struct nfs_pgio_header
*hdr
, int error
, loff_t pos
);
232 int nfs_iocounter_wait(struct nfs_io_counter
*c
);
234 static inline void nfs_iocounter_init(struct nfs_io_counter
*c
)
237 atomic_set(&c
->io_count
, 0);
241 extern struct rpc_procinfo nfs_procedures
[];
242 extern int nfs2_decode_dirent(struct xdr_stream
*,
243 struct nfs_entry
*, int);
246 extern struct rpc_procinfo nfs3_procedures
[];
247 extern int nfs3_decode_dirent(struct xdr_stream
*,
248 struct nfs_entry
*, int);
251 #if IS_ENABLED(CONFIG_NFS_V4)
252 extern int nfs4_decode_dirent(struct xdr_stream
*,
253 struct nfs_entry
*, int);
255 #ifdef CONFIG_NFS_V4_1
256 extern const u32 nfs41_maxread_overhead
;
257 extern const u32 nfs41_maxwrite_overhead
;
261 #if IS_ENABLED(CONFIG_NFS_V4)
262 extern struct rpc_procinfo nfs4_procedures
[];
266 void nfs_close_context(struct nfs_open_context
*ctx
, int is_sync
);
267 extern struct nfs_client
*nfs_init_client(struct nfs_client
*clp
,
268 const struct rpc_timeout
*timeparms
,
269 const char *ip_addr
, rpc_authflavor_t authflavour
);
272 extern int nfs_access_cache_shrinker(struct shrinker
*shrink
,
273 struct shrink_control
*sc
);
274 struct dentry
*nfs_lookup(struct inode
*, struct dentry
*, unsigned int);
275 int nfs_create(struct inode
*, struct dentry
*, umode_t
, bool);
276 int nfs_mkdir(struct inode
*, struct dentry
*, umode_t
);
277 int nfs_rmdir(struct inode
*, struct dentry
*);
278 int nfs_unlink(struct inode
*, struct dentry
*);
279 int nfs_symlink(struct inode
*, struct dentry
*, const char *);
280 int nfs_link(struct dentry
*, struct inode
*, struct dentry
*);
281 int nfs_mknod(struct inode
*, struct dentry
*, umode_t
, dev_t
);
282 int nfs_rename(struct inode
*, struct dentry
*, struct inode
*, struct dentry
*);
285 int nfs_file_fsync_commit(struct file
*, loff_t
, loff_t
, int);
286 loff_t
nfs_file_llseek(struct file
*, loff_t
, int);
287 int nfs_file_flush(struct file
*, fl_owner_t
);
288 ssize_t
nfs_file_read(struct kiocb
*, const struct iovec
*, unsigned long, loff_t
);
289 ssize_t
nfs_file_splice_read(struct file
*, loff_t
*, struct pipe_inode_info
*,
290 size_t, unsigned int);
291 int nfs_file_mmap(struct file
*, struct vm_area_struct
*);
292 ssize_t
nfs_file_write(struct kiocb
*, const struct iovec
*, unsigned long, loff_t
);
293 int nfs_file_release(struct inode
*, struct file
*);
294 int nfs_lock(struct file
*, int, struct file_lock
*);
295 int nfs_flock(struct file
*, int, struct file_lock
*);
296 ssize_t
nfs_file_splice_write(struct pipe_inode_info
*, struct file
*, loff_t
*,
297 size_t, unsigned int);
298 int nfs_check_flags(int);
299 int nfs_setlease(struct file
*, long, struct file_lock
**);
302 extern struct workqueue_struct
*nfsiod_workqueue
;
303 extern struct inode
*nfs_alloc_inode(struct super_block
*sb
);
304 extern void nfs_destroy_inode(struct inode
*);
305 extern int nfs_write_inode(struct inode
*, struct writeback_control
*);
306 extern int nfs_drop_inode(struct inode
*);
307 extern void nfs_clear_inode(struct inode
*);
308 extern void nfs_evict_inode(struct inode
*);
309 void nfs_zap_acl_cache(struct inode
*inode
);
310 extern int nfs_wait_bit_killable(void *word
);
313 extern const struct super_operations nfs_sops
;
314 extern struct file_system_type nfs_fs_type
;
315 extern struct file_system_type nfs_xdev_fs_type
;
316 #if IS_ENABLED(CONFIG_NFS_V4)
317 extern struct file_system_type nfs4_xdev_fs_type
;
318 extern struct file_system_type nfs4_referral_fs_type
;
320 struct dentry
*nfs_try_mount(int, const char *, struct nfs_mount_info
*,
321 struct nfs_subversion
*);
322 void nfs_initialise_sb(struct super_block
*);
323 int nfs_set_sb_security(struct super_block
*, struct dentry
*, struct nfs_mount_info
*);
324 int nfs_clone_sb_security(struct super_block
*, struct dentry
*, struct nfs_mount_info
*);
325 struct dentry
*nfs_fs_mount_common(struct nfs_server
*, int, const char *,
326 struct nfs_mount_info
*, struct nfs_subversion
*);
327 struct dentry
*nfs_fs_mount(struct file_system_type
*, int, const char *, void *);
328 struct dentry
* nfs_xdev_mount_common(struct file_system_type
*, int,
329 const char *, struct nfs_mount_info
*);
330 void nfs_kill_super(struct super_block
*);
331 void nfs_fill_super(struct super_block
*, struct nfs_mount_info
*);
333 extern struct rpc_stat nfs_rpcstat
;
335 extern int __init
register_nfs_fs(void);
336 extern void __exit
unregister_nfs_fs(void);
337 extern void nfs_sb_active(struct super_block
*sb
);
338 extern void nfs_sb_deactive(struct super_block
*sb
);
341 #define NFS_PATH_CANONICAL 1
342 extern char *nfs_path(char **p
, struct dentry
*dentry
,
343 char *buffer
, ssize_t buflen
, unsigned flags
);
344 extern struct vfsmount
*nfs_d_automount(struct path
*path
);
345 struct vfsmount
*nfs_submount(struct nfs_server
*, struct dentry
*,
346 struct nfs_fh
*, struct nfs_fattr
*);
347 struct vfsmount
*nfs_do_submount(struct dentry
*, struct nfs_fh
*,
348 struct nfs_fattr
*, rpc_authflavor_t
);
351 extern struct dentry
*nfs_get_root(struct super_block
*, struct nfs_fh
*,
353 #if IS_ENABLED(CONFIG_NFS_V4)
354 extern struct dentry
*nfs4_get_root(struct super_block
*, struct nfs_fh
*,
357 extern int nfs4_get_rootfh(struct nfs_server
*server
, struct nfs_fh
*mntfh
);
360 struct nfs_pgio_completion_ops
;
362 extern struct nfs_read_header
*nfs_readhdr_alloc(void);
363 extern void nfs_readhdr_free(struct nfs_pgio_header
*hdr
);
364 extern void nfs_pageio_init_read(struct nfs_pageio_descriptor
*pgio
,
366 const struct nfs_pgio_completion_ops
*compl_ops
);
367 extern int nfs_initiate_read(struct rpc_clnt
*clnt
,
368 struct nfs_read_data
*data
,
369 const struct rpc_call_ops
*call_ops
, int flags
);
370 extern void nfs_read_prepare(struct rpc_task
*task
, void *calldata
);
371 extern int nfs_generic_pagein(struct nfs_pageio_descriptor
*desc
,
372 struct nfs_pgio_header
*hdr
);
373 extern void nfs_pageio_reset_read_mds(struct nfs_pageio_descriptor
*pgio
);
374 extern void nfs_readdata_release(struct nfs_read_data
*rdata
);
377 void nfs_clone_super(struct super_block
*, struct nfs_mount_info
*);
378 void nfs_umount_begin(struct super_block
*);
379 int nfs_statfs(struct dentry
*, struct kstatfs
*);
380 int nfs_show_options(struct seq_file
*, struct dentry
*);
381 int nfs_show_devname(struct seq_file
*, struct dentry
*);
382 int nfs_show_path(struct seq_file
*, struct dentry
*);
383 int nfs_show_stats(struct seq_file
*, struct dentry
*);
384 void nfs_put_super(struct super_block
*);
385 int nfs_remount(struct super_block
*sb
, int *flags
, char *raw_data
);
388 extern void nfs_pageio_init_write(struct nfs_pageio_descriptor
*pgio
,
389 struct inode
*inode
, int ioflags
,
390 const struct nfs_pgio_completion_ops
*compl_ops
);
391 extern struct nfs_write_header
*nfs_writehdr_alloc(void);
392 extern void nfs_writehdr_free(struct nfs_pgio_header
*hdr
);
393 extern int nfs_generic_flush(struct nfs_pageio_descriptor
*desc
,
394 struct nfs_pgio_header
*hdr
);
395 extern void nfs_pageio_reset_write_mds(struct nfs_pageio_descriptor
*pgio
);
396 extern void nfs_writedata_release(struct nfs_write_data
*wdata
);
397 extern void nfs_commit_free(struct nfs_commit_data
*p
);
398 extern int nfs_initiate_write(struct rpc_clnt
*clnt
,
399 struct nfs_write_data
*data
,
400 const struct rpc_call_ops
*call_ops
,
402 extern void nfs_write_prepare(struct rpc_task
*task
, void *calldata
);
403 extern void nfs_commit_prepare(struct rpc_task
*task
, void *calldata
);
404 extern int nfs_initiate_commit(struct rpc_clnt
*clnt
,
405 struct nfs_commit_data
*data
,
406 const struct rpc_call_ops
*call_ops
,
408 extern void nfs_init_commit(struct nfs_commit_data
*data
,
409 struct list_head
*head
,
410 struct pnfs_layout_segment
*lseg
,
411 struct nfs_commit_info
*cinfo
);
412 int nfs_scan_commit_list(struct list_head
*src
, struct list_head
*dst
,
413 struct nfs_commit_info
*cinfo
, int max
);
414 int nfs_scan_commit(struct inode
*inode
, struct list_head
*dst
,
415 struct nfs_commit_info
*cinfo
);
416 void nfs_mark_request_commit(struct nfs_page
*req
,
417 struct pnfs_layout_segment
*lseg
,
418 struct nfs_commit_info
*cinfo
);
419 int nfs_generic_commit_list(struct inode
*inode
, struct list_head
*head
,
420 int how
, struct nfs_commit_info
*cinfo
);
421 void nfs_retry_commit(struct list_head
*page_list
,
422 struct pnfs_layout_segment
*lseg
,
423 struct nfs_commit_info
*cinfo
);
424 void nfs_commitdata_release(struct nfs_commit_data
*data
);
425 void nfs_request_add_commit_list(struct nfs_page
*req
, struct list_head
*dst
,
426 struct nfs_commit_info
*cinfo
);
427 void nfs_request_remove_commit_list(struct nfs_page
*req
,
428 struct nfs_commit_info
*cinfo
);
429 void nfs_init_cinfo(struct nfs_commit_info
*cinfo
,
431 struct nfs_direct_req
*dreq
);
433 #ifdef CONFIG_MIGRATION
434 extern int nfs_migrate_page(struct address_space
*,
435 struct page
*, struct page
*, enum migrate_mode
);
437 #define nfs_migrate_page NULL
441 void nfs_init_cinfo_from_dreq(struct nfs_commit_info
*cinfo
,
442 struct nfs_direct_req
*dreq
);
443 static inline void nfs_inode_dio_wait(struct inode
*inode
)
445 inode_dio_wait(inode
);
447 extern ssize_t
nfs_dreq_bytes_left(struct nfs_direct_req
*dreq
);
450 extern void __nfs4_read_done_cb(struct nfs_read_data
*);
451 extern struct nfs_client
*nfs4_init_client(struct nfs_client
*clp
,
452 const struct rpc_timeout
*timeparms
,
454 rpc_authflavor_t authflavour
);
455 extern int nfs40_walk_client_list(struct nfs_client
*clp
,
456 struct nfs_client
**result
,
457 struct rpc_cred
*cred
);
458 extern int nfs41_walk_client_list(struct nfs_client
*clp
,
459 struct nfs_client
**result
,
460 struct rpc_cred
*cred
);
463 * Determine the device name as a string
465 static inline char *nfs_devname(struct dentry
*dentry
,
466 char *buffer
, ssize_t buflen
)
469 return nfs_path(&dummy
, dentry
, buffer
, buflen
, NFS_PATH_CANONICAL
);
473 * Determine the actual block size (and log2 thereof)
476 unsigned long nfs_block_bits(unsigned long bsize
, unsigned char *nrbitsp
)
478 /* make sure blocksize is a power of two */
479 if ((bsize
& (bsize
- 1)) || nrbitsp
) {
480 unsigned char nrbits
;
482 for (nrbits
= 31; nrbits
&& !(bsize
& (1 << nrbits
)); nrbits
--)
493 * Calculate the number of 512byte blocks used.
495 static inline blkcnt_t
nfs_calc_block_size(u64 tsize
)
497 blkcnt_t used
= (tsize
+ 511) >> 9;
498 return (used
> ULONG_MAX
) ? ULONG_MAX
: used
;
502 * Compute and set NFS server blocksize
505 unsigned long nfs_block_size(unsigned long bsize
, unsigned char *nrbitsp
)
507 if (bsize
< NFS_MIN_FILE_IO_SIZE
)
508 bsize
= NFS_DEF_FILE_IO_SIZE
;
509 else if (bsize
>= NFS_MAX_FILE_IO_SIZE
)
510 bsize
= NFS_MAX_FILE_IO_SIZE
;
512 return nfs_block_bits(bsize
, nrbitsp
);
516 * Determine the maximum file size for a superblock
519 void nfs_super_set_maxbytes(struct super_block
*sb
, __u64 maxfilesize
)
521 sb
->s_maxbytes
= (loff_t
)maxfilesize
;
522 if (sb
->s_maxbytes
> MAX_LFS_FILESIZE
|| sb
->s_maxbytes
<= 0)
523 sb
->s_maxbytes
= MAX_LFS_FILESIZE
;
527 * Determine the number of bytes of data the page contains
530 unsigned int nfs_page_length(struct page
*page
)
532 loff_t i_size
= i_size_read(page_file_mapping(page
)->host
);
535 pgoff_t page_index
= page_file_index(page
);
536 pgoff_t end_index
= (i_size
- 1) >> PAGE_CACHE_SHIFT
;
537 if (page_index
< end_index
)
538 return PAGE_CACHE_SIZE
;
539 if (page_index
== end_index
)
540 return ((i_size
- 1) & ~PAGE_CACHE_MASK
) + 1;
546 * Convert a umode to a dirent->d_type
549 unsigned char nfs_umode_to_dtype(umode_t mode
)
551 return (mode
>> 12) & 15;
555 * Determine the number of pages in an array of length 'len' and
556 * with a base offset of 'base'
559 unsigned int nfs_page_array_len(unsigned int base
, size_t len
)
561 return ((unsigned long)len
+ (unsigned long)base
+
562 PAGE_SIZE
- 1) >> PAGE_SHIFT
;
566 * Convert a struct timespec into a 64-bit change attribute
568 * This does approximately the same thing as timespec_to_ns(),
569 * but for calculation efficiency, we multiply the seconds by
573 u64
nfs_timespec_to_change_attr(const struct timespec
*ts
)
575 return ((u64
)ts
->tv_sec
<< 30) + ts
->tv_nsec
;