NFSv4: Fix a BAD_SEQUENCEID condition.
[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         int                     noresvport;
76 };
77
78 extern int nfs_mount(struct nfs_mount_request *info);
79
80 /* client.c */
81 extern struct rpc_program nfs_program;
82
83 extern void nfs_put_client(struct nfs_client *);
84 extern struct nfs_client *nfs_find_client(const struct sockaddr *, u32);
85 extern struct nfs_client *nfs_find_client_next(struct nfs_client *);
86 extern struct nfs_server *nfs_create_server(
87                                         const struct nfs_parsed_mount_data *,
88                                         struct nfs_fh *);
89 extern struct nfs_server *nfs4_create_server(
90                                         const struct nfs_parsed_mount_data *,
91                                         struct nfs_fh *);
92 extern struct nfs_server *nfs4_create_referral_server(struct nfs_clone_mount *,
93                                                       struct nfs_fh *);
94 extern void nfs_free_server(struct nfs_server *server);
95 extern struct nfs_server *nfs_clone_server(struct nfs_server *,
96                                            struct nfs_fh *,
97                                            struct nfs_fattr *);
98 #ifdef CONFIG_PROC_FS
99 extern int __init nfs_fs_proc_init(void);
100 extern void nfs_fs_proc_exit(void);
101 #else
102 static inline int nfs_fs_proc_init(void)
103 {
104         return 0;
105 }
106 static inline void nfs_fs_proc_exit(void)
107 {
108 }
109 #endif
110
111 /* nfs4namespace.c */
112 #ifdef CONFIG_NFS_V4
113 extern struct vfsmount *nfs_do_refmount(const struct vfsmount *mnt_parent, struct dentry *dentry);
114 #else
115 static inline
116 struct vfsmount *nfs_do_refmount(const struct vfsmount *mnt_parent, struct dentry *dentry)
117 {
118         return ERR_PTR(-ENOENT);
119 }
120 #endif
121
122 /* callback_xdr.c */
123 extern struct svc_version nfs4_callback_version1;
124
125 /* pagelist.c */
126 extern int __init nfs_init_nfspagecache(void);
127 extern void nfs_destroy_nfspagecache(void);
128 extern int __init nfs_init_readpagecache(void);
129 extern void nfs_destroy_readpagecache(void);
130 extern int __init nfs_init_writepagecache(void);
131 extern void nfs_destroy_writepagecache(void);
132
133 extern int __init nfs_init_directcache(void);
134 extern void nfs_destroy_directcache(void);
135
136 /* nfs2xdr.c */
137 extern int nfs_stat_to_errno(int);
138 extern struct rpc_procinfo nfs_procedures[];
139 extern __be32 * nfs_decode_dirent(__be32 *, struct nfs_entry *, int);
140
141 /* nfs3xdr.c */
142 extern struct rpc_procinfo nfs3_procedures[];
143 extern __be32 *nfs3_decode_dirent(__be32 *, struct nfs_entry *, int);
144
145 /* nfs4xdr.c */
146 #ifdef CONFIG_NFS_V4
147 extern __be32 *nfs4_decode_dirent(__be32 *p, struct nfs_entry *entry, int plus);
148 #endif
149
150 /* nfs4proc.c */
151 #ifdef CONFIG_NFS_V4
152 extern struct rpc_procinfo nfs4_procedures[];
153 #endif
154
155 /* dir.c */
156 extern int nfs_access_cache_shrinker(int nr_to_scan, gfp_t gfp_mask);
157
158 /* inode.c */
159 extern struct workqueue_struct *nfsiod_workqueue;
160 extern struct inode *nfs_alloc_inode(struct super_block *sb);
161 extern void nfs_destroy_inode(struct inode *);
162 extern int nfs_write_inode(struct inode *,int);
163 extern void nfs_clear_inode(struct inode *);
164 #ifdef CONFIG_NFS_V4
165 extern void nfs4_clear_inode(struct inode *);
166 #endif
167 void nfs_zap_acl_cache(struct inode *inode);
168
169 /* super.c */
170 void nfs_parse_ip_address(char *, size_t, struct sockaddr *, size_t *);
171 extern struct file_system_type nfs_xdev_fs_type;
172 #ifdef CONFIG_NFS_V4
173 extern struct file_system_type nfs4_xdev_fs_type;
174 extern struct file_system_type nfs4_referral_fs_type;
175 #endif
176
177 extern struct rpc_stat nfs_rpcstat;
178
179 extern int __init register_nfs_fs(void);
180 extern void __exit unregister_nfs_fs(void);
181 extern void nfs_sb_active(struct super_block *sb);
182 extern void nfs_sb_deactive(struct super_block *sb);
183
184 /* namespace.c */
185 extern char *nfs_path(const char *base,
186                       const struct dentry *droot,
187                       const struct dentry *dentry,
188                       char *buffer, ssize_t buflen);
189
190 /* getroot.c */
191 extern struct dentry *nfs_get_root(struct super_block *, struct nfs_fh *);
192 #ifdef CONFIG_NFS_V4
193 extern struct dentry *nfs4_get_root(struct super_block *, struct nfs_fh *);
194
195 extern int nfs4_path_walk(struct nfs_server *server,
196                           struct nfs_fh *mntfh,
197                           const char *path);
198 #endif
199
200 /*
201  * Determine the device name as a string
202  */
203 static inline char *nfs_devname(const struct vfsmount *mnt_parent,
204                                 const struct dentry *dentry,
205                                 char *buffer, ssize_t buflen)
206 {
207         return nfs_path(mnt_parent->mnt_devname, mnt_parent->mnt_root,
208                         dentry, buffer, buflen);
209 }
210
211 /*
212  * Determine the actual block size (and log2 thereof)
213  */
214 static inline
215 unsigned long nfs_block_bits(unsigned long bsize, unsigned char *nrbitsp)
216 {
217         /* make sure blocksize is a power of two */
218         if ((bsize & (bsize - 1)) || nrbitsp) {
219                 unsigned char   nrbits;
220
221                 for (nrbits = 31; nrbits && !(bsize & (1 << nrbits)); nrbits--)
222                         ;
223                 bsize = 1 << nrbits;
224                 if (nrbitsp)
225                         *nrbitsp = nrbits;
226         }
227
228         return bsize;
229 }
230
231 /*
232  * Calculate the number of 512byte blocks used.
233  */
234 static inline blkcnt_t nfs_calc_block_size(u64 tsize)
235 {
236         blkcnt_t used = (tsize + 511) >> 9;
237         return (used > ULONG_MAX) ? ULONG_MAX : used;
238 }
239
240 /*
241  * Compute and set NFS server blocksize
242  */
243 static inline
244 unsigned long nfs_block_size(unsigned long bsize, unsigned char *nrbitsp)
245 {
246         if (bsize < NFS_MIN_FILE_IO_SIZE)
247                 bsize = NFS_DEF_FILE_IO_SIZE;
248         else if (bsize >= NFS_MAX_FILE_IO_SIZE)
249                 bsize = NFS_MAX_FILE_IO_SIZE;
250
251         return nfs_block_bits(bsize, nrbitsp);
252 }
253
254 /*
255  * Determine the maximum file size for a superblock
256  */
257 static inline
258 void nfs_super_set_maxbytes(struct super_block *sb, __u64 maxfilesize)
259 {
260         sb->s_maxbytes = (loff_t)maxfilesize;
261         if (sb->s_maxbytes > MAX_LFS_FILESIZE || sb->s_maxbytes <= 0)
262                 sb->s_maxbytes = MAX_LFS_FILESIZE;
263 }
264
265 /*
266  * Determine the number of bytes of data the page contains
267  */
268 static inline
269 unsigned int nfs_page_length(struct page *page)
270 {
271         loff_t i_size = i_size_read(page->mapping->host);
272
273         if (i_size > 0) {
274                 pgoff_t end_index = (i_size - 1) >> PAGE_CACHE_SHIFT;
275                 if (page->index < end_index)
276                         return PAGE_CACHE_SIZE;
277                 if (page->index == end_index)
278                         return ((i_size - 1) & ~PAGE_CACHE_MASK) + 1;
279         }
280         return 0;
281 }
282
283 /*
284  * Determine the number of pages in an array of length 'len' and
285  * with a base offset of 'base'
286  */
287 static inline
288 unsigned int nfs_page_array_len(unsigned int base, size_t len)
289 {
290         return ((unsigned long)len + (unsigned long)base +
291                 PAGE_SIZE - 1) >> PAGE_SHIFT;
292 }
293
294 #define IPV6_SCOPE_DELIMITER    '%'
295
296 /*
297  * Set the port number in an address.  Be agnostic about the address
298  * family.
299  */
300 static inline void nfs_set_port(struct sockaddr *sap, unsigned short port)
301 {
302         struct sockaddr_in *ap = (struct sockaddr_in *)sap;
303         struct sockaddr_in6 *ap6 = (struct sockaddr_in6 *)sap;
304
305         switch (sap->sa_family) {
306         case AF_INET:
307                 ap->sin_port = htons(port);
308                 break;
309         case AF_INET6:
310                 ap6->sin6_port = htons(port);
311                 break;
312         }
313 }