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 static inline void nfs_attr_check_mountpoint(struct super_block *parent, struct nfs_fattr *fattr)
  43 {
  44         if (!nfs_fsid_equal(&NFS_SB(parent)->fsid, &fattr->fsid))
  45                 fattr->valid |= NFS_ATTR_FATTR_MOUNTPOINT;
  46 }
  47
  48 static inline int nfs_attr_use_mounted_on_fileid(struct nfs_fattr *fattr)
  49 {
  50         if (((fattr->valid & NFS_ATTR_FATTR_MOUNTED_ON_FILEID) == 0) ||
  51             (((fattr->valid & NFS_ATTR_FATTR_MOUNTPOINT) == 0) &&
  52              ((fattr->valid & NFS_ATTR_FATTR_V4_REFERRAL) == 0)))
  53                 return 0;
  54
  55         fattr->fileid = fattr->mounted_on_fileid;
  56         return 1;
  57 }
  58
  59 struct nfs_clone_mount {
  60         const struct super_block *sb;
  61         const struct dentry *dentry;
  62         struct nfs_fh *fh;
  63         struct nfs_fattr *fattr;
  64         char *hostname;
  65         char *mnt_path;
  66         struct sockaddr *addr;
  67         size_t addrlen;
  68         rpc_authflavor_t authflavor;
  69 };
  70
  71 /*
  72  * Note: RFC 1813 doesn't limit the number of auth flavors that
  73  * a server can return, so make something up.
  74  */
  75 #define NFS_MAX_SECFLAVORS      (12)
  76
  77 /*
  78  * Value used if the user did not specify a port value.
  79  */
  80 #define NFS_UNSPEC_PORT         (-1)
  81
  82 /*
  83  * Maximum number of pages that readdir can use for creating
  84  * a vmapped array of pages.
  85  */
  86 #define NFS_MAX_READDIR_PAGES 8
  87
  88 /*
  89  * In-kernel mount arguments
  90  */
  91 struct nfs_parsed_mount_data {
  92         int                     flags;
  93         int                     rsize, wsize;
  94         int                     timeo, retrans;
  95         int                     acregmin, acregmax,
  96                                 acdirmin, acdirmax;
  97         int                     namlen;
  98         unsigned int            options;
  99         unsigned int            bsize;
 100         unsigned int            auth_flavor_len;
 101         rpc_authflavor_t        auth_flavors[1];
 102         char                    *client_address;
 103         unsigned int            version;
 104         unsigned int            minorversion;
 105         char                    *fscache_uniq;
 106         bool                    need_mount;
 107
 108         struct {
 109                 struct sockaddr_storage address;
 110                 size_t                  addrlen;
 111                 char                    *hostname;
 112                 u32                     version;
 113                 int                     port;
 114                 unsigned short          protocol;
 115         } mount_server;
 116
 117         struct {
 118                 struct sockaddr_storage address;
 119                 size_t                  addrlen;
 120                 char                    *hostname;
 121                 char                    *export_path;
 122                 int                     port;
 123                 unsigned short          protocol;
 124         } nfs_server;
 125
 126         struct security_mnt_opts lsm_opts;
 127         struct net              *net;
 128 };
 129
 130 /* mount_clnt.c */
 131 struct nfs_mount_request {
 132         struct sockaddr         *sap;
 133         size_t                  salen;
 134         char                    *hostname;
 135         char                    *dirpath;
 136         u32                     version;
 137         unsigned short          protocol;
 138         struct nfs_fh           *fh;
 139         int                     noresvport;
 140         unsigned int            *auth_flav_len;
 141         rpc_authflavor_t        *auth_flavs;
 142         struct net              *net;
 143 };
 144
 145 extern int nfs_mount(struct nfs_mount_request *info);
 146 extern void nfs_umount(const struct nfs_mount_request *info);
 147
 148 /* client.c */
 149 extern const struct rpc_program nfs_program;
 150 extern void nfs_clients_init(struct net *net);
 151 extern struct nfs_client *nfs_alloc_client(const struct nfs_client_initdata *);
 152
 153 extern void nfs_cleanup_cb_ident_idr(struct net *);
 154 extern void nfs_put_client(struct nfs_client *);
 155 extern void nfs_free_client(struct nfs_client *);
 156 extern struct nfs_client *nfs4_find_client_ident(struct net *, int);
 157 extern struct nfs_client *
 158 nfs4_find_client_sessionid(struct net *, const struct sockaddr *,
 159                                 struct nfs4_sessionid *);
 160 extern struct nfs_server *nfs_create_server(
 161                                         const struct nfs_parsed_mount_data *,
 162                                         struct nfs_fh *);
 163 extern struct nfs_server *nfs4_create_server(
 164                                         const struct nfs_parsed_mount_data *,
 165                                         struct nfs_fh *);
 166 extern struct nfs_server *nfs4_create_referral_server(struct nfs_clone_mount *,
 167                                                       struct nfs_fh *);
 168 extern void nfs_free_server(struct nfs_server *server);
 169 extern struct nfs_server *nfs_clone_server(struct nfs_server *,
 170                                            struct nfs_fh *,
 171                                            struct nfs_fattr *,
 172                                            rpc_authflavor_t);
 173 extern int nfs_wait_client_init_complete(const struct nfs_client *clp);
 174 extern void nfs_mark_client_ready(struct nfs_client *clp, int state);
 175 extern struct nfs_client *nfs4_set_ds_client(struct nfs_client* mds_clp,
 176                                              const struct sockaddr *ds_addr,
 177                                              int ds_addrlen, int ds_proto,
 178                                              unsigned int ds_timeo,
 179                                              unsigned int ds_retrans);
 180 #ifdef CONFIG_PROC_FS
 181 extern int __init nfs_fs_proc_init(void);
 182 extern void nfs_fs_proc_exit(void);
 183 #else
 184 static inline int nfs_fs_proc_init(void)
 185 {
 186         return 0;
 187 }
 188 static inline void nfs_fs_proc_exit(void)
 189 {
 190 }
 191 #endif
 192
 193 /* callback_xdr.c */
 194 extern struct svc_version nfs4_callback_version1;
 195 extern struct svc_version nfs4_callback_version4;
 196
 197 struct nfs_pageio_descriptor;
 198 /* pagelist.c */
 199 extern int __init nfs_init_nfspagecache(void);
 200 extern void nfs_destroy_nfspagecache(void);
 201 extern int __init nfs_init_readpagecache(void);
 202 extern void nfs_destroy_readpagecache(void);
 203 extern int __init nfs_init_writepagecache(void);
 204 extern void nfs_destroy_writepagecache(void);
 205
 206 extern int __init nfs_init_directcache(void);
 207 extern void nfs_destroy_directcache(void);
 208 extern bool nfs_pgarray_set(struct nfs_page_array *p, unsigned int pagecount);
 209 extern void nfs_pgheader_init(struct nfs_pageio_descriptor *desc,
 210                               struct nfs_pgio_header *hdr,
 211                               void (*release)(struct nfs_pgio_header *hdr));
 212 void nfs_set_pgio_error(struct nfs_pgio_header *hdr, int error, loff_t pos);
 213
 214 /* nfs2xdr.c */
 215 extern struct rpc_procinfo nfs_procedures[];
 216 extern int nfs2_decode_dirent(struct xdr_stream *,
 217                                 struct nfs_entry *, int);
 218
 219 /* nfs3xdr.c */
 220 extern struct rpc_procinfo nfs3_procedures[];
 221 extern int nfs3_decode_dirent(struct xdr_stream *,
 222                                 struct nfs_entry *, int);
 223
 224 /* nfs4xdr.c */
 225 #ifdef CONFIG_NFS_V4
 226 extern int nfs4_decode_dirent(struct xdr_stream *,
 227                                 struct nfs_entry *, int);
 228 #endif
 229 #ifdef CONFIG_NFS_V4_1
 230 extern const u32 nfs41_maxread_overhead;
 231 extern const u32 nfs41_maxwrite_overhead;
 232 #endif
 233
 234 /* nfs4proc.c */
 235 #ifdef CONFIG_NFS_V4
 236 extern struct rpc_procinfo nfs4_procedures[];
 237 #endif
 238
 239 extern int nfs4_init_ds_session(struct nfs_client *, unsigned long);
 240
 241 /* proc.c */
 242 void nfs_close_context(struct nfs_open_context *ctx, int is_sync);
 243 extern struct nfs_client *nfs_init_client(struct nfs_client *clp,
 244                            const struct rpc_timeout *timeparms,
 245                            const char *ip_addr, rpc_authflavor_t authflavour);
 246
 247 /* dir.c */
 248 extern int nfs_access_cache_shrinker(struct shrinker *shrink,
 249                                         struct shrink_control *sc);
 250
 251 /* inode.c */
 252 extern struct workqueue_struct *nfsiod_workqueue;
 253 extern struct inode *nfs_alloc_inode(struct super_block *sb);
 254 extern void nfs_destroy_inode(struct inode *);
 255 extern int nfs_write_inode(struct inode *, struct writeback_control *);
 256 extern void nfs_evict_inode(struct inode *);
 257 #ifdef CONFIG_NFS_V4
 258 extern void nfs4_evict_inode(struct inode *);
 259 #endif
 260 void nfs_zap_acl_cache(struct inode *inode);
 261 extern int nfs_wait_bit_killable(void *word);
 262
 263 /* super.c */
 264 extern struct file_system_type nfs_xdev_fs_type;
 265 #ifdef CONFIG_NFS_V4
 266 extern struct file_system_type nfs4_xdev_fs_type;
 267 extern struct file_system_type nfs4_referral_fs_type;
 268 #endif
 269
 270 extern struct rpc_stat nfs_rpcstat;
 271
 272 extern int __init register_nfs_fs(void);
 273 extern void __exit unregister_nfs_fs(void);
 274 extern void nfs_sb_active(struct super_block *sb);
 275 extern void nfs_sb_deactive(struct super_block *sb);
 276
 277 /* namespace.c */
 278 extern char *nfs_path(char **p, struct dentry *dentry,
 279                       char *buffer, ssize_t buflen);
 280 extern struct vfsmount *nfs_d_automount(struct path *path);
 281 struct vfsmount *nfs_submount(struct nfs_server *, struct dentry *,
 282                               struct nfs_fh *, struct nfs_fattr *);
 283 struct vfsmount *nfs_do_submount(struct dentry *, struct nfs_fh *,
 284                                  struct nfs_fattr *, rpc_authflavor_t);
 285
 286 /* getroot.c */
 287 extern struct dentry *nfs_get_root(struct super_block *, struct nfs_fh *,
 288                                    const char *);
 289 #ifdef CONFIG_NFS_V4
 290 extern struct dentry *nfs4_get_root(struct super_block *, struct nfs_fh *,
 291                                     const char *);
 292
 293 extern int nfs4_get_rootfh(struct nfs_server *server, struct nfs_fh *mntfh);
 294 #endif
 295
 296 struct nfs_pgio_completion_ops;
 297 /* read.c */
 298 extern struct nfs_read_header *nfs_readhdr_alloc(void);
 299 extern void nfs_readhdr_free(struct nfs_pgio_header *hdr);
 300 extern void nfs_pageio_init_read(struct nfs_pageio_descriptor *pgio,
 301                         struct inode *inode,
 302                         const struct nfs_pgio_completion_ops *compl_ops);
 303 extern int nfs_initiate_read(struct rpc_clnt *clnt,
 304                              struct nfs_read_data *data,
 305                              const struct rpc_call_ops *call_ops, int flags);
 306 extern void nfs_read_prepare(struct rpc_task *task, void *calldata);
 307 extern int nfs_generic_pagein(struct nfs_pageio_descriptor *desc,
 308                               struct nfs_pgio_header *hdr);
 309 extern void nfs_pageio_init_read_mds(struct nfs_pageio_descriptor *pgio,
 310                         struct inode *inode,
 311                         const struct nfs_pgio_completion_ops *compl_ops);
 312 extern void nfs_pageio_reset_read_mds(struct nfs_pageio_descriptor *pgio);
 313 extern void nfs_readdata_release(struct nfs_read_data *rdata);
 314
 315 /* write.c */
 316 extern void nfs_pageio_init_write(struct nfs_pageio_descriptor *pgio,
 317                         struct inode *inode, int ioflags,
 318                         const struct nfs_pgio_completion_ops *compl_ops);
 319 extern struct nfs_write_header *nfs_writehdr_alloc(void);
 320 extern void nfs_writehdr_free(struct nfs_pgio_header *hdr);
 321 extern int nfs_generic_flush(struct nfs_pageio_descriptor *desc,
 322                              struct nfs_pgio_header *hdr);
 323 extern void nfs_pageio_init_write_mds(struct nfs_pageio_descriptor *pgio,
 324                         struct inode *inode, int ioflags,
 325                         const struct nfs_pgio_completion_ops *compl_ops);
 326 extern void nfs_pageio_reset_write_mds(struct nfs_pageio_descriptor *pgio);
 327 extern void nfs_writedata_release(struct nfs_write_data *wdata);
 328 extern void nfs_commit_free(struct nfs_commit_data *p);
 329 extern int nfs_initiate_write(struct rpc_clnt *clnt,
 330                               struct nfs_write_data *data,
 331                               const struct rpc_call_ops *call_ops,
 332                               int how, int flags);
 333 extern void nfs_write_prepare(struct rpc_task *task, void *calldata);
 334 extern void nfs_commit_prepare(struct rpc_task *task, void *calldata);
 335 extern int nfs_initiate_commit(struct rpc_clnt *clnt,
 336                                struct nfs_commit_data *data,
 337                                const struct rpc_call_ops *call_ops,
 338                                int how, int flags);
 339 extern void nfs_init_commit(struct nfs_commit_data *data,
 340                             struct list_head *head,
 341                             struct pnfs_layout_segment *lseg,
 342                             struct nfs_commit_info *cinfo);
 343 int nfs_scan_commit_list(struct list_head *src, struct list_head *dst,
 344                          struct nfs_commit_info *cinfo, int max);
 345 int nfs_scan_commit(struct inode *inode, struct list_head *dst,
 346                     struct nfs_commit_info *cinfo);
 347 void nfs_mark_request_commit(struct nfs_page *req,
 348                              struct pnfs_layout_segment *lseg,
 349                              struct nfs_commit_info *cinfo);
 350 int nfs_generic_commit_list(struct inode *inode, struct list_head *head,
 351                             int how, struct nfs_commit_info *cinfo);
 352 void nfs_retry_commit(struct list_head *page_list,
 353                       struct pnfs_layout_segment *lseg,
 354                       struct nfs_commit_info *cinfo);
 355 void nfs_commitdata_release(struct nfs_commit_data *data);
 356 void nfs_request_add_commit_list(struct nfs_page *req, struct list_head *dst,
 357                                  struct nfs_commit_info *cinfo);
 358 void nfs_request_remove_commit_list(struct nfs_page *req,
 359                                     struct nfs_commit_info *cinfo);
 360 void nfs_init_cinfo(struct nfs_commit_info *cinfo,
 361                     struct inode *inode,
 362                     struct nfs_direct_req *dreq);
 363
 364 #ifdef CONFIG_MIGRATION
 365 extern int nfs_migrate_page(struct address_space *,
 366                 struct page *, struct page *, enum migrate_mode);
 367 #else
 368 #define nfs_migrate_page NULL
 369 #endif
 370
 371 /* direct.c */
 372 void nfs_init_cinfo_from_dreq(struct nfs_commit_info *cinfo,
 373                               struct nfs_direct_req *dreq);
 374 static inline void nfs_inode_dio_wait(struct inode *inode)
 375 {
 376         inode_dio_wait(inode);
 377 }
 378
 379 /* nfs4proc.c */
 380 extern void __nfs4_read_done_cb(struct nfs_read_data *);
 381 extern struct nfs_client *nfs4_init_client(struct nfs_client *clp,
 382                             const struct rpc_timeout *timeparms,
 383                             const char *ip_addr,
 384                             rpc_authflavor_t authflavour);
 385 extern int _nfs4_call_sync(struct rpc_clnt *clnt,
 386                            struct nfs_server *server,
 387                            struct rpc_message *msg,
 388                            struct nfs4_sequence_args *args,
 389                            struct nfs4_sequence_res *res,
 390                            int cache_reply);
 391 extern int _nfs4_call_sync_session(struct rpc_clnt *clnt,
 392                                    struct nfs_server *server,
 393                                    struct rpc_message *msg,
 394                                    struct nfs4_sequence_args *args,
 395                                    struct nfs4_sequence_res *res,
 396                                    int cache_reply);
 397
 398 /*
 399  * Determine the device name as a string
 400  */
 401 static inline char *nfs_devname(struct dentry *dentry,
 402                                 char *buffer, ssize_t buflen)
 403 {
 404         char *dummy;
 405         return nfs_path(&dummy, dentry, buffer, buflen);
 406 }
 407
 408 /*
 409  * Determine the actual block size (and log2 thereof)
 410  */
 411 static inline
 412 unsigned long nfs_block_bits(unsigned long bsize, unsigned char *nrbitsp)
 413 {
 414         /* make sure blocksize is a power of two */
 415         if ((bsize & (bsize - 1)) || nrbitsp) {
 416                 unsigned char   nrbits;
 417
 418                 for (nrbits = 31; nrbits && !(bsize & (1 << nrbits)); nrbits--)
 419                         ;
 420                 bsize = 1 << nrbits;
 421                 if (nrbitsp)
 422                         *nrbitsp = nrbits;
 423         }
 424
 425         return bsize;
 426 }
 427
 428 /*
 429  * Calculate the number of 512byte blocks used.
 430  */
 431 static inline blkcnt_t nfs_calc_block_size(u64 tsize)
 432 {
 433         blkcnt_t used = (tsize + 511) >> 9;
 434         return (used > ULONG_MAX) ? ULONG_MAX : used;
 435 }
 436
 437 /*
 438  * Compute and set NFS server blocksize
 439  */
 440 static inline
 441 unsigned long nfs_block_size(unsigned long bsize, unsigned char *nrbitsp)
 442 {
 443         if (bsize < NFS_MIN_FILE_IO_SIZE)
 444                 bsize = NFS_DEF_FILE_IO_SIZE;
 445         else if (bsize >= NFS_MAX_FILE_IO_SIZE)
 446                 bsize = NFS_MAX_FILE_IO_SIZE;
 447
 448         return nfs_block_bits(bsize, nrbitsp);
 449 }
 450
 451 /*
 452  * Determine the maximum file size for a superblock
 453  */
 454 static inline
 455 void nfs_super_set_maxbytes(struct super_block *sb, __u64 maxfilesize)
 456 {
 457         sb->s_maxbytes = (loff_t)maxfilesize;
 458         if (sb->s_maxbytes > MAX_LFS_FILESIZE || sb->s_maxbytes <= 0)
 459                 sb->s_maxbytes = MAX_LFS_FILESIZE;
 460 }
 461
 462 /*
 463  * Determine the number of bytes of data the page contains
 464  */
 465 static inline
 466 unsigned int nfs_page_length(struct page *page)
 467 {
 468         loff_t i_size = i_size_read(page->mapping->host);
 469
 470         if (i_size > 0) {
 471                 pgoff_t end_index = (i_size - 1) >> PAGE_CACHE_SHIFT;
 472                 if (page->index < end_index)
 473                         return PAGE_CACHE_SIZE;
 474                 if (page->index == end_index)
 475                         return ((i_size - 1) & ~PAGE_CACHE_MASK) + 1;
 476         }
 477         return 0;
 478 }
 479
 480 /*
 481  * Convert a umode to a dirent->d_type
 482  */
 483 static inline
 484 unsigned char nfs_umode_to_dtype(umode_t mode)
 485 {
 486         return (mode >> 12) & 15;
 487 }
 488
 489 /*
 490  * Determine the number of pages in an array of length 'len' and
 491  * with a base offset of 'base'
 492  */
 493 static inline
 494 unsigned int nfs_page_array_len(unsigned int base, size_t len)
 495 {
 496         return ((unsigned long)len + (unsigned long)base +
 497                 PAGE_SIZE - 1) >> PAGE_SHIFT;
 498 }
 499
 500 /*
 501  * Convert a struct timespec into a 64-bit change attribute
 502  *
 503  * This does approximately the same thing as timespec_to_ns(),
 504  * but for calculation efficiency, we multiply the seconds by
 505  * 1024*1024*1024.
 506  */
 507 static inline
 508 u64 nfs_timespec_to_change_attr(const struct timespec *ts)
 509 {
 510         return ((u64)ts->tv_sec << 30) + ts->tv_nsec;
 511 }