fs/nfs/internal.h

   1 /*
   2  * NFS internal definitions
   3  */
   4
   5 #include "nfs4_fs.h"
   6 #include <linux/mount.h>
   7 #include <linux/security.h>
   8
   9 #define NFS_MS_MASK (MS_RDONLY|MS_NOSUID|MS_NODEV|MS_NOEXEC|MS_SYNCHRONOUS)
  10
  11 struct nfs_string;
  12
  13 /* Maximum number of readahead requests
  14  * FIXME: this should really be a sysctl so that users may tune it to suit
  15  *        their needs. People that do NFS over a slow network, might for
  16  *        instance want to reduce it to something closer to 1 for improved
  17  *        interactive response.
  18  */
  19 #define NFS_MAX_READAHEAD       (RPC_DEF_SLOT_TABLE - 1)
  20
  21 /*
  22  * Determine if sessions are in use.
  23  */
  24 static inline int nfs4_has_session(const struct nfs_client *clp)
  25 {
  26 #ifdef CONFIG_NFS_V4_1
  27         if (clp->cl_session)
  28                 return 1;
  29 #endif /* CONFIG_NFS_V4_1 */
  30         return 0;
  31 }
  32
  33 struct nfs_clone_mount {
  34         const struct super_block *sb;
  35         const struct dentry *dentry;
  36         struct nfs_fh *fh;
  37         struct nfs_fattr *fattr;
  38         char *hostname;
  39         char *mnt_path;
  40         struct sockaddr *addr;
  41         size_t addrlen;
  42         rpc_authflavor_t authflavor;
  43 };
  44
  45 /*
  46  * Note: RFC 1813 doesn't limit the number of auth flavors that
  47  * a server can return, so make something up.
  48  */
  49 #define NFS_MAX_SECFLAVORS      (12)
  50
  51 /*
  52  * In-kernel mount arguments
  53  */
  54 struct nfs_parsed_mount_data {
  55         int                     flags;
  56         int                     rsize, wsize;
  57         int                     timeo, retrans;
  58         int                     acregmin, acregmax,
  59                                 acdirmin, acdirmax;
  60         int                     namlen;
  61         unsigned int            options;
  62         unsigned int            bsize;
  63         unsigned int            auth_flavor_len;
  64         rpc_authflavor_t        auth_flavors[1];
  65         char                    *client_address;
  66         unsigned int            minorversion;
  67         char                    *fscache_uniq;
  68
  69         struct {
  70                 struct sockaddr_storage address;
  71                 size_t                  addrlen;
  72                 char                    *hostname;
  73                 u32                     version;
  74                 unsigned short          port;
  75                 unsigned short          protocol;
  76         } mount_server;
  77
  78         struct {
  79                 struct sockaddr_storage address;
  80                 size_t                  addrlen;
  81                 char                    *hostname;
  82                 char                    *export_path;
  83                 unsigned short          port;
  84                 unsigned short          protocol;
  85         } nfs_server;
  86
  87         struct security_mnt_opts lsm_opts;
  88 };
  89
  90 /* mount_clnt.c */
  91 struct nfs_mount_request {
  92         struct sockaddr         *sap;
  93         size_t                  salen;
  94         char                    *hostname;
  95         char                    *dirpath;
  96         u32                     version;
  97         unsigned short          protocol;
  98         struct nfs_fh           *fh;
  99         int                     noresvport;
 100         unsigned int            *auth_flav_len;
 101         rpc_authflavor_t        *auth_flavs;
 102 };
 103
 104 extern int nfs_mount(struct nfs_mount_request *info);
 105 extern void nfs_umount(const struct nfs_mount_request *info);
 106
 107 /* client.c */
 108 extern struct rpc_program nfs_program;
 109
 110 extern void nfs_put_client(struct nfs_client *);
 111 extern struct nfs_client *nfs_find_client(const struct sockaddr *, u32);
 112 extern struct nfs_client *nfs_find_client_next(struct nfs_client *);
 113 extern struct nfs_server *nfs_create_server(
 114                                         const struct nfs_parsed_mount_data *,
 115                                         struct nfs_fh *);
 116 extern struct nfs_server *nfs4_create_server(
 117                                         const struct nfs_parsed_mount_data *,
 118                                         struct nfs_fh *);
 119 extern struct nfs_server *nfs4_create_referral_server(struct nfs_clone_mount *,
 120                                                       struct nfs_fh *);
 121 extern void nfs_free_server(struct nfs_server *server);
 122 extern struct nfs_server *nfs_clone_server(struct nfs_server *,
 123                                            struct nfs_fh *,
 124                                            struct nfs_fattr *);
 125 extern void nfs_mark_client_ready(struct nfs_client *clp, int state);
 126 extern int nfs4_check_client_ready(struct nfs_client *clp);
 127 #ifdef CONFIG_PROC_FS
 128 extern int __init nfs_fs_proc_init(void);
 129 extern void nfs_fs_proc_exit(void);
 130 #else
 131 static inline int nfs_fs_proc_init(void)
 132 {
 133         return 0;
 134 }
 135 static inline void nfs_fs_proc_exit(void)
 136 {
 137 }
 138 #endif
 139
 140 /* nfs4namespace.c */
 141 #ifdef CONFIG_NFS_V4
 142 extern struct vfsmount *nfs_do_refmount(const struct vfsmount *mnt_parent, struct dentry *dentry);
 143 #else
 144 static inline
 145 struct vfsmount *nfs_do_refmount(const struct vfsmount *mnt_parent, struct dentry *dentry)
 146 {
 147         return ERR_PTR(-ENOENT);
 148 }
 149 #endif
 150
 151 /* callback_xdr.c */
 152 extern struct svc_version nfs4_callback_version1;
 153
 154 /* pagelist.c */
 155 extern int __init nfs_init_nfspagecache(void);
 156 extern void nfs_destroy_nfspagecache(void);
 157 extern int __init nfs_init_readpagecache(void);
 158 extern void nfs_destroy_readpagecache(void);
 159 extern int __init nfs_init_writepagecache(void);
 160 extern void nfs_destroy_writepagecache(void);
 161
 162 extern int __init nfs_init_directcache(void);
 163 extern void nfs_destroy_directcache(void);
 164
 165 /* nfs2xdr.c */
 166 extern int nfs_stat_to_errno(int);
 167 extern struct rpc_procinfo nfs_procedures[];
 168 extern __be32 * nfs_decode_dirent(__be32 *, struct nfs_entry *, int);
 169
 170 /* nfs3xdr.c */
 171 extern struct rpc_procinfo nfs3_procedures[];
 172 extern __be32 *nfs3_decode_dirent(__be32 *, struct nfs_entry *, int);
 173
 174 /* nfs4proc.c */
 175 static inline void nfs4_restart_rpc(struct rpc_task *task,
 176                                     const struct nfs_client *clp)
 177 {
 178 #ifdef CONFIG_NFS_V4_1
 179         if (nfs4_has_session(clp) &&
 180             test_bit(NFS4CLNT_SESSION_SETUP, &clp->cl_state)) {
 181                 rpc_restart_call_prepare(task);
 182                 return;
 183         }
 184 #endif /* CONFIG_NFS_V4_1 */
 185         rpc_restart_call(task);
 186 }
 187
 188 /* nfs4xdr.c */
 189 #ifdef CONFIG_NFS_V4
 190 extern __be32 *nfs4_decode_dirent(__be32 *p, struct nfs_entry *entry, int plus);
 191 #endif
 192
 193 /* nfs4proc.c */
 194 #ifdef CONFIG_NFS_V4
 195 extern struct rpc_procinfo nfs4_procedures[];
 196 #endif
 197
 198 /* proc.c */
 199 void nfs_close_context(struct nfs_open_context *ctx, int is_sync);
 200
 201 /* dir.c */
 202 extern int nfs_access_cache_shrinker(int nr_to_scan, gfp_t gfp_mask);
 203
 204 /* inode.c */
 205 extern struct workqueue_struct *nfsiod_workqueue;
 206 extern struct inode *nfs_alloc_inode(struct super_block *sb);
 207 extern void nfs_destroy_inode(struct inode *);
 208 extern int nfs_write_inode(struct inode *,int);
 209 extern void nfs_clear_inode(struct inode *);
 210 #ifdef CONFIG_NFS_V4
 211 extern void nfs4_clear_inode(struct inode *);
 212 #endif
 213 void nfs_zap_acl_cache(struct inode *inode);
 214 extern int nfs_wait_bit_killable(void *word);
 215
 216 /* super.c */
 217 void nfs_parse_ip_address(char *, size_t, struct sockaddr *, size_t *);
 218 extern struct file_system_type nfs_xdev_fs_type;
 219 #ifdef CONFIG_NFS_V4
 220 extern struct file_system_type nfs4_xdev_fs_type;
 221 extern struct file_system_type nfs4_referral_fs_type;
 222 #endif
 223
 224 extern struct rpc_stat nfs_rpcstat;
 225
 226 extern int __init register_nfs_fs(void);
 227 extern void __exit unregister_nfs_fs(void);
 228 extern void nfs_sb_active(struct super_block *sb);
 229 extern void nfs_sb_deactive(struct super_block *sb);
 230
 231 /* namespace.c */
 232 extern char *nfs_path(const char *base,
 233                       const struct dentry *droot,
 234                       const struct dentry *dentry,
 235                       char *buffer, ssize_t buflen);
 236
 237 /* getroot.c */
 238 extern struct dentry *nfs_get_root(struct super_block *, struct nfs_fh *);
 239 #ifdef CONFIG_NFS_V4
 240 extern struct dentry *nfs4_get_root(struct super_block *, struct nfs_fh *);
 241
 242 extern int nfs4_path_walk(struct nfs_server *server,
 243                           struct nfs_fh *mntfh,
 244                           const char *path);
 245 #endif
 246
 247 /* read.c */
 248 extern void nfs_read_prepare(struct rpc_task *task, void *calldata);
 249
 250 /* write.c */
 251 extern void nfs_write_prepare(struct rpc_task *task, void *calldata);
 252
 253 /* nfs4proc.c */
 254 extern int _nfs4_call_sync(struct nfs_server *server,
 255                            struct rpc_message *msg,
 256                            struct nfs4_sequence_args *args,
 257                            struct nfs4_sequence_res *res,
 258                            int cache_reply);
 259 extern int _nfs4_call_sync_session(struct nfs_server *server,
 260                                    struct rpc_message *msg,
 261                                    struct nfs4_sequence_args *args,
 262                                    struct nfs4_sequence_res *res,
 263                                    int cache_reply);
 264
 265 #ifdef CONFIG_NFS_V4_1
 266 extern void nfs41_sequence_free_slot(const struct nfs_client *,
 267                                      struct nfs4_sequence_res *res);
 268 #endif /* CONFIG_NFS_V4_1 */
 269
 270 static inline void nfs4_sequence_free_slot(const struct nfs_client *clp,
 271                                            struct nfs4_sequence_res *res)
 272 {
 273 #ifdef CONFIG_NFS_V4_1
 274         if (nfs4_has_session(clp))
 275                 nfs41_sequence_free_slot(clp, res);
 276 #endif /* CONFIG_NFS_V4_1 */
 277 }
 278
 279 /*
 280  * Determine the device name as a string
 281  */
 282 static inline char *nfs_devname(const struct vfsmount *mnt_parent,
 283                                 const struct dentry *dentry,
 284                                 char *buffer, ssize_t buflen)
 285 {
 286         return nfs_path(mnt_parent->mnt_devname, mnt_parent->mnt_root,
 287                         dentry, buffer, buflen);
 288 }
 289
 290 /*
 291  * Determine the actual block size (and log2 thereof)
 292  */
 293 static inline
 294 unsigned long nfs_block_bits(unsigned long bsize, unsigned char *nrbitsp)
 295 {
 296         /* make sure blocksize is a power of two */
 297         if ((bsize & (bsize - 1)) || nrbitsp) {
 298                 unsigned char   nrbits;
 299
 300                 for (nrbits = 31; nrbits && !(bsize & (1 << nrbits)); nrbits--)
 301                         ;
 302                 bsize = 1 << nrbits;
 303                 if (nrbitsp)
 304                         *nrbitsp = nrbits;
 305         }
 306
 307         return bsize;
 308 }
 309
 310 /*
 311  * Calculate the number of 512byte blocks used.
 312  */
 313 static inline blkcnt_t nfs_calc_block_size(u64 tsize)
 314 {
 315         blkcnt_t used = (tsize + 511) >> 9;
 316         return (used > ULONG_MAX) ? ULONG_MAX : used;
 317 }
 318
 319 /*
 320  * Compute and set NFS server blocksize
 321  */
 322 static inline
 323 unsigned long nfs_block_size(unsigned long bsize, unsigned char *nrbitsp)
 324 {
 325         if (bsize < NFS_MIN_FILE_IO_SIZE)
 326                 bsize = NFS_DEF_FILE_IO_SIZE;
 327         else if (bsize >= NFS_MAX_FILE_IO_SIZE)
 328                 bsize = NFS_MAX_FILE_IO_SIZE;
 329
 330         return nfs_block_bits(bsize, nrbitsp);
 331 }
 332
 333 /*
 334  * Determine the maximum file size for a superblock
 335  */
 336 static inline
 337 void nfs_super_set_maxbytes(struct super_block *sb, __u64 maxfilesize)
 338 {
 339         sb->s_maxbytes = (loff_t)maxfilesize;
 340         if (sb->s_maxbytes > MAX_LFS_FILESIZE || sb->s_maxbytes <= 0)
 341                 sb->s_maxbytes = MAX_LFS_FILESIZE;
 342 }
 343
 344 /*
 345  * Determine the number of bytes of data the page contains
 346  */
 347 static inline
 348 unsigned int nfs_page_length(struct page *page)
 349 {
 350         loff_t i_size = i_size_read(page->mapping->host);
 351
 352         if (i_size > 0) {
 353                 pgoff_t end_index = (i_size - 1) >> PAGE_CACHE_SHIFT;
 354                 if (page->index < end_index)
 355                         return PAGE_CACHE_SIZE;
 356                 if (page->index == end_index)
 357                         return ((i_size - 1) & ~PAGE_CACHE_MASK) + 1;
 358         }
 359         return 0;
 360 }
 361
 362 /*
 363  * Determine the number of pages in an array of length 'len' and
 364  * with a base offset of 'base'
 365  */
 366 static inline
 367 unsigned int nfs_page_array_len(unsigned int base, size_t len)
 368 {
 369         return ((unsigned long)len + (unsigned long)base +
 370                 PAGE_SIZE - 1) >> PAGE_SHIFT;
 371 }
 372
 373 #define IPV6_SCOPE_DELIMITER    '%'
 374
 375 /*
 376  * Set the port number in an address.  Be agnostic about the address
 377  * family.
 378  */
 379 static inline void nfs_set_port(struct sockaddr *sap, unsigned short port)
 380 {
 381         struct sockaddr_in *ap = (struct sockaddr_in *)sap;
 382         struct sockaddr_in6 *ap6 = (struct sockaddr_in6 *)sap;
 383
 384         switch (sap->sa_family) {
 385         case AF_INET:
 386                 ap->sin_port = htons(port);
 387                 break;
 388         case AF_INET6:
 389                 ap6->sin6_port = htons(port);
 390                 break;
 391         }
 392 }