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
 152 extern void nfs_cleanup_cb_ident_idr(struct net *);
 153 extern void nfs_put_client(struct nfs_client *);
 154 extern void nfs_free_client(struct nfs_client *);
 155 extern struct nfs_client *nfs4_find_client_ident(struct net *, int);
 156 extern struct nfs_client *
 157 nfs4_find_client_sessionid(struct net *, const struct sockaddr *,
 158                                 struct nfs4_sessionid *);
 159 extern struct nfs_server *nfs_create_server(
 160                                         const struct nfs_parsed_mount_data *,
 161                                         struct nfs_fh *);
 162 extern struct nfs_server *nfs4_create_server(
 163                                         const struct nfs_parsed_mount_data *,
 164                                         struct nfs_fh *);
 165 extern struct nfs_server *nfs4_create_referral_server(struct nfs_clone_mount *,
 166                                                       struct nfs_fh *);
 167 extern void nfs_free_server(struct nfs_server *server);
 168 extern struct nfs_server *nfs_clone_server(struct nfs_server *,
 169                                            struct nfs_fh *,
 170                                            struct nfs_fattr *,
 171                                            rpc_authflavor_t);
 172 extern int nfs_wait_client_init_complete(const struct nfs_client *clp);
 173 extern void nfs_mark_client_ready(struct nfs_client *clp, int state);
 174 extern struct nfs_client *nfs4_set_ds_client(struct nfs_client* mds_clp,
 175                                              const struct sockaddr *ds_addr,
 176                                              int ds_addrlen, int ds_proto,
 177                                              unsigned int ds_timeo,
 178                                              unsigned int ds_retrans);
 179 #ifdef CONFIG_PROC_FS
 180 extern int __init nfs_fs_proc_init(void);
 181 extern void nfs_fs_proc_exit(void);
 182 #else
 183 static inline int nfs_fs_proc_init(void)
 184 {
 185         return 0;
 186 }
 187 static inline void nfs_fs_proc_exit(void)
 188 {
 189 }
 190 #endif
 191
 192 /* callback_xdr.c */
 193 extern struct svc_version nfs4_callback_version1;
 194 extern struct svc_version nfs4_callback_version4;
 195
 196 struct nfs_pageio_descriptor;
 197 /* pagelist.c */
 198 extern int __init nfs_init_nfspagecache(void);
 199 extern void nfs_destroy_nfspagecache(void);
 200 extern int __init nfs_init_readpagecache(void);
 201 extern void nfs_destroy_readpagecache(void);
 202 extern int __init nfs_init_writepagecache(void);
 203 extern void nfs_destroy_writepagecache(void);
 204
 205 extern int __init nfs_init_directcache(void);
 206 extern void nfs_destroy_directcache(void);
 207 extern bool nfs_pgarray_set(struct nfs_page_array *p, unsigned int pagecount);
 208 extern void nfs_pgheader_init(struct nfs_pageio_descriptor *desc,
 209                               struct nfs_pgio_header *hdr,
 210                               void (*release)(struct nfs_pgio_header *hdr));
 211 void nfs_set_pgio_error(struct nfs_pgio_header *hdr, int error, loff_t pos);
 212
 213 /* nfs2xdr.c */
 214 extern struct rpc_procinfo nfs_procedures[];
 215 extern int nfs2_decode_dirent(struct xdr_stream *,
 216                                 struct nfs_entry *, int);
 217
 218 /* nfs3xdr.c */
 219 extern struct rpc_procinfo nfs3_procedures[];
 220 extern int nfs3_decode_dirent(struct xdr_stream *,
 221                                 struct nfs_entry *, int);
 222
 223 /* nfs4xdr.c */
 224 #ifdef CONFIG_NFS_V4
 225 extern int nfs4_decode_dirent(struct xdr_stream *,
 226                                 struct nfs_entry *, int);
 227 #endif
 228 #ifdef CONFIG_NFS_V4_1
 229 extern const u32 nfs41_maxread_overhead;
 230 extern const u32 nfs41_maxwrite_overhead;
 231 #endif
 232
 233 /* nfs4proc.c */
 234 #ifdef CONFIG_NFS_V4
 235 extern struct rpc_procinfo nfs4_procedures[];
 236 #endif
 237
 238 extern int nfs4_init_ds_session(struct nfs_client *, unsigned long);
 239
 240 /* proc.c */
 241 void nfs_close_context(struct nfs_open_context *ctx, int is_sync);
 242 extern struct nfs_client *nfs_init_client(struct nfs_client *clp,
 243                            const struct rpc_timeout *timeparms,
 244                            const char *ip_addr, rpc_authflavor_t authflavour);
 245
 246 /* dir.c */
 247 extern int nfs_access_cache_shrinker(struct shrinker *shrink,
 248                                         struct shrink_control *sc);
 249
 250 /* inode.c */
 251 extern struct workqueue_struct *nfsiod_workqueue;
 252 extern struct inode *nfs_alloc_inode(struct super_block *sb);
 253 extern void nfs_destroy_inode(struct inode *);
 254 extern int nfs_write_inode(struct inode *, struct writeback_control *);
 255 extern void nfs_evict_inode(struct inode *);
 256 #ifdef CONFIG_NFS_V4
 257 extern void nfs4_evict_inode(struct inode *);
 258 #endif
 259 void nfs_zap_acl_cache(struct inode *inode);
 260 extern int nfs_wait_bit_killable(void *word);
 261
 262 /* super.c */
 263 extern struct file_system_type nfs_xdev_fs_type;
 264 #ifdef CONFIG_NFS_V4
 265 extern struct file_system_type nfs4_xdev_fs_type;
 266 extern struct file_system_type nfs4_referral_fs_type;
 267 #endif
 268
 269 extern struct rpc_stat nfs_rpcstat;
 270
 271 extern int __init register_nfs_fs(void);
 272 extern void __exit unregister_nfs_fs(void);
 273 extern void nfs_sb_active(struct super_block *sb);
 274 extern void nfs_sb_deactive(struct super_block *sb);
 275
 276 /* namespace.c */
 277 extern char *nfs_path(char **p, struct dentry *dentry,
 278                       char *buffer, ssize_t buflen);
 279 extern struct vfsmount *nfs_d_automount(struct path *path);
 280 struct vfsmount *nfs_submount(struct nfs_server *, struct dentry *,
 281                               struct nfs_fh *, struct nfs_fattr *);
 282 struct vfsmount *nfs_do_submount(struct dentry *, struct nfs_fh *,
 283                                  struct nfs_fattr *, rpc_authflavor_t);
 284
 285 /* getroot.c */
 286 extern struct dentry *nfs_get_root(struct super_block *, struct nfs_fh *,
 287                                    const char *);
 288 #ifdef CONFIG_NFS_V4
 289 extern struct dentry *nfs4_get_root(struct super_block *, struct nfs_fh *,
 290                                     const char *);
 291
 292 extern int nfs4_get_rootfh(struct nfs_server *server, struct nfs_fh *mntfh);
 293 #endif
 294
 295 struct nfs_pgio_completion_ops;
 296 /* read.c */
 297 extern struct nfs_read_header *nfs_readhdr_alloc(void);
 298 extern void nfs_readhdr_free(struct nfs_pgio_header *hdr);
 299 extern void nfs_pageio_init_read(struct nfs_pageio_descriptor *pgio,
 300                         struct inode *inode,
 301                         const struct nfs_pgio_completion_ops *compl_ops);
 302 extern int nfs_initiate_read(struct rpc_clnt *clnt,
 303                              struct nfs_read_data *data,
 304                              const struct rpc_call_ops *call_ops, int flags);
 305 extern void nfs_read_prepare(struct rpc_task *task, void *calldata);
 306 extern int nfs_generic_pagein(struct nfs_pageio_descriptor *desc,
 307                               struct nfs_pgio_header *hdr);
 308 extern void nfs_pageio_init_read_mds(struct nfs_pageio_descriptor *pgio,
 309                         struct inode *inode,
 310                         const struct nfs_pgio_completion_ops *compl_ops);
 311 extern void nfs_pageio_reset_read_mds(struct nfs_pageio_descriptor *pgio);
 312 extern void nfs_readdata_release(struct nfs_read_data *rdata);
 313
 314 /* write.c */
 315 extern void nfs_pageio_init_write(struct nfs_pageio_descriptor *pgio,
 316                         struct inode *inode, int ioflags,
 317                         const struct nfs_pgio_completion_ops *compl_ops);
 318 extern struct nfs_write_header *nfs_writehdr_alloc(void);
 319 extern void nfs_writehdr_free(struct nfs_pgio_header *hdr);
 320 extern int nfs_generic_flush(struct nfs_pageio_descriptor *desc,
 321                              struct nfs_pgio_header *hdr);
 322 extern void nfs_pageio_init_write_mds(struct nfs_pageio_descriptor *pgio,
 323                         struct inode *inode, int ioflags,
 324                         const struct nfs_pgio_completion_ops *compl_ops);
 325 extern void nfs_pageio_reset_write_mds(struct nfs_pageio_descriptor *pgio);
 326 extern void nfs_writedata_release(struct nfs_write_data *wdata);
 327 extern void nfs_commit_free(struct nfs_commit_data *p);
 328 extern int nfs_initiate_write(struct rpc_clnt *clnt,
 329                               struct nfs_write_data *data,
 330                               const struct rpc_call_ops *call_ops,
 331                               int how, int flags);
 332 extern void nfs_write_prepare(struct rpc_task *task, void *calldata);
 333 extern void nfs_commit_prepare(struct rpc_task *task, void *calldata);
 334 extern int nfs_initiate_commit(struct rpc_clnt *clnt,
 335                                struct nfs_commit_data *data,
 336                                const struct rpc_call_ops *call_ops,
 337                                int how, int flags);
 338 extern void nfs_init_commit(struct nfs_commit_data *data,
 339                             struct list_head *head,
 340                             struct pnfs_layout_segment *lseg,
 341                             struct nfs_commit_info *cinfo);
 342 int nfs_scan_commit_list(struct list_head *src, struct list_head *dst,
 343                          struct nfs_commit_info *cinfo, int max);
 344 int nfs_scan_commit(struct inode *inode, struct list_head *dst,
 345                     struct nfs_commit_info *cinfo);
 346 void nfs_mark_request_commit(struct nfs_page *req,
 347                              struct pnfs_layout_segment *lseg,
 348                              struct nfs_commit_info *cinfo);
 349 int nfs_generic_commit_list(struct inode *inode, struct list_head *head,
 350                             int how, struct nfs_commit_info *cinfo);
 351 void nfs_retry_commit(struct list_head *page_list,
 352                       struct pnfs_layout_segment *lseg,
 353                       struct nfs_commit_info *cinfo);
 354 void nfs_commitdata_release(struct nfs_commit_data *data);
 355 void nfs_request_add_commit_list(struct nfs_page *req, struct list_head *dst,
 356                                  struct nfs_commit_info *cinfo);
 357 void nfs_request_remove_commit_list(struct nfs_page *req,
 358                                     struct nfs_commit_info *cinfo);
 359 void nfs_init_cinfo(struct nfs_commit_info *cinfo,
 360                     struct inode *inode,
 361                     struct nfs_direct_req *dreq);
 362
 363 #ifdef CONFIG_MIGRATION
 364 extern int nfs_migrate_page(struct address_space *,
 365                 struct page *, struct page *, enum migrate_mode);
 366 #else
 367 #define nfs_migrate_page NULL
 368 #endif
 369
 370 /* direct.c */
 371 void nfs_init_cinfo_from_dreq(struct nfs_commit_info *cinfo,
 372                               struct nfs_direct_req *dreq);
 373 static inline void nfs_inode_dio_wait(struct inode *inode)
 374 {
 375         inode_dio_wait(inode);
 376 }
 377
 378 /* nfs4proc.c */
 379 extern void __nfs4_read_done_cb(struct nfs_read_data *);
 380 extern struct nfs_client *nfs4_init_client(struct nfs_client *clp,
 381                             const struct rpc_timeout *timeparms,
 382                             const char *ip_addr,
 383                             rpc_authflavor_t authflavour);
 384 extern int _nfs4_call_sync(struct rpc_clnt *clnt,
 385                            struct nfs_server *server,
 386                            struct rpc_message *msg,
 387                            struct nfs4_sequence_args *args,
 388                            struct nfs4_sequence_res *res,
 389                            int cache_reply);
 390 extern int _nfs4_call_sync_session(struct rpc_clnt *clnt,
 391                                    struct nfs_server *server,
 392                                    struct rpc_message *msg,
 393                                    struct nfs4_sequence_args *args,
 394                                    struct nfs4_sequence_res *res,
 395                                    int cache_reply);
 396
 397 /*
 398  * Determine the device name as a string
 399  */
 400 static inline char *nfs_devname(struct dentry *dentry,
 401                                 char *buffer, ssize_t buflen)
 402 {
 403         char *dummy;
 404         return nfs_path(&dummy, dentry, buffer, buflen);
 405 }
 406
 407 /*
 408  * Determine the actual block size (and log2 thereof)
 409  */
 410 static inline
 411 unsigned long nfs_block_bits(unsigned long bsize, unsigned char *nrbitsp)
 412 {
 413         /* make sure blocksize is a power of two */
 414         if ((bsize & (bsize - 1)) || nrbitsp) {
 415                 unsigned char   nrbits;
 416
 417                 for (nrbits = 31; nrbits && !(bsize & (1 << nrbits)); nrbits--)
 418                         ;
 419                 bsize = 1 << nrbits;
 420                 if (nrbitsp)
 421                         *nrbitsp = nrbits;
 422         }
 423
 424         return bsize;
 425 }
 426
 427 /*
 428  * Calculate the number of 512byte blocks used.
 429  */
 430 static inline blkcnt_t nfs_calc_block_size(u64 tsize)
 431 {
 432         blkcnt_t used = (tsize + 511) >> 9;
 433         return (used > ULONG_MAX) ? ULONG_MAX : used;
 434 }
 435
 436 /*
 437  * Compute and set NFS server blocksize
 438  */
 439 static inline
 440 unsigned long nfs_block_size(unsigned long bsize, unsigned char *nrbitsp)
 441 {
 442         if (bsize < NFS_MIN_FILE_IO_SIZE)
 443                 bsize = NFS_DEF_FILE_IO_SIZE;
 444         else if (bsize >= NFS_MAX_FILE_IO_SIZE)
 445                 bsize = NFS_MAX_FILE_IO_SIZE;
 446
 447         return nfs_block_bits(bsize, nrbitsp);
 448 }
 449
 450 /*
 451  * Determine the maximum file size for a superblock
 452  */
 453 static inline
 454 void nfs_super_set_maxbytes(struct super_block *sb, __u64 maxfilesize)
 455 {
 456         sb->s_maxbytes = (loff_t)maxfilesize;
 457         if (sb->s_maxbytes > MAX_LFS_FILESIZE || sb->s_maxbytes <= 0)
 458                 sb->s_maxbytes = MAX_LFS_FILESIZE;
 459 }
 460
 461 /*
 462  * Determine the number of bytes of data the page contains
 463  */
 464 static inline
 465 unsigned int nfs_page_length(struct page *page)
 466 {
 467         loff_t i_size = i_size_read(page->mapping->host);
 468
 469         if (i_size > 0) {
 470                 pgoff_t end_index = (i_size - 1) >> PAGE_CACHE_SHIFT;
 471                 if (page->index < end_index)
 472                         return PAGE_CACHE_SIZE;
 473                 if (page->index == end_index)
 474                         return ((i_size - 1) & ~PAGE_CACHE_MASK) + 1;
 475         }
 476         return 0;
 477 }
 478
 479 /*
 480  * Convert a umode to a dirent->d_type
 481  */
 482 static inline
 483 unsigned char nfs_umode_to_dtype(umode_t mode)
 484 {
 485         return (mode >> 12) & 15;
 486 }
 487
 488 /*
 489  * Determine the number of pages in an array of length 'len' and
 490  * with a base offset of 'base'
 491  */
 492 static inline
 493 unsigned int nfs_page_array_len(unsigned int base, size_t len)
 494 {
 495         return ((unsigned long)len + (unsigned long)base +
 496                 PAGE_SIZE - 1) >> PAGE_SHIFT;
 497 }
 498
 499 /*
 500  * Convert a struct timespec into a 64-bit change attribute
 501  *
 502  * This does approximately the same thing as timespec_to_ns(),
 503  * but for calculation efficiency, we multiply the seconds by
 504  * 1024*1024*1024.
 505  */
 506 static inline
 507 u64 nfs_timespec_to_change_attr(const struct timespec *ts)
 508 {
 509         return ((u64)ts->tv_sec << 30) + ts->tv_nsec;
 510 }