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