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
256 * \retval -EINVAL LO nid given without other local nid
258 struct lu_nodemap *nodemap_classify_nid(lnet_nid_t nid)
260 struct lu_nid_range *range;
261 struct lu_nodemap *nodemap;
266 /* don't use 0@lo, use the first non-lo local NID instead */
267 if (LNET_NETTYP(LNET_NIDNET(nid)) == LOLND) {
268 lnet_process_id_t id;
272 rc = LNetGetId(i++, &id);
274 RETURN(ERR_PTR(-EINVAL));
275 } while (LNET_NETTYP(LNET_NIDNET(id.nid)) == LOLND);
278 CDEBUG(D_INFO, "found nid %s\n", libcfs_nid2str(nid));
281 range = range_search(&active_config->nmc_range_tree, nid);
283 nodemap = range->rn_nodemap;
285 nodemap = active_config->nmc_default_nodemap;
287 LASSERT(nodemap != NULL);
288 nodemap_getref(nodemap);
294 * simple check for default nodemap
296 static bool is_default_nodemap(const struct lu_nodemap *nodemap)
298 return nodemap->nm_id == 0;
302 * parse a nodemap range string into two nids
304 * \param range_str string to parse
305 * \param range[2] array of two nids
306 * \reyval 0 on success
308 int nodemap_parse_range(const char *range_str, lnet_nid_t range[2])
310 char buf[LNET_NIDSTR_SIZE * 2 + 2];
316 snprintf(buf, sizeof(buf), "%s", range_str);
318 start_nidstr = strsep(&ptr, ":");
319 end_nidstr = strsep(&ptr, ":");
321 if (start_nidstr == NULL || end_nidstr == NULL)
322 GOTO(out, rc = -EINVAL);
324 range[0] = libcfs_str2nid(start_nidstr);
325 range[1] = libcfs_str2nid(end_nidstr);
331 EXPORT_SYMBOL(nodemap_parse_range);
334 * parse a string containing an id map of form "client_id:filesystem_id"
335 * into an array of __u32 * for use in mapping functions
337 * \param idmap_str map string
338 * \param idmap array[2] of __u32
340 * \retval 0 on success
341 * \retval -EINVAL if idmap cannot be parsed
343 int nodemap_parse_idmap(char *idmap_str, __u32 idmap[2])
346 long unsigned int idmap_buf;
349 if (idmap_str == NULL)
352 sep = strchr(idmap_str, ':');
358 rc = kstrtoul(idmap_str, 10, &idmap_buf);
361 idmap[0] = idmap_buf;
363 rc = kstrtoul(sep, 10, &idmap_buf);
366 idmap[1] = idmap_buf;
370 EXPORT_SYMBOL(nodemap_parse_idmap);
373 * add a member to a nodemap
375 * \param nid nid to add to the members
376 * \param exp obd_export structure for the connection
377 * that is being added
378 * \retval -EINVAL export is NULL, or has invalid NID
379 * \retval -EEXIST export is already member of a nodemap
381 int nodemap_add_member(lnet_nid_t nid, struct obd_export *exp)
383 struct lu_nodemap *nodemap;
387 mutex_lock(&active_config_lock);
388 down_read(&active_config->nmc_range_tree_lock);
390 nodemap = nodemap_classify_nid(nid);
392 if (IS_ERR(nodemap)) {
393 CWARN("%s: error adding to nodemap, no valid NIDs found\n",
394 exp->exp_obd->obd_name);
397 rc = nm_member_add(nodemap, exp);
400 up_read(&active_config->nmc_range_tree_lock);
401 mutex_unlock(&active_config_lock);
403 if (!IS_ERR(nodemap))
404 nodemap_putref(nodemap);
408 EXPORT_SYMBOL(nodemap_add_member);
411 * delete a member from a nodemap
413 * \param exp export to remove from a nodemap
415 void nodemap_del_member(struct obd_export *exp)
417 struct lu_nodemap *nodemap;
421 /* using ac lock to prevent nodemap reclassification while deleting */
422 mutex_lock(&active_config_lock);
424 /* use of ted_nodemap is protected by active_config_lock. we take an
425 * extra reference to make sure nodemap isn't destroyed under
428 nodemap = exp->exp_target_data.ted_nodemap;
432 nodemap_getref(nodemap);
434 mutex_lock(&nodemap->nm_member_list_lock);
435 nm_member_del(nodemap, exp);
436 mutex_unlock(&nodemap->nm_member_list_lock);
439 mutex_unlock(&active_config_lock);
442 nodemap_putref(nodemap);
446 EXPORT_SYMBOL(nodemap_del_member);
449 * add an idmap to the proper nodemap trees
451 * \param name name of nodemap
452 * \param id_type NODEMAP_UID or NODEMAP_GID
453 * \param map array[2] __u32 containing the map values
454 * map[0] is client id
455 * map[1] is the filesystem id
457 * \retval 0 on success
459 int nodemap_add_idmap_helper(struct lu_nodemap *nodemap,
460 enum nodemap_id_type id_type,
463 struct lu_idmap *idmap;
466 idmap = idmap_create(map[0], map[1]);
468 GOTO(out, rc = -ENOMEM);
470 write_lock(&nodemap->nm_idmap_lock);
471 idmap_insert(id_type, idmap, nodemap);
472 write_unlock(&nodemap->nm_idmap_lock);
473 nm_member_revoke_locks(nodemap);
479 int nodemap_add_idmap(const char *name, enum nodemap_id_type id_type,
482 struct lu_nodemap *nodemap = NULL;
485 mutex_lock(&active_config_lock);
486 nodemap = nodemap_lookup(name);
487 if (IS_ERR(nodemap)) {
488 mutex_unlock(&active_config_lock);
489 GOTO(out, rc = PTR_ERR(nodemap));
492 if (is_default_nodemap(nodemap)) {
495 rc = nodemap_add_idmap_helper(nodemap, id_type, map);
497 rc = nodemap_idx_idmap_add(nodemap, id_type, map);
499 mutex_unlock(&active_config_lock);
500 nodemap_putref(nodemap);
505 EXPORT_SYMBOL(nodemap_add_idmap);
508 * delete idmap from proper nodemap tree
510 * \param name name of nodemap
511 * \param id_type NODEMAP_UID or NODEMAP_GID
512 * \param map array[2] __u32 containing the mapA values
513 * map[0] is client id
514 * map[1] is the filesystem id
516 * \retval 0 on success
518 int nodemap_del_idmap(const char *name, enum nodemap_id_type id_type,
521 struct lu_nodemap *nodemap = NULL;
522 struct lu_idmap *idmap = NULL;
525 mutex_lock(&active_config_lock);
526 nodemap = nodemap_lookup(name);
527 if (IS_ERR(nodemap)) {
528 mutex_unlock(&active_config_lock);
529 GOTO(out, rc = PTR_ERR(nodemap));
532 if (is_default_nodemap(nodemap))
533 GOTO(out_putref, rc = -EINVAL);
535 write_lock(&nodemap->nm_idmap_lock);
536 idmap = idmap_search(nodemap, NODEMAP_CLIENT_TO_FS, id_type,
541 idmap_delete(id_type, idmap, nodemap);
542 rc = nodemap_idx_idmap_del(nodemap, id_type, map);
544 write_unlock(&nodemap->nm_idmap_lock);
547 mutex_unlock(&active_config_lock);
549 nm_member_revoke_locks(nodemap);
550 nodemap_putref(nodemap);
555 EXPORT_SYMBOL(nodemap_del_idmap);
558 * Get nodemap assigned to given export. Takes a reference on the nodemap.
560 * Note that this function may return either NULL, or an ERR_PTR()
561 * or a valid nodemap pointer. All of the functions accessing the
562 * returned nodemap can check IS_ERR(nodemap) to see if an error is
563 * returned. NULL is not considered an error, which is OK since this
564 * is a valid case if nodemap are not in use. All nodemap handling
565 * functions must check for nodemap == NULL and do nothing, and the
566 * nodemap returned from this function should not be dereferenced.
568 * \param export export to get nodemap for
570 * \retval pointer to nodemap on success
571 * \retval NULL nodemap subsystem disabled
572 * \retval -EACCES export does not have nodemap assigned
574 struct lu_nodemap *nodemap_get_from_exp(struct obd_export *exp)
576 struct lu_nodemap *nodemap;
583 spin_lock(&exp->exp_target_data.ted_nodemap_lock);
584 nodemap = exp->exp_target_data.ted_nodemap;
586 nodemap_getref(nodemap);
587 spin_unlock(&exp->exp_target_data.ted_nodemap_lock);
590 CDEBUG(D_INFO, "%s: nodemap null on export %s (at %s)\n",
591 exp->exp_obd->obd_name,
592 obd_uuid2str(&exp->exp_client_uuid),
593 obd_export_nid2str(exp));
594 RETURN(ERR_PTR(-EACCES));
599 EXPORT_SYMBOL(nodemap_get_from_exp);
602 * mapping function for nodemap idmaps
604 * \param nodemap lu_nodemap structure defining nodemap
605 * \param node_type NODEMAP_UID or NODEMAP_GID
606 * \param tree_type NODEMAP_CLIENT_TO_FS or
607 * NODEMAP_FS_TO_CLIENT
608 * \param id id to map
610 * \retval mapped id according to the rules below.
612 * if the nodemap_active is false, just return the passed id without mapping
614 * if the id to be looked up is 0, check that root access is allowed and if it
615 * is, return 0. Otherwise, return the squash uid or gid.
617 * if the nodemap is configured to trusted the ids from the client system, just
618 * return the passwd id without mapping.
620 * if by this point, we haven't returned and the nodemap in question is the
621 * default nodemap, return the squash uid or gid.
623 * after these checks, search the proper tree for the mapping, and if found
624 * return the mapped value, otherwise return the squash uid or gid.
626 __u32 nodemap_map_id(struct lu_nodemap *nodemap,
627 enum nodemap_id_type id_type,
628 enum nodemap_tree_type tree_type, __u32 id)
630 struct lu_idmap *idmap = NULL;
638 if (unlikely(nodemap == NULL))
642 if (nodemap->nmf_allow_root_access)
648 if (nodemap->nmf_trust_client_ids)
651 if (is_default_nodemap(nodemap))
654 read_lock(&nodemap->nm_idmap_lock);
655 idmap = idmap_search(nodemap, tree_type, id_type, id);
657 read_unlock(&nodemap->nm_idmap_lock);
661 if (tree_type == NODEMAP_FS_TO_CLIENT)
662 found_id = idmap->id_client;
664 found_id = idmap->id_fs;
665 read_unlock(&nodemap->nm_idmap_lock);
669 if (id_type == NODEMAP_UID)
670 RETURN(nodemap->nm_squash_uid);
672 RETURN(nodemap->nm_squash_gid);
676 EXPORT_SYMBOL(nodemap_map_id);
679 * Map posix ACL entries according to the nodemap membership. Removes any
682 * \param lu_nodemap nodemap
683 * \param buf buffer containing xattr encoded ACLs
684 * \param size size of ACLs in bytes
685 * \param tree_type direction of mapping
686 * \retval size new size of ACLs in bytes
687 * \retval -EINVAL bad \a size param, see posix_acl_xattr_count()
689 ssize_t nodemap_map_acl(struct lu_nodemap *nodemap, void *buf, size_t size,
690 enum nodemap_tree_type tree_type)
692 posix_acl_xattr_header *header = buf;
693 posix_acl_xattr_entry *entry = &header->a_entries[0];
694 posix_acl_xattr_entry *new_entry = entry;
695 posix_acl_xattr_entry *end;
701 if (unlikely(nodemap == NULL))
704 count = posix_acl_xattr_count(size);
710 for (end = entry + count; entry != end; entry++) {
711 __u16 tag = le16_to_cpu(entry->e_tag);
712 __u32 id = le32_to_cpu(entry->e_id);
716 id = nodemap_map_id(nodemap, NODEMAP_UID,
718 if (id == nodemap->nm_squash_uid)
720 entry->e_id = cpu_to_le32(id);
723 id = nodemap_map_id(nodemap, NODEMAP_GID,
725 if (id == nodemap->nm_squash_gid)
727 entry->e_id = cpu_to_le32(id);
731 /* if we skip an ACL, copy the following ones over it */
732 if (new_entry != entry)
738 return (void *)new_entry - (void *)header;
740 EXPORT_SYMBOL(nodemap_map_acl);
743 * Add nid range to given nodemap
745 * \param config nodemap config to work on
746 * \param nodemap nodemap to add range to
747 * \param nid nid range to add
748 * \param range_id should be 0 unless loading from disk
753 int nodemap_add_range_helper(struct nodemap_config *config,
754 struct lu_nodemap *nodemap,
755 const lnet_nid_t nid[2],
756 unsigned int range_id)
758 struct lu_nid_range *range;
761 down_write(&config->nmc_range_tree_lock);
762 range = range_create(&config->nmc_range_tree, nid[0], nid[1],
765 up_write(&config->nmc_range_tree_lock);
766 GOTO(out, rc = -ENOMEM);
769 rc = range_insert(&config->nmc_range_tree, range);
771 CERROR("cannot insert nodemap range into '%s': rc = %d\n",
772 nodemap->nm_name, rc);
773 up_write(&config->nmc_range_tree_lock);
774 list_del(&range->rn_list);
775 range_destroy(range);
776 GOTO(out, rc = -ENOMEM);
779 list_add(&range->rn_list, &nodemap->nm_ranges);
780 nm_member_reclassify_nodemap(config->nmc_default_nodemap);
781 up_write(&config->nmc_range_tree_lock);
783 /* if range_id is non-zero, we are loading from disk */
785 rc = nodemap_idx_range_add(range, nid);
787 nm_member_revoke_locks(config->nmc_default_nodemap);
788 nm_member_revoke_locks(nodemap);
793 int nodemap_add_range(const char *name, const lnet_nid_t nid[2])
795 struct lu_nodemap *nodemap = NULL;
798 mutex_lock(&active_config_lock);
799 nodemap = nodemap_lookup(name);
800 if (IS_ERR(nodemap)) {
801 mutex_unlock(&active_config_lock);
802 GOTO(out, rc = PTR_ERR(nodemap));
805 if (is_default_nodemap(nodemap))
808 rc = nodemap_add_range_helper(active_config, nodemap, nid, 0);
809 mutex_unlock(&active_config_lock);
810 nodemap_putref(nodemap);
814 EXPORT_SYMBOL(nodemap_add_range);
818 * \param name nodemap name
819 * \param range_str string containing range
820 * \retval 0 on success
822 * Delete range from global range tree, and remove it
823 * from the list in the associated nodemap.
825 int nodemap_del_range(const char *name, const lnet_nid_t nid[2])
827 struct lu_nodemap *nodemap;
828 struct lu_nid_range *range;
831 mutex_lock(&active_config_lock);
832 nodemap = nodemap_lookup(name);
833 if (IS_ERR(nodemap)) {
834 mutex_unlock(&active_config_lock);
835 GOTO(out, rc = PTR_ERR(nodemap));
838 if (is_default_nodemap(nodemap))
839 GOTO(out_putref, rc = -EINVAL);
841 down_write(&active_config->nmc_range_tree_lock);
842 range = range_find(&active_config->nmc_range_tree, nid[0], nid[1]);
844 up_write(&active_config->nmc_range_tree_lock);
845 GOTO(out_putref, rc = -EINVAL);
847 rc = nodemap_idx_range_del(range);
848 range_delete(&active_config->nmc_range_tree, range);
849 nm_member_reclassify_nodemap(nodemap);
850 up_write(&active_config->nmc_range_tree_lock);
852 nm_member_revoke_locks(active_config->nmc_default_nodemap);
853 nm_member_revoke_locks(nodemap);
856 mutex_unlock(&active_config_lock);
857 nodemap_putref(nodemap);
861 EXPORT_SYMBOL(nodemap_del_range);
864 * set fileset on nodemap
865 * \param name nodemap to set fileset on
866 * \param fileset string containing fileset
867 * \retval 0 on success
869 * set a fileset on the named nodemap
871 static int nodemap_set_fileset_helper(struct nodemap_config *config,
872 struct lu_nodemap *nodemap,
877 /* we allow fileset = "" which means clear fileset info */
878 if (fileset == NULL || (fileset[0] != 0 && fileset[0] != '/'))
880 else if (strlcpy(nodemap->nm_fileset, fileset,
881 sizeof(nodemap->nm_fileset)) >=
882 sizeof(nodemap->nm_fileset))
888 int nodemap_set_fileset(const char *name, const char *fileset)
890 struct lu_nodemap *nodemap = NULL;
893 mutex_lock(&active_config_lock);
894 nodemap = nodemap_lookup(name);
895 if (IS_ERR(nodemap)) {
896 mutex_unlock(&active_config_lock);
897 GOTO(out, rc = PTR_ERR(nodemap));
900 if (is_default_nodemap(nodemap))
903 rc = nodemap_set_fileset_helper(active_config, nodemap,
905 mutex_unlock(&active_config_lock);
907 nodemap_putref(nodemap);
911 EXPORT_SYMBOL(nodemap_set_fileset);
914 * get fileset defined on nodemap
915 * \param nodemap nodemap to get fileset from
916 * \retval fileset name, or NULL if not defined or not activated
918 * get the fileset defined on the nodemap
920 char *nodemap_get_fileset(const struct lu_nodemap *nodemap)
922 if (!nodemap_active || is_default_nodemap(nodemap))
925 return (char *)nodemap->nm_fileset;
927 EXPORT_SYMBOL(nodemap_get_fileset);
930 * Nodemap constructor
932 * Creates an lu_nodemap structure and assigns sane default
933 * member values. If this is the default nodemap, the defaults
934 * are the most restictive in xterms of mapping behavior. Otherwise
935 * the default flags should be inherited from the default nodemap.
936 * The adds nodemap to nodemap_hash.
938 * Requires that the caller take the active_config_lock
940 * \param name name of nodemap
941 * \param is_default true if default nodemap
942 * \retval nodemap success
943 * \retval -EINVAL invalid nodemap name
944 * \retval -EEXIST nodemap already exists
945 * \retval -ENOMEM cannot allocate memory for nodemap
947 struct lu_nodemap *nodemap_create(const char *name,
948 struct nodemap_config *config,
951 struct lu_nodemap *nodemap = NULL;
952 struct lu_nodemap *default_nodemap;
953 struct cfs_hash *hash = config->nmc_nodemap_hash;
956 default_nodemap = config->nmc_default_nodemap;
958 if (!nodemap_name_is_valid(name))
959 GOTO(out, rc = -EINVAL);
962 CERROR("Config nodemap hash is NULL, unable to add %s\n", name);
963 GOTO(out, rc = -EINVAL);
966 OBD_ALLOC_PTR(nodemap);
967 if (nodemap == NULL) {
968 CERROR("cannot allocate memory (%zu bytes)"
969 "for nodemap '%s'\n", sizeof(*nodemap),
971 GOTO(out, rc = -ENOMEM);
975 * take an extra reference to prevent nodemap from being destroyed
976 * while it's being created.
978 atomic_set(&nodemap->nm_refcount, 2);
979 snprintf(nodemap->nm_name, sizeof(nodemap->nm_name), "%s", name);
980 rc = cfs_hash_add_unique(hash, name, &nodemap->nm_hash);
982 OBD_FREE_PTR(nodemap);
983 GOTO(out, rc = -EEXIST);
986 INIT_LIST_HEAD(&nodemap->nm_ranges);
987 INIT_LIST_HEAD(&nodemap->nm_list);
988 INIT_LIST_HEAD(&nodemap->nm_member_list);
990 mutex_init(&nodemap->nm_member_list_lock);
991 rwlock_init(&nodemap->nm_idmap_lock);
992 nodemap->nm_fs_to_client_uidmap = RB_ROOT;
993 nodemap->nm_client_to_fs_uidmap = RB_ROOT;
994 nodemap->nm_fs_to_client_gidmap = RB_ROOT;
995 nodemap->nm_client_to_fs_gidmap = RB_ROOT;
998 nodemap->nm_id = LUSTRE_NODEMAP_DEFAULT_ID;
999 config->nmc_default_nodemap = nodemap;
1001 config->nmc_nodemap_highest_id++;
1002 nodemap->nm_id = config->nmc_nodemap_highest_id;
1005 if (is_default || default_nodemap == NULL) {
1006 nodemap->nmf_trust_client_ids = 0;
1007 nodemap->nmf_allow_root_access = 0;
1009 nodemap->nm_squash_uid = NODEMAP_NOBODY_UID;
1010 nodemap->nm_squash_gid = NODEMAP_NOBODY_GID;
1012 CWARN("adding nodemap '%s' to config without"
1013 " default nodemap\n", nodemap->nm_name);
1015 nodemap->nmf_trust_client_ids =
1016 default_nodemap->nmf_trust_client_ids;
1017 nodemap->nmf_allow_root_access =
1018 default_nodemap->nmf_allow_root_access;
1020 nodemap->nm_squash_uid = default_nodemap->nm_squash_uid;
1021 nodemap->nm_squash_gid = default_nodemap->nm_squash_gid;
1022 nodemap->nm_fileset[0] = 0;
1028 CERROR("cannot add nodemap: '%s': rc = %d\n", name, rc);
1033 * update flag to turn on or off nodemap functions
1034 * \param name nodemap name
1035 * \param admin_string string containing updated value
1036 * \retval 0 on success
1038 * Update admin flag to turn on or off nodemap functions.
1040 int nodemap_set_allow_root(const char *name, bool allow_root)
1042 struct lu_nodemap *nodemap = NULL;
1045 mutex_lock(&active_config_lock);
1046 nodemap = nodemap_lookup(name);
1047 mutex_unlock(&active_config_lock);
1048 if (IS_ERR(nodemap))
1049 GOTO(out, rc = PTR_ERR(nodemap));
1051 nodemap->nmf_allow_root_access = allow_root;
1052 rc = nodemap_idx_nodemap_update(nodemap);
1054 nm_member_revoke_locks(nodemap);
1055 nodemap_putref(nodemap);
1059 EXPORT_SYMBOL(nodemap_set_allow_root);
1062 * updated trust_client_ids flag for nodemap
1064 * \param name nodemap name
1065 * \param trust_string new value for trust flag
1066 * \retval 0 on success
1068 * Update the trust_client_ids flag for a nodemap.
1070 int nodemap_set_trust_client_ids(const char *name, bool trust_client_ids)
1072 struct lu_nodemap *nodemap = NULL;
1075 mutex_lock(&active_config_lock);
1076 nodemap = nodemap_lookup(name);
1077 mutex_unlock(&active_config_lock);
1078 if (IS_ERR(nodemap))
1079 GOTO(out, rc = PTR_ERR(nodemap));
1081 nodemap->nmf_trust_client_ids = trust_client_ids;
1082 rc = nodemap_idx_nodemap_update(nodemap);
1084 nm_member_revoke_locks(nodemap);
1085 nodemap_putref(nodemap);
1089 EXPORT_SYMBOL(nodemap_set_trust_client_ids);
1092 * update the squash_uid for a nodemap
1094 * \param name nodemap name
1095 * \param uid_string string containing new squash_uid value
1096 * \retval 0 on success
1098 * Update the squash_uid for a nodemap. The squash_uid is the uid
1099 * that the all client uids are mapped to if nodemap is active,
1100 * the trust_client_ids flag is not set, and the uid is not in
1103 int nodemap_set_squash_uid(const char *name, uid_t uid)
1105 struct lu_nodemap *nodemap = NULL;
1108 mutex_lock(&active_config_lock);
1109 nodemap = nodemap_lookup(name);
1110 mutex_unlock(&active_config_lock);
1111 if (IS_ERR(nodemap))
1112 GOTO(out, rc = PTR_ERR(nodemap));
1114 nodemap->nm_squash_uid = uid;
1115 rc = nodemap_idx_nodemap_update(nodemap);
1117 nm_member_revoke_locks(nodemap);
1118 nodemap_putref(nodemap);
1122 EXPORT_SYMBOL(nodemap_set_squash_uid);
1125 * Update the squash_gid for a nodemap.
1127 * \param name nodemap name
1128 * \param gid_string string containing new squash_gid value
1129 * \retval 0 on success
1131 * Update the squash_gid for a nodemap. The squash_uid is the gid
1132 * that the all client gids are mapped to if nodemap is active,
1133 * the trust_client_ids flag is not set, and the gid is not in
1136 int nodemap_set_squash_gid(const char *name, gid_t gid)
1138 struct lu_nodemap *nodemap = NULL;
1141 mutex_lock(&active_config_lock);
1142 nodemap = nodemap_lookup(name);
1143 mutex_unlock(&active_config_lock);
1144 if (IS_ERR(nodemap))
1145 GOTO(out, rc = PTR_ERR(nodemap));
1147 nodemap->nm_squash_gid = gid;
1148 rc = nodemap_idx_nodemap_update(nodemap);
1150 nm_member_revoke_locks(nodemap);
1151 nodemap_putref(nodemap);
1155 EXPORT_SYMBOL(nodemap_set_squash_gid);
1158 * Returns true if this nodemap has root user access. Always returns true if
1159 * nodemaps are not active.
1161 * \param nodemap nodemap to check access for
1163 bool nodemap_can_setquota(const struct lu_nodemap *nodemap)
1165 return !nodemap_active || (nodemap && nodemap->nmf_allow_root_access);
1167 EXPORT_SYMBOL(nodemap_can_setquota);
1172 * \param name name of nodemap
1174 * \retval -EINVAL invalid nodemap name
1175 * \retval -EEXIST nodemap already exists
1176 * \retval -ENOMEM cannot allocate memory for nodemap
1178 int nodemap_add(const char *nodemap_name)
1180 struct lu_nodemap *nodemap;
1183 mutex_lock(&active_config_lock);
1184 nodemap = nodemap_create(nodemap_name, active_config, 0);
1185 if (IS_ERR(nodemap)) {
1186 mutex_unlock(&active_config_lock);
1187 return PTR_ERR(nodemap);
1190 rc = nodemap_idx_nodemap_add(nodemap);
1192 rc = lprocfs_nodemap_register(nodemap, 0);
1194 mutex_unlock(&active_config_lock);
1195 nodemap_putref(nodemap);
1199 EXPORT_SYMBOL(nodemap_add);
1204 * \param name name of nodemmap
1206 * \retval -EINVAL invalid input
1207 * \retval -ENOENT no existing nodemap
1209 int nodemap_del(const char *nodemap_name)
1211 struct lu_nodemap *nodemap;
1212 struct lu_nid_range *range;
1213 struct lu_nid_range *range_temp;
1217 if (strcmp(nodemap_name, DEFAULT_NODEMAP) == 0)
1220 mutex_lock(&active_config_lock);
1221 nodemap = cfs_hash_del_key(active_config->nmc_nodemap_hash,
1223 if (nodemap == NULL) {
1224 mutex_unlock(&active_config_lock);
1225 GOTO(out, rc = -ENOENT);
1228 /* erase nodemap from active ranges to prevent client assignment */
1229 down_write(&active_config->nmc_range_tree_lock);
1230 list_for_each_entry_safe(range, range_temp, &nodemap->nm_ranges,
1232 rc2 = nodemap_idx_range_del(range);
1236 range_delete(&active_config->nmc_range_tree, range);
1238 up_write(&active_config->nmc_range_tree_lock);
1240 rc2 = nodemap_idx_nodemap_del(nodemap);
1245 * remove procfs here in case nodemap_create called with same name
1246 * before nodemap_destroy is run.
1248 lprocfs_nodemap_remove(nodemap->nm_pde_data);
1249 nodemap->nm_pde_data = NULL;
1251 /* reclassify all member exports from nodemap, so they put their refs */
1252 down_read(&active_config->nmc_range_tree_lock);
1253 nm_member_reclassify_nodemap(nodemap);
1254 up_read(&active_config->nmc_range_tree_lock);
1256 if (!list_empty(&nodemap->nm_member_list))
1257 CWARN("nodemap_del failed to reclassify all members\n");
1259 mutex_unlock(&active_config_lock);
1261 nodemap_putref(nodemap);
1266 EXPORT_SYMBOL(nodemap_del);
1269 * activate nodemap functions
1271 * \param value 1 for on, 0 for off
1273 void nodemap_activate(const bool value)
1275 mutex_lock(&active_config_lock);
1276 active_config->nmc_nodemap_is_active = value;
1278 /* copy active value to global to avoid locking in map functions */
1279 nodemap_active = value;
1280 nodemap_idx_nodemap_activate(value);
1281 mutex_unlock(&active_config_lock);
1282 nm_member_revoke_all();
1284 EXPORT_SYMBOL(nodemap_activate);
1287 * Helper iterator to convert nodemap hash to list.
1289 * \param hs hash structure
1290 * \param bd bucket descriptor
1291 * \param hnode hash node
1292 * \param nodemap_list_head list head for list of nodemaps in hash
1294 static int nodemap_cleanup_iter_cb(struct cfs_hash *hs, struct cfs_hash_bd *bd,
1295 struct hlist_node *hnode,
1296 void *nodemap_list_head)
1298 struct lu_nodemap *nodemap;
1300 nodemap = hlist_entry(hnode, struct lu_nodemap, nm_hash);
1301 list_add(&nodemap->nm_list, nodemap_list_head);
1303 cfs_hash_bd_del_locked(hs, bd, hnode);
1308 struct nodemap_config *nodemap_config_alloc(void)
1310 struct nodemap_config *config;
1313 OBD_ALLOC_PTR(config);
1315 return ERR_PTR(-ENOMEM);
1317 rc = nodemap_init_hash(config);
1319 OBD_FREE_PTR(config);
1323 init_rwsem(&config->nmc_range_tree_lock);
1327 EXPORT_SYMBOL(nodemap_config_alloc);
1330 * Walk the nodemap_hash and remove all nodemaps.
1332 void nodemap_config_dealloc(struct nodemap_config *config)
1334 struct lu_nodemap *nodemap = NULL;
1335 struct lu_nodemap *nodemap_temp;
1336 struct lu_nid_range *range;
1337 struct lu_nid_range *range_temp;
1338 LIST_HEAD(nodemap_list_head);
1340 cfs_hash_for_each_safe(config->nmc_nodemap_hash,
1341 nodemap_cleanup_iter_cb, &nodemap_list_head);
1342 cfs_hash_putref(config->nmc_nodemap_hash);
1344 /* Because nodemap_destroy might sleep, we can't destroy them
1345 * in cfs_hash_for_each, so we build a list there and destroy here
1347 list_for_each_entry_safe(nodemap, nodemap_temp, &nodemap_list_head,
1349 down_write(&config->nmc_range_tree_lock);
1351 /* move members to new config */
1352 nm_member_reclassify_nodemap(nodemap);
1353 list_for_each_entry_safe(range, range_temp, &nodemap->nm_ranges,
1355 range_delete(&config->nmc_range_tree, range);
1356 up_write(&config->nmc_range_tree_lock);
1358 nodemap_putref(nodemap);
1360 OBD_FREE_PTR(config);
1362 EXPORT_SYMBOL(nodemap_config_dealloc);
1364 static int nm_hash_list_cb(struct cfs_hash *hs, struct cfs_hash_bd *bd,
1365 struct hlist_node *hnode,
1366 void *nodemap_list_head)
1368 struct lu_nodemap *nodemap;
1370 nodemap = hlist_entry(hnode, struct lu_nodemap, nm_hash);
1371 list_add(&nodemap->nm_list, nodemap_list_head);
1375 void nodemap_config_set_active(struct nodemap_config *config)
1377 struct nodemap_config *old_config = active_config;
1378 struct lu_nodemap *nodemap;
1379 struct lu_nodemap *tmp;
1380 LIST_HEAD(nodemap_list_head);
1384 LASSERT(active_config != config);
1385 LASSERT(config->nmc_default_nodemap);
1387 mutex_lock(&active_config_lock);
1389 /* move proc entries from already existing nms, create for new nms */
1390 cfs_hash_for_each_safe(config->nmc_nodemap_hash,
1391 nm_hash_list_cb, &nodemap_list_head);
1392 list_for_each_entry_safe(nodemap, tmp, &nodemap_list_head, nm_list) {
1393 struct lu_nodemap *old_nm = NULL;
1395 if (active_config != NULL)
1396 old_nm = cfs_hash_lookup(
1397 active_config->nmc_nodemap_hash,
1399 if (old_nm != NULL) {
1400 nodemap->nm_pde_data = old_nm->nm_pde_data;
1401 old_nm->nm_pde_data = NULL;
1402 nodemap_putref(old_nm);
1404 bool is_def = (nodemap == config->nmc_default_nodemap);
1406 lprocfs_nodemap_register(nodemap, is_def);
1410 /* if new config is inactive, deactivate live config before switching */
1411 if (!config->nmc_nodemap_is_active)
1412 nodemap_active = false;
1413 active_config = config;
1414 if (config->nmc_nodemap_is_active)
1415 nodemap_active = true;
1417 mutex_unlock(&active_config_lock);
1419 if (old_config != NULL)
1420 nodemap_config_dealloc(old_config);
1422 nm_member_revoke_all();
1428 * Cleanup nodemap module on exit
1430 void nodemap_mod_exit(void)
1432 nodemap_config_dealloc(active_config);
1433 nodemap_procfs_exit();
1437 * Initialize the nodemap module
1439 int nodemap_mod_init(void)
1441 struct nodemap_config *new_config;
1442 struct lu_nodemap *nodemap;
1445 rc = nodemap_procfs_init();
1449 new_config = nodemap_config_alloc();
1450 if (IS_ERR(new_config)) {
1451 nodemap_procfs_exit();
1452 GOTO(out, rc = PTR_ERR(new_config));
1455 nodemap = nodemap_create(DEFAULT_NODEMAP, new_config, 1);
1456 if (IS_ERR(nodemap)) {
1457 nodemap_config_dealloc(new_config);
1458 nodemap_procfs_exit();
1459 GOTO(out, rc = PTR_ERR(nodemap));
1462 nodemap_config_set_active(new_config);
1463 nodemap_putref(nodemap);
1470 * Revoke locks for all nodemaps.
1472 void nm_member_revoke_all(void)
1474 struct lu_nodemap *nodemap;
1475 struct lu_nodemap *tmp;
1476 LIST_HEAD(nodemap_list_head);
1478 mutex_lock(&active_config_lock);
1479 cfs_hash_for_each_safe(active_config->nmc_nodemap_hash,
1480 nm_hash_list_cb, &nodemap_list_head);
1482 /* revoke_locks sleeps, so can't call in cfs hash cb */
1483 list_for_each_entry_safe(nodemap, tmp, &nodemap_list_head, nm_list)
1484 nm_member_revoke_locks(nodemap);
1485 mutex_unlock(&active_config_lock);
1489 * Returns the nodemap classification for a given nid into an ioctl buffer.
1490 * Useful for testing the nodemap configuration to make sure it is working as
1493 * \param nid nid to classify
1494 * \param[out] name_buf buffer to write the nodemap name to
1495 * \param name_len length of buffer
1497 void nodemap_test_nid(lnet_nid_t nid, char *name_buf, size_t name_len)
1499 struct lu_nodemap *nodemap;
1501 mutex_lock(&active_config_lock);
1502 down_read(&active_config->nmc_range_tree_lock);
1503 nodemap = nodemap_classify_nid(nid);
1504 up_read(&active_config->nmc_range_tree_lock);
1505 mutex_unlock(&active_config_lock);
1507 if (IS_ERR(nodemap))
1510 strncpy(name_buf, nodemap->nm_name, name_len);
1512 name_buf[name_len - 1] = '\0';
1514 nodemap_putref(nodemap);
1516 EXPORT_SYMBOL(nodemap_test_nid);
1519 * Passes back the id mapping for a given nid/id pair. Useful for testing the
1520 * nodemap configuration to make sure it is working as expected.
1522 * \param nid nid to classify
1523 * \param idtype uid or gid
1524 * \param client_id id to map to fs
1525 * \param fs_id_buf pointer to save mapped fs_id to
1528 * \retval -EINVAL invalid NID
1530 int nodemap_test_id(lnet_nid_t nid, enum nodemap_id_type idtype,
1531 __u32 client_id, __u32 *fs_id)
1533 struct lu_nodemap *nodemap;
1535 mutex_lock(&active_config_lock);
1536 down_read(&active_config->nmc_range_tree_lock);
1537 nodemap = nodemap_classify_nid(nid);
1538 up_read(&active_config->nmc_range_tree_lock);
1539 mutex_unlock(&active_config_lock);
1541 if (IS_ERR(nodemap))
1542 return PTR_ERR(nodemap);
1544 *fs_id = nodemap_map_id(nodemap, idtype, NODEMAP_CLIENT_TO_FS,
1546 nodemap_putref(nodemap);
1550 EXPORT_SYMBOL(nodemap_test_id);