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