blob: 84058ec693902cc1e9037784919798e6824f9c0e [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
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
Linus Torvalds1da177e2005-04-16 15:20:36 -070013# include <linux/types.h>
Jaswinder Singh Rajput3187ced2009-01-30 20:03:06 +053014#ifdef __KERNEL__
Boaz Harrosh72579ac2009-12-03 20:28:59 +020015# include <linux/nfsd/nfsfh.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070016#endif
17
18/*
19 * Important limits for the exports stuff.
20 */
21#define NFSCLNT_IDMAX 1024
22#define NFSCLNT_ADDRMAX 16
23#define NFSCLNT_KEYMAX 32
24
25/*
26 * Export flags.
27 */
28#define NFSEXP_READONLY 0x0001
29#define NFSEXP_INSECURE_PORT 0x0002
30#define NFSEXP_ROOTSQUASH 0x0004
31#define NFSEXP_ALLSQUASH 0x0008
32#define NFSEXP_ASYNC 0x0010
33#define NFSEXP_GATHERED_WRITES 0x0020
34/* 40 80 100 currently unused */
35#define NFSEXP_NOHIDE 0x0200
36#define NFSEXP_NOSUBTREECHECK 0x0400
37#define NFSEXP_NOAUTHNLM 0x0800 /* Don't authenticate NLM requests - just trust */
J. Bruce Fields9ce137e2011-01-11 14:07:12 -050038#define NFSEXP_MSNFS 0x1000 /* do silly things that MS clients expect; no longer supported */
Linus Torvalds1da177e2005-04-16 15:20:36 -070039#define NFSEXP_FSID 0x2000
40#define NFSEXP_CROSSMOUNT 0x4000
41#define NFSEXP_NOACL 0x8000 /* reserved for possible ACL related use */
Steve Dicksoneb4c86c2009-09-09 14:58:22 -040042/*
43 * The NFSEXP_V4ROOT flag causes the kernel to give access only to NFSv4
44 * clients, and only to the single directory that is the root of the
45 * export; further lookup and readdir operations are treated as if every
46 * subdirectory was a mountpoint, and ignored if they are not themselves
47 * exported. This is used by nfsd and mountd to construct the NFSv4
48 * pseudofilesystem, which provides access only to paths leading to each
49 * exported filesystem.
50 */
51#define NFSEXP_V4ROOT 0x10000
J. Bruce Fieldse8e87532009-12-14 12:53:32 -050052/* All flags that we claim to support. (Note we don't support NOACL.) */
J. Bruce Fields3d8986c2009-12-15 14:09:03 -050053#define NFSEXP_ALLFLAGS 0x17E3F
Linus Torvalds1da177e2005-04-16 15:20:36 -070054
Andy Adamsone677bfe2007-07-17 04:04:42 -070055/* The flags that may vary depending on security flavor: */
J. Bruce Fields1269bc62007-07-17 04:04:52 -070056#define NFSEXP_SECINFO_FLAGS (NFSEXP_READONLY | NFSEXP_ROOTSQUASH \
J. Bruce Fields12045a6e2009-12-08 18:15:52 -050057 | NFSEXP_ALLSQUASH \
58 | NFSEXP_INSECURE_PORT)
Linus Torvalds1da177e2005-04-16 15:20:36 -070059
60#ifdef __KERNEL__
61
Manoj Naik933469192006-10-04 02:16:18 -070062/*
63 * FS Locations
64 */
65
66#define MAX_FS_LOCATIONS 128
67
68struct nfsd4_fs_location {
69 char *hosts; /* colon separated list of hosts */
70 char *path; /* slash separated list of path components */
71};
72
73struct nfsd4_fs_locations {
74 uint32_t locations_count;
75 struct nfsd4_fs_location *locations;
76/* If we're not actually serving this data ourselves (only providing a
77 * list of replicas that do serve it) then we set "migrated": */
78 int migrated;
79};
80
Andy Adamsone677bfe2007-07-17 04:04:42 -070081/*
82 * We keep an array of pseudoflavors with the export, in order from most
Lucas De Marchi25985ed2011-03-30 22:57:33 -030083 * to least preferred. For the foreseeable future, we don't expect more
Andy Adamsone677bfe2007-07-17 04:04:42 -070084 * than the eight pseudoflavors null, unix, krb5, krb5i, krb5p, skpm3,
85 * spkm3i, and spkm3p (and using all 8 at once should be rare).
86 */
87#define MAX_SECINFO_LIST 8
88
89struct exp_flavor_info {
90 u32 pseudoflavor;
91 u32 flags;
92};
93
Linus Torvalds1da177e2005-04-16 15:20:36 -070094struct svc_export {
95 struct cache_head h;
96 struct auth_domain * ex_client;
97 int ex_flags;
Jan Blunck54775492008-02-14 19:38:39 -080098 struct path ex_path;
99 char *ex_pathname;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100 uid_t ex_anon_uid;
101 gid_t ex_anon_gid;
102 int ex_fsid;
NeilBrownaf6a4e22007-02-14 00:33:12 -0800103 unsigned char * ex_uuid; /* 16 byte fsid */
Manoj Naik933469192006-10-04 02:16:18 -0700104 struct nfsd4_fs_locations ex_fslocs;
Andy Adamsone677bfe2007-07-17 04:04:42 -0700105 int ex_nflavors;
106 struct exp_flavor_info ex_flavors[MAX_SECINFO_LIST];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107};
108
109/* an "export key" (expkey) maps a filehandlefragement to an
NeilBrownaf6a4e22007-02-14 00:33:12 -0800110 * svc_export for a given client. There can be several per export,
111 * for the different fsid types.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112 */
113struct svc_expkey {
114 struct cache_head h;
115
116 struct auth_domain * ek_client;
117 int ek_fsidtype;
NeilBrownaf6a4e22007-02-14 00:33:12 -0800118 u32 ek_fsid[6];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119
Jan Bluncke83aece2008-02-14 19:38:41 -0800120 struct path ek_path;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121};
122
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123#define EX_ISSYNC(exp) (!((exp)->ex_flags & NFSEXP_ASYNC))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124#define EX_NOHIDE(exp) ((exp)->ex_flags & NFSEXP_NOHIDE)
125#define EX_WGATHER(exp) ((exp)->ex_flags & NFSEXP_GATHERED_WRITES)
126
J. Bruce Fieldsc7d51402007-07-19 01:49:20 -0700127int nfsexp_flags(struct svc_rqst *rqstp, struct svc_export *exp);
Andy Adamson32c1eb02007-07-17 04:04:48 -0700128__be32 check_nfsd_access(struct svc_export *exp, struct svc_rqst *rqstp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129
130/*
131 * Function declarations
132 */
J. Bruce Fieldsdbf847e2007-11-08 17:20:34 -0500133int nfsd_export_init(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134void nfsd_export_shutdown(void);
135void nfsd_export_flush(void);
136void exp_readlock(void);
137void exp_readunlock(void);
J. Bruce Fields0989a782007-07-17 04:04:44 -0700138struct svc_export * rqst_exp_get_by_name(struct svc_rqst *,
Al Viro91c9fa82009-04-18 02:42:05 -0400139 struct path *);
J. Bruce Fields0989a782007-07-17 04:04:44 -0700140struct svc_export * rqst_exp_parent(struct svc_rqst *,
Al Viroe64c3902009-04-18 03:00:46 -0400141 struct path *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142int exp_rootfh(struct auth_domain *,
143 char *path, struct knfsd_fh *, int maxsize);
J. Bruce Fieldsdf547ef2007-07-17 04:04:43 -0700144__be32 exp_pseudoroot(struct svc_rqst *, struct svc_fh *);
Al Viro63f103112006-10-19 23:28:54 -0700145__be32 nfserrno(int errno);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146
Adrian Bunk74cae612006-03-27 01:15:10 -0800147extern struct cache_detail svc_export_cache;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148
149static inline void exp_put(struct svc_export *exp)
150{
NeilBrownbaab9352006-03-27 01:15:09 -0800151 cache_put(&exp->h, &svc_export_cache);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700152}
153
154static inline void exp_get(struct svc_export *exp)
155{
156 cache_get(&exp->h);
157}
J. Bruce Fields0989a782007-07-17 04:04:44 -0700158struct svc_export * rqst_exp_find(struct svc_rqst *, int, u32 *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159
160#endif /* __KERNEL__ */
161
162#endif /* NFSD_EXPORT_H */
163