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)
22 * Determine if sessions are in use.
24 static inline int nfs4_has_session(const struct nfs_client *clp)
26 #ifdef CONFIG_NFS_V4_1
29 #endif /* CONFIG_NFS_V4_1 */
33 static inline int nfs4_has_persistent_session(const struct nfs_client *clp)
35 #ifdef CONFIG_NFS_V4_1
36 if (nfs4_has_session(clp))
37 return (clp->cl_session->flags & SESSION4_PERSIST);
38 #endif /* CONFIG_NFS_V4_1 */
42 static inline void nfs_attr_check_mountpoint(struct super_block *parent, struct nfs_fattr *fattr)
44 if (!nfs_fsid_equal(&NFS_SB(parent)->fsid, &fattr->fsid))
45 fattr->valid |= NFS_ATTR_FATTR_MOUNTPOINT;
48 static inline int nfs_attr_use_mounted_on_fileid(struct nfs_fattr *fattr)
50 if (((fattr->valid & NFS_ATTR_FATTR_MOUNTED_ON_FILEID) == 0) ||
51 (((fattr->valid & NFS_ATTR_FATTR_MOUNTPOINT) == 0) &&
52 ((fattr->valid & NFS_ATTR_FATTR_V4_REFERRAL) == 0)))
55 fattr->fileid = fattr->mounted_on_fileid;
59 struct nfs_clone_mount {
60 const struct super_block *sb;
61 const struct dentry *dentry;
63 struct nfs_fattr *fattr;
66 struct sockaddr *addr;
68 rpc_authflavor_t authflavor;
72 * Note: RFC 1813 doesn't limit the number of auth flavors that
73 * a server can return, so make something up.
75 #define NFS_MAX_SECFLAVORS (12)
78 * Value used if the user did not specify a port value.
80 #define NFS_UNSPEC_PORT (-1)
83 * Maximum number of pages that readdir can use for creating
84 * a vmapped array of pages.
86 #define NFS_MAX_READDIR_PAGES 8
88 struct nfs_client_initdata {
89 unsigned long init_flags;
91 const struct sockaddr *addr;
93 const struct nfs_rpc_ops *rpc_ops;
100 * In-kernel mount arguments
102 struct nfs_parsed_mount_data {
106 int acregmin, acregmax,
109 unsigned int options;
111 unsigned int auth_flavor_len;
112 rpc_authflavor_t auth_flavors[1];
113 char *client_address;
114 unsigned int version;
115 unsigned int minorversion;
120 struct sockaddr_storage address;
125 unsigned short protocol;
129 struct sockaddr_storage address;
134 unsigned short protocol;
137 struct security_mnt_opts lsm_opts;
142 struct nfs_mount_request {
143 struct sockaddr *sap;
148 unsigned short protocol;
151 unsigned int *auth_flav_len;
152 rpc_authflavor_t *auth_flavs;
156 struct nfs_mount_info {
157 void (*fill_super)(struct super_block *, struct nfs_mount_info *);
158 int (*set_security)(struct super_block *, struct dentry *, struct nfs_mount_info *);
159 struct nfs_parsed_mount_data *parsed;
160 struct nfs_clone_mount *cloned;
161 struct nfs_fh *mntfh;
164 extern int nfs_mount(struct nfs_mount_request *info);
165 extern void nfs_umount(const struct nfs_mount_request *info);
168 extern const struct rpc_program nfs_program;
169 extern void nfs_clients_init(struct net *net);
170 extern struct nfs_client *nfs_alloc_client(const struct nfs_client_initdata *);
171 int nfs_create_rpc_client(struct nfs_client *, const struct rpc_timeout *, rpc_authflavor_t);
172 struct nfs_client *nfs_get_client(const struct nfs_client_initdata *,
173 const struct rpc_timeout *, const char *,
175 int nfs_probe_fsinfo(struct nfs_server *server, struct nfs_fh *, struct nfs_fattr *);
176 void nfs_server_insert_lists(struct nfs_server *);
177 void nfs_init_timeout_values(struct rpc_timeout *, int, unsigned int, unsigned int);
178 int nfs_init_server_rpcclient(struct nfs_server *, const struct rpc_timeout *t,
180 struct nfs_server *nfs_alloc_server(void);
181 void nfs_server_copy_userdata(struct nfs_server *, struct nfs_server *);
183 extern void nfs_cleanup_cb_ident_idr(struct net *);
184 extern void nfs_put_client(struct nfs_client *);
185 extern void nfs_free_client(struct nfs_client *);
186 extern struct nfs_client *nfs4_find_client_ident(struct net *, int);
187 extern struct nfs_client *
188 nfs4_find_client_sessionid(struct net *, const struct sockaddr *,
189 struct nfs4_sessionid *);
190 extern struct nfs_server *nfs_create_server(
191 const struct nfs_parsed_mount_data *,
193 extern struct nfs_server *nfs4_create_server(
194 const struct nfs_parsed_mount_data *,
196 extern struct nfs_server *nfs4_create_referral_server(struct nfs_clone_mount *,
198 extern void nfs_free_server(struct nfs_server *server);
199 extern struct nfs_server *nfs_clone_server(struct nfs_server *,
203 extern int nfs_wait_client_init_complete(const struct nfs_client *clp);
204 extern void nfs_mark_client_ready(struct nfs_client *clp, int state);
205 extern struct nfs_client *nfs4_set_ds_client(struct nfs_client* mds_clp,
206 const struct sockaddr *ds_addr,
207 int ds_addrlen, int ds_proto,
208 unsigned int ds_timeo,
209 unsigned int ds_retrans);
210 #ifdef CONFIG_PROC_FS
211 extern int __init nfs_fs_proc_init(void);
212 extern void nfs_fs_proc_exit(void);
214 static inline int nfs_fs_proc_init(void)
218 static inline void nfs_fs_proc_exit(void)
223 #ifdef CONFIG_NFS_V4_1
224 int nfs_sockaddr_match_ipaddr(const struct sockaddr *, const struct sockaddr *);
228 extern struct svc_version nfs4_callback_version1;
229 extern struct svc_version nfs4_callback_version4;
231 struct nfs_pageio_descriptor;
233 extern int __init nfs_init_nfspagecache(void);
234 extern void nfs_destroy_nfspagecache(void);
235 extern int __init nfs_init_readpagecache(void);
236 extern void nfs_destroy_readpagecache(void);
237 extern int __init nfs_init_writepagecache(void);
238 extern void nfs_destroy_writepagecache(void);
240 extern int __init nfs_init_directcache(void);
241 extern void nfs_destroy_directcache(void);
242 extern bool nfs_pgarray_set(struct nfs_page_array *p, unsigned int pagecount);
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);
249 extern struct rpc_procinfo nfs_procedures[];
250 extern int nfs2_decode_dirent(struct xdr_stream *,
251 struct nfs_entry *, int);
254 extern struct rpc_procinfo nfs3_procedures[];
255 extern int nfs3_decode_dirent(struct xdr_stream *,
256 struct nfs_entry *, int);
260 extern int nfs4_decode_dirent(struct xdr_stream *,
261 struct nfs_entry *, int);
263 #ifdef CONFIG_NFS_V4_1
264 extern const u32 nfs41_maxread_overhead;
265 extern const u32 nfs41_maxwrite_overhead;
270 extern struct rpc_procinfo nfs4_procedures[];
273 extern int nfs4_init_ds_session(struct nfs_client *, unsigned long);
276 void nfs_close_context(struct nfs_open_context *ctx, int is_sync);
277 extern struct nfs_client *nfs_init_client(struct nfs_client *clp,
278 const struct rpc_timeout *timeparms,
279 const char *ip_addr, rpc_authflavor_t authflavour);
282 extern int nfs_access_cache_shrinker(struct shrinker *shrink,
283 struct shrink_control *sc);
284 struct dentry *nfs_lookup(struct inode *, struct dentry *, unsigned int);
285 int nfs_create(struct inode *, struct dentry *, umode_t, bool);
286 int nfs_mkdir(struct inode *, struct dentry *, umode_t);
287 int nfs_rmdir(struct inode *, struct dentry *);
288 int nfs_unlink(struct inode *, struct dentry *);
289 int nfs_symlink(struct inode *, struct dentry *, const char *);
290 int nfs_link(struct dentry *, struct inode *, struct dentry *);
291 int nfs_mknod(struct inode *, struct dentry *, umode_t, dev_t);
292 int nfs_rename(struct inode *, struct dentry *, struct inode *, struct dentry *);
295 int nfs_file_fsync_commit(struct file *, loff_t, loff_t, int);
296 loff_t nfs_file_llseek(struct file *, loff_t, int);
297 int nfs_file_flush(struct file *, fl_owner_t);
298 ssize_t nfs_file_read(struct kiocb *, const struct iovec *, unsigned long, loff_t);
299 ssize_t nfs_file_splice_read(struct file *, loff_t *, struct pipe_inode_info *,
300 size_t, unsigned int);
301 int nfs_file_mmap(struct file *, struct vm_area_struct *);
302 ssize_t nfs_file_write(struct kiocb *, const struct iovec *, unsigned long, loff_t);
303 int nfs_file_release(struct inode *, struct file *);
304 int nfs_lock(struct file *, int, struct file_lock *);
305 int nfs_flock(struct file *, int, struct file_lock *);
306 ssize_t nfs_file_splice_write(struct pipe_inode_info *, struct file *, loff_t *,
307 size_t, unsigned int);
308 int nfs_check_flags(int);
309 int nfs_setlease(struct file *, long, struct file_lock **);
312 extern struct workqueue_struct *nfsiod_workqueue;
313 extern struct inode *nfs_alloc_inode(struct super_block *sb);
314 extern void nfs_destroy_inode(struct inode *);
315 extern int nfs_write_inode(struct inode *, struct writeback_control *);
316 extern void nfs_evict_inode(struct inode *);
318 extern void nfs4_evict_inode(struct inode *);
320 void nfs_zap_acl_cache(struct inode *inode);
321 extern int nfs_wait_bit_killable(void *word);
324 extern struct file_system_type nfs_xdev_fs_type;
326 extern struct file_system_type nfs4_xdev_fs_type;
327 extern struct file_system_type nfs4_referral_fs_type;
329 void nfs_initialise_sb(struct super_block *);
330 int nfs_set_sb_security(struct super_block *, struct dentry *, struct nfs_mount_info *);
331 int nfs_clone_sb_security(struct super_block *, struct dentry *, struct nfs_mount_info *);
332 struct dentry *nfs_fs_mount_common(struct file_system_type *, struct nfs_server *,
333 int, const char *, struct nfs_mount_info *);
334 struct dentry *nfs_fs_mount(struct file_system_type *, int, const char *, void *);
335 struct dentry * nfs_xdev_mount_common(struct file_system_type *, int,
336 const char *, struct nfs_mount_info *);
337 void nfs_kill_super(struct super_block *);
338 void nfs_fill_super(struct super_block *, struct nfs_mount_info *);
340 extern struct rpc_stat nfs_rpcstat;
342 extern int __init register_nfs_fs(void);
343 extern void __exit unregister_nfs_fs(void);
344 extern void nfs_sb_active(struct super_block *sb);
345 extern void nfs_sb_deactive(struct super_block *sb);
348 extern char *nfs_path(char **p, struct dentry *dentry,
349 char *buffer, ssize_t buflen);
350 extern struct vfsmount *nfs_d_automount(struct path *path);
351 struct vfsmount *nfs_submount(struct nfs_server *, struct dentry *,
352 struct nfs_fh *, struct nfs_fattr *);
353 struct vfsmount *nfs_do_submount(struct dentry *, struct nfs_fh *,
354 struct nfs_fattr *, rpc_authflavor_t);
357 extern struct dentry *nfs_get_root(struct super_block *, struct nfs_fh *,
360 extern struct dentry *nfs4_get_root(struct super_block *, struct nfs_fh *,
363 extern int nfs4_get_rootfh(struct nfs_server *server, struct nfs_fh *mntfh);
366 struct nfs_pgio_completion_ops;
368 extern struct nfs_read_header *nfs_readhdr_alloc(void);
369 extern void nfs_readhdr_free(struct nfs_pgio_header *hdr);
370 extern void nfs_pageio_init_read(struct nfs_pageio_descriptor *pgio,
372 const struct nfs_pgio_completion_ops *compl_ops);
373 extern int nfs_initiate_read(struct rpc_clnt *clnt,
374 struct nfs_read_data *data,
375 const struct rpc_call_ops *call_ops, int flags);
376 extern void nfs_read_prepare(struct rpc_task *task, void *calldata);
377 extern int nfs_generic_pagein(struct nfs_pageio_descriptor *desc,
378 struct nfs_pgio_header *hdr);
379 extern void nfs_pageio_init_read(struct nfs_pageio_descriptor *pgio,
381 const struct nfs_pgio_completion_ops *compl_ops);
382 extern void nfs_pageio_reset_read_mds(struct nfs_pageio_descriptor *pgio);
383 extern void nfs_readdata_release(struct nfs_read_data *rdata);
386 void nfs_clone_super(struct super_block *, struct nfs_mount_info *);
387 void nfs_umount_begin(struct super_block *);
388 int nfs_statfs(struct dentry *, struct kstatfs *);
389 int nfs_show_options(struct seq_file *, struct dentry *);
390 int nfs_show_devname(struct seq_file *, struct dentry *);
391 int nfs_show_path(struct seq_file *, struct dentry *);
392 int nfs_show_stats(struct seq_file *, struct dentry *);
393 void nfs_put_super(struct super_block *);
394 int nfs_remount(struct super_block *sb, int *flags, char *raw_data);
397 extern void nfs_pageio_init_write(struct nfs_pageio_descriptor *pgio,
398 struct inode *inode, int ioflags,
399 const struct nfs_pgio_completion_ops *compl_ops);
400 extern struct nfs_write_header *nfs_writehdr_alloc(void);
401 extern void nfs_writehdr_free(struct nfs_pgio_header *hdr);
402 extern int nfs_generic_flush(struct nfs_pageio_descriptor *desc,
403 struct nfs_pgio_header *hdr);
404 extern void nfs_pageio_init_write(struct nfs_pageio_descriptor *pgio,
405 struct inode *inode, int ioflags,
406 const struct nfs_pgio_completion_ops *compl_ops);
407 extern void nfs_pageio_reset_write_mds(struct nfs_pageio_descriptor *pgio);
408 extern void nfs_writedata_release(struct nfs_write_data *wdata);
409 extern void nfs_commit_free(struct nfs_commit_data *p);
410 extern int nfs_initiate_write(struct rpc_clnt *clnt,
411 struct nfs_write_data *data,
412 const struct rpc_call_ops *call_ops,
414 extern void nfs_write_prepare(struct rpc_task *task, void *calldata);
415 extern void nfs_commit_prepare(struct rpc_task *task, void *calldata);
416 extern int nfs_initiate_commit(struct rpc_clnt *clnt,
417 struct nfs_commit_data *data,
418 const struct rpc_call_ops *call_ops,
420 extern void nfs_init_commit(struct nfs_commit_data *data,
421 struct list_head *head,
422 struct pnfs_layout_segment *lseg,
423 struct nfs_commit_info *cinfo);
424 int nfs_scan_commit_list(struct list_head *src, struct list_head *dst,
425 struct nfs_commit_info *cinfo, int max);
426 int nfs_scan_commit(struct inode *inode, struct list_head *dst,
427 struct nfs_commit_info *cinfo);
428 void nfs_mark_request_commit(struct nfs_page *req,
429 struct pnfs_layout_segment *lseg,
430 struct nfs_commit_info *cinfo);
431 int nfs_generic_commit_list(struct inode *inode, struct list_head *head,
432 int how, struct nfs_commit_info *cinfo);
433 void nfs_retry_commit(struct list_head *page_list,
434 struct pnfs_layout_segment *lseg,
435 struct nfs_commit_info *cinfo);
436 void nfs_commitdata_release(struct nfs_commit_data *data);
437 void nfs_request_add_commit_list(struct nfs_page *req, struct list_head *dst,
438 struct nfs_commit_info *cinfo);
439 void nfs_request_remove_commit_list(struct nfs_page *req,
440 struct nfs_commit_info *cinfo);
441 void nfs_init_cinfo(struct nfs_commit_info *cinfo,
443 struct nfs_direct_req *dreq);
445 #ifdef CONFIG_MIGRATION
446 extern int nfs_migrate_page(struct address_space *,
447 struct page *, struct page *, enum migrate_mode);
449 #define nfs_migrate_page NULL
453 void nfs_init_cinfo_from_dreq(struct nfs_commit_info *cinfo,
454 struct nfs_direct_req *dreq);
455 static inline void nfs_inode_dio_wait(struct inode *inode)
457 inode_dio_wait(inode);
461 extern void __nfs4_read_done_cb(struct nfs_read_data *);
462 extern struct nfs_client *nfs4_init_client(struct nfs_client *clp,
463 const struct rpc_timeout *timeparms,
465 rpc_authflavor_t authflavour);
466 extern int _nfs4_call_sync(struct rpc_clnt *clnt,
467 struct nfs_server *server,
468 struct rpc_message *msg,
469 struct nfs4_sequence_args *args,
470 struct nfs4_sequence_res *res,
472 extern int _nfs4_call_sync_session(struct rpc_clnt *clnt,
473 struct nfs_server *server,
474 struct rpc_message *msg,
475 struct nfs4_sequence_args *args,
476 struct nfs4_sequence_res *res,
480 * Determine the device name as a string
482 static inline char *nfs_devname(struct dentry *dentry,
483 char *buffer, ssize_t buflen)
486 return nfs_path(&dummy, dentry, buffer, buflen);
490 * Determine the actual block size (and log2 thereof)
493 unsigned long nfs_block_bits(unsigned long bsize, unsigned char *nrbitsp)
495 /* make sure blocksize is a power of two */
496 if ((bsize & (bsize - 1)) || nrbitsp) {
497 unsigned char nrbits;
499 for (nrbits = 31; nrbits && !(bsize & (1 << nrbits)); nrbits--)
510 * Calculate the number of 512byte blocks used.
512 static inline blkcnt_t nfs_calc_block_size(u64 tsize)
514 blkcnt_t used = (tsize + 511) >> 9;
515 return (used > ULONG_MAX) ? ULONG_MAX : used;
519 * Compute and set NFS server blocksize
522 unsigned long nfs_block_size(unsigned long bsize, unsigned char *nrbitsp)
524 if (bsize < NFS_MIN_FILE_IO_SIZE)
525 bsize = NFS_DEF_FILE_IO_SIZE;
526 else if (bsize >= NFS_MAX_FILE_IO_SIZE)
527 bsize = NFS_MAX_FILE_IO_SIZE;
529 return nfs_block_bits(bsize, nrbitsp);
533 * Determine the maximum file size for a superblock
536 void nfs_super_set_maxbytes(struct super_block *sb, __u64 maxfilesize)
538 sb->s_maxbytes = (loff_t)maxfilesize;
539 if (sb->s_maxbytes > MAX_LFS_FILESIZE || sb->s_maxbytes <= 0)
540 sb->s_maxbytes = MAX_LFS_FILESIZE;
544 * Determine the number of bytes of data the page contains
547 unsigned int nfs_page_length(struct page *page)
549 loff_t i_size = i_size_read(page->mapping->host);
552 pgoff_t end_index = (i_size - 1) >> PAGE_CACHE_SHIFT;
553 if (page->index < end_index)
554 return PAGE_CACHE_SIZE;
555 if (page->index == end_index)
556 return ((i_size - 1) & ~PAGE_CACHE_MASK) + 1;
562 * Convert a umode to a dirent->d_type
565 unsigned char nfs_umode_to_dtype(umode_t mode)
567 return (mode >> 12) & 15;
571 * Determine the number of pages in an array of length 'len' and
572 * with a base offset of 'base'
575 unsigned int nfs_page_array_len(unsigned int base, size_t len)
577 return ((unsigned long)len + (unsigned long)base +
578 PAGE_SIZE - 1) >> PAGE_SHIFT;
582 * Convert a struct timespec into a 64-bit change attribute
584 * This does approximately the same thing as timespec_to_ns(),
585 * but for calculation efficiency, we multiply the seconds by
589 u64 nfs_timespec_to_change_attr(const struct timespec *ts)
591 return ((u64)ts->tv_sec << 30) + ts->tv_nsec;