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 extern int nfs_mount(struct nfs_mount_request *info);
157 extern void nfs_umount(const struct nfs_mount_request *info);
160 extern const struct rpc_program nfs_program;
161 extern void nfs_clients_init(struct net *net);
162 extern struct nfs_client *nfs_alloc_client(const struct nfs_client_initdata *);
163 int nfs_create_rpc_client(struct nfs_client *, const struct rpc_timeout *, rpc_authflavor_t);
164 struct nfs_client *nfs_get_client(const struct nfs_client_initdata *,
165 const struct rpc_timeout *, const char *,
167 int nfs_probe_fsinfo(struct nfs_server *server, struct nfs_fh *, struct nfs_fattr *);
168 void nfs_server_insert_lists(struct nfs_server *);
169 void nfs_init_timeout_values(struct rpc_timeout *, int, unsigned int, unsigned int);
170 int nfs_init_server_rpcclient(struct nfs_server *, const struct rpc_timeout *t,
172 struct nfs_server *nfs_alloc_server(void);
173 void nfs_server_copy_userdata(struct nfs_server *, struct nfs_server *);
175 extern void nfs_cleanup_cb_ident_idr(struct net *);
176 extern void nfs_put_client(struct nfs_client *);
177 extern void nfs_free_client(struct nfs_client *);
178 extern struct nfs_client *nfs4_find_client_ident(struct net *, int);
179 extern struct nfs_client *
180 nfs4_find_client_sessionid(struct net *, const struct sockaddr *,
181 struct nfs4_sessionid *);
182 extern struct nfs_server *nfs_create_server(
183 const struct nfs_parsed_mount_data *,
185 extern struct nfs_server *nfs4_create_server(
186 const struct nfs_parsed_mount_data *,
188 extern struct nfs_server *nfs4_create_referral_server(struct nfs_clone_mount *,
190 extern void nfs_free_server(struct nfs_server *server);
191 extern struct nfs_server *nfs_clone_server(struct nfs_server *,
195 extern int nfs_wait_client_init_complete(const struct nfs_client *clp);
196 extern void nfs_mark_client_ready(struct nfs_client *clp, int state);
197 extern struct nfs_client *nfs4_set_ds_client(struct nfs_client* mds_clp,
198 const struct sockaddr *ds_addr,
199 int ds_addrlen, int ds_proto,
200 unsigned int ds_timeo,
201 unsigned int ds_retrans);
202 #ifdef CONFIG_PROC_FS
203 extern int __init nfs_fs_proc_init(void);
204 extern void nfs_fs_proc_exit(void);
206 static inline int nfs_fs_proc_init(void)
210 static inline void nfs_fs_proc_exit(void)
215 #ifdef CONFIG_NFS_V4_1
216 int nfs_sockaddr_match_ipaddr(const struct sockaddr *, const struct sockaddr *);
220 extern struct svc_version nfs4_callback_version1;
221 extern struct svc_version nfs4_callback_version4;
223 struct nfs_pageio_descriptor;
225 extern int __init nfs_init_nfspagecache(void);
226 extern void nfs_destroy_nfspagecache(void);
227 extern int __init nfs_init_readpagecache(void);
228 extern void nfs_destroy_readpagecache(void);
229 extern int __init nfs_init_writepagecache(void);
230 extern void nfs_destroy_writepagecache(void);
232 extern int __init nfs_init_directcache(void);
233 extern void nfs_destroy_directcache(void);
234 extern bool nfs_pgarray_set(struct nfs_page_array *p, unsigned int pagecount);
235 extern void nfs_pgheader_init(struct nfs_pageio_descriptor *desc,
236 struct nfs_pgio_header *hdr,
237 void (*release)(struct nfs_pgio_header *hdr));
238 void nfs_set_pgio_error(struct nfs_pgio_header *hdr, int error, loff_t pos);
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);
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;
262 extern struct rpc_procinfo nfs4_procedures[];
265 extern int nfs4_init_ds_session(struct nfs_client *, unsigned long);
268 void nfs_close_context(struct nfs_open_context *ctx, int is_sync);
269 extern struct nfs_client *nfs_init_client(struct nfs_client *clp,
270 const struct rpc_timeout *timeparms,
271 const char *ip_addr, rpc_authflavor_t authflavour);
274 extern int nfs_access_cache_shrinker(struct shrinker *shrink,
275 struct shrink_control *sc);
276 struct dentry *nfs_lookup(struct inode *, struct dentry *, unsigned int);
277 int nfs_create(struct inode *, struct dentry *, umode_t, bool);
278 int nfs_mkdir(struct inode *, struct dentry *, umode_t);
279 int nfs_rmdir(struct inode *, struct dentry *);
280 int nfs_unlink(struct inode *, struct dentry *);
281 int nfs_symlink(struct inode *, struct dentry *, const char *);
282 int nfs_link(struct dentry *, struct inode *, struct dentry *);
283 int nfs_mknod(struct inode *, struct dentry *, umode_t, dev_t);
284 int nfs_rename(struct inode *, struct dentry *, struct inode *, struct dentry *);
287 int nfs_file_fsync_commit(struct file *, loff_t, loff_t, int);
288 loff_t nfs_file_llseek(struct file *, loff_t, int);
289 int nfs_file_flush(struct file *, fl_owner_t);
290 ssize_t nfs_file_read(struct kiocb *, const struct iovec *, unsigned long, loff_t);
291 ssize_t nfs_file_splice_read(struct file *, loff_t *, struct pipe_inode_info *,
292 size_t, unsigned int);
293 int nfs_file_mmap(struct file *, struct vm_area_struct *);
294 ssize_t nfs_file_write(struct kiocb *, const struct iovec *, unsigned long, loff_t);
295 int nfs_file_release(struct inode *, struct file *);
296 int nfs_lock(struct file *, int, struct file_lock *);
297 int nfs_flock(struct file *, int, struct file_lock *);
298 ssize_t nfs_file_splice_write(struct pipe_inode_info *, struct file *, loff_t *,
299 size_t, unsigned int);
300 int nfs_check_flags(int);
301 int nfs_setlease(struct file *, long, struct file_lock **);
304 extern struct workqueue_struct *nfsiod_workqueue;
305 extern struct inode *nfs_alloc_inode(struct super_block *sb);
306 extern void nfs_destroy_inode(struct inode *);
307 extern int nfs_write_inode(struct inode *, struct writeback_control *);
308 extern void nfs_evict_inode(struct inode *);
310 extern void nfs4_evict_inode(struct inode *);
312 void nfs_zap_acl_cache(struct inode *inode);
313 extern int nfs_wait_bit_killable(void *word);
316 extern struct file_system_type nfs_xdev_fs_type;
318 extern struct file_system_type nfs4_xdev_fs_type;
319 extern struct file_system_type nfs4_referral_fs_type;
322 extern struct rpc_stat nfs_rpcstat;
324 extern int __init register_nfs_fs(void);
325 extern void __exit unregister_nfs_fs(void);
326 extern void nfs_sb_active(struct super_block *sb);
327 extern void nfs_sb_deactive(struct super_block *sb);
330 extern char *nfs_path(char **p, struct dentry *dentry,
331 char *buffer, ssize_t buflen);
332 extern struct vfsmount *nfs_d_automount(struct path *path);
333 struct vfsmount *nfs_submount(struct nfs_server *, struct dentry *,
334 struct nfs_fh *, struct nfs_fattr *);
335 struct vfsmount *nfs_do_submount(struct dentry *, struct nfs_fh *,
336 struct nfs_fattr *, rpc_authflavor_t);
339 extern struct dentry *nfs_get_root(struct super_block *, struct nfs_fh *,
342 extern struct dentry *nfs4_get_root(struct super_block *, struct nfs_fh *,
345 extern int nfs4_get_rootfh(struct nfs_server *server, struct nfs_fh *mntfh);
348 struct nfs_pgio_completion_ops;
350 extern struct nfs_read_header *nfs_readhdr_alloc(void);
351 extern void nfs_readhdr_free(struct nfs_pgio_header *hdr);
352 extern void nfs_pageio_init_read(struct nfs_pageio_descriptor *pgio,
354 const struct nfs_pgio_completion_ops *compl_ops);
355 extern int nfs_initiate_read(struct rpc_clnt *clnt,
356 struct nfs_read_data *data,
357 const struct rpc_call_ops *call_ops, int flags);
358 extern void nfs_read_prepare(struct rpc_task *task, void *calldata);
359 extern int nfs_generic_pagein(struct nfs_pageio_descriptor *desc,
360 struct nfs_pgio_header *hdr);
361 extern void nfs_pageio_init_read(struct nfs_pageio_descriptor *pgio,
363 const struct nfs_pgio_completion_ops *compl_ops);
364 extern void nfs_pageio_reset_read_mds(struct nfs_pageio_descriptor *pgio);
365 extern void nfs_readdata_release(struct nfs_read_data *rdata);
368 extern void nfs_pageio_init_write(struct nfs_pageio_descriptor *pgio,
369 struct inode *inode, int ioflags,
370 const struct nfs_pgio_completion_ops *compl_ops);
371 extern struct nfs_write_header *nfs_writehdr_alloc(void);
372 extern void nfs_writehdr_free(struct nfs_pgio_header *hdr);
373 extern int nfs_generic_flush(struct nfs_pageio_descriptor *desc,
374 struct nfs_pgio_header *hdr);
375 extern void nfs_pageio_init_write(struct nfs_pageio_descriptor *pgio,
376 struct inode *inode, int ioflags,
377 const struct nfs_pgio_completion_ops *compl_ops);
378 extern void nfs_pageio_reset_write_mds(struct nfs_pageio_descriptor *pgio);
379 extern void nfs_writedata_release(struct nfs_write_data *wdata);
380 extern void nfs_commit_free(struct nfs_commit_data *p);
381 extern int nfs_initiate_write(struct rpc_clnt *clnt,
382 struct nfs_write_data *data,
383 const struct rpc_call_ops *call_ops,
385 extern void nfs_write_prepare(struct rpc_task *task, void *calldata);
386 extern void nfs_commit_prepare(struct rpc_task *task, void *calldata);
387 extern int nfs_initiate_commit(struct rpc_clnt *clnt,
388 struct nfs_commit_data *data,
389 const struct rpc_call_ops *call_ops,
391 extern void nfs_init_commit(struct nfs_commit_data *data,
392 struct list_head *head,
393 struct pnfs_layout_segment *lseg,
394 struct nfs_commit_info *cinfo);
395 int nfs_scan_commit_list(struct list_head *src, struct list_head *dst,
396 struct nfs_commit_info *cinfo, int max);
397 int nfs_scan_commit(struct inode *inode, struct list_head *dst,
398 struct nfs_commit_info *cinfo);
399 void nfs_mark_request_commit(struct nfs_page *req,
400 struct pnfs_layout_segment *lseg,
401 struct nfs_commit_info *cinfo);
402 int nfs_generic_commit_list(struct inode *inode, struct list_head *head,
403 int how, struct nfs_commit_info *cinfo);
404 void nfs_retry_commit(struct list_head *page_list,
405 struct pnfs_layout_segment *lseg,
406 struct nfs_commit_info *cinfo);
407 void nfs_commitdata_release(struct nfs_commit_data *data);
408 void nfs_request_add_commit_list(struct nfs_page *req, struct list_head *dst,
409 struct nfs_commit_info *cinfo);
410 void nfs_request_remove_commit_list(struct nfs_page *req,
411 struct nfs_commit_info *cinfo);
412 void nfs_init_cinfo(struct nfs_commit_info *cinfo,
414 struct nfs_direct_req *dreq);
416 #ifdef CONFIG_MIGRATION
417 extern int nfs_migrate_page(struct address_space *,
418 struct page *, struct page *, enum migrate_mode);
420 #define nfs_migrate_page NULL
424 void nfs_init_cinfo_from_dreq(struct nfs_commit_info *cinfo,
425 struct nfs_direct_req *dreq);
426 static inline void nfs_inode_dio_wait(struct inode *inode)
428 inode_dio_wait(inode);
432 extern void __nfs4_read_done_cb(struct nfs_read_data *);
433 extern struct nfs_client *nfs4_init_client(struct nfs_client *clp,
434 const struct rpc_timeout *timeparms,
436 rpc_authflavor_t authflavour);
437 extern int _nfs4_call_sync(struct rpc_clnt *clnt,
438 struct nfs_server *server,
439 struct rpc_message *msg,
440 struct nfs4_sequence_args *args,
441 struct nfs4_sequence_res *res,
443 extern int _nfs4_call_sync_session(struct rpc_clnt *clnt,
444 struct nfs_server *server,
445 struct rpc_message *msg,
446 struct nfs4_sequence_args *args,
447 struct nfs4_sequence_res *res,
451 * Determine the device name as a string
453 static inline char *nfs_devname(struct dentry *dentry,
454 char *buffer, ssize_t buflen)
457 return nfs_path(&dummy, dentry, buffer, buflen);
461 * Determine the actual block size (and log2 thereof)
464 unsigned long nfs_block_bits(unsigned long bsize, unsigned char *nrbitsp)
466 /* make sure blocksize is a power of two */
467 if ((bsize & (bsize - 1)) || nrbitsp) {
468 unsigned char nrbits;
470 for (nrbits = 31; nrbits && !(bsize & (1 << nrbits)); nrbits--)
481 * Calculate the number of 512byte blocks used.
483 static inline blkcnt_t nfs_calc_block_size(u64 tsize)
485 blkcnt_t used = (tsize + 511) >> 9;
486 return (used > ULONG_MAX) ? ULONG_MAX : used;
490 * Compute and set NFS server blocksize
493 unsigned long nfs_block_size(unsigned long bsize, unsigned char *nrbitsp)
495 if (bsize < NFS_MIN_FILE_IO_SIZE)
496 bsize = NFS_DEF_FILE_IO_SIZE;
497 else if (bsize >= NFS_MAX_FILE_IO_SIZE)
498 bsize = NFS_MAX_FILE_IO_SIZE;
500 return nfs_block_bits(bsize, nrbitsp);
504 * Determine the maximum file size for a superblock
507 void nfs_super_set_maxbytes(struct super_block *sb, __u64 maxfilesize)
509 sb->s_maxbytes = (loff_t)maxfilesize;
510 if (sb->s_maxbytes > MAX_LFS_FILESIZE || sb->s_maxbytes <= 0)
511 sb->s_maxbytes = MAX_LFS_FILESIZE;
515 * Determine the number of bytes of data the page contains
518 unsigned int nfs_page_length(struct page *page)
520 loff_t i_size = i_size_read(page->mapping->host);
523 pgoff_t end_index = (i_size - 1) >> PAGE_CACHE_SHIFT;
524 if (page->index < end_index)
525 return PAGE_CACHE_SIZE;
526 if (page->index == end_index)
527 return ((i_size - 1) & ~PAGE_CACHE_MASK) + 1;
533 * Convert a umode to a dirent->d_type
536 unsigned char nfs_umode_to_dtype(umode_t mode)
538 return (mode >> 12) & 15;
542 * Determine the number of pages in an array of length 'len' and
543 * with a base offset of 'base'
546 unsigned int nfs_page_array_len(unsigned int base, size_t len)
548 return ((unsigned long)len + (unsigned long)base +
549 PAGE_SIZE - 1) >> PAGE_SHIFT;
553 * Convert a struct timespec into a 64-bit change attribute
555 * This does approximately the same thing as timespec_to_ns(),
556 * but for calculation efficiency, we multiply the seconds by
560 u64 nfs_timespec_to_change_attr(const struct timespec *ts)
562 return ((u64)ts->tv_sec << 30) + ts->tv_nsec;