xref: /openbmc/linux/fs/nfs/internal.h (revision e0926934)
1 /*
2  * NFS internal definitions
3  */
4 
5 #include "nfs4_fs.h"
6 #include <linux/mount.h>
7 #include <linux/security.h>
8 #include <linux/crc32.h>
9 #include <linux/nfs_page.h>
10 
11 #define NFS_MS_MASK (MS_RDONLY|MS_NOSUID|MS_NODEV|MS_NOEXEC|MS_SYNCHRONOUS)
12 
13 struct nfs_string;
14 
15 /* Maximum number of readahead requests
16  * FIXME: this should really be a sysctl so that users may tune it to suit
17  *        their needs. People that do NFS over a slow network, might for
18  *        instance want to reduce it to something closer to 1 for improved
19  *        interactive response.
20  */
21 #define NFS_MAX_READAHEAD	(RPC_DEF_SLOT_TABLE - 1)
22 
23 static inline void nfs_attr_check_mountpoint(struct super_block *parent, struct nfs_fattr *fattr)
24 {
25 	if (!nfs_fsid_equal(&NFS_SB(parent)->fsid, &fattr->fsid))
26 		fattr->valid |= NFS_ATTR_FATTR_MOUNTPOINT;
27 }
28 
29 static inline int nfs_attr_use_mounted_on_fileid(struct nfs_fattr *fattr)
30 {
31 	if (((fattr->valid & NFS_ATTR_FATTR_MOUNTED_ON_FILEID) == 0) ||
32 	    (((fattr->valid & NFS_ATTR_FATTR_MOUNTPOINT) == 0) &&
33 	     ((fattr->valid & NFS_ATTR_FATTR_V4_REFERRAL) == 0)))
34 		return 0;
35 	return 1;
36 }
37 
38 struct nfs_clone_mount {
39 	const struct super_block *sb;
40 	const struct dentry *dentry;
41 	struct nfs_fh *fh;
42 	struct nfs_fattr *fattr;
43 	char *hostname;
44 	char *mnt_path;
45 	struct sockaddr *addr;
46 	size_t addrlen;
47 	rpc_authflavor_t authflavor;
48 };
49 
50 /*
51  * Note: RFC 1813 doesn't limit the number of auth flavors that
52  * a server can return, so make something up.
53  */
54 #define NFS_MAX_SECFLAVORS	(12)
55 
56 /*
57  * Value used if the user did not specify a port value.
58  */
59 #define NFS_UNSPEC_PORT		(-1)
60 
61 #define NFS_UNSPEC_RETRANS	(UINT_MAX)
62 #define NFS_UNSPEC_TIMEO	(UINT_MAX)
63 
64 /*
65  * Maximum number of pages that readdir can use for creating
66  * a vmapped array of pages.
67  */
68 #define NFS_MAX_READDIR_PAGES 8
69 
70 struct nfs_client_initdata {
71 	unsigned long init_flags;
72 	const char *hostname;			/* Hostname of the server */
73 	const struct sockaddr *addr;		/* Address of the server */
74 	const char *nodename;			/* Hostname of the client */
75 	const char *ip_addr;			/* IP address of the client */
76 	size_t addrlen;
77 	struct nfs_subversion *nfs_mod;
78 	int proto;
79 	u32 minorversion;
80 	struct net *net;
81 	const struct rpc_timeout *timeparms;
82 };
83 
84 /*
85  * In-kernel mount arguments
86  */
87 struct nfs_parsed_mount_data {
88 	int			flags;
89 	unsigned int		rsize, wsize;
90 	unsigned int		timeo, retrans;
91 	unsigned int		acregmin, acregmax,
92 				acdirmin, acdirmax;
93 	unsigned int		namlen;
94 	unsigned int		options;
95 	unsigned int		bsize;
96 	struct nfs_auth_info	auth_info;
97 	rpc_authflavor_t	selected_flavor;
98 	char			*client_address;
99 	unsigned int		version;
100 	unsigned int		minorversion;
101 	char			*fscache_uniq;
102 	bool			need_mount;
103 
104 	struct {
105 		struct sockaddr_storage	address;
106 		size_t			addrlen;
107 		char			*hostname;
108 		u32			version;
109 		int			port;
110 		unsigned short		protocol;
111 	} mount_server;
112 
113 	struct {
114 		struct sockaddr_storage	address;
115 		size_t			addrlen;
116 		char			*hostname;
117 		char			*export_path;
118 		int			port;
119 		unsigned short		protocol;
120 	} nfs_server;
121 
122 	struct security_mnt_opts lsm_opts;
123 	struct net		*net;
124 };
125 
126 /* mount_clnt.c */
127 struct nfs_mount_request {
128 	struct sockaddr		*sap;
129 	size_t			salen;
130 	char			*hostname;
131 	char			*dirpath;
132 	u32			version;
133 	unsigned short		protocol;
134 	struct nfs_fh		*fh;
135 	int			noresvport;
136 	unsigned int		*auth_flav_len;
137 	rpc_authflavor_t	*auth_flavs;
138 	struct net		*net;
139 };
140 
141 struct nfs_mount_info {
142 	void (*fill_super)(struct super_block *, struct nfs_mount_info *);
143 	int (*set_security)(struct super_block *, struct dentry *, struct nfs_mount_info *);
144 	struct nfs_parsed_mount_data *parsed;
145 	struct nfs_clone_mount *cloned;
146 	struct nfs_fh *mntfh;
147 };
148 
149 extern int nfs_mount(struct nfs_mount_request *info);
150 extern void nfs_umount(const struct nfs_mount_request *info);
151 
152 /* client.c */
153 extern const struct rpc_program nfs_program;
154 extern void nfs_clients_init(struct net *net);
155 extern struct nfs_client *nfs_alloc_client(const struct nfs_client_initdata *);
156 int nfs_create_rpc_client(struct nfs_client *, const struct nfs_client_initdata *, rpc_authflavor_t);
157 struct nfs_client *nfs_get_client(const struct nfs_client_initdata *);
158 int nfs_probe_fsinfo(struct nfs_server *server, struct nfs_fh *, struct nfs_fattr *);
159 void nfs_server_insert_lists(struct nfs_server *);
160 void nfs_server_remove_lists(struct nfs_server *);
161 void nfs_init_timeout_values(struct rpc_timeout *to, int proto, int timeo, int retrans);
162 int nfs_init_server_rpcclient(struct nfs_server *, const struct rpc_timeout *t,
163 		rpc_authflavor_t);
164 struct nfs_server *nfs_alloc_server(void);
165 void nfs_server_copy_userdata(struct nfs_server *, struct nfs_server *);
166 
167 extern void nfs_cleanup_cb_ident_idr(struct net *);
168 extern void nfs_put_client(struct nfs_client *);
169 extern void nfs_free_client(struct nfs_client *);
170 extern struct nfs_client *nfs4_find_client_ident(struct net *, int);
171 extern struct nfs_client *
172 nfs4_find_client_sessionid(struct net *, const struct sockaddr *,
173 				struct nfs4_sessionid *, u32);
174 extern struct nfs_server *nfs_create_server(struct nfs_mount_info *,
175 					struct nfs_subversion *);
176 extern struct nfs_server *nfs4_create_server(
177 					struct nfs_mount_info *,
178 					struct nfs_subversion *);
179 extern struct nfs_server *nfs4_create_referral_server(struct nfs_clone_mount *,
180 						      struct nfs_fh *);
181 extern int nfs4_update_server(struct nfs_server *server, const char *hostname,
182 					struct sockaddr *sap, size_t salen,
183 					struct net *net);
184 extern void nfs_free_server(struct nfs_server *server);
185 extern struct nfs_server *nfs_clone_server(struct nfs_server *,
186 					   struct nfs_fh *,
187 					   struct nfs_fattr *,
188 					   rpc_authflavor_t);
189 extern bool nfs_client_init_is_complete(const struct nfs_client *clp);
190 extern int nfs_client_init_status(const struct nfs_client *clp);
191 extern int nfs_wait_client_init_complete(const struct nfs_client *clp);
192 extern void nfs_mark_client_ready(struct nfs_client *clp, int state);
193 extern struct nfs_client *nfs4_set_ds_client(struct nfs_server *mds_srv,
194 					     const struct sockaddr *ds_addr,
195 					     int ds_addrlen, int ds_proto,
196 					     unsigned int ds_timeo,
197 					     unsigned int ds_retrans,
198 					     u32 minor_version);
199 extern struct rpc_clnt *nfs4_find_or_create_ds_client(struct nfs_client *,
200 						struct inode *);
201 extern struct nfs_client *nfs3_set_ds_client(struct nfs_server *mds_srv,
202 			const struct sockaddr *ds_addr, int ds_addrlen,
203 			int ds_proto, unsigned int ds_timeo,
204 			unsigned int ds_retrans);
205 #ifdef CONFIG_PROC_FS
206 extern int __init nfs_fs_proc_init(void);
207 extern void nfs_fs_proc_exit(void);
208 extern int nfs_fs_proc_net_init(struct net *net);
209 extern void nfs_fs_proc_net_exit(struct net *net);
210 #else
211 static inline int nfs_fs_proc_net_init(struct net *net)
212 {
213 	return 0;
214 }
215 static inline void nfs_fs_proc_net_exit(struct net *net)
216 {
217 }
218 static inline int nfs_fs_proc_init(void)
219 {
220 	return 0;
221 }
222 static inline void nfs_fs_proc_exit(void)
223 {
224 }
225 #endif
226 
227 /* callback_xdr.c */
228 extern struct svc_version nfs4_callback_version1;
229 extern struct svc_version nfs4_callback_version4;
230 
231 struct nfs_pageio_descriptor;
232 /* pagelist.c */
233 extern int __init nfs_init_nfspagecache(void);
234 extern void nfs_destroy_nfspagecache(void);
235 extern int __init nfs_init_readpagecache(void);
236 extern void nfs_destroy_readpagecache(void);
237 extern int __init nfs_init_writepagecache(void);
238 extern void nfs_destroy_writepagecache(void);
239 
240 extern int __init nfs_init_directcache(void);
241 extern void nfs_destroy_directcache(void);
242 extern void nfs_pgheader_init(struct nfs_pageio_descriptor *desc,
243 			      struct nfs_pgio_header *hdr,
244 			      void (*release)(struct nfs_pgio_header *hdr));
245 void nfs_set_pgio_error(struct nfs_pgio_header *hdr, int error, loff_t pos);
246 int nfs_iocounter_wait(struct nfs_lock_context *l_ctx);
247 
248 extern const struct nfs_pageio_ops nfs_pgio_rw_ops;
249 struct nfs_pgio_header *nfs_pgio_header_alloc(const struct nfs_rw_ops *);
250 void nfs_pgio_header_free(struct nfs_pgio_header *);
251 void nfs_pgio_data_destroy(struct nfs_pgio_header *);
252 int nfs_generic_pgio(struct nfs_pageio_descriptor *, struct nfs_pgio_header *);
253 int nfs_initiate_pgio(struct rpc_clnt *clnt, struct nfs_pgio_header *hdr,
254 		      struct rpc_cred *cred, const struct nfs_rpc_ops *rpc_ops,
255 		      const struct rpc_call_ops *call_ops, int how, int flags);
256 void nfs_free_request(struct nfs_page *req);
257 struct nfs_pgio_mirror *
258 nfs_pgio_current_mirror(struct nfs_pageio_descriptor *desc);
259 
260 static inline bool nfs_pgio_has_mirroring(struct nfs_pageio_descriptor *desc)
261 {
262 	WARN_ON_ONCE(desc->pg_mirror_count < 1);
263 	return desc->pg_mirror_count > 1;
264 }
265 
266 static inline bool nfs_match_open_context(const struct nfs_open_context *ctx1,
267 		const struct nfs_open_context *ctx2)
268 {
269 	return ctx1->cred == ctx2->cred && ctx1->state == ctx2->state;
270 }
271 
272 /* nfs2xdr.c */
273 extern struct rpc_procinfo nfs_procedures[];
274 extern int nfs2_decode_dirent(struct xdr_stream *,
275 				struct nfs_entry *, int);
276 
277 /* nfs3xdr.c */
278 extern struct rpc_procinfo nfs3_procedures[];
279 extern int nfs3_decode_dirent(struct xdr_stream *,
280 				struct nfs_entry *, int);
281 
282 /* nfs4xdr.c */
283 #if IS_ENABLED(CONFIG_NFS_V4)
284 extern int nfs4_decode_dirent(struct xdr_stream *,
285 				struct nfs_entry *, int);
286 #endif
287 #ifdef CONFIG_NFS_V4_1
288 extern const u32 nfs41_maxread_overhead;
289 extern const u32 nfs41_maxwrite_overhead;
290 extern const u32 nfs41_maxgetdevinfo_overhead;
291 #endif
292 
293 /* nfs4proc.c */
294 #if IS_ENABLED(CONFIG_NFS_V4)
295 extern struct rpc_procinfo nfs4_procedures[];
296 #endif
297 
298 #ifdef CONFIG_NFS_V4_SECURITY_LABEL
299 extern struct nfs4_label *nfs4_label_alloc(struct nfs_server *server, gfp_t flags);
300 static inline struct nfs4_label *
301 nfs4_label_copy(struct nfs4_label *dst, struct nfs4_label *src)
302 {
303 	if (!dst || !src)
304 		return NULL;
305 
306 	if (src->len > NFS4_MAXLABELLEN)
307 		return NULL;
308 
309 	dst->lfs = src->lfs;
310 	dst->pi = src->pi;
311 	dst->len = src->len;
312 	memcpy(dst->label, src->label, src->len);
313 
314 	return dst;
315 }
316 static inline void nfs4_label_free(struct nfs4_label *label)
317 {
318 	if (label) {
319 		kfree(label->label);
320 		kfree(label);
321 	}
322 	return;
323 }
324 
325 static inline void nfs_zap_label_cache_locked(struct nfs_inode *nfsi)
326 {
327 	if (nfs_server_capable(&nfsi->vfs_inode, NFS_CAP_SECURITY_LABEL))
328 		nfsi->cache_validity |= NFS_INO_INVALID_LABEL;
329 }
330 #else
331 static inline struct nfs4_label *nfs4_label_alloc(struct nfs_server *server, gfp_t flags) { return NULL; }
332 static inline void nfs4_label_free(void *label) {}
333 static inline void nfs_zap_label_cache_locked(struct nfs_inode *nfsi)
334 {
335 }
336 static inline struct nfs4_label *
337 nfs4_label_copy(struct nfs4_label *dst, struct nfs4_label *src)
338 {
339 	return NULL;
340 }
341 #endif /* CONFIG_NFS_V4_SECURITY_LABEL */
342 
343 /* proc.c */
344 void nfs_close_context(struct nfs_open_context *ctx, int is_sync);
345 extern struct nfs_client *nfs_init_client(struct nfs_client *clp,
346 			   const struct nfs_client_initdata *);
347 
348 /* dir.c */
349 extern void nfs_advise_use_readdirplus(struct inode *dir);
350 extern void nfs_force_use_readdirplus(struct inode *dir);
351 extern unsigned long nfs_access_cache_count(struct shrinker *shrink,
352 					    struct shrink_control *sc);
353 extern unsigned long nfs_access_cache_scan(struct shrinker *shrink,
354 					   struct shrink_control *sc);
355 struct dentry *nfs_lookup(struct inode *, struct dentry *, unsigned int);
356 int nfs_create(struct inode *, struct dentry *, umode_t, bool);
357 int nfs_mkdir(struct inode *, struct dentry *, umode_t);
358 int nfs_rmdir(struct inode *, struct dentry *);
359 int nfs_unlink(struct inode *, struct dentry *);
360 int nfs_symlink(struct inode *, struct dentry *, const char *);
361 int nfs_link(struct dentry *, struct inode *, struct dentry *);
362 int nfs_mknod(struct inode *, struct dentry *, umode_t, dev_t);
363 int nfs_rename(struct inode *, struct dentry *,
364 	       struct inode *, struct dentry *, unsigned int);
365 
366 /* file.c */
367 int nfs_file_fsync(struct file *file, loff_t start, loff_t end, int datasync);
368 loff_t nfs_file_llseek(struct file *, loff_t, int);
369 ssize_t nfs_file_read(struct kiocb *, struct iov_iter *);
370 int nfs_file_mmap(struct file *, struct vm_area_struct *);
371 ssize_t nfs_file_write(struct kiocb *, struct iov_iter *);
372 int nfs_file_release(struct inode *, struct file *);
373 int nfs_lock(struct file *, int, struct file_lock *);
374 int nfs_flock(struct file *, int, struct file_lock *);
375 int nfs_check_flags(int);
376 
377 /* inode.c */
378 extern struct workqueue_struct *nfsiod_workqueue;
379 extern struct inode *nfs_alloc_inode(struct super_block *sb);
380 extern void nfs_destroy_inode(struct inode *);
381 extern int nfs_write_inode(struct inode *, struct writeback_control *);
382 extern int nfs_drop_inode(struct inode *);
383 extern void nfs_clear_inode(struct inode *);
384 extern void nfs_evict_inode(struct inode *);
385 void nfs_zap_acl_cache(struct inode *inode);
386 extern bool nfs_check_cache_invalid(struct inode *, unsigned long);
387 extern int nfs_wait_bit_killable(struct wait_bit_key *key, int mode);
388 extern int nfs_wait_atomic_killable(atomic_t *p);
389 
390 /* super.c */
391 extern const struct super_operations nfs_sops;
392 extern struct file_system_type nfs_fs_type;
393 extern struct file_system_type nfs_xdev_fs_type;
394 #if IS_ENABLED(CONFIG_NFS_V4)
395 extern struct file_system_type nfs4_xdev_fs_type;
396 extern struct file_system_type nfs4_referral_fs_type;
397 #endif
398 bool nfs_auth_info_match(const struct nfs_auth_info *, rpc_authflavor_t);
399 struct dentry *nfs_try_mount(int, const char *, struct nfs_mount_info *,
400 			struct nfs_subversion *);
401 void nfs_initialise_sb(struct super_block *);
402 int nfs_set_sb_security(struct super_block *, struct dentry *, struct nfs_mount_info *);
403 int nfs_clone_sb_security(struct super_block *, struct dentry *, struct nfs_mount_info *);
404 struct dentry *nfs_fs_mount_common(struct nfs_server *, int, const char *,
405 				   struct nfs_mount_info *, struct nfs_subversion *);
406 struct dentry *nfs_fs_mount(struct file_system_type *, int, const char *, void *);
407 struct dentry * nfs_xdev_mount_common(struct file_system_type *, int,
408 		const char *, struct nfs_mount_info *);
409 void nfs_kill_super(struct super_block *);
410 void nfs_fill_super(struct super_block *, struct nfs_mount_info *);
411 
412 extern struct rpc_stat nfs_rpcstat;
413 
414 extern int __init register_nfs_fs(void);
415 extern void __exit unregister_nfs_fs(void);
416 extern bool nfs_sb_active(struct super_block *sb);
417 extern void nfs_sb_deactive(struct super_block *sb);
418 
419 /* io.c */
420 extern void nfs_start_io_read(struct inode *inode);
421 extern void nfs_end_io_read(struct inode *inode);
422 extern void nfs_start_io_write(struct inode *inode);
423 extern void nfs_end_io_write(struct inode *inode);
424 extern void nfs_start_io_direct(struct inode *inode);
425 extern void nfs_end_io_direct(struct inode *inode);
426 
427 static inline bool nfs_file_io_is_buffered(struct nfs_inode *nfsi)
428 {
429 	return test_bit(NFS_INO_ODIRECT, &nfsi->flags) == 0;
430 }
431 
432 /* namespace.c */
433 #define NFS_PATH_CANONICAL 1
434 extern char *nfs_path(char **p, struct dentry *dentry,
435 		      char *buffer, ssize_t buflen, unsigned flags);
436 extern struct vfsmount *nfs_d_automount(struct path *path);
437 struct vfsmount *nfs_submount(struct nfs_server *, struct dentry *,
438 			      struct nfs_fh *, struct nfs_fattr *);
439 struct vfsmount *nfs_do_submount(struct dentry *, struct nfs_fh *,
440 				 struct nfs_fattr *, rpc_authflavor_t);
441 
442 /* getroot.c */
443 extern struct dentry *nfs_get_root(struct super_block *, struct nfs_fh *,
444 				   const char *);
445 #if IS_ENABLED(CONFIG_NFS_V4)
446 extern struct dentry *nfs4_get_root(struct super_block *, struct nfs_fh *,
447 				    const char *);
448 
449 extern int nfs4_get_rootfh(struct nfs_server *server, struct nfs_fh *mntfh, bool);
450 #endif
451 
452 struct nfs_pgio_completion_ops;
453 /* read.c */
454 extern void nfs_pageio_init_read(struct nfs_pageio_descriptor *pgio,
455 			struct inode *inode, bool force_mds,
456 			const struct nfs_pgio_completion_ops *compl_ops);
457 extern void nfs_read_prepare(struct rpc_task *task, void *calldata);
458 extern void nfs_pageio_reset_read_mds(struct nfs_pageio_descriptor *pgio);
459 
460 /* super.c */
461 void nfs_clone_super(struct super_block *, struct nfs_mount_info *);
462 void nfs_umount_begin(struct super_block *);
463 int  nfs_statfs(struct dentry *, struct kstatfs *);
464 int  nfs_show_options(struct seq_file *, struct dentry *);
465 int  nfs_show_devname(struct seq_file *, struct dentry *);
466 int  nfs_show_path(struct seq_file *, struct dentry *);
467 int  nfs_show_stats(struct seq_file *, struct dentry *);
468 int nfs_remount(struct super_block *sb, int *flags, char *raw_data);
469 
470 /* write.c */
471 extern void nfs_pageio_init_write(struct nfs_pageio_descriptor *pgio,
472 			struct inode *inode, int ioflags, bool force_mds,
473 			const struct nfs_pgio_completion_ops *compl_ops);
474 extern void nfs_pageio_reset_write_mds(struct nfs_pageio_descriptor *pgio);
475 extern void nfs_commit_free(struct nfs_commit_data *p);
476 extern void nfs_write_prepare(struct rpc_task *task, void *calldata);
477 extern void nfs_commit_prepare(struct rpc_task *task, void *calldata);
478 extern int nfs_initiate_commit(struct rpc_clnt *clnt,
479 			       struct nfs_commit_data *data,
480 			       const struct nfs_rpc_ops *nfs_ops,
481 			       const struct rpc_call_ops *call_ops,
482 			       int how, int flags);
483 extern void nfs_init_commit(struct nfs_commit_data *data,
484 			    struct list_head *head,
485 			    struct pnfs_layout_segment *lseg,
486 			    struct nfs_commit_info *cinfo);
487 int nfs_scan_commit_list(struct list_head *src, struct list_head *dst,
488 			 struct nfs_commit_info *cinfo, int max);
489 unsigned long nfs_reqs_to_commit(struct nfs_commit_info *);
490 int nfs_scan_commit(struct inode *inode, struct list_head *dst,
491 		    struct nfs_commit_info *cinfo);
492 void nfs_mark_request_commit(struct nfs_page *req,
493 			     struct pnfs_layout_segment *lseg,
494 			     struct nfs_commit_info *cinfo,
495 			     u32 ds_commit_idx);
496 int nfs_write_need_commit(struct nfs_pgio_header *);
497 void nfs_writeback_update_inode(struct nfs_pgio_header *hdr);
498 int nfs_generic_commit_list(struct inode *inode, struct list_head *head,
499 			    int how, struct nfs_commit_info *cinfo);
500 void nfs_retry_commit(struct list_head *page_list,
501 		      struct pnfs_layout_segment *lseg,
502 		      struct nfs_commit_info *cinfo,
503 		      u32 ds_commit_idx);
504 void nfs_commitdata_release(struct nfs_commit_data *data);
505 void nfs_request_add_commit_list(struct nfs_page *req,
506 				 struct nfs_commit_info *cinfo);
507 void nfs_request_add_commit_list_locked(struct nfs_page *req,
508 		struct list_head *dst,
509 		struct nfs_commit_info *cinfo);
510 void nfs_request_remove_commit_list(struct nfs_page *req,
511 				    struct nfs_commit_info *cinfo);
512 void nfs_init_cinfo(struct nfs_commit_info *cinfo,
513 		    struct inode *inode,
514 		    struct nfs_direct_req *dreq);
515 int nfs_key_timeout_notify(struct file *filp, struct inode *inode);
516 bool nfs_ctx_key_to_expire(struct nfs_open_context *ctx, struct inode *inode);
517 void nfs_pageio_stop_mirroring(struct nfs_pageio_descriptor *pgio);
518 
519 int nfs_filemap_write_and_wait_range(struct address_space *mapping,
520 		loff_t lstart, loff_t lend);
521 
522 #ifdef CONFIG_NFS_V4_1
523 static inline
524 void nfs_clear_pnfs_ds_commit_verifiers(struct pnfs_ds_commit_info *cinfo)
525 {
526 	int i;
527 
528 	for (i = 0; i < cinfo->nbuckets; i++)
529 		cinfo->buckets[i].direct_verf.committed = NFS_INVALID_STABLE_HOW;
530 }
531 #else
532 static inline
533 void nfs_clear_pnfs_ds_commit_verifiers(struct pnfs_ds_commit_info *cinfo)
534 {
535 }
536 #endif
537 
538 #ifdef CONFIG_MIGRATION
539 extern int nfs_migrate_page(struct address_space *,
540 		struct page *, struct page *, enum migrate_mode);
541 #endif
542 
543 static inline int
544 nfs_write_verifier_cmp(const struct nfs_write_verifier *v1,
545 		const struct nfs_write_verifier *v2)
546 {
547 	return memcmp(v1->data, v2->data, sizeof(v1->data));
548 }
549 
550 /* unlink.c */
551 extern struct rpc_task *
552 nfs_async_rename(struct inode *old_dir, struct inode *new_dir,
553 		 struct dentry *old_dentry, struct dentry *new_dentry,
554 		 void (*complete)(struct rpc_task *, struct nfs_renamedata *));
555 extern int nfs_sillyrename(struct inode *dir, struct dentry *dentry);
556 
557 /* direct.c */
558 void nfs_init_cinfo_from_dreq(struct nfs_commit_info *cinfo,
559 			      struct nfs_direct_req *dreq);
560 extern ssize_t nfs_dreq_bytes_left(struct nfs_direct_req *dreq);
561 
562 /* nfs4proc.c */
563 extern struct nfs_client *nfs4_init_client(struct nfs_client *clp,
564 			    const struct nfs_client_initdata *);
565 extern int nfs40_walk_client_list(struct nfs_client *clp,
566 				struct nfs_client **result,
567 				struct rpc_cred *cred);
568 extern int nfs41_walk_client_list(struct nfs_client *clp,
569 				struct nfs_client **result,
570 				struct rpc_cred *cred);
571 extern int nfs4_test_session_trunk(struct rpc_clnt *,
572 				struct rpc_xprt *,
573 				void *);
574 
575 static inline struct inode *nfs_igrab_and_active(struct inode *inode)
576 {
577 	inode = igrab(inode);
578 	if (inode != NULL && !nfs_sb_active(inode->i_sb)) {
579 		iput(inode);
580 		inode = NULL;
581 	}
582 	return inode;
583 }
584 
585 static inline void nfs_iput_and_deactive(struct inode *inode)
586 {
587 	if (inode != NULL) {
588 		struct super_block *sb = inode->i_sb;
589 
590 		iput(inode);
591 		nfs_sb_deactive(sb);
592 	}
593 }
594 
595 /*
596  * Determine the device name as a string
597  */
598 static inline char *nfs_devname(struct dentry *dentry,
599 				char *buffer, ssize_t buflen)
600 {
601 	char *dummy;
602 	return nfs_path(&dummy, dentry, buffer, buflen, NFS_PATH_CANONICAL);
603 }
604 
605 /*
606  * Determine the actual block size (and log2 thereof)
607  */
608 static inline
609 unsigned long nfs_block_bits(unsigned long bsize, unsigned char *nrbitsp)
610 {
611 	/* make sure blocksize is a power of two */
612 	if ((bsize & (bsize - 1)) || nrbitsp) {
613 		unsigned char	nrbits;
614 
615 		for (nrbits = 31; nrbits && !(bsize & (1 << nrbits)); nrbits--)
616 			;
617 		bsize = 1 << nrbits;
618 		if (nrbitsp)
619 			*nrbitsp = nrbits;
620 	}
621 
622 	return bsize;
623 }
624 
625 /*
626  * Calculate the number of 512byte blocks used.
627  */
628 static inline blkcnt_t nfs_calc_block_size(u64 tsize)
629 {
630 	blkcnt_t used = (tsize + 511) >> 9;
631 	return (used > ULONG_MAX) ? ULONG_MAX : used;
632 }
633 
634 /*
635  * Compute and set NFS server blocksize
636  */
637 static inline
638 unsigned long nfs_block_size(unsigned long bsize, unsigned char *nrbitsp)
639 {
640 	if (bsize < NFS_MIN_FILE_IO_SIZE)
641 		bsize = NFS_DEF_FILE_IO_SIZE;
642 	else if (bsize >= NFS_MAX_FILE_IO_SIZE)
643 		bsize = NFS_MAX_FILE_IO_SIZE;
644 
645 	return nfs_block_bits(bsize, nrbitsp);
646 }
647 
648 /*
649  * Determine the maximum file size for a superblock
650  */
651 static inline
652 void nfs_super_set_maxbytes(struct super_block *sb, __u64 maxfilesize)
653 {
654 	sb->s_maxbytes = (loff_t)maxfilesize;
655 	if (sb->s_maxbytes > MAX_LFS_FILESIZE || sb->s_maxbytes <= 0)
656 		sb->s_maxbytes = MAX_LFS_FILESIZE;
657 }
658 
659 /*
660  * Record the page as unstable and mark its inode as dirty.
661  */
662 static inline
663 void nfs_mark_page_unstable(struct page *page, struct nfs_commit_info *cinfo)
664 {
665 	if (!cinfo->dreq) {
666 		struct inode *inode = page_file_mapping(page)->host;
667 
668 		inc_node_page_state(page, NR_UNSTABLE_NFS);
669 		inc_wb_stat(&inode_to_bdi(inode)->wb, WB_RECLAIMABLE);
670 		__mark_inode_dirty(inode, I_DIRTY_DATASYNC);
671 	}
672 }
673 
674 /*
675  * Determine the number of bytes of data the page contains
676  */
677 static inline
678 unsigned int nfs_page_length(struct page *page)
679 {
680 	loff_t i_size = i_size_read(page_file_mapping(page)->host);
681 
682 	if (i_size > 0) {
683 		pgoff_t index = page_index(page);
684 		pgoff_t end_index = (i_size - 1) >> PAGE_SHIFT;
685 		if (index < end_index)
686 			return PAGE_SIZE;
687 		if (index == end_index)
688 			return ((i_size - 1) & ~PAGE_MASK) + 1;
689 	}
690 	return 0;
691 }
692 
693 /*
694  * Convert a umode to a dirent->d_type
695  */
696 static inline
697 unsigned char nfs_umode_to_dtype(umode_t mode)
698 {
699 	return (mode >> 12) & 15;
700 }
701 
702 /*
703  * Determine the number of pages in an array of length 'len' and
704  * with a base offset of 'base'
705  */
706 static inline
707 unsigned int nfs_page_array_len(unsigned int base, size_t len)
708 {
709 	return ((unsigned long)len + (unsigned long)base +
710 		PAGE_SIZE - 1) >> PAGE_SHIFT;
711 }
712 
713 /*
714  * Convert a struct timespec into a 64-bit change attribute
715  *
716  * This does approximately the same thing as timespec_to_ns(),
717  * but for calculation efficiency, we multiply the seconds by
718  * 1024*1024*1024.
719  */
720 static inline
721 u64 nfs_timespec_to_change_attr(const struct timespec *ts)
722 {
723 	return ((u64)ts->tv_sec << 30) + ts->tv_nsec;
724 }
725 
726 #ifdef CONFIG_CRC32
727 /**
728  * nfs_fhandle_hash - calculate the crc32 hash for the filehandle
729  * @fh - pointer to filehandle
730  *
731  * returns a crc32 hash for the filehandle that is compatible with
732  * the one displayed by "wireshark".
733  */
734 static inline u32 nfs_fhandle_hash(const struct nfs_fh *fh)
735 {
736 	return ~crc32_le(0xFFFFFFFF, &fh->data[0], fh->size);
737 }
738 static inline u32 nfs_stateid_hash(const nfs4_stateid *stateid)
739 {
740 	return ~crc32_le(0xFFFFFFFF, &stateid->other[0],
741 				NFS4_STATEID_OTHER_SIZE);
742 }
743 #else
744 static inline u32 nfs_fhandle_hash(const struct nfs_fh *fh)
745 {
746 	return 0;
747 }
748 static inline u32 nfs_stateid_hash(nfs4_stateid *stateid)
749 {
750 	return 0;
751 }
752 #endif
753 
754 static inline bool nfs_error_is_fatal(int err)
755 {
756 	switch (err) {
757 	case -ERESTARTSYS:
758 	case -EACCES:
759 	case -EDQUOT:
760 	case -EFBIG:
761 	case -EIO:
762 	case -ENOSPC:
763 	case -EROFS:
764 	case -ESTALE:
765 	case -E2BIG:
766 		return true;
767 	default:
768 		return false;
769 	}
770 }
771