2 * NFS internal definitions
6 #include <linux/mount.h>
7 #include <linux/security.h>
8 #include <linux/crc32.h>
10 #define NFS_MS_MASK (MS_RDONLY|MS_NOSUID|MS_NODEV|MS_NOEXEC|MS_SYNCHRONOUS)
14 /* Maximum number of readahead requests
15 * FIXME: this should really be a sysctl so that users may tune it to suit
16 * their needs. People that do NFS over a slow network, might for
17 * instance want to reduce it to something closer to 1 for improved
18 * interactive response.
20 #define NFS_MAX_READAHEAD (RPC_DEF_SLOT_TABLE - 1)
22 static inline void nfs_attr_check_mountpoint(struct super_block *parent, struct nfs_fattr *fattr)
24 if (!nfs_fsid_equal(&NFS_SB(parent)->fsid, &fattr->fsid))
25 fattr->valid |= NFS_ATTR_FATTR_MOUNTPOINT;
28 static inline int nfs_attr_use_mounted_on_fileid(struct nfs_fattr *fattr)
30 if (((fattr->valid & NFS_ATTR_FATTR_MOUNTED_ON_FILEID) == 0) ||
31 (((fattr->valid & NFS_ATTR_FATTR_MOUNTPOINT) == 0) &&
32 ((fattr->valid & NFS_ATTR_FATTR_V4_REFERRAL) == 0)))
35 fattr->fileid = fattr->mounted_on_fileid;
39 struct nfs_clone_mount {
40 const struct super_block *sb;
41 const struct dentry *dentry;
43 struct nfs_fattr *fattr;
46 struct sockaddr *addr;
48 rpc_authflavor_t authflavor;
52 * Note: RFC 1813 doesn't limit the number of auth flavors that
53 * a server can return, so make something up.
55 #define NFS_MAX_SECFLAVORS (12)
58 * Value used if the user did not specify a port value.
60 #define NFS_UNSPEC_PORT (-1)
63 * Maximum number of pages that readdir can use for creating
64 * a vmapped array of pages.
66 #define NFS_MAX_READDIR_PAGES 8
68 struct nfs_client_initdata {
69 unsigned long init_flags;
71 const struct sockaddr *addr;
73 struct nfs_subversion *nfs_mod;
80 * In-kernel mount arguments
82 struct nfs_parsed_mount_data {
84 unsigned int rsize, wsize;
85 unsigned int timeo, retrans;
86 unsigned int acregmin, acregmax,
91 struct nfs_auth_info auth_info;
92 rpc_authflavor_t selected_flavor;
95 unsigned int minorversion;
100 struct sockaddr_storage address;
105 unsigned short protocol;
109 struct sockaddr_storage address;
114 unsigned short protocol;
117 struct security_mnt_opts lsm_opts;
122 struct nfs_mount_request {
123 struct sockaddr *sap;
128 unsigned short protocol;
131 unsigned int *auth_flav_len;
132 rpc_authflavor_t *auth_flavs;
136 struct nfs_mount_info {
137 void (*fill_super)(struct super_block *, struct nfs_mount_info *);
138 int (*set_security)(struct super_block *, struct dentry *, struct nfs_mount_info *);
139 struct nfs_parsed_mount_data *parsed;
140 struct nfs_clone_mount *cloned;
141 struct nfs_fh *mntfh;
144 extern int nfs_mount(struct nfs_mount_request *info);
145 extern void nfs_umount(const struct nfs_mount_request *info);
148 extern const struct rpc_program nfs_program;
149 extern void nfs_clients_init(struct net *net);
150 extern struct nfs_client *nfs_alloc_client(const struct nfs_client_initdata *);
151 int nfs_create_rpc_client(struct nfs_client *, const struct rpc_timeout *, rpc_authflavor_t);
152 struct nfs_client *nfs_get_client(const struct nfs_client_initdata *,
153 const struct rpc_timeout *, const char *,
155 int nfs_probe_fsinfo(struct nfs_server *server, struct nfs_fh *, struct nfs_fattr *);
156 void nfs_server_insert_lists(struct nfs_server *);
157 void nfs_server_remove_lists(struct nfs_server *);
158 void nfs_init_timeout_values(struct rpc_timeout *, int, unsigned int, unsigned int);
159 int nfs_init_server_rpcclient(struct nfs_server *, const struct rpc_timeout *t,
161 struct nfs_server *nfs_alloc_server(void);
162 void nfs_server_copy_userdata(struct nfs_server *, struct nfs_server *);
164 extern void nfs_cleanup_cb_ident_idr(struct net *);
165 extern void nfs_put_client(struct nfs_client *);
166 extern void nfs_free_client(struct nfs_client *);
167 extern struct nfs_client *nfs4_find_client_ident(struct net *, int);
168 extern struct nfs_client *
169 nfs4_find_client_sessionid(struct net *, const struct sockaddr *,
170 struct nfs4_sessionid *, u32);
171 extern struct nfs_server *nfs_create_server(struct nfs_mount_info *,
172 struct nfs_subversion *);
173 extern struct nfs_server *nfs4_create_server(
174 struct nfs_mount_info *,
175 struct nfs_subversion *);
176 extern struct nfs_server *nfs4_create_referral_server(struct nfs_clone_mount *,
178 extern int nfs4_update_server(struct nfs_server *server, const char *hostname,
179 struct sockaddr *sap, size_t salen,
181 extern void nfs_free_server(struct nfs_server *server);
182 extern struct nfs_server *nfs_clone_server(struct nfs_server *,
186 extern int nfs_wait_client_init_complete(const struct nfs_client *clp);
187 extern void nfs_mark_client_ready(struct nfs_client *clp, int state);
188 extern struct nfs_client *nfs4_set_ds_client(struct nfs_client* mds_clp,
189 const struct sockaddr *ds_addr,
190 int ds_addrlen, int ds_proto,
191 unsigned int ds_timeo,
192 unsigned int ds_retrans);
193 extern struct rpc_clnt *nfs4_find_or_create_ds_client(struct nfs_client *,
195 #ifdef CONFIG_PROC_FS
196 extern int __init nfs_fs_proc_init(void);
197 extern void nfs_fs_proc_exit(void);
198 extern int nfs_fs_proc_net_init(struct net *net);
199 extern void nfs_fs_proc_net_exit(struct net *net);
201 static inline int nfs_fs_proc_net_init(struct net *net)
205 static inline void nfs_fs_proc_net_exit(struct net *net)
208 static inline int nfs_fs_proc_init(void)
212 static inline void nfs_fs_proc_exit(void)
217 #ifdef CONFIG_NFS_V4_1
218 int nfs_sockaddr_match_ipaddr(const struct sockaddr *, const struct sockaddr *);
222 #if IS_ENABLED(CONFIG_NFS_V3)
223 struct nfs_server *nfs3_create_server(struct nfs_mount_info *, struct nfs_subversion *);
224 struct nfs_server *nfs3_clone_server(struct nfs_server *, struct nfs_fh *,
225 struct nfs_fattr *, rpc_authflavor_t);
229 extern struct svc_version nfs4_callback_version1;
230 extern struct svc_version nfs4_callback_version4;
232 struct nfs_pageio_descriptor;
234 extern int __init nfs_init_nfspagecache(void);
235 extern void nfs_destroy_nfspagecache(void);
236 extern int __init nfs_init_readpagecache(void);
237 extern void nfs_destroy_readpagecache(void);
238 extern int __init nfs_init_writepagecache(void);
239 extern void nfs_destroy_writepagecache(void);
241 extern int __init nfs_init_directcache(void);
242 extern void nfs_destroy_directcache(void);
243 extern void nfs_pgheader_init(struct nfs_pageio_descriptor *desc,
244 struct nfs_pgio_header *hdr,
245 void (*release)(struct nfs_pgio_header *hdr));
246 void nfs_set_pgio_error(struct nfs_pgio_header *hdr, int error, loff_t pos);
247 int nfs_iocounter_wait(struct nfs_io_counter *c);
249 extern const struct nfs_pageio_ops nfs_pgio_rw_ops;
250 struct nfs_pgio_header *nfs_pgio_header_alloc(const struct nfs_rw_ops *);
251 void nfs_pgio_header_free(struct nfs_pgio_header *);
252 void nfs_pgio_data_destroy(struct nfs_pgio_header *);
253 int nfs_generic_pgio(struct nfs_pageio_descriptor *, struct nfs_pgio_header *);
254 int nfs_initiate_pgio(struct rpc_clnt *, struct nfs_pgio_header *,
255 const struct rpc_call_ops *, int, int);
256 void nfs_free_request(struct nfs_page *req);
258 static inline void nfs_iocounter_init(struct nfs_io_counter *c)
261 atomic_set(&c->io_count, 0);
265 extern struct rpc_procinfo nfs_procedures[];
266 extern int nfs2_decode_dirent(struct xdr_stream *,
267 struct nfs_entry *, int);
270 extern struct rpc_procinfo nfs3_procedures[];
271 extern int nfs3_decode_dirent(struct xdr_stream *,
272 struct nfs_entry *, int);
275 #if IS_ENABLED(CONFIG_NFS_V4)
276 extern int nfs4_decode_dirent(struct xdr_stream *,
277 struct nfs_entry *, int);
279 #ifdef CONFIG_NFS_V4_1
280 extern const u32 nfs41_maxread_overhead;
281 extern const u32 nfs41_maxwrite_overhead;
282 extern const u32 nfs41_maxgetdevinfo_overhead;
286 #if IS_ENABLED(CONFIG_NFS_V4)
287 extern struct rpc_procinfo nfs4_procedures[];
290 #ifdef CONFIG_NFS_V4_SECURITY_LABEL
291 extern struct nfs4_label *nfs4_label_alloc(struct nfs_server *server, gfp_t flags);
292 static inline void nfs4_label_free(struct nfs4_label *label)
301 static inline void nfs_zap_label_cache_locked(struct nfs_inode *nfsi)
303 if (nfs_server_capable(&nfsi->vfs_inode, NFS_CAP_SECURITY_LABEL))
304 nfsi->cache_validity |= NFS_INO_INVALID_LABEL;
307 static inline struct nfs4_label *nfs4_label_alloc(struct nfs_server *server, gfp_t flags) { return NULL; }
308 static inline void nfs4_label_free(void *label) {}
309 static inline void nfs_zap_label_cache_locked(struct nfs_inode *nfsi)
312 #endif /* CONFIG_NFS_V4_SECURITY_LABEL */
315 void nfs_close_context(struct nfs_open_context *ctx, int is_sync);
316 extern struct nfs_client *nfs_init_client(struct nfs_client *clp,
317 const struct rpc_timeout *timeparms,
318 const char *ip_addr);
321 extern void nfs_force_use_readdirplus(struct inode *dir);
322 extern unsigned long nfs_access_cache_count(struct shrinker *shrink,
323 struct shrink_control *sc);
324 extern unsigned long nfs_access_cache_scan(struct shrinker *shrink,
325 struct shrink_control *sc);
326 struct dentry *nfs_lookup(struct inode *, struct dentry *, unsigned int);
327 int nfs_create(struct inode *, struct dentry *, umode_t, bool);
328 int nfs_mkdir(struct inode *, struct dentry *, umode_t);
329 int nfs_rmdir(struct inode *, struct dentry *);
330 int nfs_unlink(struct inode *, struct dentry *);
331 int nfs_symlink(struct inode *, struct dentry *, const char *);
332 int nfs_link(struct dentry *, struct inode *, struct dentry *);
333 int nfs_mknod(struct inode *, struct dentry *, umode_t, dev_t);
334 int nfs_rename(struct inode *, struct dentry *, struct inode *, struct dentry *);
337 int nfs_file_fsync_commit(struct file *, loff_t, loff_t, int);
338 loff_t nfs_file_llseek(struct file *, loff_t, int);
339 int nfs_file_flush(struct file *, fl_owner_t);
340 ssize_t nfs_file_read(struct kiocb *, struct iov_iter *);
341 ssize_t nfs_file_splice_read(struct file *, loff_t *, struct pipe_inode_info *,
342 size_t, unsigned int);
343 int nfs_file_mmap(struct file *, struct vm_area_struct *);
344 ssize_t nfs_file_write(struct kiocb *, struct iov_iter *);
345 int nfs_file_release(struct inode *, struct file *);
346 int nfs_lock(struct file *, int, struct file_lock *);
347 int nfs_flock(struct file *, int, struct file_lock *);
348 int nfs_check_flags(int);
351 extern struct workqueue_struct *nfsiod_workqueue;
352 extern struct inode *nfs_alloc_inode(struct super_block *sb);
353 extern void nfs_destroy_inode(struct inode *);
354 extern int nfs_write_inode(struct inode *, struct writeback_control *);
355 extern int nfs_drop_inode(struct inode *);
356 extern void nfs_clear_inode(struct inode *);
357 extern void nfs_evict_inode(struct inode *);
358 void nfs_zap_acl_cache(struct inode *inode);
359 extern int nfs_wait_bit_killable(struct wait_bit_key *key);
362 extern const struct super_operations nfs_sops;
363 extern struct file_system_type nfs_fs_type;
364 extern struct file_system_type nfs_xdev_fs_type;
365 #if IS_ENABLED(CONFIG_NFS_V4)
366 extern struct file_system_type nfs4_xdev_fs_type;
367 extern struct file_system_type nfs4_referral_fs_type;
369 bool nfs_auth_info_match(const struct nfs_auth_info *, rpc_authflavor_t);
370 struct dentry *nfs_try_mount(int, const char *, struct nfs_mount_info *,
371 struct nfs_subversion *);
372 void nfs_initialise_sb(struct super_block *);
373 int nfs_set_sb_security(struct super_block *, struct dentry *, struct nfs_mount_info *);
374 int nfs_clone_sb_security(struct super_block *, struct dentry *, struct nfs_mount_info *);
375 struct dentry *nfs_fs_mount_common(struct nfs_server *, int, const char *,
376 struct nfs_mount_info *, struct nfs_subversion *);
377 struct dentry *nfs_fs_mount(struct file_system_type *, int, const char *, void *);
378 struct dentry * nfs_xdev_mount_common(struct file_system_type *, int,
379 const char *, struct nfs_mount_info *);
380 void nfs_kill_super(struct super_block *);
381 void nfs_fill_super(struct super_block *, struct nfs_mount_info *);
383 extern struct rpc_stat nfs_rpcstat;
385 extern int __init register_nfs_fs(void);
386 extern void __exit unregister_nfs_fs(void);
387 extern void nfs_sb_active(struct super_block *sb);
388 extern void nfs_sb_deactive(struct super_block *sb);
391 #define NFS_PATH_CANONICAL 1
392 extern char *nfs_path(char **p, struct dentry *dentry,
393 char *buffer, ssize_t buflen, unsigned flags);
394 extern struct vfsmount *nfs_d_automount(struct path *path);
395 struct vfsmount *nfs_submount(struct nfs_server *, struct dentry *,
396 struct nfs_fh *, struct nfs_fattr *);
397 struct vfsmount *nfs_do_submount(struct dentry *, struct nfs_fh *,
398 struct nfs_fattr *, rpc_authflavor_t);
401 extern struct dentry *nfs_get_root(struct super_block *, struct nfs_fh *,
403 #if IS_ENABLED(CONFIG_NFS_V4)
404 extern struct dentry *nfs4_get_root(struct super_block *, struct nfs_fh *,
407 extern int nfs4_get_rootfh(struct nfs_server *server, struct nfs_fh *mntfh, bool);
410 struct nfs_pgio_completion_ops;
412 extern void nfs_pageio_init_read(struct nfs_pageio_descriptor *pgio,
413 struct inode *inode, bool force_mds,
414 const struct nfs_pgio_completion_ops *compl_ops);
415 extern void nfs_read_prepare(struct rpc_task *task, void *calldata);
416 extern void nfs_pageio_reset_read_mds(struct nfs_pageio_descriptor *pgio);
419 void nfs_clone_super(struct super_block *, struct nfs_mount_info *);
420 void nfs_umount_begin(struct super_block *);
421 int nfs_statfs(struct dentry *, struct kstatfs *);
422 int nfs_show_options(struct seq_file *, struct dentry *);
423 int nfs_show_devname(struct seq_file *, struct dentry *);
424 int nfs_show_path(struct seq_file *, struct dentry *);
425 int nfs_show_stats(struct seq_file *, struct dentry *);
426 void nfs_put_super(struct super_block *);
427 int nfs_remount(struct super_block *sb, int *flags, char *raw_data);
430 extern void nfs_pageio_init_write(struct nfs_pageio_descriptor *pgio,
431 struct inode *inode, int ioflags, bool force_mds,
432 const struct nfs_pgio_completion_ops *compl_ops);
433 extern void nfs_pageio_reset_write_mds(struct nfs_pageio_descriptor *pgio);
434 extern void nfs_commit_free(struct nfs_commit_data *p);
435 extern void nfs_write_prepare(struct rpc_task *task, void *calldata);
436 extern void nfs_commit_prepare(struct rpc_task *task, void *calldata);
437 extern int nfs_initiate_commit(struct rpc_clnt *clnt,
438 struct nfs_commit_data *data,
439 const struct rpc_call_ops *call_ops,
441 extern void nfs_init_commit(struct nfs_commit_data *data,
442 struct list_head *head,
443 struct pnfs_layout_segment *lseg,
444 struct nfs_commit_info *cinfo);
445 int nfs_scan_commit_list(struct list_head *src, struct list_head *dst,
446 struct nfs_commit_info *cinfo, int max);
447 unsigned long nfs_reqs_to_commit(struct nfs_commit_info *);
448 int nfs_scan_commit(struct inode *inode, struct list_head *dst,
449 struct nfs_commit_info *cinfo);
450 void nfs_mark_request_commit(struct nfs_page *req,
451 struct pnfs_layout_segment *lseg,
452 struct nfs_commit_info *cinfo);
453 int nfs_write_need_commit(struct nfs_pgio_header *);
454 int nfs_generic_commit_list(struct inode *inode, struct list_head *head,
455 int how, struct nfs_commit_info *cinfo);
456 void nfs_retry_commit(struct list_head *page_list,
457 struct pnfs_layout_segment *lseg,
458 struct nfs_commit_info *cinfo);
459 void nfs_commitdata_release(struct nfs_commit_data *data);
460 void nfs_request_add_commit_list(struct nfs_page *req, struct list_head *dst,
461 struct nfs_commit_info *cinfo);
462 void nfs_request_remove_commit_list(struct nfs_page *req,
463 struct nfs_commit_info *cinfo);
464 void nfs_init_cinfo(struct nfs_commit_info *cinfo,
466 struct nfs_direct_req *dreq);
467 int nfs_key_timeout_notify(struct file *filp, struct inode *inode);
468 bool nfs_ctx_key_to_expire(struct nfs_open_context *ctx);
470 #ifdef CONFIG_MIGRATION
471 extern int nfs_migrate_page(struct address_space *,
472 struct page *, struct page *, enum migrate_mode);
474 #define nfs_migrate_page NULL
478 extern struct rpc_task *
479 nfs_async_rename(struct inode *old_dir, struct inode *new_dir,
480 struct dentry *old_dentry, struct dentry *new_dentry,
481 void (*complete)(struct rpc_task *, struct nfs_renamedata *));
482 extern int nfs_sillyrename(struct inode *dir, struct dentry *dentry);
485 void nfs_init_cinfo_from_dreq(struct nfs_commit_info *cinfo,
486 struct nfs_direct_req *dreq);
487 static inline void nfs_inode_dio_wait(struct inode *inode)
489 inode_dio_wait(inode);
491 extern ssize_t nfs_dreq_bytes_left(struct nfs_direct_req *dreq);
494 extern void __nfs4_read_done_cb(struct nfs_pgio_header *);
495 extern struct nfs_client *nfs4_init_client(struct nfs_client *clp,
496 const struct rpc_timeout *timeparms,
497 const char *ip_addr);
498 extern int nfs40_walk_client_list(struct nfs_client *clp,
499 struct nfs_client **result,
500 struct rpc_cred *cred);
501 extern int nfs41_walk_client_list(struct nfs_client *clp,
502 struct nfs_client **result,
503 struct rpc_cred *cred);
506 * Determine the device name as a string
508 static inline char *nfs_devname(struct dentry *dentry,
509 char *buffer, ssize_t buflen)
512 return nfs_path(&dummy, dentry, buffer, buflen, NFS_PATH_CANONICAL);
516 * Determine the actual block size (and log2 thereof)
519 unsigned long nfs_block_bits(unsigned long bsize, unsigned char *nrbitsp)
521 /* make sure blocksize is a power of two */
522 if ((bsize & (bsize - 1)) || nrbitsp) {
523 unsigned char nrbits;
525 for (nrbits = 31; nrbits && !(bsize & (1 << nrbits)); nrbits--)
536 * Calculate the number of 512byte blocks used.
538 static inline blkcnt_t nfs_calc_block_size(u64 tsize)
540 blkcnt_t used = (tsize + 511) >> 9;
541 return (used > ULONG_MAX) ? ULONG_MAX : used;
545 * Compute and set NFS server blocksize
548 unsigned long nfs_block_size(unsigned long bsize, unsigned char *nrbitsp)
550 if (bsize < NFS_MIN_FILE_IO_SIZE)
551 bsize = NFS_DEF_FILE_IO_SIZE;
552 else if (bsize >= NFS_MAX_FILE_IO_SIZE)
553 bsize = NFS_MAX_FILE_IO_SIZE;
555 return nfs_block_bits(bsize, nrbitsp);
559 * Determine the maximum file size for a superblock
562 void nfs_super_set_maxbytes(struct super_block *sb, __u64 maxfilesize)
564 sb->s_maxbytes = (loff_t)maxfilesize;
565 if (sb->s_maxbytes > MAX_LFS_FILESIZE || sb->s_maxbytes <= 0)
566 sb->s_maxbytes = MAX_LFS_FILESIZE;
570 * Determine the number of bytes of data the page contains
573 unsigned int nfs_page_length(struct page *page)
575 loff_t i_size = i_size_read(page_file_mapping(page)->host);
578 pgoff_t page_index = page_file_index(page);
579 pgoff_t end_index = (i_size - 1) >> PAGE_CACHE_SHIFT;
580 if (page_index < end_index)
581 return PAGE_CACHE_SIZE;
582 if (page_index == end_index)
583 return ((i_size - 1) & ~PAGE_CACHE_MASK) + 1;
589 * Convert a umode to a dirent->d_type
592 unsigned char nfs_umode_to_dtype(umode_t mode)
594 return (mode >> 12) & 15;
598 * Determine the number of pages in an array of length 'len' and
599 * with a base offset of 'base'
602 unsigned int nfs_page_array_len(unsigned int base, size_t len)
604 return ((unsigned long)len + (unsigned long)base +
605 PAGE_SIZE - 1) >> PAGE_SHIFT;
609 * Convert a struct timespec into a 64-bit change attribute
611 * This does approximately the same thing as timespec_to_ns(),
612 * but for calculation efficiency, we multiply the seconds by
616 u64 nfs_timespec_to_change_attr(const struct timespec *ts)
618 return ((u64)ts->tv_sec << 30) + ts->tv_nsec;
623 * nfs_fhandle_hash - calculate the crc32 hash for the filehandle
624 * @fh - pointer to filehandle
626 * returns a crc32 hash for the filehandle that is compatible with
627 * the one displayed by "wireshark".
629 static inline u32 nfs_fhandle_hash(const struct nfs_fh *fh)
631 return ~crc32_le(0xFFFFFFFF, &fh->data[0], fh->size);
634 static inline u32 nfs_fhandle_hash(const struct nfs_fh *fh)