fs/nfs/internal.h

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