xref: /openbmc/linux/fs/nfs/internal.h (revision 54ceac45)
1 /*
2  * NFS internal definitions
3  */
4 
5 #include <linux/mount.h>
6 
7 struct nfs_string;
8 struct nfs_mount_data;
9 struct nfs4_mount_data;
10 
11 /* Maximum number of readahead requests
12  * FIXME: this should really be a sysctl so that users may tune it to suit
13  *        their needs. People that do NFS over a slow network, might for
14  *        instance want to reduce it to something closer to 1 for improved
15  *        interactive response.
16  */
17 #define NFS_MAX_READAHEAD	(RPC_DEF_SLOT_TABLE - 1)
18 
19 struct nfs_clone_mount {
20 	const struct super_block *sb;
21 	const struct dentry *dentry;
22 	struct nfs_fh *fh;
23 	struct nfs_fattr *fattr;
24 	char *hostname;
25 	char *mnt_path;
26 	struct sockaddr_in *addr;
27 	rpc_authflavor_t authflavor;
28 };
29 
30 /* client.c */
31 extern struct rpc_program nfs_program;
32 
33 extern void nfs_put_client(struct nfs_client *);
34 extern struct nfs_client *nfs_find_client(const struct sockaddr_in *, int);
35 extern struct nfs_server *nfs_create_server(const struct nfs_mount_data *,
36 					    struct nfs_fh *);
37 extern struct nfs_server *nfs4_create_server(const struct nfs4_mount_data *,
38 					     const char *,
39 					     const struct sockaddr_in *,
40 					     const char *,
41 					     const char *,
42 					     rpc_authflavor_t,
43 					     struct nfs_fh *);
44 extern struct nfs_server *nfs4_create_referral_server(struct nfs_clone_mount *,
45 						      struct nfs_fh *);
46 extern void nfs_free_server(struct nfs_server *server);
47 extern struct nfs_server *nfs_clone_server(struct nfs_server *,
48 					   struct nfs_fh *,
49 					   struct nfs_fattr *);
50 
51 /* nfs4namespace.c */
52 #ifdef CONFIG_NFS_V4
53 extern struct vfsmount *nfs_do_refmount(const struct vfsmount *mnt_parent, struct dentry *dentry);
54 #else
55 static inline
56 struct vfsmount *nfs_do_refmount(const struct vfsmount *mnt_parent, struct dentry *dentry)
57 {
58 	return ERR_PTR(-ENOENT);
59 }
60 #endif
61 
62 /* callback_xdr.c */
63 extern struct svc_version nfs4_callback_version1;
64 
65 /* pagelist.c */
66 extern int __init nfs_init_nfspagecache(void);
67 extern void nfs_destroy_nfspagecache(void);
68 extern int __init nfs_init_readpagecache(void);
69 extern void nfs_destroy_readpagecache(void);
70 extern int __init nfs_init_writepagecache(void);
71 extern void nfs_destroy_writepagecache(void);
72 
73 #ifdef CONFIG_NFS_DIRECTIO
74 extern int __init nfs_init_directcache(void);
75 extern void nfs_destroy_directcache(void);
76 #else
77 #define nfs_init_directcache() (0)
78 #define nfs_destroy_directcache() do {} while(0)
79 #endif
80 
81 /* nfs2xdr.c */
82 extern int nfs_stat_to_errno(int);
83 extern struct rpc_procinfo nfs_procedures[];
84 extern u32 * nfs_decode_dirent(u32 *, struct nfs_entry *, int);
85 
86 /* nfs3xdr.c */
87 extern struct rpc_procinfo nfs3_procedures[];
88 extern u32 *nfs3_decode_dirent(u32 *, struct nfs_entry *, int);
89 
90 /* nfs4xdr.c */
91 #ifdef CONFIG_NFS_V4
92 extern u32 *nfs4_decode_dirent(u32 *p, struct nfs_entry *entry, int plus);
93 #endif
94 
95 /* nfs4proc.c */
96 #ifdef CONFIG_NFS_V4
97 extern struct rpc_procinfo nfs4_procedures[];
98 
99 extern int nfs4_proc_fs_locations(struct inode *dir, struct dentry *dentry,
100 				  struct nfs4_fs_locations *fs_locations,
101 				  struct page *page);
102 #endif
103 
104 /* dir.c */
105 extern int nfs_access_cache_shrinker(int nr_to_scan, gfp_t gfp_mask);
106 
107 /* inode.c */
108 extern struct inode *nfs_alloc_inode(struct super_block *sb);
109 extern void nfs_destroy_inode(struct inode *);
110 extern int nfs_write_inode(struct inode *,int);
111 extern void nfs_clear_inode(struct inode *);
112 #ifdef CONFIG_NFS_V4
113 extern void nfs4_clear_inode(struct inode *);
114 #endif
115 
116 /* super.c */
117 extern struct file_system_type nfs_xdev_fs_type;
118 #ifdef CONFIG_NFS_V4
119 extern struct file_system_type nfs4_xdev_fs_type;
120 extern struct file_system_type nfs4_referral_fs_type;
121 #endif
122 
123 extern struct rpc_stat nfs_rpcstat;
124 
125 extern int __init register_nfs_fs(void);
126 extern void __exit unregister_nfs_fs(void);
127 
128 /* namespace.c */
129 extern char *nfs_path(const char *base,
130 		      const struct dentry *droot,
131 		      const struct dentry *dentry,
132 		      char *buffer, ssize_t buflen);
133 
134 /* getroot.c */
135 extern struct dentry *nfs_get_root(struct super_block *, struct nfs_fh *);
136 #ifdef CONFIG_NFS_V4
137 extern struct dentry *nfs4_get_root(struct super_block *, struct nfs_fh *);
138 
139 extern int nfs4_path_walk(struct nfs_server *server,
140 			  struct nfs_fh *mntfh,
141 			  const char *path);
142 #endif
143 
144 /*
145  * Determine the device name as a string
146  */
147 static inline char *nfs_devname(const struct vfsmount *mnt_parent,
148 				const struct dentry *dentry,
149 				char *buffer, ssize_t buflen)
150 {
151 	return nfs_path(mnt_parent->mnt_devname, mnt_parent->mnt_root,
152 			dentry, buffer, buflen);
153 }
154 
155 /*
156  * Determine the actual block size (and log2 thereof)
157  */
158 static inline
159 unsigned long nfs_block_bits(unsigned long bsize, unsigned char *nrbitsp)
160 {
161 	/* make sure blocksize is a power of two */
162 	if ((bsize & (bsize - 1)) || nrbitsp) {
163 		unsigned char	nrbits;
164 
165 		for (nrbits = 31; nrbits && !(bsize & (1 << nrbits)); nrbits--)
166 			;
167 		bsize = 1 << nrbits;
168 		if (nrbitsp)
169 			*nrbitsp = nrbits;
170 	}
171 
172 	return bsize;
173 }
174 
175 /*
176  * Calculate the number of 512byte blocks used.
177  */
178 static inline unsigned long nfs_calc_block_size(u64 tsize)
179 {
180 	loff_t used = (tsize + 511) >> 9;
181 	return (used > ULONG_MAX) ? ULONG_MAX : used;
182 }
183 
184 /*
185  * Compute and set NFS server blocksize
186  */
187 static inline
188 unsigned long nfs_block_size(unsigned long bsize, unsigned char *nrbitsp)
189 {
190 	if (bsize < NFS_MIN_FILE_IO_SIZE)
191 		bsize = NFS_DEF_FILE_IO_SIZE;
192 	else if (bsize >= NFS_MAX_FILE_IO_SIZE)
193 		bsize = NFS_MAX_FILE_IO_SIZE;
194 
195 	return nfs_block_bits(bsize, nrbitsp);
196 }
197 
198 /*
199  * Determine the maximum file size for a superblock
200  */
201 static inline
202 void nfs_super_set_maxbytes(struct super_block *sb, __u64 maxfilesize)
203 {
204 	sb->s_maxbytes = (loff_t)maxfilesize;
205 	if (sb->s_maxbytes > MAX_LFS_FILESIZE || sb->s_maxbytes <= 0)
206 		sb->s_maxbytes = MAX_LFS_FILESIZE;
207 }
208