]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - fs/nfs/internal.h
NFS: Correct the array bound calculation in nfs_readdir_add_to_array
[mirror_ubuntu-bionic-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
f7b422b1
DH
42struct nfs_clone_mount {
43 const struct super_block *sb;
44 const struct dentry *dentry;
45 struct nfs_fh *fh;
46 struct nfs_fattr *fattr;
47 char *hostname;
48 char *mnt_path;
6677d095
CL
49 struct sockaddr *addr;
50 size_t addrlen;
f7b422b1
DH
51 rpc_authflavor_t authflavor;
52};
53
a14017db
CL
54/*
55 * Note: RFC 1813 doesn't limit the number of auth flavors that
56 * a server can return, so make something up.
57 */
58#define NFS_MAX_SECFLAVORS (12)
59
4cfd74fc
CL
60/*
61 * Value used if the user did not specify a port value.
62 */
63#define NFS_UNSPEC_PORT (-1)
64
56e4ebf8
BS
65/*
66 * Maximum number of pages that readdir can use for creating
67 * a vmapped array of pages.
68 */
69#define NFS_MAX_READDIR_PAGES 8
70
6b18eaa0
TT
71/*
72 * In-kernel mount arguments
73 */
74struct nfs_parsed_mount_data {
75 int flags;
76 int rsize, wsize;
77 int timeo, retrans;
78 int acregmin, acregmax,
79 acdirmin, acdirmax;
80 int namlen;
b797cac7 81 unsigned int options;
6b18eaa0
TT
82 unsigned int bsize;
83 unsigned int auth_flavor_len;
84 rpc_authflavor_t auth_flavors[1];
85 char *client_address;
764302cc 86 unsigned int version;
3fd5be9e 87 unsigned int minorversion;
08734048 88 char *fscache_uniq;
6b18eaa0
TT
89
90 struct {
4c568017
CL
91 struct sockaddr_storage address;
92 size_t addrlen;
6b18eaa0 93 char *hostname;
78fa701f 94 u32 version;
4cfd74fc 95 int port;
78fa701f 96 unsigned short protocol;
6b18eaa0
TT
97 } mount_server;
98
99 struct {
4c568017
CL
100 struct sockaddr_storage address;
101 size_t addrlen;
6b18eaa0
TT
102 char *hostname;
103 char *export_path;
4cfd74fc 104 int port;
78fa701f 105 unsigned short protocol;
6b18eaa0 106 } nfs_server;
f9c3a380
EP
107
108 struct security_mnt_opts lsm_opts;
6b18eaa0
TT
109};
110
146ec944 111/* mount_clnt.c */
c5d120f8
CL
112struct nfs_mount_request {
113 struct sockaddr *sap;
114 size_t salen;
115 char *hostname;
116 char *dirpath;
117 u32 version;
118 unsigned short protocol;
119 struct nfs_fh *fh;
50a737f8 120 int noresvport;
8e02f6b9
CL
121 unsigned int *auth_flav_len;
122 rpc_authflavor_t *auth_flavs;
c5d120f8
CL
123};
124
125extern int nfs_mount(struct nfs_mount_request *info);
0b524123 126extern void nfs_umount(const struct nfs_mount_request *info);
146ec944 127
24c8dbbb 128/* client.c */
54ceac45
DH
129extern struct rpc_program nfs_program;
130
24c8dbbb 131extern void nfs_put_client(struct nfs_client *);
ff052645 132extern struct nfs_client *nfs_find_client(const struct sockaddr *, u32);
3fbd67ad 133extern struct nfs_client *nfs_find_client_next(struct nfs_client *);
2283f8d6
TT
134extern struct nfs_server *nfs_create_server(
135 const struct nfs_parsed_mount_data *,
136 struct nfs_fh *);
91ea40b9
TT
137extern struct nfs_server *nfs4_create_server(
138 const struct nfs_parsed_mount_data *,
139 struct nfs_fh *);
54ceac45
DH
140extern struct nfs_server *nfs4_create_referral_server(struct nfs_clone_mount *,
141 struct nfs_fh *);
142extern void nfs_free_server(struct nfs_server *server);
143extern struct nfs_server *nfs_clone_server(struct nfs_server *,
144 struct nfs_fh *,
145 struct nfs_fattr *);
76db6d95 146extern void nfs_mark_client_ready(struct nfs_client *clp, int state);
008f55d0 147extern int nfs4_check_client_ready(struct nfs_client *clp);
6aaca566
DH
148#ifdef CONFIG_PROC_FS
149extern int __init nfs_fs_proc_init(void);
150extern void nfs_fs_proc_exit(void);
151#else
152static inline int nfs_fs_proc_init(void)
153{
154 return 0;
155}
156static inline void nfs_fs_proc_exit(void)
157{
158}
159#endif
24c8dbbb 160
7d4e2747 161/* nfs4namespace.c */
f7b422b1
DH
162#ifdef CONFIG_NFS_V4
163extern struct vfsmount *nfs_do_refmount(const struct vfsmount *mnt_parent, struct dentry *dentry);
164#else
165static inline
166struct vfsmount *nfs_do_refmount(const struct vfsmount *mnt_parent, struct dentry *dentry)
167{
168 return ERR_PTR(-ENOENT);
169}
170#endif
171
172/* callback_xdr.c */
173extern struct svc_version nfs4_callback_version1;
07bccc2d 174extern struct svc_version nfs4_callback_version4;
f7b422b1
DH
175
176/* pagelist.c */
177extern int __init nfs_init_nfspagecache(void);
266bee88 178extern void nfs_destroy_nfspagecache(void);
f7b422b1 179extern int __init nfs_init_readpagecache(void);
266bee88 180extern void nfs_destroy_readpagecache(void);
f7b422b1 181extern int __init nfs_init_writepagecache(void);
266bee88 182extern void nfs_destroy_writepagecache(void);
f7b422b1 183
f7b422b1 184extern int __init nfs_init_directcache(void);
266bee88 185extern void nfs_destroy_directcache(void);
f7b422b1
DH
186
187/* nfs2xdr.c */
7d4e2747 188extern int nfs_stat_to_errno(int);
f7b422b1 189extern struct rpc_procinfo nfs_procedures[];
82f2e547 190extern __be32 *nfs_decode_dirent(struct xdr_stream *, struct nfs_entry *, struct nfs_server *, int);
f7b422b1
DH
191
192/* nfs3xdr.c */
193extern struct rpc_procinfo nfs3_procedures[];
82f2e547 194extern __be32 *nfs3_decode_dirent(struct xdr_stream *, struct nfs_entry *, struct nfs_server *, int);
f7b422b1
DH
195
196/* nfs4xdr.c */
7d4e2747 197#ifdef CONFIG_NFS_V4
82f2e547 198extern __be32 *nfs4_decode_dirent(struct xdr_stream *, struct nfs_entry *, struct nfs_server *, int);
7d4e2747 199#endif
2449ea2e
AB
200#ifdef CONFIG_NFS_V4_1
201extern const u32 nfs41_maxread_overhead;
202extern const u32 nfs41_maxwrite_overhead;
203#endif
f7b422b1
DH
204
205/* nfs4proc.c */
d75d5414 206#ifdef CONFIG_NFS_V4
f7b422b1 207extern struct rpc_procinfo nfs4_procedures[];
d75d5414 208#endif
f7b422b1 209
7fe5c398
TM
210/* proc.c */
211void nfs_close_context(struct nfs_open_context *ctx, int is_sync);
212
979df72e 213/* dir.c */
7f8275d0
DC
214extern int nfs_access_cache_shrinker(struct shrinker *shrink,
215 int nr_to_scan, gfp_t gfp_mask);
979df72e 216
f7b422b1 217/* inode.c */
5746006f 218extern struct workqueue_struct *nfsiod_workqueue;
f7b422b1
DH
219extern struct inode *nfs_alloc_inode(struct super_block *sb);
220extern void nfs_destroy_inode(struct inode *);
a9185b41 221extern int nfs_write_inode(struct inode *, struct writeback_control *);
b57922d9 222extern void nfs_evict_inode(struct inode *);
f7b422b1 223#ifdef CONFIG_NFS_V4
b57922d9 224extern void nfs4_evict_inode(struct inode *);
f7b422b1 225#endif
f41f7418 226void nfs_zap_acl_cache(struct inode *inode);
72cb77f4 227extern int nfs_wait_bit_killable(void *word);
f7b422b1
DH
228
229/* super.c */
54ceac45 230extern struct file_system_type nfs_xdev_fs_type;
f7b422b1 231#ifdef CONFIG_NFS_V4
54ceac45
DH
232extern struct file_system_type nfs4_xdev_fs_type;
233extern struct file_system_type nfs4_referral_fs_type;
f7b422b1 234#endif
4ebd9ab3 235
f7b422b1 236extern struct rpc_stat nfs_rpcstat;
4ebd9ab3 237
f7b422b1
DH
238extern int __init register_nfs_fs(void);
239extern void __exit unregister_nfs_fs(void);
1daef0a8
TM
240extern void nfs_sb_active(struct super_block *sb);
241extern void nfs_sb_deactive(struct super_block *sb);
f7b422b1
DH
242
243/* namespace.c */
54ceac45
DH
244extern char *nfs_path(const char *base,
245 const struct dentry *droot,
246 const struct dentry *dentry,
f7b422b1
DH
247 char *buffer, ssize_t buflen);
248
54ceac45
DH
249/* getroot.c */
250extern struct dentry *nfs_get_root(struct super_block *, struct nfs_fh *);
7d4e2747 251#ifdef CONFIG_NFS_V4
54ceac45
DH
252extern struct dentry *nfs4_get_root(struct super_block *, struct nfs_fh *);
253
815409d2 254extern int nfs4_get_rootfh(struct nfs_server *server, struct nfs_fh *mntfh);
7d4e2747 255#endif
f7b422b1 256
f11c88af
AA
257/* read.c */
258extern void nfs_read_prepare(struct rpc_task *task, void *calldata);
259
def6ed7e
AA
260/* write.c */
261extern void nfs_write_prepare(struct rpc_task *task, void *calldata);
074cc1de
TM
262#ifdef CONFIG_MIGRATION
263extern int nfs_migrate_page(struct address_space *,
264 struct page *, struct page *);
265#else
266#define nfs_migrate_page NULL
267#endif
def6ed7e 268
cccef3b9
AA
269/* nfs4proc.c */
270extern int _nfs4_call_sync(struct nfs_server *server,
271 struct rpc_message *msg,
272 struct nfs4_sequence_args *args,
273 struct nfs4_sequence_res *res,
274 int cache_reply);
275extern int _nfs4_call_sync_session(struct nfs_server *server,
276 struct rpc_message *msg,
277 struct nfs4_sequence_args *args,
278 struct nfs4_sequence_res *res,
279 int cache_reply);
280
f7b422b1
DH
281/*
282 * Determine the device name as a string
283 */
284static inline char *nfs_devname(const struct vfsmount *mnt_parent,
54ceac45
DH
285 const struct dentry *dentry,
286 char *buffer, ssize_t buflen)
f7b422b1 287{
54ceac45
DH
288 return nfs_path(mnt_parent->mnt_devname, mnt_parent->mnt_root,
289 dentry, buffer, buflen);
f7b422b1
DH
290}
291
292/*
293 * Determine the actual block size (and log2 thereof)
294 */
295static inline
296unsigned long nfs_block_bits(unsigned long bsize, unsigned char *nrbitsp)
297{
298 /* make sure blocksize is a power of two */
299 if ((bsize & (bsize - 1)) || nrbitsp) {
300 unsigned char nrbits;
301
302 for (nrbits = 31; nrbits && !(bsize & (1 << nrbits)); nrbits--)
303 ;
304 bsize = 1 << nrbits;
305 if (nrbitsp)
306 *nrbitsp = nrbits;
307 }
308
309 return bsize;
310}
311
312/*
313 * Calculate the number of 512byte blocks used.
314 */
9eaa67c6 315static inline blkcnt_t nfs_calc_block_size(u64 tsize)
f7b422b1 316{
9eaa67c6 317 blkcnt_t used = (tsize + 511) >> 9;
f7b422b1
DH
318 return (used > ULONG_MAX) ? ULONG_MAX : used;
319}
320
321/*
322 * Compute and set NFS server blocksize
323 */
324static inline
325unsigned long nfs_block_size(unsigned long bsize, unsigned char *nrbitsp)
326{
327 if (bsize < NFS_MIN_FILE_IO_SIZE)
328 bsize = NFS_DEF_FILE_IO_SIZE;
329 else if (bsize >= NFS_MAX_FILE_IO_SIZE)
330 bsize = NFS_MAX_FILE_IO_SIZE;
331
332 return nfs_block_bits(bsize, nrbitsp);
333}
334
335/*
336 * Determine the maximum file size for a superblock
337 */
338static inline
339void nfs_super_set_maxbytes(struct super_block *sb, __u64 maxfilesize)
340{
341 sb->s_maxbytes = (loff_t)maxfilesize;
342 if (sb->s_maxbytes > MAX_LFS_FILESIZE || sb->s_maxbytes <= 0)
343 sb->s_maxbytes = MAX_LFS_FILESIZE;
344}
49a70f27
TM
345
346/*
347 * Determine the number of bytes of data the page contains
348 */
349static inline
350unsigned int nfs_page_length(struct page *page)
351{
352 loff_t i_size = i_size_read(page->mapping->host);
353
354 if (i_size > 0) {
355 pgoff_t end_index = (i_size - 1) >> PAGE_CACHE_SHIFT;
356 if (page->index < end_index)
357 return PAGE_CACHE_SIZE;
358 if (page->index == end_index)
359 return ((i_size - 1) & ~PAGE_CACHE_MASK) + 1;
360 }
361 return 0;
362}
8d5658c9
TM
363
364/*
365 * Determine the number of pages in an array of length 'len' and
366 * with a base offset of 'base'
367 */
368static inline
369unsigned int nfs_page_array_len(unsigned int base, size_t len)
370{
371 return ((unsigned long)len + (unsigned long)base +
372 PAGE_SIZE - 1) >> PAGE_SHIFT;
373}
0110ee15
TM
374
375/*
376 * Helper for restarting RPC calls in the possible presence of NFSv4.1
377 * sessions.
378 */
d05dd4e9 379static inline int nfs_restart_rpc(struct rpc_task *task, const struct nfs_client *clp)
0110ee15
TM
380{
381 if (nfs4_has_session(clp))
d05dd4e9
TM
382 return rpc_restart_call_prepare(task);
383 return rpc_restart_call(task);
0110ee15 384}