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