xref: /openbmc/linux/fs/nfs/internal.h (revision e50a7a1a)
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 };
142 
143 extern int nfs_mount(struct nfs_mount_request *info);
144 extern void nfs_umount(const struct nfs_mount_request *info);
145 
146 /* client.c */
147 extern struct rpc_program nfs_program;
148 
149 extern void nfs_cleanup_cb_ident_idr(void);
150 extern void nfs_put_client(struct nfs_client *);
151 extern struct nfs_client *nfs4_find_client_no_ident(const struct sockaddr *);
152 extern struct nfs_client *nfs4_find_client_ident(int);
153 extern struct nfs_client *
154 nfs4_find_client_sessionid(const struct sockaddr *, struct nfs4_sessionid *);
155 extern struct nfs_server *nfs_create_server(
156 					const struct nfs_parsed_mount_data *,
157 					struct nfs_fh *);
158 extern struct nfs_server *nfs4_create_server(
159 					const struct nfs_parsed_mount_data *,
160 					struct nfs_fh *);
161 extern struct nfs_server *nfs4_create_referral_server(struct nfs_clone_mount *,
162 						      struct nfs_fh *);
163 extern void nfs_free_server(struct nfs_server *server);
164 extern struct nfs_server *nfs_clone_server(struct nfs_server *,
165 					   struct nfs_fh *,
166 					   struct nfs_fattr *);
167 extern void nfs_mark_client_ready(struct nfs_client *clp, int state);
168 extern int nfs4_check_client_ready(struct nfs_client *clp);
169 extern struct nfs_client *nfs4_set_ds_client(struct nfs_client* mds_clp,
170 					     const struct sockaddr *ds_addr,
171 					     int ds_addrlen, int ds_proto);
172 #ifdef CONFIG_PROC_FS
173 extern int __init nfs_fs_proc_init(void);
174 extern void nfs_fs_proc_exit(void);
175 #else
176 static inline int nfs_fs_proc_init(void)
177 {
178 	return 0;
179 }
180 static inline void nfs_fs_proc_exit(void)
181 {
182 }
183 #endif
184 
185 /* nfs4namespace.c */
186 #ifdef CONFIG_NFS_V4
187 extern struct vfsmount *nfs_do_refmount(struct dentry *dentry);
188 #else
189 static inline
190 struct vfsmount *nfs_do_refmount(struct dentry *dentry)
191 {
192 	return ERR_PTR(-ENOENT);
193 }
194 #endif
195 
196 /* callback_xdr.c */
197 extern struct svc_version nfs4_callback_version1;
198 extern struct svc_version nfs4_callback_version4;
199 
200 /* pagelist.c */
201 extern int __init nfs_init_nfspagecache(void);
202 extern void nfs_destroy_nfspagecache(void);
203 extern int __init nfs_init_readpagecache(void);
204 extern void nfs_destroy_readpagecache(void);
205 extern int __init nfs_init_writepagecache(void);
206 extern void nfs_destroy_writepagecache(void);
207 
208 extern int __init nfs_init_directcache(void);
209 extern void nfs_destroy_directcache(void);
210 
211 /* nfs2xdr.c */
212 extern int nfs_stat_to_errno(enum nfs_stat);
213 extern struct rpc_procinfo nfs_procedures[];
214 extern int nfs2_decode_dirent(struct xdr_stream *,
215 				struct nfs_entry *, int);
216 
217 /* nfs3xdr.c */
218 extern struct rpc_procinfo nfs3_procedures[];
219 extern int nfs3_decode_dirent(struct xdr_stream *,
220 				struct nfs_entry *, int);
221 
222 /* nfs4xdr.c */
223 #ifdef CONFIG_NFS_V4
224 extern int nfs4_decode_dirent(struct xdr_stream *,
225 				struct nfs_entry *, int);
226 #endif
227 #ifdef CONFIG_NFS_V4_1
228 extern const u32 nfs41_maxread_overhead;
229 extern const u32 nfs41_maxwrite_overhead;
230 #endif
231 
232 /* nfs4proc.c */
233 #ifdef CONFIG_NFS_V4
234 extern struct rpc_procinfo nfs4_procedures[];
235 void nfs_fixup_secinfo_attributes(struct nfs_fattr *, struct nfs_fh *);
236 #endif
237 
238 extern int nfs4_init_ds_session(struct nfs_client *clp);
239 
240 /* proc.c */
241 void nfs_close_context(struct nfs_open_context *ctx, int is_sync);
242 extern int nfs_init_client(struct nfs_client *clp,
243 			   const struct rpc_timeout *timeparms,
244 			   const char *ip_addr, rpc_authflavor_t authflavour,
245 			   int noresvport);
246 
247 /* dir.c */
248 extern int nfs_access_cache_shrinker(struct shrinker *shrink,
249 					struct shrink_control *sc);
250 
251 /* inode.c */
252 extern struct workqueue_struct *nfsiod_workqueue;
253 extern struct inode *nfs_alloc_inode(struct super_block *sb);
254 extern void nfs_destroy_inode(struct inode *);
255 extern int nfs_write_inode(struct inode *, struct writeback_control *);
256 extern void nfs_evict_inode(struct inode *);
257 #ifdef CONFIG_NFS_V4
258 extern void nfs4_evict_inode(struct inode *);
259 #endif
260 void nfs_zap_acl_cache(struct inode *inode);
261 extern int nfs_wait_bit_killable(void *word);
262 
263 /* super.c */
264 extern struct file_system_type nfs_xdev_fs_type;
265 #ifdef CONFIG_NFS_V4
266 extern struct file_system_type nfs4_xdev_fs_type;
267 extern struct file_system_type nfs4_referral_fs_type;
268 #endif
269 
270 extern struct rpc_stat nfs_rpcstat;
271 
272 extern int __init register_nfs_fs(void);
273 extern void __exit unregister_nfs_fs(void);
274 extern void nfs_sb_active(struct super_block *sb);
275 extern void nfs_sb_deactive(struct super_block *sb);
276 
277 /* namespace.c */
278 extern char *nfs_path(char **p, struct dentry *dentry,
279 		      char *buffer, ssize_t buflen);
280 extern struct vfsmount *nfs_d_automount(struct path *path);
281 #ifdef CONFIG_NFS_V4
282 rpc_authflavor_t nfs_find_best_sec(struct nfs4_secinfo_flavors *);
283 #endif
284 
285 /* getroot.c */
286 extern struct dentry *nfs_get_root(struct super_block *, struct nfs_fh *,
287 				   const char *);
288 #ifdef CONFIG_NFS_V4
289 extern struct dentry *nfs4_get_root(struct super_block *, struct nfs_fh *,
290 				    const char *);
291 
292 extern int nfs4_get_rootfh(struct nfs_server *server, struct nfs_fh *mntfh);
293 #endif
294 
295 struct nfs_pageio_descriptor;
296 /* read.c */
297 extern int nfs_initiate_read(struct nfs_read_data *data, struct rpc_clnt *clnt,
298 			     const struct rpc_call_ops *call_ops);
299 extern void nfs_read_prepare(struct rpc_task *task, void *calldata);
300 extern int nfs_generic_pagein(struct nfs_pageio_descriptor *desc,
301 		struct list_head *head);
302 
303 extern void nfs_pageio_init_read_mds(struct nfs_pageio_descriptor *pgio,
304 		struct inode *inode);
305 extern void nfs_pageio_reset_read_mds(struct nfs_pageio_descriptor *pgio);
306 extern void nfs_readdata_release(struct nfs_read_data *rdata);
307 
308 /* write.c */
309 extern int nfs_generic_flush(struct nfs_pageio_descriptor *desc,
310 		struct list_head *head);
311 extern void nfs_pageio_init_write_mds(struct nfs_pageio_descriptor *pgio,
312 				  struct inode *inode, int ioflags);
313 extern void nfs_pageio_reset_write_mds(struct nfs_pageio_descriptor *pgio);
314 extern void nfs_writedata_release(struct nfs_write_data *wdata);
315 extern void nfs_commit_free(struct nfs_write_data *p);
316 extern int nfs_initiate_write(struct nfs_write_data *data,
317 			      struct rpc_clnt *clnt,
318 			      const struct rpc_call_ops *call_ops,
319 			      int how);
320 extern void nfs_write_prepare(struct rpc_task *task, void *calldata);
321 extern int nfs_initiate_commit(struct nfs_write_data *data,
322 			       struct rpc_clnt *clnt,
323 			       const struct rpc_call_ops *call_ops,
324 			       int how);
325 extern void nfs_init_commit(struct nfs_write_data *data,
326 			    struct list_head *head,
327 			    struct pnfs_layout_segment *lseg);
328 void nfs_retry_commit(struct list_head *page_list,
329 		      struct pnfs_layout_segment *lseg);
330 void nfs_commit_clear_lock(struct nfs_inode *nfsi);
331 void nfs_commitdata_release(void *data);
332 void nfs_commit_release_pages(struct nfs_write_data *data);
333 
334 #ifdef CONFIG_MIGRATION
335 extern int nfs_migrate_page(struct address_space *,
336 		struct page *, struct page *, enum migrate_mode);
337 #else
338 #define nfs_migrate_page NULL
339 #endif
340 
341 /* nfs4proc.c */
342 extern void __nfs4_read_done_cb(struct nfs_read_data *);
343 extern void nfs4_reset_read(struct rpc_task *task, struct nfs_read_data *data);
344 extern int nfs4_init_client(struct nfs_client *clp,
345 			    const struct rpc_timeout *timeparms,
346 			    const char *ip_addr,
347 			    rpc_authflavor_t authflavour,
348 			    int noresvport);
349 extern void nfs4_reset_write(struct rpc_task *task, struct nfs_write_data *data);
350 extern int _nfs4_call_sync(struct rpc_clnt *clnt,
351 			   struct nfs_server *server,
352 			   struct rpc_message *msg,
353 			   struct nfs4_sequence_args *args,
354 			   struct nfs4_sequence_res *res,
355 			   int cache_reply);
356 extern int _nfs4_call_sync_session(struct rpc_clnt *clnt,
357 				   struct nfs_server *server,
358 				   struct rpc_message *msg,
359 				   struct nfs4_sequence_args *args,
360 				   struct nfs4_sequence_res *res,
361 				   int cache_reply);
362 
363 /*
364  * Determine the device name as a string
365  */
366 static inline char *nfs_devname(struct dentry *dentry,
367 				char *buffer, ssize_t buflen)
368 {
369 	char *dummy;
370 	return nfs_path(&dummy, dentry, buffer, buflen);
371 }
372 
373 /*
374  * Determine the actual block size (and log2 thereof)
375  */
376 static inline
377 unsigned long nfs_block_bits(unsigned long bsize, unsigned char *nrbitsp)
378 {
379 	/* make sure blocksize is a power of two */
380 	if ((bsize & (bsize - 1)) || nrbitsp) {
381 		unsigned char	nrbits;
382 
383 		for (nrbits = 31; nrbits && !(bsize & (1 << nrbits)); nrbits--)
384 			;
385 		bsize = 1 << nrbits;
386 		if (nrbitsp)
387 			*nrbitsp = nrbits;
388 	}
389 
390 	return bsize;
391 }
392 
393 /*
394  * Calculate the number of 512byte blocks used.
395  */
396 static inline blkcnt_t nfs_calc_block_size(u64 tsize)
397 {
398 	blkcnt_t used = (tsize + 511) >> 9;
399 	return (used > ULONG_MAX) ? ULONG_MAX : used;
400 }
401 
402 /*
403  * Compute and set NFS server blocksize
404  */
405 static inline
406 unsigned long nfs_block_size(unsigned long bsize, unsigned char *nrbitsp)
407 {
408 	if (bsize < NFS_MIN_FILE_IO_SIZE)
409 		bsize = NFS_DEF_FILE_IO_SIZE;
410 	else if (bsize >= NFS_MAX_FILE_IO_SIZE)
411 		bsize = NFS_MAX_FILE_IO_SIZE;
412 
413 	return nfs_block_bits(bsize, nrbitsp);
414 }
415 
416 /*
417  * Determine the maximum file size for a superblock
418  */
419 static inline
420 void nfs_super_set_maxbytes(struct super_block *sb, __u64 maxfilesize)
421 {
422 	sb->s_maxbytes = (loff_t)maxfilesize;
423 	if (sb->s_maxbytes > MAX_LFS_FILESIZE || sb->s_maxbytes <= 0)
424 		sb->s_maxbytes = MAX_LFS_FILESIZE;
425 }
426 
427 /*
428  * Determine the number of bytes of data the page contains
429  */
430 static inline
431 unsigned int nfs_page_length(struct page *page)
432 {
433 	loff_t i_size = i_size_read(page->mapping->host);
434 
435 	if (i_size > 0) {
436 		pgoff_t end_index = (i_size - 1) >> PAGE_CACHE_SHIFT;
437 		if (page->index < end_index)
438 			return PAGE_CACHE_SIZE;
439 		if (page->index == end_index)
440 			return ((i_size - 1) & ~PAGE_CACHE_MASK) + 1;
441 	}
442 	return 0;
443 }
444 
445 /*
446  * Convert a umode to a dirent->d_type
447  */
448 static inline
449 unsigned char nfs_umode_to_dtype(umode_t mode)
450 {
451 	return (mode >> 12) & 15;
452 }
453 
454 /*
455  * Determine the number of pages in an array of length 'len' and
456  * with a base offset of 'base'
457  */
458 static inline
459 unsigned int nfs_page_array_len(unsigned int base, size_t len)
460 {
461 	return ((unsigned long)len + (unsigned long)base +
462 		PAGE_SIZE - 1) >> PAGE_SHIFT;
463 }
464 
465