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