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