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