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) 2014, 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 <lnet/types.h>
54 #include <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,
77 static void nodemap_cluster_key_init(struct nodemap_key *nk, unsigned int nm_id)
79 nk->nk_nodemap_id = cpu_to_le32(nm_idx_set_type(nm_id,
80 NODEMAP_CLUSTER_IDX));
84 static void nodemap_cluster_rec_init(union nodemap_rec *nr,
85 const struct lu_nodemap *nodemap)
87 CLASSERT(sizeof(nr->ncr.ncr_name) == sizeof(nodemap->nm_name));
89 strncpy(nr->ncr.ncr_name, nodemap->nm_name, sizeof(nodemap->nm_name));
90 nr->ncr.ncr_squash_uid = cpu_to_le32(nodemap->nm_squash_uid);
91 nr->ncr.ncr_squash_gid = cpu_to_le32(nodemap->nm_squash_gid);
92 nr->ncr.ncr_flags = cpu_to_le32(
93 (nodemap->nmf_trust_client_ids ?
94 NM_FL_TRUST_CLIENT_IDS : 0) |
95 (nodemap->nmf_allow_root_access ?
96 NM_FL_ALLOW_ROOT_ACCESS : 0) |
97 (nodemap->nmf_deny_unknown ?
98 NM_FL_DENY_UNKNOWN : 0));
101 static void nodemap_idmap_key_init(struct nodemap_key *nk, unsigned int nm_id,
102 enum nodemap_id_type id_type,
105 enum nodemap_idx_type idx_type;
107 if (id_type == NODEMAP_UID)
108 idx_type = NODEMAP_UIDMAP_IDX;
110 idx_type = NODEMAP_GIDMAP_IDX;
112 nk->nk_nodemap_id = cpu_to_le32(nm_idx_set_type(nm_id, idx_type));
113 nk->nk_id_client = cpu_to_le32(id_client);
116 static void nodemap_idmap_rec_init(union nodemap_rec *nr, u32 id_fs)
118 nr->nir.nir_id_fs = cpu_to_le32(id_fs);
121 static void nodemap_range_key_init(struct nodemap_key *nk, unsigned int nm_id,
124 nk->nk_nodemap_id = cpu_to_le32(nm_idx_set_type(nm_id,
126 nk->nk_range_id = cpu_to_le32(rn_id);
129 static void nodemap_range_rec_init(union nodemap_rec *nr,
130 const lnet_nid_t nid[2])
132 nr->nrr.nrr_start_nid = cpu_to_le64(nid[0]);
133 nr->nrr.nrr_end_nid = cpu_to_le64(nid[1]);
136 static void nodemap_global_key_init(struct nodemap_key *nk)
138 nk->nk_nodemap_id = cpu_to_le32(nm_idx_set_type(0, NODEMAP_GLOBAL_IDX));
142 static void nodemap_global_rec_init(union nodemap_rec *nr, bool active)
144 nr->ngr.ngr_is_active = active;
147 /* should be called with dt_write lock */
148 static void nodemap_inc_version(const struct lu_env *env,
149 struct dt_object *nodemap_idx,
152 u64 ver = dt_version_get(env, nodemap_idx);
153 dt_version_set(env, nodemap_idx, ver + 1, th);
156 static struct dt_object *nodemap_cache_find_create(const struct lu_env *env,
157 struct dt_device *dev,
158 struct local_oid_storage *los,
161 struct lu_fid root_fid;
162 struct dt_object *root_obj;
163 struct dt_object *nm_obj;
166 rc = dt_root_get(env, dev, &root_fid);
168 GOTO(out, nm_obj = ERR_PTR(rc));
170 root_obj = dt_locate(env, dev, &root_fid);
171 if (unlikely(IS_ERR(root_obj)))
172 GOTO(out, nm_obj = root_obj);
175 /* if loading index fails the first time, try again with force_create */
177 CDEBUG(D_INFO, "removing old index, creating new one\n");
178 rc = local_object_unlink(env, dev, root_obj,
179 LUSTRE_NODEMAP_NAME);
181 /* XXX not sure the best way to get obd name. */
182 CERROR("cannot destroy nodemap index: rc = %d\n",
184 GOTO(out_root, nm_obj = ERR_PTR(rc));
188 nm_obj = local_index_find_or_create(env, los, root_obj,
190 S_IFREG | S_IRUGO | S_IWUSR,
191 &dt_nodemap_features);
193 GOTO(out_root, nm_obj);
195 if (nm_obj->do_index_ops == NULL) {
196 rc = nm_obj->do_ops->do_index_try(env, nm_obj,
197 &dt_nodemap_features);
198 /* even if loading from tgt fails, connecting to MGS will
201 if (rc < 0 && !force_create) {
202 CERROR("cannot load nodemap index from disk, creating "
203 "new index: rc = %d\n", rc);
204 lu_object_put(env, &nm_obj->do_lu);
211 nm_obj = ERR_PTR(rc);
214 lu_object_put(env, &root_obj->do_lu);
219 static int nodemap_idx_insert(const struct lu_env *env,
220 struct dt_object *idx,
221 const struct nodemap_key *nk,
222 const union nodemap_rec *nr)
225 struct dt_device *dev = lu2dt_dev(idx->do_lu.lo_dev);
228 CLASSERT(sizeof(union nodemap_rec) == 32);
230 th = dt_trans_create(env, dev);
233 GOTO(out, rc = PTR_ERR(th));
235 rc = dt_declare_insert(env, idx,
236 (const struct dt_rec *)nr,
237 (const struct dt_key *)nk, th);
241 rc = dt_declare_version_set(env, idx, th);
245 rc = dt_trans_start_local(env, dev, th);
249 dt_write_lock(env, idx, 0);
251 rc = dt_insert(env, idx, (const struct dt_rec *)nr,
252 (const struct dt_key *)nk, th, 1);
254 nodemap_inc_version(env, idx, th);
255 dt_write_unlock(env, idx);
257 dt_trans_stop(env, dev, th);
262 static int nodemap_idx_update(const struct lu_env *env,
263 struct dt_object *idx,
264 const struct nodemap_key *nk,
265 const union nodemap_rec *nr)
268 struct dt_device *dev = lu2dt_dev(idx->do_lu.lo_dev);
271 th = dt_trans_create(env, dev);
274 GOTO(out, rc = PTR_ERR(th));
276 rc = dt_declare_delete(env, idx, (const struct dt_key *)nk, th);
280 rc = dt_declare_insert(env, idx, (const struct dt_rec *)nr,
281 (const struct dt_key *)nk, th);
285 rc = dt_declare_version_set(env, idx, th);
289 rc = dt_trans_start_local(env, dev, th);
293 dt_write_lock(env, idx, 0);
295 rc = dt_delete(env, idx, (const struct dt_key *)nk, th);
299 rc = dt_insert(env, idx, (const struct dt_rec *)nr,
300 (const struct dt_key *)nk, th, 1);
304 nodemap_inc_version(env, idx, th);
306 dt_write_unlock(env, idx);
308 dt_trans_stop(env, dev, th);
313 static int nodemap_idx_delete(const struct lu_env *env,
314 struct dt_object *idx,
315 const struct nodemap_key *nk,
316 const union nodemap_rec *unused)
319 struct dt_device *dev = lu2dt_dev(idx->do_lu.lo_dev);
322 th = dt_trans_create(env, dev);
325 GOTO(out, rc = PTR_ERR(th));
327 rc = dt_declare_delete(env, idx, (const struct dt_key *)nk, th);
331 rc = dt_declare_version_set(env, idx, th);
335 rc = dt_trans_start_local(env, dev, th);
339 dt_write_lock(env, idx, 0);
341 rc = dt_delete(env, idx, (const struct dt_key *)nk, th);
343 nodemap_inc_version(env, idx, th);
345 dt_write_unlock(env, idx);
347 dt_trans_stop(env, dev, th);
357 static int nodemap_idx_nodemap_add_update(const struct lu_nodemap *nodemap,
358 enum nm_add_update update)
360 struct nodemap_key nk;
361 union nodemap_rec nr;
367 if (nodemap_mgs_ncf == NULL) {
368 CERROR("cannot add nodemap config to non-existing MGS.\n");
372 rc = lu_env_init(&env, LCT_LOCAL);
376 nodemap_cluster_key_init(&nk, nodemap->nm_id);
377 nodemap_cluster_rec_init(&nr, nodemap);
379 if (update == NM_UPDATE)
380 rc = nodemap_idx_update(&env, nodemap_mgs_ncf->ncf_obj,
383 rc = nodemap_idx_insert(&env, nodemap_mgs_ncf->ncf_obj,
391 int nodemap_idx_nodemap_add(const struct lu_nodemap *nodemap)
393 return nodemap_idx_nodemap_add_update(nodemap, NM_ADD);
396 int nodemap_idx_nodemap_update(const struct lu_nodemap *nodemap)
398 return nodemap_idx_nodemap_add_update(nodemap, NM_UPDATE);
401 int nodemap_idx_nodemap_del(const struct lu_nodemap *nodemap)
404 struct lu_idmap *idmap;
405 struct lu_idmap *temp;
406 struct lu_nid_range *range;
407 struct lu_nid_range *range_temp;
408 struct nodemap_key nk;
415 if (nodemap_mgs_ncf == NULL) {
416 CERROR("cannot add nodemap config to non-existing MGS.\n");
420 rc = lu_env_init(&env, LCT_LOCAL);
424 root = nodemap->nm_fs_to_client_uidmap;
425 nm_rbtree_postorder_for_each_entry_safe(idmap, temp, &root,
427 nodemap_idmap_key_init(&nk, nodemap->nm_id, NODEMAP_UID,
429 rc2 = nodemap_idx_delete(&env, nodemap_mgs_ncf->ncf_obj,
435 root = nodemap->nm_client_to_fs_gidmap;
436 nm_rbtree_postorder_for_each_entry_safe(idmap, temp, &root,
438 nodemap_idmap_key_init(&nk, nodemap->nm_id, NODEMAP_GID,
440 rc2 = nodemap_idx_delete(&env, nodemap_mgs_ncf->ncf_obj,
446 list_for_each_entry_safe(range, range_temp, &nodemap->nm_ranges,
448 nodemap_range_key_init(&nk, nodemap->nm_id, range->rn_id);
449 rc2 = nodemap_idx_delete(&env, nodemap_mgs_ncf->ncf_obj,
455 nodemap_cluster_key_init(&nk, nodemap->nm_id);
456 rc2 = nodemap_idx_delete(&env, nodemap_mgs_ncf->ncf_obj, &nk, NULL);
465 int nodemap_idx_range_add(const struct lu_nid_range *range,
466 const lnet_nid_t nid[2])
468 struct nodemap_key nk;
469 union nodemap_rec nr;
474 if (nodemap_mgs_ncf == NULL) {
475 CERROR("cannot add nodemap config to non-existing MGS.\n");
479 rc = lu_env_init(&env, LCT_LOCAL);
483 nodemap_range_key_init(&nk, range->rn_nodemap->nm_id, range->rn_id);
484 nodemap_range_rec_init(&nr, nid);
486 rc = nodemap_idx_insert(&env, nodemap_mgs_ncf->ncf_obj, &nk, &nr);
492 int nodemap_idx_range_del(const struct lu_nid_range *range)
494 struct nodemap_key nk;
499 if (nodemap_mgs_ncf == NULL) {
500 CERROR("cannot add nodemap config to non-existing MGS.\n");
504 rc = lu_env_init(&env, LCT_LOCAL);
508 nodemap_range_key_init(&nk, range->rn_nodemap->nm_id, range->rn_id);
510 rc = nodemap_idx_delete(&env, nodemap_mgs_ncf->ncf_obj, &nk, NULL);
516 int nodemap_idx_idmap_add(const struct lu_nodemap *nodemap,
517 enum nodemap_id_type id_type,
520 struct nodemap_key nk;
521 union nodemap_rec nr;
526 if (nodemap_mgs_ncf == NULL) {
527 CERROR("cannot add nodemap config to non-existing MGS.\n");
531 rc = lu_env_init(&env, LCT_LOCAL);
535 nodemap_idmap_key_init(&nk, nodemap->nm_id, id_type, map[0]);
536 nodemap_idmap_rec_init(&nr, map[1]);
538 rc = nodemap_idx_insert(&env, nodemap_mgs_ncf->ncf_obj, &nk, &nr);
544 int nodemap_idx_idmap_del(const struct lu_nodemap *nodemap,
545 enum nodemap_id_type id_type,
548 struct nodemap_key nk;
553 if (nodemap_mgs_ncf == NULL) {
554 CERROR("cannot add nodemap config to non-existing MGS.\n");
558 rc = lu_env_init(&env, LCT_LOCAL);
562 nodemap_idmap_key_init(&nk, nodemap->nm_id, id_type, map[0]);
564 rc = nodemap_idx_delete(&env, nodemap_mgs_ncf->ncf_obj, &nk, NULL);
570 static int nodemap_idx_global_add_update(bool value, enum nm_add_update update)
572 struct nodemap_key nk;
573 union nodemap_rec nr;
578 if (nodemap_mgs_ncf == NULL) {
579 CERROR("cannot add nodemap config to non-existing MGS.\n");
583 rc = lu_env_init(&env, LCT_LOCAL);
587 nodemap_global_key_init(&nk);
588 nodemap_global_rec_init(&nr, value);
590 if (update == NM_UPDATE)
591 rc = nodemap_idx_update(&env, nodemap_mgs_ncf->ncf_obj,
594 rc = nodemap_idx_insert(&env, nodemap_mgs_ncf->ncf_obj,
602 int nodemap_idx_nodemap_activate(bool value)
604 return nodemap_idx_global_add_update(value, NM_UPDATE);
608 * Process a key/rec pair and modify the new configuration.
610 * \param config configuration to update with this key/rec data
611 * \param key key of the record that was loaded
612 * \param rec record that was loaded
613 * \param recent_nodemap last referenced nodemap
614 * \retval type of record processed, see enum #nodemap_idx_type
615 * \retval -ENOENT range or map loaded before nodemap record
616 * \retval -EINVAL duplicate nodemap cluster records found with
617 * different IDs, or nodemap has invalid name
620 static int nodemap_process_keyrec(struct nodemap_config *config,
621 const struct nodemap_key *key,
622 const union nodemap_rec *rec,
623 struct lu_nodemap **recent_nodemap)
625 struct lu_nodemap *nodemap = NULL;
626 enum nodemap_idx_type type;
627 enum nodemap_id_type id_type;
634 CLASSERT(sizeof(union nodemap_rec) == 32);
636 nodemap_id = le32_to_cpu(key->nk_nodemap_id);
637 type = nm_idx_get_type(nodemap_id);
638 nodemap_id = nm_idx_set_type(nodemap_id, 0);
640 CDEBUG(D_INFO, "found config entry, nm_id %d type %d\n",
643 /* find the correct nodemap in the load list */
644 if (type == NODEMAP_RANGE_IDX || type == NODEMAP_UIDMAP_IDX ||
645 type == NODEMAP_GIDMAP_IDX) {
646 struct lu_nodemap *tmp = NULL;
648 nodemap = *recent_nodemap;
651 GOTO(out, rc = -ENOENT);
653 if (nodemap->nm_id != nodemap_id) {
654 list_for_each_entry(tmp, &nodemap->nm_list, nm_list)
655 if (tmp->nm_id == nodemap_id) {
660 if (nodemap->nm_id != nodemap_id)
661 GOTO(out, rc = -ENOENT);
664 /* update most recently used nodemap if necessay */
665 if (nodemap != *recent_nodemap)
666 *recent_nodemap = nodemap;
670 case NODEMAP_EMPTY_IDX:
672 CWARN("Found nodemap config record without type field, "
673 " nodemap_id=%d. nodemap config file corrupt?\n",
676 case NODEMAP_CLUSTER_IDX:
677 nodemap = cfs_hash_lookup(config->nmc_nodemap_hash,
679 if (nodemap == NULL) {
680 if (nodemap_id == LUSTRE_NODEMAP_DEFAULT_ID) {
681 nodemap = nodemap_create(rec->ncr.ncr_name,
683 config->nmc_default_nodemap = nodemap;
685 nodemap = nodemap_create(rec->ncr.ncr_name,
689 GOTO(out, rc = PTR_ERR(nodemap));
691 /* we need to override the local ID with the saved ID */
692 nodemap->nm_id = nodemap_id;
693 if (nodemap_id > config->nmc_nodemap_highest_id)
694 config->nmc_nodemap_highest_id = nodemap_id;
696 } else if (nodemap->nm_id != nodemap_id) {
697 nodemap_putref(nodemap);
698 GOTO(out, rc = -EINVAL);
701 nodemap->nm_squash_uid =
702 le32_to_cpu(rec->ncr.ncr_squash_uid);
703 nodemap->nm_squash_gid =
704 le32_to_cpu(rec->ncr.ncr_squash_gid);
706 flags = le32_to_cpu(rec->ncr.ncr_flags);
707 nodemap->nmf_allow_root_access =
708 flags & NM_FL_ALLOW_ROOT_ACCESS;
709 nodemap->nmf_trust_client_ids =
710 flags & NM_FL_TRUST_CLIENT_IDS;
711 nodemap->nmf_deny_unknown =
712 flags & NM_FL_DENY_UNKNOWN;
714 if (*recent_nodemap == NULL) {
715 *recent_nodemap = nodemap;
716 INIT_LIST_HEAD(&nodemap->nm_list);
718 list_add(&nodemap->nm_list,
719 &(*recent_nodemap)->nm_list);
721 nodemap_putref(nodemap);
723 case NODEMAP_RANGE_IDX:
724 nid[0] = le64_to_cpu(rec->nrr.nrr_start_nid);
725 nid[1] = le64_to_cpu(rec->nrr.nrr_end_nid);
727 rc = nodemap_add_range_helper(config, nodemap, nid,
728 le32_to_cpu(key->nk_range_id));
732 case NODEMAP_UIDMAP_IDX:
733 case NODEMAP_GIDMAP_IDX:
734 map[0] = le32_to_cpu(key->nk_id_client);
735 map[1] = le32_to_cpu(rec->nir.nir_id_fs);
737 if (type == NODEMAP_UIDMAP_IDX)
738 id_type = NODEMAP_UID;
740 id_type = NODEMAP_GID;
742 rc = nodemap_add_idmap_helper(nodemap, id_type, map);
746 case NODEMAP_GLOBAL_IDX:
747 config->nmc_nodemap_is_active = rec->ngr.ngr_is_active;
750 CERROR("got keyrec pair for unknown type %d\n", type);
760 static int nodemap_load_entries(const struct lu_env *env,
761 struct dt_object *nodemap_idx)
763 const struct dt_it_ops *iops;
765 struct lu_nodemap *recent_nodemap = NULL;
766 struct nodemap_config *new_config = NULL;
768 bool activate_nodemap = false;
769 bool loaded_global_idx = false;
774 iops = &nodemap_idx->do_index_ops->dio_it;
776 dt_read_lock(env, nodemap_idx, 0);
777 it = iops->init(env, nodemap_idx, 0);
779 GOTO(out, rc = PTR_ERR(it));
781 rc = iops->load(env, it, hash);
783 GOTO(out_iops_fini, rc);
785 /* rc == 0 means we need to advance to record */
787 rc = iops->next(env, it);
790 GOTO(out_iops_put, rc);
791 /* rc > 0 is eof, will be checked in while below */
793 /* rc == 1, we found initial record and can process below */
797 new_config = nodemap_config_alloc();
798 if (IS_ERR(new_config)) {
799 rc = PTR_ERR(new_config);
801 GOTO(out_iops_put, rc);
804 /* rc > 0 is eof, check initial iops->next here as well */
806 struct nodemap_key *key;
807 union nodemap_rec rec;
809 key = (struct nodemap_key *)iops->key(env, it);
810 rc = iops->rec(env, it, (struct dt_rec *)&rec, 0);
813 GOTO(out_nodemap_config, rc);
814 rc = nodemap_process_keyrec(new_config, key, &rec,
817 GOTO(out_nodemap_config, rc);
818 if (rc == NODEMAP_GLOBAL_IDX)
819 loaded_global_idx = true;
823 rc = iops->next(env, it);
824 while (rc == -ESTALE);
832 nodemap_config_dealloc(new_config);
834 /* creating new default needs to be done outside dt read lock */
835 activate_nodemap = true;
841 dt_read_unlock(env, nodemap_idx);
844 CWARN("%s: failed to load nodemap configuration: rc = %d\n",
845 nodemap_idx->do_lu.lo_dev->ld_obd->obd_name, rc);
847 if (!activate_nodemap)
850 if (new_config->nmc_default_nodemap == NULL) {
851 /* new MGS won't have a default nm on disk, so create it here */
852 new_config->nmc_default_nodemap =
853 nodemap_create(DEFAULT_NODEMAP, new_config, 1);
854 if (IS_ERR(new_config->nmc_default_nodemap)) {
855 rc = PTR_ERR(new_config->nmc_default_nodemap);
857 rc = nodemap_idx_nodemap_add_update(
858 new_config->nmc_default_nodemap,
860 nodemap_putref(new_config->nmc_default_nodemap);
864 /* new nodemap config won't have an active/inactive record */
865 if (rc == 0 && loaded_global_idx == false) {
866 struct nodemap_key nk;
867 union nodemap_rec nr;
869 nodemap_global_key_init(&nk);
870 nodemap_global_rec_init(&nr, false);
871 rc = nodemap_idx_insert(env, nodemap_idx, &nk, &nr);
875 nodemap_config_set_active(new_config);
877 nodemap_config_dealloc(new_config);
883 * Step through active config and write to disk.
885 int nodemap_save_config_cache(const struct lu_env *env,
886 struct nm_config_file *ncf)
888 struct dt_device *dev;
890 struct lu_nodemap *nodemap;
891 struct lu_nodemap *nm_tmp;
892 struct lu_nid_range *range;
893 struct lu_nid_range *range_temp;
894 struct lu_idmap *idmap;
895 struct lu_idmap *id_tmp;
897 struct nodemap_key nk;
898 union nodemap_rec nr;
899 LIST_HEAD(nodemap_list_head);
904 if (ncf->ncf_los == NULL || ncf->ncf_obj == NULL)
907 dev = lu2dt_dev(ncf->ncf_obj->do_lu.lo_dev);
909 /* nodemap_cache_find_create will delete old conf file, so put here */
910 lu_object_put_nocache(env, &ncf->ncf_obj->do_lu);
913 /* force create a new index file to fill with active config */
914 o = nodemap_cache_find_create(env, dev, ncf->ncf_los, true);
916 GOTO(out, rc = PTR_ERR(o));
920 mutex_lock(&active_config_lock);
922 /* convert hash to list so we don't spin */
923 cfs_hash_for_each_safe(active_config->nmc_nodemap_hash,
924 nm_hash_list_cb, &nodemap_list_head);
926 list_for_each_entry_safe(nodemap, nm_tmp, &nodemap_list_head, nm_list) {
927 nodemap_cluster_key_init(&nk, nodemap->nm_id);
928 nodemap_cluster_rec_init(&nr, nodemap);
930 rc2 = nodemap_idx_insert(env, o, &nk, &nr);
936 down_read(&active_config->nmc_range_tree_lock);
937 list_for_each_entry_safe(range, range_temp, &nodemap->nm_ranges,
939 lnet_nid_t nid[2] = {
940 range->rn_node.in_extent.start,
941 range->rn_node.in_extent.end
943 nodemap_range_key_init(&nk, nodemap->nm_id,
945 nodemap_range_rec_init(&nr, nid);
946 rc2 = nodemap_idx_insert(env, o, &nk, &nr);
950 up_read(&active_config->nmc_range_tree_lock);
952 /* we don't need to take nm_idmap_lock because active config
953 * lock prevents changes from happening to nodemaps
955 root = nodemap->nm_client_to_fs_uidmap;
956 nm_rbtree_postorder_for_each_entry_safe(idmap, id_tmp, &root,
958 nodemap_idmap_key_init(&nk, nodemap->nm_id, NODEMAP_UID,
960 nodemap_idmap_rec_init(&nr, idmap->id_fs);
961 rc2 = nodemap_idx_insert(env, o, &nk, &nr);
966 root = nodemap->nm_client_to_fs_gidmap;
967 nm_rbtree_postorder_for_each_entry_safe(idmap, id_tmp, &root,
969 nodemap_idmap_key_init(&nk, nodemap->nm_id, NODEMAP_GID,
971 nodemap_idmap_rec_init(&nr, idmap->id_fs);
972 rc2 = nodemap_idx_insert(env, o, &nk, &nr);
977 nodemap_global_key_init(&nk);
978 nodemap_global_rec_init(&nr, active_config->nmc_nodemap_is_active);
979 rc2 = nodemap_idx_insert(env, o, &nk, &nr);
984 mutex_unlock(&active_config_lock);
988 static void nodemap_save_all_caches(void)
990 struct nm_config_file *ncf;
994 /* recreating nodemap cache requires fld_thread_key be in env */
995 rc = lu_env_init(&env, LCT_MD_THREAD | LCT_DT_THREAD | LCT_MG_THREAD);
997 CWARN("cannot init env for nodemap config: rc = %d\n", rc);
1001 mutex_lock(&ncf_list_lock);
1002 list_for_each_entry(ncf, &ncf_list_head, ncf_list) {
1003 rc = nodemap_save_config_cache(&env, ncf);
1004 if (rc < 0 && ncf->ncf_obj != NULL)
1005 CWARN("%s: error writing to nodemap config: rc = %d\n",
1006 ncf->ncf_obj->do_lu.lo_dev->ld_obd->obd_name, rc);
1008 mutex_unlock(&ncf_list_lock);
1013 /* tracks if config still needs to be loaded, either from disk or network */
1014 static bool nodemap_config_loaded;
1015 static DEFINE_MUTEX(nodemap_config_loaded_lock);
1018 * Ensures that configs loaded over the wire are prioritized over those loaded
1021 * \param config config to set as the active config
1023 void nodemap_config_set_active_mgc(struct nodemap_config *config)
1025 mutex_lock(&nodemap_config_loaded_lock);
1026 nodemap_config_set_active(config);
1027 nodemap_config_loaded = true;
1028 nodemap_save_all_caches();
1029 mutex_unlock(&nodemap_config_loaded_lock);
1031 EXPORT_SYMBOL(nodemap_config_set_active_mgc);
1034 * Register a dt_object representing the config index file. This should be
1035 * called by targets in order to load the nodemap configuration from disk. The
1036 * dt_object should be created with local_index_find_or_create and the index
1037 * features should be enabled with do_index_try.
1039 * \param obj dt_object returned by local_index_find_or_create
1041 * \retval on success: nm_config_file handle for later deregistration
1042 * \retval -ENOMEM memory allocation failure
1043 * \retval -ENOENT error loading nodemap config
1044 * \retval -EINVAL error loading nodemap config
1046 struct nm_config_file *nm_config_file_register(const struct lu_env *env,
1047 struct dt_object *obj,
1048 struct local_oid_storage *los,
1049 enum nm_config_file_type ncf_type)
1051 struct nm_config_file *ncf;
1052 bool save_config = false;
1058 RETURN(ERR_PTR(-ENOMEM));
1063 if (ncf_type == NCFT_MGS) {
1064 nodemap_mgs_ncf = ncf;
1066 mutex_lock(&ncf_list_lock);
1067 list_add(&ncf->ncf_list, &ncf_list_head);
1068 mutex_unlock(&ncf_list_lock);
1071 /* prevent activation of config loaded from MGS until disk is loaded
1072 * so disk config is overwritten by MGS config.
1074 mutex_lock(&nodemap_config_loaded_lock);
1075 if (ncf_type == NCFT_MGS || !nodemap_config_loaded)
1076 rc = nodemap_load_entries(env, obj);
1079 nodemap_config_loaded = true;
1080 mutex_unlock(&nodemap_config_loaded_lock);
1082 /* sync on disk caches with loaded config in memory */
1084 rc = nodemap_save_config_cache(env, ncf);
1087 if (ncf_type == NCFT_MGS) {
1088 nodemap_mgs_ncf = NULL;
1090 mutex_lock(&ncf_list_lock);
1091 list_del(&ncf->ncf_list);
1092 mutex_unlock(&ncf_list_lock);
1096 RETURN(ERR_PTR(rc));
1101 EXPORT_SYMBOL(nm_config_file_register);
1104 * Deregister a nm_config_file. Should be called by targets during cleanup.
1106 * \param ncf config file to deregister
1108 void nm_config_file_deregister(const struct lu_env *env,
1109 struct nm_config_file *ncf,
1110 enum nm_config_file_type ncf_type)
1115 lu_object_put(env, &ncf->ncf_obj->do_lu);
1117 if (ncf_type == NCFT_TGT) {
1118 mutex_lock(&ncf_list_lock);
1119 list_del(&ncf->ncf_list);
1120 mutex_unlock(&ncf_list_lock);
1122 nodemap_mgs_ncf = NULL;
1128 EXPORT_SYMBOL(nm_config_file_deregister);
1130 int nodemap_process_idx_pages(struct nodemap_config *config, union lu_page *lip,
1131 struct lu_nodemap **recent_nodemap)
1133 struct nodemap_key *key;
1134 union nodemap_rec *rec;
1139 int size = dt_nodemap_features.dif_keysize_max +
1140 dt_nodemap_features.dif_recsize_max;
1143 for (j = 0; j < LU_PAGE_COUNT; j++) {
1144 if (lip->lp_idx.lip_magic != LIP_MAGIC)
1147 /* get and process keys and records from page */
1148 for (k = 0; k < lip->lp_idx.lip_nr; k++) {
1149 entry = lip->lp_idx.lip_entries + k * size;
1150 key = (struct nodemap_key *)entry;
1152 entry += dt_nodemap_features.dif_keysize_max;
1153 rec = (union nodemap_rec *)entry;
1155 rc = nodemap_process_keyrec(config, key, rec,
1166 EXPORT_SYMBOL(nodemap_process_idx_pages);
1168 int nodemap_index_read(struct lu_env *env,
1169 struct nm_config_file *ncf,
1170 struct idx_info *ii,
1171 const struct lu_rdpg *rdpg)
1173 struct dt_object *nodemap_idx = ncf->ncf_obj;
1177 ii->ii_keysize = dt_nodemap_features.dif_keysize_max;
1178 ii->ii_recsize = dt_nodemap_features.dif_recsize_max;
1180 dt_read_lock(env, nodemap_idx, 0);
1181 version = dt_version_get(env, nodemap_idx);
1182 if (rdpg->rp_hash != 0 && ii->ii_version != version) {
1183 CDEBUG(D_INFO, "nodemap config changed while sending, "
1184 "old "LPU64", new "LPU64"\n",
1187 ii->ii_hash_end = 0;
1189 rc = dt_index_walk(env, nodemap_idx, rdpg, NULL, ii);
1190 CDEBUG(D_INFO, "walked index, hashend %llx\n", ii->ii_hash_end);
1194 ii->ii_version = version;
1196 dt_read_unlock(env, nodemap_idx);
1199 EXPORT_SYMBOL(nodemap_index_read);
1202 * Returns the current nodemap configuration to MGC by walking the nodemap
1203 * config index and storing it in the response buffer.
1205 * \param req incoming MGS_CONFIG_READ request
1207 * \retval -EINVAL malformed request
1208 * \retval -ENOTCONN client evicted/reconnected already
1209 * \retval -ETIMEDOUT client timeout or network error
1212 int nodemap_get_config_req(struct obd_device *mgs_obd,
1213 struct ptlrpc_request *req)
1215 struct mgs_config_body *body;
1216 struct mgs_config_res *res;
1217 struct lu_rdpg rdpg;
1218 struct idx_info nodemap_ii;
1219 struct ptlrpc_bulk_desc *desc;
1220 struct l_wait_info lwi;
1221 struct tg_export_data *rqexp_ted = &req->rq_export->exp_target_data;
1227 body = req_capsule_client_get(&req->rq_pill, &RMF_MGS_CONFIG_BODY);
1231 if (body->mcb_type != CONFIG_T_NODEMAP)
1234 rdpg.rp_count = (body->mcb_units << body->mcb_bits);
1235 rdpg.rp_npages = (rdpg.rp_count + PAGE_CACHE_SIZE - 1) >>
1237 if (rdpg.rp_npages > PTLRPC_MAX_BRW_PAGES)
1240 CDEBUG(D_INFO, "reading nodemap log, name '%s', size = %u\n",
1241 body->mcb_name, rdpg.rp_count);
1243 /* allocate pages to store the containers */
1244 OBD_ALLOC(rdpg.rp_pages, sizeof(*rdpg.rp_pages) * rdpg.rp_npages);
1245 if (rdpg.rp_pages == NULL)
1247 for (i = 0; i < rdpg.rp_npages; i++) {
1248 rdpg.rp_pages[i] = alloc_page(GFP_NOFS);
1249 if (rdpg.rp_pages[i] == NULL)
1250 GOTO(out, rc = -ENOMEM);
1253 rdpg.rp_hash = body->mcb_offset;
1254 nodemap_ii.ii_magic = IDX_INFO_MAGIC;
1255 nodemap_ii.ii_flags = II_FL_NOHASH;
1256 nodemap_ii.ii_version = rqexp_ted->ted_nodemap_version;
1258 bytes = nodemap_index_read(req->rq_svc_thread->t_env,
1259 mgs_obd->u.obt.obt_nodemap_config_file,
1260 &nodemap_ii, &rdpg);
1262 GOTO(out, rc = bytes);
1264 rqexp_ted->ted_nodemap_version = nodemap_ii.ii_version;
1266 res = req_capsule_server_get(&req->rq_pill, &RMF_MGS_CONFIG_RES);
1268 GOTO(out, rc = -EINVAL);
1269 res->mcr_offset = nodemap_ii.ii_hash_end;
1270 res->mcr_size = bytes;
1272 page_count = (bytes + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;
1273 LASSERT(page_count <= rdpg.rp_count);
1274 desc = ptlrpc_prep_bulk_exp(req, page_count, 1,
1275 PTLRPC_BULK_PUT_SOURCE |
1276 PTLRPC_BULK_BUF_KIOV,
1278 &ptlrpc_bulk_kiov_pin_ops);
1280 GOTO(out, rc = -ENOMEM);
1282 for (i = 0; i < page_count && bytes > 0; i++) {
1283 ptlrpc_prep_bulk_page_pin(desc, rdpg.rp_pages[i], 0,
1284 min_t(int, bytes, PAGE_CACHE_SIZE));
1285 bytes -= PAGE_CACHE_SIZE;
1288 rc = target_bulk_io(req->rq_export, desc, &lwi);
1289 ptlrpc_free_bulk(desc);
1292 if (rdpg.rp_pages != NULL) {
1293 for (i = 0; i < rdpg.rp_npages; i++)
1294 if (rdpg.rp_pages[i] != NULL)
1295 __free_page(rdpg.rp_pages[i]);
1296 OBD_FREE(rdpg.rp_pages,
1297 rdpg.rp_npages * sizeof(rdpg.rp_pages[0]));
1301 EXPORT_SYMBOL(nodemap_get_config_req);
1303 int nodemap_fs_init(const struct lu_env *env, struct dt_device *dev,
1304 struct obd_device *obd, struct local_oid_storage *los)
1306 struct dt_object *config_obj;
1307 struct nm_config_file *nm_config_file;
1311 CDEBUG(D_INFO, "%s: finding nodemap index\n", obd->obd_name);
1312 /* load or create the index file from disk (don't force create) */
1313 config_obj = nodemap_cache_find_create(env, dev, los, false);
1314 if (IS_ERR(config_obj))
1315 GOTO(out, rc = PTR_ERR(config_obj));
1317 CDEBUG(D_INFO, "%s: registering nodemap index\n", obd->obd_name);
1319 nm_config_file = nm_config_file_register(env, config_obj, los,
1321 if (IS_ERR(nm_config_file)) {
1322 CERROR("%s: error loading nodemap config file, file must be "
1323 "removed via ldiskfs: rc = %ld\n",
1324 obd->obd_name, PTR_ERR(nm_config_file));
1325 GOTO(out, rc = PTR_ERR(nm_config_file));
1328 obd->u.obt.obt_nodemap_config_file = nm_config_file;
1330 /* save los in case object needs to be re-created */
1331 nm_config_file->ncf_los = los;
1338 EXPORT_SYMBOL(nodemap_fs_init);
1340 void nodemap_fs_fini(const struct lu_env *env, struct obd_device *obd)
1342 if (obd->u.obt.obt_nodemap_config_file == NULL)
1345 nm_config_file_deregister(env, obd->u.obt.obt_nodemap_config_file,
1347 obd->u.obt.obt_nodemap_config_file = NULL;
1349 EXPORT_SYMBOL(nodemap_fs_fini);