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