xref: /openbmc/linux/fs/nfs/internal.h (revision 63dc02bd)
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 static inline void nfs_attr_check_mountpoint(struct super_block *parent, struct nfs_fattr *fattr)
43 {
44 	if (!nfs_fsid_equal(&NFS_SB(parent)->fsid, &fattr->fsid))
45 		fattr->valid |= NFS_ATTR_FATTR_MOUNTPOINT;
46 }
47 
48 static inline int nfs_attr_use_mounted_on_fileid(struct nfs_fattr *fattr)
49 {
50 	if (((fattr->valid & NFS_ATTR_FATTR_MOUNTED_ON_FILEID) == 0) ||
51 	    (((fattr->valid & NFS_ATTR_FATTR_MOUNTPOINT) == 0) &&
52 	     ((fattr->valid & NFS_ATTR_FATTR_V4_REFERRAL) == 0)))
53 		return 0;
54 
55 	fattr->fileid = fattr->mounted_on_fileid;
56 	return 1;
57 }
58 
59 struct nfs_clone_mount {
60 	const struct super_block *sb;
61 	const struct dentry *dentry;
62 	struct nfs_fh *fh;
63 	struct nfs_fattr *fattr;
64 	char *hostname;
65 	char *mnt_path;
66 	struct sockaddr *addr;
67 	size_t addrlen;
68 	rpc_authflavor_t authflavor;
69 };
70 
71 /*
72  * Note: RFC 1813 doesn't limit the number of auth flavors that
73  * a server can return, so make something up.
74  */
75 #define NFS_MAX_SECFLAVORS	(12)
76 
77 /*
78  * Value used if the user did not specify a port value.
79  */
80 #define NFS_UNSPEC_PORT		(-1)
81 
82 /*
83  * Maximum number of pages that readdir can use for creating
84  * a vmapped array of pages.
85  */
86 #define NFS_MAX_READDIR_PAGES 8
87 
88 /*
89  * In-kernel mount arguments
90  */
91 struct nfs_parsed_mount_data {
92 	int			flags;
93 	int			rsize, wsize;
94 	int			timeo, retrans;
95 	int			acregmin, acregmax,
96 				acdirmin, acdirmax;
97 	int			namlen;
98 	unsigned int		options;
99 	unsigned int		bsize;
100 	unsigned int		auth_flavor_len;
101 	rpc_authflavor_t	auth_flavors[1];
102 	char			*client_address;
103 	unsigned int		version;
104 	unsigned int		minorversion;
105 	char			*fscache_uniq;
106 
107 	struct {
108 		struct sockaddr_storage	address;
109 		size_t			addrlen;
110 		char			*hostname;
111 		u32			version;
112 		int			port;
113 		unsigned short		protocol;
114 	} mount_server;
115 
116 	struct {
117 		struct sockaddr_storage	address;
118 		size_t			addrlen;
119 		char			*hostname;
120 		char			*export_path;
121 		int			port;
122 		unsigned short		protocol;
123 	} nfs_server;
124 
125 	struct security_mnt_opts lsm_opts;
126 	struct net		*net;
127 };
128 
129 /* mount_clnt.c */
130 struct nfs_mount_request {
131 	struct sockaddr		*sap;
132 	size_t			salen;
133 	char			*hostname;
134 	char			*dirpath;
135 	u32			version;
136 	unsigned short		protocol;
137 	struct nfs_fh		*fh;
138 	int			noresvport;
139 	unsigned int		*auth_flav_len;
140 	rpc_authflavor_t	*auth_flavs;
141 	struct net		*net;
142 };
143 
144 extern int nfs_mount(struct nfs_mount_request *info);
145 extern void nfs_umount(const struct nfs_mount_request *info);
146 
147 /* client.c */
148 extern const struct rpc_program nfs_program;
149 extern void nfs_clients_init(struct net *net);
150 
151 extern void nfs_cleanup_cb_ident_idr(struct net *);
152 extern void nfs_put_client(struct nfs_client *);
153 extern struct nfs_client *nfs4_find_client_ident(struct net *, int);
154 extern struct nfs_client *
155 nfs4_find_client_sessionid(struct net *, const struct sockaddr *,
156 				struct nfs4_sessionid *);
157 extern struct nfs_server *nfs_create_server(
158 					const struct nfs_parsed_mount_data *,
159 					struct nfs_fh *);
160 extern struct nfs_server *nfs4_create_server(
161 					const struct nfs_parsed_mount_data *,
162 					struct nfs_fh *);
163 extern struct nfs_server *nfs4_create_referral_server(struct nfs_clone_mount *,
164 						      struct nfs_fh *);
165 extern void nfs_free_server(struct nfs_server *server);
166 extern struct nfs_server *nfs_clone_server(struct nfs_server *,
167 					   struct nfs_fh *,
168 					   struct nfs_fattr *,
169 					   rpc_authflavor_t);
170 extern void nfs_mark_client_ready(struct nfs_client *clp, int state);
171 extern int nfs4_check_client_ready(struct nfs_client *clp);
172 extern struct nfs_client *nfs4_set_ds_client(struct nfs_client* mds_clp,
173 					     const struct sockaddr *ds_addr,
174 					     int ds_addrlen, int ds_proto);
175 #ifdef CONFIG_PROC_FS
176 extern int __init nfs_fs_proc_init(void);
177 extern void nfs_fs_proc_exit(void);
178 #else
179 static inline int nfs_fs_proc_init(void)
180 {
181 	return 0;
182 }
183 static inline void nfs_fs_proc_exit(void)
184 {
185 }
186 #endif
187 
188 /* nfs4namespace.c */
189 #ifdef CONFIG_NFS_V4
190 extern struct vfsmount *nfs_do_refmount(struct rpc_clnt *client, struct dentry *dentry);
191 #else
192 static inline
193 struct vfsmount *nfs_do_refmount(struct rpc_clnt *client, struct dentry *dentry)
194 {
195 	return ERR_PTR(-ENOENT);
196 }
197 #endif
198 
199 /* callback_xdr.c */
200 extern struct svc_version nfs4_callback_version1;
201 extern struct svc_version nfs4_callback_version4;
202 
203 /* pagelist.c */
204 extern int __init nfs_init_nfspagecache(void);
205 extern void nfs_destroy_nfspagecache(void);
206 extern int __init nfs_init_readpagecache(void);
207 extern void nfs_destroy_readpagecache(void);
208 extern int __init nfs_init_writepagecache(void);
209 extern void nfs_destroy_writepagecache(void);
210 
211 extern int __init nfs_init_directcache(void);
212 extern void nfs_destroy_directcache(void);
213 
214 /* nfs2xdr.c */
215 extern int nfs_stat_to_errno(enum nfs_stat);
216 extern struct rpc_procinfo nfs_procedures[];
217 extern int nfs2_decode_dirent(struct xdr_stream *,
218 				struct nfs_entry *, int);
219 
220 /* nfs3xdr.c */
221 extern struct rpc_procinfo nfs3_procedures[];
222 extern int nfs3_decode_dirent(struct xdr_stream *,
223 				struct nfs_entry *, int);
224 
225 /* nfs4xdr.c */
226 #ifdef CONFIG_NFS_V4
227 extern int nfs4_decode_dirent(struct xdr_stream *,
228 				struct nfs_entry *, int);
229 #endif
230 #ifdef CONFIG_NFS_V4_1
231 extern const u32 nfs41_maxread_overhead;
232 extern const u32 nfs41_maxwrite_overhead;
233 #endif
234 
235 /* nfs4proc.c */
236 #ifdef CONFIG_NFS_V4
237 extern struct rpc_procinfo nfs4_procedures[];
238 #endif
239 
240 extern int nfs4_init_ds_session(struct nfs_client *clp);
241 
242 /* proc.c */
243 void nfs_close_context(struct nfs_open_context *ctx, int is_sync);
244 extern int nfs_init_client(struct nfs_client *clp,
245 			   const struct rpc_timeout *timeparms,
246 			   const char *ip_addr, rpc_authflavor_t authflavour,
247 			   int noresvport);
248 
249 /* dir.c */
250 extern int nfs_access_cache_shrinker(struct shrinker *shrink,
251 					struct shrink_control *sc);
252 
253 /* inode.c */
254 extern struct workqueue_struct *nfsiod_workqueue;
255 extern struct inode *nfs_alloc_inode(struct super_block *sb);
256 extern void nfs_destroy_inode(struct inode *);
257 extern int nfs_write_inode(struct inode *, struct writeback_control *);
258 extern void nfs_evict_inode(struct inode *);
259 #ifdef CONFIG_NFS_V4
260 extern void nfs4_evict_inode(struct inode *);
261 #endif
262 void nfs_zap_acl_cache(struct inode *inode);
263 extern int nfs_wait_bit_killable(void *word);
264 
265 /* super.c */
266 extern struct file_system_type nfs_xdev_fs_type;
267 #ifdef CONFIG_NFS_V4
268 extern struct file_system_type nfs4_xdev_fs_type;
269 extern struct file_system_type nfs4_referral_fs_type;
270 #endif
271 
272 extern struct rpc_stat nfs_rpcstat;
273 
274 extern int __init register_nfs_fs(void);
275 extern void __exit unregister_nfs_fs(void);
276 extern void nfs_sb_active(struct super_block *sb);
277 extern void nfs_sb_deactive(struct super_block *sb);
278 
279 /* namespace.c */
280 extern char *nfs_path(char **p, struct dentry *dentry,
281 		      char *buffer, ssize_t buflen);
282 extern struct vfsmount *nfs_d_automount(struct path *path);
283 #ifdef CONFIG_NFS_V4
284 rpc_authflavor_t nfs_find_best_sec(struct nfs4_secinfo_flavors *);
285 #endif
286 
287 /* getroot.c */
288 extern struct dentry *nfs_get_root(struct super_block *, struct nfs_fh *,
289 				   const char *);
290 #ifdef CONFIG_NFS_V4
291 extern struct dentry *nfs4_get_root(struct super_block *, struct nfs_fh *,
292 				    const char *);
293 
294 extern int nfs4_get_rootfh(struct nfs_server *server, struct nfs_fh *mntfh);
295 #endif
296 
297 struct nfs_pageio_descriptor;
298 /* read.c */
299 extern int nfs_initiate_read(struct nfs_read_data *data, struct rpc_clnt *clnt,
300 			     const struct rpc_call_ops *call_ops);
301 extern void nfs_read_prepare(struct rpc_task *task, void *calldata);
302 extern int nfs_generic_pagein(struct nfs_pageio_descriptor *desc,
303 		struct list_head *head);
304 
305 extern void nfs_pageio_init_read_mds(struct nfs_pageio_descriptor *pgio,
306 		struct inode *inode);
307 extern void nfs_pageio_reset_read_mds(struct nfs_pageio_descriptor *pgio);
308 extern void nfs_readdata_release(struct nfs_read_data *rdata);
309 
310 /* write.c */
311 extern int nfs_generic_flush(struct nfs_pageio_descriptor *desc,
312 		struct list_head *head);
313 extern void nfs_pageio_init_write_mds(struct nfs_pageio_descriptor *pgio,
314 				  struct inode *inode, int ioflags);
315 extern void nfs_pageio_reset_write_mds(struct nfs_pageio_descriptor *pgio);
316 extern void nfs_writedata_release(struct nfs_write_data *wdata);
317 extern void nfs_commit_free(struct nfs_write_data *p);
318 extern int nfs_initiate_write(struct nfs_write_data *data,
319 			      struct rpc_clnt *clnt,
320 			      const struct rpc_call_ops *call_ops,
321 			      int how);
322 extern void nfs_write_prepare(struct rpc_task *task, void *calldata);
323 extern int nfs_initiate_commit(struct nfs_write_data *data,
324 			       struct rpc_clnt *clnt,
325 			       const struct rpc_call_ops *call_ops,
326 			       int how);
327 extern void nfs_init_commit(struct nfs_write_data *data,
328 			    struct list_head *head,
329 			    struct pnfs_layout_segment *lseg);
330 void nfs_retry_commit(struct list_head *page_list,
331 		      struct pnfs_layout_segment *lseg);
332 void nfs_commit_clear_lock(struct nfs_inode *nfsi);
333 void nfs_commitdata_release(void *data);
334 void nfs_commit_release_pages(struct nfs_write_data *data);
335 void nfs_request_add_commit_list(struct nfs_page *req, struct list_head *head);
336 void nfs_request_remove_commit_list(struct nfs_page *req);
337 
338 #ifdef CONFIG_MIGRATION
339 extern int nfs_migrate_page(struct address_space *,
340 		struct page *, struct page *, enum migrate_mode);
341 #else
342 #define nfs_migrate_page NULL
343 #endif
344 
345 /* nfs4proc.c */
346 extern void __nfs4_read_done_cb(struct nfs_read_data *);
347 extern void nfs4_reset_read(struct rpc_task *task, struct nfs_read_data *data);
348 extern int nfs4_init_client(struct nfs_client *clp,
349 			    const struct rpc_timeout *timeparms,
350 			    const char *ip_addr,
351 			    rpc_authflavor_t authflavour,
352 			    int noresvport);
353 extern void nfs4_reset_write(struct rpc_task *task, struct nfs_write_data *data);
354 extern int _nfs4_call_sync(struct rpc_clnt *clnt,
355 			   struct nfs_server *server,
356 			   struct rpc_message *msg,
357 			   struct nfs4_sequence_args *args,
358 			   struct nfs4_sequence_res *res,
359 			   int cache_reply);
360 extern int _nfs4_call_sync_session(struct rpc_clnt *clnt,
361 				   struct nfs_server *server,
362 				   struct rpc_message *msg,
363 				   struct nfs4_sequence_args *args,
364 				   struct nfs4_sequence_res *res,
365 				   int cache_reply);
366 
367 /*
368  * Determine the device name as a string
369  */
370 static inline char *nfs_devname(struct dentry *dentry,
371 				char *buffer, ssize_t buflen)
372 {
373 	char *dummy;
374 	return nfs_path(&dummy, dentry, buffer, buflen);
375 }
376 
377 /*
378  * Determine the actual block size (and log2 thereof)
379  */
380 static inline
381 unsigned long nfs_block_bits(unsigned long bsize, unsigned char *nrbitsp)
382 {
383 	/* make sure blocksize is a power of two */
384 	if ((bsize & (bsize - 1)) || nrbitsp) {
385 		unsigned char	nrbits;
386 
387 		for (nrbits = 31; nrbits && !(bsize & (1 << nrbits)); nrbits--)
388 			;
389 		bsize = 1 << nrbits;
390 		if (nrbitsp)
391 			*nrbitsp = nrbits;
392 	}
393 
394 	return bsize;
395 }
396 
397 /*
398  * Calculate the number of 512byte blocks used.
399  */
400 static inline blkcnt_t nfs_calc_block_size(u64 tsize)
401 {
402 	blkcnt_t used = (tsize + 511) >> 9;
403 	return (used > ULONG_MAX) ? ULONG_MAX : used;
404 }
405 
406 /*
407  * Compute and set NFS server blocksize
408  */
409 static inline
410 unsigned long nfs_block_size(unsigned long bsize, unsigned char *nrbitsp)
411 {
412 	if (bsize < NFS_MIN_FILE_IO_SIZE)
413 		bsize = NFS_DEF_FILE_IO_SIZE;
414 	else if (bsize >= NFS_MAX_FILE_IO_SIZE)
415 		bsize = NFS_MAX_FILE_IO_SIZE;
416 
417 	return nfs_block_bits(bsize, nrbitsp);
418 }
419 
420 /*
421  * Determine the maximum file size for a superblock
422  */
423 static inline
424 void nfs_super_set_maxbytes(struct super_block *sb, __u64 maxfilesize)
425 {
426 	sb->s_maxbytes = (loff_t)maxfilesize;
427 	if (sb->s_maxbytes > MAX_LFS_FILESIZE || sb->s_maxbytes <= 0)
428 		sb->s_maxbytes = MAX_LFS_FILESIZE;
429 }
430 
431 /*
432  * Determine the number of bytes of data the page contains
433  */
434 static inline
435 unsigned int nfs_page_length(struct page *page)
436 {
437 	loff_t i_size = i_size_read(page->mapping->host);
438 
439 	if (i_size > 0) {
440 		pgoff_t end_index = (i_size - 1) >> PAGE_CACHE_SHIFT;
441 		if (page->index < end_index)
442 			return PAGE_CACHE_SIZE;
443 		if (page->index == end_index)
444 			return ((i_size - 1) & ~PAGE_CACHE_MASK) + 1;
445 	}
446 	return 0;
447 }
448 
449 /*
450  * Convert a umode to a dirent->d_type
451  */
452 static inline
453 unsigned char nfs_umode_to_dtype(umode_t mode)
454 {
455 	return (mode >> 12) & 15;
456 }
457 
458 /*
459  * Determine the number of pages in an array of length 'len' and
460  * with a base offset of 'base'
461  */
462 static inline
463 unsigned int nfs_page_array_len(unsigned int base, size_t len)
464 {
465 	return ((unsigned long)len + (unsigned long)base +
466 		PAGE_SIZE - 1) >> PAGE_SHIFT;
467 }
468 
469