lustre/include/lustre_nodemap.h

   1 /*
   2  * GPL HEADER START
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License version 2 only,
   8  * as published by the Free Software Foundation.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * General Public License version 2 for more details (a copy is included
  14  * in the LICENSE file that accompanied this code).
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * version 2 along with this program; If not, see
  18  * http://www.gnu.org/licenses/gpl-2.0.html
  19  *
  20  * GPL HEADER END
  21  */
  22 /*
  23  * Copyright (C) 2013, Trustees of Indiana University
  24  *
  25  * Copyright (c) 2017, Intel Corporation.
  26  *
  27  * Author: Joshua Walgenbach <jjw@iu.edu>
  28  */
  29
  30 #ifndef _LUSTRE_NODEMAP_H
  31 #define _LUSTRE_NODEMAP_H
  32
  33 #include <uapi/linux/lustre/lustre_idl.h>
  34
  35 #define LUSTRE_NODEMAP_NAME "nodemap"
  36
  37 #define LUSTRE_NODEMAP_DEFAULT_ID 0
  38
  39 /** enums containing the types of ids contained in a nodemap
  40  * kept so other modules (mgs, mdt, etc) can define the type
  41  * of search easily
  42  */
  43
  44 enum nodemap_id_type {
  45         NODEMAP_UID,
  46         NODEMAP_GID,
  47 };
  48
  49 enum nodemap_tree_type {
  50         NODEMAP_FS_TO_CLIENT,
  51         NODEMAP_CLIENT_TO_FS,
  52 };
  53
  54 enum nodemap_mapping_modes {
  55         NODEMAP_MAP_BOTH,
  56         NODEMAP_MAP_UID_ONLY,
  57         NODEMAP_MAP_GID_ONLY,
  58 };
  59
  60 struct nodemap_pde {
  61         char                     npe_name[LUSTRE_NODEMAP_NAME_LENGTH + 1];
  62         struct proc_dir_entry   *npe_proc_entry;
  63         struct list_head         npe_list_member;
  64 };
  65
  66 /** The nodemap id 0 will be the default nodemap. It will have a configuration
  67  * set by the MGS, but no ranges will be allowed as all NIDs that do not map
  68  * will be added to the default nodemap
  69  */
  70
  71 struct lu_nodemap {
  72         /* human readable ID */
  73         char                     nm_name[LUSTRE_NODEMAP_NAME_LENGTH + 1];
  74         /* flags to govern nodemap behavior */
  75         bool                     nmf_trust_client_ids:1,
  76                                  nmf_deny_unknown:1,
  77                                  nmf_allow_root_access:1,
  78                                  nmf_map_uid_only:1,
  79                                  nmf_map_gid_only:1,
  80                                  nmf_enable_audit:1,
  81                                  nmf_forbid_encryption:1;
  82         /* unique ID set by MGS */
  83         unsigned int             nm_id;
  84         /* nodemap ref counter */
  85         atomic_t                 nm_refcount;
  86         /* UID to squash unmapped UIDs */
  87         uid_t                    nm_squash_uid;
  88         /* GID to squash unmapped GIDs */
  89         gid_t                    nm_squash_gid;
  90         /* NID range list */
  91         struct list_head         nm_ranges;
  92         /* lock for idmap red/black trees */
  93         struct rw_semaphore      nm_idmap_lock;
  94         /* UID map keyed by local UID */
  95         struct rb_root           nm_fs_to_client_uidmap;
  96         /* UID map keyed by remote UID */
  97         struct rb_root           nm_client_to_fs_uidmap;
  98         /* GID map keyed by local UID */
  99         struct rb_root           nm_fs_to_client_gidmap;
 100         /* GID map keyed by remote UID */
 101         struct rb_root           nm_client_to_fs_gidmap;
 102         /* attached client members of this nodemap */
 103         struct mutex             nm_member_list_lock;
 104         struct list_head         nm_member_list;
 105         /* access by nodemap name */
 106         struct hlist_node        nm_hash;
 107         struct nodemap_pde      *nm_pde_data;
 108         /* fileset the nodes of this nodemap are restricted to */
 109         char                     nm_fileset[PATH_MAX+1];
 110         /* information about the expected SELinux policy on the nodes */
 111         char                     nm_sepol[LUSTRE_NODEMAP_SEPOL_LENGTH + 1];
 112
 113         /* used when loading/unloading nodemaps */
 114         struct list_head         nm_list;
 115 };
 116
 117 /* Store handles to local MGC storage to save config locally. In future
 118  * versions of nodemap, mgc will receive the config directly and so this might
 119  * not be needed.
 120  */
 121 struct nm_config_file {
 122         struct local_oid_storage        *ncf_los;
 123         struct dt_object                *ncf_obj;
 124         struct list_head                 ncf_list;
 125 };
 126
 127 void nodemap_activate(const bool value);
 128 int nodemap_add(const char *nodemap_name);
 129 int nodemap_del(const char *nodemap_name);
 130 int nodemap_add_member(lnet_nid_t nid, struct obd_export *exp);
 131 void nodemap_del_member(struct obd_export *exp);
 132 int nodemap_parse_range(const char *range_string, lnet_nid_t range[2]);
 133 int nodemap_parse_idmap(char *idmap_string, __u32 idmap[2]);
 134 int nodemap_add_range(const char *name, const lnet_nid_t nid[2]);
 135 int nodemap_del_range(const char *name, const lnet_nid_t nid[2]);
 136 int nodemap_set_allow_root(const char *name, bool allow_root);
 137 int nodemap_set_trust_client_ids(const char *name, bool trust_client_ids);
 138 int nodemap_set_deny_unknown(const char *name, bool deny_unknown);
 139 int nodemap_set_mapping_mode(const char *name, enum nodemap_mapping_modes mode);
 140 int nodemap_set_squash_uid(const char *name, uid_t uid);
 141 int nodemap_set_squash_gid(const char *name, gid_t gid);
 142 int nodemap_set_audit_mode(const char *name, bool enable_audit);
 143 int nodemap_set_forbid_encryption(const char *name, bool forbid_encryption);
 144 bool nodemap_can_setquota(const struct lu_nodemap *nodemap);
 145 int nodemap_add_idmap(const char *name, enum nodemap_id_type id_type,
 146                       const __u32 map[2]);
 147 int nodemap_del_idmap(const char *name, enum nodemap_id_type id_type,
 148                       const __u32 map[2]);
 149 int nodemap_set_fileset(const char *name, const char *fileset);
 150 char *nodemap_get_fileset(const struct lu_nodemap *nodemap);
 151 int nodemap_set_sepol(const char *name, const char *sepol);
 152 const char *nodemap_get_sepol(const struct lu_nodemap *nodemap);
 153 __u32 nodemap_map_id(struct lu_nodemap *nodemap,
 154                      enum nodemap_id_type id_type,
 155                      enum nodemap_tree_type tree_type, __u32 id);
 156 ssize_t nodemap_map_acl(struct lu_nodemap *nodemap, void *buf, size_t size,
 157                         enum nodemap_tree_type tree_type);
 158 #ifdef HAVE_SERVER_SUPPORT
 159 void nodemap_test_nid(lnet_nid_t nid, char *name_buf, size_t name_len);
 160 #else
 161 #define nodemap_test_nid(nid, name_buf, name_len) do {} while(0)
 162 #endif
 163 int nodemap_test_id(lnet_nid_t nid, enum nodemap_id_type idtype,
 164                     __u32 client_id, __u32 *fs_id);
 165
 166 struct nm_config_file *nm_config_file_register_mgs(const struct lu_env *env,
 167                                                    struct dt_object *obj,
 168                                                    struct local_oid_storage *los);
 169 struct dt_device;
 170 struct nm_config_file *nm_config_file_register_tgt(const struct lu_env *env,
 171                                                    struct dt_device *dev,
 172                                                    struct local_oid_storage *los);
 173 void nm_config_file_deregister_mgs(const struct lu_env *env,
 174                                    struct nm_config_file *ncf);
 175 void nm_config_file_deregister_tgt(const struct lu_env *env,
 176                                    struct nm_config_file *ncf);
 177 struct lu_nodemap *nodemap_get_from_exp(struct obd_export *exp);
 178 void nodemap_putref(struct lu_nodemap *nodemap);
 179
 180 #ifdef HAVE_SERVER_SUPPORT
 181
 182 struct nodemap_range_tree {
 183         struct interval_tree_root nmrt_range_interval_root;
 184         unsigned int nmrt_range_highest_id;
 185 };
 186
 187 struct nodemap_config {
 188         /* Highest numerical lu_nodemap.nm_id defined */
 189         unsigned int nmc_nodemap_highest_id;
 190
 191         /* Simple flag to determine if nodemaps are active */
 192         bool nmc_nodemap_is_active;
 193
 194         /* Pointer to default nodemap as it is needed more often */
 195         struct lu_nodemap *nmc_default_nodemap;
 196
 197         /**
 198          * Lock required to access the range tree.
 199          */
 200         struct rw_semaphore nmc_range_tree_lock;
 201         struct nodemap_range_tree nmc_range_tree;
 202
 203         /**
 204          * Hash keyed on nodemap name containing all
 205          * nodemaps
 206          */
 207         struct cfs_hash *nmc_nodemap_hash;
 208 };
 209
 210 struct nodemap_config *nodemap_config_alloc(void);
 211 void nodemap_config_dealloc(struct nodemap_config *config);
 212 void nodemap_config_set_active_mgc(struct nodemap_config *config);
 213
 214 int nodemap_process_idx_pages(struct nodemap_config *config, union lu_page *lip,
 215                               struct lu_nodemap **recent_nodemap);
 216
 217 #else /* disable nodemap processing in MGC of non-servers */
 218 static inline int nodemap_process_idx_pages(void *config,
 219                                             union lu_page *lip,
 220                                             struct lu_nodemap **recent_nodemap)
 221 { return 0; }
 222 #endif /* HAVE_SERVER_SUPPORT */
 223
 224 int nodemap_get_config_req(struct obd_device *mgs_obd,
 225                            struct ptlrpc_request *req);
 226 #endif  /* _LUSTRE_NODEMAP_H */