4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
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.
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).
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
23 * Copyright (C) 2013, Trustees of Indiana University
25 * Copyright (c) 2013, 2014, Intel Corporation.
27 * Author: Joshua Walgenbach <jjw@iu.edu>
30 #ifndef _NODEMAP_INTERNAL_H
31 #define _NODEMAP_INTERNAL_H
33 #include <lustre_nodemap.h>
34 #include <interval_tree.h>
36 #define DEFAULT_NODEMAP "default"
38 /* Default nobody uid and gid values */
40 #define NODEMAP_NOBODY_UID 99
41 #define NODEMAP_NOBODY_GID 99
43 struct lprocfs_static_vars;
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;
50 extern struct mutex active_config_lock;
51 extern struct nodemap_config *active_config;
54 /* unique id set by mgs */
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;
65 /* uid/gid of client */
67 /* uid/gid on filesystem */
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;
75 struct nodemap_range_tree {
76 struct interval_node *nmrt_range_interval_root;
77 unsigned int nmrt_range_highest_id;
80 struct nodemap_config {
81 /* Highest numerical lu_nodemap.nm_id defined */
82 unsigned int nmc_nodemap_highest_id;
84 /* Simple flag to determine if nodemaps are active */
85 bool nmc_nodemap_is_active;
87 /* Pointer to default nodemap as it is needed more often */
88 struct lu_nodemap *nmc_default_nodemap;
91 * Lock required to access the range tree.
93 struct rw_semaphore nmc_range_tree_lock;
94 struct nodemap_range_tree nmc_range_tree;
97 * Hash keyed on nodemap name containing all
100 struct cfs_hash *nmc_nodemap_hash;
103 /* first 4 bits of the nodemap_id is the index type */
113 enum nodemap_idx_type {
114 NODEMAP_EMPTY_IDX = 0, /* index created with blank record */
115 NODEMAP_CLUSTER_IDX = 1, /* a nodemap cluster of nodes */
116 NODEMAP_RANGE_IDX = 2, /* nid range assigned to a nm cluster */
117 NODEMAP_UIDMAP_IDX = 3, /* uid map assigned to a nm cluster */
118 NODEMAP_GIDMAP_IDX = 4, /* gid map assigned to a nm cluster */
119 NODEMAP_GLOBAL_IDX = 15, /* stores nodemap activation status */
122 #define NM_TYPE_MASK 0x0FFFFFFF
123 #define NM_TYPE_SHIFT 28
125 static inline enum nodemap_idx_type nm_idx_get_type(unsigned int id)
127 return id >> NM_TYPE_SHIFT;
130 static inline __u32 nm_idx_set_type(unsigned int id, enum nodemap_idx_type t)
132 return (id & NM_TYPE_MASK) | (t << NM_TYPE_SHIFT);
135 struct nodemap_config *nodemap_config_alloc(void);
136 void nodemap_config_dealloc(struct nodemap_config *config);
137 void nodemap_config_set_active(struct nodemap_config *config);
138 struct lu_nodemap *nodemap_create(const char *name,
139 struct nodemap_config *config,
141 void nodemap_putref(struct lu_nodemap *nodemap);
142 struct lu_nodemap *nodemap_lookup(const char *name);
144 int nodemap_procfs_init(void);
145 void nodemap_procfs_exit(void);
146 int lprocfs_nodemap_register(struct lu_nodemap *nodemap,
147 bool is_default_nodemap);
148 void lprocfs_nodemap_remove(struct nodemap_pde *nodemap_pde);
149 struct lu_nid_range *nodemap_range_find(lnet_nid_t start_nid,
151 struct lu_nid_range *range_create(struct nodemap_range_tree *nm_range_tree,
152 lnet_nid_t start_nid, lnet_nid_t end_nid,
153 struct lu_nodemap *nodemap,
154 unsigned int range_id);
155 void range_destroy(struct lu_nid_range *range);
156 int range_insert(struct nodemap_range_tree *nm_range_tree,
157 struct lu_nid_range *data);
158 void range_delete(struct nodemap_range_tree *nm_range_tree,
159 struct lu_nid_range *data);
160 struct lu_nid_range *range_search(struct nodemap_range_tree *nm_range_tree,
162 struct lu_nid_range *range_find(struct nodemap_range_tree *nm_range_tree,
163 lnet_nid_t start_nid, lnet_nid_t end_nid);
164 int range_parse_nidstring(char *range_string, lnet_nid_t *start_nid,
165 lnet_nid_t *end_nid);
166 void range_init_tree(void);
167 struct lu_idmap *idmap_create(__u32 client_id, __u32 fs_id);
168 void idmap_insert(enum nodemap_id_type id_type, struct lu_idmap *idmap,
169 struct lu_nodemap *nodemap);
170 void idmap_delete(enum nodemap_id_type id_type, struct lu_idmap *idmap,
171 struct lu_nodemap *nodemap);
172 void idmap_delete_tree(struct lu_nodemap *nodemap);
173 struct lu_idmap *idmap_search(struct lu_nodemap *nodemap,
174 enum nodemap_tree_type,
175 enum nodemap_id_type id_type,
177 int nm_member_add(struct lu_nodemap *nodemap, struct obd_export *exp);
178 void nm_member_del(struct lu_nodemap *nodemap, struct obd_export *exp);
179 void nm_member_delete_list(struct lu_nodemap *nodemap);
180 struct lu_nodemap *nodemap_classify_nid(lnet_nid_t nid);
181 void nm_member_reclassify_nodemap(struct lu_nodemap *nodemap);
182 void nm_member_revoke_locks(struct lu_nodemap *nodemap);
183 void nm_member_revoke_all(void);
185 int nodemap_add_idmap_helper(struct lu_nodemap *nodemap,
186 enum nodemap_id_type id_type,
188 int nodemap_add_range_helper(struct nodemap_config *config,
189 struct lu_nodemap *nodemap,
190 const lnet_nid_t nid[2],
191 unsigned int range_id);
193 struct rb_node *nm_rb_next_postorder(const struct rb_node *node);
194 struct rb_node *nm_rb_first_postorder(const struct rb_root *root);
195 void nodemap_putref(struct lu_nodemap *nodemap);
197 #define nm_rbtree_postorder_for_each_entry_safe(pos, n, \
199 for (pos = nm_rb_first_postorder(root) ? \
200 rb_entry(nm_rb_first_postorder(root), typeof(*pos), \
202 n = (pos && nm_rb_next_postorder(&pos->field)) ? \
203 rb_entry(nm_rb_next_postorder(&pos->field), \
204 typeof(*pos), field) : NULL; \
207 n = (pos && nm_rb_next_postorder(&pos->field)) ? \
208 rb_entry(nm_rb_next_postorder(&pos->field), \
209 typeof(*pos), field) : NULL)
211 int nodemap_idx_nodemap_add(const struct lu_nodemap *nodemap);
212 int nodemap_idx_nodemap_update(const struct lu_nodemap *nodemap);
213 int nodemap_idx_nodemap_del(const struct lu_nodemap *nodemap);
214 int nodemap_idx_idmap_add(const struct lu_nodemap *nodemap,
215 enum nodemap_id_type id_type,
217 int nodemap_idx_idmap_del(const struct lu_nodemap *nodemap,
218 enum nodemap_id_type id_type,
220 int nodemap_idx_range_add(const struct lu_nid_range *range,
221 const lnet_nid_t nid[2]);
222 int nodemap_idx_range_del(const struct lu_nid_range *range);
223 int nodemap_idx_nodemap_activate(bool value);
224 #endif /* _NODEMAP_INTERNAL_H */