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