NFS: introduce nfs_mount_info struct for calling nfs_mount()
[linux-2.6] / fs / nfs / internal.h
1 /*
2  * NFS internal definitions
3  */
4
5 #include <linux/mount.h>
6 #include <linux/security.h>
7
8 struct nfs_string;
9
10 /* Maximum number of readahead requests
11  * FIXME: this should really be a sysctl so that users may tune it to suit
12  *        their needs. People that do NFS over a slow network, might for
13  *        instance want to reduce it to something closer to 1 for improved
14  *        interactive response.
15  */
16 #define NFS_MAX_READAHEAD       (RPC_DEF_SLOT_TABLE - 1)
17
18 struct nfs_clone_mount {
19         const struct super_block *sb;
20         const struct dentry *dentry;
21         struct nfs_fh *fh;
22         struct nfs_fattr *fattr;
23         char *hostname;
24         char *mnt_path;
25         struct sockaddr *addr;
26         size_t addrlen;
27         rpc_authflavor_t authflavor;
28 };
29
30 /*
31  * In-kernel mount arguments
32  */
33 struct nfs_parsed_mount_data {
34         int                     flags;
35         int                     rsize, wsize;
36         int                     timeo, retrans;
37         int                     acregmin, acregmax,
38                                 acdirmin, acdirmax;
39         int                     namlen;
40         unsigned int            bsize;
41         unsigned int            auth_flavor_len;
42         rpc_authflavor_t        auth_flavors[1];
43         char                    *client_address;
44
45         struct {
46                 struct sockaddr_storage address;
47                 size_t                  addrlen;
48                 char                    *hostname;
49                 u32                     version;
50                 unsigned short          port;
51                 unsigned short          protocol;
52         } mount_server;
53
54         struct {
55                 struct sockaddr_storage address;
56                 size_t                  addrlen;
57                 char                    *hostname;
58                 char                    *export_path;
59                 unsigned short          port;
60                 unsigned short          protocol;
61         } nfs_server;
62
63         struct security_mnt_opts lsm_opts;
64 };
65
66 /* mount_clnt.c */
67 struct nfs_mount_request {
68         struct sockaddr         *sap;
69         size_t                  salen;
70         char                    *hostname;
71         char                    *dirpath;
72         u32                     version;
73         unsigned short          protocol;
74         struct nfs_fh           *fh;
75 };
76
77 extern int nfs_mount(struct nfs_mount_request *info);
78
79 /* client.c */
80 extern struct rpc_program nfs_program;
81
82 extern void nfs_put_client(struct nfs_client *);
83 extern struct nfs_client *nfs_find_client(const struct sockaddr *, u32);
84 extern struct nfs_client *nfs_find_client_next(struct nfs_client *);
85 extern struct nfs_server *nfs_create_server(
86                                         const struct nfs_parsed_mount_data *,
87                                         struct nfs_fh *);
88 extern struct nfs_server *nfs4_create_server(
89                                         const struct nfs_parsed_mount_data *,
90                                         struct nfs_fh *);
91 extern struct nfs_server *nfs4_create_referral_server(struct nfs_clone_mount *,
92                                                       struct nfs_fh *);
93 extern void nfs_free_server(struct nfs_server *server);
94 extern struct nfs_server *nfs_clone_server(struct nfs_server *,
95                                            struct nfs_fh *,
96                                            struct nfs_fattr *);
97 #ifdef CONFIG_PROC_FS
98 extern int __init nfs_fs_proc_init(void);
99 extern void nfs_fs_proc_exit(void);
100 #else
101 static inline int nfs_fs_proc_init(void)
102 {
103         return 0;
104 }
105 static inline void nfs_fs_proc_exit(void)
106 {
107 }
108 #endif
109
110 /* nfs4namespace.c */
111 #ifdef CONFIG_NFS_V4
112 extern struct vfsmount *nfs_do_refmount(const struct vfsmount *mnt_parent, struct dentry *dentry);
113 #else
114 static inline
115 struct vfsmount *nfs_do_refmount(const struct vfsmount *mnt_parent, struct dentry *dentry)
116 {
117         return ERR_PTR(-ENOENT);
118 }
119 #endif
120
121 /* callback_xdr.c */
122 extern struct svc_version nfs4_callback_version1;
123
124 /* pagelist.c */
125 extern int __init nfs_init_nfspagecache(void);
126 extern void nfs_destroy_nfspagecache(void);
127 extern int __init nfs_init_readpagecache(void);
128 extern void nfs_destroy_readpagecache(void);
129 extern int __init nfs_init_writepagecache(void);
130 extern void nfs_destroy_writepagecache(void);
131
132 extern int __init nfs_init_directcache(void);
133 extern void nfs_destroy_directcache(void);
134
135 /* nfs2xdr.c */
136 extern int nfs_stat_to_errno(int);
137 extern struct rpc_procinfo nfs_procedures[];
138 extern __be32 * nfs_decode_dirent(__be32 *, struct nfs_entry *, int);
139
140 /* nfs3xdr.c */
141 extern struct rpc_procinfo nfs3_procedures[];
142 extern __be32 *nfs3_decode_dirent(__be32 *, struct nfs_entry *, int);
143
144 /* nfs4xdr.c */
145 #ifdef CONFIG_NFS_V4
146 extern __be32 *nfs4_decode_dirent(__be32 *p, struct nfs_entry *entry, int plus);
147 #endif
148
149 /* nfs4proc.c */
150 #ifdef CONFIG_NFS_V4
151 extern struct rpc_procinfo nfs4_procedures[];
152 #endif
153
154 /* dir.c */
155 extern int nfs_access_cache_shrinker(int nr_to_scan, gfp_t gfp_mask);
156
157 /* inode.c */
158 extern struct workqueue_struct *nfsiod_workqueue;
159 extern struct inode *nfs_alloc_inode(struct super_block *sb);
160 extern void nfs_destroy_inode(struct inode *);
161 extern int nfs_write_inode(struct inode *,int);
162 extern void nfs_clear_inode(struct inode *);
163 #ifdef CONFIG_NFS_V4
164 extern void nfs4_clear_inode(struct inode *);
165 #endif
166 void nfs_zap_acl_cache(struct inode *inode);
167
168 /* super.c */
169 void nfs_parse_ip_address(char *, size_t, struct sockaddr *, size_t *);
170 extern struct file_system_type nfs_xdev_fs_type;
171 #ifdef CONFIG_NFS_V4
172 extern struct file_system_type nfs4_xdev_fs_type;
173 extern struct file_system_type nfs4_referral_fs_type;
174 #endif
175
176 extern struct rpc_stat nfs_rpcstat;
177
178 extern int __init register_nfs_fs(void);
179 extern void __exit unregister_nfs_fs(void);
180 extern void nfs_sb_active(struct super_block *sb);
181 extern void nfs_sb_deactive(struct super_block *sb);
182
183 /* namespace.c */
184 extern char *nfs_path(const char *base,
185                       const struct dentry *droot,
186                       const struct dentry *dentry,
187                       char *buffer, ssize_t buflen);
188
189 /* getroot.c */
190 extern struct dentry *nfs_get_root(struct super_block *, struct nfs_fh *);
191 #ifdef CONFIG_NFS_V4
192 extern struct dentry *nfs4_get_root(struct super_block *, struct nfs_fh *);
193
194 extern int nfs4_path_walk(struct nfs_server *server,
195                           struct nfs_fh *mntfh,
196                           const char *path);
197 #endif
198
199 /*
200  * Determine the device name as a string
201  */
202 static inline char *nfs_devname(const struct vfsmount *mnt_parent,
203                                 const struct dentry *dentry,
204                                 char *buffer, ssize_t buflen)
205 {
206         return nfs_path(mnt_parent->mnt_devname, mnt_parent->mnt_root,
207                         dentry, buffer, buflen);
208 }
209
210 /*
211  * Determine the actual block size (and log2 thereof)
212  */
213 static inline
214 unsigned long nfs_block_bits(unsigned long bsize, unsigned char *nrbitsp)
215 {
216         /* make sure blocksize is a power of two */
217         if ((bsize & (bsize - 1)) || nrbitsp) {
218                 unsigned char   nrbits;
219
220                 for (nrbits = 31; nrbits && !(bsize & (1 << nrbits)); nrbits--)
221                         ;
222                 bsize = 1 << nrbits;
223                 if (nrbitsp)
224                         *nrbitsp = nrbits;
225         }
226
227         return bsize;
228 }
229
230 /*
231  * Calculate the number of 512byte blocks used.
232  */
233 static inline blkcnt_t nfs_calc_block_size(u64 tsize)
234 {
235         blkcnt_t used = (tsize + 511) >> 9;
236         return (used > ULONG_MAX) ? ULONG_MAX : used;
237 }
238
239 /*
240  * Compute and set NFS server blocksize
241  */
242 static inline
243 unsigned long nfs_block_size(unsigned long bsize, unsigned char *nrbitsp)
244 {
245         if (bsize < NFS_MIN_FILE_IO_SIZE)
246                 bsize = NFS_DEF_FILE_IO_SIZE;
247         else if (bsize >= NFS_MAX_FILE_IO_SIZE)
248                 bsize = NFS_MAX_FILE_IO_SIZE;
249
250         return nfs_block_bits(bsize, nrbitsp);
251 }
252
253 /*
254  * Determine the maximum file size for a superblock
255  */
256 static inline
257 void nfs_super_set_maxbytes(struct super_block *sb, __u64 maxfilesize)
258 {
259         sb->s_maxbytes = (loff_t)maxfilesize;
260         if (sb->s_maxbytes > MAX_LFS_FILESIZE || sb->s_maxbytes <= 0)
261                 sb->s_maxbytes = MAX_LFS_FILESIZE;
262 }
263
264 /*
265  * Determine the number of bytes of data the page contains
266  */
267 static inline
268 unsigned int nfs_page_length(struct page *page)
269 {
270         loff_t i_size = i_size_read(page->mapping->host);
271
272         if (i_size > 0) {
273                 pgoff_t end_index = (i_size - 1) >> PAGE_CACHE_SHIFT;
274                 if (page->index < end_index)
275                         return PAGE_CACHE_SIZE;
276                 if (page->index == end_index)
277                         return ((i_size - 1) & ~PAGE_CACHE_MASK) + 1;
278         }
279         return 0;
280 }
281
282 /*
283  * Determine the number of pages in an array of length 'len' and
284  * with a base offset of 'base'
285  */
286 static inline
287 unsigned int nfs_page_array_len(unsigned int base, size_t len)
288 {
289         return ((unsigned long)len + (unsigned long)base +
290                 PAGE_SIZE - 1) >> PAGE_SHIFT;
291 }
292
293 #define IPV6_SCOPE_DELIMITER    '%'
294
295 /*
296  * Set the port number in an address.  Be agnostic about the address
297  * family.
298  */
299 static inline void nfs_set_port(struct sockaddr *sap, unsigned short port)
300 {
301         struct sockaddr_in *ap = (struct sockaddr_in *)sap;
302         struct sockaddr_in6 *ap6 = (struct sockaddr_in6 *)sap;
303
304         switch (sap->sa_family) {
305         case AF_INET:
306                 ap->sin_port = htons(port);
307                 break;
308         case AF_INET6:
309                 ap6->sin6_port = htons(port);
310                 break;
311         }
312 }