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