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