]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blame - fs/nfs/internal.h
NFS: Create a new nfs_try_mount()
[mirror_ubuntu-artful-kernel.git] / fs / nfs / internal.h
CommitLineData
f7b422b1
DH
1/*
2 * NFS internal definitions
3 */
4
eedc020e 5#include "nfs4_fs.h"
f7b422b1 6#include <linux/mount.h>
f9c3a380 7#include <linux/security.h>
f7b422b1 8
08734048
DH
9#define NFS_MS_MASK (MS_RDONLY|MS_NOSUID|MS_NODEV|MS_NOEXEC|MS_SYNCHRONOUS)
10
54ceac45 11struct nfs_string;
54ceac45
DH
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
eedc020e
AA
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
d8cb1a7c
AB
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
7ebb9315
BS
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
533eb461
AA
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
f7b422b1
DH
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;
6677d095
CL
66 struct sockaddr *addr;
67 size_t addrlen;
f7b422b1
DH
68 rpc_authflavor_t authflavor;
69};
70
a14017db
CL
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
4cfd74fc
CL
77/*
78 * Value used if the user did not specify a port value.
79 */
80#define NFS_UNSPEC_PORT (-1)
81
56e4ebf8
BS
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
6b18eaa0
TT
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;
b797cac7 98 unsigned int options;
6b18eaa0
TT
99 unsigned int bsize;
100 unsigned int auth_flavor_len;
101 rpc_authflavor_t auth_flavors[1];
102 char *client_address;
764302cc 103 unsigned int version;
3fd5be9e 104 unsigned int minorversion;
08734048 105 char *fscache_uniq;
6b18eaa0
TT
106
107 struct {
4c568017
CL
108 struct sockaddr_storage address;
109 size_t addrlen;
6b18eaa0 110 char *hostname;
78fa701f 111 u32 version;
4cfd74fc 112 int port;
78fa701f 113 unsigned short protocol;
6b18eaa0
TT
114 } mount_server;
115
116 struct {
4c568017
CL
117 struct sockaddr_storage address;
118 size_t addrlen;
6b18eaa0
TT
119 char *hostname;
120 char *export_path;
4cfd74fc 121 int port;
78fa701f 122 unsigned short protocol;
6b18eaa0 123 } nfs_server;
f9c3a380
EP
124
125 struct security_mnt_opts lsm_opts;
e50a7a1a 126 struct net *net;
6b18eaa0
TT
127};
128
146ec944 129/* mount_clnt.c */
c5d120f8
CL
130struct nfs_mount_request {
131 struct sockaddr *sap;
132 size_t salen;
133 char *hostname;
134 char *dirpath;
135 u32 version;
136 unsigned short protocol;
137 struct nfs_fh *fh;
50a737f8 138 int noresvport;
8e02f6b9
CL
139 unsigned int *auth_flav_len;
140 rpc_authflavor_t *auth_flavs;
6d59b8d5 141 struct net *net;
c5d120f8
CL
142};
143
144extern int nfs_mount(struct nfs_mount_request *info);
0b524123 145extern void nfs_umount(const struct nfs_mount_request *info);
146ec944 146
24c8dbbb 147/* client.c */
a613fa16 148extern const struct rpc_program nfs_program;
6b13168b 149extern void nfs_clients_init(struct net *net);
54ceac45 150
28cd1b3f 151extern void nfs_cleanup_cb_ident_idr(struct net *);
24c8dbbb 152extern void nfs_put_client(struct nfs_client *);
28cd1b3f 153extern struct nfs_client *nfs4_find_client_ident(struct net *, int);
c36fca52 154extern struct nfs_client *
c7add9a9
SK
155nfs4_find_client_sessionid(struct net *, const struct sockaddr *,
156 struct nfs4_sessionid *);
2283f8d6
TT
157extern struct nfs_server *nfs_create_server(
158 const struct nfs_parsed_mount_data *,
159 struct nfs_fh *);
91ea40b9
TT
160extern struct nfs_server *nfs4_create_server(
161 const struct nfs_parsed_mount_data *,
162 struct nfs_fh *);
54ceac45
DH
163extern struct nfs_server *nfs4_create_referral_server(struct nfs_clone_mount *,
164 struct nfs_fh *);
165extern void nfs_free_server(struct nfs_server *server);
166extern struct nfs_server *nfs_clone_server(struct nfs_server *,
167 struct nfs_fh *,
7e6eb683
BS
168 struct nfs_fattr *,
169 rpc_authflavor_t);
76db6d95 170extern void nfs_mark_client_ready(struct nfs_client *clp, int state);
008f55d0 171extern int nfs4_check_client_ready(struct nfs_client *clp);
d83217c1
AA
172extern 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);
6aaca566
DH
175#ifdef CONFIG_PROC_FS
176extern int __init nfs_fs_proc_init(void);
177extern void nfs_fs_proc_exit(void);
178#else
179static inline int nfs_fs_proc_init(void)
180{
181 return 0;
182}
183static inline void nfs_fs_proc_exit(void)
184{
185}
186#endif
24c8dbbb 187
f7b422b1
DH
188/* callback_xdr.c */
189extern struct svc_version nfs4_callback_version1;
07bccc2d 190extern struct svc_version nfs4_callback_version4;
f7b422b1 191
4db6e0b7 192struct nfs_pageio_descriptor;
f7b422b1
DH
193/* pagelist.c */
194extern int __init nfs_init_nfspagecache(void);
266bee88 195extern void nfs_destroy_nfspagecache(void);
f7b422b1 196extern int __init nfs_init_readpagecache(void);
266bee88 197extern void nfs_destroy_readpagecache(void);
f7b422b1 198extern int __init nfs_init_writepagecache(void);
266bee88 199extern void nfs_destroy_writepagecache(void);
f7b422b1 200
f7b422b1 201extern int __init nfs_init_directcache(void);
266bee88 202extern void nfs_destroy_directcache(void);
30dd374f 203extern bool nfs_pgarray_set(struct nfs_page_array *p, unsigned int pagecount);
4db6e0b7
FI
204extern void nfs_pgheader_init(struct nfs_pageio_descriptor *desc,
205 struct nfs_pgio_header *hdr,
206 void (*release)(struct nfs_pgio_header *hdr));
207void nfs_set_pgio_error(struct nfs_pgio_header *hdr, int error, loff_t pos);
f7b422b1
DH
208
209/* nfs2xdr.c */
85828493 210extern int nfs_stat_to_errno(enum nfs_stat);
f7b422b1 211extern struct rpc_procinfo nfs_procedures[];
573c4e1e
CL
212extern int nfs2_decode_dirent(struct xdr_stream *,
213 struct nfs_entry *, int);
f7b422b1
DH
214
215/* nfs3xdr.c */
216extern struct rpc_procinfo nfs3_procedures[];
573c4e1e
CL
217extern int nfs3_decode_dirent(struct xdr_stream *,
218 struct nfs_entry *, int);
f7b422b1
DH
219
220/* nfs4xdr.c */
7d4e2747 221#ifdef CONFIG_NFS_V4
573c4e1e
CL
222extern int nfs4_decode_dirent(struct xdr_stream *,
223 struct nfs_entry *, int);
7d4e2747 224#endif
2449ea2e
AB
225#ifdef CONFIG_NFS_V4_1
226extern const u32 nfs41_maxread_overhead;
227extern const u32 nfs41_maxwrite_overhead;
228#endif
f7b422b1
DH
229
230/* nfs4proc.c */
d75d5414 231#ifdef CONFIG_NFS_V4
f7b422b1 232extern struct rpc_procinfo nfs4_procedures[];
d75d5414 233#endif
f7b422b1 234
d83217c1
AA
235extern int nfs4_init_ds_session(struct nfs_client *clp);
236
7fe5c398
TM
237/* proc.c */
238void nfs_close_context(struct nfs_open_context *ctx, int is_sync);
45a52a02
AA
239extern int nfs_init_client(struct nfs_client *clp,
240 const struct rpc_timeout *timeparms,
241 const char *ip_addr, rpc_authflavor_t authflavour,
242 int noresvport);
7fe5c398 243
979df72e 244/* dir.c */
7f8275d0 245extern int nfs_access_cache_shrinker(struct shrinker *shrink,
1495f230 246 struct shrink_control *sc);
979df72e 247
f7b422b1 248/* inode.c */
5746006f 249extern struct workqueue_struct *nfsiod_workqueue;
f7b422b1
DH
250extern struct inode *nfs_alloc_inode(struct super_block *sb);
251extern void nfs_destroy_inode(struct inode *);
a9185b41 252extern int nfs_write_inode(struct inode *, struct writeback_control *);
b57922d9 253extern void nfs_evict_inode(struct inode *);
f7b422b1 254#ifdef CONFIG_NFS_V4
b57922d9 255extern void nfs4_evict_inode(struct inode *);
f7b422b1 256#endif
f41f7418 257void nfs_zap_acl_cache(struct inode *inode);
72cb77f4 258extern int nfs_wait_bit_killable(void *word);
f7b422b1
DH
259
260/* super.c */
54ceac45 261extern struct file_system_type nfs_xdev_fs_type;
f7b422b1 262#ifdef CONFIG_NFS_V4
54ceac45
DH
263extern struct file_system_type nfs4_xdev_fs_type;
264extern struct file_system_type nfs4_referral_fs_type;
f7b422b1 265#endif
4ebd9ab3 266
f7b422b1 267extern struct rpc_stat nfs_rpcstat;
4ebd9ab3 268
f7b422b1
DH
269extern int __init register_nfs_fs(void);
270extern void __exit unregister_nfs_fs(void);
1daef0a8
TM
271extern void nfs_sb_active(struct super_block *sb);
272extern void nfs_sb_deactive(struct super_block *sb);
f7b422b1
DH
273
274/* namespace.c */
b514f872 275extern char *nfs_path(char **p, struct dentry *dentry,
f7b422b1 276 char *buffer, ssize_t buflen);
36d43a43 277extern struct vfsmount *nfs_d_automount(struct path *path);
281cad46
BS
278struct vfsmount *nfs_submount(struct nfs_server *, struct dentry *,
279 struct nfs_fh *, struct nfs_fattr *);
280struct vfsmount *nfs_do_submount(struct dentry *, struct nfs_fh *,
281 struct nfs_fattr *, rpc_authflavor_t);
f7b422b1 282
54ceac45 283/* getroot.c */
0d5839ad
AV
284extern struct dentry *nfs_get_root(struct super_block *, struct nfs_fh *,
285 const char *);
7d4e2747 286#ifdef CONFIG_NFS_V4
0d5839ad
AV
287extern struct dentry *nfs4_get_root(struct super_block *, struct nfs_fh *,
288 const char *);
54ceac45 289
815409d2 290extern int nfs4_get_rootfh(struct nfs_server *server, struct nfs_fh *mntfh);
7d4e2747 291#endif
f7b422b1 292
061ae2ed 293struct nfs_pgio_completion_ops;
f11c88af 294/* read.c */
4db6e0b7 295extern struct nfs_read_header *nfs_readhdr_alloc(void);
cd841605 296extern void nfs_readhdr_free(struct nfs_pgio_header *hdr);
584aa810
FI
297extern void nfs_pageio_init_read(struct nfs_pageio_descriptor *pgio,
298 struct inode *inode,
299 const struct nfs_pgio_completion_ops *compl_ops);
c5996c4e
FI
300extern int nfs_initiate_read(struct rpc_clnt *clnt,
301 struct nfs_read_data *data,
dc70d7b3 302 const struct rpc_call_ops *call_ops);
f11c88af 303extern void nfs_read_prepare(struct rpc_task *task, void *calldata);
493292dd 304extern int nfs_generic_pagein(struct nfs_pageio_descriptor *desc,
4db6e0b7 305 struct nfs_pgio_header *hdr);
62e4a769 306extern void nfs_pageio_init_read_mds(struct nfs_pageio_descriptor *pgio,
061ae2ed
FI
307 struct inode *inode,
308 const struct nfs_pgio_completion_ops *compl_ops);
493292dd
TM
309extern void nfs_pageio_reset_read_mds(struct nfs_pageio_descriptor *pgio);
310extern void nfs_readdata_release(struct nfs_read_data *rdata);
e885de1a 311
def6ed7e 312/* write.c */
1763da12
FI
313extern 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);
6c75dc0d 316extern struct nfs_write_header *nfs_writehdr_alloc(void);
cd841605 317extern void nfs_writehdr_free(struct nfs_pgio_header *hdr);
dce81290 318extern int nfs_generic_flush(struct nfs_pageio_descriptor *desc,
6c75dc0d 319 struct nfs_pgio_header *hdr);
e2fecb21 320extern void nfs_pageio_init_write_mds(struct nfs_pageio_descriptor *pgio,
061ae2ed
FI
321 struct inode *inode, int ioflags,
322 const struct nfs_pgio_completion_ops *compl_ops);
dce81290
TM
323extern void nfs_pageio_reset_write_mds(struct nfs_pageio_descriptor *pgio);
324extern void nfs_writedata_release(struct nfs_write_data *wdata);
0b7c0153 325extern void nfs_commit_free(struct nfs_commit_data *p);
c5996c4e
FI
326extern int nfs_initiate_write(struct rpc_clnt *clnt,
327 struct nfs_write_data *data,
a69aef14
FI
328 const struct rpc_call_ops *call_ops,
329 int how);
def6ed7e 330extern void nfs_write_prepare(struct rpc_task *task, void *calldata);
0b7c0153
FI
331extern void nfs_commit_prepare(struct rpc_task *task, void *calldata);
332extern int nfs_initiate_commit(struct rpc_clnt *clnt,
333 struct nfs_commit_data *data,
e0c2b380
FI
334 const struct rpc_call_ops *call_ops,
335 int how);
0b7c0153 336extern void nfs_init_commit(struct nfs_commit_data *data,
e0c2b380 337 struct list_head *head,
f453a54a
FI
338 struct pnfs_layout_segment *lseg,
339 struct nfs_commit_info *cinfo);
1763da12
FI
340int nfs_scan_commit_list(struct list_head *src, struct list_head *dst,
341 struct nfs_commit_info *cinfo, int max);
342int nfs_scan_commit(struct inode *inode, struct list_head *dst,
343 struct nfs_commit_info *cinfo);
344void nfs_mark_request_commit(struct nfs_page *req,
345 struct pnfs_layout_segment *lseg,
346 struct nfs_commit_info *cinfo);
347int nfs_generic_commit_list(struct inode *inode, struct list_head *head,
348 int how, struct nfs_commit_info *cinfo);
e0c2b380 349void nfs_retry_commit(struct list_head *page_list,
ea2cf228
FI
350 struct pnfs_layout_segment *lseg,
351 struct nfs_commit_info *cinfo);
0b7c0153 352void nfs_commitdata_release(struct nfs_commit_data *data);
ea2cf228
FI
353void nfs_request_add_commit_list(struct nfs_page *req, struct list_head *dst,
354 struct nfs_commit_info *cinfo);
355void nfs_request_remove_commit_list(struct nfs_page *req,
356 struct nfs_commit_info *cinfo);
357void nfs_init_cinfo(struct nfs_commit_info *cinfo,
358 struct inode *inode,
359 struct nfs_direct_req *dreq);
e0c2b380 360
074cc1de
TM
361#ifdef CONFIG_MIGRATION
362extern int nfs_migrate_page(struct address_space *,
a6bc32b8 363 struct page *, struct page *, enum migrate_mode);
074cc1de
TM
364#else
365#define nfs_migrate_page NULL
366#endif
def6ed7e 367
1763da12
FI
368/* direct.c */
369void nfs_init_cinfo_from_dreq(struct nfs_commit_info *cinfo,
370 struct nfs_direct_req *dreq);
371
cccef3b9 372/* nfs4proc.c */
d20581aa 373extern void __nfs4_read_done_cb(struct nfs_read_data *);
cbdabc7f 374extern void nfs4_reset_read(struct rpc_task *task, struct nfs_read_data *data);
45a52a02
AA
375extern int nfs4_init_client(struct nfs_client *clp,
376 const struct rpc_timeout *timeparms,
377 const char *ip_addr,
378 rpc_authflavor_t authflavour,
379 int noresvport);
a69aef14 380extern void nfs4_reset_write(struct rpc_task *task, struct nfs_write_data *data);
7c513058
BS
381extern int _nfs4_call_sync(struct rpc_clnt *clnt,
382 struct nfs_server *server,
cccef3b9
AA
383 struct rpc_message *msg,
384 struct nfs4_sequence_args *args,
385 struct nfs4_sequence_res *res,
386 int cache_reply);
7c513058
BS
387extern int _nfs4_call_sync_session(struct rpc_clnt *clnt,
388 struct nfs_server *server,
cccef3b9
AA
389 struct rpc_message *msg,
390 struct nfs4_sequence_args *args,
391 struct nfs4_sequence_res *res,
392 int cache_reply);
393
f7b422b1
DH
394/*
395 * Determine the device name as a string
396 */
b514f872 397static inline char *nfs_devname(struct dentry *dentry,
54ceac45 398 char *buffer, ssize_t buflen)
f7b422b1 399{
b514f872
AV
400 char *dummy;
401 return nfs_path(&dummy, dentry, buffer, buflen);
f7b422b1
DH
402}
403
404/*
405 * Determine the actual block size (and log2 thereof)
406 */
407static inline
408unsigned long nfs_block_bits(unsigned long bsize, unsigned char *nrbitsp)
409{
410 /* make sure blocksize is a power of two */
411 if ((bsize & (bsize - 1)) || nrbitsp) {
412 unsigned char nrbits;
413
414 for (nrbits = 31; nrbits && !(bsize & (1 << nrbits)); nrbits--)
415 ;
416 bsize = 1 << nrbits;
417 if (nrbitsp)
418 *nrbitsp = nrbits;
419 }
420
421 return bsize;
422}
423
424/*
425 * Calculate the number of 512byte blocks used.
426 */
9eaa67c6 427static inline blkcnt_t nfs_calc_block_size(u64 tsize)
f7b422b1 428{
9eaa67c6 429 blkcnt_t used = (tsize + 511) >> 9;
f7b422b1
DH
430 return (used > ULONG_MAX) ? ULONG_MAX : used;
431}
432
433/*
434 * Compute and set NFS server blocksize
435 */
436static inline
437unsigned long nfs_block_size(unsigned long bsize, unsigned char *nrbitsp)
438{
439 if (bsize < NFS_MIN_FILE_IO_SIZE)
440 bsize = NFS_DEF_FILE_IO_SIZE;
441 else if (bsize >= NFS_MAX_FILE_IO_SIZE)
442 bsize = NFS_MAX_FILE_IO_SIZE;
443
444 return nfs_block_bits(bsize, nrbitsp);
445}
446
447/*
448 * Determine the maximum file size for a superblock
449 */
450static inline
451void nfs_super_set_maxbytes(struct super_block *sb, __u64 maxfilesize)
452{
453 sb->s_maxbytes = (loff_t)maxfilesize;
454 if (sb->s_maxbytes > MAX_LFS_FILESIZE || sb->s_maxbytes <= 0)
455 sb->s_maxbytes = MAX_LFS_FILESIZE;
456}
49a70f27
TM
457
458/*
459 * Determine the number of bytes of data the page contains
460 */
461static inline
462unsigned int nfs_page_length(struct page *page)
463{
464 loff_t i_size = i_size_read(page->mapping->host);
465
466 if (i_size > 0) {
467 pgoff_t end_index = (i_size - 1) >> PAGE_CACHE_SHIFT;
468 if (page->index < end_index)
469 return PAGE_CACHE_SIZE;
470 if (page->index == end_index)
471 return ((i_size - 1) & ~PAGE_CACHE_MASK) + 1;
472 }
473 return 0;
474}
8d5658c9 475
0b26a0bf
TM
476/*
477 * Convert a umode to a dirent->d_type
478 */
479static inline
480unsigned char nfs_umode_to_dtype(umode_t mode)
481{
482 return (mode >> 12) & 15;
483}
484
8d5658c9
TM
485/*
486 * Determine the number of pages in an array of length 'len' and
487 * with a base offset of 'base'
488 */
489static inline
490unsigned int nfs_page_array_len(unsigned int base, size_t len)
491{
492 return ((unsigned long)len + (unsigned long)base +
493 PAGE_SIZE - 1) >> PAGE_SHIFT;
494}
0110ee15 495
3a1556e8
TM
496/*
497 * Convert a struct timespec into a 64-bit change attribute
498 *
499 * This does approximately the same thing as timespec_to_ns(),
500 * but for calculation efficiency, we multiply the seconds by
501 * 1024*1024*1024.
502 */
503static inline
504u64 nfs_timespec_to_change_attr(const struct timespec *ts)
505{
506 return ((u64)ts->tv_sec << 30) + ts->tv_nsec;
507}