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