blob: a6d9ef2bb34a9c4bb2f832ec5badea200b439678 [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__
Linus Torvalds1da177e2005-04-16 15:20:36 -070015# include <linux/in.h>
16#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 */
38#define NFSEXP_MSNFS 0x1000 /* do silly things that MS clients expect */
39#define NFSEXP_FSID 0x2000
40#define NFSEXP_CROSSMOUNT 0x4000
41#define NFSEXP_NOACL 0x8000 /* reserved for possible ACL related use */
42#define NFSEXP_ALLFLAGS 0xFE3F
43
Andy Adamsone677bfe2007-07-17 04:04:42 -070044/* The flags that may vary depending on security flavor: */
J. Bruce Fields1269bc62007-07-17 04:04:52 -070045#define NFSEXP_SECINFO_FLAGS (NFSEXP_READONLY | NFSEXP_ROOTSQUASH \
46 | NFSEXP_ALLSQUASH)
Linus Torvalds1da177e2005-04-16 15:20:36 -070047
48#ifdef __KERNEL__
49
Manoj Naik933469192006-10-04 02:16:18 -070050/*
51 * FS Locations
52 */
53
54#define MAX_FS_LOCATIONS 128
55
56struct nfsd4_fs_location {
57 char *hosts; /* colon separated list of hosts */
58 char *path; /* slash separated list of path components */
59};
60
61struct nfsd4_fs_locations {
62 uint32_t locations_count;
63 struct nfsd4_fs_location *locations;
64/* If we're not actually serving this data ourselves (only providing a
65 * list of replicas that do serve it) then we set "migrated": */
66 int migrated;
67};
68
Andy Adamsone677bfe2007-07-17 04:04:42 -070069/*
70 * We keep an array of pseudoflavors with the export, in order from most
71 * to least preferred. For the forseeable future, we don't expect more
72 * than the eight pseudoflavors null, unix, krb5, krb5i, krb5p, skpm3,
73 * spkm3i, and spkm3p (and using all 8 at once should be rare).
74 */
75#define MAX_SECINFO_LIST 8
76
77struct exp_flavor_info {
78 u32 pseudoflavor;
79 u32 flags;
80};
81
Linus Torvalds1da177e2005-04-16 15:20:36 -070082struct svc_export {
83 struct cache_head h;
84 struct auth_domain * ex_client;
85 int ex_flags;
Jan Blunck54775492008-02-14 19:38:39 -080086 struct path ex_path;
87 char *ex_pathname;
Linus Torvalds1da177e2005-04-16 15:20:36 -070088 uid_t ex_anon_uid;
89 gid_t ex_anon_gid;
90 int ex_fsid;
NeilBrownaf6a4e22007-02-14 00:33:12 -080091 unsigned char * ex_uuid; /* 16 byte fsid */
Manoj Naik933469192006-10-04 02:16:18 -070092 struct nfsd4_fs_locations ex_fslocs;
Andy Adamsone677bfe2007-07-17 04:04:42 -070093 int ex_nflavors;
94 struct exp_flavor_info ex_flavors[MAX_SECINFO_LIST];
Linus Torvalds1da177e2005-04-16 15:20:36 -070095};
96
97/* an "export key" (expkey) maps a filehandlefragement to an
NeilBrownaf6a4e22007-02-14 00:33:12 -080098 * svc_export for a given client. There can be several per export,
99 * for the different fsid types.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100 */
101struct svc_expkey {
102 struct cache_head h;
103
104 struct auth_domain * ek_client;
105 int ek_fsidtype;
NeilBrownaf6a4e22007-02-14 00:33:12 -0800106 u32 ek_fsid[6];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107
Jan Bluncke83aece2008-02-14 19:38:41 -0800108 struct path ek_path;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109};
110
111#define EX_SECURE(exp) (!((exp)->ex_flags & NFSEXP_INSECURE_PORT))
112#define EX_ISSYNC(exp) (!((exp)->ex_flags & NFSEXP_ASYNC))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113#define EX_NOHIDE(exp) ((exp)->ex_flags & NFSEXP_NOHIDE)
114#define EX_WGATHER(exp) ((exp)->ex_flags & NFSEXP_GATHERED_WRITES)
115
J. Bruce Fieldsc7d51402007-07-19 01:49:20 -0700116int nfsexp_flags(struct svc_rqst *rqstp, struct svc_export *exp);
Andy Adamson32c1eb02007-07-17 04:04:48 -0700117__be32 check_nfsd_access(struct svc_export *exp, struct svc_rqst *rqstp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118
119/*
120 * Function declarations
121 */
J. Bruce Fieldsdbf847e2007-11-08 17:20:34 -0500122int nfsd_export_init(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123void nfsd_export_shutdown(void);
124void nfsd_export_flush(void);
125void exp_readlock(void);
126void exp_readunlock(void);
J. Bruce Fields0989a782007-07-17 04:04:44 -0700127struct svc_export * rqst_exp_get_by_name(struct svc_rqst *,
Al Viro91c9fa82009-04-18 02:42:05 -0400128 struct path *);
J. Bruce Fields0989a782007-07-17 04:04:44 -0700129struct svc_export * rqst_exp_parent(struct svc_rqst *,
Al Viroe64c3902009-04-18 03:00:46 -0400130 struct path *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131int exp_rootfh(struct auth_domain *,
132 char *path, struct knfsd_fh *, int maxsize);
J. Bruce Fieldsdf547ef2007-07-17 04:04:43 -0700133__be32 exp_pseudoroot(struct svc_rqst *, struct svc_fh *);
Al Viro63f103112006-10-19 23:28:54 -0700134__be32 nfserrno(int errno);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135
Adrian Bunk74cae612006-03-27 01:15:10 -0800136extern struct cache_detail svc_export_cache;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137
138static inline void exp_put(struct svc_export *exp)
139{
NeilBrownbaab9352006-03-27 01:15:09 -0800140 cache_put(&exp->h, &svc_export_cache);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141}
142
143static inline void exp_get(struct svc_export *exp)
144{
145 cache_get(&exp->h);
146}
J. Bruce Fields0989a782007-07-17 04:04:44 -0700147struct svc_export * rqst_exp_find(struct svc_rqst *, int, u32 *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148
149#endif /* __KERNEL__ */
150
151#endif /* NFSD_EXPORT_H */
152