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