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