[mirror_ubuntu-jammy-kernel.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 <linux/percpu_counter.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;
};

/* Per-export stats */
enum {
	EXP_STATS_FH_STALE,
	EXP_STATS_IO_READ,
	EXP_STATS_IO_WRITE,
	EXP_STATS_COUNTERS_NUM
};

struct export_stats {
	time64_t		start_time;
	struct percpu_counter	counter[EXP_STATS_COUNTERS_NUM];
};

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;
	struct rcu_head		ex_rcu;
	struct export_stats	ex_stats;
};

/* 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;
	struct rcu_head		ek_rcu;
};

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