include/linux/nfsd/export.h

   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
  13 #include <asm/types.h>
  14 #ifdef __KERNEL__
  15 # include <linux/types.h>
  16 # include <linux/in.h>
  17 #endif
  18
  19 /*
  20  * Important limits for the exports stuff.
  21  */
  22 #define NFSCLNT_IDMAX           1024
  23 #define NFSCLNT_ADDRMAX         16
  24 #define NFSCLNT_KEYMAX          32
  25
  26 /*
  27  * Export flags.
  28  */
  29 #define NFSEXP_READONLY         0x0001
  30 #define NFSEXP_INSECURE_PORT    0x0002
  31 #define NFSEXP_ROOTSQUASH       0x0004
  32 #define NFSEXP_ALLSQUASH        0x0008
  33 #define NFSEXP_ASYNC            0x0010
  34 #define NFSEXP_GATHERED_WRITES  0x0020
  35 /* 40 80 100 currently unused */
  36 #define NFSEXP_NOHIDE           0x0200
  37 #define NFSEXP_NOSUBTREECHECK   0x0400
  38 #define NFSEXP_NOAUTHNLM        0x0800          /* Don't authenticate NLM requests - just trust */
  39 #define NFSEXP_MSNFS            0x1000  /* do silly things that MS clients expect */
  40 #define NFSEXP_FSID             0x2000
  41 #define NFSEXP_CROSSMOUNT       0x4000
  42 #define NFSEXP_NOACL            0x8000  /* reserved for possible ACL related use */
  43 #define NFSEXP_ALLFLAGS         0xFE3F
  44
  45 /* The flags that may vary depending on security flavor: */
  46 #define NFSEXP_SECINFO_FLAGS    0
  47
  48 #ifdef __KERNEL__
  49
  50 /*
  51  * FS Locations
  52  */
  53
  54 #define MAX_FS_LOCATIONS        128
  55
  56 struct nfsd4_fs_location {
  57         char *hosts; /* colon separated list of hosts */
  58         char *path;  /* slash separated list of path components */
  59 };
  60
  61 struct 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
  69 /*
  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
  77 struct exp_flavor_info {
  78         u32     pseudoflavor;
  79         u32     flags;
  80 };
  81
  82 struct svc_export {
  83         struct cache_head       h;
  84         struct auth_domain *    ex_client;
  85         int                     ex_flags;
  86         struct vfsmount *       ex_mnt;
  87         struct dentry *         ex_dentry;
  88         char *                  ex_path;
  89         uid_t                   ex_anon_uid;
  90         gid_t                   ex_anon_gid;
  91         int                     ex_fsid;
  92         unsigned char *         ex_uuid; /* 16 byte fsid */
  93         struct nfsd4_fs_locations ex_fslocs;
  94         int                     ex_nflavors;
  95         struct exp_flavor_info  ex_flavors[MAX_SECINFO_LIST];
  96 };
  97
  98 /* an "export key" (expkey) maps a filehandlefragement to an
  99  * svc_export for a given client.  There can be several per export,
 100  * for the different fsid types.
 101  */
 102 struct svc_expkey {
 103         struct cache_head       h;
 104
 105         struct auth_domain *    ek_client;
 106         int                     ek_fsidtype;
 107         u32                     ek_fsid[6];
 108
 109         struct vfsmount *       ek_mnt;
 110         struct dentry *         ek_dentry;
 111 };
 112
 113 #define EX_SECURE(exp)          (!((exp)->ex_flags & NFSEXP_INSECURE_PORT))
 114 #define EX_ISSYNC(exp)          (!((exp)->ex_flags & NFSEXP_ASYNC))
 115 #define EX_RDONLY(exp)          ((exp)->ex_flags & NFSEXP_READONLY)
 116 #define EX_NOHIDE(exp)          ((exp)->ex_flags & NFSEXP_NOHIDE)
 117 #define EX_WGATHER(exp)         ((exp)->ex_flags & NFSEXP_GATHERED_WRITES)
 118
 119
 120 /*
 121  * Function declarations
 122  */
 123 void                    nfsd_export_init(void);
 124 void                    nfsd_export_shutdown(void);
 125 void                    nfsd_export_flush(void);
 126 void                    exp_readlock(void);
 127 void                    exp_readunlock(void);
 128 struct svc_export *     exp_get_by_name(struct auth_domain *clp,
 129                                         struct vfsmount *mnt,
 130                                         struct dentry *dentry,
 131                                         struct cache_req *reqp);
 132 struct svc_export *     rqst_exp_get_by_name(struct svc_rqst *,
 133                                              struct vfsmount *,
 134                                              struct dentry *);
 135 struct svc_export *     exp_parent(struct auth_domain *clp,
 136                                    struct vfsmount *mnt,
 137                                    struct dentry *dentry,
 138                                    struct cache_req *reqp);
 139 struct svc_export *     rqst_exp_parent(struct svc_rqst *,
 140                                         struct vfsmount *mnt,
 141                                         struct dentry *dentry);
 142 int                     exp_rootfh(struct auth_domain *,
 143                                         char *path, struct knfsd_fh *, int maxsize);
 144 __be32                  exp_pseudoroot(struct svc_rqst *, struct svc_fh *);
 145 __be32                  nfserrno(int errno);
 146
 147 extern struct cache_detail svc_export_cache;
 148
 149 static inline void exp_put(struct svc_export *exp)
 150 {
 151         cache_put(&exp->h, &svc_export_cache);
 152 }
 153
 154 static inline void exp_get(struct svc_export *exp)
 155 {
 156         cache_get(&exp->h);
 157 }
 158 extern struct svc_export *
 159 exp_find(struct auth_domain *clp, int fsid_type, u32 *fsidv,
 160          struct cache_req *reqp);
 161 struct svc_export * rqst_exp_find(struct svc_rqst *, int, u32 *);
 162
 163 #endif /* __KERNEL__ */
 164
 165 #endif /* NFSD_EXPORT_H */
 166