git.oblomov.eu Git - linux-2.6/blob - 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         unsigned int            minorversion;
  48         char                    *fscache_uniq;
  49
  50         struct {
  51                 struct sockaddr_storage address;
  52                 size_t                  addrlen;
  53                 char                    *hostname;
  54                 u32                     version;
  55                 unsigned short          port;
  56                 unsigned short          protocol;
  57         } mount_server;
  58
  59         struct {
  60                 struct sockaddr_storage address;
  61                 size_t                  addrlen;
  62                 char                    *hostname;
  63                 char                    *export_path;
  64                 unsigned short          port;
  65                 unsigned short          protocol;
  66         } nfs_server;
  67
  68         struct security_mnt_opts lsm_opts;
  69 };
  70
  71 /* mount_clnt.c */
  72 struct nfs_mount_request {
  73         struct sockaddr         *sap;
  74         size_t                  salen;
  75         char                    *hostname;
  76         char                    *dirpath;
  77         u32                     version;
  78         unsigned short          protocol;
  79         struct nfs_fh           *fh;
  80         int                     noresvport;
  81 };
  82
  83 extern int nfs_mount(struct nfs_mount_request *info);
  84
  85 /* client.c */
  86 extern struct rpc_program nfs_program;
  87
  88 extern void nfs_put_client(struct nfs_client *);
  89 extern struct nfs_client *nfs_find_client(const struct sockaddr *, u32);
  90 extern struct nfs_client *nfs_find_client_next(struct nfs_client *);
  91 extern struct nfs_server *nfs_create_server(
  92                                         const struct nfs_parsed_mount_data *,
  93                                         struct nfs_fh *);
  94 extern struct nfs_server *nfs4_create_server(
  95                                         const struct nfs_parsed_mount_data *,
  96                                         struct nfs_fh *);
  97 extern struct nfs_server *nfs4_create_referral_server(struct nfs_clone_mount *,
  98                                                       struct nfs_fh *);
  99 extern void nfs_free_server(struct nfs_server *server);
 100 extern struct nfs_server *nfs_clone_server(struct nfs_server *,
 101                                            struct nfs_fh *,
 102                                            struct nfs_fattr *);
 103 extern void nfs_mark_client_ready(struct nfs_client *clp, int state);
 104 #ifdef CONFIG_PROC_FS
 105 extern int __init nfs_fs_proc_init(void);
 106 extern void nfs_fs_proc_exit(void);
 107 #else
 108 static inline int nfs_fs_proc_init(void)
 109 {
 110         return 0;
 111 }
 112 static inline void nfs_fs_proc_exit(void)
 113 {
 114 }
 115 #endif
 116
 117 /* nfs4namespace.c */
 118 #ifdef CONFIG_NFS_V4
 119 extern struct vfsmount *nfs_do_refmount(const struct vfsmount *mnt_parent, struct dentry *dentry);
 120 #else
 121 static inline
 122 struct vfsmount *nfs_do_refmount(const struct vfsmount *mnt_parent, struct dentry *dentry)
 123 {
 124         return ERR_PTR(-ENOENT);
 125 }
 126 #endif
 127
 128 /* callback_xdr.c */
 129 extern struct svc_version nfs4_callback_version1;
 130
 131 /* pagelist.c */
 132 extern int __init nfs_init_nfspagecache(void);
 133 extern void nfs_destroy_nfspagecache(void);
 134 extern int __init nfs_init_readpagecache(void);
 135 extern void nfs_destroy_readpagecache(void);
 136 extern int __init nfs_init_writepagecache(void);
 137 extern void nfs_destroy_writepagecache(void);
 138
 139 extern int __init nfs_init_directcache(void);
 140 extern void nfs_destroy_directcache(void);
 141
 142 /* nfs2xdr.c */
 143 extern int nfs_stat_to_errno(int);
 144 extern struct rpc_procinfo nfs_procedures[];
 145 extern __be32 * nfs_decode_dirent(__be32 *, struct nfs_entry *, int);
 146
 147 /* nfs3xdr.c */
 148 extern struct rpc_procinfo nfs3_procedures[];
 149 extern __be32 *nfs3_decode_dirent(__be32 *, struct nfs_entry *, int);
 150
 151 /* nfs4xdr.c */
 152 #ifdef CONFIG_NFS_V4
 153 extern __be32 *nfs4_decode_dirent(__be32 *p, struct nfs_entry *entry, int plus);
 154 #endif
 155
 156 /* nfs4proc.c */
 157 #ifdef CONFIG_NFS_V4
 158 extern struct rpc_procinfo nfs4_procedures[];
 159 #endif
 160
 161 /* proc.c */
 162 void nfs_close_context(struct nfs_open_context *ctx, int is_sync);
 163
 164 /* dir.c */
 165 extern int nfs_access_cache_shrinker(int nr_to_scan, gfp_t gfp_mask);
 166
 167 /* inode.c */
 168 extern struct workqueue_struct *nfsiod_workqueue;
 169 extern struct inode *nfs_alloc_inode(struct super_block *sb);
 170 extern void nfs_destroy_inode(struct inode *);
 171 extern int nfs_write_inode(struct inode *,int);
 172 extern void nfs_clear_inode(struct inode *);
 173 #ifdef CONFIG_NFS_V4
 174 extern void nfs4_clear_inode(struct inode *);
 175 #endif
 176 void nfs_zap_acl_cache(struct inode *inode);
 177 extern int nfs_wait_bit_killable(void *word);
 178
 179 /* super.c */
 180 void nfs_parse_ip_address(char *, size_t, struct sockaddr *, size_t *);
 181 extern struct file_system_type nfs_xdev_fs_type;
 182 #ifdef CONFIG_NFS_V4
 183 extern struct file_system_type nfs4_xdev_fs_type;
 184 extern struct file_system_type nfs4_referral_fs_type;
 185 #endif
 186
 187 extern struct rpc_stat nfs_rpcstat;
 188
 189 extern int __init register_nfs_fs(void);
 190 extern void __exit unregister_nfs_fs(void);
 191 extern void nfs_sb_active(struct super_block *sb);
 192 extern void nfs_sb_deactive(struct super_block *sb);
 193
 194 /* namespace.c */
 195 extern char *nfs_path(const char *base,
 196                       const struct dentry *droot,
 197                       const struct dentry *dentry,
 198                       char *buffer, ssize_t buflen);
 199
 200 /* getroot.c */
 201 extern struct dentry *nfs_get_root(struct super_block *, struct nfs_fh *);
 202 #ifdef CONFIG_NFS_V4
 203 extern struct dentry *nfs4_get_root(struct super_block *, struct nfs_fh *);
 204
 205 extern int nfs4_path_walk(struct nfs_server *server,
 206                           struct nfs_fh *mntfh,
 207                           const char *path);
 208 #endif
 209
 210 /* read.c */
 211 extern void nfs_read_prepare(struct rpc_task *task, void *calldata);
 212
 213 /* write.c */
 214 extern void nfs_write_prepare(struct rpc_task *task, void *calldata);
 215
 216 /* nfs4proc.c */
 217 extern int _nfs4_call_sync(struct nfs_server *server,
 218                            struct rpc_message *msg,
 219                            struct nfs4_sequence_args *args,
 220                            struct nfs4_sequence_res *res,
 221                            int cache_reply);
 222 extern int _nfs4_call_sync_session(struct nfs_server *server,
 223                                    struct rpc_message *msg,
 224                                    struct nfs4_sequence_args *args,
 225                                    struct nfs4_sequence_res *res,
 226                                    int cache_reply);
 227
 228 /*
 229  * Determine if sessions are in use.
 230  */
 231 static inline int nfs4_has_session(const struct nfs_client *clp)
 232 {
 233 #ifdef CONFIG_NFS_V4_1
 234         if (clp->cl_session)
 235                 return 1;
 236 #endif /* CONFIG_NFS_V4_1 */
 237         return 0;
 238 }
 239
 240 #ifdef CONFIG_NFS_V4_1
 241 extern void nfs41_sequence_free_slot(const struct nfs_client *,
 242                                      struct nfs4_sequence_res *res);
 243 #endif /* CONFIG_NFS_V4_1 */
 244
 245 static inline void nfs4_sequence_free_slot(const struct nfs_client *clp,
 246                                            struct nfs4_sequence_res *res)
 247 {
 248 #ifdef CONFIG_NFS_V4_1
 249         if (nfs4_has_session(clp))
 250                 nfs41_sequence_free_slot(clp, res);
 251 #endif /* CONFIG_NFS_V4_1 */
 252 }
 253
 254 /*
 255  * Determine the device name as a string
 256  */
 257 static inline char *nfs_devname(const struct vfsmount *mnt_parent,
 258                                 const struct dentry *dentry,
 259                                 char *buffer, ssize_t buflen)
 260 {
 261         return nfs_path(mnt_parent->mnt_devname, mnt_parent->mnt_root,
 262                         dentry, buffer, buflen);
 263 }
 264
 265 /*
 266  * Determine the actual block size (and log2 thereof)
 267  */
 268 static inline
 269 unsigned long nfs_block_bits(unsigned long bsize, unsigned char *nrbitsp)
 270 {
 271         /* make sure blocksize is a power of two */
 272         if ((bsize & (bsize - 1)) || nrbitsp) {
 273                 unsigned char   nrbits;
 274
 275                 for (nrbits = 31; nrbits && !(bsize & (1 << nrbits)); nrbits--)
 276                         ;
 277                 bsize = 1 << nrbits;
 278                 if (nrbitsp)
 279                         *nrbitsp = nrbits;
 280         }
 281
 282         return bsize;
 283 }
 284
 285 /*
 286  * Calculate the number of 512byte blocks used.
 287  */
 288 static inline blkcnt_t nfs_calc_block_size(u64 tsize)
 289 {
 290         blkcnt_t used = (tsize + 511) >> 9;
 291         return (used > ULONG_MAX) ? ULONG_MAX : used;
 292 }
 293
 294 /*
 295  * Compute and set NFS server blocksize
 296  */
 297 static inline
 298 unsigned long nfs_block_size(unsigned long bsize, unsigned char *nrbitsp)
 299 {
 300         if (bsize < NFS_MIN_FILE_IO_SIZE)
 301                 bsize = NFS_DEF_FILE_IO_SIZE;
 302         else if (bsize >= NFS_MAX_FILE_IO_SIZE)
 303                 bsize = NFS_MAX_FILE_IO_SIZE;
 304
 305         return nfs_block_bits(bsize, nrbitsp);
 306 }
 307
 308 /*
 309  * Determine the maximum file size for a superblock
 310  */
 311 static inline
 312 void nfs_super_set_maxbytes(struct super_block *sb, __u64 maxfilesize)
 313 {
 314         sb->s_maxbytes = (loff_t)maxfilesize;
 315         if (sb->s_maxbytes > MAX_LFS_FILESIZE || sb->s_maxbytes <= 0)
 316                 sb->s_maxbytes = MAX_LFS_FILESIZE;
 317 }
 318
 319 /*
 320  * Determine the number of bytes of data the page contains
 321  */
 322 static inline
 323 unsigned int nfs_page_length(struct page *page)
 324 {
 325         loff_t i_size = i_size_read(page->mapping->host);
 326
 327         if (i_size > 0) {
 328                 pgoff_t end_index = (i_size - 1) >> PAGE_CACHE_SHIFT;
 329                 if (page->index < end_index)
 330                         return PAGE_CACHE_SIZE;
 331                 if (page->index == end_index)
 332                         return ((i_size - 1) & ~PAGE_CACHE_MASK) + 1;
 333         }
 334         return 0;
 335 }
 336
 337 /*
 338  * Determine the number of pages in an array of length 'len' and
 339  * with a base offset of 'base'
 340  */
 341 static inline
 342 unsigned int nfs_page_array_len(unsigned int base, size_t len)
 343 {
 344         return ((unsigned long)len + (unsigned long)base +
 345                 PAGE_SIZE - 1) >> PAGE_SHIFT;
 346 }
 347
 348 #define IPV6_SCOPE_DELIMITER    '%'
 349
 350 /*
 351  * Set the port number in an address.  Be agnostic about the address
 352  * family.
 353  */
 354 static inline void nfs_set_port(struct sockaddr *sap, unsigned short port)
 355 {
 356         struct sockaddr_in *ap = (struct sockaddr_in *)sap;
 357         struct sockaddr_in6 *ap6 = (struct sockaddr_in6 *)sap;
 358
 359         switch (sap->sa_family) {
 360         case AF_INET:
 361                 ap->sin_port = htons(port);
 362                 break;
 363         case AF_INET6:
 364                 ap6->sin6_port = htons(port);
 365                 break;
 366         }
 367 }