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