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