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 152 extern void nfs_cleanup_cb_ident_idr(struct net *); 153 extern void nfs_put_client(struct nfs_client *); 154 extern struct nfs_client *nfs4_find_client_ident(struct net *, int); 155 extern struct nfs_client * 156 nfs4_find_client_sessionid(struct net *, const struct sockaddr *, 157 struct nfs4_sessionid *); 158 extern struct nfs_server *nfs_create_server( 159 const struct nfs_parsed_mount_data *, 160 struct nfs_fh *); 161 extern struct nfs_server *nfs4_create_server( 162 const struct nfs_parsed_mount_data *, 163 struct nfs_fh *); 164 extern struct nfs_server *nfs4_create_referral_server(struct nfs_clone_mount *, 165 struct nfs_fh *); 166 extern void nfs_free_server(struct nfs_server *server); 167 extern struct nfs_server *nfs_clone_server(struct nfs_server *, 168 struct nfs_fh *, 169 struct nfs_fattr *, 170 rpc_authflavor_t); 171 extern void nfs_mark_client_ready(struct nfs_client *clp, int state); 172 extern int nfs4_check_client_ready(struct nfs_client *clp); 173 extern struct nfs_client *nfs4_set_ds_client(struct nfs_client* mds_clp, 174 const struct sockaddr *ds_addr, 175 int ds_addrlen, int ds_proto); 176 #ifdef CONFIG_PROC_FS 177 extern int __init nfs_fs_proc_init(void); 178 extern void nfs_fs_proc_exit(void); 179 #else 180 static inline int nfs_fs_proc_init(void) 181 { 182 return 0; 183 } 184 static inline void nfs_fs_proc_exit(void) 185 { 186 } 187 #endif 188 189 /* callback_xdr.c */ 190 extern struct svc_version nfs4_callback_version1; 191 extern struct svc_version nfs4_callback_version4; 192 193 struct nfs_pageio_descriptor; 194 /* pagelist.c */ 195 extern int __init nfs_init_nfspagecache(void); 196 extern void nfs_destroy_nfspagecache(void); 197 extern int __init nfs_init_readpagecache(void); 198 extern void nfs_destroy_readpagecache(void); 199 extern int __init nfs_init_writepagecache(void); 200 extern void nfs_destroy_writepagecache(void); 201 202 extern int __init nfs_init_directcache(void); 203 extern void nfs_destroy_directcache(void); 204 extern bool nfs_pgarray_set(struct nfs_page_array *p, unsigned int pagecount); 205 extern void nfs_pgheader_init(struct nfs_pageio_descriptor *desc, 206 struct nfs_pgio_header *hdr, 207 void (*release)(struct nfs_pgio_header *hdr)); 208 void nfs_set_pgio_error(struct nfs_pgio_header *hdr, int error, loff_t pos); 209 210 /* nfs2xdr.c */ 211 extern struct rpc_procinfo nfs_procedures[]; 212 extern int nfs2_decode_dirent(struct xdr_stream *, 213 struct nfs_entry *, int); 214 215 /* nfs3xdr.c */ 216 extern struct rpc_procinfo nfs3_procedures[]; 217 extern int nfs3_decode_dirent(struct xdr_stream *, 218 struct nfs_entry *, int); 219 220 /* nfs4xdr.c */ 221 #ifdef CONFIG_NFS_V4 222 extern int nfs4_decode_dirent(struct xdr_stream *, 223 struct nfs_entry *, int); 224 #endif 225 #ifdef CONFIG_NFS_V4_1 226 extern const u32 nfs41_maxread_overhead; 227 extern const u32 nfs41_maxwrite_overhead; 228 #endif 229 230 /* nfs4proc.c */ 231 #ifdef CONFIG_NFS_V4 232 extern struct rpc_procinfo nfs4_procedures[]; 233 #endif 234 235 extern int nfs4_init_ds_session(struct nfs_client *clp); 236 237 /* proc.c */ 238 void nfs_close_context(struct nfs_open_context *ctx, int is_sync); 239 extern int nfs_init_client(struct nfs_client *clp, 240 const struct rpc_timeout *timeparms, 241 const char *ip_addr, rpc_authflavor_t authflavour, 242 int noresvport); 243 244 /* dir.c */ 245 extern int nfs_access_cache_shrinker(struct shrinker *shrink, 246 struct shrink_control *sc); 247 248 /* inode.c */ 249 extern struct workqueue_struct *nfsiod_workqueue; 250 extern struct inode *nfs_alloc_inode(struct super_block *sb); 251 extern void nfs_destroy_inode(struct inode *); 252 extern int nfs_write_inode(struct inode *, struct writeback_control *); 253 extern void nfs_evict_inode(struct inode *); 254 #ifdef CONFIG_NFS_V4 255 extern void nfs4_evict_inode(struct inode *); 256 #endif 257 void nfs_zap_acl_cache(struct inode *inode); 258 extern int nfs_wait_bit_killable(void *word); 259 260 /* super.c */ 261 extern struct file_system_type nfs_xdev_fs_type; 262 #ifdef CONFIG_NFS_V4 263 extern struct file_system_type nfs4_xdev_fs_type; 264 extern struct file_system_type nfs4_referral_fs_type; 265 #endif 266 267 extern struct rpc_stat nfs_rpcstat; 268 269 extern int __init register_nfs_fs(void); 270 extern void __exit unregister_nfs_fs(void); 271 extern void nfs_sb_active(struct super_block *sb); 272 extern void nfs_sb_deactive(struct super_block *sb); 273 274 /* namespace.c */ 275 extern char *nfs_path(char **p, struct dentry *dentry, 276 char *buffer, ssize_t buflen); 277 extern struct vfsmount *nfs_d_automount(struct path *path); 278 struct vfsmount *nfs_submount(struct nfs_server *, struct dentry *, 279 struct nfs_fh *, struct nfs_fattr *); 280 struct vfsmount *nfs_do_submount(struct dentry *, struct nfs_fh *, 281 struct nfs_fattr *, rpc_authflavor_t); 282 283 /* getroot.c */ 284 extern struct dentry *nfs_get_root(struct super_block *, struct nfs_fh *, 285 const char *); 286 #ifdef CONFIG_NFS_V4 287 extern struct dentry *nfs4_get_root(struct super_block *, struct nfs_fh *, 288 const char *); 289 290 extern int nfs4_get_rootfh(struct nfs_server *server, struct nfs_fh *mntfh); 291 #endif 292 293 struct nfs_pgio_completion_ops; 294 /* read.c */ 295 extern struct nfs_read_header *nfs_readhdr_alloc(void); 296 extern void nfs_readhdr_free(struct nfs_pgio_header *hdr); 297 extern void nfs_pageio_init_read(struct nfs_pageio_descriptor *pgio, 298 struct inode *inode, 299 const struct nfs_pgio_completion_ops *compl_ops); 300 extern int nfs_initiate_read(struct rpc_clnt *clnt, 301 struct nfs_read_data *data, 302 const struct rpc_call_ops *call_ops, int flags); 303 extern void nfs_read_prepare(struct rpc_task *task, void *calldata); 304 extern int nfs_generic_pagein(struct nfs_pageio_descriptor *desc, 305 struct nfs_pgio_header *hdr); 306 extern void nfs_pageio_init_read_mds(struct nfs_pageio_descriptor *pgio, 307 struct inode *inode, 308 const struct nfs_pgio_completion_ops *compl_ops); 309 extern void nfs_pageio_reset_read_mds(struct nfs_pageio_descriptor *pgio); 310 extern void nfs_readdata_release(struct nfs_read_data *rdata); 311 312 /* write.c */ 313 extern void nfs_pageio_init_write(struct nfs_pageio_descriptor *pgio, 314 struct inode *inode, int ioflags, 315 const struct nfs_pgio_completion_ops *compl_ops); 316 extern struct nfs_write_header *nfs_writehdr_alloc(void); 317 extern void nfs_writehdr_free(struct nfs_pgio_header *hdr); 318 extern int nfs_generic_flush(struct nfs_pageio_descriptor *desc, 319 struct nfs_pgio_header *hdr); 320 extern void nfs_pageio_init_write_mds(struct nfs_pageio_descriptor *pgio, 321 struct inode *inode, int ioflags, 322 const struct nfs_pgio_completion_ops *compl_ops); 323 extern void nfs_pageio_reset_write_mds(struct nfs_pageio_descriptor *pgio); 324 extern void nfs_writedata_release(struct nfs_write_data *wdata); 325 extern void nfs_commit_free(struct nfs_commit_data *p); 326 extern int nfs_initiate_write(struct rpc_clnt *clnt, 327 struct nfs_write_data *data, 328 const struct rpc_call_ops *call_ops, 329 int how, int flags); 330 extern void nfs_write_prepare(struct rpc_task *task, void *calldata); 331 extern void nfs_commit_prepare(struct rpc_task *task, void *calldata); 332 extern int nfs_initiate_commit(struct rpc_clnt *clnt, 333 struct nfs_commit_data *data, 334 const struct rpc_call_ops *call_ops, 335 int how, int flags); 336 extern void nfs_init_commit(struct nfs_commit_data *data, 337 struct list_head *head, 338 struct pnfs_layout_segment *lseg, 339 struct nfs_commit_info *cinfo); 340 int nfs_scan_commit_list(struct list_head *src, struct list_head *dst, 341 struct nfs_commit_info *cinfo, int max); 342 int nfs_scan_commit(struct inode *inode, struct list_head *dst, 343 struct nfs_commit_info *cinfo); 344 void nfs_mark_request_commit(struct nfs_page *req, 345 struct pnfs_layout_segment *lseg, 346 struct nfs_commit_info *cinfo); 347 int nfs_generic_commit_list(struct inode *inode, struct list_head *head, 348 int how, struct nfs_commit_info *cinfo); 349 void nfs_retry_commit(struct list_head *page_list, 350 struct pnfs_layout_segment *lseg, 351 struct nfs_commit_info *cinfo); 352 void nfs_commitdata_release(struct nfs_commit_data *data); 353 void nfs_request_add_commit_list(struct nfs_page *req, struct list_head *dst, 354 struct nfs_commit_info *cinfo); 355 void nfs_request_remove_commit_list(struct nfs_page *req, 356 struct nfs_commit_info *cinfo); 357 void nfs_init_cinfo(struct nfs_commit_info *cinfo, 358 struct inode *inode, 359 struct nfs_direct_req *dreq); 360 361 #ifdef CONFIG_MIGRATION 362 extern int nfs_migrate_page(struct address_space *, 363 struct page *, struct page *, enum migrate_mode); 364 #else 365 #define nfs_migrate_page NULL 366 #endif 367 368 /* direct.c */ 369 void nfs_init_cinfo_from_dreq(struct nfs_commit_info *cinfo, 370 struct nfs_direct_req *dreq); 371 372 /* nfs4proc.c */ 373 extern void __nfs4_read_done_cb(struct nfs_read_data *); 374 extern void nfs4_reset_read(struct rpc_task *task, struct nfs_read_data *data); 375 extern int nfs4_init_client(struct nfs_client *clp, 376 const struct rpc_timeout *timeparms, 377 const char *ip_addr, 378 rpc_authflavor_t authflavour, 379 int noresvport); 380 extern void nfs4_reset_write(struct rpc_task *task, struct nfs_write_data *data); 381 extern int _nfs4_call_sync(struct rpc_clnt *clnt, 382 struct nfs_server *server, 383 struct rpc_message *msg, 384 struct nfs4_sequence_args *args, 385 struct nfs4_sequence_res *res, 386 int cache_reply); 387 extern int _nfs4_call_sync_session(struct rpc_clnt *clnt, 388 struct nfs_server *server, 389 struct rpc_message *msg, 390 struct nfs4_sequence_args *args, 391 struct nfs4_sequence_res *res, 392 int cache_reply); 393 394 /* 395 * Determine the device name as a string 396 */ 397 static inline char *nfs_devname(struct dentry *dentry, 398 char *buffer, ssize_t buflen) 399 { 400 char *dummy; 401 return nfs_path(&dummy, dentry, buffer, buflen); 402 } 403 404 /* 405 * Determine the actual block size (and log2 thereof) 406 */ 407 static inline 408 unsigned long nfs_block_bits(unsigned long bsize, unsigned char *nrbitsp) 409 { 410 /* make sure blocksize is a power of two */ 411 if ((bsize & (bsize - 1)) || nrbitsp) { 412 unsigned char nrbits; 413 414 for (nrbits = 31; nrbits && !(bsize & (1 << nrbits)); nrbits--) 415 ; 416 bsize = 1 << nrbits; 417 if (nrbitsp) 418 *nrbitsp = nrbits; 419 } 420 421 return bsize; 422 } 423 424 /* 425 * Calculate the number of 512byte blocks used. 426 */ 427 static inline blkcnt_t nfs_calc_block_size(u64 tsize) 428 { 429 blkcnt_t used = (tsize + 511) >> 9; 430 return (used > ULONG_MAX) ? ULONG_MAX : used; 431 } 432 433 /* 434 * Compute and set NFS server blocksize 435 */ 436 static inline 437 unsigned long nfs_block_size(unsigned long bsize, unsigned char *nrbitsp) 438 { 439 if (bsize < NFS_MIN_FILE_IO_SIZE) 440 bsize = NFS_DEF_FILE_IO_SIZE; 441 else if (bsize >= NFS_MAX_FILE_IO_SIZE) 442 bsize = NFS_MAX_FILE_IO_SIZE; 443 444 return nfs_block_bits(bsize, nrbitsp); 445 } 446 447 /* 448 * Determine the maximum file size for a superblock 449 */ 450 static inline 451 void nfs_super_set_maxbytes(struct super_block *sb, __u64 maxfilesize) 452 { 453 sb->s_maxbytes = (loff_t)maxfilesize; 454 if (sb->s_maxbytes > MAX_LFS_FILESIZE || sb->s_maxbytes <= 0) 455 sb->s_maxbytes = MAX_LFS_FILESIZE; 456 } 457 458 /* 459 * Determine the number of bytes of data the page contains 460 */ 461 static inline 462 unsigned int nfs_page_length(struct page *page) 463 { 464 loff_t i_size = i_size_read(page->mapping->host); 465 466 if (i_size > 0) { 467 pgoff_t end_index = (i_size - 1) >> PAGE_CACHE_SHIFT; 468 if (page->index < end_index) 469 return PAGE_CACHE_SIZE; 470 if (page->index == end_index) 471 return ((i_size - 1) & ~PAGE_CACHE_MASK) + 1; 472 } 473 return 0; 474 } 475 476 /* 477 * Convert a umode to a dirent->d_type 478 */ 479 static inline 480 unsigned char nfs_umode_to_dtype(umode_t mode) 481 { 482 return (mode >> 12) & 15; 483 } 484 485 /* 486 * Determine the number of pages in an array of length 'len' and 487 * with a base offset of 'base' 488 */ 489 static inline 490 unsigned int nfs_page_array_len(unsigned int base, size_t len) 491 { 492 return ((unsigned long)len + (unsigned long)base + 493 PAGE_SIZE - 1) >> PAGE_SHIFT; 494 } 495 496 /* 497 * Convert a struct timespec into a 64-bit change attribute 498 * 499 * This does approximately the same thing as timespec_to_ns(), 500 * but for calculation efficiency, we multiply the seconds by 501 * 1024*1024*1024. 502 */ 503 static inline 504 u64 nfs_timespec_to_change_attr(const struct timespec *ts) 505 { 506 return ((u64)ts->tv_sec << 30) + ts->tv_nsec; 507 } 508