xref: /openbmc/linux/fs/nfs/internal.h (revision 56e4ebf877b6043c289bda32a5a7385b80c17dee)
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  * 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 
71 /*
72  * In-kernel mount arguments
73  */
74 struct 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;
81 	unsigned int		options;
82 	unsigned int		bsize;
83 	unsigned int		auth_flavor_len;
84 	rpc_authflavor_t	auth_flavors[1];
85 	char			*client_address;
86 	unsigned int		version;
87 	unsigned int		minorversion;
88 	char			*fscache_uniq;
89 
90 	struct {
91 		struct sockaddr_storage	address;
92 		size_t			addrlen;
93 		char			*hostname;
94 		u32			version;
95 		int			port;
96 		unsigned short		protocol;
97 	} mount_server;
98 
99 	struct {
100 		struct sockaddr_storage	address;
101 		size_t			addrlen;
102 		char			*hostname;
103 		char			*export_path;
104 		int			port;
105 		unsigned short		protocol;
106 	} nfs_server;
107 
108 	struct security_mnt_opts lsm_opts;
109 };
110 
111 /* mount_clnt.c */
112 struct 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;
120 	int			noresvport;
121 	unsigned int		*auth_flav_len;
122 	rpc_authflavor_t	*auth_flavs;
123 };
124 
125 extern int nfs_mount(struct nfs_mount_request *info);
126 extern void nfs_umount(const struct nfs_mount_request *info);
127 
128 /* client.c */
129 extern struct rpc_program nfs_program;
130 
131 extern void nfs_put_client(struct nfs_client *);
132 extern struct nfs_client *nfs_find_client(const struct sockaddr *, u32);
133 extern struct nfs_client *nfs_find_client_next(struct nfs_client *);
134 extern struct nfs_server *nfs_create_server(
135 					const struct nfs_parsed_mount_data *,
136 					struct nfs_fh *);
137 extern struct nfs_server *nfs4_create_server(
138 					const struct nfs_parsed_mount_data *,
139 					struct nfs_fh *);
140 extern struct nfs_server *nfs4_create_referral_server(struct nfs_clone_mount *,
141 						      struct nfs_fh *);
142 extern void nfs_free_server(struct nfs_server *server);
143 extern struct nfs_server *nfs_clone_server(struct nfs_server *,
144 					   struct nfs_fh *,
145 					   struct nfs_fattr *);
146 extern void nfs_mark_client_ready(struct nfs_client *clp, int state);
147 extern int nfs4_check_client_ready(struct nfs_client *clp);
148 #ifdef CONFIG_PROC_FS
149 extern int __init nfs_fs_proc_init(void);
150 extern void nfs_fs_proc_exit(void);
151 #else
152 static inline int nfs_fs_proc_init(void)
153 {
154 	return 0;
155 }
156 static inline void nfs_fs_proc_exit(void)
157 {
158 }
159 #endif
160 
161 /* nfs4namespace.c */
162 #ifdef CONFIG_NFS_V4
163 extern struct vfsmount *nfs_do_refmount(const struct vfsmount *mnt_parent, struct dentry *dentry);
164 #else
165 static inline
166 struct 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 */
173 extern struct svc_version nfs4_callback_version1;
174 extern struct svc_version nfs4_callback_version4;
175 
176 /* pagelist.c */
177 extern int __init nfs_init_nfspagecache(void);
178 extern void nfs_destroy_nfspagecache(void);
179 extern int __init nfs_init_readpagecache(void);
180 extern void nfs_destroy_readpagecache(void);
181 extern int __init nfs_init_writepagecache(void);
182 extern void nfs_destroy_writepagecache(void);
183 
184 extern int __init nfs_init_directcache(void);
185 extern void nfs_destroy_directcache(void);
186 
187 /* nfs2xdr.c */
188 extern int nfs_stat_to_errno(int);
189 extern struct rpc_procinfo nfs_procedures[];
190 extern __be32 *nfs_decode_dirent(struct xdr_stream *, struct nfs_entry *, int);
191 
192 /* nfs3xdr.c */
193 extern struct rpc_procinfo nfs3_procedures[];
194 extern __be32 *nfs3_decode_dirent(struct xdr_stream *, struct nfs_entry *, int);
195 
196 /* nfs4xdr.c */
197 #ifdef CONFIG_NFS_V4
198 extern __be32 *nfs4_decode_dirent(struct xdr_stream *, struct nfs_entry *entry, int plus);
199 #endif
200 #ifdef CONFIG_NFS_V4_1
201 extern const u32 nfs41_maxread_overhead;
202 extern const u32 nfs41_maxwrite_overhead;
203 #endif
204 
205 /* nfs4proc.c */
206 #ifdef CONFIG_NFS_V4
207 extern struct rpc_procinfo nfs4_procedures[];
208 #endif
209 
210 /* proc.c */
211 void nfs_close_context(struct nfs_open_context *ctx, int is_sync);
212 
213 /* dir.c */
214 extern int nfs_access_cache_shrinker(struct shrinker *shrink,
215 					int nr_to_scan, gfp_t gfp_mask);
216 
217 /* inode.c */
218 extern struct workqueue_struct *nfsiod_workqueue;
219 extern struct inode *nfs_alloc_inode(struct super_block *sb);
220 extern void nfs_destroy_inode(struct inode *);
221 extern int nfs_write_inode(struct inode *, struct writeback_control *);
222 extern void nfs_evict_inode(struct inode *);
223 #ifdef CONFIG_NFS_V4
224 extern void nfs4_evict_inode(struct inode *);
225 #endif
226 void nfs_zap_acl_cache(struct inode *inode);
227 extern int nfs_wait_bit_killable(void *word);
228 
229 /* super.c */
230 extern struct file_system_type nfs_xdev_fs_type;
231 #ifdef CONFIG_NFS_V4
232 extern struct file_system_type nfs4_xdev_fs_type;
233 extern struct file_system_type nfs4_referral_fs_type;
234 #endif
235 
236 extern struct rpc_stat nfs_rpcstat;
237 
238 extern int __init register_nfs_fs(void);
239 extern void __exit unregister_nfs_fs(void);
240 extern void nfs_sb_active(struct super_block *sb);
241 extern void nfs_sb_deactive(struct super_block *sb);
242 
243 /* namespace.c */
244 extern char *nfs_path(const char *base,
245 		      const struct dentry *droot,
246 		      const struct dentry *dentry,
247 		      char *buffer, ssize_t buflen);
248 
249 /* getroot.c */
250 extern struct dentry *nfs_get_root(struct super_block *, struct nfs_fh *);
251 #ifdef CONFIG_NFS_V4
252 extern struct dentry *nfs4_get_root(struct super_block *, struct nfs_fh *);
253 
254 extern int nfs4_get_rootfh(struct nfs_server *server, struct nfs_fh *mntfh);
255 #endif
256 
257 /* read.c */
258 extern void nfs_read_prepare(struct rpc_task *task, void *calldata);
259 
260 /* write.c */
261 extern void nfs_write_prepare(struct rpc_task *task, void *calldata);
262 #ifdef CONFIG_MIGRATION
263 extern int nfs_migrate_page(struct address_space *,
264 		struct page *, struct page *);
265 #else
266 #define nfs_migrate_page NULL
267 #endif
268 
269 /* nfs4proc.c */
270 extern 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);
275 extern 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 
281 /*
282  * Determine the device name as a string
283  */
284 static inline char *nfs_devname(const struct vfsmount *mnt_parent,
285 				const struct dentry *dentry,
286 				char *buffer, ssize_t buflen)
287 {
288 	return nfs_path(mnt_parent->mnt_devname, mnt_parent->mnt_root,
289 			dentry, buffer, buflen);
290 }
291 
292 /*
293  * Determine the actual block size (and log2 thereof)
294  */
295 static inline
296 unsigned 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  */
315 static inline blkcnt_t nfs_calc_block_size(u64 tsize)
316 {
317 	blkcnt_t used = (tsize + 511) >> 9;
318 	return (used > ULONG_MAX) ? ULONG_MAX : used;
319 }
320 
321 /*
322  * Compute and set NFS server blocksize
323  */
324 static inline
325 unsigned 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  */
338 static inline
339 void 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 }
345 
346 /*
347  * Determine the number of bytes of data the page contains
348  */
349 static inline
350 unsigned 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 }
363 
364 /*
365  * Determine the number of pages in an array of length 'len' and
366  * with a base offset of 'base'
367  */
368 static inline
369 unsigned 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 }
374 
375 /*
376  * Helper for restarting RPC calls in the possible presence of NFSv4.1
377  * sessions.
378  */
379 static inline int nfs_restart_rpc(struct rpc_task *task, const struct nfs_client *clp)
380 {
381 	if (nfs4_has_session(clp))
382 		return rpc_restart_call_prepare(task);
383 	return rpc_restart_call(task);
384 }
385