internal.h 13.9 KB
Newer Older
D
David Howells 已提交
1 2 3 4
/*
 * NFS internal definitions
 */

5
#include "nfs4_fs.h"
D
David Howells 已提交
6
#include <linux/mount.h>
7
#include <linux/security.h>
D
David Howells 已提交
8

9 10
#define NFS_MS_MASK (MS_RDONLY|MS_NOSUID|MS_NODEV|MS_NOEXEC|MS_SYNCHRONOUS)

11 12 13 14 15 16 17 18 19 20
struct nfs_string;

/* Maximum number of readahead requests
 * FIXME: this should really be a sysctl so that users may tune it to suit
 *        their needs. People that do NFS over a slow network, might for
 *        instance want to reduce it to something closer to 1 for improved
 *        interactive response.
 */
#define NFS_MAX_READAHEAD	(RPC_DEF_SLOT_TABLE - 1)

21 22 23 24 25 26 27 28 29 30 31 32
/*
 * Determine if sessions are in use.
 */
static inline int nfs4_has_session(const struct nfs_client *clp)
{
#ifdef CONFIG_NFS_V4_1
	if (clp->cl_session)
		return 1;
#endif /* CONFIG_NFS_V4_1 */
	return 0;
}

33 34 35 36 37 38 39 40 41
static inline int nfs4_has_persistent_session(const struct nfs_client *clp)
{
#ifdef CONFIG_NFS_V4_1
	if (nfs4_has_session(clp))
		return (clp->cl_session->flags & SESSION4_PERSIST);
#endif /* CONFIG_NFS_V4_1 */
	return 0;
}

42 43 44 45 46 47
static inline void nfs_attr_check_mountpoint(struct super_block *parent, struct nfs_fattr *fattr)
{
	if (!nfs_fsid_equal(&NFS_SB(parent)->fsid, &fattr->fsid))
		fattr->valid |= NFS_ATTR_FATTR_MOUNTPOINT;
}

48 49 50 51 52 53 54 55 56 57 58
static inline int nfs_attr_use_mounted_on_fileid(struct nfs_fattr *fattr)
{
	if (((fattr->valid & NFS_ATTR_FATTR_MOUNTED_ON_FILEID) == 0) ||
	    (((fattr->valid & NFS_ATTR_FATTR_MOUNTPOINT) == 0) &&
	     ((fattr->valid & NFS_ATTR_FATTR_V4_REFERRAL) == 0)))
		return 0;

	fattr->fileid = fattr->mounted_on_fileid;
	return 1;
}

D
David Howells 已提交
59 60 61 62 63 64 65
struct nfs_clone_mount {
	const struct super_block *sb;
	const struct dentry *dentry;
	struct nfs_fh *fh;
	struct nfs_fattr *fattr;
	char *hostname;
	char *mnt_path;
66 67
	struct sockaddr *addr;
	size_t addrlen;
D
David Howells 已提交
68 69 70
	rpc_authflavor_t authflavor;
};

71 72 73 74 75 76
/*
 * Note: RFC 1813 doesn't limit the number of auth flavors that
 * a server can return, so make something up.
 */
#define NFS_MAX_SECFLAVORS	(12)

77 78 79 80 81
/*
 * Value used if the user did not specify a port value.
 */
#define NFS_UNSPEC_PORT		(-1)

B
Bryan Schumaker 已提交
82 83 84 85 86 87
/*
 * Maximum number of pages that readdir can use for creating
 * a vmapped array of pages.
 */
#define NFS_MAX_READDIR_PAGES 8

88 89 90 91 92 93 94 95 96 97
/*
 * In-kernel mount arguments
 */
struct nfs_parsed_mount_data {
	int			flags;
	int			rsize, wsize;
	int			timeo, retrans;
	int			acregmin, acregmax,
				acdirmin, acdirmax;
	int			namlen;
98
	unsigned int		options;
99 100 101 102
	unsigned int		bsize;
	unsigned int		auth_flavor_len;
	rpc_authflavor_t	auth_flavors[1];
	char			*client_address;
103
	unsigned int		version;
104
	unsigned int		minorversion;
105
	char			*fscache_uniq;
106 107

	struct {
108 109
		struct sockaddr_storage	address;
		size_t			addrlen;
110
		char			*hostname;
111
		u32			version;
112
		int			port;
113
		unsigned short		protocol;
114 115 116
	} mount_server;

	struct {
117 118
		struct sockaddr_storage	address;
		size_t			addrlen;
119 120
		char			*hostname;
		char			*export_path;
121
		int			port;
122
		unsigned short		protocol;
123
	} nfs_server;
124 125

	struct security_mnt_opts lsm_opts;
126
	struct net		*net;
127 128
};

129
/* mount_clnt.c */
130 131 132 133 134 135 136 137
struct nfs_mount_request {
	struct sockaddr		*sap;
	size_t			salen;
	char			*hostname;
	char			*dirpath;
	u32			version;
	unsigned short		protocol;
	struct nfs_fh		*fh;
138
	int			noresvport;
139 140
	unsigned int		*auth_flav_len;
	rpc_authflavor_t	*auth_flavs;
141
	struct net		*net;
142 143 144
};

extern int nfs_mount(struct nfs_mount_request *info);
145
extern void nfs_umount(const struct nfs_mount_request *info);
146

147
/* client.c */
148
extern const struct rpc_program nfs_program;
149
extern void nfs_clients_init(struct net *net);
150

151
extern void nfs_cleanup_cb_ident_idr(struct net *);
152
extern void nfs_put_client(struct nfs_client *);
153
extern struct nfs_client *nfs4_find_client_ident(struct net *, int);
154
extern struct nfs_client *
155 156
nfs4_find_client_sessionid(struct net *, const struct sockaddr *,
				struct nfs4_sessionid *);
157 158 159
extern struct nfs_server *nfs_create_server(
					const struct nfs_parsed_mount_data *,
					struct nfs_fh *);
160 161 162
extern struct nfs_server *nfs4_create_server(
					const struct nfs_parsed_mount_data *,
					struct nfs_fh *);
163 164 165 166 167
extern struct nfs_server *nfs4_create_referral_server(struct nfs_clone_mount *,
						      struct nfs_fh *);
extern void nfs_free_server(struct nfs_server *server);
extern struct nfs_server *nfs_clone_server(struct nfs_server *,
					   struct nfs_fh *,
168 169
					   struct nfs_fattr *,
					   rpc_authflavor_t);
170
extern void nfs_mark_client_ready(struct nfs_client *clp, int state);
171
extern int nfs4_check_client_ready(struct nfs_client *clp);
A
Andy Adamson 已提交
172 173 174
extern struct nfs_client *nfs4_set_ds_client(struct nfs_client* mds_clp,
					     const struct sockaddr *ds_addr,
					     int ds_addrlen, int ds_proto);
175 176 177 178 179 180 181 182 183 184 185 186
#ifdef CONFIG_PROC_FS
extern int __init nfs_fs_proc_init(void);
extern void nfs_fs_proc_exit(void);
#else
static inline int nfs_fs_proc_init(void)
{
	return 0;
}
static inline void nfs_fs_proc_exit(void)
{
}
#endif
187

188
/* nfs4namespace.c */
D
David Howells 已提交
189
#ifdef CONFIG_NFS_V4
190
extern struct vfsmount *nfs_do_refmount(struct rpc_clnt *client, struct dentry *dentry);
D
David Howells 已提交
191 192
#else
static inline
193
struct vfsmount *nfs_do_refmount(struct rpc_clnt *client, struct dentry *dentry)
D
David Howells 已提交
194 195 196 197 198 199 200
{
	return ERR_PTR(-ENOENT);
}
#endif

/* callback_xdr.c */
extern struct svc_version nfs4_callback_version1;
201
extern struct svc_version nfs4_callback_version4;
D
David Howells 已提交
202

203
struct nfs_pageio_descriptor;
D
David Howells 已提交
204 205
/* pagelist.c */
extern int __init nfs_init_nfspagecache(void);
206
extern void nfs_destroy_nfspagecache(void);
D
David Howells 已提交
207
extern int __init nfs_init_readpagecache(void);
208
extern void nfs_destroy_readpagecache(void);
D
David Howells 已提交
209
extern int __init nfs_init_writepagecache(void);
210
extern void nfs_destroy_writepagecache(void);
D
David Howells 已提交
211 212

extern int __init nfs_init_directcache(void);
213
extern void nfs_destroy_directcache(void);
F
Fred Isaman 已提交
214
extern bool nfs_pgarray_set(struct nfs_page_array *p, unsigned int pagecount);
215 216 217 218
extern void nfs_pgheader_init(struct nfs_pageio_descriptor *desc,
			      struct nfs_pgio_header *hdr,
			      void (*release)(struct nfs_pgio_header *hdr));
void nfs_set_pgio_error(struct nfs_pgio_header *hdr, int error, loff_t pos);
D
David Howells 已提交
219 220

/* nfs2xdr.c */
221
extern int nfs_stat_to_errno(enum nfs_stat);
D
David Howells 已提交
222
extern struct rpc_procinfo nfs_procedures[];
223 224
extern int nfs2_decode_dirent(struct xdr_stream *,
				struct nfs_entry *, int);
D
David Howells 已提交
225 226 227

/* nfs3xdr.c */
extern struct rpc_procinfo nfs3_procedures[];
228 229
extern int nfs3_decode_dirent(struct xdr_stream *,
				struct nfs_entry *, int);
D
David Howells 已提交
230 231

/* nfs4xdr.c */
232
#ifdef CONFIG_NFS_V4
233 234
extern int nfs4_decode_dirent(struct xdr_stream *,
				struct nfs_entry *, int);
235
#endif
236 237 238 239
#ifdef CONFIG_NFS_V4_1
extern const u32 nfs41_maxread_overhead;
extern const u32 nfs41_maxwrite_overhead;
#endif
D
David Howells 已提交
240 241

/* nfs4proc.c */
A
Andrew Morton 已提交
242
#ifdef CONFIG_NFS_V4
D
David Howells 已提交
243
extern struct rpc_procinfo nfs4_procedures[];
A
Andrew Morton 已提交
244
#endif
D
David Howells 已提交
245

A
Andy Adamson 已提交
246 247
extern int nfs4_init_ds_session(struct nfs_client *clp);

T
Trond Myklebust 已提交
248 249
/* proc.c */
void nfs_close_context(struct nfs_open_context *ctx, int is_sync);
250 251 252 253
extern int nfs_init_client(struct nfs_client *clp,
			   const struct rpc_timeout *timeparms,
			   const char *ip_addr, rpc_authflavor_t authflavour,
			   int noresvport);
T
Trond Myklebust 已提交
254

255
/* dir.c */
256
extern int nfs_access_cache_shrinker(struct shrinker *shrink,
257
					struct shrink_control *sc);
258

D
David Howells 已提交
259
/* inode.c */
T
Trond Myklebust 已提交
260
extern struct workqueue_struct *nfsiod_workqueue;
D
David Howells 已提交
261 262
extern struct inode *nfs_alloc_inode(struct super_block *sb);
extern void nfs_destroy_inode(struct inode *);
263
extern int nfs_write_inode(struct inode *, struct writeback_control *);
264
extern void nfs_evict_inode(struct inode *);
D
David Howells 已提交
265
#ifdef CONFIG_NFS_V4
266
extern void nfs4_evict_inode(struct inode *);
D
David Howells 已提交
267
#endif
268
void nfs_zap_acl_cache(struct inode *inode);
269
extern int nfs_wait_bit_killable(void *word);
D
David Howells 已提交
270 271

/* super.c */
272
extern struct file_system_type nfs_xdev_fs_type;
D
David Howells 已提交
273
#ifdef CONFIG_NFS_V4
274 275
extern struct file_system_type nfs4_xdev_fs_type;
extern struct file_system_type nfs4_referral_fs_type;
D
David Howells 已提交
276
#endif
277

D
David Howells 已提交
278
extern struct rpc_stat nfs_rpcstat;
279

D
David Howells 已提交
280 281
extern int __init register_nfs_fs(void);
extern void __exit unregister_nfs_fs(void);
282 283
extern void nfs_sb_active(struct super_block *sb);
extern void nfs_sb_deactive(struct super_block *sb);
D
David Howells 已提交
284 285

/* namespace.c */
286
extern char *nfs_path(char **p, struct dentry *dentry,
D
David Howells 已提交
287
		      char *buffer, ssize_t buflen);
288
extern struct vfsmount *nfs_d_automount(struct path *path);
289 290 291
#ifdef CONFIG_NFS_V4
rpc_authflavor_t nfs_find_best_sec(struct nfs4_secinfo_flavors *);
#endif
D
David Howells 已提交
292

293
/* getroot.c */
294 295
extern struct dentry *nfs_get_root(struct super_block *, struct nfs_fh *,
				   const char *);
296
#ifdef CONFIG_NFS_V4
297 298
extern struct dentry *nfs4_get_root(struct super_block *, struct nfs_fh *,
				    const char *);
299

300
extern int nfs4_get_rootfh(struct nfs_server *server, struct nfs_fh *mntfh);
301
#endif
D
David Howells 已提交
302

303
/* read.c */
304 305
extern void nfs_async_read_error(struct list_head *head);
extern struct nfs_read_header *nfs_readhdr_alloc(void);
306
extern void nfs_readhdr_free(struct nfs_pgio_header *hdr);
307 308 309
extern void nfs_read_completion(struct nfs_pgio_header *hdr);
extern struct nfs_read_data *nfs_readdata_alloc(struct nfs_pgio_header *hdr,
						unsigned int pagecount);
310 311
extern int nfs_initiate_read(struct rpc_clnt *clnt,
			     struct nfs_read_data *data,
A
Andy Adamson 已提交
312
			     const struct rpc_call_ops *call_ops);
313
extern void nfs_read_prepare(struct rpc_task *task, void *calldata);
314
extern int nfs_generic_pagein(struct nfs_pageio_descriptor *desc,
315
			      struct nfs_pgio_header *hdr);
316 317
extern void nfs_pageio_init_read_mds(struct nfs_pageio_descriptor *pgio,
		struct inode *inode);
318 319
extern void nfs_pageio_reset_read_mds(struct nfs_pageio_descriptor *pgio);
extern void nfs_readdata_release(struct nfs_read_data *rdata);
320

321
/* write.c */
322 323
extern struct nfs_write_header *nfs_writehdr_alloc(unsigned int npages);
extern void nfs_writehdr_free(struct nfs_pgio_header *hdr);
324 325
extern int nfs_generic_flush(struct nfs_pageio_descriptor *desc,
		struct list_head *head);
326 327
extern void nfs_pageio_init_write_mds(struct nfs_pageio_descriptor *pgio,
				  struct inode *inode, int ioflags);
328 329
extern void nfs_pageio_reset_write_mds(struct nfs_pageio_descriptor *pgio);
extern void nfs_writedata_release(struct nfs_write_data *wdata);
330
extern void nfs_commit_free(struct nfs_commit_data *p);
331 332
extern int nfs_initiate_write(struct rpc_clnt *clnt,
			      struct nfs_write_data *data,
333 334
			      const struct rpc_call_ops *call_ops,
			      int how);
335
extern void nfs_write_prepare(struct rpc_task *task, void *calldata);
336 337 338
extern void nfs_commit_prepare(struct rpc_task *task, void *calldata);
extern int nfs_initiate_commit(struct rpc_clnt *clnt,
			       struct nfs_commit_data *data,
339 340
			       const struct rpc_call_ops *call_ops,
			       int how);
341
extern void nfs_init_commit(struct nfs_commit_data *data,
342 343 344 345 346
			    struct list_head *head,
			    struct pnfs_layout_segment *lseg);
void nfs_retry_commit(struct list_head *page_list,
		      struct pnfs_layout_segment *lseg);
void nfs_commit_clear_lock(struct nfs_inode *nfsi);
347 348
void nfs_commitdata_release(struct nfs_commit_data *data);
void nfs_commit_release_pages(struct nfs_commit_data *data);
349 350
void nfs_request_add_commit_list(struct nfs_page *req, struct list_head *head);
void nfs_request_remove_commit_list(struct nfs_page *req);
351

352 353
#ifdef CONFIG_MIGRATION
extern int nfs_migrate_page(struct address_space *,
354
		struct page *, struct page *, enum migrate_mode);
355 356 357
#else
#define nfs_migrate_page NULL
#endif
358

A
Andy Adamson 已提交
359
/* nfs4proc.c */
360
extern void __nfs4_read_done_cb(struct nfs_read_data *);
361
extern void nfs4_reset_read(struct rpc_task *task, struct nfs_read_data *data);
362 363 364 365 366
extern int nfs4_init_client(struct nfs_client *clp,
			    const struct rpc_timeout *timeparms,
			    const char *ip_addr,
			    rpc_authflavor_t authflavour,
			    int noresvport);
367
extern void nfs4_reset_write(struct rpc_task *task, struct nfs_write_data *data);
368 369
extern int _nfs4_call_sync(struct rpc_clnt *clnt,
			   struct nfs_server *server,
A
Andy Adamson 已提交
370 371 372 373
			   struct rpc_message *msg,
			   struct nfs4_sequence_args *args,
			   struct nfs4_sequence_res *res,
			   int cache_reply);
374 375
extern int _nfs4_call_sync_session(struct rpc_clnt *clnt,
				   struct nfs_server *server,
A
Andy Adamson 已提交
376 377 378 379 380
				   struct rpc_message *msg,
				   struct nfs4_sequence_args *args,
				   struct nfs4_sequence_res *res,
				   int cache_reply);

D
David Howells 已提交
381 382 383
/*
 * Determine the device name as a string
 */
384
static inline char *nfs_devname(struct dentry *dentry,
385
				char *buffer, ssize_t buflen)
D
David Howells 已提交
386
{
387 388
	char *dummy;
	return nfs_path(&dummy, dentry, buffer, buflen);
D
David Howells 已提交
389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413
}

/*
 * Determine the actual block size (and log2 thereof)
 */
static inline
unsigned long nfs_block_bits(unsigned long bsize, unsigned char *nrbitsp)
{
	/* make sure blocksize is a power of two */
	if ((bsize & (bsize - 1)) || nrbitsp) {
		unsigned char	nrbits;

		for (nrbits = 31; nrbits && !(bsize & (1 << nrbits)); nrbits--)
			;
		bsize = 1 << nrbits;
		if (nrbitsp)
			*nrbitsp = nrbits;
	}

	return bsize;
}

/*
 * Calculate the number of 512byte blocks used.
 */
414
static inline blkcnt_t nfs_calc_block_size(u64 tsize)
D
David Howells 已提交
415
{
416
	blkcnt_t used = (tsize + 511) >> 9;
D
David Howells 已提交
417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443
	return (used > ULONG_MAX) ? ULONG_MAX : used;
}

/*
 * Compute and set NFS server blocksize
 */
static inline
unsigned long nfs_block_size(unsigned long bsize, unsigned char *nrbitsp)
{
	if (bsize < NFS_MIN_FILE_IO_SIZE)
		bsize = NFS_DEF_FILE_IO_SIZE;
	else if (bsize >= NFS_MAX_FILE_IO_SIZE)
		bsize = NFS_MAX_FILE_IO_SIZE;

	return nfs_block_bits(bsize, nrbitsp);
}

/*
 * Determine the maximum file size for a superblock
 */
static inline
void nfs_super_set_maxbytes(struct super_block *sb, __u64 maxfilesize)
{
	sb->s_maxbytes = (loff_t)maxfilesize;
	if (sb->s_maxbytes > MAX_LFS_FILESIZE || sb->s_maxbytes <= 0)
		sb->s_maxbytes = MAX_LFS_FILESIZE;
}
444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461

/*
 * Determine the number of bytes of data the page contains
 */
static inline
unsigned int nfs_page_length(struct page *page)
{
	loff_t i_size = i_size_read(page->mapping->host);

	if (i_size > 0) {
		pgoff_t end_index = (i_size - 1) >> PAGE_CACHE_SHIFT;
		if (page->index < end_index)
			return PAGE_CACHE_SIZE;
		if (page->index == end_index)
			return ((i_size - 1) & ~PAGE_CACHE_MASK) + 1;
	}
	return 0;
}
462

463 464 465 466 467 468 469 470 471
/*
 * Convert a umode to a dirent->d_type
 */
static inline
unsigned char nfs_umode_to_dtype(umode_t mode)
{
	return (mode >> 12) & 15;
}

472 473 474 475 476 477 478 479 480 481
/*
 * Determine the number of pages in an array of length 'len' and
 * with a base offset of 'base'
 */
static inline
unsigned int nfs_page_array_len(unsigned int base, size_t len)
{
	return ((unsigned long)len + (unsigned long)base +
		PAGE_SIZE - 1) >> PAGE_SHIFT;
}
482