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