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) 2014, Intel Corporation.
27 * Author: Joshua Walgenbach <jjw@iu.edu>
29 #include <linux/module.h>
30 #include <linux/sort.h>
31 #include <lnet/nidstr.h>
32 #include <lustre_net.h>
33 #include <lustre_acl.h>
34 #include <lustre_eacl.h>
35 #include <obd_class.h>
36 #include "nodemap_internal.h"
38 #define HASH_NODEMAP_BKT_BITS 3
39 #define HASH_NODEMAP_CUR_BITS 3
40 #define HASH_NODEMAP_MAX_BITS 7
42 #define DEFAULT_NODEMAP "default"
44 /* nodemap proc root proc directory under fs/lustre */
45 struct proc_dir_entry *proc_lustre_nodemap_root;
47 /* Copy of config active flag to avoid locking in mapping functions */
50 /* Lock protecting the active config, useful primarily when proc and
51 * nodemap_hash might be replaced when loading a new config
52 * Any time the active config is referenced, the lock should be held.
54 DEFINE_MUTEX(active_config_lock);
55 struct nodemap_config *active_config;
60 * \param nodemap nodemap to destroy
62 static void nodemap_destroy(struct lu_nodemap *nodemap)
66 if (nodemap->nm_pde_data != NULL)
67 lprocfs_nodemap_remove(nodemap->nm_pde_data);
69 mutex_lock(&active_config_lock);
70 down_read(&active_config->nmc_range_tree_lock);
71 nm_member_reclassify_nodemap(nodemap);
72 up_read(&active_config->nmc_range_tree_lock);
74 write_lock(&nodemap->nm_idmap_lock);
75 idmap_delete_tree(nodemap);
76 write_unlock(&nodemap->nm_idmap_lock);
78 mutex_unlock(&active_config_lock);
80 if (!list_empty(&nodemap->nm_member_list))
81 CWARN("nodemap_destroy failed to reclassify all members\n");
83 nm_member_delete_list(nodemap);
85 OBD_FREE_PTR(nodemap);
91 * Functions used for the cfs_hash
93 void nodemap_getref(struct lu_nodemap *nodemap)
95 atomic_inc(&nodemap->nm_refcount);
96 CDEBUG(D_INFO, "GETting nodemap %s(p=%p) : new refcount %d\n",
97 nodemap->nm_name, nodemap, atomic_read(&nodemap->nm_refcount));
101 * Destroy nodemap if last reference is put. Should be called outside
104 void nodemap_putref(struct lu_nodemap *nodemap)
109 LASSERT(atomic_read(&nodemap->nm_refcount) > 0);
111 CDEBUG(D_INFO, "PUTting nodemap %s(p=%p) : new refcount %d\n",
112 nodemap->nm_name, nodemap,
113 atomic_read(&nodemap->nm_refcount) - 1);
115 if (atomic_dec_and_test(&nodemap->nm_refcount))
116 nodemap_destroy(nodemap);
118 EXPORT_SYMBOL(nodemap_putref);
120 static __u32 nodemap_hashfn(struct cfs_hash *hash_body,
121 const void *key, unsigned mask)
123 return cfs_hash_djb2_hash(key, strlen(key), mask);
126 static void *nodemap_hs_key(struct hlist_node *hnode)
128 struct lu_nodemap *nodemap;
130 nodemap = hlist_entry(hnode, struct lu_nodemap, nm_hash);
132 return nodemap->nm_name;
135 static int nodemap_hs_keycmp(const void *key,
136 struct hlist_node *compared_hnode)
140 nodemap_name = nodemap_hs_key(compared_hnode);
142 return !strcmp(key, nodemap_name);
145 static void *nodemap_hs_hashobject(struct hlist_node *hnode)
147 return hlist_entry(hnode, struct lu_nodemap, nm_hash);
150 static void nodemap_hs_get(struct cfs_hash *hs, struct hlist_node *hnode)
152 struct lu_nodemap *nodemap;
154 nodemap = hlist_entry(hnode, struct lu_nodemap, nm_hash);
155 nodemap_getref(nodemap);
158 static void nodemap_hs_put_locked(struct cfs_hash *hs,
159 struct hlist_node *hnode)
161 struct lu_nodemap *nodemap;
163 nodemap = hlist_entry(hnode, struct lu_nodemap, nm_hash);
164 nodemap_putref(nodemap);
167 static struct cfs_hash_ops nodemap_hash_operations = {
168 .hs_hash = nodemap_hashfn,
169 .hs_key = nodemap_hs_key,
170 .hs_keycmp = nodemap_hs_keycmp,
171 .hs_object = nodemap_hs_hashobject,
172 .hs_get = nodemap_hs_get,
173 .hs_put_locked = nodemap_hs_put_locked,
176 /* end of cfs_hash functions */
179 * Initialize nodemap_hash
182 * \retval -ENOMEM cannot create hash
184 static int nodemap_init_hash(struct nodemap_config *nmc)
186 nmc->nmc_nodemap_hash = cfs_hash_create("NODEMAP",
187 HASH_NODEMAP_CUR_BITS,
188 HASH_NODEMAP_MAX_BITS,
189 HASH_NODEMAP_BKT_BITS, 0,
192 &nodemap_hash_operations,
195 if (nmc->nmc_nodemap_hash == NULL) {
196 CERROR("cannot create nodemap_hash table\n");
204 * Check for valid nodemap name
206 * \param name nodemap name
208 * \retval false invalid
210 static bool nodemap_name_is_valid(const char *name)
212 if (strlen(name) > LUSTRE_NODEMAP_NAME_LENGTH ||
216 for (; *name != '\0'; name++) {
217 if (!isalnum(*name) && *name != '_')
227 * Look nodemap up in the active_config nodemap hash. Caller should hold the
228 * active_config_lock.
230 * \param name name of nodemap
231 * \retval nodemap pointer set to found nodemap
232 * \retval -EINVAL name is not valid
233 * \retval -ENOENT nodemap not found
235 struct lu_nodemap *nodemap_lookup(const char *name)
237 struct lu_nodemap *nodemap = NULL;
239 if (!nodemap_name_is_valid(name))
240 return ERR_PTR(-EINVAL);
242 nodemap = cfs_hash_lookup(active_config->nmc_nodemap_hash, name);
244 return ERR_PTR(-ENOENT);
250 * Classify the nid into the proper nodemap. Caller must hold active config and
251 * nm_range_tree_lock, and call nodemap_putref when done with nodemap.
253 * \param nid nid to classify
254 * \retval nodemap nodemap containing the nid
255 * \retval default_nodemap default nodemap
257 struct lu_nodemap *nodemap_classify_nid(lnet_nid_t nid)
259 struct lu_nid_range *range;
260 struct lu_nodemap *nodemap;
262 range = range_search(&active_config->nmc_range_tree, nid);
264 nodemap = range->rn_nodemap;
266 nodemap = active_config->nmc_default_nodemap;
268 LASSERT(nodemap != NULL);
269 nodemap_getref(nodemap);
275 * simple check for default nodemap
277 static bool is_default_nodemap(const struct lu_nodemap *nodemap)
279 return nodemap->nm_id == 0;
283 * parse a nodemap range string into two nids
285 * \param range_str string to parse
286 * \param range[2] array of two nids
287 * \reyval 0 on success
289 int nodemap_parse_range(const char *range_str, lnet_nid_t range[2])
291 char buf[LNET_NIDSTR_SIZE * 2 + 2];
297 snprintf(buf, sizeof(buf), "%s", range_str);
299 start_nidstr = strsep(&ptr, ":");
300 end_nidstr = strsep(&ptr, ":");
302 if (start_nidstr == NULL || end_nidstr == NULL)
303 GOTO(out, rc = -EINVAL);
305 range[0] = libcfs_str2nid(start_nidstr);
306 range[1] = libcfs_str2nid(end_nidstr);
312 EXPORT_SYMBOL(nodemap_parse_range);
315 * parse a string containing an id map of form "client_id:filesystem_id"
316 * into an array of __u32 * for use in mapping functions
318 * \param idmap_str map string
319 * \param idmap array[2] of __u32
321 * \retval 0 on success
322 * \retval -EINVAL if idmap cannot be parsed
324 int nodemap_parse_idmap(char *idmap_str, __u32 idmap[2])
327 long unsigned int idmap_buf;
330 if (idmap_str == NULL)
333 sep = strchr(idmap_str, ':');
339 rc = kstrtoul(idmap_str, 10, &idmap_buf);
342 idmap[0] = idmap_buf;
344 rc = kstrtoul(sep, 10, &idmap_buf);
347 idmap[1] = idmap_buf;
351 EXPORT_SYMBOL(nodemap_parse_idmap);
354 * add a member to a nodemap
356 * \param nid nid to add to the members
357 * \param exp obd_export structure for the connection
358 * that is being added
359 * \retval -EINVAL export is NULL
360 * \retval -EEXIST export is already member of a nodemap
362 int nodemap_add_member(lnet_nid_t nid, struct obd_export *exp)
364 struct lu_nodemap *nodemap;
368 mutex_lock(&active_config_lock);
369 down_read(&active_config->nmc_range_tree_lock);
371 nodemap = nodemap_classify_nid(nid);
372 rc = nm_member_add(nodemap, exp);
374 up_read(&active_config->nmc_range_tree_lock);
375 mutex_unlock(&active_config_lock);
377 nodemap_putref(nodemap);
381 EXPORT_SYMBOL(nodemap_add_member);
384 * delete a member from a nodemap
386 * \param exp export to remove from a nodemap
388 void nodemap_del_member(struct obd_export *exp)
390 struct lu_nodemap *nodemap;
394 /* using ac lock to prevent nodemap reclassification while deleting */
395 mutex_lock(&active_config_lock);
397 /* use of ted_nodemap is protected by active_config_lock. we take an
398 * extra reference to make sure nodemap isn't destroyed under
401 nodemap = exp->exp_target_data.ted_nodemap;
405 nodemap_getref(nodemap);
407 mutex_lock(&nodemap->nm_member_list_lock);
408 nm_member_del(nodemap, exp);
409 mutex_unlock(&nodemap->nm_member_list_lock);
412 mutex_unlock(&active_config_lock);
415 nodemap_putref(nodemap);
419 EXPORT_SYMBOL(nodemap_del_member);
422 * add an idmap to the proper nodemap trees
424 * \param name name of nodemap
425 * \param id_type NODEMAP_UID or NODEMAP_GID
426 * \param map array[2] __u32 containing the map values
427 * map[0] is client id
428 * map[1] is the filesystem id
430 * \retval 0 on success
432 int nodemap_add_idmap_helper(struct lu_nodemap *nodemap,
433 enum nodemap_id_type id_type,
436 struct lu_idmap *idmap;
439 idmap = idmap_create(map[0], map[1]);
441 GOTO(out, rc = -ENOMEM);
443 write_lock(&nodemap->nm_idmap_lock);
444 idmap_insert(id_type, idmap, nodemap);
445 write_unlock(&nodemap->nm_idmap_lock);
446 nm_member_revoke_locks(nodemap);
452 int nodemap_add_idmap(const char *name, enum nodemap_id_type id_type,
455 struct lu_nodemap *nodemap = NULL;
458 mutex_lock(&active_config_lock);
459 nodemap = nodemap_lookup(name);
460 if (IS_ERR(nodemap)) {
461 mutex_unlock(&active_config_lock);
462 GOTO(out, rc = PTR_ERR(nodemap));
465 if (is_default_nodemap(nodemap)) {
468 rc = nodemap_add_idmap_helper(nodemap, id_type, map);
470 rc = nodemap_idx_idmap_add(nodemap, id_type, map);
472 mutex_unlock(&active_config_lock);
473 nodemap_putref(nodemap);
478 EXPORT_SYMBOL(nodemap_add_idmap);
481 * delete idmap from proper nodemap tree
483 * \param name name of nodemap
484 * \param id_type NODEMAP_UID or NODEMAP_GID
485 * \param map array[2] __u32 containing the mapA values
486 * map[0] is client id
487 * map[1] is the filesystem id
489 * \retval 0 on success
491 int nodemap_del_idmap(const char *name, enum nodemap_id_type id_type,
494 struct lu_nodemap *nodemap = NULL;
495 struct lu_idmap *idmap = NULL;
498 mutex_lock(&active_config_lock);
499 nodemap = nodemap_lookup(name);
500 if (IS_ERR(nodemap)) {
501 mutex_unlock(&active_config_lock);
502 GOTO(out, rc = PTR_ERR(nodemap));
505 if (is_default_nodemap(nodemap))
506 GOTO(out_putref, rc = -EINVAL);
508 write_lock(&nodemap->nm_idmap_lock);
509 idmap = idmap_search(nodemap, NODEMAP_CLIENT_TO_FS, id_type,
514 idmap_delete(id_type, idmap, nodemap);
515 rc = nodemap_idx_idmap_del(nodemap, id_type, map);
517 write_unlock(&nodemap->nm_idmap_lock);
520 mutex_unlock(&active_config_lock);
522 nm_member_revoke_locks(nodemap);
523 nodemap_putref(nodemap);
528 EXPORT_SYMBOL(nodemap_del_idmap);
531 * Get nodemap assigned to given export. Takes a reference on the nodemap.
533 * Note that this function may return either NULL, or an ERR_PTR()
534 * or a valid nodemap pointer. All of the functions accessing the
535 * returned nodemap can check IS_ERR(nodemap) to see if an error is
536 * returned. NULL is not considered an error, which is OK since this
537 * is a valid case if nodemap are not in use. All nodemap handling
538 * functions must check for nodemap == NULL and do nothing, and the
539 * nodemap returned from this function should not be dereferenced.
541 * \param export export to get nodemap for
543 * \retval pointer to nodemap on success
544 * \retval NULL nodemap subsystem disabled
545 * \retval -EACCES export does not have nodemap assigned
547 struct lu_nodemap *nodemap_get_from_exp(struct obd_export *exp)
549 struct lu_nodemap *nodemap;
556 spin_lock(&exp->exp_target_data.ted_nodemap_lock);
557 nodemap = exp->exp_target_data.ted_nodemap;
559 nodemap_getref(nodemap);
560 spin_unlock(&exp->exp_target_data.ted_nodemap_lock);
563 CDEBUG(D_INFO, "%s: nodemap null on export %s (at %s)\n",
564 exp->exp_obd->obd_name,
565 obd_uuid2str(&exp->exp_client_uuid),
566 obd_export_nid2str(exp));
567 RETURN(ERR_PTR(-EACCES));
572 EXPORT_SYMBOL(nodemap_get_from_exp);
575 * mapping function for nodemap idmaps
577 * \param nodemap lu_nodemap structure defining nodemap
578 * \param node_type NODEMAP_UID or NODEMAP_GID
579 * \param tree_type NODEMAP_CLIENT_TO_FS or
580 * NODEMAP_FS_TO_CLIENT
581 * \param id id to map
583 * \retval mapped id according to the rules below.
585 * if the nodemap_active is false, just return the passed id without mapping
587 * if the id to be looked up is 0, check that root access is allowed and if it
588 * is, return 0. Otherwise, return the squash uid or gid.
590 * if the nodemap is configured to trusted the ids from the client system, just
591 * return the passwd id without mapping.
593 * if by this point, we haven't returned and the nodemap in question is the
594 * default nodemap, return the squash uid or gid.
596 * after these checks, search the proper tree for the mapping, and if found
597 * return the mapped value, otherwise return the squash uid or gid.
599 __u32 nodemap_map_id(struct lu_nodemap *nodemap,
600 enum nodemap_id_type id_type,
601 enum nodemap_tree_type tree_type, __u32 id)
603 struct lu_idmap *idmap = NULL;
611 if (unlikely(nodemap == NULL))
615 if (nodemap->nmf_allow_root_access)
621 if (nodemap->nmf_trust_client_ids)
624 if (is_default_nodemap(nodemap))
627 read_lock(&nodemap->nm_idmap_lock);
628 idmap = idmap_search(nodemap, tree_type, id_type, id);
630 read_unlock(&nodemap->nm_idmap_lock);
634 if (tree_type == NODEMAP_FS_TO_CLIENT)
635 found_id = idmap->id_client;
637 found_id = idmap->id_fs;
638 read_unlock(&nodemap->nm_idmap_lock);
642 if (id_type == NODEMAP_UID)
643 RETURN(nodemap->nm_squash_uid);
645 RETURN(nodemap->nm_squash_gid);
649 EXPORT_SYMBOL(nodemap_map_id);
652 * Map posix ACL entries according to the nodemap membership. Removes any
655 * \param lu_nodemap nodemap
656 * \param buf buffer containing xattr encoded ACLs
657 * \param size size of ACLs in bytes
658 * \param tree_type direction of mapping
659 * \retval size new size of ACLs in bytes
660 * \retval -EINVAL bad \a size param, see posix_acl_xattr_count()
662 ssize_t nodemap_map_acl(struct lu_nodemap *nodemap, void *buf, size_t size,
663 enum nodemap_tree_type tree_type)
665 posix_acl_xattr_header *header = buf;
666 posix_acl_xattr_entry *entry = &header->a_entries[0];
667 posix_acl_xattr_entry *new_entry = entry;
668 posix_acl_xattr_entry *end;
674 if (unlikely(nodemap == NULL))
677 count = posix_acl_xattr_count(size);
683 for (end = entry + count; entry != end; entry++) {
684 __u16 tag = le16_to_cpu(entry->e_tag);
685 __u32 id = le32_to_cpu(entry->e_id);
689 id = nodemap_map_id(nodemap, NODEMAP_UID,
691 if (id == nodemap->nm_squash_uid)
693 entry->e_id = cpu_to_le32(id);
696 id = nodemap_map_id(nodemap, NODEMAP_GID,
698 if (id == nodemap->nm_squash_gid)
700 entry->e_id = cpu_to_le32(id);
704 /* if we skip an ACL, copy the following ones over it */
705 if (new_entry != entry)
711 return (void *)new_entry - (void *)header;
713 EXPORT_SYMBOL(nodemap_map_acl);
716 * Add nid range to given nodemap
718 * \param config nodemap config to work on
719 * \param nodemap nodemap to add range to
720 * \param nid nid range to add
721 * \param range_id should be 0 unless loading from disk
726 int nodemap_add_range_helper(struct nodemap_config *config,
727 struct lu_nodemap *nodemap,
728 const lnet_nid_t nid[2],
729 unsigned int range_id)
731 struct lu_nid_range *range;
734 down_write(&config->nmc_range_tree_lock);
735 range = range_create(&config->nmc_range_tree, nid[0], nid[1],
738 up_write(&config->nmc_range_tree_lock);
739 GOTO(out, rc = -ENOMEM);
742 rc = range_insert(&config->nmc_range_tree, range);
744 CERROR("cannot insert nodemap range into '%s': rc = %d\n",
745 nodemap->nm_name, rc);
746 up_write(&config->nmc_range_tree_lock);
747 list_del(&range->rn_list);
748 range_destroy(range);
749 GOTO(out, rc = -ENOMEM);
752 list_add(&range->rn_list, &nodemap->nm_ranges);
753 nm_member_reclassify_nodemap(config->nmc_default_nodemap);
754 up_write(&config->nmc_range_tree_lock);
756 /* if range_id is non-zero, we are loading from disk */
758 rc = nodemap_idx_range_add(range, nid);
760 nm_member_revoke_locks(config->nmc_default_nodemap);
761 nm_member_revoke_locks(nodemap);
766 int nodemap_add_range(const char *name, const lnet_nid_t nid[2])
768 struct lu_nodemap *nodemap = NULL;
771 mutex_lock(&active_config_lock);
772 nodemap = nodemap_lookup(name);
773 if (IS_ERR(nodemap)) {
774 mutex_unlock(&active_config_lock);
775 GOTO(out, rc = PTR_ERR(nodemap));
778 if (is_default_nodemap(nodemap))
781 rc = nodemap_add_range_helper(active_config, nodemap, nid, 0);
782 mutex_unlock(&active_config_lock);
783 nodemap_putref(nodemap);
787 EXPORT_SYMBOL(nodemap_add_range);
791 * \param name nodemap name
792 * \param range_str string containing range
793 * \retval 0 on success
795 * Delete range from global range tree, and remove it
796 * from the list in the associated nodemap.
798 int nodemap_del_range(const char *name, const lnet_nid_t nid[2])
800 struct lu_nodemap *nodemap;
801 struct lu_nid_range *range;
804 mutex_lock(&active_config_lock);
805 nodemap = nodemap_lookup(name);
806 if (IS_ERR(nodemap)) {
807 mutex_unlock(&active_config_lock);
808 GOTO(out, rc = PTR_ERR(nodemap));
811 if (is_default_nodemap(nodemap))
812 GOTO(out_putref, rc = -EINVAL);
814 down_write(&active_config->nmc_range_tree_lock);
815 range = range_find(&active_config->nmc_range_tree, nid[0], nid[1]);
817 up_write(&active_config->nmc_range_tree_lock);
818 GOTO(out_putref, rc = -EINVAL);
820 rc = nodemap_idx_range_del(range);
821 range_delete(&active_config->nmc_range_tree, range);
822 nm_member_reclassify_nodemap(nodemap);
823 up_write(&active_config->nmc_range_tree_lock);
825 nm_member_revoke_locks(active_config->nmc_default_nodemap);
826 nm_member_revoke_locks(nodemap);
829 mutex_unlock(&active_config_lock);
830 nodemap_putref(nodemap);
834 EXPORT_SYMBOL(nodemap_del_range);
837 * set fileset on nodemap
838 * \param name nodemap to set fileset on
839 * \param fileset string containing fileset
840 * \retval 0 on success
842 * set a fileset on the named nodemap
844 static int nodemap_set_fileset_helper(struct nodemap_config *config,
845 struct lu_nodemap *nodemap,
850 /* we allow fileset = "" which means clear fileset info */
851 if (fileset == NULL || (fileset[0] != 0 && fileset[0] != '/'))
853 else if (strlcpy(nodemap->nm_fileset, fileset,
854 sizeof(nodemap->nm_fileset)) >=
855 sizeof(nodemap->nm_fileset))
861 int nodemap_set_fileset(const char *name, const char *fileset)
863 struct lu_nodemap *nodemap = NULL;
866 mutex_lock(&active_config_lock);
867 nodemap = nodemap_lookup(name);
868 if (IS_ERR(nodemap)) {
869 mutex_unlock(&active_config_lock);
870 GOTO(out, rc = PTR_ERR(nodemap));
873 if (is_default_nodemap(nodemap))
876 rc = nodemap_set_fileset_helper(active_config, nodemap,
878 mutex_unlock(&active_config_lock);
880 nodemap_putref(nodemap);
884 EXPORT_SYMBOL(nodemap_set_fileset);
887 * get fileset defined on nodemap
888 * \param nodemap nodemap to get fileset from
889 * \retval fileset name, or NULL if not defined or not activated
891 * get the fileset defined on the nodemap
893 char *nodemap_get_fileset(const struct lu_nodemap *nodemap)
895 if (!nodemap_active || is_default_nodemap(nodemap))
898 return (char *)nodemap->nm_fileset;
900 EXPORT_SYMBOL(nodemap_get_fileset);
903 * Nodemap constructor
905 * Creates an lu_nodemap structure and assigns sane default
906 * member values. If this is the default nodemap, the defaults
907 * are the most restictive in xterms of mapping behavior. Otherwise
908 * the default flags should be inherited from the default nodemap.
909 * The adds nodemap to nodemap_hash.
911 * Requires that the caller take the active_config_lock
913 * \param name name of nodemap
914 * \param is_default true if default nodemap
915 * \retval nodemap success
916 * \retval -EINVAL invalid nodemap name
917 * \retval -EEXIST nodemap already exists
918 * \retval -ENOMEM cannot allocate memory for nodemap
920 struct lu_nodemap *nodemap_create(const char *name,
921 struct nodemap_config *config,
924 struct lu_nodemap *nodemap = NULL;
925 struct lu_nodemap *default_nodemap;
926 struct cfs_hash *hash = config->nmc_nodemap_hash;
929 default_nodemap = config->nmc_default_nodemap;
931 if (!nodemap_name_is_valid(name))
932 GOTO(out, rc = -EINVAL);
935 CERROR("Config nodemap hash is NULL, unable to add %s\n", name);
936 GOTO(out, rc = -EINVAL);
939 OBD_ALLOC_PTR(nodemap);
940 if (nodemap == NULL) {
941 CERROR("cannot allocate memory (%zu bytes)"
942 "for nodemap '%s'\n", sizeof(*nodemap),
944 GOTO(out, rc = -ENOMEM);
948 * take an extra reference to prevent nodemap from being destroyed
949 * while it's being created.
951 atomic_set(&nodemap->nm_refcount, 2);
952 snprintf(nodemap->nm_name, sizeof(nodemap->nm_name), "%s", name);
953 rc = cfs_hash_add_unique(hash, name, &nodemap->nm_hash);
955 OBD_FREE_PTR(nodemap);
956 GOTO(out, rc = -EEXIST);
959 INIT_LIST_HEAD(&nodemap->nm_ranges);
960 INIT_LIST_HEAD(&nodemap->nm_list);
961 INIT_LIST_HEAD(&nodemap->nm_member_list);
963 mutex_init(&nodemap->nm_member_list_lock);
964 rwlock_init(&nodemap->nm_idmap_lock);
965 nodemap->nm_fs_to_client_uidmap = RB_ROOT;
966 nodemap->nm_client_to_fs_uidmap = RB_ROOT;
967 nodemap->nm_fs_to_client_gidmap = RB_ROOT;
968 nodemap->nm_client_to_fs_gidmap = RB_ROOT;
971 nodemap->nm_id = LUSTRE_NODEMAP_DEFAULT_ID;
972 config->nmc_default_nodemap = nodemap;
974 config->nmc_nodemap_highest_id++;
975 nodemap->nm_id = config->nmc_nodemap_highest_id;
978 if (is_default || default_nodemap == NULL) {
979 nodemap->nmf_trust_client_ids = 0;
980 nodemap->nmf_allow_root_access = 0;
982 nodemap->nm_squash_uid = NODEMAP_NOBODY_UID;
983 nodemap->nm_squash_gid = NODEMAP_NOBODY_GID;
985 CWARN("adding nodemap '%s' to config without"
986 " default nodemap\n", nodemap->nm_name);
988 nodemap->nmf_trust_client_ids =
989 default_nodemap->nmf_trust_client_ids;
990 nodemap->nmf_allow_root_access =
991 default_nodemap->nmf_allow_root_access;
993 nodemap->nm_squash_uid = default_nodemap->nm_squash_uid;
994 nodemap->nm_squash_gid = default_nodemap->nm_squash_gid;
995 nodemap->nm_fileset[0] = 0;
1001 CERROR("cannot add nodemap: '%s': rc = %d\n", name, rc);
1006 * update flag to turn on or off nodemap functions
1007 * \param name nodemap name
1008 * \param admin_string string containing updated value
1009 * \retval 0 on success
1011 * Update admin flag to turn on or off nodemap functions.
1013 int nodemap_set_allow_root(const char *name, bool allow_root)
1015 struct lu_nodemap *nodemap = NULL;
1018 mutex_lock(&active_config_lock);
1019 nodemap = nodemap_lookup(name);
1020 mutex_unlock(&active_config_lock);
1021 if (IS_ERR(nodemap))
1022 GOTO(out, rc = PTR_ERR(nodemap));
1024 nodemap->nmf_allow_root_access = allow_root;
1025 rc = nodemap_idx_nodemap_update(nodemap);
1027 nm_member_revoke_locks(nodemap);
1028 nodemap_putref(nodemap);
1032 EXPORT_SYMBOL(nodemap_set_allow_root);
1035 * updated trust_client_ids flag for nodemap
1037 * \param name nodemap name
1038 * \param trust_string new value for trust flag
1039 * \retval 0 on success
1041 * Update the trust_client_ids flag for a nodemap.
1043 int nodemap_set_trust_client_ids(const char *name, bool trust_client_ids)
1045 struct lu_nodemap *nodemap = NULL;
1048 mutex_lock(&active_config_lock);
1049 nodemap = nodemap_lookup(name);
1050 mutex_unlock(&active_config_lock);
1051 if (IS_ERR(nodemap))
1052 GOTO(out, rc = PTR_ERR(nodemap));
1054 nodemap->nmf_trust_client_ids = trust_client_ids;
1055 rc = nodemap_idx_nodemap_update(nodemap);
1057 nm_member_revoke_locks(nodemap);
1058 nodemap_putref(nodemap);
1062 EXPORT_SYMBOL(nodemap_set_trust_client_ids);
1065 * update the squash_uid for a nodemap
1067 * \param name nodemap name
1068 * \param uid_string string containing new squash_uid value
1069 * \retval 0 on success
1071 * Update the squash_uid for a nodemap. The squash_uid is the uid
1072 * that the all client uids are mapped to if nodemap is active,
1073 * the trust_client_ids flag is not set, and the uid is not in
1076 int nodemap_set_squash_uid(const char *name, uid_t uid)
1078 struct lu_nodemap *nodemap = NULL;
1081 mutex_lock(&active_config_lock);
1082 nodemap = nodemap_lookup(name);
1083 mutex_unlock(&active_config_lock);
1084 if (IS_ERR(nodemap))
1085 GOTO(out, rc = PTR_ERR(nodemap));
1087 nodemap->nm_squash_uid = uid;
1088 rc = nodemap_idx_nodemap_update(nodemap);
1090 nm_member_revoke_locks(nodemap);
1091 nodemap_putref(nodemap);
1095 EXPORT_SYMBOL(nodemap_set_squash_uid);
1098 * Update the squash_gid for a nodemap.
1100 * \param name nodemap name
1101 * \param gid_string string containing new squash_gid value
1102 * \retval 0 on success
1104 * Update the squash_gid for a nodemap. The squash_uid is the gid
1105 * that the all client gids are mapped to if nodemap is active,
1106 * the trust_client_ids flag is not set, and the gid is not in
1109 int nodemap_set_squash_gid(const char *name, gid_t gid)
1111 struct lu_nodemap *nodemap = NULL;
1114 mutex_lock(&active_config_lock);
1115 nodemap = nodemap_lookup(name);
1116 mutex_unlock(&active_config_lock);
1117 if (IS_ERR(nodemap))
1118 GOTO(out, rc = PTR_ERR(nodemap));
1120 nodemap->nm_squash_gid = gid;
1121 rc = nodemap_idx_nodemap_update(nodemap);
1123 nm_member_revoke_locks(nodemap);
1124 nodemap_putref(nodemap);
1128 EXPORT_SYMBOL(nodemap_set_squash_gid);
1131 * Returns true if this nodemap has root user access. Always returns true if
1132 * nodemaps are not active.
1134 * \param nodemap nodemap to check access for
1136 bool nodemap_can_setquota(const struct lu_nodemap *nodemap)
1138 return !nodemap_active || (nodemap && nodemap->nmf_allow_root_access);
1140 EXPORT_SYMBOL(nodemap_can_setquota);
1145 * \param name name of nodemap
1147 * \retval -EINVAL invalid nodemap name
1148 * \retval -EEXIST nodemap already exists
1149 * \retval -ENOMEM cannot allocate memory for nodemap
1151 int nodemap_add(const char *nodemap_name)
1153 struct lu_nodemap *nodemap;
1156 mutex_lock(&active_config_lock);
1157 nodemap = nodemap_create(nodemap_name, active_config, 0);
1158 if (IS_ERR(nodemap)) {
1159 mutex_unlock(&active_config_lock);
1160 return PTR_ERR(nodemap);
1163 rc = nodemap_idx_nodemap_add(nodemap);
1165 rc = lprocfs_nodemap_register(nodemap, 0);
1167 mutex_unlock(&active_config_lock);
1168 nodemap_putref(nodemap);
1172 EXPORT_SYMBOL(nodemap_add);
1177 * \param name name of nodemmap
1179 * \retval -EINVAL invalid input
1180 * \retval -ENOENT no existing nodemap
1182 int nodemap_del(const char *nodemap_name)
1184 struct lu_nodemap *nodemap;
1185 struct lu_nid_range *range;
1186 struct lu_nid_range *range_temp;
1190 if (strcmp(nodemap_name, DEFAULT_NODEMAP) == 0)
1193 mutex_lock(&active_config_lock);
1194 nodemap = cfs_hash_del_key(active_config->nmc_nodemap_hash,
1196 if (nodemap == NULL) {
1197 mutex_unlock(&active_config_lock);
1198 GOTO(out, rc = -ENOENT);
1201 /* erase nodemap from active ranges to prevent client assignment */
1202 down_write(&active_config->nmc_range_tree_lock);
1203 list_for_each_entry_safe(range, range_temp, &nodemap->nm_ranges,
1205 rc2 = nodemap_idx_range_del(range);
1209 range_delete(&active_config->nmc_range_tree, range);
1211 up_write(&active_config->nmc_range_tree_lock);
1213 rc2 = nodemap_idx_nodemap_del(nodemap);
1218 * remove procfs here in case nodemap_create called with same name
1219 * before nodemap_destroy is run.
1221 lprocfs_nodemap_remove(nodemap->nm_pde_data);
1222 nodemap->nm_pde_data = NULL;
1224 /* reclassify all member exports from nodemap, so they put their refs */
1225 down_read(&active_config->nmc_range_tree_lock);
1226 nm_member_reclassify_nodemap(nodemap);
1227 up_read(&active_config->nmc_range_tree_lock);
1229 if (!list_empty(&nodemap->nm_member_list))
1230 CWARN("nodemap_del failed to reclassify all members\n");
1232 mutex_unlock(&active_config_lock);
1234 nodemap_putref(nodemap);
1239 EXPORT_SYMBOL(nodemap_del);
1242 * activate nodemap functions
1244 * \param value 1 for on, 0 for off
1246 void nodemap_activate(const bool value)
1248 mutex_lock(&active_config_lock);
1249 active_config->nmc_nodemap_is_active = value;
1251 /* copy active value to global to avoid locking in map functions */
1252 nodemap_active = value;
1253 nodemap_idx_nodemap_activate(value);
1254 mutex_unlock(&active_config_lock);
1255 nm_member_revoke_all();
1257 EXPORT_SYMBOL(nodemap_activate);
1260 * Helper iterator to convert nodemap hash to list.
1262 * \param hs hash structure
1263 * \param bd bucket descriptor
1264 * \param hnode hash node
1265 * \param nodemap_list_head list head for list of nodemaps in hash
1267 static int nodemap_cleanup_iter_cb(struct cfs_hash *hs, struct cfs_hash_bd *bd,
1268 struct hlist_node *hnode,
1269 void *nodemap_list_head)
1271 struct lu_nodemap *nodemap;
1273 nodemap = hlist_entry(hnode, struct lu_nodemap, nm_hash);
1274 list_add(&nodemap->nm_list, nodemap_list_head);
1276 cfs_hash_bd_del_locked(hs, bd, hnode);
1281 struct nodemap_config *nodemap_config_alloc(void)
1283 struct nodemap_config *config;
1286 OBD_ALLOC_PTR(config);
1288 return ERR_PTR(-ENOMEM);
1290 rc = nodemap_init_hash(config);
1292 OBD_FREE_PTR(config);
1296 init_rwsem(&config->nmc_range_tree_lock);
1300 EXPORT_SYMBOL(nodemap_config_alloc);
1303 * Walk the nodemap_hash and remove all nodemaps.
1305 void nodemap_config_dealloc(struct nodemap_config *config)
1307 struct lu_nodemap *nodemap = NULL;
1308 struct lu_nodemap *nodemap_temp;
1309 struct lu_nid_range *range;
1310 struct lu_nid_range *range_temp;
1311 LIST_HEAD(nodemap_list_head);
1313 cfs_hash_for_each_safe(config->nmc_nodemap_hash,
1314 nodemap_cleanup_iter_cb, &nodemap_list_head);
1315 cfs_hash_putref(config->nmc_nodemap_hash);
1317 /* Because nodemap_destroy might sleep, we can't destroy them
1318 * in cfs_hash_for_each, so we build a list there and destroy here
1320 list_for_each_entry_safe(nodemap, nodemap_temp, &nodemap_list_head,
1322 down_write(&config->nmc_range_tree_lock);
1324 /* move members to new config */
1325 nm_member_reclassify_nodemap(nodemap);
1326 list_for_each_entry_safe(range, range_temp, &nodemap->nm_ranges,
1328 range_delete(&config->nmc_range_tree, range);
1329 up_write(&config->nmc_range_tree_lock);
1331 nodemap_putref(nodemap);
1333 OBD_FREE_PTR(config);
1335 EXPORT_SYMBOL(nodemap_config_dealloc);
1337 static int nm_hash_list_cb(struct cfs_hash *hs, struct cfs_hash_bd *bd,
1338 struct hlist_node *hnode,
1339 void *nodemap_list_head)
1341 struct lu_nodemap *nodemap;
1343 nodemap = hlist_entry(hnode, struct lu_nodemap, nm_hash);
1344 list_add(&nodemap->nm_list, nodemap_list_head);
1348 void nodemap_config_set_active(struct nodemap_config *config)
1350 struct nodemap_config *old_config = active_config;
1351 struct lu_nodemap *nodemap;
1352 struct lu_nodemap *tmp;
1353 LIST_HEAD(nodemap_list_head);
1357 LASSERT(active_config != config);
1358 LASSERT(config->nmc_default_nodemap);
1360 mutex_lock(&active_config_lock);
1362 /* move proc entries from already existing nms, create for new nms */
1363 cfs_hash_for_each_safe(config->nmc_nodemap_hash,
1364 nm_hash_list_cb, &nodemap_list_head);
1365 list_for_each_entry_safe(nodemap, tmp, &nodemap_list_head, nm_list) {
1366 struct lu_nodemap *old_nm = NULL;
1368 if (active_config != NULL)
1369 old_nm = cfs_hash_lookup(
1370 active_config->nmc_nodemap_hash,
1372 if (old_nm != NULL) {
1373 nodemap->nm_pde_data = old_nm->nm_pde_data;
1374 old_nm->nm_pde_data = NULL;
1375 nodemap_putref(old_nm);
1377 bool is_def = (nodemap == config->nmc_default_nodemap);
1379 lprocfs_nodemap_register(nodemap, is_def);
1383 /* if new config is inactive, deactivate live config before switching */
1384 if (!config->nmc_nodemap_is_active)
1385 nodemap_active = false;
1386 active_config = config;
1387 if (config->nmc_nodemap_is_active)
1388 nodemap_active = true;
1390 mutex_unlock(&active_config_lock);
1392 if (old_config != NULL)
1393 nodemap_config_dealloc(old_config);
1395 nm_member_revoke_all();
1401 * Cleanup nodemap module on exit
1403 void nodemap_mod_exit(void)
1405 nodemap_config_dealloc(active_config);
1406 nodemap_procfs_exit();
1410 * Initialize the nodemap module
1412 int nodemap_mod_init(void)
1414 struct nodemap_config *new_config;
1415 struct lu_nodemap *nodemap;
1418 rc = nodemap_procfs_init();
1422 new_config = nodemap_config_alloc();
1423 if (IS_ERR(new_config)) {
1424 nodemap_procfs_exit();
1425 GOTO(out, rc = PTR_ERR(new_config));
1428 nodemap = nodemap_create(DEFAULT_NODEMAP, new_config, 1);
1429 if (IS_ERR(nodemap)) {
1430 nodemap_config_dealloc(new_config);
1431 nodemap_procfs_exit();
1432 GOTO(out, rc = PTR_ERR(nodemap));
1435 nodemap_config_set_active(new_config);
1436 nodemap_putref(nodemap);
1443 * Revoke locks for all nodemaps.
1445 void nm_member_revoke_all(void)
1447 struct lu_nodemap *nodemap;
1448 struct lu_nodemap *tmp;
1449 LIST_HEAD(nodemap_list_head);
1451 mutex_lock(&active_config_lock);
1452 cfs_hash_for_each_safe(active_config->nmc_nodemap_hash,
1453 nm_hash_list_cb, &nodemap_list_head);
1455 /* revoke_locks sleeps, so can't call in cfs hash cb */
1456 list_for_each_entry_safe(nodemap, tmp, &nodemap_list_head, nm_list)
1457 nm_member_revoke_locks(nodemap);
1458 mutex_unlock(&active_config_lock);
1462 * Returns the nodemap classification for a given nid into an ioctl buffer.
1463 * Useful for testing the nodemap configuration to make sure it is working as
1466 * \param nid nid to classify
1467 * \param[out] name_buf buffer to write the nodemap name to
1468 * \param name_len length of buffer
1470 void nodemap_test_nid(lnet_nid_t nid, char *name_buf, size_t name_len)
1472 struct lu_nodemap *nodemap;
1474 mutex_lock(&active_config_lock);
1475 down_read(&active_config->nmc_range_tree_lock);
1476 nodemap = nodemap_classify_nid(nid);
1477 up_read(&active_config->nmc_range_tree_lock);
1478 mutex_unlock(&active_config_lock);
1480 strncpy(name_buf, nodemap->nm_name, name_len);
1482 name_buf[name_len - 1] = '\0';
1484 nodemap_putref(nodemap);
1486 EXPORT_SYMBOL(nodemap_test_nid);
1489 * Returns the id mapping for a given nid/id pair. Useful for testing the
1490 * nodemap configuration to make sure it is working as expected.
1492 * \param nid nid to classify
1493 * \param idtype uid or gid
1494 * \param client_id id to map to fs
1496 * \retval the mapped fs_id of the given client_id
1498 __u32 nodemap_test_id(lnet_nid_t nid, enum nodemap_id_type idtype,
1501 struct lu_nodemap *nodemap;
1504 mutex_lock(&active_config_lock);
1505 down_read(&active_config->nmc_range_tree_lock);
1506 nodemap = nodemap_classify_nid(nid);
1507 up_read(&active_config->nmc_range_tree_lock);
1508 mutex_unlock(&active_config_lock);
1510 fs_id = nodemap_map_id(nodemap, idtype, NODEMAP_CLIENT_TO_FS,
1512 nodemap_putref(nodemap);
1516 EXPORT_SYMBOL(nodemap_test_id);