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