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