lustre/ptlrpc/nodemap_handler.c

   1 /*
   2  * GPL HEADER START
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   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.
   9  *
  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).
  15  *
  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
  19  *
  20  * GPL HEADER END
  21  */
  22 /*
  23  * Copyright (C) 2013, Trustees of Indiana University
  24  *
  25  * Copyright (c) 2014, Intel Corporation.
  26  *
  27  * Author: Joshua Walgenbach <jjw@iu.edu>
  28  */
  29 #include <linux/module.h>
  30 #include <linux/sort.h>
  31 #include <uapi/linux/lnet/nidstr.h>
  32 #include <lustre_net.h>
  33 #include <lustre_acl.h>
  34 #include <lustre_eacl.h>
  35 #include <obd_class.h>
  36 #include "nodemap_internal.h"
  37
  38 #define HASH_NODEMAP_BKT_BITS 3
  39 #define HASH_NODEMAP_CUR_BITS 3
  40 #define HASH_NODEMAP_MAX_BITS 7
  41
  42 #define DEFAULT_NODEMAP "default"
  43
  44 /* nodemap proc root proc directory under fs/lustre */
  45 struct proc_dir_entry *proc_lustre_nodemap_root;
  46
  47 /* Copy of config active flag to avoid locking in mapping functions */
  48 bool nodemap_active;
  49
  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.
  53  */
  54 DEFINE_MUTEX(active_config_lock);
  55 struct nodemap_config *active_config;
  56
  57 /**
  58  * Nodemap destructor
  59  *
  60  * \param       nodemap         nodemap to destroy
  61  */
  62 static void nodemap_destroy(struct lu_nodemap *nodemap)
  63 {
  64         ENTRY;
  65
  66         if (nodemap->nm_pde_data != NULL)
  67                 lprocfs_nodemap_remove(nodemap->nm_pde_data);
  68
  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);
  73
  74         write_lock(&nodemap->nm_idmap_lock);
  75         idmap_delete_tree(nodemap);
  76         write_unlock(&nodemap->nm_idmap_lock);
  77
  78         mutex_unlock(&active_config_lock);
  79
  80         if (!list_empty(&nodemap->nm_member_list))
  81                 CWARN("nodemap_destroy failed to reclassify all members\n");
  82
  83         nm_member_delete_list(nodemap);
  84
  85         OBD_FREE_PTR(nodemap);
  86
  87         EXIT;
  88 }
  89
  90 /**
  91  * Functions used for the cfs_hash
  92  */
  93 void nodemap_getref(struct lu_nodemap *nodemap)
  94 {
  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));
  98 }
  99
 100 /**
 101  * Destroy nodemap if last reference is put. Should be called outside
 102  * active_config_lock
 103  */
 104 void nodemap_putref(struct lu_nodemap *nodemap)
 105 {
 106         if (!nodemap)
 107                 return;
 108
 109         LASSERT(atomic_read(&nodemap->nm_refcount) > 0);
 110
 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);
 114
 115         if (atomic_dec_and_test(&nodemap->nm_refcount))
 116                 nodemap_destroy(nodemap);
 117 }
 118 EXPORT_SYMBOL(nodemap_putref);
 119
 120 static __u32 nodemap_hashfn(struct cfs_hash *hash_body,
 121                             const void *key, unsigned mask)
 122 {
 123         return cfs_hash_djb2_hash(key, strlen(key), mask);
 124 }
 125
 126 static void *nodemap_hs_key(struct hlist_node *hnode)
 127 {
 128         struct lu_nodemap *nodemap;
 129
 130         nodemap = hlist_entry(hnode, struct lu_nodemap, nm_hash);
 131
 132         return nodemap->nm_name;
 133 }
 134
 135 static int nodemap_hs_keycmp(const void *key,
 136                              struct hlist_node *compared_hnode)
 137 {
 138         char *nodemap_name;
 139
 140         nodemap_name = nodemap_hs_key(compared_hnode);
 141
 142         return !strcmp(key, nodemap_name);
 143 }
 144
 145 static void *nodemap_hs_hashobject(struct hlist_node *hnode)
 146 {
 147         return hlist_entry(hnode, struct lu_nodemap, nm_hash);
 148 }
 149
 150 static void nodemap_hs_get(struct cfs_hash *hs, struct hlist_node *hnode)
 151 {
 152         struct lu_nodemap *nodemap;
 153
 154         nodemap = hlist_entry(hnode, struct lu_nodemap, nm_hash);
 155         nodemap_getref(nodemap);
 156 }
 157
 158 static void nodemap_hs_put_locked(struct cfs_hash *hs,
 159                                   struct hlist_node *hnode)
 160 {
 161         struct lu_nodemap *nodemap;
 162
 163         nodemap = hlist_entry(hnode, struct lu_nodemap, nm_hash);
 164         nodemap_putref(nodemap);
 165 }
 166
 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,
 174 };
 175
 176 /* end of cfs_hash functions */
 177
 178 /**
 179  * Initialize nodemap_hash
 180  *
 181  * \retval      0               success
 182  * \retval      -ENOMEM         cannot create hash
 183  */
 184 static int nodemap_init_hash(struct nodemap_config *nmc)
 185 {
 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,
 190                                                 CFS_HASH_MIN_THETA,
 191                                                 CFS_HASH_MAX_THETA,
 192                                                 &nodemap_hash_operations,
 193                                                 CFS_HASH_DEFAULT);
 194
 195         if (nmc->nmc_nodemap_hash == NULL) {
 196                 CERROR("cannot create nodemap_hash table\n");
 197                 return -ENOMEM;
 198         }
 199
 200         return 0;
 201 }
 202
 203 /**
 204  * Check for valid nodemap name
 205  *
 206  * \param       name            nodemap name
 207  * \retval      true            valid
 208  * \retval      false           invalid
 209  */
 210 static bool nodemap_name_is_valid(const char *name)
 211 {
 212         if (strlen(name) > LUSTRE_NODEMAP_NAME_LENGTH ||
 213             strlen(name) == 0)
 214                 return false;
 215
 216         for (; *name != '\0'; name++) {
 217                 if (!isalnum(*name) && *name != '_')
 218                         return false;
 219         }
 220
 221         return true;
 222 }
 223
 224 /**
 225  * Nodemap lookup
 226  *
 227  * Look nodemap up in the active_config nodemap hash. Caller should hold the
 228  * active_config_lock.
 229  *
 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
 234  */
 235 struct lu_nodemap *nodemap_lookup(const char *name)
 236 {
 237         struct lu_nodemap *nodemap = NULL;
 238
 239         if (!nodemap_name_is_valid(name))
 240                 return ERR_PTR(-EINVAL);
 241
 242         nodemap = cfs_hash_lookup(active_config->nmc_nodemap_hash, name);
 243         if (nodemap == NULL)
 244                 return ERR_PTR(-ENOENT);
 245
 246         return nodemap;
 247 }
 248
 249 /**
 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.
 252  *
 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
 257  */
 258 struct lu_nodemap *nodemap_classify_nid(lnet_nid_t nid)
 259 {
 260         struct lu_nid_range     *range;
 261         struct lu_nodemap       *nodemap;
 262         int rc;
 263
 264         ENTRY;
 265
 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;
 269                 int i = 0;
 270
 271                 do {
 272                         rc = LNetGetId(i++, &id);
 273                         if (rc < 0)
 274                                 RETURN(ERR_PTR(-EINVAL));
 275                 } while (LNET_NETTYP(LNET_NIDNET(id.nid)) == LOLND);
 276
 277                 nid = id.nid;
 278                 CDEBUG(D_INFO, "found nid %s\n", libcfs_nid2str(nid));
 279         }
 280
 281         range = range_search(&active_config->nmc_range_tree, nid);
 282         if (range != NULL)
 283                 nodemap = range->rn_nodemap;
 284         else
 285                 nodemap = active_config->nmc_default_nodemap;
 286
 287         LASSERT(nodemap != NULL);
 288         nodemap_getref(nodemap);
 289
 290         RETURN(nodemap);
 291 }
 292
 293 /**
 294  * simple check for default nodemap
 295  */
 296 static bool is_default_nodemap(const struct lu_nodemap *nodemap)
 297 {
 298         return nodemap->nm_id == 0;
 299 }
 300
 301 /**
 302  * parse a nodemap range string into two nids
 303  *
 304  * \param       range_str               string to parse
 305  * \param       range[2]                array of two nids
 306  * \reyval      0 on success
 307  */
 308 int nodemap_parse_range(const char *range_str, lnet_nid_t range[2])
 309 {
 310         char    buf[LNET_NIDSTR_SIZE * 2 + 2];
 311         char    *ptr = NULL;
 312         char    *start_nidstr;
 313         char    *end_nidstr;
 314         int     rc = 0;
 315
 316         snprintf(buf, sizeof(buf), "%s", range_str);
 317         ptr = buf;
 318         start_nidstr = strsep(&ptr, ":");
 319         end_nidstr = strsep(&ptr, ":");
 320
 321         if (start_nidstr == NULL || end_nidstr == NULL)
 322                 GOTO(out, rc = -EINVAL);
 323
 324         range[0] = libcfs_str2nid(start_nidstr);
 325         range[1] = libcfs_str2nid(end_nidstr);
 326
 327 out:
 328         return rc;
 329
 330 }
 331 EXPORT_SYMBOL(nodemap_parse_range);
 332
 333 /**
 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
 336  *
 337  * \param       idmap_str               map string
 338  * \param       idmap                   array[2] of __u32
 339  *
 340  * \retval      0 on success
 341  * \retval      -EINVAL if idmap cannot be parsed
 342  */
 343 int nodemap_parse_idmap(char *idmap_str, __u32 idmap[2])
 344 {
 345         char                    *sep;
 346         long unsigned int        idmap_buf;
 347         int                      rc;
 348
 349         if (idmap_str == NULL)
 350                 return -EINVAL;
 351
 352         sep = strchr(idmap_str, ':');
 353         if (sep == NULL)
 354                 return -EINVAL;
 355         *sep = '\0';
 356         sep++;
 357
 358         rc = kstrtoul(idmap_str, 10, &idmap_buf);
 359         if (rc != 0)
 360                 return -EINVAL;
 361         idmap[0] = idmap_buf;
 362
 363         rc = kstrtoul(sep, 10, &idmap_buf);
 364         if (rc != 0)
 365                 return -EINVAL;
 366         idmap[1] = idmap_buf;
 367
 368         return 0;
 369 }
 370 EXPORT_SYMBOL(nodemap_parse_idmap);
 371
 372 /**
 373  * add a member to a nodemap
 374  *
 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
 380  */
 381 int nodemap_add_member(lnet_nid_t nid, struct obd_export *exp)
 382 {
 383         struct lu_nodemap *nodemap;
 384         int rc = 0;
 385         ENTRY;
 386
 387         mutex_lock(&active_config_lock);
 388         down_read(&active_config->nmc_range_tree_lock);
 389
 390         nodemap = nodemap_classify_nid(nid);
 391
 392         if (IS_ERR(nodemap)) {
 393                 CWARN("%s: error adding to nodemap, no valid NIDs found\n",
 394                           exp->exp_obd->obd_name);
 395                 rc = -EINVAL;
 396         } else {
 397                 rc = nm_member_add(nodemap, exp);
 398         }
 399
 400         up_read(&active_config->nmc_range_tree_lock);
 401         mutex_unlock(&active_config_lock);
 402
 403         if (!IS_ERR(nodemap))
 404                 nodemap_putref(nodemap);
 405
 406         RETURN(rc);
 407 }
 408 EXPORT_SYMBOL(nodemap_add_member);
 409
 410 /**
 411  * delete a member from a nodemap
 412  *
 413  * \param       exp             export to remove from a nodemap
 414  */
 415 void nodemap_del_member(struct obd_export *exp)
 416 {
 417         struct lu_nodemap *nodemap;
 418
 419         ENTRY;
 420
 421         /* using ac lock to prevent nodemap reclassification while deleting */
 422         mutex_lock(&active_config_lock);
 423
 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
 426          * active_config_lock
 427          */
 428         nodemap = exp->exp_target_data.ted_nodemap;
 429         if (nodemap == NULL)
 430                 goto out;
 431         else
 432                 nodemap_getref(nodemap);
 433
 434         mutex_lock(&nodemap->nm_member_list_lock);
 435         nm_member_del(nodemap, exp);
 436         mutex_unlock(&nodemap->nm_member_list_lock);
 437
 438 out:
 439         mutex_unlock(&active_config_lock);
 440
 441         if (nodemap)
 442                 nodemap_putref(nodemap);
 443
 444         EXIT;
 445 }
 446 EXPORT_SYMBOL(nodemap_del_member);
 447
 448 /**
 449  * add an idmap to the proper nodemap trees
 450  *
 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
 456  *
 457  * \retval      0 on success
 458  */
 459 int nodemap_add_idmap_helper(struct lu_nodemap *nodemap,
 460                              enum nodemap_id_type id_type,
 461                              const __u32 map[2])
 462 {
 463         struct lu_idmap         *idmap;
 464         int                     rc = 0;
 465
 466         idmap = idmap_create(map[0], map[1]);
 467         if (idmap == NULL)
 468                 GOTO(out, rc = -ENOMEM);
 469
 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);
 474
 475 out:
 476         return rc;
 477 }
 478
 479 int nodemap_add_idmap(const char *name, enum nodemap_id_type id_type,
 480                       const __u32 map[2])
 481 {
 482         struct lu_nodemap       *nodemap = NULL;
 483         int                      rc;
 484
 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));
 490         }
 491
 492         if (is_default_nodemap(nodemap)) {
 493                 rc = -EINVAL;
 494         } else {
 495                 rc = nodemap_add_idmap_helper(nodemap, id_type, map);
 496                 if (rc == 0)
 497                         rc = nodemap_idx_idmap_add(nodemap, id_type, map);
 498         }
 499         mutex_unlock(&active_config_lock);
 500         nodemap_putref(nodemap);
 501
 502 out:
 503         return rc;
 504 }
 505 EXPORT_SYMBOL(nodemap_add_idmap);
 506
 507 /**
 508  * delete idmap from proper nodemap tree
 509  *
 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
 515  *
 516  * \retval      0 on success
 517  */
 518 int nodemap_del_idmap(const char *name, enum nodemap_id_type id_type,
 519                       const __u32 map[2])
 520 {
 521         struct lu_nodemap       *nodemap = NULL;
 522         struct lu_idmap         *idmap = NULL;
 523         int                     rc = 0;
 524
 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));
 530         }
 531
 532         if (is_default_nodemap(nodemap))
 533                 GOTO(out_putref, rc = -EINVAL);
 534
 535         write_lock(&nodemap->nm_idmap_lock);
 536         idmap = idmap_search(nodemap, NODEMAP_CLIENT_TO_FS, id_type,
 537                              map[0]);
 538         if (idmap == NULL) {
 539                 rc = -EINVAL;
 540         } else {
 541                 idmap_delete(id_type, idmap, nodemap);
 542                 rc = nodemap_idx_idmap_del(nodemap, id_type, map);
 543         }
 544         write_unlock(&nodemap->nm_idmap_lock);
 545
 546 out_putref:
 547         mutex_unlock(&active_config_lock);
 548         if (rc == 0)
 549                 nm_member_revoke_locks(nodemap);
 550         nodemap_putref(nodemap);
 551
 552 out:
 553         return rc;
 554 }
 555 EXPORT_SYMBOL(nodemap_del_idmap);
 556
 557 /**
 558  * Get nodemap assigned to given export. Takes a reference on the nodemap.
 559  *
 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.
 567  *
 568  * \param       export          export to get nodemap for
 569  *
 570  * \retval      pointer to nodemap on success
 571  * \retval      NULL    nodemap subsystem disabled
 572  * \retval      -EACCES export does not have nodemap assigned
 573  */
 574 struct lu_nodemap *nodemap_get_from_exp(struct obd_export *exp)
 575 {
 576         struct lu_nodemap *nodemap;
 577
 578         ENTRY;
 579
 580         if (!nodemap_active)
 581                 RETURN(NULL);
 582
 583         spin_lock(&exp->exp_target_data.ted_nodemap_lock);
 584         nodemap = exp->exp_target_data.ted_nodemap;
 585         if (nodemap)
 586                 nodemap_getref(nodemap);
 587         spin_unlock(&exp->exp_target_data.ted_nodemap_lock);
 588
 589         if (!nodemap) {
 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));
 595         }
 596
 597         RETURN(nodemap);
 598 }
 599 EXPORT_SYMBOL(nodemap_get_from_exp);
 600
 601 /**
 602  * mapping function for nodemap idmaps
 603  *
 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
 609  *
 610  * \retval      mapped id according to the rules below.
 611  *
 612  * if the nodemap_active is false, just return the passed id without mapping
 613  *
 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.
 616  *
 617  * if the nodemap is configured to trusted the ids from the client system, just
 618  * return the passwd id without mapping.
 619  *
 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.
 622  *
 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.
 625  */
 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)
 629 {
 630         struct lu_idmap         *idmap = NULL;
 631         __u32                    found_id;
 632
 633         ENTRY;
 634
 635         if (!nodemap_active)
 636                 goto out;
 637
 638         if (unlikely(nodemap == NULL))
 639                 goto out;
 640
 641         if (nodemap->nmf_map_uid_only && id_type == NODEMAP_GID)
 642                 goto out;
 643
 644         if (nodemap->nmf_map_gid_only && id_type == NODEMAP_UID)
 645                 goto out;
 646
 647         if (id == 0) {
 648                 if (nodemap->nmf_allow_root_access)
 649                         goto out;
 650                 else
 651                         goto squash;
 652         }
 653
 654         if (nodemap->nmf_trust_client_ids)
 655                 goto out;
 656
 657         if (is_default_nodemap(nodemap))
 658                 goto squash;
 659
 660         read_lock(&nodemap->nm_idmap_lock);
 661         idmap = idmap_search(nodemap, tree_type, id_type, id);
 662         if (idmap == NULL) {
 663                 read_unlock(&nodemap->nm_idmap_lock);
 664                 goto squash;
 665         }
 666
 667         if (tree_type == NODEMAP_FS_TO_CLIENT)
 668                 found_id = idmap->id_client;
 669         else
 670                 found_id = idmap->id_fs;
 671         read_unlock(&nodemap->nm_idmap_lock);
 672         RETURN(found_id);
 673
 674 squash:
 675         if (id_type == NODEMAP_UID)
 676                 RETURN(nodemap->nm_squash_uid);
 677         else
 678                 RETURN(nodemap->nm_squash_gid);
 679 out:
 680         RETURN(id);
 681 }
 682 EXPORT_SYMBOL(nodemap_map_id);
 683
 684 /**
 685  * Map posix ACL entries according to the nodemap membership. Removes any
 686  * squashed ACLs.
 687  *
 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()
 694  */
 695 ssize_t nodemap_map_acl(struct lu_nodemap *nodemap, void *buf, size_t size,
 696                         enum nodemap_tree_type tree_type)
 697 {
 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;
 702         int                      count;
 703
 704         if (!nodemap_active)
 705                 return size;
 706
 707         if (unlikely(nodemap == NULL))
 708                 return size;
 709
 710         count = posix_acl_xattr_count(size);
 711         if (count < 0)
 712                 return -EINVAL;
 713         if (count == 0)
 714                 return 0;
 715
 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);
 719
 720                 switch (tag) {
 721                 case ACL_USER:
 722                         id = nodemap_map_id(nodemap, NODEMAP_UID,
 723                                             tree_type, id);
 724                         if (id == nodemap->nm_squash_uid)
 725                                 continue;
 726                         entry->e_id = cpu_to_le32(id);
 727                         break;
 728                 case ACL_GROUP:
 729                         id = nodemap_map_id(nodemap, NODEMAP_GID,
 730                                             tree_type, id);
 731                         if (id == nodemap->nm_squash_gid)
 732                                 continue;
 733                         entry->e_id = cpu_to_le32(id);
 734                         break;
 735                 }
 736
 737                 /* if we skip an ACL, copy the following ones over it */
 738                 if (new_entry != entry)
 739                         *new_entry = *entry;
 740
 741                 new_entry++;
 742         }
 743
 744         return (void *)new_entry - (void *)header;
 745 }
 746 EXPORT_SYMBOL(nodemap_map_acl);
 747
 748 /*
 749  * Add nid range to given nodemap
 750  *
 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
 755  * \retval      0               success
 756  * \retval      -ENOMEM
 757  *
 758  */
 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)
 763 {
 764         struct lu_nid_range     *range;
 765         int rc;
 766
 767         down_write(&config->nmc_range_tree_lock);
 768         range = range_create(&config->nmc_range_tree, nid[0], nid[1],
 769                              nodemap, range_id);
 770         if (range == NULL) {
 771                 up_write(&config->nmc_range_tree_lock);
 772                 GOTO(out, rc = -ENOMEM);
 773         }
 774
 775         rc = range_insert(&config->nmc_range_tree, range);
 776         if (rc != 0) {
 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);
 783         }
 784
 785         list_add(&range->rn_list, &nodemap->nm_ranges);
 786
 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);
 790
 791         up_write(&config->nmc_range_tree_lock);
 792
 793         /* if range_id is non-zero, we are loading from disk */
 794         if (range_id == 0)
 795                 rc = nodemap_idx_range_add(range, nid);
 796
 797         if (config == active_config) {
 798                 nm_member_revoke_locks(config->nmc_default_nodemap);
 799                 nm_member_revoke_locks(nodemap);
 800         }
 801
 802 out:
 803         return rc;
 804 }
 805 int nodemap_add_range(const char *name, const lnet_nid_t nid[2])
 806 {
 807         struct lu_nodemap       *nodemap = NULL;
 808         int                      rc;
 809
 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));
 815         }
 816
 817         if (is_default_nodemap(nodemap))
 818                 rc = -EINVAL;
 819         else
 820                 rc = nodemap_add_range_helper(active_config, nodemap, nid, 0);
 821         mutex_unlock(&active_config_lock);
 822         nodemap_putref(nodemap);
 823 out:
 824         return rc;
 825 }
 826 EXPORT_SYMBOL(nodemap_add_range);
 827
 828 /**
 829  * delete a range
 830  * \param       name            nodemap name
 831  * \param       nid             nid range
 832  * \retval      0 on success
 833  *
 834  * Delete range from global range tree, and remove it
 835  * from the list in the associated nodemap.
 836  */
 837 int nodemap_del_range(const char *name, const lnet_nid_t nid[2])
 838 {
 839         struct lu_nodemap       *nodemap;
 840         struct lu_nid_range     *range;
 841         int                     rc = 0;
 842
 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));
 848         }
 849
 850         if (is_default_nodemap(nodemap))
 851                 GOTO(out_putref, rc = -EINVAL);
 852
 853         down_write(&active_config->nmc_range_tree_lock);
 854         range = range_find(&active_config->nmc_range_tree, nid[0], nid[1]);
 855         if (range == NULL) {
 856                 up_write(&active_config->nmc_range_tree_lock);
 857                 GOTO(out_putref, rc = -EINVAL);
 858         }
 859         if (range->rn_nodemap != nodemap) {
 860                 up_write(&active_config->nmc_range_tree_lock);
 861                 GOTO(out_putref, rc = -EINVAL);
 862         }
 863         rc = nodemap_idx_range_del(range);
 864         range_delete(&active_config->nmc_range_tree, range);
 865         nm_member_reclassify_nodemap(nodemap);
 866         up_write(&active_config->nmc_range_tree_lock);
 867
 868         nm_member_revoke_locks(active_config->nmc_default_nodemap);
 869         nm_member_revoke_locks(nodemap);
 870
 871 out_putref:
 872         mutex_unlock(&active_config_lock);
 873         nodemap_putref(nodemap);
 874 out:
 875         return rc;
 876 }
 877 EXPORT_SYMBOL(nodemap_del_range);
 878
 879 /**
 880  * set fileset on nodemap
 881  * \param       name            nodemap to set fileset on
 882  * \param       fileset         string containing fileset
 883  * \retval      0 on success
 884  *
 885  * set a fileset on the named nodemap
 886  */
 887 static int nodemap_set_fileset_helper(struct nodemap_config *config,
 888                                       struct lu_nodemap *nodemap,
 889                                       const char *fileset)
 890 {
 891         int rc = 0;
 892
 893         /* we allow fileset = "" which means clear fileset info */
 894         if (fileset == NULL || (fileset[0] != 0 && fileset[0] != '/'))
 895                 rc = -EINVAL;
 896         else if (strlcpy(nodemap->nm_fileset, fileset,
 897                          sizeof(nodemap->nm_fileset)) >=
 898                  sizeof(nodemap->nm_fileset))
 899                 rc = -ENAMETOOLONG;
 900
 901         return rc;
 902 }
 903
 904 int nodemap_set_fileset(const char *name, const char *fileset)
 905 {
 906         struct lu_nodemap       *nodemap = NULL;
 907         int                      rc = 0;
 908
 909         mutex_lock(&active_config_lock);
 910         nodemap = nodemap_lookup(name);
 911         if (IS_ERR(nodemap)) {
 912                 mutex_unlock(&active_config_lock);
 913                 GOTO(out, rc = PTR_ERR(nodemap));
 914         }
 915
 916         if (is_default_nodemap(nodemap))
 917                 rc = -EINVAL;
 918         else
 919                 rc = nodemap_set_fileset_helper(active_config, nodemap,
 920                                                 fileset);
 921         mutex_unlock(&active_config_lock);
 922
 923         nodemap_putref(nodemap);
 924 out:
 925         return rc;
 926 }
 927 EXPORT_SYMBOL(nodemap_set_fileset);
 928
 929 /**
 930  * get fileset defined on nodemap
 931  * \param       nodemap         nodemap to get fileset from
 932  * \retval      fileset name, or NULL if not defined or not activated
 933  *
 934  * get the fileset defined on the nodemap
 935  */
 936 char *nodemap_get_fileset(const struct lu_nodemap *nodemap)
 937 {
 938         if (!nodemap_active || is_default_nodemap(nodemap))
 939                 return NULL;
 940         else
 941                 return (char *)nodemap->nm_fileset;
 942 }
 943 EXPORT_SYMBOL(nodemap_get_fileset);
 944
 945 /**
 946  * Nodemap constructor
 947  *
 948  * Creates an lu_nodemap structure and assigns sane default
 949  * member values. If this is the default nodemap, the defaults
 950  * are the most restictive in xterms of mapping behavior. Otherwise
 951  * the default flags should be inherited from the default nodemap.
 952  * The adds nodemap to nodemap_hash.
 953  *
 954  * Requires that the caller take the active_config_lock
 955  *
 956  * \param       name            name of nodemap
 957  * \param       is_default      true if default nodemap
 958  * \retval      nodemap         success
 959  * \retval      -EINVAL         invalid nodemap name
 960  * \retval      -EEXIST         nodemap already exists
 961  * \retval      -ENOMEM         cannot allocate memory for nodemap
 962  */
 963 struct lu_nodemap *nodemap_create(const char *name,
 964                                   struct nodemap_config *config,
 965                                   bool is_default)
 966 {
 967         struct lu_nodemap       *nodemap = NULL;
 968         struct lu_nodemap       *default_nodemap;
 969         struct cfs_hash         *hash = config->nmc_nodemap_hash;
 970         int                      rc = 0;
 971
 972         default_nodemap = config->nmc_default_nodemap;
 973
 974         if (!nodemap_name_is_valid(name))
 975                 GOTO(out, rc = -EINVAL);
 976
 977         if (hash == NULL) {
 978                 CERROR("Config nodemap hash is NULL, unable to add %s\n", name);
 979                 GOTO(out, rc = -EINVAL);
 980         }
 981
 982         OBD_ALLOC_PTR(nodemap);
 983         if (nodemap == NULL) {
 984                 CERROR("cannot allocate memory (%zu bytes)"
 985                        "for nodemap '%s'\n", sizeof(*nodemap),
 986                        name);
 987                 GOTO(out, rc = -ENOMEM);
 988         }
 989
 990         /*
 991          * take an extra reference to prevent nodemap from being destroyed
 992          * while it's being created.
 993          */
 994         atomic_set(&nodemap->nm_refcount, 2);
 995         snprintf(nodemap->nm_name, sizeof(nodemap->nm_name), "%s", name);
 996         rc = cfs_hash_add_unique(hash, name, &nodemap->nm_hash);
 997         if (rc != 0) {
 998                 OBD_FREE_PTR(nodemap);
 999                 GOTO(out, rc = -EEXIST);
1000         }
1001
1002         INIT_LIST_HEAD(&nodemap->nm_ranges);
1003         INIT_LIST_HEAD(&nodemap->nm_list);
1004         INIT_LIST_HEAD(&nodemap->nm_member_list);
1005
1006         mutex_init(&nodemap->nm_member_list_lock);
1007         rwlock_init(&nodemap->nm_idmap_lock);
1008         nodemap->nm_fs_to_client_uidmap = RB_ROOT;
1009         nodemap->nm_client_to_fs_uidmap = RB_ROOT;
1010         nodemap->nm_fs_to_client_gidmap = RB_ROOT;
1011         nodemap->nm_client_to_fs_gidmap = RB_ROOT;
1012
1013         if (is_default) {
1014                 nodemap->nm_id = LUSTRE_NODEMAP_DEFAULT_ID;
1015                 config->nmc_default_nodemap = nodemap;
1016         } else {
1017                 config->nmc_nodemap_highest_id++;
1018                 nodemap->nm_id = config->nmc_nodemap_highest_id;
1019         }
1020
1021         if (is_default || default_nodemap == NULL) {
1022                 nodemap->nmf_trust_client_ids = 0;
1023                 nodemap->nmf_allow_root_access = 0;
1024                 nodemap->nmf_deny_unknown = 0;
1025                 nodemap->nmf_map_uid_only = 0;
1026                 nodemap->nmf_map_gid_only = 0;
1027
1028                 nodemap->nm_squash_uid = NODEMAP_NOBODY_UID;
1029                 nodemap->nm_squash_gid = NODEMAP_NOBODY_GID;
1030                 if (!is_default)
1031                         CWARN("adding nodemap '%s' to config without"
1032                               " default nodemap\n", nodemap->nm_name);
1033         } else {
1034                 nodemap->nmf_trust_client_ids =
1035                                 default_nodemap->nmf_trust_client_ids;
1036                 nodemap->nmf_allow_root_access =
1037                                 default_nodemap->nmf_allow_root_access;
1038                 nodemap->nmf_deny_unknown =
1039                                 default_nodemap->nmf_deny_unknown;
1040                 nodemap->nmf_map_uid_only =
1041                                 default_nodemap->nmf_map_uid_only;
1042                 nodemap->nmf_map_gid_only =
1043                                 default_nodemap->nmf_map_gid_only;
1044
1045                 nodemap->nm_squash_uid = default_nodemap->nm_squash_uid;
1046                 nodemap->nm_squash_gid = default_nodemap->nm_squash_gid;
1047                 nodemap->nm_fileset[0] = 0;
1048         }
1049
1050         return nodemap;
1051
1052 out:
1053         CERROR("cannot add nodemap: '%s': rc = %d\n", name, rc);
1054         return ERR_PTR(rc);
1055 }
1056
1057 /**
1058  * Set the nmf_deny_unknown flag to true or false.
1059  * \param       name            nodemap name
1060  * \param       deny_unknown    if true, squashed users will get EACCES
1061  * \retval      0 on success
1062  *
1063  */
1064 int nodemap_set_deny_unknown(const char *name, bool deny_unknown)
1065 {
1066         struct lu_nodemap       *nodemap = NULL;
1067         int                     rc = 0;
1068
1069         mutex_lock(&active_config_lock);
1070         nodemap = nodemap_lookup(name);
1071         mutex_unlock(&active_config_lock);
1072         if (IS_ERR(nodemap))
1073                 GOTO(out, rc = PTR_ERR(nodemap));
1074
1075         nodemap->nmf_deny_unknown = deny_unknown;
1076         rc = nodemap_idx_nodemap_update(nodemap);
1077
1078         nm_member_revoke_locks(nodemap);
1079         nodemap_putref(nodemap);
1080 out:
1081         return rc;
1082 }
1083 EXPORT_SYMBOL(nodemap_set_deny_unknown);
1084
1085 /**
1086  * Set the nmf_allow_root_access flag to true or false.
1087  * \param       name            nodemap name
1088  * \param       allow_root      if true, nodemap will not squash the root user
1089  * \retval      0 on success
1090  *
1091  */
1092 int nodemap_set_allow_root(const char *name, bool allow_root)
1093 {
1094         struct lu_nodemap       *nodemap = NULL;
1095         int                     rc = 0;
1096
1097         mutex_lock(&active_config_lock);
1098         nodemap = nodemap_lookup(name);
1099         mutex_unlock(&active_config_lock);
1100         if (IS_ERR(nodemap))
1101                 GOTO(out, rc = PTR_ERR(nodemap));
1102
1103         nodemap->nmf_allow_root_access = allow_root;
1104         rc = nodemap_idx_nodemap_update(nodemap);
1105
1106         nm_member_revoke_locks(nodemap);
1107         nodemap_putref(nodemap);
1108 out:
1109         return rc;
1110 }
1111 EXPORT_SYMBOL(nodemap_set_allow_root);
1112
1113 /**
1114  * Set the nmf_trust_client_ids flag to true or false.
1115  *
1116  * \param       name                    nodemap name
1117  * \param       trust_client_ids        if true, nodemap will not map its IDs
1118  * \retval      0 on success
1119  *
1120  */
1121 int nodemap_set_trust_client_ids(const char *name, bool trust_client_ids)
1122 {
1123         struct lu_nodemap       *nodemap = NULL;
1124         int                     rc = 0;
1125
1126         mutex_lock(&active_config_lock);
1127         nodemap = nodemap_lookup(name);
1128         mutex_unlock(&active_config_lock);
1129         if (IS_ERR(nodemap))
1130                 GOTO(out, rc = PTR_ERR(nodemap));
1131
1132         nodemap->nmf_trust_client_ids = trust_client_ids;
1133         rc = nodemap_idx_nodemap_update(nodemap);
1134
1135         nm_member_revoke_locks(nodemap);
1136         nodemap_putref(nodemap);
1137 out:
1138         return rc;
1139 }
1140 EXPORT_SYMBOL(nodemap_set_trust_client_ids);
1141
1142 int nodemap_set_mapping_mode(const char *name, enum nodemap_mapping_modes mode)
1143 {
1144         struct lu_nodemap       *nodemap = NULL;
1145         int                     rc = 0;
1146
1147         mutex_lock(&active_config_lock);
1148         nodemap = nodemap_lookup(name);
1149         mutex_unlock(&active_config_lock);
1150         if (IS_ERR(nodemap))
1151                 GOTO(out, rc = PTR_ERR(nodemap));
1152
1153         switch (mode) {
1154         case NODEMAP_MAP_BOTH:
1155                 nodemap->nmf_map_uid_only = 0;
1156                 nodemap->nmf_map_gid_only = 0;
1157                 break;
1158         case NODEMAP_MAP_UID_ONLY:
1159                 nodemap->nmf_map_uid_only = 1;
1160                 nodemap->nmf_map_gid_only = 0;
1161                 break;
1162         case NODEMAP_MAP_GID_ONLY:
1163                 nodemap->nmf_map_uid_only = 0;
1164                 nodemap->nmf_map_gid_only = 1;
1165                 break;
1166         default:
1167                 CWARN("cannot set unknown mapping mode, mode = %d\n", mode);
1168         }
1169         rc = nodemap_idx_nodemap_update(nodemap);
1170
1171         nm_member_revoke_locks(nodemap);
1172         nodemap_putref(nodemap);
1173 out:
1174         return rc;
1175 }
1176 EXPORT_SYMBOL(nodemap_set_mapping_mode);
1177
1178 /**
1179  * Update the squash_uid for a nodemap.
1180  *
1181  * \param       name            nodemap name
1182  * \param       uid             the new uid to squash unknown users to
1183  * \retval      0 on success
1184  *
1185  * Update the squash_uid for a nodemap. The squash_uid is the uid
1186  * that the all client uids are mapped to if nodemap is active,
1187  * the trust_client_ids flag is not set, and the uid is not in
1188  * the idmap tree.
1189  */
1190 int nodemap_set_squash_uid(const char *name, uid_t uid)
1191 {
1192         struct lu_nodemap       *nodemap = NULL;
1193         int                     rc = 0;
1194
1195         mutex_lock(&active_config_lock);
1196         nodemap = nodemap_lookup(name);
1197         mutex_unlock(&active_config_lock);
1198         if (IS_ERR(nodemap))
1199                 GOTO(out, rc = PTR_ERR(nodemap));
1200
1201         nodemap->nm_squash_uid = uid;
1202         rc = nodemap_idx_nodemap_update(nodemap);
1203
1204         nm_member_revoke_locks(nodemap);
1205         nodemap_putref(nodemap);
1206 out:
1207         return rc;
1208 }
1209 EXPORT_SYMBOL(nodemap_set_squash_uid);
1210
1211 /**
1212  * Update the squash_gid for a nodemap.
1213  *
1214  * \param       name            nodemap name
1215  * \param       gid             the new gid to squash unknown gids to
1216  * \retval      0 on success
1217  *
1218  * Update the squash_gid for a nodemap. The squash_uid is the gid
1219  * that the all client gids are mapped to if nodemap is active,
1220  * the trust_client_ids flag is not set, and the gid is not in
1221  * the idmap tree.
1222  */
1223 int nodemap_set_squash_gid(const char *name, gid_t gid)
1224 {
1225         struct lu_nodemap       *nodemap = NULL;
1226         int                     rc = 0;
1227
1228         mutex_lock(&active_config_lock);
1229         nodemap = nodemap_lookup(name);
1230         mutex_unlock(&active_config_lock);
1231         if (IS_ERR(nodemap))
1232                 GOTO(out, rc = PTR_ERR(nodemap));
1233
1234         nodemap->nm_squash_gid = gid;
1235         rc = nodemap_idx_nodemap_update(nodemap);
1236
1237         nm_member_revoke_locks(nodemap);
1238         nodemap_putref(nodemap);
1239 out:
1240         return rc;
1241 }
1242 EXPORT_SYMBOL(nodemap_set_squash_gid);
1243
1244 /**
1245  * Returns true if this nodemap has root user access. Always returns true if
1246  * nodemaps are not active.
1247  *
1248  * \param       nodemap         nodemap to check access for
1249  */
1250 bool nodemap_can_setquota(const struct lu_nodemap *nodemap)
1251 {
1252         return !nodemap_active || (nodemap && nodemap->nmf_allow_root_access);
1253 }
1254 EXPORT_SYMBOL(nodemap_can_setquota);
1255
1256 /**
1257  * Add a nodemap
1258  *
1259  * \param       name            name of nodemap
1260  * \retval      0               success
1261  * \retval      -EINVAL         invalid nodemap name
1262  * \retval      -EEXIST         nodemap already exists
1263  * \retval      -ENOMEM         cannot allocate memory for nodemap
1264  */
1265 int nodemap_add(const char *nodemap_name)
1266 {
1267         struct lu_nodemap *nodemap;
1268         int rc;
1269
1270         mutex_lock(&active_config_lock);
1271         nodemap = nodemap_create(nodemap_name, active_config, 0);
1272         if (IS_ERR(nodemap)) {
1273                 mutex_unlock(&active_config_lock);
1274                 return PTR_ERR(nodemap);
1275         }
1276
1277         rc = nodemap_idx_nodemap_add(nodemap);
1278         if (rc == 0)
1279                 rc = lprocfs_nodemap_register(nodemap, 0);
1280
1281         mutex_unlock(&active_config_lock);
1282         nodemap_putref(nodemap);
1283
1284         return rc;
1285 }
1286 EXPORT_SYMBOL(nodemap_add);
1287
1288 /**
1289  * Delete a nodemap
1290  *
1291  * \param       name            name of nodemmap
1292  * \retval      0               success
1293  * \retval      -EINVAL         invalid input
1294  * \retval      -ENOENT         no existing nodemap
1295  */
1296 int nodemap_del(const char *nodemap_name)
1297 {
1298         struct lu_nodemap       *nodemap;
1299         struct lu_nid_range     *range;
1300         struct lu_nid_range     *range_temp;
1301         int                      rc = 0;
1302         int                      rc2 = 0;
1303
1304         if (strcmp(nodemap_name, DEFAULT_NODEMAP) == 0)
1305                 RETURN(-EINVAL);
1306
1307         mutex_lock(&active_config_lock);
1308         nodemap = cfs_hash_del_key(active_config->nmc_nodemap_hash,
1309                                    nodemap_name);
1310         if (nodemap == NULL) {
1311                 mutex_unlock(&active_config_lock);
1312                 GOTO(out, rc = -ENOENT);
1313         }
1314
1315         /* erase nodemap from active ranges to prevent client assignment */
1316         down_write(&active_config->nmc_range_tree_lock);
1317         list_for_each_entry_safe(range, range_temp, &nodemap->nm_ranges,
1318                                  rn_list) {
1319                 rc2 = nodemap_idx_range_del(range);
1320                 if (rc2 < 0)
1321                         rc = rc2;
1322
1323                 range_delete(&active_config->nmc_range_tree, range);
1324         }
1325         up_write(&active_config->nmc_range_tree_lock);
1326
1327         rc2 = nodemap_idx_nodemap_del(nodemap);
1328         if (rc2 < 0)
1329                 rc = rc2;
1330
1331         /*
1332          * remove procfs here in case nodemap_create called with same name
1333          * before nodemap_destroy is run.
1334          */
1335         lprocfs_nodemap_remove(nodemap->nm_pde_data);
1336         nodemap->nm_pde_data = NULL;
1337
1338         /* reclassify all member exports from nodemap, so they put their refs */
1339         down_read(&active_config->nmc_range_tree_lock);
1340         nm_member_reclassify_nodemap(nodemap);
1341         up_read(&active_config->nmc_range_tree_lock);
1342
1343         if (!list_empty(&nodemap->nm_member_list))
1344                 CWARN("nodemap_del failed to reclassify all members\n");
1345
1346         mutex_unlock(&active_config_lock);
1347
1348         nodemap_putref(nodemap);
1349
1350 out:
1351         return rc;
1352 }
1353 EXPORT_SYMBOL(nodemap_del);
1354
1355 /**
1356  * activate nodemap functions
1357  *
1358  * \param       value           1 for on, 0 for off
1359  */
1360 void nodemap_activate(const bool value)
1361 {
1362         mutex_lock(&active_config_lock);
1363         active_config->nmc_nodemap_is_active = value;
1364
1365         /* copy active value to global to avoid locking in map functions */
1366         nodemap_active = value;
1367         nodemap_idx_nodemap_activate(value);
1368         mutex_unlock(&active_config_lock);
1369         nm_member_revoke_all();
1370 }
1371 EXPORT_SYMBOL(nodemap_activate);
1372
1373 /**
1374  * Helper iterator to convert nodemap hash to list.
1375  *
1376  * \param       hs                      hash structure
1377  * \param       bd                      bucket descriptor
1378  * \param       hnode                   hash node
1379  * \param       nodemap_list_head       list head for list of nodemaps in hash
1380  */
1381 static int nodemap_cleanup_iter_cb(struct cfs_hash *hs, struct cfs_hash_bd *bd,
1382                                    struct hlist_node *hnode,
1383                                    void *nodemap_list_head)
1384 {
1385         struct lu_nodemap *nodemap;
1386
1387         nodemap = hlist_entry(hnode, struct lu_nodemap, nm_hash);
1388         list_add(&nodemap->nm_list, nodemap_list_head);
1389
1390         cfs_hash_bd_del_locked(hs, bd, hnode);
1391
1392         return 0;
1393 }
1394
1395 struct nodemap_config *nodemap_config_alloc(void)
1396 {
1397         struct nodemap_config *config;
1398         int rc = 0;
1399
1400         OBD_ALLOC_PTR(config);
1401         if (config == NULL)
1402                 return ERR_PTR(-ENOMEM);
1403
1404         rc = nodemap_init_hash(config);
1405         if (rc != 0) {
1406                 OBD_FREE_PTR(config);
1407                 return ERR_PTR(rc);
1408         }
1409
1410         init_rwsem(&config->nmc_range_tree_lock);
1411
1412         return config;
1413 }
1414 EXPORT_SYMBOL(nodemap_config_alloc);
1415
1416 /**
1417  * Walk the nodemap_hash and remove all nodemaps.
1418  */
1419 void nodemap_config_dealloc(struct nodemap_config *config)
1420 {
1421         struct lu_nodemap       *nodemap = NULL;
1422         struct lu_nodemap       *nodemap_temp;
1423         struct lu_nid_range     *range;
1424         struct lu_nid_range     *range_temp;
1425         LIST_HEAD(nodemap_list_head);
1426
1427         cfs_hash_for_each_safe(config->nmc_nodemap_hash,
1428                                nodemap_cleanup_iter_cb, &nodemap_list_head);
1429         cfs_hash_putref(config->nmc_nodemap_hash);
1430
1431         /* Because nodemap_destroy might sleep, we can't destroy them
1432          * in cfs_hash_for_each, so we build a list there and destroy here
1433          */
1434         list_for_each_entry_safe(nodemap, nodemap_temp, &nodemap_list_head,
1435                                  nm_list) {
1436                 mutex_lock(&active_config_lock);
1437                 down_write(&config->nmc_range_tree_lock);
1438
1439                 /* move members to new config, requires ac lock */
1440                 nm_member_reclassify_nodemap(nodemap);
1441                 list_for_each_entry_safe(range, range_temp, &nodemap->nm_ranges,
1442                                          rn_list)
1443                         range_delete(&config->nmc_range_tree, range);
1444                 up_write(&config->nmc_range_tree_lock);
1445                 mutex_unlock(&active_config_lock);
1446
1447                 /* putref must be outside of ac lock if nm could be destroyed */
1448                 nodemap_putref(nodemap);
1449         }
1450         OBD_FREE_PTR(config);
1451 }
1452 EXPORT_SYMBOL(nodemap_config_dealloc);
1453
1454 /*
1455  * callback for cfs_hash_for_each_safe used to convert a nodemap hash to a
1456  * nodemap list, generally for locking purposes as a hash cb can't sleep.
1457  */
1458 int nm_hash_list_cb(struct cfs_hash *hs, struct cfs_hash_bd *bd,
1459                     struct hlist_node *hnode,
1460                     void *nodemap_list_head)
1461 {
1462         struct lu_nodemap *nodemap;
1463
1464         nodemap = hlist_entry(hnode, struct lu_nodemap, nm_hash);
1465         list_add(&nodemap->nm_list, nodemap_list_head);
1466         return 0;
1467 }
1468
1469 void nodemap_config_set_active(struct nodemap_config *config)
1470 {
1471         struct nodemap_config   *old_config = active_config;
1472         struct lu_nodemap       *nodemap;
1473         struct lu_nodemap       *tmp;
1474         bool revoke_locks;
1475         LIST_HEAD(nodemap_list_head);
1476
1477         ENTRY;
1478
1479         LASSERT(active_config != config);
1480         LASSERT(config->nmc_default_nodemap);
1481
1482         mutex_lock(&active_config_lock);
1483
1484         /* move proc entries from already existing nms, create for new nms */
1485         cfs_hash_for_each_safe(config->nmc_nodemap_hash,
1486                                nm_hash_list_cb, &nodemap_list_head);
1487         list_for_each_entry_safe(nodemap, tmp, &nodemap_list_head, nm_list) {
1488                 struct lu_nodemap *old_nm = NULL;
1489
1490                 if (active_config != NULL)
1491                         old_nm = cfs_hash_lookup(
1492                                         active_config->nmc_nodemap_hash,
1493                                         nodemap->nm_name);
1494                 if (old_nm != NULL) {
1495                         nodemap->nm_pde_data = old_nm->nm_pde_data;
1496                         old_nm->nm_pde_data = NULL;
1497                         nodemap_putref(old_nm);
1498                 } else {
1499                         bool is_def = (nodemap == config->nmc_default_nodemap);
1500
1501                         lprocfs_nodemap_register(nodemap, is_def);
1502                 }
1503         }
1504
1505         /*
1506          * We only need to revoke locks if old nodemap was active, and new
1507          * config is now nodemap inactive. nodemap_config_dealloc will
1508          * reclassify exports, triggering a lock revoke if and only if new
1509          * nodemap is active.
1510          */
1511         revoke_locks = !config->nmc_nodemap_is_active && nodemap_active;
1512
1513         /* if new config is inactive, deactivate live config before switching */
1514         if (!config->nmc_nodemap_is_active)
1515                 nodemap_active = false;
1516         active_config = config;
1517         if (config->nmc_nodemap_is_active)
1518                 nodemap_active = true;
1519
1520         mutex_unlock(&active_config_lock);
1521
1522         if (old_config != NULL)
1523                 nodemap_config_dealloc(old_config);
1524
1525         if (revoke_locks)
1526                 nm_member_revoke_all();
1527
1528         EXIT;
1529 }
1530
1531 /**
1532  * Cleanup nodemap module on exit
1533  */
1534 void nodemap_mod_exit(void)
1535 {
1536         nodemap_config_dealloc(active_config);
1537         nodemap_procfs_exit();
1538 }
1539
1540 /**
1541  * Initialize the nodemap module
1542  */
1543 int nodemap_mod_init(void)
1544 {
1545         struct nodemap_config   *new_config;
1546         struct lu_nodemap       *nodemap;
1547         int                      rc = 0;
1548
1549         rc = nodemap_procfs_init();
1550         if (rc != 0)
1551                 return rc;
1552
1553         new_config = nodemap_config_alloc();
1554         if (IS_ERR(new_config)) {
1555                 nodemap_procfs_exit();
1556                 GOTO(out, rc = PTR_ERR(new_config));
1557         }
1558
1559         nodemap = nodemap_create(DEFAULT_NODEMAP, new_config, 1);
1560         if (IS_ERR(nodemap)) {
1561                 nodemap_config_dealloc(new_config);
1562                 nodemap_procfs_exit();
1563                 GOTO(out, rc = PTR_ERR(nodemap));
1564         }
1565
1566         nodemap_config_set_active(new_config);
1567         nodemap_putref(nodemap);
1568
1569 out:
1570         return rc;
1571 }
1572
1573 /**
1574  * Revoke locks for all nodemaps.
1575  */
1576 void nm_member_revoke_all(void)
1577 {
1578         struct lu_nodemap *nodemap;
1579         struct lu_nodemap *tmp;
1580         LIST_HEAD(nodemap_list_head);
1581
1582         mutex_lock(&active_config_lock);
1583         cfs_hash_for_each_safe(active_config->nmc_nodemap_hash,
1584                                nm_hash_list_cb, &nodemap_list_head);
1585
1586         /* revoke_locks sleeps, so can't call in cfs hash cb */
1587         list_for_each_entry_safe(nodemap, tmp, &nodemap_list_head, nm_list)
1588                 nm_member_revoke_locks_always(nodemap);
1589         mutex_unlock(&active_config_lock);
1590 }
1591
1592 /**
1593  * Returns the nodemap classification for a given nid into an ioctl buffer.
1594  * Useful for testing the nodemap configuration to make sure it is working as
1595  * expected.
1596  *
1597  * \param       nid             nid to classify
1598  * \param[out]  name_buf        buffer to write the nodemap name to
1599  * \param       name_len        length of buffer
1600  */
1601 void nodemap_test_nid(lnet_nid_t nid, char *name_buf, size_t name_len)
1602 {
1603         struct lu_nodemap       *nodemap;
1604
1605         mutex_lock(&active_config_lock);
1606         down_read(&active_config->nmc_range_tree_lock);
1607         nodemap = nodemap_classify_nid(nid);
1608         up_read(&active_config->nmc_range_tree_lock);
1609         mutex_unlock(&active_config_lock);
1610
1611         if (IS_ERR(nodemap))
1612                 return;
1613
1614         strncpy(name_buf, nodemap->nm_name, name_len);
1615         if (name_len > 0)
1616                 name_buf[name_len - 1] = '\0';
1617
1618         nodemap_putref(nodemap);
1619 }
1620 EXPORT_SYMBOL(nodemap_test_nid);
1621
1622 /**
1623  * Passes back the id mapping for a given nid/id pair. Useful for testing the
1624  * nodemap configuration to make sure it is working as expected.
1625  *
1626  * \param       nid             nid to classify
1627  * \param       idtype          uid or gid
1628  * \param       client_id       id to map to fs
1629  * \param       fs_id_buf       pointer to save mapped fs_id to
1630  *
1631  * \retval      0       success
1632  * \retval      -EINVAL invalid NID
1633  */
1634 int nodemap_test_id(lnet_nid_t nid, enum nodemap_id_type idtype,
1635                     __u32 client_id, __u32 *fs_id)
1636 {
1637         struct lu_nodemap       *nodemap;
1638
1639         mutex_lock(&active_config_lock);
1640         down_read(&active_config->nmc_range_tree_lock);
1641         nodemap = nodemap_classify_nid(nid);
1642         up_read(&active_config->nmc_range_tree_lock);
1643         mutex_unlock(&active_config_lock);
1644
1645         if (IS_ERR(nodemap))
1646                 return PTR_ERR(nodemap);
1647
1648         *fs_id = nodemap_map_id(nodemap, idtype, NODEMAP_CLIENT_TO_FS,
1649                                client_id);
1650         nodemap_putref(nodemap);
1651
1652         return 0;
1653 }
1654 EXPORT_SYMBOL(nodemap_test_id);