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 struct dentry *nfs_lookup(struct inode *, struct dentry *, unsigned int);
 251 int nfs_create(struct inode *, struct dentry *, umode_t, bool);
 252 int nfs_mkdir(struct inode *, struct dentry *, umode_t);
 253 int nfs_rmdir(struct inode *, struct dentry *);
 254 int nfs_unlink(struct inode *, struct dentry *);
 255 int nfs_symlink(struct inode *, struct dentry *, const char *);
 256 int nfs_link(struct dentry *, struct inode *, struct dentry *);
 257 int nfs_mknod(struct inode *, struct dentry *, umode_t, dev_t);
 258 int nfs_rename(struct inode *, struct dentry *, struct inode *, struct dentry *);
 259
 260 /* file.c */
 261 int nfs_file_fsync_commit(struct file *, loff_t, loff_t, int);
 262 loff_t nfs_file_llseek(struct file *, loff_t, int);
 263 int nfs_file_flush(struct file *, fl_owner_t);
 264 ssize_t nfs_file_read(struct kiocb *, const struct iovec *, unsigned long, loff_t);
 265 ssize_t nfs_file_splice_read(struct file *, loff_t *, struct pipe_inode_info *,
 266                              size_t, unsigned int);
 267 int nfs_file_mmap(struct file *, struct vm_area_struct *);
 268 ssize_t nfs_file_write(struct kiocb *, const struct iovec *, unsigned long, loff_t);
 269 int nfs_file_release(struct inode *, struct file *);
 270 int nfs_lock(struct file *, int, struct file_lock *);
 271 int nfs_flock(struct file *, int, struct file_lock *);
 272 ssize_t nfs_file_splice_write(struct pipe_inode_info *, struct file *, loff_t *,
 273                               size_t, unsigned int);
 274 int nfs_check_flags(int);
 275 int nfs_setlease(struct file *, long, struct file_lock **);
 276
 277 /* inode.c */
 278 extern struct workqueue_struct *nfsiod_workqueue;
 279 extern struct inode *nfs_alloc_inode(struct super_block *sb);
 280 extern void nfs_destroy_inode(struct inode *);
 281 extern int nfs_write_inode(struct inode *, struct writeback_control *);
 282 extern void nfs_evict_inode(struct inode *);
 283 #ifdef CONFIG_NFS_V4
 284 extern void nfs4_evict_inode(struct inode *);
 285 #endif
 286 void nfs_zap_acl_cache(struct inode *inode);
 287 extern int nfs_wait_bit_killable(void *word);
 288
 289 /* super.c */
 290 extern struct file_system_type nfs_xdev_fs_type;
 291 #ifdef CONFIG_NFS_V4
 292 extern struct file_system_type nfs4_xdev_fs_type;
 293 extern struct file_system_type nfs4_referral_fs_type;
 294 #endif
 295
 296 extern struct rpc_stat nfs_rpcstat;
 297
 298 extern int __init register_nfs_fs(void);
 299 extern void __exit unregister_nfs_fs(void);
 300 extern void nfs_sb_active(struct super_block *sb);
 301 extern void nfs_sb_deactive(struct super_block *sb);
 302
 303 /* namespace.c */
 304 extern char *nfs_path(char **p, struct dentry *dentry,
 305                       char *buffer, ssize_t buflen);
 306 extern struct vfsmount *nfs_d_automount(struct path *path);
 307 struct vfsmount *nfs_submount(struct nfs_server *, struct dentry *,
 308                               struct nfs_fh *, struct nfs_fattr *);
 309 struct vfsmount *nfs_do_submount(struct dentry *, struct nfs_fh *,
 310                                  struct nfs_fattr *, rpc_authflavor_t);
 311
 312 /* getroot.c */
 313 extern struct dentry *nfs_get_root(struct super_block *, struct nfs_fh *,
 314                                    const char *);
 315 #ifdef CONFIG_NFS_V4
 316 extern struct dentry *nfs4_get_root(struct super_block *, struct nfs_fh *,
 317                                     const char *);
 318
 319 extern int nfs4_get_rootfh(struct nfs_server *server, struct nfs_fh *mntfh);
 320 #endif
 321
 322 struct nfs_pgio_completion_ops;
 323 /* read.c */
 324 extern struct nfs_read_header *nfs_readhdr_alloc(void);
 325 extern void nfs_readhdr_free(struct nfs_pgio_header *hdr);
 326 extern void nfs_pageio_init_read(struct nfs_pageio_descriptor *pgio,
 327                         struct inode *inode,
 328                         const struct nfs_pgio_completion_ops *compl_ops);
 329 extern int nfs_initiate_read(struct rpc_clnt *clnt,
 330                              struct nfs_read_data *data,
 331                              const struct rpc_call_ops *call_ops, int flags);
 332 extern void nfs_read_prepare(struct rpc_task *task, void *calldata);
 333 extern int nfs_generic_pagein(struct nfs_pageio_descriptor *desc,
 334                               struct nfs_pgio_header *hdr);
 335 extern void nfs_pageio_init_read(struct nfs_pageio_descriptor *pgio,
 336                         struct inode *inode,
 337                         const struct nfs_pgio_completion_ops *compl_ops);
 338 extern void nfs_pageio_reset_read_mds(struct nfs_pageio_descriptor *pgio);
 339 extern void nfs_readdata_release(struct nfs_read_data *rdata);
 340
 341 /* write.c */
 342 extern void nfs_pageio_init_write(struct nfs_pageio_descriptor *pgio,
 343                         struct inode *inode, int ioflags,
 344                         const struct nfs_pgio_completion_ops *compl_ops);
 345 extern struct nfs_write_header *nfs_writehdr_alloc(void);
 346 extern void nfs_writehdr_free(struct nfs_pgio_header *hdr);
 347 extern int nfs_generic_flush(struct nfs_pageio_descriptor *desc,
 348                              struct nfs_pgio_header *hdr);
 349 extern void nfs_pageio_init_write(struct nfs_pageio_descriptor *pgio,
 350                         struct inode *inode, int ioflags,
 351                         const struct nfs_pgio_completion_ops *compl_ops);
 352 extern void nfs_pageio_reset_write_mds(struct nfs_pageio_descriptor *pgio);
 353 extern void nfs_writedata_release(struct nfs_write_data *wdata);
 354 extern void nfs_commit_free(struct nfs_commit_data *p);
 355 extern int nfs_initiate_write(struct rpc_clnt *clnt,
 356                               struct nfs_write_data *data,
 357                               const struct rpc_call_ops *call_ops,
 358                               int how, int flags);
 359 extern void nfs_write_prepare(struct rpc_task *task, void *calldata);
 360 extern void nfs_commit_prepare(struct rpc_task *task, void *calldata);
 361 extern int nfs_initiate_commit(struct rpc_clnt *clnt,
 362                                struct nfs_commit_data *data,
 363                                const struct rpc_call_ops *call_ops,
 364                                int how, int flags);
 365 extern void nfs_init_commit(struct nfs_commit_data *data,
 366                             struct list_head *head,
 367                             struct pnfs_layout_segment *lseg,
 368                             struct nfs_commit_info *cinfo);
 369 int nfs_scan_commit_list(struct list_head *src, struct list_head *dst,
 370                          struct nfs_commit_info *cinfo, int max);
 371 int nfs_scan_commit(struct inode *inode, struct list_head *dst,
 372                     struct nfs_commit_info *cinfo);
 373 void nfs_mark_request_commit(struct nfs_page *req,
 374                              struct pnfs_layout_segment *lseg,
 375                              struct nfs_commit_info *cinfo);
 376 int nfs_generic_commit_list(struct inode *inode, struct list_head *head,
 377                             int how, struct nfs_commit_info *cinfo);
 378 void nfs_retry_commit(struct list_head *page_list,
 379                       struct pnfs_layout_segment *lseg,
 380                       struct nfs_commit_info *cinfo);
 381 void nfs_commitdata_release(struct nfs_commit_data *data);
 382 void nfs_request_add_commit_list(struct nfs_page *req, struct list_head *dst,
 383                                  struct nfs_commit_info *cinfo);
 384 void nfs_request_remove_commit_list(struct nfs_page *req,
 385                                     struct nfs_commit_info *cinfo);
 386 void nfs_init_cinfo(struct nfs_commit_info *cinfo,
 387                     struct inode *inode,
 388                     struct nfs_direct_req *dreq);
 389
 390 #ifdef CONFIG_MIGRATION
 391 extern int nfs_migrate_page(struct address_space *,
 392                 struct page *, struct page *, enum migrate_mode);
 393 #else
 394 #define nfs_migrate_page NULL
 395 #endif
 396
 397 /* direct.c */
 398 void nfs_init_cinfo_from_dreq(struct nfs_commit_info *cinfo,
 399                               struct nfs_direct_req *dreq);
 400 static inline void nfs_inode_dio_wait(struct inode *inode)
 401 {
 402         inode_dio_wait(inode);
 403 }
 404
 405 /* nfs4proc.c */
 406 extern void __nfs4_read_done_cb(struct nfs_read_data *);
 407 extern struct nfs_client *nfs4_init_client(struct nfs_client *clp,
 408                             const struct rpc_timeout *timeparms,
 409                             const char *ip_addr,
 410                             rpc_authflavor_t authflavour);
 411 extern int _nfs4_call_sync(struct rpc_clnt *clnt,
 412                            struct nfs_server *server,
 413                            struct rpc_message *msg,
 414                            struct nfs4_sequence_args *args,
 415                            struct nfs4_sequence_res *res,
 416                            int cache_reply);
 417 extern int _nfs4_call_sync_session(struct rpc_clnt *clnt,
 418                                    struct nfs_server *server,
 419                                    struct rpc_message *msg,
 420                                    struct nfs4_sequence_args *args,
 421                                    struct nfs4_sequence_res *res,
 422                                    int cache_reply);
 423
 424 /*
 425  * Determine the device name as a string
 426  */
 427 static inline char *nfs_devname(struct dentry *dentry,
 428                                 char *buffer, ssize_t buflen)
 429 {
 430         char *dummy;
 431         return nfs_path(&dummy, dentry, buffer, buflen);
 432 }
 433
 434 /*
 435  * Determine the actual block size (and log2 thereof)
 436  */
 437 static inline
 438 unsigned long nfs_block_bits(unsigned long bsize, unsigned char *nrbitsp)
 439 {
 440         /* make sure blocksize is a power of two */
 441         if ((bsize & (bsize - 1)) || nrbitsp) {
 442                 unsigned char   nrbits;
 443
 444                 for (nrbits = 31; nrbits && !(bsize & (1 << nrbits)); nrbits--)
 445                         ;
 446                 bsize = 1 << nrbits;
 447                 if (nrbitsp)
 448                         *nrbitsp = nrbits;
 449         }
 450
 451         return bsize;
 452 }
 453
 454 /*
 455  * Calculate the number of 512byte blocks used.
 456  */
 457 static inline blkcnt_t nfs_calc_block_size(u64 tsize)
 458 {
 459         blkcnt_t used = (tsize + 511) >> 9;
 460         return (used > ULONG_MAX) ? ULONG_MAX : used;
 461 }
 462
 463 /*
 464  * Compute and set NFS server blocksize
 465  */
 466 static inline
 467 unsigned long nfs_block_size(unsigned long bsize, unsigned char *nrbitsp)
 468 {
 469         if (bsize < NFS_MIN_FILE_IO_SIZE)
 470                 bsize = NFS_DEF_FILE_IO_SIZE;
 471         else if (bsize >= NFS_MAX_FILE_IO_SIZE)
 472                 bsize = NFS_MAX_FILE_IO_SIZE;
 473
 474         return nfs_block_bits(bsize, nrbitsp);
 475 }
 476
 477 /*
 478  * Determine the maximum file size for a superblock
 479  */
 480 static inline
 481 void nfs_super_set_maxbytes(struct super_block *sb, __u64 maxfilesize)
 482 {
 483         sb->s_maxbytes = (loff_t)maxfilesize;
 484         if (sb->s_maxbytes > MAX_LFS_FILESIZE || sb->s_maxbytes <= 0)
 485                 sb->s_maxbytes = MAX_LFS_FILESIZE;
 486 }
 487
 488 /*
 489  * Determine the number of bytes of data the page contains
 490  */
 491 static inline
 492 unsigned int nfs_page_length(struct page *page)
 493 {
 494         loff_t i_size = i_size_read(page->mapping->host);
 495
 496         if (i_size > 0) {
 497                 pgoff_t end_index = (i_size - 1) >> PAGE_CACHE_SHIFT;
 498                 if (page->index < end_index)
 499                         return PAGE_CACHE_SIZE;
 500                 if (page->index == end_index)
 501                         return ((i_size - 1) & ~PAGE_CACHE_MASK) + 1;
 502         }
 503         return 0;
 504 }
 505
 506 /*
 507  * Convert a umode to a dirent->d_type
 508  */
 509 static inline
 510 unsigned char nfs_umode_to_dtype(umode_t mode)
 511 {
 512         return (mode >> 12) & 15;
 513 }
 514
 515 /*
 516  * Determine the number of pages in an array of length 'len' and
 517  * with a base offset of 'base'
 518  */
 519 static inline
 520 unsigned int nfs_page_array_len(unsigned int base, size_t len)
 521 {
 522         return ((unsigned long)len + (unsigned long)base +
 523                 PAGE_SIZE - 1) >> PAGE_SHIFT;
 524 }
 525
 526 /*
 527  * Convert a struct timespec into a 64-bit change attribute
 528  *
 529  * This does approximately the same thing as timespec_to_ns(),
 530  * but for calculation efficiency, we multiply the seconds by
 531  * 1024*1024*1024.
 532  */
 533 static inline
 534 u64 nfs_timespec_to_change_attr(const struct timespec *ts)
 535 {
 536         return ((u64)ts->tv_sec << 30) + ts->tv_nsec;
 537 }