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