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) 2015, Trustees of Indiana University
25 * Copyright (c) 2017, Intel Corporation.
27 * Author: Joshua Walgenbach <jjw@iu.edu>
28 * Author: Kit Westneat <cwestnea@iu.edu>
30 * Implements the storage functionality for the nodemap configuration. Functions
31 * in this file prepare, store, and load nodemap configuration data. Targets
32 * using nodemap services should register a configuration file object. Nodemap
33 * configuration changes that need to persist should call the appropriate
34 * storage function for the data being modified.
36 * There are several index types as defined in enum nodemap_idx_type:
37 * NODEMAP_CLUSTER_IDX stores the data found on the lu_nodemap struct,
38 * like root squash and config flags, as well as
40 * NODEMAP_RANGE_IDX stores NID range information for a nodemap
41 * NODEMAP_UIDMAP_IDX stores a fs/client UID mapping pair
42 * NODEMAP_GIDMAP_IDX stores a fs/client GID mapping pair
43 * NODEMAP_GLOBAL_IDX stores whether or not nodemaps are active
46 #include <libcfs/libcfs.h>
47 #include <linux/err.h>
48 #include <linux/kernel.h>
49 #include <linux/list.h>
50 #include <linux/mutex.h>
51 #include <linux/string.h>
52 #include <linux/types.h>
53 #include <uapi/linux/lnet/lnet-types.h>
54 #include <uapi/linux/lustre/lustre_idl.h>
55 #include <dt_object.h>
56 #include <lu_object.h>
57 #include <lustre_net.h>
58 #include <lustre_nodemap.h>
59 #include <obd_class.h>
60 #include <obd_support.h>
61 #include "nodemap_internal.h"
63 /* list of registered nodemap index files, except MGS */
64 static LIST_HEAD(ncf_list_head);
65 static DEFINE_MUTEX(ncf_list_lock);
67 /* MGS index is different than others, others are listeners to MGS idx */
68 static struct nm_config_file *nodemap_mgs_ncf;
70 /* lu_nodemap flags */
72 NM_FL_ALLOW_ROOT_ACCESS = 0x1,
73 NM_FL_TRUST_CLIENT_IDS = 0x2,
74 NM_FL_DENY_UNKNOWN = 0x4,
75 NM_FL_MAP_UID_ONLY = 0x8,
76 NM_FL_MAP_GID_ONLY = 0x10,
77 NM_FL_ENABLE_AUDIT = 0x20,
78 NM_FL_FORBID_ENCRYPT = 0x40,
81 static void nodemap_cluster_key_init(struct nodemap_key *nk, unsigned int nm_id)
83 nk->nk_nodemap_id = cpu_to_le32(nm_idx_set_type(nm_id,
84 NODEMAP_CLUSTER_IDX));
88 static void nodemap_cluster_rec_init(union nodemap_rec *nr,
89 const struct lu_nodemap *nodemap)
91 BUILD_BUG_ON(sizeof(nr->ncr.ncr_name) != sizeof(nodemap->nm_name));
93 strncpy(nr->ncr.ncr_name, nodemap->nm_name, sizeof(nr->ncr.ncr_name));
94 nr->ncr.ncr_squash_uid = cpu_to_le32(nodemap->nm_squash_uid);
95 nr->ncr.ncr_squash_gid = cpu_to_le32(nodemap->nm_squash_gid);
96 nr->ncr.ncr_flags = cpu_to_le32(
97 (nodemap->nmf_trust_client_ids ?
98 NM_FL_TRUST_CLIENT_IDS : 0) |
99 (nodemap->nmf_allow_root_access ?
100 NM_FL_ALLOW_ROOT_ACCESS : 0) |
101 (nodemap->nmf_deny_unknown ?
102 NM_FL_DENY_UNKNOWN : 0) |
103 (nodemap->nmf_map_uid_only ?
104 NM_FL_MAP_UID_ONLY : 0) |
105 (nodemap->nmf_map_gid_only ?
106 NM_FL_MAP_GID_ONLY : 0) |
107 (nodemap->nmf_enable_audit ?
108 NM_FL_ENABLE_AUDIT : 0) |
109 (nodemap->nmf_forbid_encryption ?
110 NM_FL_FORBID_ENCRYPT : 0));
113 static void nodemap_idmap_key_init(struct nodemap_key *nk, unsigned int nm_id,
114 enum nodemap_id_type id_type,
117 enum nodemap_idx_type idx_type;
119 if (id_type == NODEMAP_UID)
120 idx_type = NODEMAP_UIDMAP_IDX;
122 idx_type = NODEMAP_GIDMAP_IDX;
124 nk->nk_nodemap_id = cpu_to_le32(nm_idx_set_type(nm_id, idx_type));
125 nk->nk_id_client = cpu_to_le32(id_client);
128 static void nodemap_idmap_rec_init(union nodemap_rec *nr, u32 id_fs)
130 nr->nir.nir_id_fs = cpu_to_le32(id_fs);
133 static void nodemap_range_key_init(struct nodemap_key *nk, unsigned int nm_id,
136 nk->nk_nodemap_id = cpu_to_le32(nm_idx_set_type(nm_id,
138 nk->nk_range_id = cpu_to_le32(rn_id);
141 static void nodemap_range_rec_init(union nodemap_rec *nr,
142 const lnet_nid_t nid[2])
144 nr->nrr.nrr_start_nid = cpu_to_le64(nid[0]);
145 nr->nrr.nrr_end_nid = cpu_to_le64(nid[1]);
148 static void nodemap_global_key_init(struct nodemap_key *nk)
150 nk->nk_nodemap_id = cpu_to_le32(nm_idx_set_type(0, NODEMAP_GLOBAL_IDX));
154 static void nodemap_global_rec_init(union nodemap_rec *nr, bool active)
156 nr->ngr.ngr_is_active = active;
159 /* should be called with dt_write lock */
160 static void nodemap_inc_version(const struct lu_env *env,
161 struct dt_object *nodemap_idx,
164 u64 ver = dt_version_get(env, nodemap_idx);
165 dt_version_set(env, nodemap_idx, ver + 1, th);
168 enum ncfc_find_create {
172 static struct dt_object *nodemap_cache_find_create(const struct lu_env *env,
173 struct dt_device *dev,
174 struct local_oid_storage *los,
175 enum ncfc_find_create create_new)
178 struct dt_object *root_obj;
179 struct dt_object *nm_obj;
182 rc = dt_root_get(env, dev, &tfid);
184 GOTO(out, nm_obj = ERR_PTR(rc));
186 root_obj = dt_locate(env, dev, &tfid);
187 if (unlikely(IS_ERR(root_obj)))
188 GOTO(out, nm_obj = root_obj);
190 rc = dt_lookup_dir(env, root_obj, LUSTRE_NODEMAP_NAME, &tfid);
193 GOTO(out_root, nm_obj = ERR_PTR(-EROFS));
195 GOTO(out_root, nm_obj = ERR_PTR(rc));
196 } else if (dev->dd_rdonly && create_new == NCFC_CREATE_NEW) {
197 GOTO(out_root, nm_obj = ERR_PTR(-EROFS));
201 /* if loading index fails the first time, create new index */
202 if (create_new == NCFC_CREATE_NEW && rc != -ENOENT) {
203 CDEBUG(D_INFO, "removing old index, creating new one\n");
204 rc = local_object_unlink(env, dev, root_obj,
205 LUSTRE_NODEMAP_NAME);
207 /* XXX not sure the best way to get obd name. */
208 CERROR("cannot destroy nodemap index: rc = %d\n",
210 GOTO(out_root, nm_obj = ERR_PTR(rc));
214 nm_obj = local_index_find_or_create(env, los, root_obj,
216 S_IFREG | S_IRUGO | S_IWUSR,
217 &dt_nodemap_features);
219 GOTO(out_root, nm_obj);
221 if (nm_obj->do_index_ops == NULL) {
222 rc = nm_obj->do_ops->do_index_try(env, nm_obj,
223 &dt_nodemap_features);
224 /* even if loading from tgt fails, connecting to MGS will
228 dt_object_put(env, nm_obj);
230 if (create_new == NCFC_CREATE_NEW)
231 GOTO(out_root, nm_obj = ERR_PTR(rc));
233 CERROR("cannot load nodemap index from disk, creating "
234 "new index: rc = %d\n", rc);
235 create_new = NCFC_CREATE_NEW;
241 dt_object_put(env, root_obj);
246 static int nodemap_idx_insert(const struct lu_env *env,
247 struct dt_object *idx,
248 const struct nodemap_key *nk,
249 const union nodemap_rec *nr)
252 struct dt_device *dev = lu2dt_dev(idx->do_lu.lo_dev);
255 BUILD_BUG_ON(sizeof(union nodemap_rec) != 32);
257 th = dt_trans_create(env, dev);
260 GOTO(out, rc = PTR_ERR(th));
262 rc = dt_declare_insert(env, idx,
263 (const struct dt_rec *)nr,
264 (const struct dt_key *)nk, th);
268 rc = dt_declare_version_set(env, idx, th);
272 rc = dt_trans_start_local(env, dev, th);
276 dt_write_lock(env, idx, 0);
278 rc = dt_insert(env, idx, (const struct dt_rec *)nr,
279 (const struct dt_key *)nk, th);
281 nodemap_inc_version(env, idx, th);
282 dt_write_unlock(env, idx);
284 dt_trans_stop(env, dev, th);
289 static int nodemap_idx_update(const struct lu_env *env,
290 struct dt_object *idx,
291 const struct nodemap_key *nk,
292 const union nodemap_rec *nr)
295 struct dt_device *dev = lu2dt_dev(idx->do_lu.lo_dev);
298 th = dt_trans_create(env, dev);
301 GOTO(out, rc = PTR_ERR(th));
303 rc = dt_declare_delete(env, idx, (const struct dt_key *)nk, th);
307 rc = dt_declare_insert(env, idx, (const struct dt_rec *)nr,
308 (const struct dt_key *)nk, th);
312 rc = dt_declare_version_set(env, idx, th);
316 rc = dt_trans_start_local(env, dev, th);
320 dt_write_lock(env, idx, 0);
322 rc = dt_delete(env, idx, (const struct dt_key *)nk, th);
326 rc = dt_insert(env, idx, (const struct dt_rec *)nr,
327 (const struct dt_key *)nk, th);
331 nodemap_inc_version(env, idx, th);
333 dt_write_unlock(env, idx);
335 dt_trans_stop(env, dev, th);
340 static int nodemap_idx_delete(const struct lu_env *env,
341 struct dt_object *idx,
342 const struct nodemap_key *nk,
343 const union nodemap_rec *unused)
346 struct dt_device *dev = lu2dt_dev(idx->do_lu.lo_dev);
349 th = dt_trans_create(env, dev);
352 GOTO(out, rc = PTR_ERR(th));
354 rc = dt_declare_delete(env, idx, (const struct dt_key *)nk, th);
358 rc = dt_declare_version_set(env, idx, th);
362 rc = dt_trans_start_local(env, dev, th);
366 dt_write_lock(env, idx, 0);
368 rc = dt_delete(env, idx, (const struct dt_key *)nk, th);
370 nodemap_inc_version(env, idx, th);
372 dt_write_unlock(env, idx);
374 dt_trans_stop(env, dev, th);
384 static int nodemap_idx_nodemap_add_update(const struct lu_nodemap *nodemap,
385 struct dt_object *idx,
386 enum nm_add_update update)
388 struct nodemap_key nk;
389 union nodemap_rec nr;
395 rc = lu_env_init(&env, LCT_LOCAL);
399 nodemap_cluster_key_init(&nk, nodemap->nm_id);
400 nodemap_cluster_rec_init(&nr, nodemap);
402 if (update == NM_UPDATE)
403 rc = nodemap_idx_update(&env, idx, &nk, &nr);
405 rc = nodemap_idx_insert(&env, idx, &nk, &nr);
412 int nodemap_idx_nodemap_add(const struct lu_nodemap *nodemap)
414 if (nodemap_mgs_ncf == NULL) {
415 CERROR("cannot add nodemap config to non-existing MGS.\n");
419 return nodemap_idx_nodemap_add_update(nodemap, nodemap_mgs_ncf->ncf_obj,
423 int nodemap_idx_nodemap_update(const struct lu_nodemap *nodemap)
425 if (nodemap_mgs_ncf == NULL) {
426 CERROR("cannot add nodemap config to non-existing MGS.\n");
430 return nodemap_idx_nodemap_add_update(nodemap, nodemap_mgs_ncf->ncf_obj,
434 int nodemap_idx_nodemap_del(const struct lu_nodemap *nodemap)
437 struct lu_idmap *idmap;
438 struct lu_idmap *temp;
439 struct lu_nid_range *range;
440 struct lu_nid_range *range_temp;
441 struct nodemap_key nk;
448 if (nodemap_mgs_ncf == NULL) {
449 CERROR("cannot add nodemap config to non-existing MGS.\n");
453 rc = lu_env_init(&env, LCT_LOCAL);
457 root = nodemap->nm_fs_to_client_uidmap;
458 nm_rbtree_postorder_for_each_entry_safe(idmap, temp, &root,
460 nodemap_idmap_key_init(&nk, nodemap->nm_id, NODEMAP_UID,
462 rc2 = nodemap_idx_delete(&env, nodemap_mgs_ncf->ncf_obj,
468 root = nodemap->nm_client_to_fs_gidmap;
469 nm_rbtree_postorder_for_each_entry_safe(idmap, temp, &root,
471 nodemap_idmap_key_init(&nk, nodemap->nm_id, NODEMAP_GID,
473 rc2 = nodemap_idx_delete(&env, nodemap_mgs_ncf->ncf_obj,
479 list_for_each_entry_safe(range, range_temp, &nodemap->nm_ranges,
481 nodemap_range_key_init(&nk, nodemap->nm_id, range->rn_id);
482 rc2 = nodemap_idx_delete(&env, nodemap_mgs_ncf->ncf_obj,
488 nodemap_cluster_key_init(&nk, nodemap->nm_id);
489 rc2 = nodemap_idx_delete(&env, nodemap_mgs_ncf->ncf_obj, &nk, NULL);
498 int nodemap_idx_range_add(const struct lu_nid_range *range,
499 const lnet_nid_t nid[2])
501 struct nodemap_key nk;
502 union nodemap_rec nr;
507 if (nodemap_mgs_ncf == NULL) {
508 CERROR("cannot add nodemap config to non-existing MGS.\n");
512 rc = lu_env_init(&env, LCT_LOCAL);
516 nodemap_range_key_init(&nk, range->rn_nodemap->nm_id, range->rn_id);
517 nodemap_range_rec_init(&nr, nid);
519 rc = nodemap_idx_insert(&env, nodemap_mgs_ncf->ncf_obj, &nk, &nr);
525 int nodemap_idx_range_del(const struct lu_nid_range *range)
527 struct nodemap_key nk;
532 if (nodemap_mgs_ncf == NULL) {
533 CERROR("cannot add nodemap config to non-existing MGS.\n");
537 rc = lu_env_init(&env, LCT_LOCAL);
541 nodemap_range_key_init(&nk, range->rn_nodemap->nm_id, range->rn_id);
543 rc = nodemap_idx_delete(&env, nodemap_mgs_ncf->ncf_obj, &nk, NULL);
549 int nodemap_idx_idmap_add(const struct lu_nodemap *nodemap,
550 enum nodemap_id_type id_type,
553 struct nodemap_key nk;
554 union nodemap_rec nr;
559 if (nodemap_mgs_ncf == NULL) {
560 CERROR("cannot add nodemap config to non-existing MGS.\n");
564 rc = lu_env_init(&env, LCT_LOCAL);
568 nodemap_idmap_key_init(&nk, nodemap->nm_id, id_type, map[0]);
569 nodemap_idmap_rec_init(&nr, map[1]);
571 rc = nodemap_idx_insert(&env, nodemap_mgs_ncf->ncf_obj, &nk, &nr);
577 int nodemap_idx_idmap_del(const struct lu_nodemap *nodemap,
578 enum nodemap_id_type id_type,
581 struct nodemap_key nk;
586 if (nodemap_mgs_ncf == NULL) {
587 CERROR("cannot add nodemap config to non-existing MGS.\n");
591 rc = lu_env_init(&env, LCT_LOCAL);
595 nodemap_idmap_key_init(&nk, nodemap->nm_id, id_type, map[0]);
597 rc = nodemap_idx_delete(&env, nodemap_mgs_ncf->ncf_obj, &nk, NULL);
603 static int nodemap_idx_global_add_update(bool value, enum nm_add_update update)
605 struct nodemap_key nk;
606 union nodemap_rec nr;
611 if (nodemap_mgs_ncf == NULL) {
612 CERROR("cannot add nodemap config to non-existing MGS.\n");
616 rc = lu_env_init(&env, LCT_LOCAL);
620 nodemap_global_key_init(&nk);
621 nodemap_global_rec_init(&nr, value);
623 if (update == NM_UPDATE)
624 rc = nodemap_idx_update(&env, nodemap_mgs_ncf->ncf_obj,
627 rc = nodemap_idx_insert(&env, nodemap_mgs_ncf->ncf_obj,
635 int nodemap_idx_nodemap_activate(bool value)
637 return nodemap_idx_global_add_update(value, NM_UPDATE);
640 static enum nodemap_idx_type nodemap_get_key_type(const struct nodemap_key *key)
644 nodemap_id = le32_to_cpu(key->nk_nodemap_id);
645 return nm_idx_get_type(nodemap_id);
649 * Process a key/rec pair and modify the new configuration.
651 * \param config configuration to update with this key/rec data
652 * \param key key of the record that was loaded
653 * \param rec record that was loaded
654 * \param recent_nodemap last referenced nodemap
655 * \retval type of record processed, see enum #nodemap_idx_type
656 * \retval -ENOENT range or map loaded before nodemap record
657 * \retval -EINVAL duplicate nodemap cluster records found with
658 * different IDs, or nodemap has invalid name
661 static int nodemap_process_keyrec(struct nodemap_config *config,
662 const struct nodemap_key *key,
663 const union nodemap_rec *rec,
664 struct lu_nodemap **recent_nodemap)
666 struct lu_nodemap *nodemap = NULL;
667 enum nodemap_idx_type type;
668 enum nodemap_id_type id_type;
677 BUILD_BUG_ON(sizeof(union nodemap_rec) != 32);
679 nodemap_id = le32_to_cpu(key->nk_nodemap_id);
680 type = nodemap_get_key_type(key);
681 nodemap_id = nm_idx_set_type(nodemap_id, 0);
683 CDEBUG(D_INFO, "found config entry, nm_id %d type %d\n",
686 /* find the correct nodemap in the load list */
687 if (type == NODEMAP_RANGE_IDX || type == NODEMAP_UIDMAP_IDX ||
688 type == NODEMAP_GIDMAP_IDX) {
689 struct lu_nodemap *tmp = NULL;
691 nodemap = *recent_nodemap;
694 GOTO(out, rc = -ENOENT);
696 if (nodemap->nm_id != nodemap_id) {
697 list_for_each_entry(tmp, &nodemap->nm_list, nm_list)
698 if (tmp->nm_id == nodemap_id) {
703 if (nodemap->nm_id != nodemap_id)
704 GOTO(out, rc = -ENOENT);
707 /* update most recently used nodemap if necessay */
708 if (nodemap != *recent_nodemap)
709 *recent_nodemap = nodemap;
713 case NODEMAP_EMPTY_IDX:
715 CWARN("Found nodemap config record without type field, "
716 " nodemap_id=%d. nodemap config file corrupt?\n",
719 case NODEMAP_CLUSTER_IDX: {
720 struct lu_nodemap *old_nm = NULL;
722 nodemap = cfs_hash_lookup(config->nmc_nodemap_hash,
724 if (nodemap == NULL) {
725 if (nodemap_id == LUSTRE_NODEMAP_DEFAULT_ID) {
726 nodemap = nodemap_create(rec->ncr.ncr_name,
729 nodemap = nodemap_create(rec->ncr.ncr_name,
733 GOTO(out, rc = PTR_ERR(nodemap));
735 /* we need to override the local ID with the saved ID */
736 nodemap->nm_id = nodemap_id;
737 if (nodemap_id > config->nmc_nodemap_highest_id)
738 config->nmc_nodemap_highest_id = nodemap_id;
740 } else if (nodemap->nm_id != nodemap_id) {
741 nodemap_putref(nodemap);
742 GOTO(out, rc = -EINVAL);
745 nodemap->nm_squash_uid =
746 le32_to_cpu(rec->ncr.ncr_squash_uid);
747 nodemap->nm_squash_gid =
748 le32_to_cpu(rec->ncr.ncr_squash_gid);
750 flags = le32_to_cpu(rec->ncr.ncr_flags);
751 nodemap->nmf_allow_root_access =
752 flags & NM_FL_ALLOW_ROOT_ACCESS;
753 nodemap->nmf_trust_client_ids =
754 flags & NM_FL_TRUST_CLIENT_IDS;
755 nodemap->nmf_deny_unknown =
756 flags & NM_FL_DENY_UNKNOWN;
757 nodemap->nmf_map_uid_only =
758 flags & NM_FL_MAP_UID_ONLY;
759 nodemap->nmf_map_gid_only =
760 flags & NM_FL_MAP_GID_ONLY;
761 nodemap->nmf_enable_audit =
762 flags & NM_FL_ENABLE_AUDIT;
763 nodemap->nmf_forbid_encryption =
764 flags & NM_FL_FORBID_ENCRYPT;
766 /* The fileset should be saved otherwise it will be empty
767 * every time in case of "NODEMAP_CLUSTER_IDX". */
768 mutex_lock(&active_config_lock);
769 old_nm = nodemap_lookup(rec->ncr.ncr_name);
770 if (!IS_ERR(old_nm) && old_nm->nm_fileset[0] != '\0')
771 strlcpy(nodemap->nm_fileset, old_nm->nm_fileset,
772 sizeof(nodemap->nm_fileset));
773 mutex_unlock(&active_config_lock);
775 nodemap_putref(old_nm);
777 if (*recent_nodemap == NULL) {
778 *recent_nodemap = nodemap;
779 INIT_LIST_HEAD(&nodemap->nm_list);
781 list_add(&nodemap->nm_list,
782 &(*recent_nodemap)->nm_list);
784 nodemap_putref(nodemap);
787 case NODEMAP_RANGE_IDX:
788 nid[0] = le64_to_cpu(rec->nrr.nrr_start_nid);
789 nid[1] = le64_to_cpu(rec->nrr.nrr_end_nid);
791 rc = nodemap_add_range_helper(config, nodemap, nid,
792 le32_to_cpu(key->nk_range_id));
796 case NODEMAP_UIDMAP_IDX:
797 case NODEMAP_GIDMAP_IDX:
798 map[0] = le32_to_cpu(key->nk_id_client);
799 map[1] = le32_to_cpu(rec->nir.nir_id_fs);
801 if (type == NODEMAP_UIDMAP_IDX)
802 id_type = NODEMAP_UID;
804 id_type = NODEMAP_GID;
806 rc = nodemap_add_idmap_helper(nodemap, id_type, map);
810 case NODEMAP_GLOBAL_IDX:
811 config->nmc_nodemap_is_active = rec->ngr.ngr_is_active;
814 CERROR("got keyrec pair for unknown type %d\n", type);
826 enum nm_config_passes {
827 NM_READ_CLUSTERS = 0,
828 NM_READ_ATTRIBUTES = 1,
831 static int nodemap_load_entries(const struct lu_env *env,
832 struct dt_object *nodemap_idx)
834 const struct dt_it_ops *iops;
836 struct lu_nodemap *recent_nodemap = NULL;
837 struct nodemap_config *new_config = NULL;
839 bool activate_nodemap = false;
840 bool loaded_global_idx = false;
841 enum nm_config_passes cur_pass = NM_READ_CLUSTERS;
846 iops = &nodemap_idx->do_index_ops->dio_it;
848 dt_read_lock(env, nodemap_idx, 0);
849 it = iops->init(env, nodemap_idx, 0);
851 GOTO(out, rc = PTR_ERR(it));
853 rc = iops->load(env, it, hash);
855 GOTO(out_iops_fini, rc);
857 /* rc == 0 means we need to advance to record */
859 rc = iops->next(env, it);
862 GOTO(out_iops_put, rc);
863 /* rc > 0 is eof, will be checked in while below */
865 /* rc == 1, we found initial record and can process below */
869 new_config = nodemap_config_alloc();
870 if (IS_ERR(new_config)) {
871 rc = PTR_ERR(new_config);
873 GOTO(out_iops_put, rc);
876 /* rc > 0 is eof, check initial iops->next here as well */
878 struct nodemap_key *key;
879 union nodemap_rec rec;
880 enum nodemap_idx_type key_type;
882 key = (struct nodemap_key *)iops->key(env, it);
883 key_type = nodemap_get_key_type((struct nodemap_key *)key);
884 if ((cur_pass == NM_READ_CLUSTERS &&
885 key_type == NODEMAP_CLUSTER_IDX) ||
886 (cur_pass == NM_READ_ATTRIBUTES &&
887 key_type != NODEMAP_CLUSTER_IDX &&
888 key_type != NODEMAP_EMPTY_IDX)) {
889 rc = iops->rec(env, it, (struct dt_rec *)&rec, 0);
892 GOTO(out_nodemap_config, rc);
893 rc = nodemap_process_keyrec(new_config, key, &rec,
896 GOTO(out_nodemap_config, rc);
897 if (rc == NODEMAP_GLOBAL_IDX)
898 loaded_global_idx = true;
903 rc = iops->next(env, it);
904 while (rc == -ESTALE);
906 /* move to second pass */
907 if (rc > 0 && cur_pass == NM_READ_CLUSTERS) {
908 cur_pass = NM_READ_ATTRIBUTES;
909 rc = iops->load(env, it, 0);
911 rc = iops->next(env, it);
924 nodemap_config_dealloc(new_config);
926 /* creating new default needs to be done outside dt read lock */
927 activate_nodemap = true;
933 dt_read_unlock(env, nodemap_idx);
936 CWARN("%s: failed to load nodemap configuration: rc = %d\n",
937 nodemap_idx->do_lu.lo_dev->ld_obd->obd_name, rc);
939 if (!activate_nodemap)
942 if (new_config->nmc_default_nodemap == NULL) {
943 /* new MGS won't have a default nm on disk, so create it here */
944 struct lu_nodemap *nodemap =
945 nodemap_create(DEFAULT_NODEMAP, new_config, 1);
946 if (IS_ERR(nodemap)) {
947 rc = PTR_ERR(nodemap);
949 rc = nodemap_idx_nodemap_add_update(
950 new_config->nmc_default_nodemap,
953 nodemap_putref(new_config->nmc_default_nodemap);
957 /* new nodemap config won't have an active/inactive record */
958 if (rc == 0 && loaded_global_idx == false) {
959 struct nodemap_key nk;
960 union nodemap_rec nr;
962 nodemap_global_key_init(&nk);
963 nodemap_global_rec_init(&nr, false);
964 rc = nodemap_idx_insert(env, nodemap_idx, &nk, &nr);
968 nodemap_config_set_active(new_config);
970 nodemap_config_dealloc(new_config);
976 * Step through active config and write to disk.
978 struct dt_object *nodemap_save_config_cache(const struct lu_env *env,
979 struct dt_device *dev,
980 struct local_oid_storage *los)
983 struct lu_nodemap *nodemap;
984 struct lu_nodemap *nm_tmp;
985 struct lu_nid_range *range;
986 struct lu_nid_range *range_temp;
987 struct lu_idmap *idmap;
988 struct lu_idmap *id_tmp;
990 struct nodemap_key nk;
991 union nodemap_rec nr;
992 LIST_HEAD(nodemap_list_head);
997 /* create a new index file to fill with active config */
998 o = nodemap_cache_find_create(env, dev, los, NCFC_CREATE_NEW);
1002 mutex_lock(&active_config_lock);
1004 /* convert hash to list so we don't spin */
1005 cfs_hash_for_each_safe(active_config->nmc_nodemap_hash,
1006 nm_hash_list_cb, &nodemap_list_head);
1008 list_for_each_entry_safe(nodemap, nm_tmp, &nodemap_list_head, nm_list) {
1009 nodemap_cluster_key_init(&nk, nodemap->nm_id);
1010 nodemap_cluster_rec_init(&nr, nodemap);
1012 rc2 = nodemap_idx_insert(env, o, &nk, &nr);
1018 down_read(&active_config->nmc_range_tree_lock);
1019 list_for_each_entry_safe(range, range_temp, &nodemap->nm_ranges,
1021 lnet_nid_t nid[2] = {
1025 nodemap_range_key_init(&nk, nodemap->nm_id,
1027 nodemap_range_rec_init(&nr, nid);
1028 rc2 = nodemap_idx_insert(env, o, &nk, &nr);
1032 up_read(&active_config->nmc_range_tree_lock);
1034 /* we don't need to take nm_idmap_lock because active config
1035 * lock prevents changes from happening to nodemaps
1037 root = nodemap->nm_client_to_fs_uidmap;
1038 nm_rbtree_postorder_for_each_entry_safe(idmap, id_tmp, &root,
1040 nodemap_idmap_key_init(&nk, nodemap->nm_id, NODEMAP_UID,
1042 nodemap_idmap_rec_init(&nr, idmap->id_fs);
1043 rc2 = nodemap_idx_insert(env, o, &nk, &nr);
1048 root = nodemap->nm_client_to_fs_gidmap;
1049 nm_rbtree_postorder_for_each_entry_safe(idmap, id_tmp, &root,
1051 nodemap_idmap_key_init(&nk, nodemap->nm_id, NODEMAP_GID,
1053 nodemap_idmap_rec_init(&nr, idmap->id_fs);
1054 rc2 = nodemap_idx_insert(env, o, &nk, &nr);
1059 nodemap_global_key_init(&nk);
1060 nodemap_global_rec_init(&nr, active_config->nmc_nodemap_is_active);
1061 rc2 = nodemap_idx_insert(env, o, &nk, &nr);
1065 mutex_unlock(&active_config_lock);
1068 dt_object_put(env, o);
1075 static void nodemap_save_all_caches(void)
1077 struct nm_config_file *ncf;
1081 /* recreating nodemap cache requires fld_thread_key be in env */
1082 rc = lu_env_init(&env, LCT_MD_THREAD | LCT_DT_THREAD | LCT_MG_THREAD);
1084 CWARN("cannot init env for nodemap config: rc = %d\n", rc);
1088 mutex_lock(&ncf_list_lock);
1089 list_for_each_entry(ncf, &ncf_list_head, ncf_list) {
1090 struct dt_device *dev = lu2dt_dev(ncf->ncf_obj->do_lu.lo_dev);
1091 struct obd_device *obd = ncf->ncf_obj->do_lu.lo_dev->ld_obd;
1092 struct dt_object *o;
1094 /* put current config file so save conf can rewrite it */
1095 dt_object_put_nocache(&env, ncf->ncf_obj);
1096 ncf->ncf_obj = NULL;
1098 o = nodemap_save_config_cache(&env, dev, ncf->ncf_los);
1100 CWARN("%s: error writing to nodemap config: rc = %d\n",
1105 mutex_unlock(&ncf_list_lock);
1110 /* tracks if config still needs to be loaded, either from disk or network */
1111 static bool nodemap_config_loaded;
1112 static DEFINE_MUTEX(nodemap_config_loaded_lock);
1115 * Ensures that configs loaded over the wire are prioritized over those loaded
1118 * \param config config to set as the active config
1120 void nodemap_config_set_active_mgc(struct nodemap_config *config)
1122 mutex_lock(&nodemap_config_loaded_lock);
1123 nodemap_config_set_active(config);
1124 nodemap_config_loaded = true;
1125 nodemap_save_all_caches();
1126 mutex_unlock(&nodemap_config_loaded_lock);
1128 EXPORT_SYMBOL(nodemap_config_set_active_mgc);
1131 * Register a dt_object representing the config index file. This should be
1132 * called by targets in order to load the nodemap configuration from disk. The
1133 * dt_object should be created with local_index_find_or_create and the index
1134 * features should be enabled with do_index_try.
1136 * \param obj dt_object returned by local_index_find_or_create
1138 * \retval on success: nm_config_file handle for later deregistration
1139 * \retval -ENOMEM memory allocation failure
1140 * \retval -ENOENT error loading nodemap config
1141 * \retval -EINVAL error loading nodemap config
1142 * \retval -EEXIST nodemap config already registered for MGS
1144 struct nm_config_file *nm_config_file_register_mgs(const struct lu_env *env,
1145 struct dt_object *obj,
1146 struct local_oid_storage *los)
1148 struct nm_config_file *ncf;
1152 if (nodemap_mgs_ncf != NULL)
1153 GOTO(out, ncf = ERR_PTR(-EEXIST));
1157 GOTO(out, ncf = ERR_PTR(-ENOMEM));
1159 /* if loading from cache, prevent activation of MGS config until cache
1160 * loading is done, so disk config is overwritten by MGS config.
1162 mutex_lock(&nodemap_config_loaded_lock);
1163 rc = nodemap_load_entries(env, obj);
1165 nodemap_config_loaded = true;
1166 mutex_unlock(&nodemap_config_loaded_lock);
1170 GOTO(out, ncf = ERR_PTR(rc));
1173 lu_object_get(&obj->do_lu);
1178 nodemap_mgs_ncf = ncf;
1183 EXPORT_SYMBOL(nm_config_file_register_mgs);
1185 struct nm_config_file *nm_config_file_register_tgt(const struct lu_env *env,
1186 struct dt_device *dev,
1187 struct local_oid_storage *los)
1189 struct nm_config_file *ncf;
1190 struct dt_object *config_obj = NULL;
1195 RETURN(ERR_PTR(-ENOMEM));
1197 /* don't load from cache if config already loaded */
1198 mutex_lock(&nodemap_config_loaded_lock);
1199 if (!nodemap_config_loaded) {
1200 config_obj = nodemap_cache_find_create(env, dev, los, 0);
1201 if (IS_ERR(config_obj))
1202 rc = PTR_ERR(config_obj);
1204 rc = nodemap_load_entries(env, config_obj);
1207 nodemap_config_loaded = true;
1209 mutex_unlock(&nodemap_config_loaded_lock);
1213 /* sync on disk caches w/ loaded config in memory, ncf_obj may change */
1215 config_obj = nodemap_save_config_cache(env, dev, los);
1216 if (IS_ERR(config_obj))
1217 GOTO(out_ncf, rc = PTR_ERR(config_obj));
1220 ncf->ncf_obj = config_obj;
1223 mutex_lock(&ncf_list_lock);
1224 list_add(&ncf->ncf_list, &ncf_list_head);
1225 mutex_unlock(&ncf_list_lock);
1230 RETURN(ERR_PTR(rc));
1235 EXPORT_SYMBOL(nm_config_file_register_tgt);
1238 * Deregister a nm_config_file. Should be called by targets during cleanup.
1240 * \param ncf config file to deregister
1242 void nm_config_file_deregister_mgs(const struct lu_env *env,
1243 struct nm_config_file *ncf)
1246 LASSERT(nodemap_mgs_ncf == ncf);
1248 nodemap_mgs_ncf = NULL;
1250 dt_object_put(env, ncf->ncf_obj);
1256 EXPORT_SYMBOL(nm_config_file_deregister_mgs);
1258 void nm_config_file_deregister_tgt(const struct lu_env *env,
1259 struct nm_config_file *ncf)
1266 mutex_lock(&ncf_list_lock);
1267 list_del(&ncf->ncf_list);
1268 mutex_unlock(&ncf_list_lock);
1271 dt_object_put(env, ncf->ncf_obj);
1277 EXPORT_SYMBOL(nm_config_file_deregister_tgt);
1279 int nodemap_process_idx_pages(struct nodemap_config *config, union lu_page *lip,
1280 struct lu_nodemap **recent_nodemap)
1282 struct nodemap_key *key;
1283 union nodemap_rec *rec;
1288 int size = dt_nodemap_features.dif_keysize_max +
1289 dt_nodemap_features.dif_recsize_max;
1292 for (j = 0; j < LU_PAGE_COUNT; j++) {
1293 if (lip->lp_idx.lip_magic != LIP_MAGIC)
1296 /* get and process keys and records from page */
1297 for (k = 0; k < lip->lp_idx.lip_nr; k++) {
1298 entry = lip->lp_idx.lip_entries + k * size;
1299 key = (struct nodemap_key *)entry;
1301 entry += dt_nodemap_features.dif_keysize_max;
1302 rec = (union nodemap_rec *)entry;
1304 rc = nodemap_process_keyrec(config, key, rec,
1315 EXPORT_SYMBOL(nodemap_process_idx_pages);
1317 static int nodemap_page_build(const struct lu_env *env, union lu_page *lp,
1318 size_t nob, const struct dt_it_ops *iops,
1319 struct dt_it *it, __u32 attr, void *arg)
1321 struct idx_info *ii = (struct idx_info *)arg;
1322 struct lu_idxpage *lip = &lp->lp_idx;
1324 size_t size = ii->ii_keysize + ii->ii_recsize;
1328 if (nob < LIP_HDR_SIZE)
1331 /* initialize the header of the new container */
1332 memset(lip, 0, LIP_HDR_SIZE);
1333 lip->lip_magic = LIP_MAGIC;
1334 nob -= LIP_HDR_SIZE;
1336 entry = lip->lip_entries;
1338 char *tmp_entry = entry;
1341 enum nodemap_idx_type key_type;
1343 /* fetch 64-bit hash value */
1344 hash = iops->store(env, it);
1345 ii->ii_hash_end = hash;
1347 if (OBD_FAIL_CHECK(OBD_FAIL_OBD_IDX_READ_BREAK)) {
1348 if (lip->lip_nr != 0)
1353 if (lip->lip_nr == 0)
1354 GOTO(out, rc = -EINVAL);
1358 key = iops->key(env, it);
1359 key_type = nodemap_get_key_type((struct nodemap_key *)key);
1361 /* on the first pass, get only the cluster types. On second
1362 * pass, get all the rest */
1363 if ((ii->ii_attrs == NM_READ_CLUSTERS &&
1364 key_type == NODEMAP_CLUSTER_IDX) ||
1365 (ii->ii_attrs == NM_READ_ATTRIBUTES &&
1366 key_type != NODEMAP_CLUSTER_IDX &&
1367 key_type != NODEMAP_EMPTY_IDX)) {
1368 memcpy(tmp_entry, key, ii->ii_keysize);
1369 tmp_entry += ii->ii_keysize;
1371 /* and finally the record */
1372 rc = iops->rec(env, it, (struct dt_rec *)tmp_entry,
1374 if (rc != -ESTALE) {
1378 /* hash/key/record successfully copied! */
1380 if (unlikely(lip->lip_nr == 1 &&
1382 ii->ii_hash_start = hash;
1384 entry = tmp_entry + ii->ii_recsize;
1389 /* move on to the next record */
1391 rc = iops->next(env, it);
1392 } while (rc == -ESTALE);
1394 /* move to second pass */
1395 if (rc > 0 && ii->ii_attrs == NM_READ_CLUSTERS) {
1396 ii->ii_attrs = NM_READ_ATTRIBUTES;
1397 rc = iops->load(env, it, 0);
1399 rc = iops->next(env, it);
1410 if (rc >= 0 && lip->lip_nr > 0)
1411 /* one more container */
1414 /* no more entries */
1415 ii->ii_hash_end = II_END_OFF;
1420 int nodemap_index_read(struct lu_env *env,
1421 struct nm_config_file *ncf,
1422 struct idx_info *ii,
1423 const struct lu_rdpg *rdpg)
1425 struct dt_object *nodemap_idx = ncf->ncf_obj;
1429 ii->ii_keysize = dt_nodemap_features.dif_keysize_max;
1430 ii->ii_recsize = dt_nodemap_features.dif_recsize_max;
1432 dt_read_lock(env, nodemap_idx, 0);
1433 version = dt_version_get(env, nodemap_idx);
1434 if (rdpg->rp_hash != 0 && ii->ii_version != version) {
1435 CDEBUG(D_INFO, "nodemap config changed inflight, old %llu, new %llu\n",
1438 ii->ii_hash_end = 0;
1440 rc = dt_index_walk(env, nodemap_idx, rdpg, nodemap_page_build,
1442 CDEBUG(D_INFO, "walked index, hashend %llx\n", ii->ii_hash_end);
1446 ii->ii_version = version;
1448 dt_read_unlock(env, nodemap_idx);
1451 EXPORT_SYMBOL(nodemap_index_read);
1454 * Returns the current nodemap configuration to MGC by walking the nodemap
1455 * config index and storing it in the response buffer.
1457 * \param req incoming MGS_CONFIG_READ request
1459 * \retval -EINVAL malformed request
1460 * \retval -ENOTCONN client evicted/reconnected already
1461 * \retval -ETIMEDOUT client timeout or network error
1464 int nodemap_get_config_req(struct obd_device *mgs_obd,
1465 struct ptlrpc_request *req)
1467 const struct ptlrpc_bulk_frag_ops *frag_ops = &ptlrpc_bulk_kiov_pin_ops;
1468 struct mgs_config_body *body;
1469 struct mgs_config_res *res;
1470 struct lu_rdpg rdpg;
1471 struct idx_info nodemap_ii;
1472 struct ptlrpc_bulk_desc *desc;
1473 struct tg_export_data *rqexp_ted = &req->rq_export->exp_target_data;
1479 body = req_capsule_client_get(&req->rq_pill, &RMF_MGS_CONFIG_BODY);
1483 if (body->mcb_type != CONFIG_T_NODEMAP)
1486 rdpg.rp_count = (body->mcb_units << body->mcb_bits);
1487 rdpg.rp_npages = (rdpg.rp_count + PAGE_SIZE - 1) >>
1489 if (rdpg.rp_npages > PTLRPC_MAX_BRW_PAGES)
1492 CDEBUG(D_INFO, "reading nodemap log, name '%s', size = %u\n",
1493 body->mcb_name, rdpg.rp_count);
1495 /* allocate pages to store the containers */
1496 OBD_ALLOC_PTR_ARRAY(rdpg.rp_pages, rdpg.rp_npages);
1497 if (rdpg.rp_pages == NULL)
1499 for (i = 0; i < rdpg.rp_npages; i++) {
1500 rdpg.rp_pages[i] = alloc_page(GFP_NOFS);
1501 if (rdpg.rp_pages[i] == NULL)
1502 GOTO(out, rc = -ENOMEM);
1505 rdpg.rp_hash = body->mcb_offset;
1506 nodemap_ii.ii_magic = IDX_INFO_MAGIC;
1507 nodemap_ii.ii_flags = II_FL_NOHASH;
1508 nodemap_ii.ii_version = rqexp_ted->ted_nodemap_version;
1509 nodemap_ii.ii_attrs = body->mcb_nm_cur_pass;
1511 bytes = nodemap_index_read(req->rq_svc_thread->t_env,
1512 mgs_obd->u.obt.obt_nodemap_config_file,
1513 &nodemap_ii, &rdpg);
1515 GOTO(out, rc = bytes);
1517 rqexp_ted->ted_nodemap_version = nodemap_ii.ii_version;
1519 res = req_capsule_server_get(&req->rq_pill, &RMF_MGS_CONFIG_RES);
1521 GOTO(out, rc = -EINVAL);
1522 res->mcr_offset = nodemap_ii.ii_hash_end;
1523 res->mcr_nm_cur_pass = nodemap_ii.ii_attrs;
1525 page_count = (bytes + PAGE_SIZE - 1) >> PAGE_SHIFT;
1526 LASSERT(page_count <= rdpg.rp_count);
1527 desc = ptlrpc_prep_bulk_exp(req, page_count, 1,
1528 PTLRPC_BULK_PUT_SOURCE,
1529 MGS_BULK_PORTAL, frag_ops);
1531 GOTO(out, rc = -ENOMEM);
1533 for (i = 0; i < page_count && bytes > 0; i++) {
1534 frag_ops->add_kiov_frag(desc, rdpg.rp_pages[i], 0,
1535 min_t(int, bytes, PAGE_SIZE));
1539 rc = target_bulk_io(req->rq_export, desc);
1540 ptlrpc_free_bulk(desc);
1543 if (rdpg.rp_pages != NULL) {
1544 for (i = 0; i < rdpg.rp_npages; i++)
1545 if (rdpg.rp_pages[i] != NULL)
1546 __free_page(rdpg.rp_pages[i]);
1547 OBD_FREE_PTR_ARRAY(rdpg.rp_pages, rdpg.rp_npages);
1551 EXPORT_SYMBOL(nodemap_get_config_req);