1 /* 2 * NFS internal definitions 3 */ 4 5 #include "nfs4_fs.h" 6 #include <linux/mount.h> 7 #include <linux/security.h> 8 9 #define NFS_MS_MASK (MS_RDONLY|MS_NOSUID|MS_NODEV|MS_NOEXEC|MS_SYNCHRONOUS) 10 11 struct nfs_string; 12 13 /* Maximum number of readahead requests 14 * FIXME: this should really be a sysctl so that users may tune it to suit 15 * their needs. People that do NFS over a slow network, might for 16 * instance want to reduce it to something closer to 1 for improved 17 * interactive response. 18 */ 19 #define NFS_MAX_READAHEAD (RPC_DEF_SLOT_TABLE - 1) 20 21 /* 22 * Determine if sessions are in use. 23 */ 24 static inline int nfs4_has_session(const struct nfs_client *clp) 25 { 26 #ifdef CONFIG_NFS_V4_1 27 if (clp->cl_session) 28 return 1; 29 #endif /* CONFIG_NFS_V4_1 */ 30 return 0; 31 } 32 33 static inline int nfs4_has_persistent_session(const struct nfs_client *clp) 34 { 35 #ifdef CONFIG_NFS_V4_1 36 if (nfs4_has_session(clp)) 37 return (clp->cl_session->flags & SESSION4_PERSIST); 38 #endif /* CONFIG_NFS_V4_1 */ 39 return 0; 40 } 41 42 static inline void nfs_attr_check_mountpoint(struct super_block *parent, struct nfs_fattr *fattr) 43 { 44 if (!nfs_fsid_equal(&NFS_SB(parent)->fsid, &fattr->fsid)) 45 fattr->valid |= NFS_ATTR_FATTR_MOUNTPOINT; 46 } 47 48 static inline int nfs_attr_use_mounted_on_fileid(struct nfs_fattr *fattr) 49 { 50 if (((fattr->valid & NFS_ATTR_FATTR_MOUNTED_ON_FILEID) == 0) || 51 (((fattr->valid & NFS_ATTR_FATTR_MOUNTPOINT) == 0) && 52 ((fattr->valid & NFS_ATTR_FATTR_V4_REFERRAL) == 0))) 53 return 0; 54 55 fattr->fileid = fattr->mounted_on_fileid; 56 return 1; 57 } 58 59 struct nfs_clone_mount { 60 const struct super_block *sb; 61 const struct dentry *dentry; 62 struct nfs_fh *fh; 63 struct nfs_fattr *fattr; 64 char *hostname; 65 char *mnt_path; 66 struct sockaddr *addr; 67 size_t addrlen; 68 rpc_authflavor_t authflavor; 69 }; 70 71 /* 72 * Note: RFC 1813 doesn't limit the number of auth flavors that 73 * a server can return, so make something up. 74 */ 75 #define NFS_MAX_SECFLAVORS (12) 76 77 /* 78 * Value used if the user did not specify a port value. 79 */ 80 #define NFS_UNSPEC_PORT (-1) 81 82 /* 83 * Maximum number of pages that readdir can use for creating 84 * a vmapped array of pages. 85 */ 86 #define NFS_MAX_READDIR_PAGES 8 87 88 /* 89 * In-kernel mount arguments 90 */ 91 struct nfs_parsed_mount_data { 92 int flags; 93 int rsize, wsize; 94 int timeo, retrans; 95 int acregmin, acregmax, 96 acdirmin, acdirmax; 97 int namlen; 98 unsigned int options; 99 unsigned int bsize; 100 unsigned int auth_flavor_len; 101 rpc_authflavor_t auth_flavors[1]; 102 char *client_address; 103 unsigned int version; 104 unsigned int minorversion; 105 char *fscache_uniq; 106 bool need_mount; 107 108 struct { 109 struct sockaddr_storage address; 110 size_t addrlen; 111 char *hostname; 112 u32 version; 113 int port; 114 unsigned short protocol; 115 } mount_server; 116 117 struct { 118 struct sockaddr_storage address; 119 size_t addrlen; 120 char *hostname; 121 char *export_path; 122 int port; 123 unsigned short protocol; 124 } nfs_server; 125 126 struct security_mnt_opts lsm_opts; 127 struct net *net; 128 }; 129 130 /* mount_clnt.c */ 131 struct nfs_mount_request { 132 struct sockaddr *sap; 133 size_t salen; 134 char *hostname; 135 char *dirpath; 136 u32 version; 137 unsigned short protocol; 138 struct nfs_fh *fh; 139 int noresvport; 140 unsigned int *auth_flav_len; 141 rpc_authflavor_t *auth_flavs; 142 struct net *net; 143 }; 144 145 extern int nfs_mount(struct nfs_mount_request *info); 146 extern void nfs_umount(const struct nfs_mount_request *info); 147 148 /* client.c */ 149 extern const struct rpc_program nfs_program; 150 extern void nfs_clients_init(struct net *net); 151 extern struct nfs_client *nfs_alloc_client(const struct nfs_client_initdata *); 152 int nfs_create_rpc_client(struct nfs_client *, const struct rpc_timeout *, rpc_authflavor_t); 153 154 extern void nfs_cleanup_cb_ident_idr(struct net *); 155 extern void nfs_put_client(struct nfs_client *); 156 extern void nfs_free_client(struct nfs_client *); 157 extern struct nfs_client *nfs4_find_client_ident(struct net *, int); 158 extern struct nfs_client * 159 nfs4_find_client_sessionid(struct net *, const struct sockaddr *, 160 struct nfs4_sessionid *); 161 extern struct nfs_server *nfs_create_server( 162 const struct nfs_parsed_mount_data *, 163 struct nfs_fh *); 164 extern struct nfs_server *nfs4_create_server( 165 const struct nfs_parsed_mount_data *, 166 struct nfs_fh *); 167 extern struct nfs_server *nfs4_create_referral_server(struct nfs_clone_mount *, 168 struct nfs_fh *); 169 extern void nfs_free_server(struct nfs_server *server); 170 extern struct nfs_server *nfs_clone_server(struct nfs_server *, 171 struct nfs_fh *, 172 struct nfs_fattr *, 173 rpc_authflavor_t); 174 extern int nfs_wait_client_init_complete(const struct nfs_client *clp); 175 extern void nfs_mark_client_ready(struct nfs_client *clp, int state); 176 extern struct nfs_client *nfs4_set_ds_client(struct nfs_client* mds_clp, 177 const struct sockaddr *ds_addr, 178 int ds_addrlen, int ds_proto, 179 unsigned int ds_timeo, 180 unsigned int ds_retrans); 181 #ifdef CONFIG_PROC_FS 182 extern int __init nfs_fs_proc_init(void); 183 extern void nfs_fs_proc_exit(void); 184 #else 185 static inline int nfs_fs_proc_init(void) 186 { 187 return 0; 188 } 189 static inline void nfs_fs_proc_exit(void) 190 { 191 } 192 #endif 193 194 /* callback_xdr.c */ 195 extern struct svc_version nfs4_callback_version1; 196 extern struct svc_version nfs4_callback_version4; 197 198 struct nfs_pageio_descriptor; 199 /* pagelist.c */ 200 extern int __init nfs_init_nfspagecache(void); 201 extern void nfs_destroy_nfspagecache(void); 202 extern int __init nfs_init_readpagecache(void); 203 extern void nfs_destroy_readpagecache(void); 204 extern int __init nfs_init_writepagecache(void); 205 extern void nfs_destroy_writepagecache(void); 206 207 extern int __init nfs_init_directcache(void); 208 extern void nfs_destroy_directcache(void); 209 extern bool nfs_pgarray_set(struct nfs_page_array *p, unsigned int pagecount); 210 extern void nfs_pgheader_init(struct nfs_pageio_descriptor *desc, 211 struct nfs_pgio_header *hdr, 212 void (*release)(struct nfs_pgio_header *hdr)); 213 void nfs_set_pgio_error(struct nfs_pgio_header *hdr, int error, loff_t pos); 214 215 /* nfs2xdr.c */ 216 extern struct rpc_procinfo nfs_procedures[]; 217 extern int nfs2_decode_dirent(struct xdr_stream *, 218 struct nfs_entry *, int); 219 220 /* nfs3xdr.c */ 221 extern struct rpc_procinfo nfs3_procedures[]; 222 extern int nfs3_decode_dirent(struct xdr_stream *, 223 struct nfs_entry *, int); 224 225 /* nfs4xdr.c */ 226 #ifdef CONFIG_NFS_V4 227 extern int nfs4_decode_dirent(struct xdr_stream *, 228 struct nfs_entry *, int); 229 #endif 230 #ifdef CONFIG_NFS_V4_1 231 extern const u32 nfs41_maxread_overhead; 232 extern const u32 nfs41_maxwrite_overhead; 233 #endif 234 235 /* nfs4proc.c */ 236 #ifdef CONFIG_NFS_V4 237 extern struct rpc_procinfo nfs4_procedures[]; 238 #endif 239 240 extern int nfs4_init_ds_session(struct nfs_client *, unsigned long); 241 242 /* proc.c */ 243 void nfs_close_context(struct nfs_open_context *ctx, int is_sync); 244 extern struct nfs_client *nfs_init_client(struct nfs_client *clp, 245 const struct rpc_timeout *timeparms, 246 const char *ip_addr, rpc_authflavor_t authflavour); 247 248 /* dir.c */ 249 extern int nfs_access_cache_shrinker(struct shrinker *shrink, 250 struct shrink_control *sc); 251 struct dentry *nfs_lookup(struct inode *, struct dentry *, unsigned int); 252 int nfs_create(struct inode *, struct dentry *, umode_t, bool); 253 int nfs_mkdir(struct inode *, struct dentry *, umode_t); 254 int nfs_rmdir(struct inode *, struct dentry *); 255 int nfs_unlink(struct inode *, struct dentry *); 256 int nfs_symlink(struct inode *, struct dentry *, const char *); 257 int nfs_link(struct dentry *, struct inode *, struct dentry *); 258 int nfs_mknod(struct inode *, struct dentry *, umode_t, dev_t); 259 int nfs_rename(struct inode *, struct dentry *, struct inode *, struct dentry *); 260 261 /* file.c */ 262 int nfs_file_fsync_commit(struct file *, loff_t, loff_t, int); 263 loff_t nfs_file_llseek(struct file *, loff_t, int); 264 int nfs_file_flush(struct file *, fl_owner_t); 265 ssize_t nfs_file_read(struct kiocb *, const struct iovec *, unsigned long, loff_t); 266 ssize_t nfs_file_splice_read(struct file *, loff_t *, struct pipe_inode_info *, 267 size_t, unsigned int); 268 int nfs_file_mmap(struct file *, struct vm_area_struct *); 269 ssize_t nfs_file_write(struct kiocb *, const struct iovec *, unsigned long, loff_t); 270 int nfs_file_release(struct inode *, struct file *); 271 int nfs_lock(struct file *, int, struct file_lock *); 272 int nfs_flock(struct file *, int, struct file_lock *); 273 ssize_t nfs_file_splice_write(struct pipe_inode_info *, struct file *, loff_t *, 274 size_t, unsigned int); 275 int nfs_check_flags(int); 276 int nfs_setlease(struct file *, long, struct file_lock **); 277 278 /* inode.c */ 279 extern struct workqueue_struct *nfsiod_workqueue; 280 extern struct inode *nfs_alloc_inode(struct super_block *sb); 281 extern void nfs_destroy_inode(struct inode *); 282 extern int nfs_write_inode(struct inode *, struct writeback_control *); 283 extern void nfs_evict_inode(struct inode *); 284 #ifdef CONFIG_NFS_V4 285 extern void nfs4_evict_inode(struct inode *); 286 #endif 287 void nfs_zap_acl_cache(struct inode *inode); 288 extern int nfs_wait_bit_killable(void *word); 289 290 /* super.c */ 291 extern struct file_system_type nfs_xdev_fs_type; 292 #ifdef CONFIG_NFS_V4 293 extern struct file_system_type nfs4_xdev_fs_type; 294 extern struct file_system_type nfs4_referral_fs_type; 295 #endif 296 297 extern struct rpc_stat nfs_rpcstat; 298 299 extern int __init register_nfs_fs(void); 300 extern void __exit unregister_nfs_fs(void); 301 extern void nfs_sb_active(struct super_block *sb); 302 extern void nfs_sb_deactive(struct super_block *sb); 303 304 /* namespace.c */ 305 extern char *nfs_path(char **p, struct dentry *dentry, 306 char *buffer, ssize_t buflen); 307 extern struct vfsmount *nfs_d_automount(struct path *path); 308 struct vfsmount *nfs_submount(struct nfs_server *, struct dentry *, 309 struct nfs_fh *, struct nfs_fattr *); 310 struct vfsmount *nfs_do_submount(struct dentry *, struct nfs_fh *, 311 struct nfs_fattr *, rpc_authflavor_t); 312 313 /* getroot.c */ 314 extern struct dentry *nfs_get_root(struct super_block *, struct nfs_fh *, 315 const char *); 316 #ifdef CONFIG_NFS_V4 317 extern struct dentry *nfs4_get_root(struct super_block *, struct nfs_fh *, 318 const char *); 319 320 extern int nfs4_get_rootfh(struct nfs_server *server, struct nfs_fh *mntfh); 321 #endif 322 323 struct nfs_pgio_completion_ops; 324 /* read.c */ 325 extern struct nfs_read_header *nfs_readhdr_alloc(void); 326 extern void nfs_readhdr_free(struct nfs_pgio_header *hdr); 327 extern void nfs_pageio_init_read(struct nfs_pageio_descriptor *pgio, 328 struct inode *inode, 329 const struct nfs_pgio_completion_ops *compl_ops); 330 extern int nfs_initiate_read(struct rpc_clnt *clnt, 331 struct nfs_read_data *data, 332 const struct rpc_call_ops *call_ops, int flags); 333 extern void nfs_read_prepare(struct rpc_task *task, void *calldata); 334 extern int nfs_generic_pagein(struct nfs_pageio_descriptor *desc, 335 struct nfs_pgio_header *hdr); 336 extern void nfs_pageio_init_read(struct nfs_pageio_descriptor *pgio, 337 struct inode *inode, 338 const struct nfs_pgio_completion_ops *compl_ops); 339 extern void nfs_pageio_reset_read_mds(struct nfs_pageio_descriptor *pgio); 340 extern void nfs_readdata_release(struct nfs_read_data *rdata); 341 342 /* write.c */ 343 extern void nfs_pageio_init_write(struct nfs_pageio_descriptor *pgio, 344 struct inode *inode, int ioflags, 345 const struct nfs_pgio_completion_ops *compl_ops); 346 extern struct nfs_write_header *nfs_writehdr_alloc(void); 347 extern void nfs_writehdr_free(struct nfs_pgio_header *hdr); 348 extern int nfs_generic_flush(struct nfs_pageio_descriptor *desc, 349 struct nfs_pgio_header *hdr); 350 extern void nfs_pageio_init_write(struct nfs_pageio_descriptor *pgio, 351 struct inode *inode, int ioflags, 352 const struct nfs_pgio_completion_ops *compl_ops); 353 extern void nfs_pageio_reset_write_mds(struct nfs_pageio_descriptor *pgio); 354 extern void nfs_writedata_release(struct nfs_write_data *wdata); 355 extern void nfs_commit_free(struct nfs_commit_data *p); 356 extern int nfs_initiate_write(struct rpc_clnt *clnt, 357 struct nfs_write_data *data, 358 const struct rpc_call_ops *call_ops, 359 int how, int flags); 360 extern void nfs_write_prepare(struct rpc_task *task, void *calldata); 361 extern void nfs_commit_prepare(struct rpc_task *task, void *calldata); 362 extern int nfs_initiate_commit(struct rpc_clnt *clnt, 363 struct nfs_commit_data *data, 364 const struct rpc_call_ops *call_ops, 365 int how, int flags); 366 extern void nfs_init_commit(struct nfs_commit_data *data, 367 struct list_head *head, 368 struct pnfs_layout_segment *lseg, 369 struct nfs_commit_info *cinfo); 370 int nfs_scan_commit_list(struct list_head *src, struct list_head *dst, 371 struct nfs_commit_info *cinfo, int max); 372 int nfs_scan_commit(struct inode *inode, struct list_head *dst, 373 struct nfs_commit_info *cinfo); 374 void nfs_mark_request_commit(struct nfs_page *req, 375 struct pnfs_layout_segment *lseg, 376 struct nfs_commit_info *cinfo); 377 int nfs_generic_commit_list(struct inode *inode, struct list_head *head, 378 int how, struct nfs_commit_info *cinfo); 379 void nfs_retry_commit(struct list_head *page_list, 380 struct pnfs_layout_segment *lseg, 381 struct nfs_commit_info *cinfo); 382 void nfs_commitdata_release(struct nfs_commit_data *data); 383 void nfs_request_add_commit_list(struct nfs_page *req, struct list_head *dst, 384 struct nfs_commit_info *cinfo); 385 void nfs_request_remove_commit_list(struct nfs_page *req, 386 struct nfs_commit_info *cinfo); 387 void nfs_init_cinfo(struct nfs_commit_info *cinfo, 388 struct inode *inode, 389 struct nfs_direct_req *dreq); 390 391 #ifdef CONFIG_MIGRATION 392 extern int nfs_migrate_page(struct address_space *, 393 struct page *, struct page *, enum migrate_mode); 394 #else 395 #define nfs_migrate_page NULL 396 #endif 397 398 /* direct.c */ 399 void nfs_init_cinfo_from_dreq(struct nfs_commit_info *cinfo, 400 struct nfs_direct_req *dreq); 401 static inline void nfs_inode_dio_wait(struct inode *inode) 402 { 403 inode_dio_wait(inode); 404 } 405 406 /* nfs4proc.c */ 407 extern void __nfs4_read_done_cb(struct nfs_read_data *); 408 extern struct nfs_client *nfs4_init_client(struct nfs_client *clp, 409 const struct rpc_timeout *timeparms, 410 const char *ip_addr, 411 rpc_authflavor_t authflavour); 412 extern int _nfs4_call_sync(struct rpc_clnt *clnt, 413 struct nfs_server *server, 414 struct rpc_message *msg, 415 struct nfs4_sequence_args *args, 416 struct nfs4_sequence_res *res, 417 int cache_reply); 418 extern int _nfs4_call_sync_session(struct rpc_clnt *clnt, 419 struct nfs_server *server, 420 struct rpc_message *msg, 421 struct nfs4_sequence_args *args, 422 struct nfs4_sequence_res *res, 423 int cache_reply); 424 425 /* 426 * Determine the device name as a string 427 */ 428 static inline char *nfs_devname(struct dentry *dentry, 429 char *buffer, ssize_t buflen) 430 { 431 char *dummy; 432 return nfs_path(&dummy, dentry, buffer, buflen); 433 } 434 435 /* 436 * Determine the actual block size (and log2 thereof) 437 */ 438 static inline 439 unsigned long nfs_block_bits(unsigned long bsize, unsigned char *nrbitsp) 440 { 441 /* make sure blocksize is a power of two */ 442 if ((bsize & (bsize - 1)) || nrbitsp) { 443 unsigned char nrbits; 444 445 for (nrbits = 31; nrbits && !(bsize & (1 << nrbits)); nrbits--) 446 ; 447 bsize = 1 << nrbits; 448 if (nrbitsp) 449 *nrbitsp = nrbits; 450 } 451 452 return bsize; 453 } 454 455 /* 456 * Calculate the number of 512byte blocks used. 457 */ 458 static inline blkcnt_t nfs_calc_block_size(u64 tsize) 459 { 460 blkcnt_t used = (tsize + 511) >> 9; 461 return (used > ULONG_MAX) ? ULONG_MAX : used; 462 } 463 464 /* 465 * Compute and set NFS server blocksize 466 */ 467 static inline 468 unsigned long nfs_block_size(unsigned long bsize, unsigned char *nrbitsp) 469 { 470 if (bsize < NFS_MIN_FILE_IO_SIZE) 471 bsize = NFS_DEF_FILE_IO_SIZE; 472 else if (bsize >= NFS_MAX_FILE_IO_SIZE) 473 bsize = NFS_MAX_FILE_IO_SIZE; 474 475 return nfs_block_bits(bsize, nrbitsp); 476 } 477 478 /* 479 * Determine the maximum file size for a superblock 480 */ 481 static inline 482 void nfs_super_set_maxbytes(struct super_block *sb, __u64 maxfilesize) 483 { 484 sb->s_maxbytes = (loff_t)maxfilesize; 485 if (sb->s_maxbytes > MAX_LFS_FILESIZE || sb->s_maxbytes <= 0) 486 sb->s_maxbytes = MAX_LFS_FILESIZE; 487 } 488 489 /* 490 * Determine the number of bytes of data the page contains 491 */ 492 static inline 493 unsigned int nfs_page_length(struct page *page) 494 { 495 loff_t i_size = i_size_read(page->mapping->host); 496 497 if (i_size > 0) { 498 pgoff_t end_index = (i_size - 1) >> PAGE_CACHE_SHIFT; 499 if (page->index < end_index) 500 return PAGE_CACHE_SIZE; 501 if (page->index == end_index) 502 return ((i_size - 1) & ~PAGE_CACHE_MASK) + 1; 503 } 504 return 0; 505 } 506 507 /* 508 * Convert a umode to a dirent->d_type 509 */ 510 static inline 511 unsigned char nfs_umode_to_dtype(umode_t mode) 512 { 513 return (mode >> 12) & 15; 514 } 515 516 /* 517 * Determine the number of pages in an array of length 'len' and 518 * with a base offset of 'base' 519 */ 520 static inline 521 unsigned int nfs_page_array_len(unsigned int base, size_t len) 522 { 523 return ((unsigned long)len + (unsigned long)base + 524 PAGE_SIZE - 1) >> PAGE_SHIFT; 525 } 526 527 /* 528 * Convert a struct timespec into a 64-bit change attribute 529 * 530 * This does approximately the same thing as timespec_to_ns(), 531 * but for calculation efficiency, we multiply the seconds by 532 * 1024*1024*1024. 533 */ 534 static inline 535 u64 nfs_timespec_to_change_attr(const struct timespec *ts) 536 { 537 return ((u64)ts->tv_sec << 30) + ts->tv_nsec; 538 } 539