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