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