[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 <asm/types.h>
#ifdef __KERNEL__
# include <linux/types.h>
# include <linux/in.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 */
#define NFSEXP_ALLFLAGS		0xFE3F

/* The flags that may vary depending on security flavor: */
#define NFSEXP_SECINFO_FLAGS	0

#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 vfsmount *	ex_mnt;
	struct dentry *		ex_dentry;
	char *			ex_path;
	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 vfsmount *	ek_mnt;
	struct dentry *		ek_dentry;
};

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


/*
 * Function declarations
 */
void			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 *	exp_get_by_name(struct auth_domain *clp,
					struct vfsmount *mnt,
					struct dentry *dentry,
					struct cache_req *reqp);
struct svc_export *	exp_parent(struct auth_domain *clp,
				   struct vfsmount *mnt,
				   struct dentry *dentry,
				   struct cache_req *reqp);
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);
}
extern struct svc_export *
exp_find(struct auth_domain *clp, int fsid_type, u32 *fsidv,
	 struct cache_req *reqp);

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