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