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_disk.h>
  34
  35 #define LUSTRE_NODEMAP_NAME "nodemap"
  36
  37 #define LUSTRE_NODEMAP_DEFAULT_ID 0
  38
  39 static const struct nodemap_rbac_name {
  40         enum nodemap_rbac_roles nrn_mode;
  41         const char             *nrn_name;
  42 } nodemap_rbac_names[] = {
  43         { NODEMAP_RBAC_FILE_PERMS,      "file_perms"    },
  44         { NODEMAP_RBAC_DNE_OPS,         "dne_ops"       },
  45         { NODEMAP_RBAC_QUOTA_OPS,       "quota_ops"     },
  46         { NODEMAP_RBAC_BYFID_OPS,       "byfid_ops"     },
  47         { NODEMAP_RBAC_CHLG_OPS,        "chlg_ops"      },
  48         { NODEMAP_RBAC_FSCRYPT_ADMIN,   "fscrypt_admin" },
  49 };
  50
  51 struct nodemap_pde {
  52         char                     npe_name[LUSTRE_NODEMAP_NAME_LENGTH + 1];
  53         struct proc_dir_entry   *npe_proc_entry;
  54         struct list_head         npe_list_member;
  55 };
  56
  57 /** The nodemap id 0 will be the default nodemap. It will have a configuration
  58  * set by the MGS, but no ranges will be allowed as all NIDs that do not map
  59  * will be added to the default nodemap
  60  */
  61
  62 struct lu_nodemap {
  63         /* human readable ID */
  64         char                     nm_name[LUSTRE_NODEMAP_NAME_LENGTH + 1];
  65         /* flags to govern nodemap behavior */
  66         bool                     nmf_trust_client_ids:1,
  67                                  nmf_deny_unknown:1,
  68                                  nmf_allow_root_access:1,
  69                                  nmf_enable_audit:1,
  70                                  nmf_forbid_encryption:1,
  71                                  nmf_readonly_mount:1;
  72         /* bitmap for mapping type */
  73         enum nodemap_mapping_modes nmf_map_mode;
  74         /* bitmap for rbac, enum nodemap_rbac_roles */
  75         enum nodemap_rbac_roles  nmf_rbac;
  76         /* unique ID set by MGS */
  77         unsigned int             nm_id;
  78         /* nodemap ref counter */
  79         atomic_t                 nm_refcount;
  80         /* UID to squash unmapped UIDs */
  81         uid_t                    nm_squash_uid;
  82         /* GID to squash unmapped GIDs */
  83         gid_t                    nm_squash_gid;
  84         /* PROJID to squash unmapped PROJIDs */
  85         projid_t                 nm_squash_projid;
  86         /* NID range list */
  87         struct list_head         nm_ranges;
  88         /* lock for idmap red/black trees */
  89         struct rw_semaphore      nm_idmap_lock;
  90         /* UID map keyed by local UID */
  91         struct rb_root           nm_fs_to_client_uidmap;
  92         /* UID map keyed by remote UID */
  93         struct rb_root           nm_client_to_fs_uidmap;
  94         /* GID map keyed by local UID */
  95         struct rb_root           nm_fs_to_client_gidmap;
  96         /* GID map keyed by remote UID */
  97         struct rb_root           nm_client_to_fs_gidmap;
  98         /* PROJID map keyed by local UID */
  99         struct rb_root           nm_fs_to_client_projidmap;
 100         /* PROJID map keyed by remote UID */
 101         struct rb_root           nm_client_to_fs_projidmap;
 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(struct lnet_nid *nid, struct obd_export *exp);
 131 void nodemap_del_member(struct obd_export *exp);
 132 int nodemap_parse_range(const char *range_string, struct lnet_nid range[2],
 133                         u8 *netmask);
 134 int nodemap_parse_idmap(char *idmap_string, __u32 idmap[2]);
 135 int nodemap_add_range(const char *name, const struct lnet_nid nid[2],
 136                       u8 netmask);
 137 int nodemap_del_range(const char *name, const struct lnet_nid nid[2],
 138                       u8 netmask);
 139 int nodemap_set_allow_root(const char *name, bool allow_root);
 140 int nodemap_set_trust_client_ids(const char *name, bool trust_client_ids);
 141 int nodemap_set_deny_unknown(const char *name, bool deny_unknown);
 142 int nodemap_set_mapping_mode(const char *name,
 143                              enum nodemap_mapping_modes map_mode);
 144 int nodemap_set_rbac(const char *name, enum nodemap_rbac_roles rbac);
 145 int nodemap_set_squash_uid(const char *name, uid_t uid);
 146 int nodemap_set_squash_gid(const char *name, gid_t gid);
 147 int nodemap_set_squash_projid(const char *name, projid_t projid);
 148 int nodemap_set_audit_mode(const char *name, bool enable_audit);
 149 int nodemap_set_forbid_encryption(const char *name, bool forbid_encryption);
 150 int nodemap_set_readonly_mount(const char *name, bool readonly_mount);
 151 bool nodemap_can_setquota(struct lu_nodemap *nodemap, __u32 qc_type, __u32 id);
 152 int nodemap_add_idmap(const char *name, enum nodemap_id_type id_type,
 153                       const __u32 map[2]);
 154 int nodemap_del_idmap(const char *name, enum nodemap_id_type id_type,
 155                       const __u32 map[2]);
 156 int nodemap_set_fileset(const char *name, const char *fileset);
 157 char *nodemap_get_fileset(const struct lu_nodemap *nodemap);
 158 int nodemap_set_sepol(const char *name, const char *sepol);
 159 const char *nodemap_get_sepol(const struct lu_nodemap *nodemap);
 160 __u32 nodemap_map_id(struct lu_nodemap *nodemap,
 161                      enum nodemap_id_type id_type,
 162                      enum nodemap_tree_type tree_type, __u32 id);
 163 ssize_t nodemap_map_acl(struct lu_nodemap *nodemap, void *buf, size_t size,
 164                         enum nodemap_tree_type tree_type);
 165 #ifdef HAVE_SERVER_SUPPORT
 166 void nodemap_test_nid(struct lnet_nid *nid, char *name_buf, size_t name_len);
 167 #else
 168 #define nodemap_test_nid(nid, name_buf, name_len) do {} while(0)
 169 #endif
 170 int nodemap_test_id(struct lnet_nid *nid, enum nodemap_id_type idtype,
 171                     u32 client_id, u32 *fs_id);
 172
 173 struct nm_config_file *nm_config_file_register_mgs(const struct lu_env *env,
 174                                                    struct dt_object *obj,
 175                                                    struct local_oid_storage *los);
 176 struct dt_device;
 177 struct nm_config_file *nm_config_file_register_tgt(const struct lu_env *env,
 178                                                    struct dt_device *dev,
 179                                                    struct local_oid_storage *los);
 180 void nm_config_file_deregister_mgs(const struct lu_env *env,
 181                                    struct nm_config_file *ncf);
 182 void nm_config_file_deregister_tgt(const struct lu_env *env,
 183                                    struct nm_config_file *ncf);
 184 struct lu_nodemap *nodemap_get_from_exp(struct obd_export *exp);
 185 void nodemap_putref(struct lu_nodemap *nodemap);
 186
 187 #ifdef HAVE_SERVER_SUPPORT
 188
 189 struct nodemap_range_tree {
 190         struct interval_tree_root nmrt_range_interval_root;
 191         unsigned int nmrt_range_highest_id;
 192 };
 193
 194 struct nodemap_config {
 195         /* Highest numerical lu_nodemap.nm_id defined */
 196         unsigned int nmc_nodemap_highest_id;
 197
 198         /* Simple flag to determine if nodemaps are active */
 199         bool nmc_nodemap_is_active;
 200
 201         /* Pointer to default nodemap as it is needed more often */
 202         struct lu_nodemap *nmc_default_nodemap;
 203
 204         /* list of netmask + address prefix */
 205         struct list_head nmc_netmask_setup;
 206
 207         /**
 208          * Lock required to access the range tree.
 209          */
 210         struct rw_semaphore nmc_range_tree_lock;
 211         struct nodemap_range_tree nmc_range_tree;
 212
 213         /**
 214          * Hash keyed on nodemap name containing all
 215          * nodemaps
 216          */
 217         struct cfs_hash *nmc_nodemap_hash;
 218 };
 219
 220 struct nodemap_config *nodemap_config_alloc(void);
 221 void nodemap_config_dealloc(struct nodemap_config *config);
 222 void nodemap_config_set_active_mgc(struct nodemap_config *config);
 223
 224 int nodemap_process_idx_pages(struct nodemap_config *config, union lu_page *lip,
 225                               struct lu_nodemap **recent_nodemap);
 226
 227 #else /* disable nodemap processing in MGC of non-servers */
 228 static inline int nodemap_process_idx_pages(void *config,
 229                                             union lu_page *lip,
 230                                             struct lu_nodemap **recent_nodemap)
 231 { return 0; }
 232 #endif /* HAVE_SERVER_SUPPORT */
 233
 234 int nodemap_get_config_req(struct obd_device *mgs_obd,
 235                            struct ptlrpc_request *req);
 236 #endif  /* _LUSTRE_NODEMAP_H */