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