blob: 4cafbe1255f0de2a47c1f58d11da782aa64e389e [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 */
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 */
J. Bruce Fieldse8e87532009-12-14 12:53:32 -050042/* All flags that we claim to support. (Note we don't support NOACL.) */
43#define NFSEXP_ALLFLAGS 0x7E3F
Linus Torvalds1da177e2005-04-16 15:20:36 -070044
Andy Adamsone677bfe2007-07-17 04:04:42 -070045/* The flags that may vary depending on security flavor: */
J. Bruce Fields1269bc62007-07-17 04:04:52 -070046#define NFSEXP_SECINFO_FLAGS (NFSEXP_READONLY | NFSEXP_ROOTSQUASH \
J. Bruce Fields12045a6e2009-12-08 18:15:52 -050047 | NFSEXP_ALLSQUASH \
48 | NFSEXP_INSECURE_PORT)
Linus Torvalds1da177e2005-04-16 15:20:36 -070049
50#ifdef __KERNEL__
51
Manoj Naik933469192006-10-04 02:16:18 -070052/*
53 * FS Locations
54 */
55
56#define MAX_FS_LOCATIONS 128
57
58struct nfsd4_fs_location {
59 char *hosts; /* colon separated list of hosts */
60 char *path; /* slash separated list of path components */
61};
62
63struct nfsd4_fs_locations {
64 uint32_t locations_count;
65 struct nfsd4_fs_location *locations;
66/* If we're not actually serving this data ourselves (only providing a
67 * list of replicas that do serve it) then we set "migrated": */
68 int migrated;
69};
70
Andy Adamsone677bfe2007-07-17 04:04:42 -070071/*
72 * We keep an array of pseudoflavors with the export, in order from most
73 * to least preferred. For the forseeable future, we don't expect more
74 * than the eight pseudoflavors null, unix, krb5, krb5i, krb5p, skpm3,
75 * spkm3i, and spkm3p (and using all 8 at once should be rare).
76 */
77#define MAX_SECINFO_LIST 8
78
79struct exp_flavor_info {
80 u32 pseudoflavor;
81 u32 flags;
82};
83
Linus Torvalds1da177e2005-04-16 15:20:36 -070084struct svc_export {
85 struct cache_head h;
86 struct auth_domain * ex_client;
87 int ex_flags;
Jan Blunck54775492008-02-14 19:38:39 -080088 struct path ex_path;
89 char *ex_pathname;
Linus Torvalds1da177e2005-04-16 15:20:36 -070090 uid_t ex_anon_uid;
91 gid_t ex_anon_gid;
92 int ex_fsid;
NeilBrownaf6a4e22007-02-14 00:33:12 -080093 unsigned char * ex_uuid; /* 16 byte fsid */
Manoj Naik933469192006-10-04 02:16:18 -070094 struct nfsd4_fs_locations ex_fslocs;
Andy Adamsone677bfe2007-07-17 04:04:42 -070095 int ex_nflavors;
96 struct exp_flavor_info ex_flavors[MAX_SECINFO_LIST];
Linus Torvalds1da177e2005-04-16 15:20:36 -070097};
98
99/* an "export key" (expkey) maps a filehandlefragement to an
NeilBrownaf6a4e22007-02-14 00:33:12 -0800100 * svc_export for a given client. There can be several per export,
101 * for the different fsid types.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102 */
103struct svc_expkey {
104 struct cache_head h;
105
106 struct auth_domain * ek_client;
107 int ek_fsidtype;
NeilBrownaf6a4e22007-02-14 00:33:12 -0800108 u32 ek_fsid[6];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109
Jan Bluncke83aece2008-02-14 19:38:41 -0800110 struct path ek_path;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111};
112
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113#define EX_ISSYNC(exp) (!((exp)->ex_flags & NFSEXP_ASYNC))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114#define EX_NOHIDE(exp) ((exp)->ex_flags & NFSEXP_NOHIDE)
115#define EX_WGATHER(exp) ((exp)->ex_flags & NFSEXP_GATHERED_WRITES)
116
J. Bruce Fieldsc7d51402007-07-19 01:49:20 -0700117int nfsexp_flags(struct svc_rqst *rqstp, struct svc_export *exp);
Andy Adamson32c1eb02007-07-17 04:04:48 -0700118__be32 check_nfsd_access(struct svc_export *exp, struct svc_rqst *rqstp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119
120/*
121 * Function declarations
122 */
J. Bruce Fieldsdbf847e2007-11-08 17:20:34 -0500123int nfsd_export_init(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124void nfsd_export_shutdown(void);
125void nfsd_export_flush(void);
126void exp_readlock(void);
127void exp_readunlock(void);
J. Bruce Fields0989a782007-07-17 04:04:44 -0700128struct svc_export * rqst_exp_get_by_name(struct svc_rqst *,
Al Viro91c9fa82009-04-18 02:42:05 -0400129 struct path *);
J. Bruce Fields0989a782007-07-17 04:04:44 -0700130struct svc_export * rqst_exp_parent(struct svc_rqst *,
Al Viroe64c3902009-04-18 03:00:46 -0400131 struct path *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132int exp_rootfh(struct auth_domain *,
133 char *path, struct knfsd_fh *, int maxsize);
J. Bruce Fieldsdf547ef2007-07-17 04:04:43 -0700134__be32 exp_pseudoroot(struct svc_rqst *, struct svc_fh *);
Al Viro63f103112006-10-19 23:28:54 -0700135__be32 nfserrno(int errno);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136
Adrian Bunk74cae612006-03-27 01:15:10 -0800137extern struct cache_detail svc_export_cache;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138
139static inline void exp_put(struct svc_export *exp)
140{
NeilBrownbaab9352006-03-27 01:15:09 -0800141 cache_put(&exp->h, &svc_export_cache);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142}
143
144static inline void exp_get(struct svc_export *exp)
145{
146 cache_get(&exp->h);
147}
J. Bruce Fields0989a782007-07-17 04:04:44 -0700148struct svc_export * rqst_exp_find(struct svc_rqst *, int, u32 *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149
150#endif /* __KERNEL__ */
151
152#endif /* NFSD_EXPORT_H */
153