[deliverable/linux.git] / include / linux / nfsd / export.h

/*
 * include/linux/nfsd/export.h
 * 
 * Public declarations for NFS exports. The definitions for the
 * syscall interface are in nfsctl.h
 *
 * Copyright (C) 1995-1997 Olaf Kirch <okir@monad.swb.de>
 */

#ifndef NFSD_EXPORT_H
#define NFSD_EXPORT_H

# include <linux/types.h>
#ifdef __KERNEL__
# include <linux/nfsd/nfsfh.h>
#endif

/*
 * Important limits for the exports stuff.
 */
#define NFSCLNT_IDMAX		1024
#define NFSCLNT_ADDRMAX		16
#define NFSCLNT_KEYMAX		32

/*
 * Export flags.
 */
#define NFSEXP_READONLY		0x0001
#define NFSEXP_INSECURE_PORT	0x0002
#define NFSEXP_ROOTSQUASH	0x0004
#define NFSEXP_ALLSQUASH	0x0008
#define NFSEXP_ASYNC		0x0010
#define NFSEXP_GATHERED_WRITES	0x0020
/* 40 80 100 currently unused */
#define NFSEXP_NOHIDE		0x0200
#define NFSEXP_NOSUBTREECHECK	0x0400
#define	NFSEXP_NOAUTHNLM	0x0800		/* Don't authenticate NLM requests - just trust */
#define NFSEXP_MSNFS		0x1000	/* do silly things that MS clients expect */
#define NFSEXP_FSID		0x2000
#define	NFSEXP_CROSSMOUNT	0x4000
#define	NFSEXP_NOACL		0x8000	/* reserved for possible ACL related use */
/* All flags that we claim to support.  (Note we don't support NOACL.) */
#define NFSEXP_ALLFLAGS		0x7E3F

/* The flags that may vary depending on security flavor: */
#define NFSEXP_SECINFO_FLAGS	(NFSEXP_READONLY | NFSEXP_ROOTSQUASH \
					| NFSEXP_ALLSQUASH \
					| NFSEXP_INSECURE_PORT)

#ifdef __KERNEL__

/*
 * FS Locations
 */

#define MAX_FS_LOCATIONS	128

struct nfsd4_fs_location {
	char *hosts; /* colon separated list of hosts */
	char *path;  /* slash separated list of path components */
};

struct nfsd4_fs_locations {
	uint32_t locations_count;
	struct nfsd4_fs_location *locations;
/* If we're not actually serving this data ourselves (only providing a
 * list of replicas that do serve it) then we set "migrated": */
	int migrated;
};

/*
 * We keep an array of pseudoflavors with the export, in order from most
 * to least preferred.  For the forseeable future, we don't expect more
 * than the eight pseudoflavors null, unix, krb5, krb5i, krb5p, skpm3,
 * spkm3i, and spkm3p (and using all 8 at once should be rare).
 */
#define MAX_SECINFO_LIST	8

struct exp_flavor_info {
	u32	pseudoflavor;
	u32	flags;
};

struct svc_export {
	struct cache_head	h;
	struct auth_domain *	ex_client;
	int			ex_flags;
	struct path		ex_path;
	char			*ex_pathname;
	uid_t			ex_anon_uid;
	gid_t			ex_anon_gid;
	int			ex_fsid;
	unsigned char *		ex_uuid; /* 16 byte fsid */
	struct nfsd4_fs_locations ex_fslocs;
	int			ex_nflavors;
	struct exp_flavor_info	ex_flavors[MAX_SECINFO_LIST];
};

/* an "export key" (expkey) maps a filehandlefragement to an
 * svc_export for a given client.  There can be several per export,
 * for the different fsid types.
 */
struct svc_expkey {
	struct cache_head	h;

	struct auth_domain *	ek_client;
	int			ek_fsidtype;
	u32			ek_fsid[6];

	struct path		ek_path;
};

#define EX_ISSYNC(exp)		(!((exp)->ex_flags & NFSEXP_ASYNC))
#define EX_NOHIDE(exp)		((exp)->ex_flags & NFSEXP_NOHIDE)
#define EX_WGATHER(exp)		((exp)->ex_flags & NFSEXP_GATHERED_WRITES)

int nfsexp_flags(struct svc_rqst *rqstp, struct svc_export *exp);
__be32 check_nfsd_access(struct svc_export *exp, struct svc_rqst *rqstp);

/*
 * Function declarations
 */
int			nfsd_export_init(void);
void			nfsd_export_shutdown(void);
void			nfsd_export_flush(void);
void			exp_readlock(void);
void			exp_readunlock(void);
struct svc_export *	rqst_exp_get_by_name(struct svc_rqst *,
					     struct path *);
struct svc_export *	rqst_exp_parent(struct svc_rqst *,
					struct path *);
int			exp_rootfh(struct auth_domain *, 
					char *path, struct knfsd_fh *, int maxsize);
__be32			exp_pseudoroot(struct svc_rqst *, struct svc_fh *);
__be32			nfserrno(int errno);

extern struct cache_detail svc_export_cache;

static inline void exp_put(struct svc_export *exp)
{
	cache_put(&exp->h, &svc_export_cache);
}

static inline void exp_get(struct svc_export *exp)
{
	cache_get(&exp->h);
}
struct svc_export * rqst_exp_find(struct svc_rqst *, int, u32 *);

#endif /* __KERNEL__ */

#endif /* NFSD_EXPORT_H */
Commit	Line	Data
1da177e4 LT	1	/*
	2	* include/linux/nfsd/export.h
	3	*
	4	* Public declarations for NFS exports. The definitions for the
	5	* syscall interface are in nfsctl.h
	6	*
	7	* Copyright (C) 1995-1997 Olaf Kirch <okir@monad.swb.de>
	8	*/
	9
	10	#ifndef NFSD_EXPORT_H
	11	#define NFSD_EXPORT_H
	12
1da177e4	13	# include <linux/types.h>
3187cedf	14	#ifdef __KERNEL__
72579ac9	15	# include <linux/nfsd/nfsfh.h>
1da177e4 LT	16	#endif
	17
	18	/*
	19	* Important limits for the exports stuff.
	20	*/
	21	#define NFSCLNT_IDMAX 1024
	22	#define NFSCLNT_ADDRMAX 16
	23	#define NFSCLNT_KEYMAX 32
	24
	25	/*
	26	* Export flags.
	27	*/
	28	#define NFSEXP_READONLY 0x0001
	29	#define NFSEXP_INSECURE_PORT 0x0002
	30	#define NFSEXP_ROOTSQUASH 0x0004
	31	#define NFSEXP_ALLSQUASH 0x0008
	32	#define NFSEXP_ASYNC 0x0010
	33	#define NFSEXP_GATHERED_WRITES 0x0020
	34	/* 40 80 100 currently unused */
	35	#define NFSEXP_NOHIDE 0x0200
	36	#define NFSEXP_NOSUBTREECHECK 0x0400
	37	#define NFSEXP_NOAUTHNLM 0x0800 /* Don't authenticate NLM requests - just trust */
	38	#define NFSEXP_MSNFS 0x1000 /* do silly things that MS clients expect */
	39	#define NFSEXP_FSID 0x2000
	40	#define NFSEXP_CROSSMOUNT 0x4000
	41	#define NFSEXP_NOACL 0x8000 /* reserved for possible ACL related use */
e8e8753f BF	42	/* All flags that we claim to support. (Note we don't support NOACL.) */
e8e8753f BF	43	#define NFSEXP_ALLFLAGS 0x7E3F
1da177e4	44
e677bfe4	45	/* The flags that may vary depending on security flavor: */
1269bc69	46	#define NFSEXP_SECINFO_FLAGS (NFSEXP_READONLY \| NFSEXP_ROOTSQUASH \
12045a6e BF	47	\| NFSEXP_ALLSQUASH \
12045a6e BF	48	\| NFSEXP_INSECURE_PORT)
1da177e4 LT	49
	50	#ifdef __KERNEL__
	51
93346919 MN	52	/*
	53	* FS Locations
	54	*/
	55
	56	#define MAX_FS_LOCATIONS 128
	57
	58	struct nfsd4_fs_location {
	59	char hosts; / colon separated list of hosts */
	60	char path; / slash separated list of path components */
	61	};
	62
	63	struct nfsd4_fs_locations {
	64	uint32_t locations_count;
	65	struct nfsd4_fs_location *locations;
	66	/* If we're not actually serving this data ourselves (only providing a
	67	* list of replicas that do serve it) then we set "migrated": */
	68	int migrated;
	69	};
	70
e677bfe4 AA	71	/*
	72	* We keep an array of pseudoflavors with the export, in order from most
	73	* to least preferred. For the forseeable future, we don't expect more
	74	* than the eight pseudoflavors null, unix, krb5, krb5i, krb5p, skpm3,
	75	* spkm3i, and spkm3p (and using all 8 at once should be rare).
	76	*/
	77	#define MAX_SECINFO_LIST 8
	78
	79	struct exp_flavor_info {
	80	u32 pseudoflavor;
	81	u32 flags;
	82	};
	83
1da177e4 LT	84	struct svc_export {
	85	struct cache_head h;
	86	struct auth_domain * ex_client;
	87	int ex_flags;
54775491 JB	88	struct path ex_path;
54775491 JB	89	char *ex_pathname;
1da177e4 LT	90	uid_t ex_anon_uid;
	91	gid_t ex_anon_gid;
	92	int ex_fsid;
af6a4e28	93	unsigned char * ex_uuid; /* 16 byte fsid */
93346919	94	struct nfsd4_fs_locations ex_fslocs;
e677bfe4 AA	95	int ex_nflavors;
e677bfe4 AA	96	struct exp_flavor_info ex_flavors[MAX_SECINFO_LIST];
1da177e4 LT	97	};
	98
	99	/* an "export key" (expkey) maps a filehandlefragement to an
af6a4e28 N	100	* svc_export for a given client. There can be several per export,
af6a4e28 N	101	* for the different fsid types.
1da177e4 LT	102	*/
	103	struct svc_expkey {
	104	struct cache_head h;
	105
	106	struct auth_domain * ek_client;
	107	int ek_fsidtype;
af6a4e28	108	u32 ek_fsid[6];
1da177e4	109
e83aece3	110	struct path ek_path;
1da177e4 LT	111	};
1da177e4 LT	112
1da177e4	113	#define EX_ISSYNC(exp) (!((exp)->ex_flags & NFSEXP_ASYNC))
1da177e4 LT	114	#define EX_NOHIDE(exp) ((exp)->ex_flags & NFSEXP_NOHIDE)
	115	#define EX_WGATHER(exp) ((exp)->ex_flags & NFSEXP_GATHERED_WRITES)
	116
c7d51402	117	int nfsexp_flags(struct svc_rqst rqstp, struct svc_export exp);
32c1eb0c	118	__be32 check_nfsd_access(struct svc_export exp, struct svc_rqst rqstp);
1da177e4 LT	119
	120	/*
	121	* Function declarations
	122	*/
dbf847ec	123	int nfsd_export_init(void);
1da177e4 LT	124	void nfsd_export_shutdown(void);
	125	void nfsd_export_flush(void);
	126	void exp_readlock(void);
	127	void exp_readunlock(void);
0989a788	128	struct svc_export * rqst_exp_get_by_name(struct svc_rqst *,
91c9fa8f	129	struct path *);
0989a788	130	struct svc_export * rqst_exp_parent(struct svc_rqst *,
e64c390c	131	struct path *);
1da177e4 LT	132	int exp_rootfh(struct auth_domain *,
1da177e4 LT	133	char path, struct knfsd_fh , int maxsize);
df547efb	134	__be32 exp_pseudoroot(struct svc_rqst , struct svc_fh );
63f10311	135	__be32 nfserrno(int errno);
1da177e4	136
74cae61a	137	extern struct cache_detail svc_export_cache;
1da177e4 LT	138
	139	static inline void exp_put(struct svc_export *exp)
	140	{
baab935f	141	cache_put(&exp->h, &svc_export_cache);
1da177e4 LT	142	}
	143
	144	static inline void exp_get(struct svc_export *exp)
	145	{
	146	cache_get(&exp->h);
	147	}
0989a788	148	struct svc_export * rqst_exp_find(struct svc_rqst , int, u32 );
1da177e4 LT	149
	150	#endif /* __KERNEL__ */
	151
	152	#endif /* NFSD_EXPORT_H */
	153