[mirror_ubuntu-zesty-kernel.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	(NFSEXP_READONLY | NFSEXP_ROOTSQUASH \
					| NFSEXP_ALLSQUASH)

#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 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_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 vfsmount *,
					     struct dentry *);
struct svc_export *	rqst_exp_parent(struct svc_rqst *,
					struct vfsmount *mnt,
					struct dentry *dentry);
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
	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	45	/* The flags that may vary depending on security flavor: */
1269bc69 BF	46	#define NFSEXP_SECINFO_FLAGS (NFSEXP_READONLY \| NFSEXP_ROOTSQUASH \
1269bc69 BF	47	\| NFSEXP_ALLSQUASH)
1da177e4 LT	48
	49	#ifdef __KERNEL__
	50
93346919 MN	51	/*
	52	* FS Locations
	53	*/
	54
	55	#define MAX_FS_LOCATIONS 128
	56
	57	struct nfsd4_fs_location {
	58	char hosts; / colon separated list of hosts */
	59	char path; / slash separated list of path components */
	60	};
	61
	62	struct nfsd4_fs_locations {
	63	uint32_t locations_count;
	64	struct nfsd4_fs_location *locations;
	65	/* If we're not actually serving this data ourselves (only providing a
	66	* list of replicas that do serve it) then we set "migrated": */
	67	int migrated;
	68	};
	69
e677bfe4 AA	70	/*
	71	* We keep an array of pseudoflavors with the export, in order from most
	72	* to least preferred. For the forseeable future, we don't expect more
	73	* than the eight pseudoflavors null, unix, krb5, krb5i, krb5p, skpm3,
	74	* spkm3i, and spkm3p (and using all 8 at once should be rare).
	75	*/
	76	#define MAX_SECINFO_LIST 8
	77
	78	struct exp_flavor_info {
	79	u32 pseudoflavor;
	80	u32 flags;
	81	};
	82
1da177e4 LT	83	struct svc_export {
	84	struct cache_head h;
	85	struct auth_domain * ex_client;
	86	int ex_flags;
54775491 JB	87	struct path ex_path;
54775491 JB	88	char *ex_pathname;
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))
1da177e4 LT	115	#define EX_NOHIDE(exp) ((exp)->ex_flags & NFSEXP_NOHIDE)
	116	#define EX_WGATHER(exp) ((exp)->ex_flags & NFSEXP_GATHERED_WRITES)
	117
c7d51402	118	int nfsexp_flags(struct svc_rqst rqstp, struct svc_export exp);
32c1eb0c	119	__be32 check_nfsd_access(struct svc_export exp, struct svc_rqst rqstp);
1da177e4 LT	120
	121	/*
	122	* Function declarations
	123	*/
dbf847ec	124	int nfsd_export_init(void);
1da177e4 LT	125	void nfsd_export_shutdown(void);
	126	void nfsd_export_flush(void);
	127	void exp_readlock(void);
	128	void exp_readunlock(void);
0989a788 BF	129	struct svc_export * rqst_exp_get_by_name(struct svc_rqst *,
	130	struct vfsmount *,
	131	struct dentry *);
0989a788 BF	132	struct svc_export * rqst_exp_parent(struct svc_rqst *,
	133	struct vfsmount *mnt,
	134	struct dentry *dentry);
1da177e4 LT	135	int exp_rootfh(struct auth_domain *,
1da177e4 LT	136	char path, struct knfsd_fh , int maxsize);
df547efb	137	__be32 exp_pseudoroot(struct svc_rqst , struct svc_fh );
63f10311	138	__be32 nfserrno(int errno);
1da177e4	139
74cae61a	140	extern struct cache_detail svc_export_cache;
1da177e4 LT	141
	142	static inline void exp_put(struct svc_export *exp)
	143	{
baab935f	144	cache_put(&exp->h, &svc_export_cache);
1da177e4 LT	145	}
	146
	147	static inline void exp_get(struct svc_export *exp)
	148	{
	149	cache_get(&exp->h);
	150	}
0989a788	151	struct svc_export * rqst_exp_find(struct svc_rqst , int, u32 );
1da177e4 LT	152
	153	#endif /* __KERNEL__ */
	154
	155	#endif /* NFSD_EXPORT_H */
	156