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) 2017, 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         down_write(&nodemap->nm_idmap_lock);
  75         idmap_delete_tree(nodemap);
  76         up_write(&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 (nid == LNET_NID_LO_0) {
 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 (id.nid == LNET_NID_LO_0);
 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       nodemap         nodemap to add idmap to
 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  * \retval      < 0     if error occurs
 459  */
 460 int nodemap_add_idmap_helper(struct lu_nodemap *nodemap,
 461                              enum nodemap_id_type id_type,
 462                              const __u32 map[2])
 463 {
 464         struct lu_idmap         *idmap;
 465         struct lu_idmap         *temp;
 466         int                     rc = 0;
 467
 468         idmap = idmap_create(map[0], map[1]);
 469         if (idmap == NULL)
 470                 GOTO(out, rc = -ENOMEM);
 471
 472         down_write(&nodemap->nm_idmap_lock);
 473         temp = idmap_insert(id_type, idmap, nodemap);
 474         /* If the new id_client or id_fs is matched, the old idmap and its
 475          * index should be deleted according to its id_client before the new
 476          * idmap is added again.
 477          */
 478         if (IS_ERR(temp))
 479                 GOTO(out_insert, rc = PTR_ERR(temp));
 480         if (temp) {
 481                 __u32 del_map[2];
 482
 483                 del_map[0] = temp->id_client;
 484                 idmap_delete(id_type, temp, nodemap);
 485                 rc = nodemap_idx_idmap_del(nodemap, id_type, del_map);
 486                 /* In case there is any corrupted idmap */
 487                 if (!rc || unlikely(rc == -ENOENT)) {
 488                         temp = idmap_insert(id_type, idmap, nodemap);
 489                         if (IS_ERR(temp))
 490                                 rc = PTR_ERR(temp);
 491                         else if (!temp)
 492                                 rc = 0;
 493                         else
 494                                 rc = -EPERM;
 495                 }
 496         }
 497 out_insert:
 498         if (rc)
 499                 OBD_FREE_PTR(idmap);
 500         up_write(&nodemap->nm_idmap_lock);
 501         nm_member_revoke_locks(nodemap);
 502
 503 out:
 504         return rc;
 505 }
 506
 507 int nodemap_add_idmap(const char *name, enum nodemap_id_type id_type,
 508                       const __u32 map[2])
 509 {
 510         struct lu_nodemap       *nodemap = NULL;
 511         int                      rc;
 512
 513         ENTRY;
 514
 515         mutex_lock(&active_config_lock);
 516         nodemap = nodemap_lookup(name);
 517         if (IS_ERR(nodemap)) {
 518                 mutex_unlock(&active_config_lock);
 519                 GOTO(out, rc = PTR_ERR(nodemap));
 520         }
 521
 522         if (is_default_nodemap(nodemap)) {
 523                 rc = -EINVAL;
 524         } else {
 525                 rc = nodemap_add_idmap_helper(nodemap, id_type, map);
 526                 if (rc == 0)
 527                         rc = nodemap_idx_idmap_add(nodemap, id_type, map);
 528         }
 529         mutex_unlock(&active_config_lock);
 530         nodemap_putref(nodemap);
 531
 532 out:
 533         RETURN(rc);
 534 }
 535 EXPORT_SYMBOL(nodemap_add_idmap);
 536
 537 /**
 538  * delete idmap from proper nodemap tree
 539  *
 540  * \param       name            name of nodemap
 541  * \param       id_type         NODEMAP_UID or NODEMAP_GID
 542  * \param       map             array[2] __u32 containing the mapA values
 543  *                              map[0] is client id
 544  *                              map[1] is the filesystem id
 545  *
 546  * \retval      0 on success
 547  */
 548 int nodemap_del_idmap(const char *name, enum nodemap_id_type id_type,
 549                       const __u32 map[2])
 550 {
 551         struct lu_nodemap       *nodemap = NULL;
 552         struct lu_idmap         *idmap = NULL;
 553         int                     rc = 0;
 554
 555         ENTRY;
 556
 557         mutex_lock(&active_config_lock);
 558         nodemap = nodemap_lookup(name);
 559         if (IS_ERR(nodemap)) {
 560                 mutex_unlock(&active_config_lock);
 561                 GOTO(out, rc = PTR_ERR(nodemap));
 562         }
 563
 564         if (is_default_nodemap(nodemap))
 565                 GOTO(out_putref, rc = -EINVAL);
 566
 567         down_write(&nodemap->nm_idmap_lock);
 568         idmap = idmap_search(nodemap, NODEMAP_CLIENT_TO_FS, id_type,
 569                              map[0]);
 570         if (idmap == NULL) {
 571                 rc = -EINVAL;
 572         } else {
 573                 idmap_delete(id_type, idmap, nodemap);
 574                 rc = nodemap_idx_idmap_del(nodemap, id_type, map);
 575         }
 576         up_write(&nodemap->nm_idmap_lock);
 577
 578 out_putref:
 579         mutex_unlock(&active_config_lock);
 580         if (rc == 0)
 581                 nm_member_revoke_locks(nodemap);
 582         nodemap_putref(nodemap);
 583
 584 out:
 585         RETURN(rc);
 586 }
 587 EXPORT_SYMBOL(nodemap_del_idmap);
 588
 589 /**
 590  * Get nodemap assigned to given export. Takes a reference on the nodemap.
 591  *
 592  * Note that this function may return either NULL, or an ERR_PTR()
 593  * or a valid nodemap pointer.  All of the functions accessing the
 594  * returned nodemap can check IS_ERR(nodemap) to see if an error is
 595  * returned.  NULL is not considered an error, which is OK since this
 596  * is a valid case if nodemap are not in use.  All nodemap handling
 597  * functions must check for nodemap == NULL and do nothing, and the
 598  * nodemap returned from this function should not be dereferenced.
 599  *
 600  * \param       export          export to get nodemap for
 601  *
 602  * \retval      pointer to nodemap on success
 603  * \retval      NULL    nodemap subsystem disabled
 604  * \retval      -EACCES export does not have nodemap assigned
 605  */
 606 struct lu_nodemap *nodemap_get_from_exp(struct obd_export *exp)
 607 {
 608         struct lu_nodemap *nodemap;
 609
 610         ENTRY;
 611
 612         if (!nodemap_active)
 613                 RETURN(NULL);
 614
 615         spin_lock(&exp->exp_target_data.ted_nodemap_lock);
 616         nodemap = exp->exp_target_data.ted_nodemap;
 617         if (nodemap)
 618                 nodemap_getref(nodemap);
 619         spin_unlock(&exp->exp_target_data.ted_nodemap_lock);
 620
 621         if (!nodemap) {
 622                 CDEBUG(D_INFO, "%s: nodemap null on export %s (at %s)\n",
 623                        exp->exp_obd->obd_name,
 624                        obd_uuid2str(&exp->exp_client_uuid),
 625                        obd_export_nid2str(exp));
 626                 RETURN(ERR_PTR(-EACCES));
 627         }
 628
 629         RETURN(nodemap);
 630 }
 631 EXPORT_SYMBOL(nodemap_get_from_exp);
 632
 633 /**
 634  * mapping function for nodemap idmaps
 635  *
 636  * \param       nodemap         lu_nodemap structure defining nodemap
 637  * \param       node_type       NODEMAP_UID or NODEMAP_GID
 638  * \param       tree_type       NODEMAP_CLIENT_TO_FS or
 639  *                              NODEMAP_FS_TO_CLIENT
 640  * \param       id              id to map
 641  *
 642  * \retval      mapped id according to the rules below.
 643  *
 644  * if the nodemap_active is false, just return the passed id without mapping
 645  *
 646  * if the id to be looked up is 0, check that root access is allowed and if it
 647  * is, return 0. Otherwise, return the squash uid or gid.
 648  *
 649  * if the nodemap is configured to trusted the ids from the client system, just
 650  * return the passed id without mapping.
 651  *
 652  * if by this point, we haven't returned and the nodemap in question is the
 653  * default nodemap, return the squash uid or gid.
 654  *
 655  * after these checks, search the proper tree for the mapping, and if found
 656  * return the mapped value, otherwise return the squash uid or gid.
 657  */
 658 __u32 nodemap_map_id(struct lu_nodemap *nodemap,
 659                      enum nodemap_id_type id_type,
 660                      enum nodemap_tree_type tree_type, __u32 id)
 661 {
 662         struct lu_idmap         *idmap = NULL;
 663         __u32                    found_id;
 664
 665         ENTRY;
 666
 667         if (!nodemap_active)
 668                 goto out;
 669
 670         if (unlikely(nodemap == NULL))
 671                 goto out;
 672
 673         if (nodemap->nmf_map_uid_only && id_type == NODEMAP_GID)
 674                 goto out;
 675
 676         if (nodemap->nmf_map_gid_only && id_type == NODEMAP_UID)
 677                 goto out;
 678
 679         if (id == 0) {
 680                 if (nodemap->nmf_allow_root_access)
 681                         goto out;
 682                 else
 683                         goto squash;
 684         }
 685
 686         if (nodemap->nmf_trust_client_ids)
 687                 goto out;
 688
 689         if (is_default_nodemap(nodemap))
 690                 goto squash;
 691
 692         down_read(&nodemap->nm_idmap_lock);
 693         idmap = idmap_search(nodemap, tree_type, id_type, id);
 694         if (idmap == NULL) {
 695                 up_read(&nodemap->nm_idmap_lock);
 696                 goto squash;
 697         }
 698
 699         if (tree_type == NODEMAP_FS_TO_CLIENT)
 700                 found_id = idmap->id_client;
 701         else
 702                 found_id = idmap->id_fs;
 703         up_read(&nodemap->nm_idmap_lock);
 704         RETURN(found_id);
 705
 706 squash:
 707         if (id_type == NODEMAP_UID)
 708                 RETURN(nodemap->nm_squash_uid);
 709         else
 710                 RETURN(nodemap->nm_squash_gid);
 711 out:
 712         RETURN(id);
 713 }
 714 EXPORT_SYMBOL(nodemap_map_id);
 715
 716 /**
 717  * Map posix ACL entries according to the nodemap membership. Removes any
 718  * squashed ACLs.
 719  *
 720  * \param       lu_nodemap      nodemap
 721  * \param       buf             buffer containing xattr encoded ACLs
 722  * \param       size            size of ACLs in bytes
 723  * \param       tree_type       direction of mapping
 724  * \retval      size            new size of ACLs in bytes
 725  * \retval      -EINVAL         bad \a size param, see posix_acl_xattr_count()
 726  */
 727 ssize_t nodemap_map_acl(struct lu_nodemap *nodemap, void *buf, size_t size,
 728                         enum nodemap_tree_type tree_type)
 729 {
 730         posix_acl_xattr_header  *header = buf;
 731         posix_acl_xattr_entry   *entry = GET_POSIX_ACL_XATTR_ENTRY(header);
 732         posix_acl_xattr_entry   *new_entry = entry;
 733         posix_acl_xattr_entry   *end;
 734         int                      count;
 735
 736         ENTRY;
 737
 738         if (!nodemap_active)
 739                 RETURN(size);
 740
 741         if (unlikely(nodemap == NULL))
 742                 RETURN(size);
 743
 744         count = posix_acl_xattr_count(size);
 745         if (count < 0)
 746                 RETURN(-EINVAL);
 747         if (count == 0)
 748                 RETURN(0);
 749
 750         for (end = entry + count; entry != end; entry++) {
 751                 __u16 tag = le16_to_cpu(entry->e_tag);
 752                 __u32 id = le32_to_cpu(entry->e_id);
 753
 754                 switch (tag) {
 755                 case ACL_USER:
 756                         id = nodemap_map_id(nodemap, NODEMAP_UID,
 757                                             tree_type, id);
 758                         if (id == nodemap->nm_squash_uid)
 759                                 continue;
 760                         entry->e_id = cpu_to_le32(id);
 761                         break;
 762                 case ACL_GROUP:
 763                         id = nodemap_map_id(nodemap, NODEMAP_GID,
 764                                             tree_type, id);
 765                         if (id == nodemap->nm_squash_gid)
 766                                 continue;
 767                         entry->e_id = cpu_to_le32(id);
 768                         break;
 769                 }
 770
 771                 /* if we skip an ACL, copy the following ones over it */
 772                 if (new_entry != entry)
 773                         *new_entry = *entry;
 774
 775                 new_entry++;
 776         }
 777
 778         RETURN((void *)new_entry - (void *)header);
 779 }
 780 EXPORT_SYMBOL(nodemap_map_acl);
 781
 782 /*
 783  * Add nid range to given nodemap
 784  *
 785  * \param       config          nodemap config to work on
 786  * \param       nodemap         nodemap to add range to
 787  * \param       nid             nid range to add
 788  * \param       range_id        should be 0 unless loading from disk
 789  * \retval      0               success
 790  * \retval      -ENOMEM
 791  *
 792  */
 793 int nodemap_add_range_helper(struct nodemap_config *config,
 794                              struct lu_nodemap *nodemap,
 795                              const lnet_nid_t nid[2],
 796                              unsigned int range_id)
 797 {
 798         struct lu_nid_range     *range;
 799         int rc;
 800
 801         down_write(&config->nmc_range_tree_lock);
 802         range = range_create(&config->nmc_range_tree, nid[0], nid[1],
 803                              nodemap, range_id);
 804         if (range == NULL) {
 805                 up_write(&config->nmc_range_tree_lock);
 806                 GOTO(out, rc = -ENOMEM);
 807         }
 808
 809         rc = range_insert(&config->nmc_range_tree, range);
 810         if (rc != 0) {
 811                 CERROR("cannot insert nodemap range into '%s': rc = %d\n",
 812                       nodemap->nm_name, rc);
 813                 up_write(&config->nmc_range_tree_lock);
 814                 list_del(&range->rn_list);
 815                 range_destroy(range);
 816                 GOTO(out, rc = -ENOMEM);
 817         }
 818
 819         list_add(&range->rn_list, &nodemap->nm_ranges);
 820
 821         /* nodemaps have no members if they aren't on the active config */
 822         if (config == active_config)
 823                 nm_member_reclassify_nodemap(config->nmc_default_nodemap);
 824
 825         up_write(&config->nmc_range_tree_lock);
 826
 827         /* if range_id is non-zero, we are loading from disk */
 828         if (range_id == 0)
 829                 rc = nodemap_idx_range_add(range, nid);
 830
 831         if (config == active_config) {
 832                 nm_member_revoke_locks(config->nmc_default_nodemap);
 833                 nm_member_revoke_locks(nodemap);
 834         }
 835
 836 out:
 837         return rc;
 838 }
 839 int nodemap_add_range(const char *name, const lnet_nid_t nid[2])
 840 {
 841         struct lu_nodemap       *nodemap = NULL;
 842         int                      rc;
 843
 844         mutex_lock(&active_config_lock);
 845         nodemap = nodemap_lookup(name);
 846         if (IS_ERR(nodemap)) {
 847                 mutex_unlock(&active_config_lock);
 848                 GOTO(out, rc = PTR_ERR(nodemap));
 849         }
 850
 851         if (is_default_nodemap(nodemap))
 852                 rc = -EINVAL;
 853         else
 854                 rc = nodemap_add_range_helper(active_config, nodemap, nid, 0);
 855         mutex_unlock(&active_config_lock);
 856         nodemap_putref(nodemap);
 857 out:
 858         return rc;
 859 }
 860 EXPORT_SYMBOL(nodemap_add_range);
 861
 862 /**
 863  * delete a range
 864  * \param       name            nodemap name
 865  * \param       nid             nid range
 866  * \retval      0 on success
 867  *
 868  * Delete range from global range tree, and remove it
 869  * from the list in the associated nodemap.
 870  */
 871 int nodemap_del_range(const char *name, const lnet_nid_t nid[2])
 872 {
 873         struct lu_nodemap       *nodemap;
 874         struct lu_nid_range     *range;
 875         int                     rc = 0;
 876
 877         mutex_lock(&active_config_lock);
 878         nodemap = nodemap_lookup(name);
 879         if (IS_ERR(nodemap)) {
 880                 mutex_unlock(&active_config_lock);
 881                 GOTO(out, rc = PTR_ERR(nodemap));
 882         }
 883
 884         if (is_default_nodemap(nodemap))
 885                 GOTO(out_putref, rc = -EINVAL);
 886
 887         down_write(&active_config->nmc_range_tree_lock);
 888         range = range_find(&active_config->nmc_range_tree, nid[0], nid[1]);
 889         if (range == NULL) {
 890                 up_write(&active_config->nmc_range_tree_lock);
 891                 GOTO(out_putref, rc = -EINVAL);
 892         }
 893         if (range->rn_nodemap != nodemap) {
 894                 up_write(&active_config->nmc_range_tree_lock);
 895                 GOTO(out_putref, rc = -EINVAL);
 896         }
 897         rc = nodemap_idx_range_del(range);
 898         range_delete(&active_config->nmc_range_tree, range);
 899         nm_member_reclassify_nodemap(nodemap);
 900         up_write(&active_config->nmc_range_tree_lock);
 901
 902         nm_member_revoke_locks(active_config->nmc_default_nodemap);
 903         nm_member_revoke_locks(nodemap);
 904
 905 out_putref:
 906         mutex_unlock(&active_config_lock);
 907         nodemap_putref(nodemap);
 908 out:
 909         return rc;
 910 }
 911 EXPORT_SYMBOL(nodemap_del_range);
 912
 913 /**
 914  * set fileset on nodemap
 915  * \param       name            nodemap to set fileset on
 916  * \param       fileset         string containing fileset
 917  * \retval      0 on success
 918  *
 919  * set a fileset on the named nodemap
 920  */
 921 static int nodemap_set_fileset_helper(struct nodemap_config *config,
 922                                       struct lu_nodemap *nodemap,
 923                                       const char *fileset)
 924 {
 925         int rc = 0;
 926
 927         /* Allow 'fileset=clear' in addition to 'fileset=""' to clear fileset
 928          * because either command 'lctl set_param -P *.*.fileset=""' or
 929          * 'lctl nodemap_set_fileset --fileset ""' can only work correctly
 930          * on MGS, while on other servers, both commands will invoke upcall
 931          * "/usr/sbin/lctl set_param nodemap.default.fileset=" by function
 932          * process_param2_config(), which will cause "no value" error and
 933          * won't clear fileset.
 934          * 'fileset=""' is still kept for compatibility reason.
 935          */
 936         if (fileset == NULL)
 937                 rc = -EINVAL;
 938         else if (fileset[0] == '\0' || strcmp(fileset, "clear") == 0)
 939                 nodemap->nm_fileset[0] = '\0';
 940         else if (fileset[0] != '/')
 941                 rc = -EINVAL;
 942         else if (strlcpy(nodemap->nm_fileset, fileset,
 943                          sizeof(nodemap->nm_fileset)) >=
 944                  sizeof(nodemap->nm_fileset))
 945                 rc = -ENAMETOOLONG;
 946
 947         return rc;
 948 }
 949
 950 int nodemap_set_fileset(const char *name, const char *fileset)
 951 {
 952         struct lu_nodemap       *nodemap = NULL;
 953         int                      rc = 0;
 954
 955         mutex_lock(&active_config_lock);
 956         nodemap = nodemap_lookup(name);
 957         if (IS_ERR(nodemap)) {
 958                 mutex_unlock(&active_config_lock);
 959                 GOTO(out, rc = PTR_ERR(nodemap));
 960         }
 961
 962         rc = nodemap_set_fileset_helper(active_config, nodemap, fileset);
 963         mutex_unlock(&active_config_lock);
 964
 965         nodemap_putref(nodemap);
 966 out:
 967         return rc;
 968 }
 969 EXPORT_SYMBOL(nodemap_set_fileset);
 970
 971 /**
 972  * get fileset defined on nodemap
 973  * \param       nodemap         nodemap to get fileset from
 974  * \retval      fileset name, or NULL if not defined or not activated
 975  *
 976  * get the fileset defined on the nodemap
 977  */
 978 char *nodemap_get_fileset(const struct lu_nodemap *nodemap)
 979 {
 980         if (!nodemap_active)
 981                 return NULL;
 982
 983         return (char *)nodemap->nm_fileset;
 984 }
 985 EXPORT_SYMBOL(nodemap_get_fileset);
 986
 987 static int nodemap_validate_sepol(const char *sepol)
 988 {
 989         char buf[LUSTRE_NODEMAP_SEPOL_LENGTH + 1];
 990         char *p = (char *)sepol;
 991         char *q = buf;
 992         char polname[NAME_MAX + 1] = "";
 993         char hash[SELINUX_POLICY_HASH_LEN + 1] = "";
 994         unsigned char mode;
 995         unsigned short ver;
 996
 997         CLASSERT(sizeof(buf) == sizeof(((struct lu_nodemap *)0)->nm_sepol));
 998
 999         if (sepol == NULL)
1000                 return -EINVAL;
1001
1002         /* we allow sepol = "" which means clear SELinux policy info */
1003         if (sepol[0] == '\0')
1004                 return 0;
1005
1006         /* make a copy of sepol, by replacing ':' with space
1007          * so that we can use sscanf over the string
1008          */
1009         while (p-sepol < sizeof(buf)) {
1010                 if (*p == ':')
1011                         *q = ' ';
1012                 else
1013                         *q = *p;
1014                 if (*p == '\0')
1015                         break;
1016                 p++;
1017                 q++;
1018         }
1019         if (p-sepol == sizeof(buf))
1020                 return -ENAMETOOLONG;
1021
1022         if (sscanf(buf, "%1hhu %s %hu %s", &mode, polname, &ver, hash) != 4)
1023                 return -EINVAL;
1024
1025         if (mode != 0 && mode != 1)
1026                 return -EINVAL;
1027
1028         return 0;
1029 }
1030
1031 /**
1032  * set SELinux policy on nodemap
1033  * \param       name            nodemap to set SELinux policy info on
1034  * \param       sepol           string containing SELinux policy info
1035  * \retval      0 on success
1036  *
1037  * set SELinux policy info on the named nodemap
1038  */
1039 int nodemap_set_sepol(const char *name, const char *sepol)
1040 {
1041         struct lu_nodemap       *nodemap = NULL;
1042         int                      rc;
1043
1044         rc = nodemap_validate_sepol(sepol);
1045         if (rc < 0)
1046                 GOTO(out, rc);
1047
1048         mutex_lock(&active_config_lock);
1049         nodemap = nodemap_lookup(name);
1050         if (IS_ERR(nodemap)) {
1051                 mutex_unlock(&active_config_lock);
1052                 GOTO(out, rc = PTR_ERR(nodemap));
1053         }
1054
1055         if (is_default_nodemap(nodemap)) {
1056                 /* We do not want nodes in the default nodemap to have
1057                  * SELinux restrictions. Sec admin should create dedicated
1058                  * nodemap entries for this.
1059                  */
1060                 GOTO(out_putref, rc = -EINVAL);
1061         }
1062
1063         /* truncation cannot happen, as string length was checked in
1064          * nodemap_validate_sepol()
1065          */
1066         strlcpy(nodemap->nm_sepol, sepol, sizeof(nodemap->nm_sepol));
1067
1068 out_putref:
1069         mutex_unlock(&active_config_lock);
1070         nodemap_putref(nodemap);
1071 out:
1072         return rc;
1073 }
1074 EXPORT_SYMBOL(nodemap_set_sepol);
1075
1076 /**
1077  * get SELinux policy info defined on nodemap
1078  * \param       nodemap         nodemap to get SELinux policy info from
1079  * \retval      SELinux policy info, or NULL if not defined or not activated
1080  *
1081  * get the SELinux policy info defined on the nodemap
1082  */
1083 const char *nodemap_get_sepol(const struct lu_nodemap *nodemap)
1084 {
1085         if (is_default_nodemap(nodemap))
1086                 return NULL;
1087         else
1088                 return (char *)nodemap->nm_sepol;
1089 }
1090 EXPORT_SYMBOL(nodemap_get_sepol);
1091
1092 /**
1093  * Nodemap constructor
1094  *
1095  * Creates an lu_nodemap structure and assigns sane default
1096  * member values. If this is the default nodemap, the defaults
1097  * are the most restrictive in terms of mapping behavior. Otherwise
1098  * the default flags should be inherited from the default nodemap.
1099  * The adds nodemap to nodemap_hash.
1100  *
1101  * Requires that the caller take the active_config_lock
1102  *
1103  * \param       name            name of nodemap
1104  * \param       is_default      true if default nodemap
1105  * \retval      nodemap         success
1106  * \retval      -EINVAL         invalid nodemap name
1107  * \retval      -EEXIST         nodemap already exists
1108  * \retval      -ENOMEM         cannot allocate memory for nodemap
1109  */
1110 struct lu_nodemap *nodemap_create(const char *name,
1111                                   struct nodemap_config *config,
1112                                   bool is_default)
1113 {
1114         struct lu_nodemap       *nodemap = NULL;
1115         struct lu_nodemap       *default_nodemap;
1116         struct cfs_hash         *hash = config->nmc_nodemap_hash;
1117         int                      rc = 0;
1118         ENTRY;
1119
1120         default_nodemap = config->nmc_default_nodemap;
1121
1122         if (!nodemap_name_is_valid(name))
1123                 GOTO(out, rc = -EINVAL);
1124
1125         if (hash == NULL) {
1126                 CERROR("Config nodemap hash is NULL, unable to add %s\n", name);
1127                 GOTO(out, rc = -EINVAL);
1128         }
1129
1130         OBD_ALLOC_PTR(nodemap);
1131         if (nodemap == NULL) {
1132                 CERROR("cannot allocate memory (%zu bytes)"
1133                        "for nodemap '%s'\n", sizeof(*nodemap),
1134                        name);
1135                 GOTO(out, rc = -ENOMEM);
1136         }
1137
1138         /*
1139          * take an extra reference to prevent nodemap from being destroyed
1140          * while it's being created.
1141          */
1142         atomic_set(&nodemap->nm_refcount, 2);
1143         snprintf(nodemap->nm_name, sizeof(nodemap->nm_name), "%s", name);
1144         rc = cfs_hash_add_unique(hash, name, &nodemap->nm_hash);
1145         if (rc != 0) {
1146                 OBD_FREE_PTR(nodemap);
1147                 GOTO(out, rc = -EEXIST);
1148         }
1149
1150         INIT_LIST_HEAD(&nodemap->nm_ranges);
1151         INIT_LIST_HEAD(&nodemap->nm_list);
1152         INIT_LIST_HEAD(&nodemap->nm_member_list);
1153
1154         mutex_init(&nodemap->nm_member_list_lock);
1155         init_rwsem(&nodemap->nm_idmap_lock);
1156         nodemap->nm_fs_to_client_uidmap = RB_ROOT;
1157         nodemap->nm_client_to_fs_uidmap = RB_ROOT;
1158         nodemap->nm_fs_to_client_gidmap = RB_ROOT;
1159         nodemap->nm_client_to_fs_gidmap = RB_ROOT;
1160
1161         if (is_default) {
1162                 nodemap->nm_id = LUSTRE_NODEMAP_DEFAULT_ID;
1163                 config->nmc_default_nodemap = nodemap;
1164         } else {
1165                 config->nmc_nodemap_highest_id++;
1166                 nodemap->nm_id = config->nmc_nodemap_highest_id;
1167         }
1168
1169         if (is_default || default_nodemap == NULL) {
1170                 nodemap->nmf_trust_client_ids = 0;
1171                 nodemap->nmf_allow_root_access = 0;
1172                 nodemap->nmf_deny_unknown = 0;
1173                 nodemap->nmf_map_uid_only = 0;
1174                 nodemap->nmf_map_gid_only = 0;
1175                 nodemap->nmf_enable_audit = 1;
1176
1177                 nodemap->nm_squash_uid = NODEMAP_NOBODY_UID;
1178                 nodemap->nm_squash_gid = NODEMAP_NOBODY_GID;
1179                 nodemap->nm_fileset[0] = '\0';
1180                 nodemap->nm_sepol[0] = '\0';
1181                 if (!is_default)
1182                         CWARN("adding nodemap '%s' to config without"
1183                               " default nodemap\n", nodemap->nm_name);
1184         } else {
1185                 nodemap->nmf_trust_client_ids =
1186                                 default_nodemap->nmf_trust_client_ids;
1187                 nodemap->nmf_allow_root_access =
1188                                 default_nodemap->nmf_allow_root_access;
1189                 nodemap->nmf_deny_unknown =
1190                                 default_nodemap->nmf_deny_unknown;
1191                 nodemap->nmf_map_uid_only =
1192                                 default_nodemap->nmf_map_uid_only;
1193                 nodemap->nmf_map_gid_only =
1194                                 default_nodemap->nmf_map_gid_only;
1195                 nodemap->nmf_enable_audit =
1196                         default_nodemap->nmf_enable_audit;
1197
1198                 nodemap->nm_squash_uid = default_nodemap->nm_squash_uid;
1199                 nodemap->nm_squash_gid = default_nodemap->nm_squash_gid;
1200                 nodemap->nm_fileset[0] = '\0';
1201                 nodemap->nm_sepol[0] = '\0';
1202         }
1203
1204         RETURN(nodemap);
1205
1206 out:
1207         CERROR("cannot add nodemap: '%s': rc = %d\n", name, rc);
1208         RETURN(ERR_PTR(rc));
1209 }
1210
1211 /**
1212  * Set the nmf_deny_unknown flag to true or false.
1213  * \param       name            nodemap name
1214  * \param       deny_unknown    if true, squashed users will get EACCES
1215  * \retval      0 on success
1216  *
1217  */
1218 int nodemap_set_deny_unknown(const char *name, bool deny_unknown)
1219 {
1220         struct lu_nodemap       *nodemap = NULL;
1221         int                     rc = 0;
1222
1223         mutex_lock(&active_config_lock);
1224         nodemap = nodemap_lookup(name);
1225         mutex_unlock(&active_config_lock);
1226         if (IS_ERR(nodemap))
1227                 GOTO(out, rc = PTR_ERR(nodemap));
1228
1229         nodemap->nmf_deny_unknown = deny_unknown;
1230         rc = nodemap_idx_nodemap_update(nodemap);
1231
1232         nm_member_revoke_locks(nodemap);
1233         nodemap_putref(nodemap);
1234 out:
1235         return rc;
1236 }
1237 EXPORT_SYMBOL(nodemap_set_deny_unknown);
1238
1239 /**
1240  * Set the nmf_allow_root_access flag to true or false.
1241  * \param       name            nodemap name
1242  * \param       allow_root      if true, nodemap will not squash the root user
1243  * \retval      0 on success
1244  *
1245  */
1246 int nodemap_set_allow_root(const char *name, bool allow_root)
1247 {
1248         struct lu_nodemap       *nodemap = NULL;
1249         int                     rc = 0;
1250
1251         mutex_lock(&active_config_lock);
1252         nodemap = nodemap_lookup(name);
1253         mutex_unlock(&active_config_lock);
1254         if (IS_ERR(nodemap))
1255                 GOTO(out, rc = PTR_ERR(nodemap));
1256
1257         nodemap->nmf_allow_root_access = allow_root;
1258         rc = nodemap_idx_nodemap_update(nodemap);
1259
1260         nm_member_revoke_locks(nodemap);
1261         nodemap_putref(nodemap);
1262 out:
1263         return rc;
1264 }
1265 EXPORT_SYMBOL(nodemap_set_allow_root);
1266
1267 /**
1268  * Set the nmf_trust_client_ids flag to true or false.
1269  *
1270  * \param       name                    nodemap name
1271  * \param       trust_client_ids        if true, nodemap will not map its IDs
1272  * \retval      0 on success
1273  *
1274  */
1275 int nodemap_set_trust_client_ids(const char *name, bool trust_client_ids)
1276 {
1277         struct lu_nodemap       *nodemap = NULL;
1278         int                     rc = 0;
1279
1280         mutex_lock(&active_config_lock);
1281         nodemap = nodemap_lookup(name);
1282         mutex_unlock(&active_config_lock);
1283         if (IS_ERR(nodemap))
1284                 GOTO(out, rc = PTR_ERR(nodemap));
1285
1286         nodemap->nmf_trust_client_ids = trust_client_ids;
1287         rc = nodemap_idx_nodemap_update(nodemap);
1288
1289         nm_member_revoke_locks(nodemap);
1290         nodemap_putref(nodemap);
1291 out:
1292         return rc;
1293 }
1294 EXPORT_SYMBOL(nodemap_set_trust_client_ids);
1295
1296 int nodemap_set_mapping_mode(const char *name, enum nodemap_mapping_modes mode)
1297 {
1298         struct lu_nodemap       *nodemap = NULL;
1299         int                     rc = 0;
1300
1301         mutex_lock(&active_config_lock);
1302         nodemap = nodemap_lookup(name);
1303         mutex_unlock(&active_config_lock);
1304         if (IS_ERR(nodemap))
1305                 GOTO(out, rc = PTR_ERR(nodemap));
1306
1307         switch (mode) {
1308         case NODEMAP_MAP_BOTH:
1309                 nodemap->nmf_map_uid_only = 0;
1310                 nodemap->nmf_map_gid_only = 0;
1311                 break;
1312         case NODEMAP_MAP_UID_ONLY:
1313                 nodemap->nmf_map_uid_only = 1;
1314                 nodemap->nmf_map_gid_only = 0;
1315                 break;
1316         case NODEMAP_MAP_GID_ONLY:
1317                 nodemap->nmf_map_uid_only = 0;
1318                 nodemap->nmf_map_gid_only = 1;
1319                 break;
1320         default:
1321                 CWARN("cannot set unknown mapping mode, mode = %d\n", mode);
1322         }
1323         rc = nodemap_idx_nodemap_update(nodemap);
1324
1325         nm_member_revoke_locks(nodemap);
1326         nodemap_putref(nodemap);
1327 out:
1328         return rc;
1329 }
1330 EXPORT_SYMBOL(nodemap_set_mapping_mode);
1331
1332 /**
1333  * Update the squash_uid for a nodemap.
1334  *
1335  * \param       name            nodemap name
1336  * \param       uid             the new uid to squash unknown users to
1337  * \retval      0 on success
1338  *
1339  * Update the squash_uid for a nodemap. The squash_uid is the uid
1340  * that the all client uids are mapped to if nodemap is active,
1341  * the trust_client_ids flag is not set, and the uid is not in
1342  * the idmap tree.
1343  */
1344 int nodemap_set_squash_uid(const char *name, uid_t uid)
1345 {
1346         struct lu_nodemap       *nodemap = NULL;
1347         int                     rc = 0;
1348
1349         mutex_lock(&active_config_lock);
1350         nodemap = nodemap_lookup(name);
1351         mutex_unlock(&active_config_lock);
1352         if (IS_ERR(nodemap))
1353                 GOTO(out, rc = PTR_ERR(nodemap));
1354
1355         nodemap->nm_squash_uid = uid;
1356         rc = nodemap_idx_nodemap_update(nodemap);
1357
1358         nm_member_revoke_locks(nodemap);
1359         nodemap_putref(nodemap);
1360 out:
1361         return rc;
1362 }
1363 EXPORT_SYMBOL(nodemap_set_squash_uid);
1364
1365 /**
1366  * Update the squash_gid for a nodemap.
1367  *
1368  * \param       name            nodemap name
1369  * \param       gid             the new gid to squash unknown gids to
1370  * \retval      0 on success
1371  *
1372  * Update the squash_gid for a nodemap. The squash_uid is the gid
1373  * that the all client gids are mapped to if nodemap is active,
1374  * the trust_client_ids flag is not set, and the gid is not in
1375  * the idmap tree.
1376  */
1377 int nodemap_set_squash_gid(const char *name, gid_t gid)
1378 {
1379         struct lu_nodemap       *nodemap = NULL;
1380         int                     rc = 0;
1381
1382         mutex_lock(&active_config_lock);
1383         nodemap = nodemap_lookup(name);
1384         mutex_unlock(&active_config_lock);
1385         if (IS_ERR(nodemap))
1386                 GOTO(out, rc = PTR_ERR(nodemap));
1387
1388         nodemap->nm_squash_gid = gid;
1389         rc = nodemap_idx_nodemap_update(nodemap);
1390
1391         nm_member_revoke_locks(nodemap);
1392         nodemap_putref(nodemap);
1393 out:
1394         return rc;
1395 }
1396 EXPORT_SYMBOL(nodemap_set_squash_gid);
1397
1398 /**
1399  * Returns true if this nodemap has root user access. Always returns true if
1400  * nodemaps are not active.
1401  *
1402  * \param       nodemap         nodemap to check access for
1403  */
1404 bool nodemap_can_setquota(const struct lu_nodemap *nodemap)
1405 {
1406         return !nodemap_active || (nodemap && nodemap->nmf_allow_root_access);
1407 }
1408 EXPORT_SYMBOL(nodemap_can_setquota);
1409
1410 /**
1411  * Set the nmf_enable_audit flag to true or false.
1412  * \param       name            nodemap name
1413  * \param       audit_mode      if true, allow audit
1414  * \retval      0 on success
1415  *
1416  */
1417 int nodemap_set_audit_mode(const char *name, bool enable_audit)
1418 {
1419         struct lu_nodemap       *nodemap = NULL;
1420         int                     rc = 0;
1421
1422         mutex_lock(&active_config_lock);
1423         nodemap = nodemap_lookup(name);
1424         mutex_unlock(&active_config_lock);
1425         if (IS_ERR(nodemap))
1426                 GOTO(out, rc = PTR_ERR(nodemap));
1427
1428         nodemap->nmf_enable_audit = enable_audit;
1429         rc = nodemap_idx_nodemap_update(nodemap);
1430
1431         nm_member_revoke_locks(nodemap);
1432         nodemap_putref(nodemap);
1433 out:
1434         return rc;
1435 }
1436 EXPORT_SYMBOL(nodemap_set_audit_mode);
1437
1438
1439 /**
1440  * Add a nodemap
1441  *
1442  * \param       name            name of nodemap
1443  * \retval      0               success
1444  * \retval      -EINVAL         invalid nodemap name
1445  * \retval      -EEXIST         nodemap already exists
1446  * \retval      -ENOMEM         cannot allocate memory for nodemap
1447  */
1448 int nodemap_add(const char *nodemap_name)
1449 {
1450         struct lu_nodemap *nodemap;
1451         int rc;
1452
1453         mutex_lock(&active_config_lock);
1454         nodemap = nodemap_create(nodemap_name, active_config, 0);
1455         if (IS_ERR(nodemap)) {
1456                 mutex_unlock(&active_config_lock);
1457                 return PTR_ERR(nodemap);
1458         }
1459
1460         rc = nodemap_idx_nodemap_add(nodemap);
1461         if (rc == 0)
1462                 rc = lprocfs_nodemap_register(nodemap, 0);
1463
1464         mutex_unlock(&active_config_lock);
1465         nodemap_putref(nodemap);
1466
1467         return rc;
1468 }
1469 EXPORT_SYMBOL(nodemap_add);
1470
1471 /**
1472  * Delete a nodemap
1473  *
1474  * \param       name            name of nodemmap
1475  * \retval      0               success
1476  * \retval      -EINVAL         invalid input
1477  * \retval      -ENOENT         no existing nodemap
1478  */
1479 int nodemap_del(const char *nodemap_name)
1480 {
1481         struct lu_nodemap       *nodemap;
1482         struct lu_nid_range     *range;
1483         struct lu_nid_range     *range_temp;
1484         int                      rc = 0;
1485         int                      rc2 = 0;
1486
1487         if (strcmp(nodemap_name, DEFAULT_NODEMAP) == 0)
1488                 RETURN(-EINVAL);
1489
1490         mutex_lock(&active_config_lock);
1491         nodemap = cfs_hash_del_key(active_config->nmc_nodemap_hash,
1492                                    nodemap_name);
1493         if (nodemap == NULL) {
1494                 mutex_unlock(&active_config_lock);
1495                 GOTO(out, rc = -ENOENT);
1496         }
1497
1498         /* erase nodemap from active ranges to prevent client assignment */
1499         down_write(&active_config->nmc_range_tree_lock);
1500         list_for_each_entry_safe(range, range_temp, &nodemap->nm_ranges,
1501                                  rn_list) {
1502                 rc2 = nodemap_idx_range_del(range);
1503                 if (rc2 < 0)
1504                         rc = rc2;
1505
1506                 range_delete(&active_config->nmc_range_tree, range);
1507         }
1508         up_write(&active_config->nmc_range_tree_lock);
1509
1510         rc2 = nodemap_idx_nodemap_del(nodemap);
1511         if (rc2 < 0)
1512                 rc = rc2;
1513
1514         /*
1515          * remove procfs here in case nodemap_create called with same name
1516          * before nodemap_destroy is run.
1517          */
1518         lprocfs_nodemap_remove(nodemap->nm_pde_data);
1519         nodemap->nm_pde_data = NULL;
1520
1521         /* reclassify all member exports from nodemap, so they put their refs */
1522         down_read(&active_config->nmc_range_tree_lock);
1523         nm_member_reclassify_nodemap(nodemap);
1524         up_read(&active_config->nmc_range_tree_lock);
1525
1526         if (!list_empty(&nodemap->nm_member_list))
1527                 CWARN("nodemap_del failed to reclassify all members\n");
1528
1529         mutex_unlock(&active_config_lock);
1530
1531         nodemap_putref(nodemap);
1532
1533 out:
1534         return rc;
1535 }
1536 EXPORT_SYMBOL(nodemap_del);
1537
1538 /**
1539  * activate nodemap functions
1540  *
1541  * \param       value           1 for on, 0 for off
1542  */
1543 void nodemap_activate(const bool value)
1544 {
1545         mutex_lock(&active_config_lock);
1546         active_config->nmc_nodemap_is_active = value;
1547
1548         /* copy active value to global to avoid locking in map functions */
1549         nodemap_active = value;
1550         nodemap_idx_nodemap_activate(value);
1551         mutex_unlock(&active_config_lock);
1552         nm_member_revoke_all();
1553 }
1554 EXPORT_SYMBOL(nodemap_activate);
1555
1556 /**
1557  * Helper iterator to convert nodemap hash to list.
1558  *
1559  * \param       hs                      hash structure
1560  * \param       bd                      bucket descriptor
1561  * \param       hnode                   hash node
1562  * \param       nodemap_list_head       list head for list of nodemaps in hash
1563  */
1564 static int nodemap_cleanup_iter_cb(struct cfs_hash *hs, struct cfs_hash_bd *bd,
1565                                    struct hlist_node *hnode,
1566                                    void *nodemap_list_head)
1567 {
1568         struct lu_nodemap *nodemap;
1569
1570         nodemap = hlist_entry(hnode, struct lu_nodemap, nm_hash);
1571         list_add(&nodemap->nm_list, nodemap_list_head);
1572
1573         cfs_hash_bd_del_locked(hs, bd, hnode);
1574
1575         return 0;
1576 }
1577
1578 struct nodemap_config *nodemap_config_alloc(void)
1579 {
1580         struct nodemap_config *config;
1581         int rc = 0;
1582
1583         OBD_ALLOC_PTR(config);
1584         if (config == NULL)
1585                 return ERR_PTR(-ENOMEM);
1586
1587         rc = nodemap_init_hash(config);
1588         if (rc != 0) {
1589                 OBD_FREE_PTR(config);
1590                 return ERR_PTR(rc);
1591         }
1592
1593         init_rwsem(&config->nmc_range_tree_lock);
1594
1595         return config;
1596 }
1597 EXPORT_SYMBOL(nodemap_config_alloc);
1598
1599 /**
1600  * Walk the nodemap_hash and remove all nodemaps.
1601  */
1602 void nodemap_config_dealloc(struct nodemap_config *config)
1603 {
1604         struct lu_nodemap       *nodemap = NULL;
1605         struct lu_nodemap       *nodemap_temp;
1606         struct lu_nid_range     *range;
1607         struct lu_nid_range     *range_temp;
1608         LIST_HEAD(nodemap_list_head);
1609
1610         cfs_hash_for_each_safe(config->nmc_nodemap_hash,
1611                                nodemap_cleanup_iter_cb, &nodemap_list_head);
1612         cfs_hash_putref(config->nmc_nodemap_hash);
1613
1614         /* Because nodemap_destroy might sleep, we can't destroy them
1615          * in cfs_hash_for_each, so we build a list there and destroy here
1616          */
1617         list_for_each_entry_safe(nodemap, nodemap_temp, &nodemap_list_head,
1618                                  nm_list) {
1619                 mutex_lock(&active_config_lock);
1620                 down_write(&config->nmc_range_tree_lock);
1621
1622                 /* move members to new config, requires ac lock */
1623                 nm_member_reclassify_nodemap(nodemap);
1624                 list_for_each_entry_safe(range, range_temp, &nodemap->nm_ranges,
1625                                          rn_list)
1626                         range_delete(&config->nmc_range_tree, range);
1627                 up_write(&config->nmc_range_tree_lock);
1628                 mutex_unlock(&active_config_lock);
1629
1630                 /* putref must be outside of ac lock if nm could be destroyed */
1631                 nodemap_putref(nodemap);
1632         }
1633         OBD_FREE_PTR(config);
1634 }
1635 EXPORT_SYMBOL(nodemap_config_dealloc);
1636
1637 /*
1638  * callback for cfs_hash_for_each_safe used to convert a nodemap hash to a
1639  * nodemap list, generally for locking purposes as a hash cb can't sleep.
1640  */
1641 int nm_hash_list_cb(struct cfs_hash *hs, struct cfs_hash_bd *bd,
1642                     struct hlist_node *hnode,
1643                     void *nodemap_list_head)
1644 {
1645         struct lu_nodemap *nodemap;
1646
1647         nodemap = hlist_entry(hnode, struct lu_nodemap, nm_hash);
1648         list_add(&nodemap->nm_list, nodemap_list_head);
1649         return 0;
1650 }
1651
1652 void nodemap_config_set_active(struct nodemap_config *config)
1653 {
1654         struct nodemap_config   *old_config = active_config;
1655         struct lu_nodemap       *nodemap;
1656         struct lu_nodemap       *tmp;
1657         bool revoke_locks;
1658         LIST_HEAD(nodemap_list_head);
1659
1660         ENTRY;
1661
1662         LASSERT(active_config != config);
1663         LASSERT(config->nmc_default_nodemap);
1664
1665         mutex_lock(&active_config_lock);
1666
1667         /* move proc entries from already existing nms, create for new nms */
1668         cfs_hash_for_each_safe(config->nmc_nodemap_hash,
1669                                nm_hash_list_cb, &nodemap_list_head);
1670         list_for_each_entry_safe(nodemap, tmp, &nodemap_list_head, nm_list) {
1671                 struct lu_nodemap *old_nm = NULL;
1672
1673                 if (active_config != NULL)
1674                         old_nm = cfs_hash_lookup(
1675                                         active_config->nmc_nodemap_hash,
1676                                         nodemap->nm_name);
1677                 if (old_nm != NULL) {
1678                         nodemap->nm_pde_data = old_nm->nm_pde_data;
1679                         old_nm->nm_pde_data = NULL;
1680                         nodemap_putref(old_nm);
1681                 } else {
1682                         bool is_def = (nodemap == config->nmc_default_nodemap);
1683
1684                         lprocfs_nodemap_register(nodemap, is_def);
1685                 }
1686         }
1687
1688         /*
1689          * We only need to revoke locks if old nodemap was active, and new
1690          * config is now nodemap inactive. nodemap_config_dealloc will
1691          * reclassify exports, triggering a lock revoke if and only if new
1692          * nodemap is active.
1693          */
1694         revoke_locks = !config->nmc_nodemap_is_active && nodemap_active;
1695
1696         /* if new config is inactive, deactivate live config before switching */
1697         if (!config->nmc_nodemap_is_active)
1698                 nodemap_active = false;
1699         active_config = config;
1700         if (config->nmc_nodemap_is_active)
1701                 nodemap_active = true;
1702
1703         mutex_unlock(&active_config_lock);
1704
1705         if (old_config != NULL)
1706                 nodemap_config_dealloc(old_config);
1707
1708         if (revoke_locks)
1709                 nm_member_revoke_all();
1710
1711         EXIT;
1712 }
1713
1714 /**
1715  * Cleanup nodemap module on exit
1716  */
1717 void nodemap_mod_exit(void)
1718 {
1719         nodemap_config_dealloc(active_config);
1720         nodemap_procfs_exit();
1721 }
1722
1723 /**
1724  * Initialize the nodemap module
1725  */
1726 int nodemap_mod_init(void)
1727 {
1728         struct nodemap_config   *new_config;
1729         struct lu_nodemap       *nodemap;
1730         int                      rc = 0;
1731
1732         rc = nodemap_procfs_init();
1733         if (rc != 0)
1734                 return rc;
1735
1736         new_config = nodemap_config_alloc();
1737         if (IS_ERR(new_config)) {
1738                 nodemap_procfs_exit();
1739                 GOTO(out, rc = PTR_ERR(new_config));
1740         }
1741
1742         nodemap = nodemap_create(DEFAULT_NODEMAP, new_config, 1);
1743         if (IS_ERR(nodemap)) {
1744                 nodemap_config_dealloc(new_config);
1745                 nodemap_procfs_exit();
1746                 GOTO(out, rc = PTR_ERR(nodemap));
1747         }
1748
1749         nodemap_config_set_active(new_config);
1750         nodemap_putref(nodemap);
1751
1752 out:
1753         return rc;
1754 }
1755
1756 /**
1757  * Revoke locks for all nodemaps.
1758  */
1759 void nm_member_revoke_all(void)
1760 {
1761         struct lu_nodemap *nodemap;
1762         struct lu_nodemap *tmp;
1763         LIST_HEAD(nodemap_list_head);
1764
1765         mutex_lock(&active_config_lock);
1766         cfs_hash_for_each_safe(active_config->nmc_nodemap_hash,
1767                                nm_hash_list_cb, &nodemap_list_head);
1768
1769         /* revoke_locks sleeps, so can't call in cfs hash cb */
1770         list_for_each_entry_safe(nodemap, tmp, &nodemap_list_head, nm_list)
1771                 nm_member_revoke_locks_always(nodemap);
1772         mutex_unlock(&active_config_lock);
1773 }
1774
1775 /**
1776  * Returns the nodemap classification for a given nid into an ioctl buffer.
1777  * Useful for testing the nodemap configuration to make sure it is working as
1778  * expected.
1779  *
1780  * \param       nid             nid to classify
1781  * \param[out]  name_buf        buffer to write the nodemap name to
1782  * \param       name_len        length of buffer
1783  */
1784 void nodemap_test_nid(lnet_nid_t nid, char *name_buf, size_t name_len)
1785 {
1786         struct lu_nodemap       *nodemap;
1787
1788         mutex_lock(&active_config_lock);
1789         down_read(&active_config->nmc_range_tree_lock);
1790         nodemap = nodemap_classify_nid(nid);
1791         up_read(&active_config->nmc_range_tree_lock);
1792         mutex_unlock(&active_config_lock);
1793
1794         if (IS_ERR(nodemap))
1795                 return;
1796
1797         strncpy(name_buf, nodemap->nm_name, name_len);
1798         if (name_len > 0)
1799                 name_buf[name_len - 1] = '\0';
1800
1801         nodemap_putref(nodemap);
1802 }
1803 EXPORT_SYMBOL(nodemap_test_nid);
1804
1805 /**
1806  * Passes back the id mapping for a given nid/id pair. Useful for testing the
1807  * nodemap configuration to make sure it is working as expected.
1808  *
1809  * \param       nid             nid to classify
1810  * \param       idtype          uid or gid
1811  * \param       client_id       id to map to fs
1812  * \param       fs_id_buf       pointer to save mapped fs_id to
1813  *
1814  * \retval      0       success
1815  * \retval      -EINVAL invalid NID
1816  */
1817 int nodemap_test_id(lnet_nid_t nid, enum nodemap_id_type idtype,
1818                     __u32 client_id, __u32 *fs_id)
1819 {
1820         struct lu_nodemap       *nodemap;
1821
1822         mutex_lock(&active_config_lock);
1823         down_read(&active_config->nmc_range_tree_lock);
1824         nodemap = nodemap_classify_nid(nid);
1825         up_read(&active_config->nmc_range_tree_lock);
1826         mutex_unlock(&active_config_lock);
1827
1828         if (IS_ERR(nodemap))
1829                 return PTR_ERR(nodemap);
1830
1831         *fs_id = nodemap_map_id(nodemap, idtype, NODEMAP_CLIENT_TO_FS,
1832                                client_id);
1833         nodemap_putref(nodemap);
1834
1835         return 0;
1836 }
1837 EXPORT_SYMBOL(nodemap_test_id);