internal.h 15.0 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
	bool			need_mount;
107 108

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

	struct {
118 119
		struct sockaddr_storage	address;
		size_t			addrlen;
120 121
		char			*hostname;
		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 132 133 134 135 136 137 138
struct nfs_mount_request {
	struct sockaddr		*sap;
	size_t			salen;
	char			*hostname;
	char			*dirpath;
	u32			version;
	unsigned short		protocol;
	struct nfs_fh		*fh;
139
	int			noresvport;
140 141
	unsigned int		*auth_flav_len;
	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 157
nfs4_find_client_sessionid(struct net *, const struct sockaddr *,
				struct nfs4_sessionid *);
158 159 160
extern struct nfs_server *nfs_create_server(
					const struct nfs_parsed_mount_data *,
					struct nfs_fh *);
161 162 163
extern struct nfs_server *nfs4_create_server(
					const struct nfs_parsed_mount_data *,
					struct nfs_fh *);
164 165 166 167 168
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 *,
169 170
					   struct nfs_fattr *,
					   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);
A
Andy Adamson 已提交
173 174 175
extern struct nfs_client *nfs4_set_ds_client(struct nfs_client* mds_clp,
					     const struct sockaddr *ds_addr,
					     int ds_addrlen, int ds_proto);
176 177 178 179 180 181 182 183 184 185 186 187
#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
188

D
David Howells 已提交
189 190
/* callback_xdr.c */
extern struct svc_version nfs4_callback_version1;
191
extern struct svc_version nfs4_callback_version4;
D
David Howells 已提交
192

193
struct nfs_pageio_descriptor;
D
David Howells 已提交
194 195
/* pagelist.c */
extern int __init nfs_init_nfspagecache(void);
196
extern void nfs_destroy_nfspagecache(void);
D
David Howells 已提交
197
extern int __init nfs_init_readpagecache(void);
198
extern void nfs_destroy_readpagecache(void);
D
David Howells 已提交
199
extern int __init nfs_init_writepagecache(void);
200
extern void nfs_destroy_writepagecache(void);
D
David Howells 已提交
201 202

extern int __init nfs_init_directcache(void);
203
extern void nfs_destroy_directcache(void);
F
Fred Isaman 已提交
204
extern bool nfs_pgarray_set(struct nfs_page_array *p, unsigned int pagecount);
205 206 207 208
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 已提交
209 210

/* nfs2xdr.c */
211
extern int nfs_stat_to_errno(enum nfs_stat);
D
David Howells 已提交
212
extern struct rpc_procinfo nfs_procedures[];
213 214
extern int nfs2_decode_dirent(struct xdr_stream *,
				struct nfs_entry *, int);
D
David Howells 已提交
215 216 217

/* nfs3xdr.c */
extern struct rpc_procinfo nfs3_procedures[];
218 219
extern int nfs3_decode_dirent(struct xdr_stream *,
				struct nfs_entry *, int);
D
David Howells 已提交
220 221

/* nfs4xdr.c */
222
#ifdef CONFIG_NFS_V4
223 224
extern int nfs4_decode_dirent(struct xdr_stream *,
				struct nfs_entry *, int);
225
#endif
226 227 228 229
#ifdef CONFIG_NFS_V4_1
extern const u32 nfs41_maxread_overhead;
extern const u32 nfs41_maxwrite_overhead;
#endif
D
David Howells 已提交
230 231

/* nfs4proc.c */
A
Andrew Morton 已提交
232
#ifdef CONFIG_NFS_V4
D
David Howells 已提交
233
extern struct rpc_procinfo nfs4_procedures[];
A
Andrew Morton 已提交
234
#endif
D
David Howells 已提交
235

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

T
Trond Myklebust 已提交
238 239
/* proc.c */
void nfs_close_context(struct nfs_open_context *ctx, int is_sync);
240 241 242 243
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 已提交
244

245
/* dir.c */
246
extern int nfs_access_cache_shrinker(struct shrinker *shrink,
247
					struct shrink_control *sc);
248

D
David Howells 已提交
249
/* inode.c */
T
Trond Myklebust 已提交
250
extern struct workqueue_struct *nfsiod_workqueue;
D
David Howells 已提交
251 252
extern struct inode *nfs_alloc_inode(struct super_block *sb);
extern void nfs_destroy_inode(struct inode *);
253
extern int nfs_write_inode(struct inode *, struct writeback_control *);
254
extern void nfs_evict_inode(struct inode *);
D
David Howells 已提交
255
#ifdef CONFIG_NFS_V4
256
extern void nfs4_evict_inode(struct inode *);
D
David Howells 已提交
257
#endif
258
void nfs_zap_acl_cache(struct inode *inode);
259
extern int nfs_wait_bit_killable(void *word);
D
David Howells 已提交
260 261

/* super.c */
262
extern struct file_system_type nfs_xdev_fs_type;
D
David Howells 已提交
263
#ifdef CONFIG_NFS_V4
264 265
extern struct file_system_type nfs4_xdev_fs_type;
extern struct file_system_type nfs4_referral_fs_type;
D
David Howells 已提交
266
#endif
267

D
David Howells 已提交
268
extern struct rpc_stat nfs_rpcstat;
269

D
David Howells 已提交
270 271
extern int __init register_nfs_fs(void);
extern void __exit unregister_nfs_fs(void);
272 273
extern void nfs_sb_active(struct super_block *sb);
extern void nfs_sb_deactive(struct super_block *sb);
D
David Howells 已提交
274 275

/* namespace.c */
276
extern char *nfs_path(char **p, struct dentry *dentry,
D
David Howells 已提交
277
		      char *buffer, ssize_t buflen);
278
extern struct vfsmount *nfs_d_automount(struct path *path);
B
Bryan Schumaker 已提交
279 280 281 282
struct vfsmount *nfs_submount(struct nfs_server *, struct dentry *,
			      struct nfs_fh *, struct nfs_fattr *);
struct vfsmount *nfs_do_submount(struct dentry *, struct nfs_fh *,
				 struct nfs_fattr *, rpc_authflavor_t);
D
David Howells 已提交
283

284
/* getroot.c */
285 286
extern struct dentry *nfs_get_root(struct super_block *, struct nfs_fh *,
				   const char *);
287
#ifdef CONFIG_NFS_V4
288 289
extern struct dentry *nfs4_get_root(struct super_block *, struct nfs_fh *,
				    const char *);
290

291
extern int nfs4_get_rootfh(struct nfs_server *server, struct nfs_fh *mntfh);
292
#endif
D
David Howells 已提交
293

294
struct nfs_pgio_completion_ops;
295
/* read.c */
296
extern struct nfs_read_header *nfs_readhdr_alloc(void);
297
extern void nfs_readhdr_free(struct nfs_pgio_header *hdr);
298 299 300
extern void nfs_pageio_init_read(struct nfs_pageio_descriptor *pgio,
			struct inode *inode,
			const struct nfs_pgio_completion_ops *compl_ops);
301 302
extern int nfs_initiate_read(struct rpc_clnt *clnt,
			     struct nfs_read_data *data,
A
Andy Adamson 已提交
303
			     const struct rpc_call_ops *call_ops);
304
extern void nfs_read_prepare(struct rpc_task *task, void *calldata);
305
extern int nfs_generic_pagein(struct nfs_pageio_descriptor *desc,
306
			      struct nfs_pgio_header *hdr);
307
extern void nfs_pageio_init_read_mds(struct nfs_pageio_descriptor *pgio,
308 309
			struct inode *inode,
			const struct nfs_pgio_completion_ops *compl_ops);
310 311
extern void nfs_pageio_reset_read_mds(struct nfs_pageio_descriptor *pgio);
extern void nfs_readdata_release(struct nfs_read_data *rdata);
312

313
/* write.c */
314 315 316
extern void nfs_pageio_init_write(struct nfs_pageio_descriptor *pgio,
			struct inode *inode, int ioflags,
			const struct nfs_pgio_completion_ops *compl_ops);
317
extern struct nfs_write_header *nfs_writehdr_alloc(void);
318
extern void nfs_writehdr_free(struct nfs_pgio_header *hdr);
319
extern int nfs_generic_flush(struct nfs_pageio_descriptor *desc,
320
			     struct nfs_pgio_header *hdr);
321
extern void nfs_pageio_init_write_mds(struct nfs_pageio_descriptor *pgio,
322 323
			struct inode *inode, int ioflags,
			const struct nfs_pgio_completion_ops *compl_ops);
324 325
extern void nfs_pageio_reset_write_mds(struct nfs_pageio_descriptor *pgio);
extern void nfs_writedata_release(struct nfs_write_data *wdata);
326
extern void nfs_commit_free(struct nfs_commit_data *p);
327 328
extern int nfs_initiate_write(struct rpc_clnt *clnt,
			      struct nfs_write_data *data,
329 330
			      const struct rpc_call_ops *call_ops,
			      int how);
331
extern void nfs_write_prepare(struct rpc_task *task, void *calldata);
332 333 334
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,
335 336
			       const struct rpc_call_ops *call_ops,
			       int how);
337
extern void nfs_init_commit(struct nfs_commit_data *data,
338
			    struct list_head *head,
339 340
			    struct pnfs_layout_segment *lseg,
			    struct nfs_commit_info *cinfo);
341 342 343 344 345 346 347 348 349
int nfs_scan_commit_list(struct list_head *src, struct list_head *dst,
			 struct nfs_commit_info *cinfo, int max);
int nfs_scan_commit(struct inode *inode, struct list_head *dst,
		    struct nfs_commit_info *cinfo);
void nfs_mark_request_commit(struct nfs_page *req,
			     struct pnfs_layout_segment *lseg,
			     struct nfs_commit_info *cinfo);
int nfs_generic_commit_list(struct inode *inode, struct list_head *head,
			    int how, struct nfs_commit_info *cinfo);
350
void nfs_retry_commit(struct list_head *page_list,
F
Fred Isaman 已提交
351 352
		      struct pnfs_layout_segment *lseg,
		      struct nfs_commit_info *cinfo);
353
void nfs_commitdata_release(struct nfs_commit_data *data);
F
Fred Isaman 已提交
354 355 356 357 358 359 360
void nfs_request_add_commit_list(struct nfs_page *req, struct list_head *dst,
				 struct nfs_commit_info *cinfo);
void nfs_request_remove_commit_list(struct nfs_page *req,
				    struct nfs_commit_info *cinfo);
void nfs_init_cinfo(struct nfs_commit_info *cinfo,
		    struct inode *inode,
		    struct nfs_direct_req *dreq);
361

362 363
#ifdef CONFIG_MIGRATION
extern int nfs_migrate_page(struct address_space *,
364
		struct page *, struct page *, enum migrate_mode);
365 366 367
#else
#define nfs_migrate_page NULL
#endif
368

369 370 371 372
/* direct.c */
void nfs_init_cinfo_from_dreq(struct nfs_commit_info *cinfo,
			      struct nfs_direct_req *dreq);

A
Andy Adamson 已提交
373
/* nfs4proc.c */
374
extern void __nfs4_read_done_cb(struct nfs_read_data *);
375
extern void nfs4_reset_read(struct rpc_task *task, struct nfs_read_data *data);
376 377 378 379 380
extern int nfs4_init_client(struct nfs_client *clp,
			    const struct rpc_timeout *timeparms,
			    const char *ip_addr,
			    rpc_authflavor_t authflavour,
			    int noresvport);
381
extern void nfs4_reset_write(struct rpc_task *task, struct nfs_write_data *data);
382 383
extern int _nfs4_call_sync(struct rpc_clnt *clnt,
			   struct nfs_server *server,
A
Andy Adamson 已提交
384 385 386 387
			   struct rpc_message *msg,
			   struct nfs4_sequence_args *args,
			   struct nfs4_sequence_res *res,
			   int cache_reply);
388 389
extern int _nfs4_call_sync_session(struct rpc_clnt *clnt,
				   struct nfs_server *server,
A
Andy Adamson 已提交
390 391 392 393 394
				   struct rpc_message *msg,
				   struct nfs4_sequence_args *args,
				   struct nfs4_sequence_res *res,
				   int cache_reply);

D
David Howells 已提交
395 396 397
/*
 * Determine the device name as a string
 */
398
static inline char *nfs_devname(struct dentry *dentry,
399
				char *buffer, ssize_t buflen)
D
David Howells 已提交
400
{
401 402
	char *dummy;
	return nfs_path(&dummy, dentry, buffer, buflen);
D
David Howells 已提交
403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427
}

/*
 * 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.
 */
428
static inline blkcnt_t nfs_calc_block_size(u64 tsize)
D
David Howells 已提交
429
{
430
	blkcnt_t used = (tsize + 511) >> 9;
D
David Howells 已提交
431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457
	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;
}
458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475

/*
 * 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;
}
476

477 478 479 480 481 482 483 484 485
/*
 * Convert a umode to a dirent->d_type
 */
static inline
unsigned char nfs_umode_to_dtype(umode_t mode)
{
	return (mode >> 12) & 15;
}

486 487 488 489 490 491 492 493 494 495
/*
 * 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;
}
496

497 498 499 500 501 502 503 504 505 506 507 508
/*
 * Convert a struct timespec into a 64-bit change attribute
 *
 * This does approximately the same thing as timespec_to_ns(),
 * but for calculation efficiency, we multiply the seconds by
 * 1024*1024*1024.
 */
static inline
u64 nfs_timespec_to_change_attr(const struct timespec *ts)
{
	return ((u64)ts->tv_sec << 30) + ts->tv_nsec;
}