fs/nfs/internal.h

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