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
89 * In-kernel mount arguments
91 struct nfs_parsed_mount_data {
95 int acregmin, acregmax,
100 unsigned int auth_flavor_len;
101 rpc_authflavor_t auth_flavors[1];
102 char *client_address;
103 unsigned int version;
104 unsigned int minorversion;
109 struct sockaddr_storage address;
114 unsigned short protocol;
118 struct sockaddr_storage address;
123 unsigned short protocol;
126 struct security_mnt_opts lsm_opts;
131 struct nfs_mount_request {
132 struct sockaddr *sap;
137 unsigned short protocol;
140 unsigned int *auth_flav_len;
141 rpc_authflavor_t *auth_flavs;
145 extern int nfs_mount(struct nfs_mount_request *info);
146 extern void nfs_umount(const struct nfs_mount_request *info);
149 extern const struct rpc_program nfs_program;
150 extern void nfs_clients_init(struct net *net);
152 extern void nfs_cleanup_cb_ident_idr(struct net *);
153 extern void nfs_put_client(struct nfs_client *);
154 extern struct nfs_client *nfs4_find_client_ident(struct net *, int);
155 extern struct nfs_client *
156 nfs4_find_client_sessionid(struct net *, const struct sockaddr *,
157 struct nfs4_sessionid *);
158 extern struct nfs_server *nfs_create_server(
159 const struct nfs_parsed_mount_data *,
161 extern struct nfs_server *nfs4_create_server(
162 const struct nfs_parsed_mount_data *,
164 extern struct nfs_server *nfs4_create_referral_server(struct nfs_clone_mount *,
166 extern void nfs_free_server(struct nfs_server *server);
167 extern struct nfs_server *nfs_clone_server(struct nfs_server *,
171 extern void nfs_mark_client_ready(struct nfs_client *clp, int state);
172 extern struct nfs_client *nfs4_set_ds_client(struct nfs_client* mds_clp,
173 const struct sockaddr *ds_addr,
174 int ds_addrlen, int ds_proto,
175 unsigned int ds_timeo,
176 unsigned int ds_retrans);
177 #ifdef CONFIG_PROC_FS
178 extern int __init nfs_fs_proc_init(void);
179 extern void nfs_fs_proc_exit(void);
181 static inline int nfs_fs_proc_init(void)
185 static inline void nfs_fs_proc_exit(void)
191 extern struct svc_version nfs4_callback_version1;
192 extern struct svc_version nfs4_callback_version4;
194 struct nfs_pageio_descriptor;
196 extern int __init nfs_init_nfspagecache(void);
197 extern void nfs_destroy_nfspagecache(void);
198 extern int __init nfs_init_readpagecache(void);
199 extern void nfs_destroy_readpagecache(void);
200 extern int __init nfs_init_writepagecache(void);
201 extern void nfs_destroy_writepagecache(void);
203 extern int __init nfs_init_directcache(void);
204 extern void nfs_destroy_directcache(void);
205 extern bool nfs_pgarray_set(struct nfs_page_array *p, unsigned int pagecount);
206 extern void nfs_pgheader_init(struct nfs_pageio_descriptor *desc,
207 struct nfs_pgio_header *hdr,
208 void (*release)(struct nfs_pgio_header *hdr));
209 void nfs_set_pgio_error(struct nfs_pgio_header *hdr, int error, loff_t pos);
212 extern struct rpc_procinfo nfs_procedures[];
213 extern int nfs2_decode_dirent(struct xdr_stream *,
214 struct nfs_entry *, int);
217 extern struct rpc_procinfo nfs3_procedures[];
218 extern int nfs3_decode_dirent(struct xdr_stream *,
219 struct nfs_entry *, int);
223 extern int nfs4_decode_dirent(struct xdr_stream *,
224 struct nfs_entry *, int);
226 #ifdef CONFIG_NFS_V4_1
227 extern const u32 nfs41_maxread_overhead;
228 extern const u32 nfs41_maxwrite_overhead;
233 extern struct rpc_procinfo nfs4_procedures[];
236 extern int nfs4_init_ds_session(struct nfs_client *, unsigned long);
239 void nfs_close_context(struct nfs_open_context *ctx, int is_sync);
240 extern struct nfs_client *nfs_init_client(struct nfs_client *clp,
241 const struct rpc_timeout *timeparms,
242 const char *ip_addr, rpc_authflavor_t authflavour);
245 extern int nfs_access_cache_shrinker(struct shrinker *shrink,
246 struct shrink_control *sc);
249 extern struct workqueue_struct *nfsiod_workqueue;
250 extern struct inode *nfs_alloc_inode(struct super_block *sb);
251 extern void nfs_destroy_inode(struct inode *);
252 extern int nfs_write_inode(struct inode *, struct writeback_control *);
253 extern void nfs_evict_inode(struct inode *);
255 extern void nfs4_evict_inode(struct inode *);
257 void nfs_zap_acl_cache(struct inode *inode);
258 extern int nfs_wait_bit_killable(void *word);
261 extern struct file_system_type nfs_xdev_fs_type;
263 extern struct file_system_type nfs4_xdev_fs_type;
264 extern struct file_system_type nfs4_referral_fs_type;
267 extern struct rpc_stat nfs_rpcstat;
269 extern int __init register_nfs_fs(void);
270 extern void __exit unregister_nfs_fs(void);
271 extern void nfs_sb_active(struct super_block *sb);
272 extern void nfs_sb_deactive(struct super_block *sb);
275 extern char *nfs_path(char **p, struct dentry *dentry,
276 char *buffer, ssize_t buflen);
277 extern struct vfsmount *nfs_d_automount(struct path *path);
278 struct vfsmount *nfs_submount(struct nfs_server *, struct dentry *,
279 struct nfs_fh *, struct nfs_fattr *);
280 struct vfsmount *nfs_do_submount(struct dentry *, struct nfs_fh *,
281 struct nfs_fattr *, rpc_authflavor_t);
284 extern struct dentry *nfs_get_root(struct super_block *, struct nfs_fh *,
287 extern struct dentry *nfs4_get_root(struct super_block *, struct nfs_fh *,
290 extern int nfs4_get_rootfh(struct nfs_server *server, struct nfs_fh *mntfh);
293 struct nfs_pgio_completion_ops;
295 extern struct nfs_read_header *nfs_readhdr_alloc(void);
296 extern void nfs_readhdr_free(struct nfs_pgio_header *hdr);
297 extern void nfs_pageio_init_read(struct nfs_pageio_descriptor *pgio,
299 const struct nfs_pgio_completion_ops *compl_ops);
300 extern int nfs_initiate_read(struct rpc_clnt *clnt,
301 struct nfs_read_data *data,
302 const struct rpc_call_ops *call_ops, int flags);
303 extern void nfs_read_prepare(struct rpc_task *task, void *calldata);
304 extern int nfs_generic_pagein(struct nfs_pageio_descriptor *desc,
305 struct nfs_pgio_header *hdr);
306 extern void nfs_pageio_init_read_mds(struct nfs_pageio_descriptor *pgio,
308 const struct nfs_pgio_completion_ops *compl_ops);
309 extern void nfs_pageio_reset_read_mds(struct nfs_pageio_descriptor *pgio);
310 extern void nfs_readdata_release(struct nfs_read_data *rdata);
313 extern void nfs_pageio_init_write(struct nfs_pageio_descriptor *pgio,
314 struct inode *inode, int ioflags,
315 const struct nfs_pgio_completion_ops *compl_ops);
316 extern struct nfs_write_header *nfs_writehdr_alloc(void);
317 extern void nfs_writehdr_free(struct nfs_pgio_header *hdr);
318 extern int nfs_generic_flush(struct nfs_pageio_descriptor *desc,
319 struct nfs_pgio_header *hdr);
320 extern void nfs_pageio_init_write_mds(struct nfs_pageio_descriptor *pgio,
321 struct inode *inode, int ioflags,
322 const struct nfs_pgio_completion_ops *compl_ops);
323 extern void nfs_pageio_reset_write_mds(struct nfs_pageio_descriptor *pgio);
324 extern void nfs_writedata_release(struct nfs_write_data *wdata);
325 extern void nfs_commit_free(struct nfs_commit_data *p);
326 extern int nfs_initiate_write(struct rpc_clnt *clnt,
327 struct nfs_write_data *data,
328 const struct rpc_call_ops *call_ops,
330 extern void nfs_write_prepare(struct rpc_task *task, void *calldata);
331 extern void nfs_commit_prepare(struct rpc_task *task, void *calldata);
332 extern int nfs_initiate_commit(struct rpc_clnt *clnt,
333 struct nfs_commit_data *data,
334 const struct rpc_call_ops *call_ops,
336 extern void nfs_init_commit(struct nfs_commit_data *data,
337 struct list_head *head,
338 struct pnfs_layout_segment *lseg,
339 struct nfs_commit_info *cinfo);
340 int nfs_scan_commit_list(struct list_head *src, struct list_head *dst,
341 struct nfs_commit_info *cinfo, int max);
342 int nfs_scan_commit(struct inode *inode, struct list_head *dst,
343 struct nfs_commit_info *cinfo);
344 void nfs_mark_request_commit(struct nfs_page *req,
345 struct pnfs_layout_segment *lseg,
346 struct nfs_commit_info *cinfo);
347 int nfs_generic_commit_list(struct inode *inode, struct list_head *head,
348 int how, struct nfs_commit_info *cinfo);
349 void nfs_retry_commit(struct list_head *page_list,
350 struct pnfs_layout_segment *lseg,
351 struct nfs_commit_info *cinfo);
352 void nfs_commitdata_release(struct nfs_commit_data *data);
353 void nfs_request_add_commit_list(struct nfs_page *req, struct list_head *dst,
354 struct nfs_commit_info *cinfo);
355 void nfs_request_remove_commit_list(struct nfs_page *req,
356 struct nfs_commit_info *cinfo);
357 void nfs_init_cinfo(struct nfs_commit_info *cinfo,
359 struct nfs_direct_req *dreq);
361 #ifdef CONFIG_MIGRATION
362 extern int nfs_migrate_page(struct address_space *,
363 struct page *, struct page *, enum migrate_mode);
365 #define nfs_migrate_page NULL
369 void nfs_init_cinfo_from_dreq(struct nfs_commit_info *cinfo,
370 struct nfs_direct_req *dreq);
373 extern void __nfs4_read_done_cb(struct nfs_read_data *);
374 extern struct nfs_client *nfs4_init_client(struct nfs_client *clp,
375 const struct rpc_timeout *timeparms,
377 rpc_authflavor_t authflavour);
378 extern int _nfs4_call_sync(struct rpc_clnt *clnt,
379 struct nfs_server *server,
380 struct rpc_message *msg,
381 struct nfs4_sequence_args *args,
382 struct nfs4_sequence_res *res,
384 extern int _nfs4_call_sync_session(struct rpc_clnt *clnt,
385 struct nfs_server *server,
386 struct rpc_message *msg,
387 struct nfs4_sequence_args *args,
388 struct nfs4_sequence_res *res,
392 * Determine the device name as a string
394 static inline char *nfs_devname(struct dentry *dentry,
395 char *buffer, ssize_t buflen)
398 return nfs_path(&dummy, dentry, buffer, buflen);
402 * Determine the actual block size (and log2 thereof)
405 unsigned long nfs_block_bits(unsigned long bsize, unsigned char *nrbitsp)
407 /* make sure blocksize is a power of two */
408 if ((bsize & (bsize - 1)) || nrbitsp) {
409 unsigned char nrbits;
411 for (nrbits = 31; nrbits && !(bsize & (1 << nrbits)); nrbits--)
422 * Calculate the number of 512byte blocks used.
424 static inline blkcnt_t nfs_calc_block_size(u64 tsize)
426 blkcnt_t used = (tsize + 511) >> 9;
427 return (used > ULONG_MAX) ? ULONG_MAX : used;
431 * Compute and set NFS server blocksize
434 unsigned long nfs_block_size(unsigned long bsize, unsigned char *nrbitsp)
436 if (bsize < NFS_MIN_FILE_IO_SIZE)
437 bsize = NFS_DEF_FILE_IO_SIZE;
438 else if (bsize >= NFS_MAX_FILE_IO_SIZE)
439 bsize = NFS_MAX_FILE_IO_SIZE;
441 return nfs_block_bits(bsize, nrbitsp);
445 * Determine the maximum file size for a superblock
448 void nfs_super_set_maxbytes(struct super_block *sb, __u64 maxfilesize)
450 sb->s_maxbytes = (loff_t)maxfilesize;
451 if (sb->s_maxbytes > MAX_LFS_FILESIZE || sb->s_maxbytes <= 0)
452 sb->s_maxbytes = MAX_LFS_FILESIZE;
456 * Determine the number of bytes of data the page contains
459 unsigned int nfs_page_length(struct page *page)
461 loff_t i_size = i_size_read(page->mapping->host);
464 pgoff_t end_index = (i_size - 1) >> PAGE_CACHE_SHIFT;
465 if (page->index < end_index)
466 return PAGE_CACHE_SIZE;
467 if (page->index == end_index)
468 return ((i_size - 1) & ~PAGE_CACHE_MASK) + 1;
474 * Convert a umode to a dirent->d_type
477 unsigned char nfs_umode_to_dtype(umode_t mode)
479 return (mode >> 12) & 15;
483 * Determine the number of pages in an array of length 'len' and
484 * with a base offset of 'base'
487 unsigned int nfs_page_array_len(unsigned int base, size_t len)
489 return ((unsigned long)len + (unsigned long)base +
490 PAGE_SIZE - 1) >> PAGE_SHIFT;
494 * Convert a struct timespec into a 64-bit change attribute
496 * This does approximately the same thing as timespec_to_ns(),
497 * but for calculation efficiency, we multiply the seconds by
501 u64 nfs_timespec_to_change_attr(const struct timespec *ts)
503 return ((u64)ts->tv_sec << 30) + ts->tv_nsec;