[linux-2.6-block.git] / fs / nfsd / export.h

/* SPDX-License-Identifier: GPL-2.0 */
/*
 * Copyright (C) 1995-1997 Olaf Kirch <okir@monad.swb.de>
 */
#ifndef NFSD_EXPORT_H
#define NFSD_EXPORT_H

#include <linux/sunrpc/cache.h>
#include <uapi/linux/nfsd/export.h>
#include <linux/nfs4.h>

struct knfsd_fh;
struct svc_fh;
struct svc_rqst;

/*
 * 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 foreseeable 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
#define EX_UUID_LEN		16

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;
	kuid_t			ex_anon_uid;
	kgid_t			ex_anon_gid;
	int			ex_fsid;
	unsigned char *		ex_uuid; /* 16 byte fsid */
	struct nfsd4_fs_locations ex_fslocs;
	uint32_t		ex_nflavors;
	struct exp_flavor_info	ex_flavors[MAX_SECINFO_LIST];
	u32			ex_layout_types;
	struct nfsd4_deviceid_map *ex_devid_map;
	struct cache_detail	*cd;
};

/* 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(struct net *);
void			nfsd_export_shutdown(struct net *);
void			nfsd_export_flush(struct net *);
struct svc_export *	rqst_exp_get_by_name(struct svc_rqst *,
					     struct path *);
struct svc_export *	rqst_exp_parent(struct svc_rqst *,
					struct path *);
struct svc_export *	rqst_find_fsidzero_export(struct svc_rqst *);
int			exp_rootfh(struct net *, struct auth_domain *,
					char *path, struct knfsd_fh *, int maxsize);
__be32			exp_pseudoroot(struct svc_rqst *, struct svc_fh *);
__be32			nfserrno(int errno);

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

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

#endif /* NFSD_EXPORT_H */
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
1da177e4	2	/*
1da177e4 LT	3	* Copyright (C) 1995-1997 Olaf Kirch <okir@monad.swb.de>
1da177e4 LT	4	*/
1da177e4 LT	5	#ifndef NFSD_EXPORT_H
	6	#define NFSD_EXPORT_H
	7
9c69de4c	8	#include <linux/sunrpc/cache.h>
616d1ca5	9	#include <uapi/linux/nfsd/export.h>
4bc66037	10	#include <linux/nfs4.h>
1da177e4	11
9c69de4c CH	12	struct knfsd_fh;
	13	struct svc_fh;
	14	struct svc_rqst;
	15
93346919 MN	16	/*
	17	* FS Locations
	18	*/
	19
	20	#define MAX_FS_LOCATIONS 128
	21
	22	struct nfsd4_fs_location {
	23	char hosts; / colon separated list of hosts */
	24	char path; / slash separated list of path components */
	25	};
	26
	27	struct nfsd4_fs_locations {
	28	uint32_t locations_count;
	29	struct nfsd4_fs_location *locations;
	30	/* If we're not actually serving this data ourselves (only providing a
	31	* list of replicas that do serve it) then we set "migrated": */
	32	int migrated;
	33	};
	34
e677bfe4 AA	35	/*
e677bfe4 AA	36	* We keep an array of pseudoflavors with the export, in order from most
25985edc	37	* to least preferred. For the foreseeable future, we don't expect more
e677bfe4 AA	38	* than the eight pseudoflavors null, unix, krb5, krb5i, krb5p, skpm3,
	39	* spkm3i, and spkm3p (and using all 8 at once should be rare).
	40	*/
	41	#define MAX_SECINFO_LIST 8
94eb3689	42	#define EX_UUID_LEN 16
e677bfe4 AA	43
	44	struct exp_flavor_info {
	45	u32 pseudoflavor;
	46	u32 flags;
	47	};
	48
1da177e4 LT	49	struct svc_export {
	50	struct cache_head h;
	51	struct auth_domain * ex_client;
	52	int ex_flags;
54775491	53	struct path ex_path;
4c1e1b34 EB	54	kuid_t ex_anon_uid;
4c1e1b34 EB	55	kgid_t ex_anon_gid;
1da177e4	56	int ex_fsid;
af6a4e28	57	unsigned char * ex_uuid; /* 16 byte fsid */
93346919	58	struct nfsd4_fs_locations ex_fslocs;
1f53146d	59	uint32_t ex_nflavors;
e677bfe4	60	struct exp_flavor_info ex_flavors[MAX_SECINFO_LIST];
8a4c3926	61	u32 ex_layout_types;
9cf514cc	62	struct nfsd4_deviceid_map *ex_devid_map;
db3a3532	63	struct cache_detail *cd;
1da177e4 LT	64	};
	65
	66	/* an "export key" (expkey) maps a filehandlefragement to an
af6a4e28 N	67	* svc_export for a given client. There can be several per export,
af6a4e28 N	68	* for the different fsid types.
1da177e4 LT	69	*/
	70	struct svc_expkey {
	71	struct cache_head h;
	72
	73	struct auth_domain * ek_client;
	74	int ek_fsidtype;
af6a4e28	75	u32 ek_fsid[6];
1da177e4	76
e83aece3	77	struct path ek_path;
1da177e4 LT	78	};
1da177e4 LT	79
1da177e4	80	#define EX_ISSYNC(exp) (!((exp)->ex_flags & NFSEXP_ASYNC))
1da177e4 LT	81	#define EX_NOHIDE(exp) ((exp)->ex_flags & NFSEXP_NOHIDE)
	82	#define EX_WGATHER(exp) ((exp)->ex_flags & NFSEXP_GATHERED_WRITES)
	83
c7d51402	84	int nfsexp_flags(struct svc_rqst rqstp, struct svc_export exp);
32c1eb0c	85	__be32 check_nfsd_access(struct svc_export exp, struct svc_rqst rqstp);
1da177e4 LT	86
	87	/*
	88	* Function declarations
	89	*/
b89109be SK	90	int nfsd_export_init(struct net *);
b89109be SK	91	void nfsd_export_shutdown(struct net *);
b3853e0e	92	void nfsd_export_flush(struct net *);
0989a788	93	struct svc_export * rqst_exp_get_by_name(struct svc_rqst *,
91c9fa8f	94	struct path *);
0989a788	95	struct svc_export * rqst_exp_parent(struct svc_rqst *,
e64c390c	96	struct path *);
ed748aac	97	struct svc_export * rqst_find_fsidzero_export(struct svc_rqst *);
b3853e0e	98	int exp_rootfh(struct net , struct auth_domain ,
1da177e4	99	char path, struct knfsd_fh , int maxsize);
df547efb	100	__be32 exp_pseudoroot(struct svc_rqst , struct svc_fh );
63f10311	101	__be32 nfserrno(int errno);
1da177e4	102
1da177e4 LT	103	static inline void exp_put(struct svc_export *exp)
1da177e4 LT	104	{
71234978	105	cache_put(&exp->h, exp->cd);
1da177e4 LT	106	}
1da177e4 LT	107
bf18f163	108	static inline struct svc_export exp_get(struct svc_export exp)
1da177e4 LT	109	{
1da177e4 LT	110	cache_get(&exp->h);
bf18f163	111	return exp;
1da177e4	112	}
0989a788	113	struct svc_export * rqst_exp_find(struct svc_rqst , int, u32 );
1da177e4	114
1da177e4	115	#endif /* NFSD_EXPORT_H */