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 struct lnet_process_id 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))
641 if (nodemap->nmf_map_uid_only && id_type == NODEMAP_GID)
644 if (nodemap->nmf_map_gid_only && id_type == NODEMAP_UID)
648 if (nodemap->nmf_allow_root_access)
654 if (nodemap->nmf_trust_client_ids)
657 if (is_default_nodemap(nodemap))
660 read_lock(&nodemap->nm_idmap_lock);
661 idmap = idmap_search(nodemap, tree_type, id_type, id);
663 read_unlock(&nodemap->nm_idmap_lock);
667 if (tree_type == NODEMAP_FS_TO_CLIENT)
668 found_id = idmap->id_client;
670 found_id = idmap->id_fs;
671 read_unlock(&nodemap->nm_idmap_lock);
675 if (id_type == NODEMAP_UID)
676 RETURN(nodemap->nm_squash_uid);
678 RETURN(nodemap->nm_squash_gid);
682 EXPORT_SYMBOL(nodemap_map_id);
685 * Map posix ACL entries according to the nodemap membership. Removes any
688 * \param lu_nodemap nodemap
689 * \param buf buffer containing xattr encoded ACLs
690 * \param size size of ACLs in bytes
691 * \param tree_type direction of mapping
692 * \retval size new size of ACLs in bytes
693 * \retval -EINVAL bad \a size param, see posix_acl_xattr_count()
695 ssize_t nodemap_map_acl(struct lu_nodemap *nodemap, void *buf, size_t size,
696 enum nodemap_tree_type tree_type)
698 posix_acl_xattr_header *header = buf;
699 posix_acl_xattr_entry *entry = GET_POSIX_ACL_XATTR_ENTRY(header);
700 posix_acl_xattr_entry *new_entry = entry;
701 posix_acl_xattr_entry *end;
707 if (unlikely(nodemap == NULL))
710 count = posix_acl_xattr_count(size);
716 for (end = entry + count; entry != end; entry++) {
717 __u16 tag = le16_to_cpu(entry->e_tag);
718 __u32 id = le32_to_cpu(entry->e_id);
722 id = nodemap_map_id(nodemap, NODEMAP_UID,
724 if (id == nodemap->nm_squash_uid)
726 entry->e_id = cpu_to_le32(id);
729 id = nodemap_map_id(nodemap, NODEMAP_GID,
731 if (id == nodemap->nm_squash_gid)
733 entry->e_id = cpu_to_le32(id);
737 /* if we skip an ACL, copy the following ones over it */
738 if (new_entry != entry)
744 return (void *)new_entry - (void *)header;
746 EXPORT_SYMBOL(nodemap_map_acl);
749 * Add nid range to given nodemap
751 * \param config nodemap config to work on
752 * \param nodemap nodemap to add range to
753 * \param nid nid range to add
754 * \param range_id should be 0 unless loading from disk
759 int nodemap_add_range_helper(struct nodemap_config *config,
760 struct lu_nodemap *nodemap,
761 const lnet_nid_t nid[2],
762 unsigned int range_id)
764 struct lu_nid_range *range;
767 down_write(&config->nmc_range_tree_lock);
768 range = range_create(&config->nmc_range_tree, nid[0], nid[1],
771 up_write(&config->nmc_range_tree_lock);
772 GOTO(out, rc = -ENOMEM);
775 rc = range_insert(&config->nmc_range_tree, range);
777 CERROR("cannot insert nodemap range into '%s': rc = %d\n",
778 nodemap->nm_name, rc);
779 up_write(&config->nmc_range_tree_lock);
780 list_del(&range->rn_list);
781 range_destroy(range);
782 GOTO(out, rc = -ENOMEM);
785 list_add(&range->rn_list, &nodemap->nm_ranges);
787 /* nodemaps have no members if they aren't on the active config */
788 if (config == active_config)
789 nm_member_reclassify_nodemap(config->nmc_default_nodemap);
791 up_write(&config->nmc_range_tree_lock);
793 /* if range_id is non-zero, we are loading from disk */
795 rc = nodemap_idx_range_add(range, nid);
797 if (config == active_config) {
798 nm_member_revoke_locks(config->nmc_default_nodemap);
799 nm_member_revoke_locks(nodemap);
805 int nodemap_add_range(const char *name, const lnet_nid_t nid[2])
807 struct lu_nodemap *nodemap = NULL;
810 mutex_lock(&active_config_lock);
811 nodemap = nodemap_lookup(name);
812 if (IS_ERR(nodemap)) {
813 mutex_unlock(&active_config_lock);
814 GOTO(out, rc = PTR_ERR(nodemap));
817 if (is_default_nodemap(nodemap))
820 rc = nodemap_add_range_helper(active_config, nodemap, nid, 0);
821 mutex_unlock(&active_config_lock);
822 nodemap_putref(nodemap);
826 EXPORT_SYMBOL(nodemap_add_range);
830 * \param name nodemap name
831 * \param range_str string containing range
832 * \retval 0 on success
834 * Delete range from global range tree, and remove it
835 * from the list in the associated nodemap.
837 int nodemap_del_range(const char *name, const lnet_nid_t nid[2])
839 struct lu_nodemap *nodemap;
840 struct lu_nid_range *range;
843 mutex_lock(&active_config_lock);
844 nodemap = nodemap_lookup(name);
845 if (IS_ERR(nodemap)) {
846 mutex_unlock(&active_config_lock);
847 GOTO(out, rc = PTR_ERR(nodemap));
850 if (is_default_nodemap(nodemap))
851 GOTO(out_putref, rc = -EINVAL);
853 down_write(&active_config->nmc_range_tree_lock);
854 range = range_find(&active_config->nmc_range_tree, nid[0], nid[1]);
856 up_write(&active_config->nmc_range_tree_lock);
857 GOTO(out_putref, rc = -EINVAL);
859 rc = nodemap_idx_range_del(range);
860 range_delete(&active_config->nmc_range_tree, range);
861 nm_member_reclassify_nodemap(nodemap);
862 up_write(&active_config->nmc_range_tree_lock);
864 nm_member_revoke_locks(active_config->nmc_default_nodemap);
865 nm_member_revoke_locks(nodemap);
868 mutex_unlock(&active_config_lock);
869 nodemap_putref(nodemap);
873 EXPORT_SYMBOL(nodemap_del_range);
876 * set fileset on nodemap
877 * \param name nodemap to set fileset on
878 * \param fileset string containing fileset
879 * \retval 0 on success
881 * set a fileset on the named nodemap
883 static int nodemap_set_fileset_helper(struct nodemap_config *config,
884 struct lu_nodemap *nodemap,
889 /* we allow fileset = "" which means clear fileset info */
890 if (fileset == NULL || (fileset[0] != 0 && fileset[0] != '/'))
892 else if (strlcpy(nodemap->nm_fileset, fileset,
893 sizeof(nodemap->nm_fileset)) >=
894 sizeof(nodemap->nm_fileset))
900 int nodemap_set_fileset(const char *name, const char *fileset)
902 struct lu_nodemap *nodemap = NULL;
905 mutex_lock(&active_config_lock);
906 nodemap = nodemap_lookup(name);
907 if (IS_ERR(nodemap)) {
908 mutex_unlock(&active_config_lock);
909 GOTO(out, rc = PTR_ERR(nodemap));
912 if (is_default_nodemap(nodemap))
915 rc = nodemap_set_fileset_helper(active_config, nodemap,
917 mutex_unlock(&active_config_lock);
919 nodemap_putref(nodemap);
923 EXPORT_SYMBOL(nodemap_set_fileset);
926 * get fileset defined on nodemap
927 * \param nodemap nodemap to get fileset from
928 * \retval fileset name, or NULL if not defined or not activated
930 * get the fileset defined on the nodemap
932 char *nodemap_get_fileset(const struct lu_nodemap *nodemap)
934 if (!nodemap_active || is_default_nodemap(nodemap))
937 return (char *)nodemap->nm_fileset;
939 EXPORT_SYMBOL(nodemap_get_fileset);
942 * Nodemap constructor
944 * Creates an lu_nodemap structure and assigns sane default
945 * member values. If this is the default nodemap, the defaults
946 * are the most restictive in xterms of mapping behavior. Otherwise
947 * the default flags should be inherited from the default nodemap.
948 * The adds nodemap to nodemap_hash.
950 * Requires that the caller take the active_config_lock
952 * \param name name of nodemap
953 * \param is_default true if default nodemap
954 * \retval nodemap success
955 * \retval -EINVAL invalid nodemap name
956 * \retval -EEXIST nodemap already exists
957 * \retval -ENOMEM cannot allocate memory for nodemap
959 struct lu_nodemap *nodemap_create(const char *name,
960 struct nodemap_config *config,
963 struct lu_nodemap *nodemap = NULL;
964 struct lu_nodemap *default_nodemap;
965 struct cfs_hash *hash = config->nmc_nodemap_hash;
968 default_nodemap = config->nmc_default_nodemap;
970 if (!nodemap_name_is_valid(name))
971 GOTO(out, rc = -EINVAL);
974 CERROR("Config nodemap hash is NULL, unable to add %s\n", name);
975 GOTO(out, rc = -EINVAL);
978 OBD_ALLOC_PTR(nodemap);
979 if (nodemap == NULL) {
980 CERROR("cannot allocate memory (%zu bytes)"
981 "for nodemap '%s'\n", sizeof(*nodemap),
983 GOTO(out, rc = -ENOMEM);
987 * take an extra reference to prevent nodemap from being destroyed
988 * while it's being created.
990 atomic_set(&nodemap->nm_refcount, 2);
991 snprintf(nodemap->nm_name, sizeof(nodemap->nm_name), "%s", name);
992 rc = cfs_hash_add_unique(hash, name, &nodemap->nm_hash);
994 OBD_FREE_PTR(nodemap);
995 GOTO(out, rc = -EEXIST);
998 INIT_LIST_HEAD(&nodemap->nm_ranges);
999 INIT_LIST_HEAD(&nodemap->nm_list);
1000 INIT_LIST_HEAD(&nodemap->nm_member_list);
1002 mutex_init(&nodemap->nm_member_list_lock);
1003 rwlock_init(&nodemap->nm_idmap_lock);
1004 nodemap->nm_fs_to_client_uidmap = RB_ROOT;
1005 nodemap->nm_client_to_fs_uidmap = RB_ROOT;
1006 nodemap->nm_fs_to_client_gidmap = RB_ROOT;
1007 nodemap->nm_client_to_fs_gidmap = RB_ROOT;
1010 nodemap->nm_id = LUSTRE_NODEMAP_DEFAULT_ID;
1011 config->nmc_default_nodemap = nodemap;
1013 config->nmc_nodemap_highest_id++;
1014 nodemap->nm_id = config->nmc_nodemap_highest_id;
1017 if (is_default || default_nodemap == NULL) {
1018 nodemap->nmf_trust_client_ids = 0;
1019 nodemap->nmf_allow_root_access = 0;
1020 nodemap->nmf_deny_unknown = 0;
1021 nodemap->nmf_map_uid_only = 0;
1022 nodemap->nmf_map_gid_only = 0;
1024 nodemap->nm_squash_uid = NODEMAP_NOBODY_UID;
1025 nodemap->nm_squash_gid = NODEMAP_NOBODY_GID;
1027 CWARN("adding nodemap '%s' to config without"
1028 " default nodemap\n", nodemap->nm_name);
1030 nodemap->nmf_trust_client_ids =
1031 default_nodemap->nmf_trust_client_ids;
1032 nodemap->nmf_allow_root_access =
1033 default_nodemap->nmf_allow_root_access;
1034 nodemap->nmf_deny_unknown =
1035 default_nodemap->nmf_deny_unknown;
1036 nodemap->nmf_map_uid_only =
1037 default_nodemap->nmf_map_uid_only;
1038 nodemap->nmf_map_gid_only =
1039 default_nodemap->nmf_map_gid_only;
1041 nodemap->nm_squash_uid = default_nodemap->nm_squash_uid;
1042 nodemap->nm_squash_gid = default_nodemap->nm_squash_gid;
1043 nodemap->nm_fileset[0] = 0;
1049 CERROR("cannot add nodemap: '%s': rc = %d\n", name, rc);
1054 * Set the nmf_deny_unknown flag to true or false.
1055 * \param name nodemap name
1056 * \param deny_unknown if true, squashed users will get EACCES
1057 * \retval 0 on success
1060 int nodemap_set_deny_unknown(const char *name, bool deny_unknown)
1062 struct lu_nodemap *nodemap = NULL;
1065 mutex_lock(&active_config_lock);
1066 nodemap = nodemap_lookup(name);
1067 mutex_unlock(&active_config_lock);
1068 if (IS_ERR(nodemap))
1069 GOTO(out, rc = PTR_ERR(nodemap));
1071 nodemap->nmf_deny_unknown = deny_unknown;
1072 rc = nodemap_idx_nodemap_update(nodemap);
1074 nm_member_revoke_locks(nodemap);
1075 nodemap_putref(nodemap);
1079 EXPORT_SYMBOL(nodemap_set_deny_unknown);
1082 * Set the nmf_allow_root_access flag to true or false.
1083 * \param name nodemap name
1084 * \param allow_root if true, nodemap will not squash the root user
1085 * \retval 0 on success
1088 int nodemap_set_allow_root(const char *name, bool allow_root)
1090 struct lu_nodemap *nodemap = NULL;
1093 mutex_lock(&active_config_lock);
1094 nodemap = nodemap_lookup(name);
1095 mutex_unlock(&active_config_lock);
1096 if (IS_ERR(nodemap))
1097 GOTO(out, rc = PTR_ERR(nodemap));
1099 nodemap->nmf_allow_root_access = allow_root;
1100 rc = nodemap_idx_nodemap_update(nodemap);
1102 nm_member_revoke_locks(nodemap);
1103 nodemap_putref(nodemap);
1107 EXPORT_SYMBOL(nodemap_set_allow_root);
1110 * Set the nmf_trust_client_ids flag to true or false.
1112 * \param name nodemap name
1113 * \param trust_client_ids if true, nodemap will not map its IDs
1114 * \retval 0 on success
1117 int nodemap_set_trust_client_ids(const char *name, bool trust_client_ids)
1119 struct lu_nodemap *nodemap = NULL;
1122 mutex_lock(&active_config_lock);
1123 nodemap = nodemap_lookup(name);
1124 mutex_unlock(&active_config_lock);
1125 if (IS_ERR(nodemap))
1126 GOTO(out, rc = PTR_ERR(nodemap));
1128 nodemap->nmf_trust_client_ids = trust_client_ids;
1129 rc = nodemap_idx_nodemap_update(nodemap);
1131 nm_member_revoke_locks(nodemap);
1132 nodemap_putref(nodemap);
1136 EXPORT_SYMBOL(nodemap_set_trust_client_ids);
1138 int nodemap_set_mapping_mode(const char *name, enum nodemap_mapping_modes mode)
1140 struct lu_nodemap *nodemap = NULL;
1143 mutex_lock(&active_config_lock);
1144 nodemap = nodemap_lookup(name);
1145 mutex_unlock(&active_config_lock);
1146 if (IS_ERR(nodemap))
1147 GOTO(out, rc = PTR_ERR(nodemap));
1150 case NODEMAP_MAP_BOTH:
1151 nodemap->nmf_map_uid_only = 0;
1152 nodemap->nmf_map_gid_only = 0;
1154 case NODEMAP_MAP_UID_ONLY:
1155 nodemap->nmf_map_uid_only = 1;
1156 nodemap->nmf_map_gid_only = 0;
1158 case NODEMAP_MAP_GID_ONLY:
1159 nodemap->nmf_map_uid_only = 0;
1160 nodemap->nmf_map_gid_only = 1;
1163 CWARN("cannot set unknown mapping mode, mode = %d\n", mode);
1165 rc = nodemap_idx_nodemap_update(nodemap);
1167 nm_member_revoke_locks(nodemap);
1168 nodemap_putref(nodemap);
1172 EXPORT_SYMBOL(nodemap_set_mapping_mode);
1175 * Update the squash_uid for a nodemap.
1177 * \param name nodemap name
1178 * \param uid the new uid to squash unknown users to
1179 * \retval 0 on success
1181 * Update the squash_uid for a nodemap. The squash_uid is the uid
1182 * that the all client uids are mapped to if nodemap is active,
1183 * the trust_client_ids flag is not set, and the uid is not in
1186 int nodemap_set_squash_uid(const char *name, uid_t uid)
1188 struct lu_nodemap *nodemap = NULL;
1191 mutex_lock(&active_config_lock);
1192 nodemap = nodemap_lookup(name);
1193 mutex_unlock(&active_config_lock);
1194 if (IS_ERR(nodemap))
1195 GOTO(out, rc = PTR_ERR(nodemap));
1197 nodemap->nm_squash_uid = uid;
1198 rc = nodemap_idx_nodemap_update(nodemap);
1200 nm_member_revoke_locks(nodemap);
1201 nodemap_putref(nodemap);
1205 EXPORT_SYMBOL(nodemap_set_squash_uid);
1208 * Update the squash_gid for a nodemap.
1210 * \param name nodemap name
1211 * \param gid the new gid to squash unknown gids to
1212 * \retval 0 on success
1214 * Update the squash_gid for a nodemap. The squash_uid is the gid
1215 * that the all client gids are mapped to if nodemap is active,
1216 * the trust_client_ids flag is not set, and the gid is not in
1219 int nodemap_set_squash_gid(const char *name, gid_t gid)
1221 struct lu_nodemap *nodemap = NULL;
1224 mutex_lock(&active_config_lock);
1225 nodemap = nodemap_lookup(name);
1226 mutex_unlock(&active_config_lock);
1227 if (IS_ERR(nodemap))
1228 GOTO(out, rc = PTR_ERR(nodemap));
1230 nodemap->nm_squash_gid = gid;
1231 rc = nodemap_idx_nodemap_update(nodemap);
1233 nm_member_revoke_locks(nodemap);
1234 nodemap_putref(nodemap);
1238 EXPORT_SYMBOL(nodemap_set_squash_gid);
1241 * Returns true if this nodemap has root user access. Always returns true if
1242 * nodemaps are not active.
1244 * \param nodemap nodemap to check access for
1246 bool nodemap_can_setquota(const struct lu_nodemap *nodemap)
1248 return !nodemap_active || (nodemap && nodemap->nmf_allow_root_access);
1250 EXPORT_SYMBOL(nodemap_can_setquota);
1255 * \param name name of nodemap
1257 * \retval -EINVAL invalid nodemap name
1258 * \retval -EEXIST nodemap already exists
1259 * \retval -ENOMEM cannot allocate memory for nodemap
1261 int nodemap_add(const char *nodemap_name)
1263 struct lu_nodemap *nodemap;
1266 mutex_lock(&active_config_lock);
1267 nodemap = nodemap_create(nodemap_name, active_config, 0);
1268 if (IS_ERR(nodemap)) {
1269 mutex_unlock(&active_config_lock);
1270 return PTR_ERR(nodemap);
1273 rc = nodemap_idx_nodemap_add(nodemap);
1275 rc = lprocfs_nodemap_register(nodemap, 0);
1277 mutex_unlock(&active_config_lock);
1278 nodemap_putref(nodemap);
1282 EXPORT_SYMBOL(nodemap_add);
1287 * \param name name of nodemmap
1289 * \retval -EINVAL invalid input
1290 * \retval -ENOENT no existing nodemap
1292 int nodemap_del(const char *nodemap_name)
1294 struct lu_nodemap *nodemap;
1295 struct lu_nid_range *range;
1296 struct lu_nid_range *range_temp;
1300 if (strcmp(nodemap_name, DEFAULT_NODEMAP) == 0)
1303 mutex_lock(&active_config_lock);
1304 nodemap = cfs_hash_del_key(active_config->nmc_nodemap_hash,
1306 if (nodemap == NULL) {
1307 mutex_unlock(&active_config_lock);
1308 GOTO(out, rc = -ENOENT);
1311 /* erase nodemap from active ranges to prevent client assignment */
1312 down_write(&active_config->nmc_range_tree_lock);
1313 list_for_each_entry_safe(range, range_temp, &nodemap->nm_ranges,
1315 rc2 = nodemap_idx_range_del(range);
1319 range_delete(&active_config->nmc_range_tree, range);
1321 up_write(&active_config->nmc_range_tree_lock);
1323 rc2 = nodemap_idx_nodemap_del(nodemap);
1328 * remove procfs here in case nodemap_create called with same name
1329 * before nodemap_destroy is run.
1331 lprocfs_nodemap_remove(nodemap->nm_pde_data);
1332 nodemap->nm_pde_data = NULL;
1334 /* reclassify all member exports from nodemap, so they put their refs */
1335 down_read(&active_config->nmc_range_tree_lock);
1336 nm_member_reclassify_nodemap(nodemap);
1337 up_read(&active_config->nmc_range_tree_lock);
1339 if (!list_empty(&nodemap->nm_member_list))
1340 CWARN("nodemap_del failed to reclassify all members\n");
1342 mutex_unlock(&active_config_lock);
1344 nodemap_putref(nodemap);
1349 EXPORT_SYMBOL(nodemap_del);
1352 * activate nodemap functions
1354 * \param value 1 for on, 0 for off
1356 void nodemap_activate(const bool value)
1358 mutex_lock(&active_config_lock);
1359 active_config->nmc_nodemap_is_active = value;
1361 /* copy active value to global to avoid locking in map functions */
1362 nodemap_active = value;
1363 nodemap_idx_nodemap_activate(value);
1364 mutex_unlock(&active_config_lock);
1365 nm_member_revoke_all();
1367 EXPORT_SYMBOL(nodemap_activate);
1370 * Helper iterator to convert nodemap hash to list.
1372 * \param hs hash structure
1373 * \param bd bucket descriptor
1374 * \param hnode hash node
1375 * \param nodemap_list_head list head for list of nodemaps in hash
1377 static int nodemap_cleanup_iter_cb(struct cfs_hash *hs, struct cfs_hash_bd *bd,
1378 struct hlist_node *hnode,
1379 void *nodemap_list_head)
1381 struct lu_nodemap *nodemap;
1383 nodemap = hlist_entry(hnode, struct lu_nodemap, nm_hash);
1384 list_add(&nodemap->nm_list, nodemap_list_head);
1386 cfs_hash_bd_del_locked(hs, bd, hnode);
1391 struct nodemap_config *nodemap_config_alloc(void)
1393 struct nodemap_config *config;
1396 OBD_ALLOC_PTR(config);
1398 return ERR_PTR(-ENOMEM);
1400 rc = nodemap_init_hash(config);
1402 OBD_FREE_PTR(config);
1406 init_rwsem(&config->nmc_range_tree_lock);
1410 EXPORT_SYMBOL(nodemap_config_alloc);
1413 * Walk the nodemap_hash and remove all nodemaps.
1415 void nodemap_config_dealloc(struct nodemap_config *config)
1417 struct lu_nodemap *nodemap = NULL;
1418 struct lu_nodemap *nodemap_temp;
1419 struct lu_nid_range *range;
1420 struct lu_nid_range *range_temp;
1421 LIST_HEAD(nodemap_list_head);
1423 cfs_hash_for_each_safe(config->nmc_nodemap_hash,
1424 nodemap_cleanup_iter_cb, &nodemap_list_head);
1425 cfs_hash_putref(config->nmc_nodemap_hash);
1427 /* Because nodemap_destroy might sleep, we can't destroy them
1428 * in cfs_hash_for_each, so we build a list there and destroy here
1430 list_for_each_entry_safe(nodemap, nodemap_temp, &nodemap_list_head,
1432 mutex_lock(&active_config_lock);
1433 down_write(&config->nmc_range_tree_lock);
1435 /* move members to new config, requires ac lock */
1436 nm_member_reclassify_nodemap(nodemap);
1437 list_for_each_entry_safe(range, range_temp, &nodemap->nm_ranges,
1439 range_delete(&config->nmc_range_tree, range);
1440 up_write(&config->nmc_range_tree_lock);
1441 mutex_unlock(&active_config_lock);
1443 /* putref must be outside of ac lock if nm could be destroyed */
1444 nodemap_putref(nodemap);
1446 OBD_FREE_PTR(config);
1448 EXPORT_SYMBOL(nodemap_config_dealloc);
1451 * callback for cfs_hash_for_each_safe used to convert a nodemap hash to a
1452 * nodemap list, generally for locking purposes as a hash cb can't sleep.
1454 int nm_hash_list_cb(struct cfs_hash *hs, struct cfs_hash_bd *bd,
1455 struct hlist_node *hnode,
1456 void *nodemap_list_head)
1458 struct lu_nodemap *nodemap;
1460 nodemap = hlist_entry(hnode, struct lu_nodemap, nm_hash);
1461 list_add(&nodemap->nm_list, nodemap_list_head);
1465 void nodemap_config_set_active(struct nodemap_config *config)
1467 struct nodemap_config *old_config = active_config;
1468 struct lu_nodemap *nodemap;
1469 struct lu_nodemap *tmp;
1471 LIST_HEAD(nodemap_list_head);
1475 LASSERT(active_config != config);
1476 LASSERT(config->nmc_default_nodemap);
1478 mutex_lock(&active_config_lock);
1480 /* move proc entries from already existing nms, create for new nms */
1481 cfs_hash_for_each_safe(config->nmc_nodemap_hash,
1482 nm_hash_list_cb, &nodemap_list_head);
1483 list_for_each_entry_safe(nodemap, tmp, &nodemap_list_head, nm_list) {
1484 struct lu_nodemap *old_nm = NULL;
1486 if (active_config != NULL)
1487 old_nm = cfs_hash_lookup(
1488 active_config->nmc_nodemap_hash,
1490 if (old_nm != NULL) {
1491 nodemap->nm_pde_data = old_nm->nm_pde_data;
1492 old_nm->nm_pde_data = NULL;
1493 nodemap_putref(old_nm);
1495 bool is_def = (nodemap == config->nmc_default_nodemap);
1497 lprocfs_nodemap_register(nodemap, is_def);
1502 * We only need to revoke locks if old nodemap was active, and new
1503 * config is now nodemap inactive. nodemap_config_dealloc will
1504 * reclassify exports, triggering a lock revoke if and only if new
1505 * nodemap is active.
1507 revoke_locks = !config->nmc_nodemap_is_active && nodemap_active;
1509 /* if new config is inactive, deactivate live config before switching */
1510 if (!config->nmc_nodemap_is_active)
1511 nodemap_active = false;
1512 active_config = config;
1513 if (config->nmc_nodemap_is_active)
1514 nodemap_active = true;
1516 mutex_unlock(&active_config_lock);
1518 if (old_config != NULL)
1519 nodemap_config_dealloc(old_config);
1522 nm_member_revoke_all();
1528 * Cleanup nodemap module on exit
1530 void nodemap_mod_exit(void)
1532 nodemap_config_dealloc(active_config);
1533 nodemap_procfs_exit();
1537 * Initialize the nodemap module
1539 int nodemap_mod_init(void)
1541 struct nodemap_config *new_config;
1542 struct lu_nodemap *nodemap;
1545 rc = nodemap_procfs_init();
1549 new_config = nodemap_config_alloc();
1550 if (IS_ERR(new_config)) {
1551 nodemap_procfs_exit();
1552 GOTO(out, rc = PTR_ERR(new_config));
1555 nodemap = nodemap_create(DEFAULT_NODEMAP, new_config, 1);
1556 if (IS_ERR(nodemap)) {
1557 nodemap_config_dealloc(new_config);
1558 nodemap_procfs_exit();
1559 GOTO(out, rc = PTR_ERR(nodemap));
1562 nodemap_config_set_active(new_config);
1563 nodemap_putref(nodemap);
1570 * Revoke locks for all nodemaps.
1572 void nm_member_revoke_all(void)
1574 struct lu_nodemap *nodemap;
1575 struct lu_nodemap *tmp;
1576 LIST_HEAD(nodemap_list_head);
1578 mutex_lock(&active_config_lock);
1579 cfs_hash_for_each_safe(active_config->nmc_nodemap_hash,
1580 nm_hash_list_cb, &nodemap_list_head);
1582 /* revoke_locks sleeps, so can't call in cfs hash cb */
1583 list_for_each_entry_safe(nodemap, tmp, &nodemap_list_head, nm_list)
1584 nm_member_revoke_locks_always(nodemap);
1585 mutex_unlock(&active_config_lock);
1589 * Returns the nodemap classification for a given nid into an ioctl buffer.
1590 * Useful for testing the nodemap configuration to make sure it is working as
1593 * \param nid nid to classify
1594 * \param[out] name_buf buffer to write the nodemap name to
1595 * \param name_len length of buffer
1597 void nodemap_test_nid(lnet_nid_t nid, char *name_buf, size_t name_len)
1599 struct lu_nodemap *nodemap;
1601 mutex_lock(&active_config_lock);
1602 down_read(&active_config->nmc_range_tree_lock);
1603 nodemap = nodemap_classify_nid(nid);
1604 up_read(&active_config->nmc_range_tree_lock);
1605 mutex_unlock(&active_config_lock);
1607 if (IS_ERR(nodemap))
1610 strncpy(name_buf, nodemap->nm_name, name_len);
1612 name_buf[name_len - 1] = '\0';
1614 nodemap_putref(nodemap);
1616 EXPORT_SYMBOL(nodemap_test_nid);
1619 * Passes back the id mapping for a given nid/id pair. Useful for testing the
1620 * nodemap configuration to make sure it is working as expected.
1622 * \param nid nid to classify
1623 * \param idtype uid or gid
1624 * \param client_id id to map to fs
1625 * \param fs_id_buf pointer to save mapped fs_id to
1628 * \retval -EINVAL invalid NID
1630 int nodemap_test_id(lnet_nid_t nid, enum nodemap_id_type idtype,
1631 __u32 client_id, __u32 *fs_id)
1633 struct lu_nodemap *nodemap;
1635 mutex_lock(&active_config_lock);
1636 down_read(&active_config->nmc_range_tree_lock);
1637 nodemap = nodemap_classify_nid(nid);
1638 up_read(&active_config->nmc_range_tree_lock);
1639 mutex_unlock(&active_config_lock);
1641 if (IS_ERR(nodemap))
1642 return PTR_ERR(nodemap);
1644 *fs_id = nodemap_map_id(nodemap, idtype, NODEMAP_CLIENT_TO_FS,
1646 nodemap_putref(nodemap);
1650 EXPORT_SYMBOL(nodemap_test_id);