Loading...
1/*
2 * NFS internal definitions
3 */
4
5#include "nfs4_fs.h"
6#include <linux/mount.h>
7#include <linux/security.h>
8
9#define NFS_MS_MASK (MS_RDONLY|MS_NOSUID|MS_NODEV|MS_NOEXEC|MS_SYNCHRONOUS)
10
11struct nfs_string;
12
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.
18 */
19#define NFS_MAX_READAHEAD (RPC_DEF_SLOT_TABLE - 1)
20
21/*
22 * Determine if sessions are in use.
23 */
24static inline int nfs4_has_session(const struct nfs_client *clp)
25{
26#ifdef CONFIG_NFS_V4_1
27 if (clp->cl_session)
28 return 1;
29#endif /* CONFIG_NFS_V4_1 */
30 return 0;
31}
32
33static inline int nfs4_has_persistent_session(const struct nfs_client *clp)
34{
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 */
39 return 0;
40}
41
42static inline void nfs_attr_check_mountpoint(struct super_block *parent, struct nfs_fattr *fattr)
43{
44 if (!nfs_fsid_equal(&NFS_SB(parent)->fsid, &fattr->fsid))
45 fattr->valid |= NFS_ATTR_FATTR_MOUNTPOINT;
46}
47
48static inline int nfs_attr_use_mounted_on_fileid(struct nfs_fattr *fattr)
49{
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)))
53 return 0;
54
55 fattr->fileid = fattr->mounted_on_fileid;
56 return 1;
57}
58
59struct nfs_clone_mount {
60 const struct super_block *sb;
61 const struct dentry *dentry;
62 struct nfs_fh *fh;
63 struct nfs_fattr *fattr;
64 char *hostname;
65 char *mnt_path;
66 struct sockaddr *addr;
67 size_t addrlen;
68 rpc_authflavor_t authflavor;
69};
70
71/*
72 * Note: RFC 1813 doesn't limit the number of auth flavors that
73 * a server can return, so make something up.
74 */
75#define NFS_MAX_SECFLAVORS (12)
76
77/*
78 * Value used if the user did not specify a port value.
79 */
80#define NFS_UNSPEC_PORT (-1)
81
82/*
83 * Maximum number of pages that readdir can use for creating
84 * a vmapped array of pages.
85 */
86#define NFS_MAX_READDIR_PAGES 8
87
88/*
89 * In-kernel mount arguments
90 */
91struct nfs_parsed_mount_data {
92 int flags;
93 int rsize, wsize;
94 int timeo, retrans;
95 int acregmin, acregmax,
96 acdirmin, acdirmax;
97 int namlen;
98 unsigned int options;
99 unsigned int bsize;
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;
105 char *fscache_uniq;
106 bool need_mount;
107
108 struct {
109 struct sockaddr_storage address;
110 size_t addrlen;
111 char *hostname;
112 u32 version;
113 int port;
114 unsigned short protocol;
115 } mount_server;
116
117 struct {
118 struct sockaddr_storage address;
119 size_t addrlen;
120 char *hostname;
121 char *export_path;
122 int port;
123 unsigned short protocol;
124 } nfs_server;
125
126 struct security_mnt_opts lsm_opts;
127 struct net *net;
128};
129
130/* mount_clnt.c */
131struct nfs_mount_request {
132 struct sockaddr *sap;
133 size_t salen;
134 char *hostname;
135 char *dirpath;
136 u32 version;
137 unsigned short protocol;
138 struct nfs_fh *fh;
139 int noresvport;
140 unsigned int *auth_flav_len;
141 rpc_authflavor_t *auth_flavs;
142 struct net *net;
143};
144
145extern int nfs_mount(struct nfs_mount_request *info);
146extern void nfs_umount(const struct nfs_mount_request *info);
147
148/* client.c */
149extern const struct rpc_program nfs_program;
150extern void nfs_clients_init(struct net *net);
151
152extern void nfs_cleanup_cb_ident_idr(struct net *);
153extern void nfs_put_client(struct nfs_client *);
154extern struct nfs_client *nfs4_find_client_ident(struct net *, int);
155extern struct nfs_client *
156nfs4_find_client_sessionid(struct net *, const struct sockaddr *,
157 struct nfs4_sessionid *);
158extern struct nfs_server *nfs_create_server(
159 const struct nfs_parsed_mount_data *,
160 struct nfs_fh *);
161extern struct nfs_server *nfs4_create_server(
162 const struct nfs_parsed_mount_data *,
163 struct nfs_fh *);
164extern struct nfs_server *nfs4_create_referral_server(struct nfs_clone_mount *,
165 struct nfs_fh *);
166extern void nfs_free_server(struct nfs_server *server);
167extern struct nfs_server *nfs_clone_server(struct nfs_server *,
168 struct nfs_fh *,
169 struct nfs_fattr *,
170 rpc_authflavor_t);
171extern int nfs_wait_client_init_complete(const struct nfs_client *clp);
172extern void nfs_mark_client_ready(struct nfs_client *clp, int state);
173extern struct nfs_client *nfs4_set_ds_client(struct nfs_client* mds_clp,
174 const struct sockaddr *ds_addr,
175 int ds_addrlen, int ds_proto,
176 unsigned int ds_timeo,
177 unsigned int ds_retrans);
178#ifdef CONFIG_PROC_FS
179extern int __init nfs_fs_proc_init(void);
180extern void nfs_fs_proc_exit(void);
181#else
182static inline int nfs_fs_proc_init(void)
183{
184 return 0;
185}
186static inline void nfs_fs_proc_exit(void)
187{
188}
189#endif
190
191/* callback_xdr.c */
192extern struct svc_version nfs4_callback_version1;
193extern struct svc_version nfs4_callback_version4;
194
195struct nfs_pageio_descriptor;
196/* pagelist.c */
197extern int __init nfs_init_nfspagecache(void);
198extern void nfs_destroy_nfspagecache(void);
199extern int __init nfs_init_readpagecache(void);
200extern void nfs_destroy_readpagecache(void);
201extern int __init nfs_init_writepagecache(void);
202extern void nfs_destroy_writepagecache(void);
203
204extern int __init nfs_init_directcache(void);
205extern void nfs_destroy_directcache(void);
206extern bool nfs_pgarray_set(struct nfs_page_array *p, unsigned int pagecount);
207extern void nfs_pgheader_init(struct nfs_pageio_descriptor *desc,
208 struct nfs_pgio_header *hdr,
209 void (*release)(struct nfs_pgio_header *hdr));
210void nfs_set_pgio_error(struct nfs_pgio_header *hdr, int error, loff_t pos);
211
212/* nfs2xdr.c */
213extern struct rpc_procinfo nfs_procedures[];
214extern int nfs2_decode_dirent(struct xdr_stream *,
215 struct nfs_entry *, int);
216
217/* nfs3xdr.c */
218extern struct rpc_procinfo nfs3_procedures[];
219extern int nfs3_decode_dirent(struct xdr_stream *,
220 struct nfs_entry *, int);
221
222/* nfs4xdr.c */
223#ifdef CONFIG_NFS_V4
224extern int nfs4_decode_dirent(struct xdr_stream *,
225 struct nfs_entry *, int);
226#endif
227#ifdef CONFIG_NFS_V4_1
228extern const u32 nfs41_maxread_overhead;
229extern const u32 nfs41_maxwrite_overhead;
230#endif
231
232/* nfs4proc.c */
233#ifdef CONFIG_NFS_V4
234extern struct rpc_procinfo nfs4_procedures[];
235#endif
236
237extern int nfs4_init_ds_session(struct nfs_client *, unsigned long);
238
239/* proc.c */
240void nfs_close_context(struct nfs_open_context *ctx, int is_sync);
241extern struct nfs_client *nfs_init_client(struct nfs_client *clp,
242 const struct rpc_timeout *timeparms,
243 const char *ip_addr, rpc_authflavor_t authflavour);
244
245/* dir.c */
246extern int nfs_access_cache_shrinker(struct shrinker *shrink,
247 struct shrink_control *sc);
248
249/* inode.c */
250extern struct workqueue_struct *nfsiod_workqueue;
251extern struct inode *nfs_alloc_inode(struct super_block *sb);
252extern void nfs_destroy_inode(struct inode *);
253extern int nfs_write_inode(struct inode *, struct writeback_control *);
254extern void nfs_evict_inode(struct inode *);
255#ifdef CONFIG_NFS_V4
256extern void nfs4_evict_inode(struct inode *);
257#endif
258void nfs_zap_acl_cache(struct inode *inode);
259extern int nfs_wait_bit_killable(void *word);
260
261/* super.c */
262extern struct file_system_type nfs_xdev_fs_type;
263#ifdef CONFIG_NFS_V4
264extern struct file_system_type nfs4_xdev_fs_type;
265extern struct file_system_type nfs4_referral_fs_type;
266#endif
267
268extern struct rpc_stat nfs_rpcstat;
269
270extern int __init register_nfs_fs(void);
271extern void __exit unregister_nfs_fs(void);
272extern void nfs_sb_active(struct super_block *sb);
273extern void nfs_sb_deactive(struct super_block *sb);
274
275/* namespace.c */
276extern char *nfs_path(char **p, struct dentry *dentry,
277 char *buffer, ssize_t buflen);
278extern struct vfsmount *nfs_d_automount(struct path *path);
279struct vfsmount *nfs_submount(struct nfs_server *, struct dentry *,
280 struct nfs_fh *, struct nfs_fattr *);
281struct vfsmount *nfs_do_submount(struct dentry *, struct nfs_fh *,
282 struct nfs_fattr *, rpc_authflavor_t);
283
284/* getroot.c */
285extern struct dentry *nfs_get_root(struct super_block *, struct nfs_fh *,
286 const char *);
287#ifdef CONFIG_NFS_V4
288extern struct dentry *nfs4_get_root(struct super_block *, struct nfs_fh *,
289 const char *);
290
291extern int nfs4_get_rootfh(struct nfs_server *server, struct nfs_fh *mntfh);
292#endif
293
294struct nfs_pgio_completion_ops;
295/* read.c */
296extern struct nfs_read_header *nfs_readhdr_alloc(void);
297extern void nfs_readhdr_free(struct nfs_pgio_header *hdr);
298extern void nfs_pageio_init_read(struct nfs_pageio_descriptor *pgio,
299 struct inode *inode,
300 const struct nfs_pgio_completion_ops *compl_ops);
301extern int nfs_initiate_read(struct rpc_clnt *clnt,
302 struct nfs_read_data *data,
303 const struct rpc_call_ops *call_ops, int flags);
304extern void nfs_read_prepare(struct rpc_task *task, void *calldata);
305extern int nfs_generic_pagein(struct nfs_pageio_descriptor *desc,
306 struct nfs_pgio_header *hdr);
307extern void nfs_pageio_init_read_mds(struct nfs_pageio_descriptor *pgio,
308 struct inode *inode,
309 const struct nfs_pgio_completion_ops *compl_ops);
310extern void nfs_pageio_reset_read_mds(struct nfs_pageio_descriptor *pgio);
311extern void nfs_readdata_release(struct nfs_read_data *rdata);
312
313/* write.c */
314extern void nfs_pageio_init_write(struct nfs_pageio_descriptor *pgio,
315 struct inode *inode, int ioflags,
316 const struct nfs_pgio_completion_ops *compl_ops);
317extern struct nfs_write_header *nfs_writehdr_alloc(void);
318extern void nfs_writehdr_free(struct nfs_pgio_header *hdr);
319extern int nfs_generic_flush(struct nfs_pageio_descriptor *desc,
320 struct nfs_pgio_header *hdr);
321extern void nfs_pageio_init_write_mds(struct nfs_pageio_descriptor *pgio,
322 struct inode *inode, int ioflags,
323 const struct nfs_pgio_completion_ops *compl_ops);
324extern void nfs_pageio_reset_write_mds(struct nfs_pageio_descriptor *pgio);
325extern void nfs_writedata_release(struct nfs_write_data *wdata);
326extern void nfs_commit_free(struct nfs_commit_data *p);
327extern int nfs_initiate_write(struct rpc_clnt *clnt,
328 struct nfs_write_data *data,
329 const struct rpc_call_ops *call_ops,
330 int how, int flags);
331extern void nfs_write_prepare(struct rpc_task *task, void *calldata);
332extern void nfs_commit_prepare(struct rpc_task *task, void *calldata);
333extern int nfs_initiate_commit(struct rpc_clnt *clnt,
334 struct nfs_commit_data *data,
335 const struct rpc_call_ops *call_ops,
336 int how, int flags);
337extern void nfs_init_commit(struct nfs_commit_data *data,
338 struct list_head *head,
339 struct pnfs_layout_segment *lseg,
340 struct nfs_commit_info *cinfo);
341int nfs_scan_commit_list(struct list_head *src, struct list_head *dst,
342 struct nfs_commit_info *cinfo, int max);
343int nfs_scan_commit(struct inode *inode, struct list_head *dst,
344 struct nfs_commit_info *cinfo);
345void nfs_mark_request_commit(struct nfs_page *req,
346 struct pnfs_layout_segment *lseg,
347 struct nfs_commit_info *cinfo);
348int nfs_generic_commit_list(struct inode *inode, struct list_head *head,
349 int how, struct nfs_commit_info *cinfo);
350void nfs_retry_commit(struct list_head *page_list,
351 struct pnfs_layout_segment *lseg,
352 struct nfs_commit_info *cinfo);
353void nfs_commitdata_release(struct nfs_commit_data *data);
354void nfs_request_add_commit_list(struct nfs_page *req, struct list_head *dst,
355 struct nfs_commit_info *cinfo);
356void nfs_request_remove_commit_list(struct nfs_page *req,
357 struct nfs_commit_info *cinfo);
358void nfs_init_cinfo(struct nfs_commit_info *cinfo,
359 struct inode *inode,
360 struct nfs_direct_req *dreq);
361
362#ifdef CONFIG_MIGRATION
363extern int nfs_migrate_page(struct address_space *,
364 struct page *, struct page *, enum migrate_mode);
365#else
366#define nfs_migrate_page NULL
367#endif
368
369/* direct.c */
370void nfs_init_cinfo_from_dreq(struct nfs_commit_info *cinfo,
371 struct nfs_direct_req *dreq);
372static inline void nfs_inode_dio_wait(struct inode *inode)
373{
374 inode_dio_wait(inode);
375}
376
377/* nfs4proc.c */
378extern void __nfs4_read_done_cb(struct nfs_read_data *);
379extern struct nfs_client *nfs4_init_client(struct nfs_client *clp,
380 const struct rpc_timeout *timeparms,
381 const char *ip_addr,
382 rpc_authflavor_t authflavour);
383extern int _nfs4_call_sync(struct rpc_clnt *clnt,
384 struct nfs_server *server,
385 struct rpc_message *msg,
386 struct nfs4_sequence_args *args,
387 struct nfs4_sequence_res *res,
388 int cache_reply);
389extern int _nfs4_call_sync_session(struct rpc_clnt *clnt,
390 struct nfs_server *server,
391 struct rpc_message *msg,
392 struct nfs4_sequence_args *args,
393 struct nfs4_sequence_res *res,
394 int cache_reply);
395
396/*
397 * Determine the device name as a string
398 */
399static inline char *nfs_devname(struct dentry *dentry,
400 char *buffer, ssize_t buflen)
401{
402 char *dummy;
403 return nfs_path(&dummy, dentry, buffer, buflen);
404}
405
406/*
407 * Determine the actual block size (and log2 thereof)
408 */
409static inline
410unsigned long nfs_block_bits(unsigned long bsize, unsigned char *nrbitsp)
411{
412 /* make sure blocksize is a power of two */
413 if ((bsize & (bsize - 1)) || nrbitsp) {
414 unsigned char nrbits;
415
416 for (nrbits = 31; nrbits && !(bsize & (1 << nrbits)); nrbits--)
417 ;
418 bsize = 1 << nrbits;
419 if (nrbitsp)
420 *nrbitsp = nrbits;
421 }
422
423 return bsize;
424}
425
426/*
427 * Calculate the number of 512byte blocks used.
428 */
429static inline blkcnt_t nfs_calc_block_size(u64 tsize)
430{
431 blkcnt_t used = (tsize + 511) >> 9;
432 return (used > ULONG_MAX) ? ULONG_MAX : used;
433}
434
435/*
436 * Compute and set NFS server blocksize
437 */
438static inline
439unsigned long nfs_block_size(unsigned long bsize, unsigned char *nrbitsp)
440{
441 if (bsize < NFS_MIN_FILE_IO_SIZE)
442 bsize = NFS_DEF_FILE_IO_SIZE;
443 else if (bsize >= NFS_MAX_FILE_IO_SIZE)
444 bsize = NFS_MAX_FILE_IO_SIZE;
445
446 return nfs_block_bits(bsize, nrbitsp);
447}
448
449/*
450 * Determine the maximum file size for a superblock
451 */
452static inline
453void nfs_super_set_maxbytes(struct super_block *sb, __u64 maxfilesize)
454{
455 sb->s_maxbytes = (loff_t)maxfilesize;
456 if (sb->s_maxbytes > MAX_LFS_FILESIZE || sb->s_maxbytes <= 0)
457 sb->s_maxbytes = MAX_LFS_FILESIZE;
458}
459
460/*
461 * Determine the number of bytes of data the page contains
462 */
463static inline
464unsigned int nfs_page_length(struct page *page)
465{
466 loff_t i_size = i_size_read(page->mapping->host);
467
468 if (i_size > 0) {
469 pgoff_t end_index = (i_size - 1) >> PAGE_CACHE_SHIFT;
470 if (page->index < end_index)
471 return PAGE_CACHE_SIZE;
472 if (page->index == end_index)
473 return ((i_size - 1) & ~PAGE_CACHE_MASK) + 1;
474 }
475 return 0;
476}
477
478/*
479 * Convert a umode to a dirent->d_type
480 */
481static inline
482unsigned char nfs_umode_to_dtype(umode_t mode)
483{
484 return (mode >> 12) & 15;
485}
486
487/*
488 * Determine the number of pages in an array of length 'len' and
489 * with a base offset of 'base'
490 */
491static inline
492unsigned int nfs_page_array_len(unsigned int base, size_t len)
493{
494 return ((unsigned long)len + (unsigned long)base +
495 PAGE_SIZE - 1) >> PAGE_SHIFT;
496}
497
498/*
499 * Convert a struct timespec into a 64-bit change attribute
500 *
501 * This does approximately the same thing as timespec_to_ns(),
502 * but for calculation efficiency, we multiply the seconds by
503 * 1024*1024*1024.
504 */
505static inline
506u64 nfs_timespec_to_change_attr(const struct timespec *ts)
507{
508 return ((u64)ts->tv_sec << 30) + ts->tv_nsec;
509}