fs/nfs/internal.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 /*
   3  * NFS internal definitions
   4  */
   5
   6 #include "nfs4_fs.h"
   7 #include <linux/mount.h>
   8 #include <linux/security.h>
   9 #include <linux/crc32.h>
  10 #include <linux/nfs_page.h>
  11 #include <linux/wait_bit.h>
  12
  13 #define NFS_MS_MASK (SB_RDONLY|SB_NOSUID|SB_NODEV|SB_NOEXEC|SB_SYNCHRONOUS)
  14
  15 extern const struct export_operations nfs_export_ops;
  16
  17 struct nfs_string;
  18
  19 /* Maximum number of readahead requests
  20  * FIXME: this should really be a sysctl so that users may tune it to suit
  21  *        their needs. People that do NFS over a slow network, might for
  22  *        instance want to reduce it to something closer to 1 for improved
  23  *        interactive response.
  24  */
  25 #define NFS_MAX_READAHEAD       (RPC_DEF_SLOT_TABLE - 1)
  26
  27 static inline void nfs_attr_check_mountpoint(struct super_block *parent, struct nfs_fattr *fattr)
  28 {
  29         if (!nfs_fsid_equal(&NFS_SB(parent)->fsid, &fattr->fsid))
  30                 fattr->valid |= NFS_ATTR_FATTR_MOUNTPOINT;
  31 }
  32
  33 static inline int nfs_attr_use_mounted_on_fileid(struct nfs_fattr *fattr)
  34 {
  35         if (((fattr->valid & NFS_ATTR_FATTR_MOUNTED_ON_FILEID) == 0) ||
  36             (((fattr->valid & NFS_ATTR_FATTR_MOUNTPOINT) == 0) &&
  37              ((fattr->valid & NFS_ATTR_FATTR_V4_REFERRAL) == 0)))
  38                 return 0;
  39         return 1;
  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 #define NFS_UNSPEC_RETRANS      (UINT_MAX)
  66 #define NFS_UNSPEC_TIMEO        (UINT_MAX)
  67
  68 /*
  69  * Maximum number of pages that readdir can use for creating
  70  * a vmapped array of pages.
  71  */
  72 #define NFS_MAX_READDIR_PAGES 64
  73 #define NFS_MAX_READDIR_RAPAGES 8
  74
  75 struct nfs_client_initdata {
  76         unsigned long init_flags;
  77         const char *hostname;                   /* Hostname of the server */
  78         const struct sockaddr *addr;            /* Address of the server */
  79         const char *nodename;                   /* Hostname of the client */
  80         const char *ip_addr;                    /* IP address of the client */
  81         size_t addrlen;
  82         struct nfs_subversion *nfs_mod;
  83         int proto;
  84         u32 minorversion;
  85         struct net *net;
  86         const struct rpc_timeout *timeparms;
  87         const struct cred *cred;
  88 };
  89
  90 /*
  91  * In-kernel mount arguments
  92  */
  93 struct nfs_parsed_mount_data {
  94         int                     flags;
  95         unsigned int            rsize, wsize;
  96         unsigned int            timeo, retrans;
  97         unsigned int            acregmin, acregmax,
  98                                 acdirmin, acdirmax;
  99         unsigned int            namlen;
 100         unsigned int            options;
 101         unsigned int            bsize;
 102         struct nfs_auth_info    auth_info;
 103         rpc_authflavor_t        selected_flavor;
 104         char                    *client_address;
 105         unsigned int            version;
 106         unsigned int            minorversion;
 107         char                    *fscache_uniq;
 108         bool                    need_mount;
 109
 110         struct {
 111                 struct sockaddr_storage address;
 112                 size_t                  addrlen;
 113                 char                    *hostname;
 114                 u32                     version;
 115                 int                     port;
 116                 unsigned short          protocol;
 117         } mount_server;
 118
 119         struct {
 120                 struct sockaddr_storage address;
 121                 size_t                  addrlen;
 122                 char                    *hostname;
 123                 char                    *export_path;
 124                 int                     port;
 125                 unsigned short          protocol;
 126         } nfs_server;
 127
 128         void                    *lsm_opts;
 129         struct net              *net;
 130 };
 131
 132 /* mount_clnt.c */
 133 struct nfs_mount_request {
 134         struct sockaddr         *sap;
 135         size_t                  salen;
 136         char                    *hostname;
 137         char                    *dirpath;
 138         u32                     version;
 139         unsigned short          protocol;
 140         struct nfs_fh           *fh;
 141         int                     noresvport;
 142         unsigned int            *auth_flav_len;
 143         rpc_authflavor_t        *auth_flavs;
 144         struct net              *net;
 145 };
 146
 147 struct nfs_mount_info {
 148         void (*fill_super)(struct super_block *, struct nfs_mount_info *);
 149         int (*set_security)(struct super_block *, struct dentry *, struct nfs_mount_info *);
 150         struct nfs_parsed_mount_data *parsed;
 151         struct nfs_clone_mount *cloned;
 152         struct nfs_fh *mntfh;
 153 };
 154
 155 extern int nfs_mount(struct nfs_mount_request *info);
 156 extern void nfs_umount(const struct nfs_mount_request *info);
 157
 158 /* client.c */
 159 extern const struct rpc_program nfs_program;
 160 extern void nfs_clients_init(struct net *net);
 161 extern struct nfs_client *nfs_alloc_client(const struct nfs_client_initdata *);
 162 int nfs_create_rpc_client(struct nfs_client *, const struct nfs_client_initdata *, rpc_authflavor_t);
 163 struct nfs_client *nfs_get_client(const struct nfs_client_initdata *);
 164 int nfs_probe_fsinfo(struct nfs_server *server, struct nfs_fh *, struct nfs_fattr *);
 165 void nfs_server_insert_lists(struct nfs_server *);
 166 void nfs_server_remove_lists(struct nfs_server *);
 167 void nfs_init_timeout_values(struct rpc_timeout *to, int proto, int timeo, int retrans);
 168 int nfs_init_server_rpcclient(struct nfs_server *, const struct rpc_timeout *t,
 169                 rpc_authflavor_t);
 170 struct nfs_server *nfs_alloc_server(void);
 171 void nfs_server_copy_userdata(struct nfs_server *, struct nfs_server *);
 172
 173 extern void nfs_cleanup_cb_ident_idr(struct net *);
 174 extern void nfs_put_client(struct nfs_client *);
 175 extern void nfs_free_client(struct nfs_client *);
 176 extern struct nfs_client *nfs4_find_client_ident(struct net *, int);
 177 extern struct nfs_client *
 178 nfs4_find_client_sessionid(struct net *, const struct sockaddr *,
 179                                 struct nfs4_sessionid *, u32);
 180 extern struct nfs_server *nfs_create_server(struct nfs_mount_info *,
 181                                         struct nfs_subversion *);
 182 extern struct nfs_server *nfs4_create_server(
 183                                         struct nfs_mount_info *,
 184                                         struct nfs_subversion *);
 185 extern struct nfs_server *nfs4_create_referral_server(struct nfs_clone_mount *,
 186                                                       struct nfs_fh *);
 187 extern int nfs4_update_server(struct nfs_server *server, const char *hostname,
 188                                         struct sockaddr *sap, size_t salen,
 189                                         struct net *net);
 190 extern void nfs_free_server(struct nfs_server *server);
 191 extern struct nfs_server *nfs_clone_server(struct nfs_server *,
 192                                            struct nfs_fh *,
 193                                            struct nfs_fattr *,
 194                                            rpc_authflavor_t);
 195 extern bool nfs_client_init_is_complete(const struct nfs_client *clp);
 196 extern int nfs_client_init_status(const struct nfs_client *clp);
 197 extern int nfs_wait_client_init_complete(const struct nfs_client *clp);
 198 extern void nfs_mark_client_ready(struct nfs_client *clp, int state);
 199 extern struct nfs_client *nfs4_set_ds_client(struct nfs_server *mds_srv,
 200                                              const struct sockaddr *ds_addr,
 201                                              int ds_addrlen, int ds_proto,
 202                                              unsigned int ds_timeo,
 203                                              unsigned int ds_retrans,
 204                                              u32 minor_version);
 205 extern struct rpc_clnt *nfs4_find_or_create_ds_client(struct nfs_client *,
 206                                                 struct inode *);
 207 extern struct nfs_client *nfs3_set_ds_client(struct nfs_server *mds_srv,
 208                         const struct sockaddr *ds_addr, int ds_addrlen,
 209                         int ds_proto, unsigned int ds_timeo,
 210                         unsigned int ds_retrans);
 211 #ifdef CONFIG_PROC_FS
 212 extern int __init nfs_fs_proc_init(void);
 213 extern void nfs_fs_proc_exit(void);
 214 extern int nfs_fs_proc_net_init(struct net *net);
 215 extern void nfs_fs_proc_net_exit(struct net *net);
 216 #else
 217 static inline int nfs_fs_proc_net_init(struct net *net)
 218 {
 219         return 0;
 220 }
 221 static inline void nfs_fs_proc_net_exit(struct net *net)
 222 {
 223 }
 224 static inline int nfs_fs_proc_init(void)
 225 {
 226         return 0;
 227 }
 228 static inline void nfs_fs_proc_exit(void)
 229 {
 230 }
 231 #endif
 232
 233 /* callback_xdr.c */
 234 extern const struct svc_version nfs4_callback_version1;
 235 extern const struct svc_version nfs4_callback_version4;
 236
 237 struct nfs_pageio_descriptor;
 238 /* pagelist.c */
 239 extern int __init nfs_init_nfspagecache(void);
 240 extern void nfs_destroy_nfspagecache(void);
 241 extern int __init nfs_init_readpagecache(void);
 242 extern void nfs_destroy_readpagecache(void);
 243 extern int __init nfs_init_writepagecache(void);
 244 extern void nfs_destroy_writepagecache(void);
 245
 246 extern int __init nfs_init_directcache(void);
 247 extern void nfs_destroy_directcache(void);
 248 extern void nfs_pgheader_init(struct nfs_pageio_descriptor *desc,
 249                               struct nfs_pgio_header *hdr,
 250                               void (*release)(struct nfs_pgio_header *hdr));
 251 void nfs_set_pgio_error(struct nfs_pgio_header *hdr, int error, loff_t pos);
 252 int nfs_iocounter_wait(struct nfs_lock_context *l_ctx);
 253
 254 extern const struct nfs_pageio_ops nfs_pgio_rw_ops;
 255 struct nfs_pgio_header *nfs_pgio_header_alloc(const struct nfs_rw_ops *);
 256 void nfs_pgio_header_free(struct nfs_pgio_header *);
 257 int nfs_generic_pgio(struct nfs_pageio_descriptor *, struct nfs_pgio_header *);
 258 int nfs_initiate_pgio(struct rpc_clnt *clnt, struct nfs_pgio_header *hdr,
 259                       const struct cred *cred, const struct nfs_rpc_ops *rpc_ops,
 260                       const struct rpc_call_ops *call_ops, int how, int flags);
 261 void nfs_free_request(struct nfs_page *req);
 262 struct nfs_pgio_mirror *
 263 nfs_pgio_current_mirror(struct nfs_pageio_descriptor *desc);
 264
 265 static inline bool nfs_pgio_has_mirroring(struct nfs_pageio_descriptor *desc)
 266 {
 267         WARN_ON_ONCE(desc->pg_mirror_count < 1);
 268         return desc->pg_mirror_count > 1;
 269 }
 270
 271 static inline bool nfs_match_open_context(const struct nfs_open_context *ctx1,
 272                 const struct nfs_open_context *ctx2)
 273 {
 274         return cred_fscmp(ctx1->cred, ctx2->cred) == 0 && ctx1->state == ctx2->state;
 275 }
 276
 277 /* nfs2xdr.c */
 278 extern const struct rpc_procinfo nfs_procedures[];
 279 extern int nfs2_decode_dirent(struct xdr_stream *,
 280                                 struct nfs_entry *, bool);
 281
 282 /* nfs3xdr.c */
 283 extern const struct rpc_procinfo nfs3_procedures[];
 284 extern int nfs3_decode_dirent(struct xdr_stream *,
 285                                 struct nfs_entry *, bool);
 286
 287 /* nfs4xdr.c */
 288 #if IS_ENABLED(CONFIG_NFS_V4)
 289 extern int nfs4_decode_dirent(struct xdr_stream *,
 290                                 struct nfs_entry *, bool);
 291 #endif
 292 #ifdef CONFIG_NFS_V4_1
 293 extern const u32 nfs41_maxread_overhead;
 294 extern const u32 nfs41_maxwrite_overhead;
 295 extern const u32 nfs41_maxgetdevinfo_overhead;
 296 #endif
 297
 298 /* nfs4proc.c */
 299 #if IS_ENABLED(CONFIG_NFS_V4)
 300 extern const struct rpc_procinfo nfs4_procedures[];
 301 #endif
 302
 303 #ifdef CONFIG_NFS_V4_SECURITY_LABEL
 304 extern struct nfs4_label *nfs4_label_alloc(struct nfs_server *server, gfp_t flags);
 305 static inline struct nfs4_label *
 306 nfs4_label_copy(struct nfs4_label *dst, struct nfs4_label *src)
 307 {
 308         if (!dst || !src)
 309                 return NULL;
 310
 311         if (src->len > NFS4_MAXLABELLEN)
 312                 return NULL;
 313
 314         dst->lfs = src->lfs;
 315         dst->pi = src->pi;
 316         dst->len = src->len;
 317         memcpy(dst->label, src->label, src->len);
 318
 319         return dst;
 320 }
 321 static inline void nfs4_label_free(struct nfs4_label *label)
 322 {
 323         if (label) {
 324                 kfree(label->label);
 325                 kfree(label);
 326         }
 327         return;
 328 }
 329
 330 static inline void nfs_zap_label_cache_locked(struct nfs_inode *nfsi)
 331 {
 332         if (nfs_server_capable(&nfsi->vfs_inode, NFS_CAP_SECURITY_LABEL))
 333                 nfsi->cache_validity |= NFS_INO_INVALID_LABEL;
 334 }
 335 #else
 336 static inline struct nfs4_label *nfs4_label_alloc(struct nfs_server *server, gfp_t flags) { return NULL; }
 337 static inline void nfs4_label_free(void *label) {}
 338 static inline void nfs_zap_label_cache_locked(struct nfs_inode *nfsi)
 339 {
 340 }
 341 static inline struct nfs4_label *
 342 nfs4_label_copy(struct nfs4_label *dst, struct nfs4_label *src)
 343 {
 344         return NULL;
 345 }
 346 #endif /* CONFIG_NFS_V4_SECURITY_LABEL */
 347
 348 /* proc.c */
 349 void nfs_close_context(struct nfs_open_context *ctx, int is_sync);
 350 extern struct nfs_client *nfs_init_client(struct nfs_client *clp,
 351                            const struct nfs_client_initdata *);
 352
 353 /* dir.c */
 354 extern void nfs_advise_use_readdirplus(struct inode *dir);
 355 extern void nfs_force_use_readdirplus(struct inode *dir);
 356 extern unsigned long nfs_access_cache_count(struct shrinker *shrink,
 357                                             struct shrink_control *sc);
 358 extern unsigned long nfs_access_cache_scan(struct shrinker *shrink,
 359                                            struct shrink_control *sc);
 360 struct dentry *nfs_lookup(struct inode *, struct dentry *, unsigned int);
 361 int nfs_create(struct inode *, struct dentry *, umode_t, bool);
 362 int nfs_mkdir(struct inode *, struct dentry *, umode_t);
 363 int nfs_rmdir(struct inode *, struct dentry *);
 364 int nfs_unlink(struct inode *, struct dentry *);
 365 int nfs_symlink(struct inode *, struct dentry *, const char *);
 366 int nfs_link(struct dentry *, struct inode *, struct dentry *);
 367 int nfs_mknod(struct inode *, struct dentry *, umode_t, dev_t);
 368 int nfs_rename(struct inode *, struct dentry *,
 369                struct inode *, struct dentry *, unsigned int);
 370
 371 /* file.c */
 372 int nfs_file_fsync(struct file *file, loff_t start, loff_t end, int datasync);
 373 loff_t nfs_file_llseek(struct file *, loff_t, int);
 374 ssize_t nfs_file_read(struct kiocb *, struct iov_iter *);
 375 int nfs_file_mmap(struct file *, struct vm_area_struct *);
 376 ssize_t nfs_file_write(struct kiocb *, struct iov_iter *);
 377 int nfs_file_release(struct inode *, struct file *);
 378 int nfs_lock(struct file *, int, struct file_lock *);
 379 int nfs_flock(struct file *, int, struct file_lock *);
 380 int nfs_check_flags(int);
 381
 382 /* inode.c */
 383 extern struct workqueue_struct *nfsiod_workqueue;
 384 extern struct inode *nfs_alloc_inode(struct super_block *sb);
 385 extern void nfs_free_inode(struct inode *);
 386 extern int nfs_write_inode(struct inode *, struct writeback_control *);
 387 extern int nfs_drop_inode(struct inode *);
 388 extern void nfs_clear_inode(struct inode *);
 389 extern void nfs_evict_inode(struct inode *);
 390 void nfs_zap_acl_cache(struct inode *inode);
 391 extern bool nfs_check_cache_invalid(struct inode *, unsigned long);
 392 extern int nfs_wait_bit_killable(struct wait_bit_key *key, int mode);
 393 extern int nfs_wait_atomic_killable(atomic_t *p, unsigned int mode);
 394
 395 /* super.c */
 396 extern const struct super_operations nfs_sops;
 397 extern struct file_system_type nfs_fs_type;
 398 extern struct file_system_type nfs_xdev_fs_type;
 399 #if IS_ENABLED(CONFIG_NFS_V4)
 400 extern struct file_system_type nfs4_referral_fs_type;
 401 #endif
 402 bool nfs_auth_info_match(const struct nfs_auth_info *, rpc_authflavor_t);
 403 struct dentry *nfs_try_mount(int, const char *, struct nfs_mount_info *,
 404                         struct nfs_subversion *);
 405 int nfs_set_sb_security(struct super_block *, struct dentry *, struct nfs_mount_info *);
 406 int nfs_clone_sb_security(struct super_block *, struct dentry *, struct nfs_mount_info *);
 407 struct dentry *nfs_fs_mount_common(struct nfs_server *, int, const char *,
 408                                    struct nfs_mount_info *, struct nfs_subversion *);
 409 struct dentry *nfs_fs_mount(struct file_system_type *, int, const char *, void *);
 410 struct dentry * nfs_xdev_mount_common(struct file_system_type *, int,
 411                 const char *, struct nfs_mount_info *);
 412 void nfs_kill_super(struct super_block *);
 413 void nfs_fill_super(struct super_block *, struct nfs_mount_info *);
 414
 415 extern struct rpc_stat nfs_rpcstat;
 416
 417 extern int __init register_nfs_fs(void);
 418 extern void __exit unregister_nfs_fs(void);
 419 extern bool nfs_sb_active(struct super_block *sb);
 420 extern void nfs_sb_deactive(struct super_block *sb);
 421
 422 /* io.c */
 423 extern void nfs_start_io_read(struct inode *inode);
 424 extern void nfs_end_io_read(struct inode *inode);
 425 extern void nfs_start_io_write(struct inode *inode);
 426 extern void nfs_end_io_write(struct inode *inode);
 427 extern void nfs_start_io_direct(struct inode *inode);
 428 extern void nfs_end_io_direct(struct inode *inode);
 429
 430 static inline bool nfs_file_io_is_buffered(struct nfs_inode *nfsi)
 431 {
 432         return test_bit(NFS_INO_ODIRECT, &nfsi->flags) == 0;
 433 }
 434
 435 /* namespace.c */
 436 #define NFS_PATH_CANONICAL 1
 437 extern char *nfs_path(char **p, struct dentry *dentry,
 438                       char *buffer, ssize_t buflen, unsigned flags);
 439 extern struct vfsmount *nfs_d_automount(struct path *path);
 440 struct vfsmount *nfs_submount(struct nfs_server *, struct dentry *,
 441                               struct nfs_fh *, struct nfs_fattr *);
 442 struct vfsmount *nfs_do_submount(struct dentry *, struct nfs_fh *,
 443                                  struct nfs_fattr *, rpc_authflavor_t);
 444
 445 /* getroot.c */
 446 extern struct dentry *nfs_get_root(struct super_block *, struct nfs_fh *,
 447                                    const char *);
 448 #if IS_ENABLED(CONFIG_NFS_V4)
 449 extern struct dentry *nfs4_get_root(struct super_block *, struct nfs_fh *,
 450                                     const char *);
 451
 452 extern int nfs4_get_rootfh(struct nfs_server *server, struct nfs_fh *mntfh, bool);
 453 #endif
 454
 455 struct nfs_pgio_completion_ops;
 456 /* read.c */
 457 extern void nfs_pageio_init_read(struct nfs_pageio_descriptor *pgio,
 458                         struct inode *inode, bool force_mds,
 459                         const struct nfs_pgio_completion_ops *compl_ops);
 460 extern void nfs_read_prepare(struct rpc_task *task, void *calldata);
 461 extern void nfs_pageio_reset_read_mds(struct nfs_pageio_descriptor *pgio);
 462
 463 /* super.c */
 464 void nfs_umount_begin(struct super_block *);
 465 int  nfs_statfs(struct dentry *, struct kstatfs *);
 466 int  nfs_show_options(struct seq_file *, struct dentry *);
 467 int  nfs_show_devname(struct seq_file *, struct dentry *);
 468 int  nfs_show_path(struct seq_file *, struct dentry *);
 469 int  nfs_show_stats(struct seq_file *, struct dentry *);
 470 int nfs_remount(struct super_block *sb, int *flags, char *raw_data);
 471
 472 /* write.c */
 473 extern void nfs_pageio_init_write(struct nfs_pageio_descriptor *pgio,
 474                         struct inode *inode, int ioflags, bool force_mds,
 475                         const struct nfs_pgio_completion_ops *compl_ops);
 476 extern void nfs_pageio_reset_write_mds(struct nfs_pageio_descriptor *pgio);
 477 extern void nfs_commit_free(struct nfs_commit_data *p);
 478 extern void nfs_write_prepare(struct rpc_task *task, void *calldata);
 479 extern void nfs_commit_prepare(struct rpc_task *task, void *calldata);
 480 extern int nfs_initiate_commit(struct rpc_clnt *clnt,
 481                                struct nfs_commit_data *data,
 482                                const struct nfs_rpc_ops *nfs_ops,
 483                                const struct rpc_call_ops *call_ops,
 484                                int how, int flags);
 485 extern void nfs_init_commit(struct nfs_commit_data *data,
 486                             struct list_head *head,
 487                             struct pnfs_layout_segment *lseg,
 488                             struct nfs_commit_info *cinfo);
 489 int nfs_scan_commit_list(struct list_head *src, struct list_head *dst,
 490                          struct nfs_commit_info *cinfo, int max);
 491 unsigned long nfs_reqs_to_commit(struct nfs_commit_info *);
 492 int nfs_scan_commit(struct inode *inode, struct list_head *dst,
 493                     struct nfs_commit_info *cinfo);
 494 void nfs_mark_request_commit(struct nfs_page *req,
 495                              struct pnfs_layout_segment *lseg,
 496                              struct nfs_commit_info *cinfo,
 497                              u32 ds_commit_idx);
 498 int nfs_write_need_commit(struct nfs_pgio_header *);
 499 void nfs_writeback_update_inode(struct nfs_pgio_header *hdr);
 500 int nfs_generic_commit_list(struct inode *inode, struct list_head *head,
 501                             int how, struct nfs_commit_info *cinfo);
 502 void nfs_retry_commit(struct list_head *page_list,
 503                       struct pnfs_layout_segment *lseg,
 504                       struct nfs_commit_info *cinfo,
 505                       u32 ds_commit_idx);
 506 void nfs_commitdata_release(struct nfs_commit_data *data);
 507 void nfs_request_add_commit_list(struct nfs_page *req,
 508                                  struct nfs_commit_info *cinfo);
 509 void nfs_request_add_commit_list_locked(struct nfs_page *req,
 510                 struct list_head *dst,
 511                 struct nfs_commit_info *cinfo);
 512 void nfs_request_remove_commit_list(struct nfs_page *req,
 513                                     struct nfs_commit_info *cinfo);
 514 void nfs_init_cinfo(struct nfs_commit_info *cinfo,
 515                     struct inode *inode,
 516                     struct nfs_direct_req *dreq);
 517 int nfs_key_timeout_notify(struct file *filp, struct inode *inode);
 518 bool nfs_ctx_key_to_expire(struct nfs_open_context *ctx, struct inode *inode);
 519 void nfs_pageio_stop_mirroring(struct nfs_pageio_descriptor *pgio);
 520
 521 int nfs_filemap_write_and_wait_range(struct address_space *mapping,
 522                 loff_t lstart, loff_t lend);
 523
 524 #ifdef CONFIG_NFS_V4_1
 525 static inline
 526 void nfs_clear_pnfs_ds_commit_verifiers(struct pnfs_ds_commit_info *cinfo)
 527 {
 528         int i;
 529
 530         for (i = 0; i < cinfo->nbuckets; i++)
 531                 cinfo->buckets[i].direct_verf.committed = NFS_INVALID_STABLE_HOW;
 532 }
 533 #else
 534 static inline
 535 void nfs_clear_pnfs_ds_commit_verifiers(struct pnfs_ds_commit_info *cinfo)
 536 {
 537 }
 538 #endif
 539
 540 #ifdef CONFIG_MIGRATION
 541 extern int nfs_migrate_page(struct address_space *,
 542                 struct page *, struct page *, enum migrate_mode);
 543 #endif
 544
 545 static inline int
 546 nfs_write_verifier_cmp(const struct nfs_write_verifier *v1,
 547                 const struct nfs_write_verifier *v2)
 548 {
 549         return memcmp(v1->data, v2->data, sizeof(v1->data));
 550 }
 551
 552 /* unlink.c */
 553 extern struct rpc_task *
 554 nfs_async_rename(struct inode *old_dir, struct inode *new_dir,
 555                  struct dentry *old_dentry, struct dentry *new_dentry,
 556                  void (*complete)(struct rpc_task *, struct nfs_renamedata *));
 557 extern int nfs_sillyrename(struct inode *dir, struct dentry *dentry);
 558
 559 /* direct.c */
 560 void nfs_init_cinfo_from_dreq(struct nfs_commit_info *cinfo,
 561                               struct nfs_direct_req *dreq);
 562 extern ssize_t nfs_dreq_bytes_left(struct nfs_direct_req *dreq);
 563
 564 /* nfs4proc.c */
 565 extern struct nfs_client *nfs4_init_client(struct nfs_client *clp,
 566                             const struct nfs_client_initdata *);
 567 extern int nfs40_walk_client_list(struct nfs_client *clp,
 568                                 struct nfs_client **result,
 569                                 const struct cred *cred);
 570 extern int nfs41_walk_client_list(struct nfs_client *clp,
 571                                 struct nfs_client **result,
 572                                 const struct cred *cred);
 573 extern void nfs4_test_session_trunk(struct rpc_clnt *clnt,
 574                                 struct rpc_xprt *xprt,
 575                                 void *data);
 576
 577 static inline struct inode *nfs_igrab_and_active(struct inode *inode)
 578 {
 579         inode = igrab(inode);
 580         if (inode != NULL && !nfs_sb_active(inode->i_sb)) {
 581                 iput(inode);
 582                 inode = NULL;
 583         }
 584         return inode;
 585 }
 586
 587 static inline void nfs_iput_and_deactive(struct inode *inode)
 588 {
 589         if (inode != NULL) {
 590                 struct super_block *sb = inode->i_sb;
 591
 592                 iput(inode);
 593                 nfs_sb_deactive(sb);
 594         }
 595 }
 596
 597 /*
 598  * Determine the device name as a string
 599  */
 600 static inline char *nfs_devname(struct dentry *dentry,
 601                                 char *buffer, ssize_t buflen)
 602 {
 603         char *dummy;
 604         return nfs_path(&dummy, dentry, buffer, buflen, NFS_PATH_CANONICAL);
 605 }
 606
 607 /*
 608  * Determine the actual block size (and log2 thereof)
 609  */
 610 static inline
 611 unsigned long nfs_block_bits(unsigned long bsize, unsigned char *nrbitsp)
 612 {
 613         /* make sure blocksize is a power of two */
 614         if ((bsize & (bsize - 1)) || nrbitsp) {
 615                 unsigned char   nrbits;
 616
 617                 for (nrbits = 31; nrbits && !(bsize & (1 << nrbits)); nrbits--)
 618                         ;
 619                 bsize = 1 << nrbits;
 620                 if (nrbitsp)
 621                         *nrbitsp = nrbits;
 622         }
 623
 624         return bsize;
 625 }
 626
 627 /*
 628  * Calculate the number of 512byte blocks used.
 629  */
 630 static inline blkcnt_t nfs_calc_block_size(u64 tsize)
 631 {
 632         blkcnt_t used = (tsize + 511) >> 9;
 633         return (used > ULONG_MAX) ? ULONG_MAX : used;
 634 }
 635
 636 /*
 637  * Compute and set NFS server blocksize
 638  */
 639 static inline
 640 unsigned long nfs_block_size(unsigned long bsize, unsigned char *nrbitsp)
 641 {
 642         if (bsize < NFS_MIN_FILE_IO_SIZE)
 643                 bsize = NFS_DEF_FILE_IO_SIZE;
 644         else if (bsize >= NFS_MAX_FILE_IO_SIZE)
 645                 bsize = NFS_MAX_FILE_IO_SIZE;
 646
 647         return nfs_block_bits(bsize, nrbitsp);
 648 }
 649
 650 /*
 651  * Determine the maximum file size for a superblock
 652  */
 653 static inline
 654 void nfs_super_set_maxbytes(struct super_block *sb, __u64 maxfilesize)
 655 {
 656         sb->s_maxbytes = (loff_t)maxfilesize;
 657         if (sb->s_maxbytes > MAX_LFS_FILESIZE || sb->s_maxbytes <= 0)
 658                 sb->s_maxbytes = MAX_LFS_FILESIZE;
 659 }
 660
 661 /*
 662  * Record the page as unstable and mark its inode as dirty.
 663  */
 664 static inline
 665 void nfs_mark_page_unstable(struct page *page, struct nfs_commit_info *cinfo)
 666 {
 667         if (!cinfo->dreq) {
 668                 struct inode *inode = page_file_mapping(page)->host;
 669
 670                 inc_node_page_state(page, NR_UNSTABLE_NFS);
 671                 inc_wb_stat(&inode_to_bdi(inode)->wb, WB_RECLAIMABLE);
 672                 __mark_inode_dirty(inode, I_DIRTY_DATASYNC);
 673         }
 674 }
 675
 676 /*
 677  * Determine the number of bytes of data the page contains
 678  */
 679 static inline
 680 unsigned int nfs_page_length(struct page *page)
 681 {
 682         loff_t i_size = i_size_read(page_file_mapping(page)->host);
 683
 684         if (i_size > 0) {
 685                 pgoff_t index = page_index(page);
 686                 pgoff_t end_index = (i_size - 1) >> PAGE_SHIFT;
 687                 if (index < end_index)
 688                         return PAGE_SIZE;
 689                 if (index == end_index)
 690                         return ((i_size - 1) & ~PAGE_MASK) + 1;
 691         }
 692         return 0;
 693 }
 694
 695 /*
 696  * Convert a umode to a dirent->d_type
 697  */
 698 static inline
 699 unsigned char nfs_umode_to_dtype(umode_t mode)
 700 {
 701         return (mode >> 12) & 15;
 702 }
 703
 704 /*
 705  * Determine the number of pages in an array of length 'len' and
 706  * with a base offset of 'base'
 707  */
 708 static inline
 709 unsigned int nfs_page_array_len(unsigned int base, size_t len)
 710 {
 711         return ((unsigned long)len + (unsigned long)base +
 712                 PAGE_SIZE - 1) >> PAGE_SHIFT;
 713 }
 714
 715 /*
 716  * Convert a struct timespec into a 64-bit change attribute
 717  *
 718  * This does approximately the same thing as timespec_to_ns(),
 719  * but for calculation efficiency, we multiply the seconds by
 720  * 1024*1024*1024.
 721  */
 722 static inline
 723 u64 nfs_timespec_to_change_attr(const struct timespec *ts)
 724 {
 725         return ((u64)ts->tv_sec << 30) + ts->tv_nsec;
 726 }
 727
 728 #ifdef CONFIG_CRC32
 729 /**
 730  * nfs_fhandle_hash - calculate the crc32 hash for the filehandle
 731  * @fh - pointer to filehandle
 732  *
 733  * returns a crc32 hash for the filehandle that is compatible with
 734  * the one displayed by "wireshark".
 735  */
 736 static inline u32 nfs_fhandle_hash(const struct nfs_fh *fh)
 737 {
 738         return ~crc32_le(0xFFFFFFFF, &fh->data[0], fh->size);
 739 }
 740 static inline u32 nfs_stateid_hash(const nfs4_stateid *stateid)
 741 {
 742         return ~crc32_le(0xFFFFFFFF, &stateid->other[0],
 743                                 NFS4_STATEID_OTHER_SIZE);
 744 }
 745 #else
 746 static inline u32 nfs_fhandle_hash(const struct nfs_fh *fh)
 747 {
 748         return 0;
 749 }
 750 static inline u32 nfs_stateid_hash(nfs4_stateid *stateid)
 751 {
 752         return 0;
 753 }
 754 #endif
 755
 756 static inline bool nfs_error_is_fatal(int err)
 757 {
 758         switch (err) {
 759         case -ERESTARTSYS:
 760         case -EINTR:
 761         case -EACCES:
 762         case -EDQUOT:
 763         case -EFBIG:
 764         case -EIO:
 765         case -ENOSPC:
 766         case -EROFS:
 767         case -ESTALE:
 768         case -E2BIG:
 769         case -ENOMEM:
 770         case -ETIMEDOUT:
 771                 return true;
 772         default:
 773                 return false;
 774         }
 775 }
 776