lustre/ptlrpc/nodemap_internal.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) 2013, 2017, Intel Corporation.
  26  *
  27  * Author: Joshua Walgenbach <jjw@iu.edu>
  28  */
  29
  30 #ifndef _NODEMAP_INTERNAL_H
  31 #define _NODEMAP_INTERNAL_H
  32
  33 #include <lustre_nodemap.h>
  34 #include <interval_tree.h>
  35
  36 #define DEFAULT_NODEMAP "default"
  37
  38 /* Default nobody uid and gid values */
  39
  40 #define NODEMAP_NOBODY_UID 99
  41 #define NODEMAP_NOBODY_GID 99
  42
  43 struct lprocfs_static_vars;
  44
  45 /* nodemap root proc directory under fs/lustre */
  46 extern struct proc_dir_entry *proc_lustre_nodemap_root;
  47 /* flag if nodemap is active */
  48 extern bool nodemap_active;
  49
  50 extern struct mutex active_config_lock;
  51 extern struct nodemap_config *active_config;
  52
  53 struct lu_nid_range {
  54         /* unique id set by mgs */
  55         unsigned int             rn_id;
  56         /* lu_nodemap containing this range */
  57         struct lu_nodemap       *rn_nodemap;
  58         /* list for nodemap */
  59         struct list_head         rn_list;
  60         /* nid interval tree */
  61         struct interval_node     rn_node;
  62 };
  63
  64 struct lu_idmap {
  65         /* uid/gid of client */
  66         __u32           id_client;
  67         /* uid/gid on filesystem */
  68         __u32           id_fs;
  69         /* tree mapping client ids to filesystem ids */
  70         struct rb_node  id_client_to_fs;
  71         /* tree mappung filesystem to client */
  72         struct rb_node  id_fs_to_client;
  73 };
  74
  75 /* first 4 bits of the nodemap_id is the index type */
  76 struct nodemap_key {
  77         __u32 nk_nodemap_id;
  78         union {
  79                 __u32 nk_range_id;
  80                 __u32 nk_id_client;
  81                 __u32 nk_unused;
  82         };
  83 };
  84
  85 enum nodemap_idx_type {
  86         NODEMAP_EMPTY_IDX = 0,          /* index created with blank record */
  87         NODEMAP_CLUSTER_IDX = 1,        /* a nodemap cluster of nodes */
  88         NODEMAP_RANGE_IDX = 2,          /* nid range assigned to a nm cluster */
  89         NODEMAP_UIDMAP_IDX = 3,         /* uid map assigned to a nm cluster */
  90         NODEMAP_GIDMAP_IDX = 4,         /* gid map assigned to a nm cluster */
  91         NODEMAP_GLOBAL_IDX = 15,        /* stores nodemap activation status */
  92 };
  93
  94 #define NM_TYPE_MASK 0x0FFFFFFF
  95 #define NM_TYPE_SHIFT 28
  96
  97 static inline enum nodemap_idx_type nm_idx_get_type(unsigned int id)
  98 {
  99         return id >> NM_TYPE_SHIFT;
 100 }
 101
 102 static inline __u32 nm_idx_set_type(unsigned int id, enum nodemap_idx_type t)
 103 {
 104         return (id & NM_TYPE_MASK) | (t << NM_TYPE_SHIFT);
 105 }
 106
 107 void nodemap_config_set_active(struct nodemap_config *config);
 108 struct lu_nodemap *nodemap_create(const char *name,
 109                                   struct nodemap_config *config,
 110                                   bool is_default);
 111 void nodemap_putref(struct lu_nodemap *nodemap);
 112 struct lu_nodemap *nodemap_lookup(const char *name);
 113
 114 int nodemap_procfs_init(void);
 115 void nodemap_procfs_exit(void);
 116 int lprocfs_nodemap_register(struct lu_nodemap *nodemap,
 117                              bool is_default_nodemap);
 118 void lprocfs_nodemap_remove(struct nodemap_pde *nodemap_pde);
 119 struct lu_nid_range *nodemap_range_find(lnet_nid_t start_nid,
 120                                         lnet_nid_t end_nid);
 121 struct lu_nid_range *range_create(struct nodemap_range_tree *nm_range_tree,
 122                                   lnet_nid_t start_nid, lnet_nid_t end_nid,
 123                                   struct lu_nodemap *nodemap,
 124                                   unsigned int range_id);
 125 void range_destroy(struct lu_nid_range *range);
 126 int range_insert(struct nodemap_range_tree *nm_range_tree,
 127                  struct lu_nid_range *data);
 128 void range_delete(struct nodemap_range_tree *nm_range_tree,
 129                   struct lu_nid_range *data);
 130 struct lu_nid_range *range_search(struct nodemap_range_tree *nm_range_tree,
 131                                   lnet_nid_t nid);
 132 struct lu_nid_range *range_find(struct nodemap_range_tree *nm_range_tree,
 133                                 lnet_nid_t start_nid, lnet_nid_t end_nid);
 134 int range_parse_nidstring(char *range_string, lnet_nid_t *start_nid,
 135                           lnet_nid_t *end_nid);
 136 void range_init_tree(void);
 137 struct lu_idmap *idmap_create(__u32 client_id, __u32 fs_id);
 138 struct lu_idmap *idmap_insert(enum nodemap_id_type id_type,
 139                               struct lu_idmap *idmap,
 140                               struct lu_nodemap *nodemap);
 141 void idmap_delete(enum nodemap_id_type id_type,  struct lu_idmap *idmap,
 142                   struct lu_nodemap *nodemap);
 143 void idmap_delete_tree(struct lu_nodemap *nodemap);
 144 struct lu_idmap *idmap_search(struct lu_nodemap *nodemap,
 145                               enum nodemap_tree_type,
 146                               enum nodemap_id_type id_type,
 147                               __u32 id);
 148 int nm_member_add(struct lu_nodemap *nodemap, struct obd_export *exp);
 149 void nm_member_del(struct lu_nodemap *nodemap, struct obd_export *exp);
 150 void nm_member_delete_list(struct lu_nodemap *nodemap);
 151 struct lu_nodemap *nodemap_classify_nid(lnet_nid_t nid);
 152 void nm_member_reclassify_nodemap(struct lu_nodemap *nodemap);
 153 void nm_member_revoke_locks(struct lu_nodemap *nodemap);
 154 void nm_member_revoke_locks_always(struct lu_nodemap *nodemap);
 155 void nm_member_revoke_all(void);
 156
 157 int nodemap_add_idmap_helper(struct lu_nodemap *nodemap,
 158                              enum nodemap_id_type id_type,
 159                              const __u32 map[2]);
 160 int nodemap_add_range_helper(struct nodemap_config *config,
 161                              struct lu_nodemap *nodemap,
 162                              const lnet_nid_t nid[2],
 163                              unsigned int range_id);
 164
 165 struct rb_node *nm_rb_next_postorder(const struct rb_node *node);
 166 struct rb_node *nm_rb_first_postorder(const struct rb_root *root);
 167 void nodemap_getref(struct lu_nodemap *nodemap);
 168 void nodemap_putref(struct lu_nodemap *nodemap);
 169 int nm_hash_list_cb(struct cfs_hash *hs, struct cfs_hash_bd *bd,
 170                     struct hlist_node *hnode,
 171                     void *nodemap_list_head);
 172
 173 #define nm_rbtree_postorder_for_each_entry_safe(pos, n,                 \
 174                                                 root, field)            \
 175         for (pos = nm_rb_first_postorder(root) ?                        \
 176                 rb_entry(nm_rb_first_postorder(root), typeof(*pos),     \
 177                 field) : NULL,                                          \
 178                 n = (pos && nm_rb_next_postorder(&pos->field)) ?        \
 179                 rb_entry(nm_rb_next_postorder(&pos->field),             \
 180                 typeof(*pos), field) : NULL;                            \
 181                 pos != NULL;                                            \
 182                 pos = n,                                                \
 183                 n = (pos && nm_rb_next_postorder(&pos->field)) ?        \
 184                 rb_entry(nm_rb_next_postorder(&pos->field),             \
 185                 typeof(*pos), field) : NULL)
 186
 187 int nodemap_idx_nodemap_add(const struct lu_nodemap *nodemap);
 188 int nodemap_idx_nodemap_update(const struct lu_nodemap *nodemap);
 189 int nodemap_idx_nodemap_del(const struct lu_nodemap *nodemap);
 190 int nodemap_idx_idmap_add(const struct lu_nodemap *nodemap,
 191                           enum nodemap_id_type id_type,
 192                           const __u32 map[2]);
 193 int nodemap_idx_idmap_del(const struct lu_nodemap *nodemap,
 194                           enum nodemap_id_type id_type,
 195                           const __u32 map[2]);
 196 int nodemap_idx_range_add(const struct lu_nid_range *range,
 197                           const lnet_nid_t nid[2]);
 198 int nodemap_idx_range_del(const struct lu_nid_range *range);
 199 int nodemap_idx_nodemap_activate(bool value);
 200 #endif  /* _NODEMAP_INTERNAL_H */