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 }; 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 } clone_data; 156 }; 157 158 enum 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 188 static inline struct nfs_fs_context *nfs_fc2context(const struct fs_context *fc) 189 { 190 return fc->fs_private; 191 } 192 193 /* mount_clnt.c */ 194 struct 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 208 extern int nfs_mount(struct nfs_mount_request *info, int timeo, int retrans); 209 210 /* client.c */ 211 extern const struct rpc_program nfs_program; 212 extern void nfs_clients_init(struct net *net); 213 extern void nfs_clients_exit(struct net *net); 214 extern struct nfs_client *nfs_alloc_client(const struct nfs_client_initdata *); 215 int nfs_create_rpc_client(struct nfs_client *, const struct nfs_client_initdata *, rpc_authflavor_t); 216 struct nfs_client *nfs_get_client(const struct nfs_client_initdata *); 217 int nfs_probe_server(struct nfs_server *, struct nfs_fh *); 218 void nfs_server_insert_lists(struct nfs_server *); 219 void nfs_server_remove_lists(struct nfs_server *); 220 void nfs_init_timeout_values(struct rpc_timeout *to, int proto, int timeo, int retrans); 221 int nfs_init_server_rpcclient(struct nfs_server *, const struct rpc_timeout *t, 222 rpc_authflavor_t); 223 struct nfs_server *nfs_alloc_server(void); 224 void nfs_server_copy_userdata(struct nfs_server *, struct nfs_server *); 225 226 extern void nfs_put_client(struct nfs_client *); 227 extern void nfs_free_client(struct nfs_client *); 228 void nfs_cb_idr_remove(struct nfs_client *clp); 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 bool tightly_coupled); 256 extern struct rpc_clnt *nfs4_find_or_create_ds_client(struct nfs_client *, 257 struct inode *); 258 extern void nfs4_session_limit_rwsize(struct nfs_server *server); 259 extern void nfs4_session_limit_xasize(struct nfs_server *server); 260 extern struct nfs_client *nfs3_set_ds_client(struct nfs_server *mds_srv, 261 const struct sockaddr_storage *ds_addr, int ds_addrlen, 262 int ds_proto, unsigned int ds_timeo, 263 unsigned int ds_retrans); 264 #ifdef CONFIG_PROC_FS 265 extern int __init nfs_fs_proc_init(void); 266 extern void nfs_fs_proc_exit(void); 267 extern int nfs_fs_proc_net_init(struct net *net); 268 extern void nfs_fs_proc_net_exit(struct net *net); 269 #else 270 static inline int nfs_fs_proc_net_init(struct net *net) 271 { 272 return 0; 273 } 274 static inline void nfs_fs_proc_net_exit(struct net *net) 275 { 276 } 277 static inline int nfs_fs_proc_init(void) 278 { 279 return 0; 280 } 281 static inline void nfs_fs_proc_exit(void) 282 { 283 } 284 #endif 285 286 /* callback_xdr.c */ 287 extern const struct svc_version nfs4_callback_version1; 288 extern const struct svc_version nfs4_callback_version4; 289 290 /* fs_context.c */ 291 extern struct file_system_type nfs_fs_type; 292 293 /* pagelist.c */ 294 extern int __init nfs_init_nfspagecache(void); 295 extern void nfs_destroy_nfspagecache(void); 296 extern int __init nfs_init_readpagecache(void); 297 extern void nfs_destroy_readpagecache(void); 298 extern int __init nfs_init_writepagecache(void); 299 extern void nfs_destroy_writepagecache(void); 300 301 extern int __init nfs_init_directcache(void); 302 extern void nfs_destroy_directcache(void); 303 extern void nfs_pgheader_init(struct nfs_pageio_descriptor *desc, 304 struct nfs_pgio_header *hdr, 305 void (*release)(struct nfs_pgio_header *hdr)); 306 void nfs_set_pgio_error(struct nfs_pgio_header *hdr, int error, loff_t pos); 307 int nfs_iocounter_wait(struct nfs_lock_context *l_ctx); 308 309 extern const struct nfs_pageio_ops nfs_pgio_rw_ops; 310 struct nfs_pgio_header *nfs_pgio_header_alloc(const struct nfs_rw_ops *); 311 void nfs_pgio_header_free(struct nfs_pgio_header *); 312 int nfs_generic_pgio(struct nfs_pageio_descriptor *, struct nfs_pgio_header *); 313 int nfs_initiate_pgio(struct rpc_clnt *clnt, struct nfs_pgio_header *hdr, 314 const struct cred *cred, const struct nfs_rpc_ops *rpc_ops, 315 const struct rpc_call_ops *call_ops, int how, int flags, 316 struct nfsd_file *localio); 317 void nfs_free_request(struct nfs_page *req); 318 struct nfs_pgio_mirror * 319 nfs_pgio_current_mirror(struct nfs_pageio_descriptor *desc); 320 321 static inline bool nfs_match_open_context(const struct nfs_open_context *ctx1, 322 const struct nfs_open_context *ctx2) 323 { 324 return cred_fscmp(ctx1->cred, ctx2->cred) == 0 && ctx1->state == ctx2->state; 325 } 326 327 /* nfs2xdr.c */ 328 extern const struct rpc_procinfo nfs_procedures[]; 329 extern int nfs2_decode_dirent(struct xdr_stream *, 330 struct nfs_entry *, bool); 331 332 /* nfs3xdr.c */ 333 extern const struct rpc_procinfo nfs3_procedures[]; 334 extern int nfs3_decode_dirent(struct xdr_stream *, 335 struct nfs_entry *, bool); 336 337 /* nfs4xdr.c */ 338 #if IS_ENABLED(CONFIG_NFS_V4) 339 extern int nfs4_decode_dirent(struct xdr_stream *, 340 struct nfs_entry *, bool); 341 extern const u32 nfs41_maxread_overhead; 342 extern const u32 nfs41_maxwrite_overhead; 343 extern const u32 nfs41_maxgetdevinfo_overhead; 344 345 /* nfs4proc.c */ 346 extern const struct rpc_procinfo nfs4_procedures[]; 347 #endif /* CONFIG_NFS_V4 */ 348 349 #ifdef CONFIG_NFS_V4_SECURITY_LABEL 350 extern struct nfs4_label *nfs4_label_alloc(struct nfs_server *server, gfp_t flags); 351 static inline struct nfs4_label * 352 nfs4_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 368 static 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 374 static inline struct nfs4_label *nfs4_label_alloc(struct nfs_server *server, gfp_t flags) { return NULL; } 375 static inline void nfs_zap_label_cache_locked(struct nfs_inode *nfsi) 376 { 377 } 378 static inline struct nfs4_label * 379 nfs4_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 */ 386 void nfs_close_context(struct nfs_open_context *ctx, int is_sync); 387 extern struct nfs_client *nfs_init_client(struct nfs_client *clp, 388 const struct nfs_client_initdata *); 389 390 /* dir.c */ 391 extern void nfs_readdir_record_entry_cache_hit(struct inode *dir); 392 extern void nfs_readdir_record_entry_cache_miss(struct inode *dir); 393 extern unsigned long nfs_access_cache_count(struct shrinker *shrink, 394 struct shrink_control *sc); 395 extern unsigned long nfs_access_cache_scan(struct shrinker *shrink, 396 struct shrink_control *sc); 397 struct dentry *nfs_lookup(struct inode *, struct dentry *, unsigned int); 398 void nfs_d_prune_case_insensitive_aliases(struct inode *inode); 399 int nfs_create(const struct mnt_idmap *, struct inode *, struct dentry *, 400 umode_t); 401 struct dentry *nfs_mkdir(const struct mnt_idmap *, struct inode *, struct dentry *, 402 umode_t); 403 int nfs_rmdir(struct inode *, struct dentry *); 404 int nfs_unlink(struct inode *, struct dentry *); 405 int nfs_symlink(const struct mnt_idmap *, struct inode *, struct dentry *, 406 const char *); 407 int nfs_link(struct dentry *, struct inode *, struct dentry *); 408 int nfs_mknod(const struct mnt_idmap *, struct inode *, struct dentry *, umode_t, 409 dev_t); 410 int nfs_rename(const struct mnt_idmap *, struct inode *, struct dentry *, 411 struct inode *, struct dentry *, unsigned int); 412 413 #ifdef CONFIG_NFS_V4_2 414 static 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 421 static inline __u32 nfs_access_xattr_mask(const struct nfs_server *server) 422 { 423 return 0; 424 } 425 #endif 426 427 /* file.c */ 428 int nfs_file_fsync(struct file *file, loff_t start, loff_t end, int datasync); 429 loff_t nfs_file_llseek(struct file *, loff_t, int); 430 ssize_t nfs_file_read(struct kiocb *, struct iov_iter *); 431 ssize_t nfs_file_splice_read(struct file *in, loff_t *ppos, struct pipe_inode_info *pipe, 432 size_t len, unsigned int flags); 433 int nfs_file_mmap_prepare(struct vm_area_desc *); 434 ssize_t nfs_file_write(struct kiocb *, struct iov_iter *); 435 int nfs_file_release(struct inode *, struct file *); 436 int nfs_lock(struct file *, int, struct file_lock *); 437 int nfs_flock(struct file *, int, struct file_lock *); 438 int nfs_check_flags(int); 439 void nfs_truncate_last_folio(struct address_space *mapping, loff_t from, 440 loff_t to); 441 442 /* inode.c */ 443 extern struct workqueue_struct *nfsiod_workqueue; 444 extern struct workqueue_struct *nfslocaliod_workqueue; 445 extern struct inode *nfs_alloc_inode(struct super_block *sb); 446 extern void nfs_free_inode(struct inode *); 447 extern int nfs_write_inode(struct inode *, struct writeback_control *); 448 extern int nfs_drop_inode(struct inode *); 449 extern void nfs_clear_inode(struct inode *); 450 extern void nfs_evict_inode(struct inode *); 451 extern void nfs_zap_acl_cache(struct inode *inode); 452 extern void nfs_set_cache_invalid(struct inode *inode, unsigned long flags); 453 extern bool nfs_check_cache_invalid(struct inode *, unsigned long); 454 extern int nfs_wait_bit_killable(struct wait_bit_key *key, int mode); 455 456 struct file_kattr; 457 int nfs_fileattr_get(struct dentry *dentry, struct file_kattr *fa); 458 459 #if IS_ENABLED(CONFIG_NFS_LOCALIO) 460 /* localio.c */ 461 struct nfs_local_dio { 462 u32 mem_align; 463 u32 offset_align; 464 loff_t middle_offset; 465 loff_t end_offset; 466 ssize_t start_len; /* Length for misaligned first extent */ 467 ssize_t middle_len; /* Length for DIO-aligned middle extent */ 468 ssize_t end_len; /* Length for misaligned last extent */ 469 }; 470 471 extern void nfs_local_probe_async(struct nfs_client *); 472 extern void nfs_local_probe_async_work(struct work_struct *); 473 extern struct nfsd_file *nfs_local_open_fh(struct nfs_client *, 474 const struct cred *, 475 struct nfs_fh *, 476 struct nfs_file_localio *, 477 const fmode_t); 478 extern int nfs_local_doio(struct nfs_client *, 479 struct nfsd_file *, 480 struct nfs_pgio_header *, 481 const struct rpc_call_ops *); 482 extern int nfs_local_commit(struct nfsd_file *, 483 struct nfs_commit_data *, 484 const struct rpc_call_ops *); 485 extern bool nfs_server_is_local(const struct nfs_client *clp); 486 487 #else /* CONFIG_NFS_LOCALIO */ 488 static inline void nfs_local_probe(struct nfs_client *clp) {} 489 static inline void nfs_local_probe_async(struct nfs_client *clp) {} 490 static inline struct nfsd_file * 491 nfs_local_open_fh(struct nfs_client *clp, const struct cred *cred, 492 struct nfs_fh *fh, struct nfs_file_localio *nfl, 493 const fmode_t mode) 494 { 495 return NULL; 496 } 497 static inline int nfs_local_doio(struct nfs_client *clp, 498 struct nfsd_file *localio, 499 struct nfs_pgio_header *hdr, 500 const struct rpc_call_ops *call_ops) 501 { 502 return -EINVAL; 503 } 504 static inline int nfs_local_commit(struct nfsd_file *localio, 505 struct nfs_commit_data *data, 506 const struct rpc_call_ops *call_ops) 507 { 508 return -EINVAL; 509 } 510 static inline bool nfs_server_is_local(const struct nfs_client *clp) 511 { 512 return false; 513 } 514 #endif /* CONFIG_NFS_LOCALIO */ 515 516 /* super.c */ 517 extern const struct super_operations nfs_sops; 518 bool nfs_auth_info_match(const struct nfs_auth_info *, rpc_authflavor_t); 519 int nfs_try_get_tree(struct fs_context *); 520 int nfs_get_tree_common(struct fs_context *); 521 void nfs_kill_super(struct super_block *); 522 523 extern int __init register_nfs_fs(void); 524 extern void __exit unregister_nfs_fs(void); 525 extern bool nfs_sb_active(struct super_block *sb); 526 extern void nfs_sb_deactive(struct super_block *sb); 527 extern int nfs_client_for_each_server(struct nfs_client *clp, 528 int (*fn)(struct nfs_server *, void *), 529 void *data); 530 #ifdef CONFIG_NFS_FSCACHE 531 extern const struct netfs_request_ops nfs_netfs_ops; 532 #endif 533 534 /* io.c */ 535 extern __must_check int nfs_start_io_read(struct inode *inode); 536 extern void nfs_end_io_read(struct inode *inode); 537 extern __must_check int nfs_start_io_write(struct inode *inode); 538 extern void nfs_end_io_write(struct inode *inode); 539 extern __must_check int nfs_start_io_direct(struct inode *inode); 540 extern __must_check int nfs_start_io_direct_nowait(struct inode *inode); 541 extern void nfs_end_io_direct(struct inode *inode); 542 543 static inline bool nfs_file_io_is_buffered(struct nfs_inode *nfsi) 544 { 545 return test_bit(NFS_INO_ODIRECT, &nfsi->flags) == 0; 546 } 547 548 /* Must be called with exclusively locked inode->i_rwsem */ 549 static inline void nfs_file_block_o_direct(struct nfs_inode *nfsi) 550 { 551 if (test_bit(NFS_INO_ODIRECT, &nfsi->flags)) { 552 clear_bit(NFS_INO_ODIRECT, &nfsi->flags); 553 inode_dio_wait(&nfsi->vfs_inode); 554 } 555 } 556 557 558 /* namespace.c */ 559 #define NFS_PATH_CANONICAL 1 560 extern char *nfs_path(char **p, struct dentry *dentry, 561 char *buffer, ssize_t buflen, unsigned flags); 562 extern struct vfsmount *nfs_d_automount(struct path *path); 563 int nfs_submount(struct fs_context *, struct nfs_server *); 564 int nfs_do_submount(struct fs_context *); 565 566 /* getroot.c */ 567 extern int nfs_get_root(struct super_block *s, struct fs_context *fc); 568 #if IS_ENABLED(CONFIG_NFS_V4) 569 extern int nfs4_get_rootfh(struct nfs_server *server, struct nfs_fh *mntfh, bool); 570 #endif 571 572 struct nfs_pgio_completion_ops; 573 /* read.c */ 574 extern const struct nfs_pgio_completion_ops nfs_async_read_completion_ops; 575 extern void nfs_pageio_init_read(struct nfs_pageio_descriptor *pgio, 576 struct inode *inode, bool force_mds, 577 const struct nfs_pgio_completion_ops *compl_ops); 578 extern bool nfs_read_alloc_scratch(struct nfs_pgio_header *hdr, size_t size); 579 extern int nfs_read_add_folio(struct nfs_pageio_descriptor *pgio, 580 struct nfs_open_context *ctx, 581 struct folio *folio); 582 extern void nfs_pageio_complete_read(struct nfs_pageio_descriptor *pgio); 583 extern void nfs_pageio_reset_read_mds(struct nfs_pageio_descriptor *pgio); 584 585 /* super.c */ 586 void nfs_umount_begin(struct super_block *); 587 int nfs_statfs(struct dentry *, struct kstatfs *); 588 int nfs_show_options(struct seq_file *, struct dentry *); 589 int nfs_show_devname(struct seq_file *, struct dentry *); 590 int nfs_show_path(struct seq_file *, struct dentry *); 591 int nfs_show_stats(struct seq_file *, struct dentry *); 592 int nfs_reconfigure(struct fs_context *); 593 594 /* write.c */ 595 extern void nfs_pageio_init_write(struct nfs_pageio_descriptor *pgio, 596 struct inode *inode, int ioflags, bool force_mds, 597 const struct nfs_pgio_completion_ops *compl_ops); 598 extern void nfs_pageio_reset_write_mds(struct nfs_pageio_descriptor *pgio); 599 extern void nfs_commit_free(struct nfs_commit_data *p); 600 extern void nfs_commit_prepare(struct rpc_task *task, void *calldata); 601 extern int nfs_initiate_commit(struct rpc_clnt *clnt, 602 struct nfs_commit_data *data, 603 const struct nfs_rpc_ops *nfs_ops, 604 const struct rpc_call_ops *call_ops, 605 int how, int flags, 606 struct nfsd_file *localio); 607 extern void nfs_init_commit(struct nfs_commit_data *data, 608 struct list_head *head, 609 struct pnfs_layout_segment *lseg, 610 struct nfs_commit_info *cinfo); 611 int nfs_scan_commit_list(struct list_head *src, struct list_head *dst, 612 struct nfs_commit_info *cinfo, int max); 613 unsigned long nfs_reqs_to_commit(struct nfs_commit_info *); 614 int nfs_scan_commit(struct inode *inode, struct list_head *dst, 615 struct nfs_commit_info *cinfo); 616 void nfs_mark_request_commit(struct nfs_page *req, 617 struct pnfs_layout_segment *lseg, 618 struct nfs_commit_info *cinfo, 619 u32 ds_commit_idx); 620 int nfs_write_need_commit(struct nfs_pgio_header *); 621 void nfs_writeback_update_inode(struct nfs_pgio_header *hdr); 622 int nfs_generic_commit_list(struct inode *inode, struct list_head *head, 623 int how, struct nfs_commit_info *cinfo); 624 void nfs_retry_commit(struct list_head *page_list, 625 struct pnfs_layout_segment *lseg, 626 struct nfs_commit_info *cinfo, 627 u32 ds_commit_idx); 628 void nfs_commitdata_release(struct nfs_commit_data *data); 629 void nfs_request_add_commit_list(struct nfs_page *req, 630 struct nfs_commit_info *cinfo); 631 void nfs_request_add_commit_list_locked(struct nfs_page *req, 632 struct list_head *dst, 633 struct nfs_commit_info *cinfo); 634 void nfs_request_remove_commit_list(struct nfs_page *req, 635 struct nfs_commit_info *cinfo); 636 void nfs_init_cinfo(struct nfs_commit_info *cinfo, 637 struct inode *inode, 638 struct nfs_direct_req *dreq); 639 int nfs_key_timeout_notify(struct file *filp, struct inode *inode); 640 bool nfs_ctx_key_to_expire(struct nfs_open_context *ctx, struct inode *inode); 641 void nfs_pageio_stop_mirroring(struct nfs_pageio_descriptor *pgio); 642 643 int nfs_filemap_write_and_wait_range(struct address_space *mapping, 644 loff_t lstart, loff_t lend); 645 646 #ifdef CONFIG_NFS_V4 647 static inline void 648 pnfs_bucket_clear_pnfs_ds_commit_verifiers(struct pnfs_commit_bucket *buckets, 649 unsigned int nbuckets) 650 { 651 unsigned int i; 652 653 for (i = 0; i < nbuckets; i++) 654 buckets[i].direct_verf.committed = NFS_INVALID_STABLE_HOW; 655 } 656 static inline 657 void nfs_clear_pnfs_ds_commit_verifiers(struct pnfs_ds_commit_info *cinfo) 658 { 659 struct pnfs_commit_array *array; 660 661 rcu_read_lock(); 662 list_for_each_entry_rcu(array, &cinfo->commits, cinfo_list) 663 pnfs_bucket_clear_pnfs_ds_commit_verifiers(array->buckets, 664 array->nbuckets); 665 rcu_read_unlock(); 666 } 667 #else /* CONFIG_NFS_V4 */ 668 static inline 669 void nfs_clear_pnfs_ds_commit_verifiers(struct pnfs_ds_commit_info *cinfo) 670 { 671 } 672 #endif /* CONFIG_NFS_V4 */ 673 674 #ifdef CONFIG_MIGRATION 675 int nfs_migrate_folio(struct address_space *, struct folio *dst, 676 struct folio *src, enum migrate_mode); 677 #else 678 #define nfs_migrate_folio NULL 679 #endif 680 681 static inline int 682 nfs_write_verifier_cmp(const struct nfs_write_verifier *v1, 683 const struct nfs_write_verifier *v2) 684 { 685 return memcmp(v1->data, v2->data, sizeof(v1->data)); 686 } 687 688 static inline bool 689 nfs_write_match_verf(const struct nfs_writeverf *verf, 690 struct nfs_page *req) 691 { 692 return verf->committed > NFS_UNSTABLE && 693 !nfs_write_verifier_cmp(&req->wb_verf, &verf->verifier); 694 } 695 696 static inline gfp_t nfs_io_gfp_mask(void) 697 { 698 gfp_t ret = current_gfp_context(GFP_KERNEL); 699 700 /* For workers __GFP_NORETRY only with __GFP_IO or __GFP_FS */ 701 if ((current->flags & PF_WQ_WORKER) && ret == GFP_KERNEL) 702 ret |= __GFP_NORETRY | __GFP_NOWARN; 703 return ret; 704 } 705 706 /* 707 * Special version of should_remove_suid() that ignores capabilities. 708 */ 709 static inline int nfs_should_remove_suid(const struct inode *inode) 710 { 711 umode_t mode = inode->i_mode; 712 int kill = 0; 713 714 /* suid always must be killed */ 715 if (unlikely(mode & S_ISUID)) 716 kill = ATTR_KILL_SUID; 717 718 /* 719 * sgid without any exec bits is just a mandatory locking mark; leave 720 * it alone. If some exec bits are set, it's a real sgid; kill it. 721 */ 722 if (unlikely((mode & S_ISGID) && (mode & S_IXGRP))) 723 kill |= ATTR_KILL_SGID; 724 725 if (unlikely(kill && S_ISREG(mode))) 726 return kill; 727 728 return 0; 729 } 730 731 /* unlink.c */ 732 extern struct rpc_task * 733 nfs_async_rename(struct inode *old_dir, struct inode *new_dir, 734 struct dentry *old_dentry, struct dentry *new_dentry, 735 void (*complete)(struct rpc_task *, struct nfs_renamedata *)); 736 extern int nfs_sillyrename(struct inode *dir, struct dentry *dentry); 737 738 /* direct.c */ 739 void nfs_init_cinfo_from_dreq(struct nfs_commit_info *cinfo, 740 struct nfs_direct_req *dreq); 741 extern ssize_t nfs_dreq_bytes_left(struct nfs_direct_req *dreq, loff_t offset); 742 743 /* nfs4proc.c */ 744 extern struct nfs_client *nfs4_init_client(struct nfs_client *clp, 745 const struct nfs_client_initdata *); 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 request's range as unstable (an extra writeback period) and 857 * mark its inode as dirty. 858 */ 859 static inline void nfs_folio_mark_unstable(struct nfs_page *req, 860 struct nfs_commit_info *cinfo) 861 { 862 struct folio *folio = nfs_page_to_folio(req); 863 864 if (folio && !cinfo->dreq) { 865 struct inode *inode = folio->mapping->host; 866 long nr = DIV_ROUND_UP(req->wb_bytes, PAGE_SIZE); 867 868 /* This range is really still in write-back - just that the 869 * writeback is happening on the server now. 870 */ 871 node_stat_mod_folio(folio, NR_WRITEBACK, nr); 872 bdi_wb_stat_mod(inode, WB_WRITEBACK, nr); 873 __mark_inode_dirty(inode, I_DIRTY_DATASYNC); 874 } 875 } 876 877 /* 878 * Determine the number of bytes of data the page contains 879 */ 880 static inline size_t nfs_folio_length(struct folio *folio) 881 { 882 loff_t i_size = i_size_read(folio->mapping->host); 883 884 if (i_size > 0) { 885 pgoff_t index = folio->index >> folio_order(folio); 886 pgoff_t end_index = (i_size - 1) >> folio_shift(folio); 887 if (index < end_index) 888 return folio_size(folio); 889 if (index == end_index) 890 return offset_in_folio(folio, i_size - 1) + 1; 891 } 892 return 0; 893 } 894 895 /* 896 * Convert a umode to a dirent->d_type 897 */ 898 static inline 899 unsigned char nfs_umode_to_dtype(umode_t mode) 900 { 901 return (mode >> 12) & 15; 902 } 903 904 /* 905 * Determine the number of pages in an array of length 'len' and 906 * with a base offset of 'base' 907 */ 908 static inline unsigned int nfs_page_array_len(unsigned int base, size_t len) 909 { 910 return ((unsigned long)len + (unsigned long)base + PAGE_SIZE - 1) >> 911 PAGE_SHIFT; 912 } 913 914 /* 915 * Convert a struct timespec64 into a 64-bit change attribute 916 * 917 * This does approximately the same thing as timespec64_to_ns(), 918 * but for calculation efficiency, we multiply the seconds by 919 * 1024*1024*1024. 920 */ 921 static inline 922 u64 nfs_timespec_to_change_attr(const struct timespec64 *ts) 923 { 924 return ((u64)ts->tv_sec << 30) + ts->tv_nsec; 925 } 926 927 static inline u32 nfs_stateid_hash(const nfs4_stateid *stateid) 928 { 929 return ~crc32_le(0xFFFFFFFF, &stateid->other[0], 930 NFS4_STATEID_OTHER_SIZE); 931 } 932 933 static inline bool nfs_current_task_exiting(void) 934 { 935 return (current->flags & PF_EXITING) != 0; 936 } 937 938 static inline bool nfs_error_is_fatal(int err) 939 { 940 switch (err) { 941 case -ERESTARTSYS: 942 case -EINTR: 943 case -EACCES: 944 case -EDQUOT: 945 case -EFBIG: 946 case -EIO: 947 case -ENOSPC: 948 case -EROFS: 949 case -ESTALE: 950 case -E2BIG: 951 case -ENOMEM: 952 case -ETIMEDOUT: 953 return true; 954 default: 955 return false; 956 } 957 } 958 959 static inline bool nfs_error_is_fatal_on_server(int err) 960 { 961 switch (err) { 962 case 0: 963 case -ERESTARTSYS: 964 case -EINTR: 965 case -ENOMEM: 966 return false; 967 } 968 return nfs_error_is_fatal(err); 969 } 970 971 /* 972 * Select between a default port value and a user-specified port value. 973 * If a zero value is set, then autobind will be used. 974 */ 975 static inline void nfs_set_port(struct sockaddr_storage *sap, int *port, 976 const unsigned short default_port) 977 { 978 if (*port == NFS_UNSPEC_PORT) 979 *port = default_port; 980 981 rpc_set_port((struct sockaddr *)sap, *port); 982 } 983 984 struct nfs_direct_req { 985 struct kref kref; /* release manager */ 986 987 /* I/O parameters */ 988 struct nfs_open_context *ctx; /* file open context info */ 989 struct nfs_lock_context *l_ctx; /* Lock context info */ 990 struct kiocb * iocb; /* controlling i/o request */ 991 struct inode * inode; /* target file of i/o */ 992 993 /* completion state */ 994 atomic_t io_count; /* i/os we're waiting for */ 995 spinlock_t lock; /* protect completion state */ 996 997 loff_t io_start; /* Start offset for I/O */ 998 ssize_t count, /* bytes actually processed */ 999 max_count, /* max expected count */ 1000 error; /* any reported error */ 1001 struct completion completion; /* wait for i/o completion */ 1002 1003 /* commit state */ 1004 struct nfs_mds_commit_info mds_cinfo; /* Storage for cinfo */ 1005 struct pnfs_ds_commit_info ds_cinfo; /* Storage for cinfo */ 1006 struct work_struct work; 1007 int flags; 1008 /* for write */ 1009 #define NFS_ODIRECT_DO_COMMIT (1) /* an unstable reply was received */ 1010 #define NFS_ODIRECT_RESCHED_WRITES (2) /* write verification failed */ 1011 /* for read */ 1012 #define NFS_ODIRECT_SHOULD_DIRTY (3) /* dirty user-space page after read */ 1013 #define NFS_ODIRECT_DONE INT_MAX /* write verification failed */ 1014 }; 1015