Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1 | /* |
| 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 Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 13 | # include <linux/types.h> |
Jaswinder Singh Rajput | 3187ced | 2009-01-30 20:03:06 +0530 | [diff] [blame] | 14 | #ifdef __KERNEL__ |
Boaz Harrosh | 72579ac | 2009-12-03 20:28:59 +0200 | [diff] [blame] | 15 | # include <linux/nfsd/nfsfh.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 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 */ |
J. Bruce Fields | 9ce137e | 2011-01-11 14:07:12 -0500 | [diff] [blame] | 38 | #define NFSEXP_MSNFS 0x1000 /* do silly things that MS clients expect; no longer supported */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 39 | #define NFSEXP_FSID 0x2000 |
| 40 | #define NFSEXP_CROSSMOUNT 0x4000 |
| 41 | #define NFSEXP_NOACL 0x8000 /* reserved for possible ACL related use */ |
Steve Dickson | eb4c86c | 2009-09-09 14:58:22 -0400 | [diff] [blame] | 42 | /* |
| 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 Fields | e8e8753 | 2009-12-14 12:53:32 -0500 | [diff] [blame] | 52 | /* All flags that we claim to support. (Note we don't support NOACL.) */ |
J. Bruce Fields | 3d8986c | 2009-12-15 14:09:03 -0500 | [diff] [blame] | 53 | #define NFSEXP_ALLFLAGS 0x17E3F |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 54 | |
Andy Adamson | e677bfe | 2007-07-17 04:04:42 -0700 | [diff] [blame] | 55 | /* The flags that may vary depending on security flavor: */ |
J. Bruce Fields | 1269bc6 | 2007-07-17 04:04:52 -0700 | [diff] [blame] | 56 | #define NFSEXP_SECINFO_FLAGS (NFSEXP_READONLY | NFSEXP_ROOTSQUASH \ |
J. Bruce Fields | 12045a6e | 2009-12-08 18:15:52 -0500 | [diff] [blame] | 57 | | NFSEXP_ALLSQUASH \ |
| 58 | | NFSEXP_INSECURE_PORT) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 59 | |
| 60 | #ifdef __KERNEL__ |
| 61 | |
Manoj Naik | 93346919 | 2006-10-04 02:16:18 -0700 | [diff] [blame] | 62 | /* |
| 63 | * FS Locations |
| 64 | */ |
| 65 | |
| 66 | #define MAX_FS_LOCATIONS 128 |
| 67 | |
| 68 | struct nfsd4_fs_location { |
| 69 | char *hosts; /* colon separated list of hosts */ |
| 70 | char *path; /* slash separated list of path components */ |
| 71 | }; |
| 72 | |
| 73 | struct 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 Adamson | e677bfe | 2007-07-17 04:04:42 -0700 | [diff] [blame] | 81 | /* |
| 82 | * We keep an array of pseudoflavors with the export, in order from most |
Lucas De Marchi | 25985ed | 2011-03-30 22:57:33 -0300 | [diff] [blame] | 83 | * to least preferred. For the foreseeable future, we don't expect more |
Andy Adamson | e677bfe | 2007-07-17 04:04:42 -0700 | [diff] [blame] | 84 | * 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 | |
| 89 | struct exp_flavor_info { |
| 90 | u32 pseudoflavor; |
| 91 | u32 flags; |
| 92 | }; |
| 93 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 94 | struct svc_export { |
| 95 | struct cache_head h; |
| 96 | struct auth_domain * ex_client; |
| 97 | int ex_flags; |
Jan Blunck | 5477549 | 2008-02-14 19:38:39 -0800 | [diff] [blame] | 98 | struct path ex_path; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 99 | uid_t ex_anon_uid; |
| 100 | gid_t ex_anon_gid; |
| 101 | int ex_fsid; |
NeilBrown | af6a4e2 | 2007-02-14 00:33:12 -0800 | [diff] [blame] | 102 | unsigned char * ex_uuid; /* 16 byte fsid */ |
Manoj Naik | 93346919 | 2006-10-04 02:16:18 -0700 | [diff] [blame] | 103 | struct nfsd4_fs_locations ex_fslocs; |
Andy Adamson | e677bfe | 2007-07-17 04:04:42 -0700 | [diff] [blame] | 104 | int ex_nflavors; |
| 105 | struct exp_flavor_info ex_flavors[MAX_SECINFO_LIST]; |
Stanislav Kinsbursky | db3a353 | 2012-03-28 19:09:08 +0400 | [diff] [blame^] | 106 | struct cache_detail *cd; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 107 | }; |
| 108 | |
| 109 | /* an "export key" (expkey) maps a filehandlefragement to an |
NeilBrown | af6a4e2 | 2007-02-14 00:33:12 -0800 | [diff] [blame] | 110 | * svc_export for a given client. There can be several per export, |
| 111 | * for the different fsid types. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 112 | */ |
| 113 | struct svc_expkey { |
| 114 | struct cache_head h; |
| 115 | |
| 116 | struct auth_domain * ek_client; |
| 117 | int ek_fsidtype; |
NeilBrown | af6a4e2 | 2007-02-14 00:33:12 -0800 | [diff] [blame] | 118 | u32 ek_fsid[6]; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 119 | |
Jan Blunck | e83aece | 2008-02-14 19:38:41 -0800 | [diff] [blame] | 120 | struct path ek_path; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 121 | }; |
| 122 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 123 | #define EX_ISSYNC(exp) (!((exp)->ex_flags & NFSEXP_ASYNC)) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 124 | #define EX_NOHIDE(exp) ((exp)->ex_flags & NFSEXP_NOHIDE) |
| 125 | #define EX_WGATHER(exp) ((exp)->ex_flags & NFSEXP_GATHERED_WRITES) |
| 126 | |
J. Bruce Fields | c7d5140 | 2007-07-19 01:49:20 -0700 | [diff] [blame] | 127 | int nfsexp_flags(struct svc_rqst *rqstp, struct svc_export *exp); |
Andy Adamson | 32c1eb0 | 2007-07-17 04:04:48 -0700 | [diff] [blame] | 128 | __be32 check_nfsd_access(struct svc_export *exp, struct svc_rqst *rqstp); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 129 | |
| 130 | /* |
| 131 | * Function declarations |
| 132 | */ |
J. Bruce Fields | dbf847e | 2007-11-08 17:20:34 -0500 | [diff] [blame] | 133 | int nfsd_export_init(void); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 134 | void nfsd_export_shutdown(void); |
| 135 | void nfsd_export_flush(void); |
J. Bruce Fields | 0989a78 | 2007-07-17 04:04:44 -0700 | [diff] [blame] | 136 | struct svc_export * rqst_exp_get_by_name(struct svc_rqst *, |
Al Viro | 91c9fa8 | 2009-04-18 02:42:05 -0400 | [diff] [blame] | 137 | struct path *); |
J. Bruce Fields | 0989a78 | 2007-07-17 04:04:44 -0700 | [diff] [blame] | 138 | struct svc_export * rqst_exp_parent(struct svc_rqst *, |
Al Viro | e64c390 | 2009-04-18 03:00:46 -0400 | [diff] [blame] | 139 | struct path *); |
Trond Myklebust | ed748aa | 2011-09-12 19:37:06 -0400 | [diff] [blame] | 140 | struct svc_export * rqst_find_fsidzero_export(struct svc_rqst *); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 141 | int exp_rootfh(struct auth_domain *, |
| 142 | char *path, struct knfsd_fh *, int maxsize); |
J. Bruce Fields | df547ef | 2007-07-17 04:04:43 -0700 | [diff] [blame] | 143 | __be32 exp_pseudoroot(struct svc_rqst *, struct svc_fh *); |
Al Viro | 63f10311 | 2006-10-19 23:28:54 -0700 | [diff] [blame] | 144 | __be32 nfserrno(int errno); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 145 | |
Adrian Bunk | 74cae61 | 2006-03-27 01:15:10 -0800 | [diff] [blame] | 146 | extern struct cache_detail svc_export_cache; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 147 | |
| 148 | static inline void exp_put(struct svc_export *exp) |
| 149 | { |
NeilBrown | baab935 | 2006-03-27 01:15:09 -0800 | [diff] [blame] | 150 | cache_put(&exp->h, &svc_export_cache); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 151 | } |
| 152 | |
| 153 | static inline void exp_get(struct svc_export *exp) |
| 154 | { |
| 155 | cache_get(&exp->h); |
| 156 | } |
J. Bruce Fields | 0989a78 | 2007-07-17 04:04:44 -0700 | [diff] [blame] | 157 | struct svc_export * rqst_exp_find(struct svc_rqst *, int, u32 *); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 158 | |
| 159 | #endif /* __KERNEL__ */ |
| 160 | |
| 161 | #endif /* NFSD_EXPORT_H */ |
| 162 | |