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) 2017, Intel Corporation.
27 * Author: Joshua Walgenbach <jjw@iu.edu>
29 #include <linux/module.h>
30 #include <linux/sort.h>
31 #include <uapi/linux/lnet/nidstr.h>
32 #include <lustre_net.h>
33 #include <lustre_acl.h>
34 #include <obd_class.h>
35 #include "nodemap_internal.h"
37 #define HASH_NODEMAP_BKT_BITS 3
38 #define HASH_NODEMAP_CUR_BITS 3
39 #define HASH_NODEMAP_MAX_BITS 7
41 #define DEFAULT_NODEMAP "default"
43 /* nodemap proc root proc directory under fs/lustre */
44 struct proc_dir_entry *proc_lustre_nodemap_root;
46 /* Copy of config active flag to avoid locking in mapping functions */
49 /* Lock protecting the active config, useful primarily when proc and
50 * nodemap_hash might be replaced when loading a new config
51 * Any time the active config is referenced, the lock should be held.
53 DEFINE_MUTEX(active_config_lock);
54 struct nodemap_config *active_config;
59 * \param nodemap nodemap to destroy
61 static void nodemap_destroy(struct lu_nodemap *nodemap)
65 if (nodemap->nm_pde_data != NULL)
66 lprocfs_nodemap_remove(nodemap->nm_pde_data);
68 mutex_lock(&active_config_lock);
69 down_read(&active_config->nmc_range_tree_lock);
70 nm_member_reclassify_nodemap(nodemap);
71 up_read(&active_config->nmc_range_tree_lock);
73 down_write(&nodemap->nm_idmap_lock);
74 idmap_delete_tree(nodemap);
75 up_write(&nodemap->nm_idmap_lock);
77 mutex_unlock(&active_config_lock);
79 if (!list_empty(&nodemap->nm_member_list))
80 CWARN("nodemap_destroy failed to reclassify all members\n");
82 nm_member_delete_list(nodemap);
84 OBD_FREE_PTR(nodemap);
90 * Functions used for the cfs_hash
92 void nodemap_getref(struct lu_nodemap *nodemap)
94 atomic_inc(&nodemap->nm_refcount);
95 CDEBUG(D_INFO, "GETting nodemap %s(p=%p) : new refcount %d\n",
96 nodemap->nm_name, nodemap, atomic_read(&nodemap->nm_refcount));
100 * Destroy nodemap if last reference is put. Should be called outside
103 void nodemap_putref(struct lu_nodemap *nodemap)
108 LASSERT(atomic_read(&nodemap->nm_refcount) > 0);
110 CDEBUG(D_INFO, "PUTting nodemap %s(p=%p) : new refcount %d\n",
111 nodemap->nm_name, nodemap,
112 atomic_read(&nodemap->nm_refcount) - 1);
114 if (atomic_dec_and_test(&nodemap->nm_refcount))
115 nodemap_destroy(nodemap);
117 EXPORT_SYMBOL(nodemap_putref);
119 static __u32 nodemap_hashfn(struct cfs_hash *hash_body,
120 const void *key, unsigned mask)
122 return cfs_hash_djb2_hash(key, strlen(key), mask);
125 static void *nodemap_hs_key(struct hlist_node *hnode)
127 struct lu_nodemap *nodemap;
129 nodemap = hlist_entry(hnode, struct lu_nodemap, nm_hash);
131 return nodemap->nm_name;
134 static int nodemap_hs_keycmp(const void *key,
135 struct hlist_node *compared_hnode)
139 nodemap_name = nodemap_hs_key(compared_hnode);
141 return !strcmp(key, nodemap_name);
144 static void *nodemap_hs_hashobject(struct hlist_node *hnode)
146 return hlist_entry(hnode, struct lu_nodemap, nm_hash);
149 static void nodemap_hs_get(struct cfs_hash *hs, struct hlist_node *hnode)
151 struct lu_nodemap *nodemap;
153 nodemap = hlist_entry(hnode, struct lu_nodemap, nm_hash);
154 nodemap_getref(nodemap);
157 static void nodemap_hs_put_locked(struct cfs_hash *hs,
158 struct hlist_node *hnode)
160 struct lu_nodemap *nodemap;
162 nodemap = hlist_entry(hnode, struct lu_nodemap, nm_hash);
163 nodemap_putref(nodemap);
166 static struct cfs_hash_ops nodemap_hash_operations = {
167 .hs_hash = nodemap_hashfn,
168 .hs_key = nodemap_hs_key,
169 .hs_keycmp = nodemap_hs_keycmp,
170 .hs_object = nodemap_hs_hashobject,
171 .hs_get = nodemap_hs_get,
172 .hs_put_locked = nodemap_hs_put_locked,
175 /* end of cfs_hash functions */
178 * Initialize nodemap_hash
181 * \retval -ENOMEM cannot create hash
183 static int nodemap_init_hash(struct nodemap_config *nmc)
185 nmc->nmc_nodemap_hash = cfs_hash_create("NODEMAP",
186 HASH_NODEMAP_CUR_BITS,
187 HASH_NODEMAP_MAX_BITS,
188 HASH_NODEMAP_BKT_BITS, 0,
191 &nodemap_hash_operations,
194 if (nmc->nmc_nodemap_hash == NULL) {
195 CERROR("cannot create nodemap_hash table\n");
203 * Check for valid nodemap name
205 * \param name nodemap name
207 * \retval false invalid
209 static bool nodemap_name_is_valid(const char *name)
211 if (strlen(name) > LUSTRE_NODEMAP_NAME_LENGTH ||
215 for (; *name != '\0'; name++) {
216 if (!isalnum(*name) && *name != '_')
226 * Look nodemap up in the active_config nodemap hash. Caller should hold the
227 * active_config_lock.
229 * \param name name of nodemap
230 * \retval nodemap pointer set to found nodemap
231 * \retval -EINVAL name is not valid
232 * \retval -ENOENT nodemap not found
234 struct lu_nodemap *nodemap_lookup(const char *name)
236 struct lu_nodemap *nodemap = NULL;
238 if (!nodemap_name_is_valid(name))
239 return ERR_PTR(-EINVAL);
241 nodemap = cfs_hash_lookup(active_config->nmc_nodemap_hash, name);
243 return ERR_PTR(-ENOENT);
249 * Classify the nid into the proper nodemap. Caller must hold active config and
250 * nm_range_tree_lock, and call nodemap_putref when done with nodemap.
252 * \param nid nid to classify
253 * \retval nodemap nodemap containing the nid
254 * \retval default_nodemap default nodemap
255 * \retval -EINVAL LO nid given without other local nid
257 struct lu_nodemap *nodemap_classify_nid(lnet_nid_t nid)
259 struct lu_nid_range *range;
260 struct lu_nodemap *nodemap;
265 /* don't use 0@lo, use the first non-lo local NID instead */
266 if (nid == LNET_NID_LO_0) {
267 struct lnet_processid id;
271 rc = LNetGetId(i++, &id);
273 RETURN(ERR_PTR(-EINVAL));
274 } while (nid_is_lo0(&id.nid));
276 nid = lnet_nid_to_nid4(&id.nid);
277 CDEBUG(D_INFO, "found nid %s\n", libcfs_nid2str(nid));
280 range = range_search(&active_config->nmc_range_tree, nid);
282 nodemap = range->rn_nodemap;
284 nodemap = active_config->nmc_default_nodemap;
286 LASSERT(nodemap != NULL);
287 nodemap_getref(nodemap);
293 * simple check for default nodemap
295 static bool is_default_nodemap(const struct lu_nodemap *nodemap)
297 return nodemap->nm_id == 0;
301 * parse a nodemap range string into two nids
303 * \param range_str string to parse
304 * \param range[2] array of two nids
305 * \reyval 0 on success
307 int nodemap_parse_range(const char *range_str, lnet_nid_t range[2])
309 char buf[LNET_NIDSTR_SIZE * 2 + 2];
315 snprintf(buf, sizeof(buf), "%s", range_str);
317 start_nidstr = strsep(&ptr, ":");
318 end_nidstr = strsep(&ptr, ":");
320 if (start_nidstr == NULL || end_nidstr == NULL)
321 GOTO(out, rc = -EINVAL);
323 range[0] = libcfs_str2nid(start_nidstr);
324 range[1] = libcfs_str2nid(end_nidstr);
330 EXPORT_SYMBOL(nodemap_parse_range);
333 * parse a string containing an id map of form "client_id:filesystem_id"
334 * into an array of __u32 * for use in mapping functions
336 * \param idmap_str map string
337 * \param idmap array[2] of __u32
339 * \retval 0 on success
340 * \retval -EINVAL if idmap cannot be parsed
342 int nodemap_parse_idmap(char *idmap_str, __u32 idmap[2])
345 long unsigned int idmap_buf;
348 if (idmap_str == NULL)
351 sep = strchr(idmap_str, ':');
357 rc = kstrtoul(idmap_str, 10, &idmap_buf);
360 idmap[0] = idmap_buf;
362 rc = kstrtoul(sep, 10, &idmap_buf);
365 idmap[1] = idmap_buf;
369 EXPORT_SYMBOL(nodemap_parse_idmap);
372 * add a member to a nodemap
374 * \param nid nid to add to the members
375 * \param exp obd_export structure for the connection
376 * that is being added
377 * \retval -EINVAL export is NULL, or has invalid NID
378 * \retval -EEXIST export is already member of a nodemap
380 int nodemap_add_member(lnet_nid_t nid, struct obd_export *exp)
382 struct lu_nodemap *nodemap;
386 mutex_lock(&active_config_lock);
387 down_read(&active_config->nmc_range_tree_lock);
389 nodemap = nodemap_classify_nid(nid);
391 if (IS_ERR(nodemap)) {
392 CWARN("%s: error adding to nodemap, no valid NIDs found\n",
393 exp->exp_obd->obd_name);
396 rc = nm_member_add(nodemap, exp);
399 up_read(&active_config->nmc_range_tree_lock);
400 mutex_unlock(&active_config_lock);
402 if (!IS_ERR(nodemap))
403 nodemap_putref(nodemap);
407 EXPORT_SYMBOL(nodemap_add_member);
410 * delete a member from a nodemap
412 * \param exp export to remove from a nodemap
414 void nodemap_del_member(struct obd_export *exp)
416 struct lu_nodemap *nodemap;
420 /* using ac lock to prevent nodemap reclassification while deleting */
421 mutex_lock(&active_config_lock);
423 /* use of ted_nodemap is protected by active_config_lock. we take an
424 * extra reference to make sure nodemap isn't destroyed under
427 nodemap = exp->exp_target_data.ted_nodemap;
431 nodemap_getref(nodemap);
433 mutex_lock(&nodemap->nm_member_list_lock);
434 nm_member_del(nodemap, exp);
435 mutex_unlock(&nodemap->nm_member_list_lock);
438 mutex_unlock(&active_config_lock);
441 nodemap_putref(nodemap);
445 EXPORT_SYMBOL(nodemap_del_member);
448 * add an idmap to the proper nodemap trees
450 * \param nodemap nodemap to add idmap to
451 * \param id_type NODEMAP_UID or NODEMAP_GID
452 * \param map array[2] __u32 containing the map values
453 * map[0] is client id
454 * map[1] is the filesystem id
456 * \retval 0 on success
457 * \retval < 0 if error occurs
459 int nodemap_add_idmap_helper(struct lu_nodemap *nodemap,
460 enum nodemap_id_type id_type,
463 struct lu_idmap *idmap;
464 struct lu_idmap *temp;
467 idmap = idmap_create(map[0], map[1]);
469 GOTO(out, rc = -ENOMEM);
471 down_write(&nodemap->nm_idmap_lock);
472 temp = idmap_insert(id_type, idmap, nodemap);
473 /* If the new id_client or id_fs is matched, the old idmap and its
474 * index should be deleted according to its id_client before the new
475 * idmap is added again.
478 GOTO(out_insert, rc = PTR_ERR(temp));
482 del_map[0] = temp->id_client;
483 idmap_delete(id_type, temp, nodemap);
484 rc = nodemap_idx_idmap_del(nodemap, id_type, del_map);
485 /* In case there is any corrupted idmap */
486 if (!rc || unlikely(rc == -ENOENT)) {
487 temp = idmap_insert(id_type, idmap, nodemap);
499 up_write(&nodemap->nm_idmap_lock);
500 nm_member_revoke_locks(nodemap);
506 int nodemap_add_idmap(const char *name, enum nodemap_id_type id_type,
509 struct lu_nodemap *nodemap = NULL;
514 mutex_lock(&active_config_lock);
515 nodemap = nodemap_lookup(name);
516 if (IS_ERR(nodemap)) {
517 mutex_unlock(&active_config_lock);
518 GOTO(out, rc = PTR_ERR(nodemap));
521 if (is_default_nodemap(nodemap)) {
524 rc = nodemap_add_idmap_helper(nodemap, id_type, map);
526 rc = nodemap_idx_idmap_add(nodemap, id_type, map);
528 mutex_unlock(&active_config_lock);
529 nodemap_putref(nodemap);
534 EXPORT_SYMBOL(nodemap_add_idmap);
537 * delete idmap from proper nodemap tree
539 * \param name name of nodemap
540 * \param id_type NODEMAP_UID or NODEMAP_GID
541 * \param map array[2] __u32 containing the mapA values
542 * map[0] is client id
543 * map[1] is the filesystem id
545 * \retval 0 on success
547 int nodemap_del_idmap(const char *name, enum nodemap_id_type id_type,
550 struct lu_nodemap *nodemap = NULL;
551 struct lu_idmap *idmap = NULL;
556 mutex_lock(&active_config_lock);
557 nodemap = nodemap_lookup(name);
558 if (IS_ERR(nodemap)) {
559 mutex_unlock(&active_config_lock);
560 GOTO(out, rc = PTR_ERR(nodemap));
563 if (is_default_nodemap(nodemap))
564 GOTO(out_putref, rc = -EINVAL);
566 down_write(&nodemap->nm_idmap_lock);
567 idmap = idmap_search(nodemap, NODEMAP_CLIENT_TO_FS, id_type,
572 idmap_delete(id_type, idmap, nodemap);
573 rc = nodemap_idx_idmap_del(nodemap, id_type, map);
575 up_write(&nodemap->nm_idmap_lock);
578 mutex_unlock(&active_config_lock);
580 nm_member_revoke_locks(nodemap);
581 nodemap_putref(nodemap);
586 EXPORT_SYMBOL(nodemap_del_idmap);
589 * Get nodemap assigned to given export. Takes a reference on the nodemap.
591 * Note that this function may return either NULL, or an ERR_PTR()
592 * or a valid nodemap pointer. All of the functions accessing the
593 * returned nodemap can check IS_ERR(nodemap) to see if an error is
594 * returned. NULL is not considered an error, which is OK since this
595 * is a valid case if nodemap are not in use. All nodemap handling
596 * functions must check for nodemap == NULL and do nothing, and the
597 * nodemap returned from this function should not be dereferenced.
599 * \param export export to get nodemap for
601 * \retval pointer to nodemap on success
602 * \retval NULL nodemap subsystem disabled
603 * \retval -EACCES export does not have nodemap assigned
605 struct lu_nodemap *nodemap_get_from_exp(struct obd_export *exp)
607 struct lu_nodemap *nodemap;
614 spin_lock(&exp->exp_target_data.ted_nodemap_lock);
615 nodemap = exp->exp_target_data.ted_nodemap;
617 nodemap_getref(nodemap);
618 spin_unlock(&exp->exp_target_data.ted_nodemap_lock);
621 CDEBUG(D_INFO, "%s: nodemap null on export %s (at %s)\n",
622 exp->exp_obd->obd_name,
623 obd_uuid2str(&exp->exp_client_uuid),
624 obd_export_nid2str(exp));
625 RETURN(ERR_PTR(-EACCES));
630 EXPORT_SYMBOL(nodemap_get_from_exp);
633 * mapping function for nodemap idmaps
635 * \param nodemap lu_nodemap structure defining nodemap
636 * \param node_type NODEMAP_UID or NODEMAP_GID or NODEMAP_PROJID
637 * \param tree_type NODEMAP_CLIENT_TO_FS or
638 * NODEMAP_FS_TO_CLIENT
639 * \param id id to map
641 * \retval mapped id according to the rules below.
643 * if the nodemap_active is false, just return the passed id without mapping
645 * if the id to be looked up is 0, check that root access is allowed and if it
646 * is, return 0. Otherwise, return the squash uid or gid.
648 * if the nodemap is configured to trusted the ids from the client system, just
649 * return the passed id without mapping.
651 * if by this point, we haven't returned and the nodemap in question is the
652 * default nodemap, return the squash uid or gid.
654 * after these checks, search the proper tree for the mapping, and if found
655 * return the mapped value, otherwise return the squash uid or gid.
657 __u32 nodemap_map_id(struct lu_nodemap *nodemap,
658 enum nodemap_id_type id_type,
659 enum nodemap_tree_type tree_type, __u32 id)
661 struct lu_idmap *idmap = NULL;
669 if (unlikely(nodemap == NULL))
673 if (nodemap->nmf_allow_root_access)
678 if (id_type == NODEMAP_UID &&
679 !(nodemap->nmf_map_mode & NODEMAP_MAP_UID))
682 if (id_type == NODEMAP_GID &&
683 !(nodemap->nmf_map_mode & NODEMAP_MAP_GID))
686 if (id_type == NODEMAP_PROJID &&
687 !(nodemap->nmf_map_mode & NODEMAP_MAP_PROJID))
690 if (nodemap->nmf_trust_client_ids)
693 if (is_default_nodemap(nodemap))
696 down_read(&nodemap->nm_idmap_lock);
697 idmap = idmap_search(nodemap, tree_type, id_type, id);
699 up_read(&nodemap->nm_idmap_lock);
703 if (tree_type == NODEMAP_FS_TO_CLIENT)
704 found_id = idmap->id_client;
706 found_id = idmap->id_fs;
707 up_read(&nodemap->nm_idmap_lock);
711 if (id_type == NODEMAP_UID)
712 RETURN(nodemap->nm_squash_uid);
713 if (id_type == NODEMAP_GID)
714 RETURN(nodemap->nm_squash_gid);
715 if (id_type == NODEMAP_PROJID)
716 RETURN(nodemap->nm_squash_projid);
720 EXPORT_SYMBOL(nodemap_map_id);
723 * Map posix ACL entries according to the nodemap membership. Removes any
726 * \param lu_nodemap nodemap
727 * \param buf buffer containing xattr encoded ACLs
728 * \param size size of ACLs in bytes
729 * \param tree_type direction of mapping
730 * \retval size new size of ACLs in bytes
731 * \retval -EINVAL bad \a size param, see posix_acl_xattr_count()
733 ssize_t nodemap_map_acl(struct lu_nodemap *nodemap, void *buf, size_t size,
734 enum nodemap_tree_type tree_type)
736 posix_acl_xattr_header *header = buf;
737 posix_acl_xattr_entry *entry = GET_POSIX_ACL_XATTR_ENTRY(header);
738 posix_acl_xattr_entry *new_entry = entry;
739 posix_acl_xattr_entry *end;
747 if (unlikely(nodemap == NULL))
750 count = posix_acl_xattr_count(size);
754 /* if not proper ACL, do nothing and return initial size */
757 for (end = entry + count; entry != end; entry++) {
758 __u16 tag = le16_to_cpu(entry->e_tag);
759 __u32 id = le32_to_cpu(entry->e_id);
763 id = nodemap_map_id(nodemap, NODEMAP_UID,
765 if (id == nodemap->nm_squash_uid)
767 entry->e_id = cpu_to_le32(id);
770 id = nodemap_map_id(nodemap, NODEMAP_GID,
772 if (id == nodemap->nm_squash_gid)
774 entry->e_id = cpu_to_le32(id);
778 /* if we skip an ACL, copy the following ones over it */
779 if (new_entry != entry)
785 RETURN((void *)new_entry - (void *)header);
787 EXPORT_SYMBOL(nodemap_map_acl);
790 * Add nid range to given nodemap
792 * \param config nodemap config to work on
793 * \param nodemap nodemap to add range to
794 * \param nid nid range to add
795 * \param range_id should be 0 unless loading from disk
800 int nodemap_add_range_helper(struct nodemap_config *config,
801 struct lu_nodemap *nodemap,
802 const lnet_nid_t nid[2],
803 unsigned int range_id)
805 struct lu_nid_range *range;
808 down_write(&config->nmc_range_tree_lock);
809 range = range_create(&config->nmc_range_tree, nid[0], nid[1],
812 up_write(&config->nmc_range_tree_lock);
813 GOTO(out, rc = -ENOMEM);
816 rc = range_insert(&config->nmc_range_tree, range);
818 CDEBUG_LIMIT(rc == -EEXIST ? D_INFO : D_ERROR,
819 "cannot insert nodemap range into '%s': rc = %d\n",
820 nodemap->nm_name, rc);
821 up_write(&config->nmc_range_tree_lock);
822 list_del(&range->rn_list);
823 range_destroy(range);
827 list_add(&range->rn_list, &nodemap->nm_ranges);
829 /* nodemaps have no members if they aren't on the active config */
830 if (config == active_config)
831 nm_member_reclassify_nodemap(config->nmc_default_nodemap);
833 up_write(&config->nmc_range_tree_lock);
835 /* if range_id is non-zero, we are loading from disk */
837 rc = nodemap_idx_range_add(range, nid);
839 if (config == active_config) {
840 nm_member_revoke_locks(config->nmc_default_nodemap);
841 nm_member_revoke_locks(nodemap);
848 int nodemap_add_range(const char *name, const lnet_nid_t nid[2])
850 struct lu_nodemap *nodemap = NULL;
853 mutex_lock(&active_config_lock);
854 nodemap = nodemap_lookup(name);
855 if (IS_ERR(nodemap)) {
856 mutex_unlock(&active_config_lock);
857 GOTO(out, rc = PTR_ERR(nodemap));
860 if (is_default_nodemap(nodemap))
863 rc = nodemap_add_range_helper(active_config, nodemap, nid, 0);
864 mutex_unlock(&active_config_lock);
865 nodemap_putref(nodemap);
869 EXPORT_SYMBOL(nodemap_add_range);
873 * \param name nodemap name
874 * \param nid nid range
875 * \retval 0 on success
877 * Delete range from global range tree, and remove it
878 * from the list in the associated nodemap.
880 int nodemap_del_range(const char *name, const lnet_nid_t nid[2])
882 struct lu_nodemap *nodemap;
883 struct lu_nid_range *range;
886 mutex_lock(&active_config_lock);
887 nodemap = nodemap_lookup(name);
888 if (IS_ERR(nodemap)) {
889 mutex_unlock(&active_config_lock);
890 GOTO(out, rc = PTR_ERR(nodemap));
893 if (is_default_nodemap(nodemap))
894 GOTO(out_putref, rc = -EINVAL);
896 down_write(&active_config->nmc_range_tree_lock);
897 range = range_find(&active_config->nmc_range_tree, nid[0], nid[1]);
899 up_write(&active_config->nmc_range_tree_lock);
900 GOTO(out_putref, rc = -EINVAL);
902 if (range->rn_nodemap != nodemap) {
903 up_write(&active_config->nmc_range_tree_lock);
904 GOTO(out_putref, rc = -EINVAL);
906 rc = nodemap_idx_range_del(range);
907 range_delete(&active_config->nmc_range_tree, range);
908 nm_member_reclassify_nodemap(nodemap);
909 up_write(&active_config->nmc_range_tree_lock);
911 nm_member_revoke_locks(active_config->nmc_default_nodemap);
912 nm_member_revoke_locks(nodemap);
915 mutex_unlock(&active_config_lock);
916 nodemap_putref(nodemap);
920 EXPORT_SYMBOL(nodemap_del_range);
923 * set fileset on nodemap
924 * \param name nodemap to set fileset on
925 * \param fileset string containing fileset
926 * \retval 0 on success
928 * set a fileset on the named nodemap
930 static int nodemap_set_fileset_helper(struct nodemap_config *config,
931 struct lu_nodemap *nodemap,
936 /* Allow 'fileset=clear' in addition to 'fileset=""' to clear fileset
937 * because either command 'lctl set_param -P *.*.fileset=""' or
938 * 'lctl nodemap_set_fileset --fileset ""' can only work correctly
939 * on MGS, while on other servers, both commands will invoke upcall
940 * "/usr/sbin/lctl set_param nodemap.default.fileset=" by function
941 * process_param2_config(), which will cause "no value" error and
942 * won't clear fileset.
943 * 'fileset=""' is still kept for compatibility reason.
947 else if (fileset[0] == '\0' || strcmp(fileset, "clear") == 0)
948 nodemap->nm_fileset[0] = '\0';
949 else if (fileset[0] != '/')
951 else if (strlcpy(nodemap->nm_fileset, fileset,
952 sizeof(nodemap->nm_fileset)) >=
953 sizeof(nodemap->nm_fileset))
959 int nodemap_set_fileset(const char *name, const char *fileset)
961 struct lu_nodemap *nodemap = NULL;
964 mutex_lock(&active_config_lock);
965 nodemap = nodemap_lookup(name);
966 if (IS_ERR(nodemap)) {
967 mutex_unlock(&active_config_lock);
968 GOTO(out, rc = PTR_ERR(nodemap));
971 rc = nodemap_set_fileset_helper(active_config, nodemap, fileset);
972 mutex_unlock(&active_config_lock);
974 nodemap_putref(nodemap);
978 EXPORT_SYMBOL(nodemap_set_fileset);
981 * get fileset defined on nodemap
982 * \param nodemap nodemap to get fileset from
983 * \retval fileset name, or NULL if not defined or not activated
985 * get the fileset defined on the nodemap
987 char *nodemap_get_fileset(const struct lu_nodemap *nodemap)
992 return (char *)nodemap->nm_fileset;
994 EXPORT_SYMBOL(nodemap_get_fileset);
996 static int nodemap_validate_sepol(const char *sepol)
998 char buf[LUSTRE_NODEMAP_SEPOL_LENGTH + 1];
999 char *p = (char *)sepol;
1001 char polname[NAME_MAX + 1] = "";
1002 char hash[SELINUX_POLICY_HASH_LEN + 1] = "";
1006 BUILD_BUG_ON(sizeof(buf) != sizeof(((struct lu_nodemap *)0)->nm_sepol));
1011 /* we allow sepol = "" which means clear SELinux policy info */
1012 if (sepol[0] == '\0')
1015 /* make a copy of sepol, by replacing ':' with space
1016 * so that we can use sscanf over the string
1018 while (p-sepol < sizeof(buf)) {
1028 if (p-sepol == sizeof(buf))
1029 return -ENAMETOOLONG;
1031 if (sscanf(buf, "%1hhu %s %hu %s", &mode, polname, &ver, hash) != 4)
1034 if (mode != 0 && mode != 1)
1041 * set SELinux policy on nodemap
1042 * \param name nodemap to set SELinux policy info on
1043 * \param sepol string containing SELinux policy info
1044 * \retval 0 on success
1046 * set SELinux policy info on the named nodemap
1048 int nodemap_set_sepol(const char *name, const char *sepol)
1050 struct lu_nodemap *nodemap = NULL;
1053 rc = nodemap_validate_sepol(sepol);
1057 mutex_lock(&active_config_lock);
1058 nodemap = nodemap_lookup(name);
1059 if (IS_ERR(nodemap)) {
1060 mutex_unlock(&active_config_lock);
1061 GOTO(out, rc = PTR_ERR(nodemap));
1064 if (is_default_nodemap(nodemap)) {
1065 /* We do not want nodes in the default nodemap to have
1066 * SELinux restrictions. Sec admin should create dedicated
1067 * nodemap entries for this.
1069 GOTO(out_putref, rc = -EINVAL);
1072 /* truncation cannot happen, as string length was checked in
1073 * nodemap_validate_sepol()
1075 strlcpy(nodemap->nm_sepol, sepol, sizeof(nodemap->nm_sepol));
1078 mutex_unlock(&active_config_lock);
1079 nodemap_putref(nodemap);
1083 EXPORT_SYMBOL(nodemap_set_sepol);
1086 * get SELinux policy info defined on nodemap
1087 * \param nodemap nodemap to get SELinux policy info from
1088 * \retval SELinux policy info, or NULL if not defined or not activated
1090 * get the SELinux policy info defined on the nodemap
1092 const char *nodemap_get_sepol(const struct lu_nodemap *nodemap)
1094 if (is_default_nodemap(nodemap))
1097 return (char *)nodemap->nm_sepol;
1099 EXPORT_SYMBOL(nodemap_get_sepol);
1102 * Nodemap constructor
1104 * Creates an lu_nodemap structure and assigns sane default
1105 * member values. If this is the default nodemap, the defaults
1106 * are the most restrictive in terms of mapping behavior. Otherwise
1107 * the default flags should be inherited from the default nodemap.
1108 * The adds nodemap to nodemap_hash.
1110 * Requires that the caller take the active_config_lock
1112 * \param name name of nodemap
1113 * \param is_default true if default nodemap
1114 * \retval nodemap success
1115 * \retval -EINVAL invalid nodemap name
1116 * \retval -EEXIST nodemap already exists
1117 * \retval -ENOMEM cannot allocate memory for nodemap
1119 struct lu_nodemap *nodemap_create(const char *name,
1120 struct nodemap_config *config,
1123 struct lu_nodemap *nodemap = NULL;
1124 struct lu_nodemap *default_nodemap;
1125 struct cfs_hash *hash = config->nmc_nodemap_hash;
1129 default_nodemap = config->nmc_default_nodemap;
1131 if (!nodemap_name_is_valid(name))
1132 GOTO(out, rc = -EINVAL);
1135 CERROR("Config nodemap hash is NULL, unable to add %s\n", name);
1136 GOTO(out, rc = -EINVAL);
1139 OBD_ALLOC_PTR(nodemap);
1140 if (nodemap == NULL) {
1141 CERROR("cannot allocate memory (%zu bytes) for nodemap '%s'\n",
1142 sizeof(*nodemap), name);
1143 GOTO(out, rc = -ENOMEM);
1147 * take an extra reference to prevent nodemap from being destroyed
1148 * while it's being created.
1150 atomic_set(&nodemap->nm_refcount, 2);
1151 snprintf(nodemap->nm_name, sizeof(nodemap->nm_name), "%s", name);
1152 rc = cfs_hash_add_unique(hash, name, &nodemap->nm_hash);
1154 OBD_FREE_PTR(nodemap);
1155 GOTO(out, rc = -EEXIST);
1158 INIT_LIST_HEAD(&nodemap->nm_ranges);
1159 INIT_LIST_HEAD(&nodemap->nm_list);
1160 INIT_LIST_HEAD(&nodemap->nm_member_list);
1162 mutex_init(&nodemap->nm_member_list_lock);
1163 init_rwsem(&nodemap->nm_idmap_lock);
1164 nodemap->nm_fs_to_client_uidmap = RB_ROOT;
1165 nodemap->nm_client_to_fs_uidmap = RB_ROOT;
1166 nodemap->nm_fs_to_client_gidmap = RB_ROOT;
1167 nodemap->nm_client_to_fs_gidmap = RB_ROOT;
1168 nodemap->nm_fs_to_client_projidmap = RB_ROOT;
1169 nodemap->nm_client_to_fs_projidmap = RB_ROOT;
1172 nodemap->nm_id = LUSTRE_NODEMAP_DEFAULT_ID;
1173 config->nmc_default_nodemap = nodemap;
1175 config->nmc_nodemap_highest_id++;
1176 nodemap->nm_id = config->nmc_nodemap_highest_id;
1179 if (is_default || default_nodemap == NULL) {
1180 nodemap->nmf_trust_client_ids = 0;
1181 nodemap->nmf_allow_root_access = 0;
1182 nodemap->nmf_deny_unknown = 0;
1183 nodemap->nmf_map_mode = NODEMAP_MAP_ALL;
1184 nodemap->nmf_enable_audit = 1;
1185 nodemap->nmf_forbid_encryption = 0;
1186 nodemap->nmf_readonly_mount = 0;
1187 nodemap->nmf_rbac = NODEMAP_RBAC_ALL;
1189 nodemap->nm_squash_uid = NODEMAP_NOBODY_UID;
1190 nodemap->nm_squash_gid = NODEMAP_NOBODY_GID;
1191 nodemap->nm_squash_projid = NODEMAP_NOBODY_PROJID;
1192 nodemap->nm_fileset[0] = '\0';
1193 nodemap->nm_sepol[0] = '\0';
1195 CWARN("adding nodemap '%s' to config without"
1196 " default nodemap\n", nodemap->nm_name);
1198 nodemap->nmf_trust_client_ids =
1199 default_nodemap->nmf_trust_client_ids;
1200 nodemap->nmf_allow_root_access =
1201 default_nodemap->nmf_allow_root_access;
1202 nodemap->nmf_deny_unknown = default_nodemap->nmf_deny_unknown;
1203 nodemap->nmf_map_mode = default_nodemap->nmf_map_mode;
1204 nodemap->nmf_enable_audit = default_nodemap->nmf_enable_audit;
1205 nodemap->nmf_forbid_encryption =
1206 default_nodemap->nmf_forbid_encryption;
1207 nodemap->nmf_readonly_mount =
1208 default_nodemap->nmf_readonly_mount;
1209 nodemap->nmf_rbac = default_nodemap->nmf_rbac;
1211 nodemap->nm_squash_uid = default_nodemap->nm_squash_uid;
1212 nodemap->nm_squash_gid = default_nodemap->nm_squash_gid;
1213 nodemap->nm_squash_projid = default_nodemap->nm_squash_projid;
1214 nodemap->nm_fileset[0] = '\0';
1215 nodemap->nm_sepol[0] = '\0';
1221 CERROR("cannot add nodemap: '%s': rc = %d\n", name, rc);
1222 RETURN(ERR_PTR(rc));
1226 * Set the nmf_deny_unknown flag to true or false.
1227 * \param name nodemap name
1228 * \param deny_unknown if true, squashed users will get EACCES
1229 * \retval 0 on success
1232 int nodemap_set_deny_unknown(const char *name, bool deny_unknown)
1234 struct lu_nodemap *nodemap = NULL;
1237 mutex_lock(&active_config_lock);
1238 nodemap = nodemap_lookup(name);
1239 mutex_unlock(&active_config_lock);
1240 if (IS_ERR(nodemap))
1241 GOTO(out, rc = PTR_ERR(nodemap));
1243 nodemap->nmf_deny_unknown = deny_unknown;
1244 rc = nodemap_idx_nodemap_update(nodemap);
1246 nm_member_revoke_locks(nodemap);
1247 nodemap_putref(nodemap);
1251 EXPORT_SYMBOL(nodemap_set_deny_unknown);
1254 * Set the nmf_allow_root_access flag to true or false.
1255 * \param name nodemap name
1256 * \param allow_root if true, nodemap will not squash the root user
1257 * \retval 0 on success
1260 int nodemap_set_allow_root(const char *name, bool allow_root)
1262 struct lu_nodemap *nodemap = NULL;
1265 mutex_lock(&active_config_lock);
1266 nodemap = nodemap_lookup(name);
1267 mutex_unlock(&active_config_lock);
1268 if (IS_ERR(nodemap))
1269 GOTO(out, rc = PTR_ERR(nodemap));
1271 nodemap->nmf_allow_root_access = allow_root;
1272 rc = nodemap_idx_nodemap_update(nodemap);
1274 nm_member_revoke_locks(nodemap);
1275 nodemap_putref(nodemap);
1279 EXPORT_SYMBOL(nodemap_set_allow_root);
1282 * Set the nmf_trust_client_ids flag to true or false.
1284 * \param name nodemap name
1285 * \param trust_client_ids if true, nodemap will not map its IDs
1286 * \retval 0 on success
1289 int nodemap_set_trust_client_ids(const char *name, bool trust_client_ids)
1291 struct lu_nodemap *nodemap = NULL;
1294 mutex_lock(&active_config_lock);
1295 nodemap = nodemap_lookup(name);
1296 mutex_unlock(&active_config_lock);
1297 if (IS_ERR(nodemap))
1298 GOTO(out, rc = PTR_ERR(nodemap));
1300 nodemap->nmf_trust_client_ids = trust_client_ids;
1301 rc = nodemap_idx_nodemap_update(nodemap);
1303 nm_member_revoke_locks(nodemap);
1304 nodemap_putref(nodemap);
1308 EXPORT_SYMBOL(nodemap_set_trust_client_ids);
1310 int nodemap_set_mapping_mode(const char *name,
1311 enum nodemap_mapping_modes map_mode)
1313 struct lu_nodemap *nodemap = NULL;
1316 mutex_lock(&active_config_lock);
1317 nodemap = nodemap_lookup(name);
1318 mutex_unlock(&active_config_lock);
1319 if (IS_ERR(nodemap))
1320 GOTO(out, rc = PTR_ERR(nodemap));
1322 nodemap->nmf_map_mode = map_mode;
1323 rc = nodemap_idx_nodemap_update(nodemap);
1325 nm_member_revoke_locks(nodemap);
1326 nodemap_putref(nodemap);
1330 EXPORT_SYMBOL(nodemap_set_mapping_mode);
1332 int nodemap_set_rbac(const char *name, enum nodemap_rbac_roles rbac)
1334 struct lu_nodemap *nodemap = NULL;
1335 enum nodemap_rbac_roles old_rbac;
1338 mutex_lock(&active_config_lock);
1339 nodemap = nodemap_lookup(name);
1340 mutex_unlock(&active_config_lock);
1341 if (IS_ERR(nodemap))
1342 GOTO(out, rc = PTR_ERR(nodemap));
1344 if (is_default_nodemap(nodemap))
1345 GOTO(put, rc = -EINVAL);
1347 old_rbac = nodemap->nmf_rbac;
1348 /* if value does not change, do nothing */
1349 if (rbac == old_rbac)
1352 nodemap->nmf_rbac = rbac;
1353 if (rbac == NODEMAP_RBAC_ALL)
1354 /* if new value is ALL (default), just delete
1355 * NODEMAP_CLUSTER_ROLES idx
1357 rc = nodemap_idx_cluster_roles_del(nodemap);
1358 else if (old_rbac == NODEMAP_RBAC_ALL)
1359 /* if old value is ALL (default), need to insert
1360 * NODEMAP_CLUSTER_ROLES idx
1362 rc = nodemap_idx_cluster_roles_add(nodemap);
1364 /* otherwise just update existing NODEMAP_CLUSTER_ROLES idx */
1365 rc = nodemap_idx_cluster_roles_update(nodemap);
1367 nm_member_revoke_locks(nodemap);
1369 nodemap_putref(nodemap);
1373 EXPORT_SYMBOL(nodemap_set_rbac);
1376 * Update the squash_uid for a nodemap.
1378 * \param name nodemap name
1379 * \param uid the new uid to squash unknown users to
1380 * \retval 0 on success
1382 * Update the squash_uid for a nodemap. The squash_uid is the uid
1383 * that the all client uids are mapped to if nodemap is active,
1384 * the trust_client_ids flag is not set, and the uid is not in
1387 int nodemap_set_squash_uid(const char *name, uid_t uid)
1389 struct lu_nodemap *nodemap = NULL;
1392 mutex_lock(&active_config_lock);
1393 nodemap = nodemap_lookup(name);
1394 mutex_unlock(&active_config_lock);
1395 if (IS_ERR(nodemap))
1396 GOTO(out, rc = PTR_ERR(nodemap));
1398 nodemap->nm_squash_uid = uid;
1399 rc = nodemap_idx_nodemap_update(nodemap);
1401 nm_member_revoke_locks(nodemap);
1402 nodemap_putref(nodemap);
1406 EXPORT_SYMBOL(nodemap_set_squash_uid);
1409 * Update the squash_gid for a nodemap.
1411 * \param name nodemap name
1412 * \param gid the new gid to squash unknown gids to
1413 * \retval 0 on success
1415 * Update the squash_gid for a nodemap. The squash_gid is the gid
1416 * that the all client gids are mapped to if nodemap is active,
1417 * the trust_client_ids flag is not set, and the gid is not in
1420 int nodemap_set_squash_gid(const char *name, gid_t gid)
1422 struct lu_nodemap *nodemap = NULL;
1425 mutex_lock(&active_config_lock);
1426 nodemap = nodemap_lookup(name);
1427 mutex_unlock(&active_config_lock);
1428 if (IS_ERR(nodemap))
1429 GOTO(out, rc = PTR_ERR(nodemap));
1431 nodemap->nm_squash_gid = gid;
1432 rc = nodemap_idx_nodemap_update(nodemap);
1434 nm_member_revoke_locks(nodemap);
1435 nodemap_putref(nodemap);
1439 EXPORT_SYMBOL(nodemap_set_squash_gid);
1442 * Update the squash_projid for a nodemap.
1444 * \param name nodemap name
1445 * \param gid the new projid to squash unknown projids to
1446 * \retval 0 on success
1448 * Update the squash_projid for a nodemap. The squash_projid is the projid
1449 * that the all client projids are mapped to if nodemap is active,
1450 * the trust_client_ids flag is not set, and the projid is not in
1453 int nodemap_set_squash_projid(const char *name, projid_t projid)
1455 struct lu_nodemap *nodemap = NULL;
1458 mutex_lock(&active_config_lock);
1459 nodemap = nodemap_lookup(name);
1460 mutex_unlock(&active_config_lock);
1461 if (IS_ERR(nodemap))
1462 GOTO(out, rc = PTR_ERR(nodemap));
1464 nodemap->nm_squash_projid = projid;
1465 rc = nodemap_idx_nodemap_update(nodemap);
1467 nm_member_revoke_locks(nodemap);
1468 nodemap_putref(nodemap);
1472 EXPORT_SYMBOL(nodemap_set_squash_projid);
1475 * Check if nodemap allows setting quota.
1477 * If nodemap is not active, always allow.
1478 * For user and group quota, allow if the nodemap allows root access.
1479 * For project quota, allow if project id is not squashed or deny_unknown
1482 * \param nodemap nodemap to check access for
1483 * \param qc_type quota type
1484 * \param id client id to map
1485 * \retval true is setquota is allowed, false otherwise
1487 bool nodemap_can_setquota(struct lu_nodemap *nodemap, __u32 qc_type, __u32 id)
1489 if (!nodemap_active)
1492 if (!nodemap || !nodemap->nmf_allow_root_access ||
1493 !(nodemap->nmf_rbac & NODEMAP_RBAC_QUOTA_OPS))
1496 if (qc_type == PRJQUOTA) {
1497 id = nodemap_map_id(nodemap, NODEMAP_PROJID,
1498 NODEMAP_CLIENT_TO_FS, id);
1500 if (id == nodemap->nm_squash_projid &&
1501 nodemap->nmf_deny_unknown)
1507 EXPORT_SYMBOL(nodemap_can_setquota);
1510 * Set the nmf_enable_audit flag to true or false.
1511 * \param name nodemap name
1512 * \param audit_mode if true, allow audit
1513 * \retval 0 on success
1516 int nodemap_set_audit_mode(const char *name, bool enable_audit)
1518 struct lu_nodemap *nodemap = NULL;
1521 mutex_lock(&active_config_lock);
1522 nodemap = nodemap_lookup(name);
1523 mutex_unlock(&active_config_lock);
1524 if (IS_ERR(nodemap))
1525 GOTO(out, rc = PTR_ERR(nodemap));
1527 nodemap->nmf_enable_audit = enable_audit;
1528 rc = nodemap_idx_nodemap_update(nodemap);
1530 nm_member_revoke_locks(nodemap);
1531 nodemap_putref(nodemap);
1535 EXPORT_SYMBOL(nodemap_set_audit_mode);
1538 * Set the nmf_forbid_encryption flag to true or false.
1539 * \param name nodemap name
1540 * \param forbid_encryption if true, forbid encryption
1541 * \retval 0 on success
1544 int nodemap_set_forbid_encryption(const char *name, bool forbid_encryption)
1546 struct lu_nodemap *nodemap = NULL;
1549 mutex_lock(&active_config_lock);
1550 nodemap = nodemap_lookup(name);
1551 mutex_unlock(&active_config_lock);
1552 if (IS_ERR(nodemap))
1553 GOTO(out, rc = PTR_ERR(nodemap));
1555 nodemap->nmf_forbid_encryption = forbid_encryption;
1556 rc = nodemap_idx_nodemap_update(nodemap);
1558 nm_member_revoke_locks(nodemap);
1559 nodemap_putref(nodemap);
1563 EXPORT_SYMBOL(nodemap_set_forbid_encryption);
1566 * Set the nmf_readonly_mount flag to true or false.
1567 * \param name nodemap name
1568 * \param readonly_mount if true, forbid rw mount
1569 * \retval 0 on success
1572 int nodemap_set_readonly_mount(const char *name, bool readonly_mount)
1574 struct lu_nodemap *nodemap = NULL;
1577 mutex_lock(&active_config_lock);
1578 nodemap = nodemap_lookup(name);
1579 mutex_unlock(&active_config_lock);
1580 if (IS_ERR(nodemap))
1581 GOTO(out, rc = PTR_ERR(nodemap));
1583 nodemap->nmf_readonly_mount = readonly_mount;
1584 rc = nodemap_idx_nodemap_update(nodemap);
1586 nm_member_revoke_locks(nodemap);
1587 nodemap_putref(nodemap);
1591 EXPORT_SYMBOL(nodemap_set_readonly_mount);
1596 * \param name name of nodemap
1598 * \retval -EINVAL invalid nodemap name
1599 * \retval -EEXIST nodemap already exists
1600 * \retval -ENOMEM cannot allocate memory for nodemap
1602 int nodemap_add(const char *nodemap_name)
1604 struct lu_nodemap *nodemap;
1607 mutex_lock(&active_config_lock);
1608 nodemap = nodemap_create(nodemap_name, active_config, 0);
1609 if (IS_ERR(nodemap)) {
1610 mutex_unlock(&active_config_lock);
1611 return PTR_ERR(nodemap);
1614 rc = nodemap_idx_nodemap_add(nodemap);
1616 rc = lprocfs_nodemap_register(nodemap, 0);
1618 mutex_unlock(&active_config_lock);
1619 nodemap_putref(nodemap);
1623 EXPORT_SYMBOL(nodemap_add);
1628 * \param name name of nodemmap
1630 * \retval -EINVAL invalid input
1631 * \retval -ENOENT no existing nodemap
1633 int nodemap_del(const char *nodemap_name)
1635 struct lu_nodemap *nodemap;
1636 struct lu_nid_range *range;
1637 struct lu_nid_range *range_temp;
1641 if (strcmp(nodemap_name, DEFAULT_NODEMAP) == 0)
1644 mutex_lock(&active_config_lock);
1645 nodemap = cfs_hash_del_key(active_config->nmc_nodemap_hash,
1647 if (nodemap == NULL) {
1648 mutex_unlock(&active_config_lock);
1649 GOTO(out, rc = -ENOENT);
1652 /* erase nodemap from active ranges to prevent client assignment */
1653 down_write(&active_config->nmc_range_tree_lock);
1654 list_for_each_entry_safe(range, range_temp, &nodemap->nm_ranges,
1656 rc2 = nodemap_idx_range_del(range);
1660 range_delete(&active_config->nmc_range_tree, range);
1662 up_write(&active_config->nmc_range_tree_lock);
1664 rc2 = nodemap_idx_nodemap_del(nodemap);
1669 * remove procfs here in case nodemap_create called with same name
1670 * before nodemap_destroy is run.
1672 lprocfs_nodemap_remove(nodemap->nm_pde_data);
1673 nodemap->nm_pde_data = NULL;
1675 /* reclassify all member exports from nodemap, so they put their refs */
1676 down_read(&active_config->nmc_range_tree_lock);
1677 nm_member_reclassify_nodemap(nodemap);
1678 up_read(&active_config->nmc_range_tree_lock);
1680 if (!list_empty(&nodemap->nm_member_list))
1681 CWARN("nodemap_del failed to reclassify all members\n");
1683 mutex_unlock(&active_config_lock);
1685 nodemap_putref(nodemap);
1690 EXPORT_SYMBOL(nodemap_del);
1693 * activate nodemap functions
1695 * \param value 1 for on, 0 for off
1697 void nodemap_activate(const bool value)
1699 mutex_lock(&active_config_lock);
1700 active_config->nmc_nodemap_is_active = value;
1702 /* copy active value to global to avoid locking in map functions */
1703 nodemap_active = value;
1704 nodemap_idx_nodemap_activate(value);
1705 mutex_unlock(&active_config_lock);
1706 nm_member_revoke_all();
1708 EXPORT_SYMBOL(nodemap_activate);
1711 * Helper iterator to convert nodemap hash to list.
1713 * \param hs hash structure
1714 * \param bd bucket descriptor
1715 * \param hnode hash node
1716 * \param nodemap_list_head list head for list of nodemaps in hash
1718 static int nodemap_cleanup_iter_cb(struct cfs_hash *hs, struct cfs_hash_bd *bd,
1719 struct hlist_node *hnode,
1720 void *nodemap_list_head)
1722 struct lu_nodemap *nodemap;
1724 nodemap = hlist_entry(hnode, struct lu_nodemap, nm_hash);
1725 list_add(&nodemap->nm_list, nodemap_list_head);
1727 cfs_hash_bd_del_locked(hs, bd, hnode);
1732 struct nodemap_config *nodemap_config_alloc(void)
1734 struct nodemap_config *config;
1737 OBD_ALLOC_PTR(config);
1739 return ERR_PTR(-ENOMEM);
1741 rc = nodemap_init_hash(config);
1743 OBD_FREE_PTR(config);
1747 init_rwsem(&config->nmc_range_tree_lock);
1749 config->nmc_range_tree.nmrt_range_interval_root = INTERVAL_TREE_ROOT;
1753 EXPORT_SYMBOL(nodemap_config_alloc);
1756 * Walk the nodemap_hash and remove all nodemaps.
1758 void nodemap_config_dealloc(struct nodemap_config *config)
1760 struct lu_nodemap *nodemap = NULL;
1761 struct lu_nodemap *nodemap_temp;
1762 struct lu_nid_range *range;
1763 struct lu_nid_range *range_temp;
1764 LIST_HEAD(nodemap_list_head);
1766 cfs_hash_for_each_safe(config->nmc_nodemap_hash,
1767 nodemap_cleanup_iter_cb, &nodemap_list_head);
1768 cfs_hash_putref(config->nmc_nodemap_hash);
1770 /* Because nodemap_destroy might sleep, we can't destroy them
1771 * in cfs_hash_for_each, so we build a list there and destroy here
1773 list_for_each_entry_safe(nodemap, nodemap_temp, &nodemap_list_head,
1775 mutex_lock(&active_config_lock);
1776 down_write(&config->nmc_range_tree_lock);
1778 /* move members to new config, requires ac lock */
1779 nm_member_reclassify_nodemap(nodemap);
1780 list_for_each_entry_safe(range, range_temp, &nodemap->nm_ranges,
1782 range_delete(&config->nmc_range_tree, range);
1783 up_write(&config->nmc_range_tree_lock);
1784 mutex_unlock(&active_config_lock);
1786 /* putref must be outside of ac lock if nm could be destroyed */
1787 nodemap_putref(nodemap);
1789 OBD_FREE_PTR(config);
1791 EXPORT_SYMBOL(nodemap_config_dealloc);
1794 * callback for cfs_hash_for_each_safe used to convert a nodemap hash to a
1795 * nodemap list, generally for locking purposes as a hash cb can't sleep.
1797 int nm_hash_list_cb(struct cfs_hash *hs, struct cfs_hash_bd *bd,
1798 struct hlist_node *hnode,
1799 void *nodemap_list_head)
1801 struct lu_nodemap *nodemap;
1803 nodemap = hlist_entry(hnode, struct lu_nodemap, nm_hash);
1804 list_add(&nodemap->nm_list, nodemap_list_head);
1808 void nodemap_config_set_active(struct nodemap_config *config)
1810 struct nodemap_config *old_config = active_config;
1811 struct lu_nodemap *nodemap;
1812 struct lu_nodemap *tmp;
1814 LIST_HEAD(nodemap_list_head);
1818 LASSERT(active_config != config);
1819 LASSERT(config->nmc_default_nodemap);
1821 mutex_lock(&active_config_lock);
1823 /* move proc entries from already existing nms, create for new nms */
1824 cfs_hash_for_each_safe(config->nmc_nodemap_hash,
1825 nm_hash_list_cb, &nodemap_list_head);
1826 list_for_each_entry_safe(nodemap, tmp, &nodemap_list_head, nm_list) {
1827 struct lu_nodemap *old_nm = NULL;
1829 if (active_config != NULL)
1830 old_nm = cfs_hash_lookup(
1831 active_config->nmc_nodemap_hash,
1833 if (old_nm != NULL) {
1834 nodemap->nm_pde_data = old_nm->nm_pde_data;
1835 old_nm->nm_pde_data = NULL;
1836 nodemap_putref(old_nm);
1838 bool is_def = (nodemap == config->nmc_default_nodemap);
1840 lprocfs_nodemap_register(nodemap, is_def);
1845 * We only need to revoke locks if old nodemap was active, and new
1846 * config is now nodemap inactive. nodemap_config_dealloc will
1847 * reclassify exports, triggering a lock revoke if and only if new
1848 * nodemap is active.
1850 revoke_locks = !config->nmc_nodemap_is_active && nodemap_active;
1852 /* if new config is inactive, deactivate live config before switching */
1853 if (!config->nmc_nodemap_is_active)
1854 nodemap_active = false;
1855 active_config = config;
1856 if (config->nmc_nodemap_is_active)
1857 nodemap_active = true;
1859 mutex_unlock(&active_config_lock);
1861 if (old_config != NULL)
1862 nodemap_config_dealloc(old_config);
1865 nm_member_revoke_all();
1871 * Cleanup nodemap module on exit
1873 void nodemap_mod_exit(void)
1875 nodemap_config_dealloc(active_config);
1876 nodemap_procfs_exit();
1880 * Initialize the nodemap module
1882 int nodemap_mod_init(void)
1884 struct nodemap_config *new_config;
1885 struct lu_nodemap *nodemap;
1888 rc = nodemap_procfs_init();
1892 new_config = nodemap_config_alloc();
1893 if (IS_ERR(new_config)) {
1894 nodemap_procfs_exit();
1895 GOTO(out, rc = PTR_ERR(new_config));
1898 nodemap = nodemap_create(DEFAULT_NODEMAP, new_config, 1);
1899 if (IS_ERR(nodemap)) {
1900 nodemap_config_dealloc(new_config);
1901 nodemap_procfs_exit();
1902 GOTO(out, rc = PTR_ERR(nodemap));
1905 nodemap_config_set_active(new_config);
1906 nodemap_putref(nodemap);
1913 * Revoke locks for all nodemaps.
1915 void nm_member_revoke_all(void)
1917 struct lu_nodemap *nodemap;
1918 struct lu_nodemap *tmp;
1919 LIST_HEAD(nodemap_list_head);
1921 mutex_lock(&active_config_lock);
1922 cfs_hash_for_each_safe(active_config->nmc_nodemap_hash,
1923 nm_hash_list_cb, &nodemap_list_head);
1925 /* revoke_locks sleeps, so can't call in cfs hash cb */
1926 list_for_each_entry_safe(nodemap, tmp, &nodemap_list_head, nm_list)
1927 nm_member_revoke_locks_always(nodemap);
1928 mutex_unlock(&active_config_lock);
1932 * Returns the nodemap classification for a given nid into an ioctl buffer.
1933 * Useful for testing the nodemap configuration to make sure it is working as
1936 * \param nid nid to classify
1937 * \param[out] name_buf buffer to write the nodemap name to
1938 * \param name_len length of buffer
1940 void nodemap_test_nid(lnet_nid_t nid, char *name_buf, size_t name_len)
1942 struct lu_nodemap *nodemap;
1944 mutex_lock(&active_config_lock);
1945 down_read(&active_config->nmc_range_tree_lock);
1946 nodemap = nodemap_classify_nid(nid);
1947 up_read(&active_config->nmc_range_tree_lock);
1948 mutex_unlock(&active_config_lock);
1950 if (IS_ERR(nodemap))
1953 strncpy(name_buf, nodemap->nm_name, name_len);
1955 name_buf[name_len - 1] = '\0';
1957 nodemap_putref(nodemap);
1959 EXPORT_SYMBOL(nodemap_test_nid);
1962 * Passes back the id mapping for a given nid/id pair. Useful for testing the
1963 * nodemap configuration to make sure it is working as expected.
1965 * \param nid nid to classify
1966 * \param idtype uid or gid
1967 * \param client_id id to map to fs
1968 * \param fs_id_buf pointer to save mapped fs_id to
1971 * \retval -EINVAL invalid NID
1973 int nodemap_test_id(lnet_nid_t nid, enum nodemap_id_type idtype,
1974 __u32 client_id, __u32 *fs_id)
1976 struct lu_nodemap *nodemap;
1978 mutex_lock(&active_config_lock);
1979 down_read(&active_config->nmc_range_tree_lock);
1980 nodemap = nodemap_classify_nid(nid);
1981 up_read(&active_config->nmc_range_tree_lock);
1982 mutex_unlock(&active_config_lock);
1984 if (IS_ERR(nodemap))
1985 return PTR_ERR(nodemap);
1987 *fs_id = nodemap_map_id(nodemap, idtype, NODEMAP_CLIENT_TO_FS,
1989 nodemap_putref(nodemap);
1993 EXPORT_SYMBOL(nodemap_test_id);