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