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