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 <obd_class.h>
  35 #include "nodemap_internal.h"
  36
  37 #define HASH_NODEMAP_BKT_BITS 3
  38 #define HASH_NODEMAP_CUR_BITS 3
  39 #define HASH_NODEMAP_MAX_BITS 7
  40
  41 #define DEFAULT_NODEMAP "default"
  42
  43 /* nodemap proc root proc directory under fs/lustre */
  44 struct proc_dir_entry *proc_lustre_nodemap_root;
  45
  46 /* Copy of config active flag to avoid locking in mapping functions */
  47 bool nodemap_active;
  48
  49 /* Lock protecting the active config, useful primarily when proc and
  50  * nodemap_hash might be replaced when loading a new config
  51  * Any time the active config is referenced, the lock should be held.
  52  */
  53 DEFINE_MUTEX(active_config_lock);
  54 struct nodemap_config *active_config;
  55
  56 /**
  57  * Nodemap destructor
  58  *
  59  * \param       nodemap         nodemap to destroy
  60  */
  61 static void nodemap_destroy(struct lu_nodemap *nodemap)
  62 {
  63         ENTRY;
  64
  65         if (nodemap->nm_pde_data != NULL)
  66                 lprocfs_nodemap_remove(nodemap->nm_pde_data);
  67
  68         mutex_lock(&active_config_lock);
  69         down_read(&active_config->nmc_range_tree_lock);
  70         nm_member_reclassify_nodemap(nodemap);
  71         up_read(&active_config->nmc_range_tree_lock);
  72
  73         down_write(&nodemap->nm_idmap_lock);
  74         idmap_delete_tree(nodemap);
  75         up_write(&nodemap->nm_idmap_lock);
  76
  77         mutex_unlock(&active_config_lock);
  78
  79         if (!list_empty(&nodemap->nm_member_list))
  80                 CWARN("nodemap_destroy failed to reclassify all members\n");
  81
  82         nm_member_delete_list(nodemap);
  83
  84         OBD_FREE_PTR(nodemap);
  85
  86         EXIT;
  87 }
  88
  89 /**
  90  * Functions used for the cfs_hash
  91  */
  92 void nodemap_getref(struct lu_nodemap *nodemap)
  93 {
  94         atomic_inc(&nodemap->nm_refcount);
  95         CDEBUG(D_INFO, "GETting nodemap %s(p=%p) : new refcount %d\n",
  96                nodemap->nm_name, nodemap, atomic_read(&nodemap->nm_refcount));
  97 }
  98
  99 /**
 100  * Destroy nodemap if last reference is put. Should be called outside
 101  * active_config_lock
 102  */
 103 void nodemap_putref(struct lu_nodemap *nodemap)
 104 {
 105         if (!nodemap)
 106                 return;
 107
 108         LASSERT(atomic_read(&nodemap->nm_refcount) > 0);
 109
 110         CDEBUG(D_INFO, "PUTting nodemap %s(p=%p) : new refcount %d\n",
 111                nodemap->nm_name, nodemap,
 112                atomic_read(&nodemap->nm_refcount) - 1);
 113
 114         if (atomic_dec_and_test(&nodemap->nm_refcount))
 115                 nodemap_destroy(nodemap);
 116 }
 117 EXPORT_SYMBOL(nodemap_putref);
 118
 119 static __u32 nodemap_hashfn(struct cfs_hash *hash_body,
 120                             const void *key, unsigned mask)
 121 {
 122         return cfs_hash_djb2_hash(key, strlen(key), mask);
 123 }
 124
 125 static void *nodemap_hs_key(struct hlist_node *hnode)
 126 {
 127         struct lu_nodemap *nodemap;
 128
 129         nodemap = hlist_entry(hnode, struct lu_nodemap, nm_hash);
 130
 131         return nodemap->nm_name;
 132 }
 133
 134 static int nodemap_hs_keycmp(const void *key,
 135                              struct hlist_node *compared_hnode)
 136 {
 137         char *nodemap_name;
 138
 139         nodemap_name = nodemap_hs_key(compared_hnode);
 140
 141         return !strcmp(key, nodemap_name);
 142 }
 143
 144 static void *nodemap_hs_hashobject(struct hlist_node *hnode)
 145 {
 146         return hlist_entry(hnode, struct lu_nodemap, nm_hash);
 147 }
 148
 149 static void nodemap_hs_get(struct cfs_hash *hs, struct hlist_node *hnode)
 150 {
 151         struct lu_nodemap *nodemap;
 152
 153         nodemap = hlist_entry(hnode, struct lu_nodemap, nm_hash);
 154         nodemap_getref(nodemap);
 155 }
 156
 157 static void nodemap_hs_put_locked(struct cfs_hash *hs,
 158                                   struct hlist_node *hnode)
 159 {
 160         struct lu_nodemap *nodemap;
 161
 162         nodemap = hlist_entry(hnode, struct lu_nodemap, nm_hash);
 163         nodemap_putref(nodemap);
 164 }
 165
 166 static struct cfs_hash_ops nodemap_hash_operations = {
 167         .hs_hash        = nodemap_hashfn,
 168         .hs_key         = nodemap_hs_key,
 169         .hs_keycmp      = nodemap_hs_keycmp,
 170         .hs_object      = nodemap_hs_hashobject,
 171         .hs_get         = nodemap_hs_get,
 172         .hs_put_locked  = nodemap_hs_put_locked,
 173 };
 174
 175 /* end of cfs_hash functions */
 176
 177 /**
 178  * Initialize nodemap_hash
 179  *
 180  * \retval      0               success
 181  * \retval      -ENOMEM         cannot create hash
 182  */
 183 static int nodemap_init_hash(struct nodemap_config *nmc)
 184 {
 185         nmc->nmc_nodemap_hash = cfs_hash_create("NODEMAP",
 186                                                 HASH_NODEMAP_CUR_BITS,
 187                                                 HASH_NODEMAP_MAX_BITS,
 188                                                 HASH_NODEMAP_BKT_BITS, 0,
 189                                                 CFS_HASH_MIN_THETA,
 190                                                 CFS_HASH_MAX_THETA,
 191                                                 &nodemap_hash_operations,
 192                                                 CFS_HASH_DEFAULT);
 193
 194         if (nmc->nmc_nodemap_hash == NULL) {
 195                 CERROR("cannot create nodemap_hash table\n");
 196                 return -ENOMEM;
 197         }
 198
 199         return 0;
 200 }
 201
 202 /**
 203  * Check for valid nodemap name
 204  *
 205  * \param       name            nodemap name
 206  * \retval      true            valid
 207  * \retval      false           invalid
 208  */
 209 static bool nodemap_name_is_valid(const char *name)
 210 {
 211         if (strlen(name) > LUSTRE_NODEMAP_NAME_LENGTH ||
 212             strlen(name) == 0)
 213                 return false;
 214
 215         for (; *name != '\0'; name++) {
 216                 if (!isalnum(*name) && *name != '_')
 217                         return false;
 218         }
 219
 220         return true;
 221 }
 222
 223 /**
 224  * Nodemap lookup
 225  *
 226  * Look nodemap up in the active_config nodemap hash. Caller should hold the
 227  * active_config_lock.
 228  *
 229  * \param       name            name of nodemap
 230  * \retval      nodemap         pointer set to found nodemap
 231  * \retval      -EINVAL         name is not valid
 232  * \retval      -ENOENT         nodemap not found
 233  */
 234 struct lu_nodemap *nodemap_lookup(const char *name)
 235 {
 236         struct lu_nodemap *nodemap = NULL;
 237
 238         if (!nodemap_name_is_valid(name))
 239                 return ERR_PTR(-EINVAL);
 240
 241         nodemap = cfs_hash_lookup(active_config->nmc_nodemap_hash, name);
 242         if (nodemap == NULL)
 243                 return ERR_PTR(-ENOENT);
 244
 245         return nodemap;
 246 }
 247
 248 /**
 249  * Classify the nid into the proper nodemap. Caller must hold active config and
 250  * nm_range_tree_lock, and call nodemap_putref when done with nodemap.
 251  *
 252  * \param       nid                     nid to classify
 253  * \retval      nodemap                 nodemap containing the nid
 254  * \retval      default_nodemap         default nodemap
 255  * \retval      -EINVAL                 LO nid given without other local nid
 256  */
 257 struct lu_nodemap *nodemap_classify_nid(lnet_nid_t nid)
 258 {
 259         struct lu_nid_range *range;
 260         struct lu_nodemap *nodemap;
 261         int rc;
 262
 263         ENTRY;
 264
 265         /* don't use 0@lo, use the first non-lo local NID instead */
 266         if (nid == LNET_NID_LO_0) {
 267                 struct lnet_processid id;
 268                 int i = 0;
 269
 270                 do {
 271                         rc = LNetGetId(i++, &id);
 272                         if (rc < 0)
 273                                 RETURN(ERR_PTR(-EINVAL));
 274                 } while (nid_is_lo0(&id.nid));
 275
 276                 nid = lnet_nid_to_nid4(&id.nid);
 277                 CDEBUG(D_INFO, "found nid %s\n", libcfs_nid2str(nid));
 278         }
 279
 280         range = range_search(&active_config->nmc_range_tree, nid);
 281         if (range != NULL)
 282                 nodemap = range->rn_nodemap;
 283         else
 284                 nodemap = active_config->nmc_default_nodemap;
 285
 286         LASSERT(nodemap != NULL);
 287         nodemap_getref(nodemap);
 288
 289         RETURN(nodemap);
 290 }
 291
 292 /**
 293  * simple check for default nodemap
 294  */
 295 static bool is_default_nodemap(const struct lu_nodemap *nodemap)
 296 {
 297         return nodemap->nm_id == 0;
 298 }
 299
 300 /**
 301  * parse a nodemap range string into two nids
 302  *
 303  * \param       range_str               string to parse
 304  * \param       range[2]                array of two nids
 305  * \reyval      0 on success
 306  */
 307 int nodemap_parse_range(const char *range_str, lnet_nid_t range[2])
 308 {
 309         char    buf[LNET_NIDSTR_SIZE * 2 + 2];
 310         char    *ptr = NULL;
 311         char    *start_nidstr;
 312         char    *end_nidstr;
 313         int     rc = 0;
 314
 315         snprintf(buf, sizeof(buf), "%s", range_str);
 316         ptr = buf;
 317         start_nidstr = strsep(&ptr, ":");
 318         end_nidstr = strsep(&ptr, ":");
 319
 320         if (start_nidstr == NULL || end_nidstr == NULL)
 321                 GOTO(out, rc = -EINVAL);
 322
 323         range[0] = libcfs_str2nid(start_nidstr);
 324         range[1] = libcfs_str2nid(end_nidstr);
 325
 326 out:
 327         return rc;
 328
 329 }
 330 EXPORT_SYMBOL(nodemap_parse_range);
 331
 332 /**
 333  * parse a string containing an id map of form "client_id:filesystem_id"
 334  * into an array of __u32 * for use in mapping functions
 335  *
 336  * \param       idmap_str               map string
 337  * \param       idmap                   array[2] of __u32
 338  *
 339  * \retval      0 on success
 340  * \retval      -EINVAL if idmap cannot be parsed
 341  */
 342 int nodemap_parse_idmap(char *idmap_str, __u32 idmap[2])
 343 {
 344         char                    *sep;
 345         long unsigned int        idmap_buf;
 346         int                      rc;
 347
 348         if (idmap_str == NULL)
 349                 return -EINVAL;
 350
 351         sep = strchr(idmap_str, ':');
 352         if (sep == NULL)
 353                 return -EINVAL;
 354         *sep = '\0';
 355         sep++;
 356
 357         rc = kstrtoul(idmap_str, 10, &idmap_buf);
 358         if (rc != 0)
 359                 return -EINVAL;
 360         idmap[0] = idmap_buf;
 361
 362         rc = kstrtoul(sep, 10, &idmap_buf);
 363         if (rc != 0)
 364                 return -EINVAL;
 365         idmap[1] = idmap_buf;
 366
 367         return 0;
 368 }
 369 EXPORT_SYMBOL(nodemap_parse_idmap);
 370
 371 /**
 372  * add a member to a nodemap
 373  *
 374  * \param       nid             nid to add to the members
 375  * \param       exp             obd_export structure for the connection
 376  *                              that is being added
 377  * \retval      -EINVAL         export is NULL, or has invalid NID
 378  * \retval      -EEXIST         export is already member of a nodemap
 379  */
 380 int nodemap_add_member(lnet_nid_t nid, struct obd_export *exp)
 381 {
 382         struct lu_nodemap *nodemap;
 383         int rc = 0;
 384         ENTRY;
 385
 386         mutex_lock(&active_config_lock);
 387         down_read(&active_config->nmc_range_tree_lock);
 388
 389         nodemap = nodemap_classify_nid(nid);
 390
 391         if (IS_ERR(nodemap)) {
 392                 CWARN("%s: error adding to nodemap, no valid NIDs found\n",
 393                           exp->exp_obd->obd_name);
 394                 rc = -EINVAL;
 395         } else {
 396                 rc = nm_member_add(nodemap, exp);
 397         }
 398
 399         up_read(&active_config->nmc_range_tree_lock);
 400         mutex_unlock(&active_config_lock);
 401
 402         if (!IS_ERR(nodemap))
 403                 nodemap_putref(nodemap);
 404
 405         RETURN(rc);
 406 }
 407 EXPORT_SYMBOL(nodemap_add_member);
 408
 409 /**
 410  * delete a member from a nodemap
 411  *
 412  * \param       exp             export to remove from a nodemap
 413  */
 414 void nodemap_del_member(struct obd_export *exp)
 415 {
 416         struct lu_nodemap *nodemap;
 417
 418         ENTRY;
 419
 420         /* using ac lock to prevent nodemap reclassification while deleting */
 421         mutex_lock(&active_config_lock);
 422
 423         /* use of ted_nodemap is protected by active_config_lock. we take an
 424          * extra reference to make sure nodemap isn't destroyed under
 425          * active_config_lock
 426          */
 427         nodemap = exp->exp_target_data.ted_nodemap;
 428         if (nodemap == NULL)
 429                 goto out;
 430         else
 431                 nodemap_getref(nodemap);
 432
 433         mutex_lock(&nodemap->nm_member_list_lock);
 434         nm_member_del(nodemap, exp);
 435         mutex_unlock(&nodemap->nm_member_list_lock);
 436
 437 out:
 438         mutex_unlock(&active_config_lock);
 439
 440         if (nodemap)
 441                 nodemap_putref(nodemap);
 442
 443         EXIT;
 444 }
 445 EXPORT_SYMBOL(nodemap_del_member);
 446
 447 /**
 448  * add an idmap to the proper nodemap trees
 449  *
 450  * \param       nodemap         nodemap to add idmap to
 451  * \param       id_type         NODEMAP_UID or NODEMAP_GID
 452  * \param       map             array[2] __u32 containing the map values
 453  *                              map[0] is client id
 454  *                              map[1] is the filesystem id
 455  *
 456  * \retval      0       on success
 457  * \retval      < 0     if error occurs
 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         struct lu_idmap         *temp;
 465         int                     rc = 0;
 466
 467         idmap = idmap_create(map[0], map[1]);
 468         if (idmap == NULL)
 469                 GOTO(out, rc = -ENOMEM);
 470
 471         down_write(&nodemap->nm_idmap_lock);
 472         temp = idmap_insert(id_type, idmap, nodemap);
 473         /* If the new id_client or id_fs is matched, the old idmap and its
 474          * index should be deleted according to its id_client before the new
 475          * idmap is added again.
 476          */
 477         if (IS_ERR(temp))
 478                 GOTO(out_insert, rc = PTR_ERR(temp));
 479         if (temp) {
 480                 __u32 del_map[2];
 481
 482                 del_map[0] = temp->id_client;
 483                 idmap_delete(id_type, temp, nodemap);
 484                 rc = nodemap_idx_idmap_del(nodemap, id_type, del_map);
 485                 /* In case there is any corrupted idmap */
 486                 if (!rc || unlikely(rc == -ENOENT)) {
 487                         temp = idmap_insert(id_type, idmap, nodemap);
 488                         if (IS_ERR(temp))
 489                                 rc = PTR_ERR(temp);
 490                         else if (!temp)
 491                                 rc = 0;
 492                         else
 493                                 rc = -EPERM;
 494                 }
 495         }
 496 out_insert:
 497         if (rc)
 498                 OBD_FREE_PTR(idmap);
 499         up_write(&nodemap->nm_idmap_lock);
 500         nm_member_revoke_locks(nodemap);
 501
 502 out:
 503         return rc;
 504 }
 505
 506 int nodemap_add_idmap(const char *name, enum nodemap_id_type id_type,
 507                       const __u32 map[2])
 508 {
 509         struct lu_nodemap       *nodemap = NULL;
 510         int                      rc;
 511
 512         ENTRY;
 513
 514         mutex_lock(&active_config_lock);
 515         nodemap = nodemap_lookup(name);
 516         if (IS_ERR(nodemap)) {
 517                 mutex_unlock(&active_config_lock);
 518                 GOTO(out, rc = PTR_ERR(nodemap));
 519         }
 520
 521         if (is_default_nodemap(nodemap)) {
 522                 rc = -EINVAL;
 523         } else {
 524                 rc = nodemap_add_idmap_helper(nodemap, id_type, map);
 525                 if (rc == 0)
 526                         rc = nodemap_idx_idmap_add(nodemap, id_type, map);
 527         }
 528         mutex_unlock(&active_config_lock);
 529         nodemap_putref(nodemap);
 530
 531 out:
 532         RETURN(rc);
 533 }
 534 EXPORT_SYMBOL(nodemap_add_idmap);
 535
 536 /**
 537  * delete idmap from proper nodemap tree
 538  *
 539  * \param       name            name of nodemap
 540  * \param       id_type         NODEMAP_UID or NODEMAP_GID
 541  * \param       map             array[2] __u32 containing the mapA values
 542  *                              map[0] is client id
 543  *                              map[1] is the filesystem id
 544  *
 545  * \retval      0 on success
 546  */
 547 int nodemap_del_idmap(const char *name, enum nodemap_id_type id_type,
 548                       const __u32 map[2])
 549 {
 550         struct lu_nodemap       *nodemap = NULL;
 551         struct lu_idmap         *idmap = NULL;
 552         int                     rc = 0;
 553
 554         ENTRY;
 555
 556         mutex_lock(&active_config_lock);
 557         nodemap = nodemap_lookup(name);
 558         if (IS_ERR(nodemap)) {
 559                 mutex_unlock(&active_config_lock);
 560                 GOTO(out, rc = PTR_ERR(nodemap));
 561         }
 562
 563         if (is_default_nodemap(nodemap))
 564                 GOTO(out_putref, rc = -EINVAL);
 565
 566         down_write(&nodemap->nm_idmap_lock);
 567         idmap = idmap_search(nodemap, NODEMAP_CLIENT_TO_FS, id_type,
 568                              map[0]);
 569         if (idmap == NULL) {
 570                 rc = -EINVAL;
 571         } else {
 572                 idmap_delete(id_type, idmap, nodemap);
 573                 rc = nodemap_idx_idmap_del(nodemap, id_type, map);
 574         }
 575         up_write(&nodemap->nm_idmap_lock);
 576
 577 out_putref:
 578         mutex_unlock(&active_config_lock);
 579         if (rc == 0)
 580                 nm_member_revoke_locks(nodemap);
 581         nodemap_putref(nodemap);
 582
 583 out:
 584         RETURN(rc);
 585 }
 586 EXPORT_SYMBOL(nodemap_del_idmap);
 587
 588 /**
 589  * Get nodemap assigned to given export. Takes a reference on the nodemap.
 590  *
 591  * Note that this function may return either NULL, or an ERR_PTR()
 592  * or a valid nodemap pointer.  All of the functions accessing the
 593  * returned nodemap can check IS_ERR(nodemap) to see if an error is
 594  * returned.  NULL is not considered an error, which is OK since this
 595  * is a valid case if nodemap are not in use.  All nodemap handling
 596  * functions must check for nodemap == NULL and do nothing, and the
 597  * nodemap returned from this function should not be dereferenced.
 598  *
 599  * \param       export          export to get nodemap for
 600  *
 601  * \retval      pointer to nodemap on success
 602  * \retval      NULL    nodemap subsystem disabled
 603  * \retval      -EACCES export does not have nodemap assigned
 604  */
 605 struct lu_nodemap *nodemap_get_from_exp(struct obd_export *exp)
 606 {
 607         struct lu_nodemap *nodemap;
 608
 609         ENTRY;
 610
 611         if (!nodemap_active)
 612                 RETURN(NULL);
 613
 614         spin_lock(&exp->exp_target_data.ted_nodemap_lock);
 615         nodemap = exp->exp_target_data.ted_nodemap;
 616         if (nodemap)
 617                 nodemap_getref(nodemap);
 618         spin_unlock(&exp->exp_target_data.ted_nodemap_lock);
 619
 620         if (!nodemap) {
 621                 CDEBUG(D_INFO, "%s: nodemap null on export %s (at %s)\n",
 622                        exp->exp_obd->obd_name,
 623                        obd_uuid2str(&exp->exp_client_uuid),
 624                        obd_export_nid2str(exp));
 625                 RETURN(ERR_PTR(-EACCES));
 626         }
 627
 628         RETURN(nodemap);
 629 }
 630 EXPORT_SYMBOL(nodemap_get_from_exp);
 631
 632 /**
 633  * mapping function for nodemap idmaps
 634  *
 635  * \param       nodemap         lu_nodemap structure defining nodemap
 636  * \param       node_type       NODEMAP_UID or NODEMAP_GID or NODEMAP_PROJID
 637  * \param       tree_type       NODEMAP_CLIENT_TO_FS or
 638  *                              NODEMAP_FS_TO_CLIENT
 639  * \param       id              id to map
 640  *
 641  * \retval      mapped id according to the rules below.
 642  *
 643  * if the nodemap_active is false, just return the passed id without mapping
 644  *
 645  * if the id to be looked up is 0, check that root access is allowed and if it
 646  * is, return 0. Otherwise, return the squash uid or gid.
 647  *
 648  * if the nodemap is configured to trusted the ids from the client system, just
 649  * return the passed id without mapping.
 650  *
 651  * if by this point, we haven't returned and the nodemap in question is the
 652  * default nodemap, return the squash uid or gid.
 653  *
 654  * after these checks, search the proper tree for the mapping, and if found
 655  * return the mapped value, otherwise return the squash uid or gid.
 656  */
 657 __u32 nodemap_map_id(struct lu_nodemap *nodemap,
 658                      enum nodemap_id_type id_type,
 659                      enum nodemap_tree_type tree_type, __u32 id)
 660 {
 661         struct lu_idmap         *idmap = NULL;
 662         __u32                    found_id;
 663
 664         ENTRY;
 665
 666         if (!nodemap_active)
 667                 goto out;
 668
 669         if (unlikely(nodemap == NULL))
 670                 goto out;
 671
 672         if (id_type == NODEMAP_UID &&
 673             !(nodemap->nmf_map_mode & NODEMAP_MAP_UID))
 674                 goto out;
 675
 676         if (id_type == NODEMAP_GID &&
 677             !(nodemap->nmf_map_mode & NODEMAP_MAP_GID))
 678                 goto out;
 679
 680         if (id_type == NODEMAP_PROJID &&
 681             !(nodemap->nmf_map_mode & NODEMAP_MAP_PROJID))
 682                 goto out;
 683
 684         if (id == 0) {
 685                 if (nodemap->nmf_allow_root_access)
 686                         goto out;
 687                 else
 688                         goto squash;
 689         }
 690
 691         if (nodemap->nmf_trust_client_ids)
 692                 goto out;
 693
 694         if (is_default_nodemap(nodemap))
 695                 goto squash;
 696
 697         down_read(&nodemap->nm_idmap_lock);
 698         idmap = idmap_search(nodemap, tree_type, id_type, id);
 699         if (idmap == NULL) {
 700                 up_read(&nodemap->nm_idmap_lock);
 701                 goto squash;
 702         }
 703
 704         if (tree_type == NODEMAP_FS_TO_CLIENT)
 705                 found_id = idmap->id_client;
 706         else
 707                 found_id = idmap->id_fs;
 708         up_read(&nodemap->nm_idmap_lock);
 709         RETURN(found_id);
 710
 711 squash:
 712         if (id_type == NODEMAP_UID)
 713                 RETURN(nodemap->nm_squash_uid);
 714         if (id_type == NODEMAP_GID)
 715                 RETURN(nodemap->nm_squash_gid);
 716         if (id_type == NODEMAP_PROJID)
 717                 RETURN(nodemap->nm_squash_projid);
 718 out:
 719         RETURN(id);
 720 }
 721 EXPORT_SYMBOL(nodemap_map_id);
 722
 723 /**
 724  * Map posix ACL entries according to the nodemap membership. Removes any
 725  * squashed ACLs.
 726  *
 727  * \param       lu_nodemap      nodemap
 728  * \param       buf             buffer containing xattr encoded ACLs
 729  * \param       size            size of ACLs in bytes
 730  * \param       tree_type       direction of mapping
 731  * \retval      size            new size of ACLs in bytes
 732  * \retval      -EINVAL         bad \a size param, see posix_acl_xattr_count()
 733  */
 734 ssize_t nodemap_map_acl(struct lu_nodemap *nodemap, void *buf, size_t size,
 735                         enum nodemap_tree_type tree_type)
 736 {
 737         posix_acl_xattr_header  *header = buf;
 738         posix_acl_xattr_entry   *entry = GET_POSIX_ACL_XATTR_ENTRY(header);
 739         posix_acl_xattr_entry   *new_entry = entry;
 740         posix_acl_xattr_entry   *end;
 741         int                      count;
 742
 743         ENTRY;
 744
 745         if (!nodemap_active)
 746                 RETURN(size);
 747
 748         if (unlikely(nodemap == NULL))
 749                 RETURN(size);
 750
 751         count = posix_acl_xattr_count(size);
 752         if (count < 0)
 753                 RETURN(-EINVAL);
 754         if (count == 0)
 755                 /* if not proper ACL, do nothing and return initial size */
 756                 RETURN(size);
 757
 758         for (end = entry + count; entry != end; entry++) {
 759                 __u16 tag = le16_to_cpu(entry->e_tag);
 760                 __u32 id = le32_to_cpu(entry->e_id);
 761
 762                 switch (tag) {
 763                 case ACL_USER:
 764                         id = nodemap_map_id(nodemap, NODEMAP_UID,
 765                                             tree_type, id);
 766                         if (id == nodemap->nm_squash_uid)
 767                                 continue;
 768                         entry->e_id = cpu_to_le32(id);
 769                         break;
 770                 case ACL_GROUP:
 771                         id = nodemap_map_id(nodemap, NODEMAP_GID,
 772                                             tree_type, id);
 773                         if (id == nodemap->nm_squash_gid)
 774                                 continue;
 775                         entry->e_id = cpu_to_le32(id);
 776                         break;
 777                 }
 778
 779                 /* if we skip an ACL, copy the following ones over it */
 780                 if (new_entry != entry)
 781                         *new_entry = *entry;
 782
 783                 new_entry++;
 784         }
 785
 786         RETURN((void *)new_entry - (void *)header);
 787 }
 788 EXPORT_SYMBOL(nodemap_map_acl);
 789
 790 /*
 791  * Add nid range to given nodemap
 792  *
 793  * \param       config          nodemap config to work on
 794  * \param       nodemap         nodemap to add range to
 795  * \param       nid             nid range to add
 796  * \param       range_id        should be 0 unless loading from disk
 797  * \retval      0               success
 798  * \retval      -ENOMEM
 799  *
 800  */
 801 int nodemap_add_range_helper(struct nodemap_config *config,
 802                              struct lu_nodemap *nodemap,
 803                              const lnet_nid_t nid[2],
 804                              unsigned int range_id)
 805 {
 806         struct lu_nid_range     *range;
 807         int rc;
 808
 809         down_write(&config->nmc_range_tree_lock);
 810         range = range_create(&config->nmc_range_tree, nid[0], nid[1],
 811                              nodemap, range_id);
 812         if (range == NULL) {
 813                 up_write(&config->nmc_range_tree_lock);
 814                 GOTO(out, rc = -ENOMEM);
 815         }
 816
 817         rc = range_insert(&config->nmc_range_tree, range);
 818         if (rc) {
 819                 CDEBUG_LIMIT(rc == -EEXIST ? D_INFO : D_ERROR,
 820                              "cannot insert nodemap range into '%s': rc = %d\n",
 821                              nodemap->nm_name, rc);
 822                 up_write(&config->nmc_range_tree_lock);
 823                 list_del(&range->rn_list);
 824                 range_destroy(range);
 825                 GOTO(out, rc);
 826         }
 827
 828         list_add(&range->rn_list, &nodemap->nm_ranges);
 829
 830         /* nodemaps have no members if they aren't on the active config */
 831         if (config == active_config)
 832                 nm_member_reclassify_nodemap(config->nmc_default_nodemap);
 833
 834         up_write(&config->nmc_range_tree_lock);
 835
 836         /* if range_id is non-zero, we are loading from disk */
 837         if (range_id == 0)
 838                 rc = nodemap_idx_range_add(range, nid);
 839
 840         if (config == active_config) {
 841                 nm_member_revoke_locks(config->nmc_default_nodemap);
 842                 nm_member_revoke_locks(nodemap);
 843         }
 844
 845 out:
 846         return rc;
 847 }
 848
 849 int nodemap_add_range(const char *name, const lnet_nid_t nid[2])
 850 {
 851         struct lu_nodemap       *nodemap = NULL;
 852         int                      rc;
 853
 854         mutex_lock(&active_config_lock);
 855         nodemap = nodemap_lookup(name);
 856         if (IS_ERR(nodemap)) {
 857                 mutex_unlock(&active_config_lock);
 858                 GOTO(out, rc = PTR_ERR(nodemap));
 859         }
 860
 861         if (is_default_nodemap(nodemap))
 862                 rc = -EINVAL;
 863         else
 864                 rc = nodemap_add_range_helper(active_config, nodemap, nid, 0);
 865         mutex_unlock(&active_config_lock);
 866         nodemap_putref(nodemap);
 867 out:
 868         return rc;
 869 }
 870 EXPORT_SYMBOL(nodemap_add_range);
 871
 872 /**
 873  * delete a range
 874  * \param       name            nodemap name
 875  * \param       nid             nid range
 876  * \retval      0 on success
 877  *
 878  * Delete range from global range tree, and remove it
 879  * from the list in the associated nodemap.
 880  */
 881 int nodemap_del_range(const char *name, const lnet_nid_t nid[2])
 882 {
 883         struct lu_nodemap       *nodemap;
 884         struct lu_nid_range     *range;
 885         int                     rc = 0;
 886
 887         mutex_lock(&active_config_lock);
 888         nodemap = nodemap_lookup(name);
 889         if (IS_ERR(nodemap)) {
 890                 mutex_unlock(&active_config_lock);
 891                 GOTO(out, rc = PTR_ERR(nodemap));
 892         }
 893
 894         if (is_default_nodemap(nodemap))
 895                 GOTO(out_putref, rc = -EINVAL);
 896
 897         down_write(&active_config->nmc_range_tree_lock);
 898         range = range_find(&active_config->nmc_range_tree, nid[0], nid[1]);
 899         if (range == NULL) {
 900                 up_write(&active_config->nmc_range_tree_lock);
 901                 GOTO(out_putref, rc = -EINVAL);
 902         }
 903         if (range->rn_nodemap != nodemap) {
 904                 up_write(&active_config->nmc_range_tree_lock);
 905                 GOTO(out_putref, rc = -EINVAL);
 906         }
 907         rc = nodemap_idx_range_del(range);
 908         range_delete(&active_config->nmc_range_tree, range);
 909         nm_member_reclassify_nodemap(nodemap);
 910         up_write(&active_config->nmc_range_tree_lock);
 911
 912         nm_member_revoke_locks(active_config->nmc_default_nodemap);
 913         nm_member_revoke_locks(nodemap);
 914
 915 out_putref:
 916         mutex_unlock(&active_config_lock);
 917         nodemap_putref(nodemap);
 918 out:
 919         return rc;
 920 }
 921 EXPORT_SYMBOL(nodemap_del_range);
 922
 923 /**
 924  * set fileset on nodemap
 925  * \param       name            nodemap to set fileset on
 926  * \param       fileset         string containing fileset
 927  * \retval      0 on success
 928  *
 929  * set a fileset on the named nodemap
 930  */
 931 static int nodemap_set_fileset_helper(struct nodemap_config *config,
 932                                       struct lu_nodemap *nodemap,
 933                                       const char *fileset)
 934 {
 935         int rc = 0;
 936
 937         /* Allow 'fileset=clear' in addition to 'fileset=""' to clear fileset
 938          * because either command 'lctl set_param -P *.*.fileset=""' or
 939          * 'lctl nodemap_set_fileset --fileset ""' can only work correctly
 940          * on MGS, while on other servers, both commands will invoke upcall
 941          * "/usr/sbin/lctl set_param nodemap.default.fileset=" by function
 942          * process_param2_config(), which will cause "no value" error and
 943          * won't clear fileset.
 944          * 'fileset=""' is still kept for compatibility reason.
 945          */
 946         if (fileset == NULL)
 947                 rc = -EINVAL;
 948         else if (fileset[0] == '\0' || strcmp(fileset, "clear") == 0)
 949                 nodemap->nm_fileset[0] = '\0';
 950         else if (fileset[0] != '/')
 951                 rc = -EINVAL;
 952         else if (strlcpy(nodemap->nm_fileset, fileset,
 953                          sizeof(nodemap->nm_fileset)) >=
 954                  sizeof(nodemap->nm_fileset))
 955                 rc = -ENAMETOOLONG;
 956
 957         return rc;
 958 }
 959
 960 int nodemap_set_fileset(const char *name, const char *fileset)
 961 {
 962         struct lu_nodemap       *nodemap = NULL;
 963         int                      rc = 0;
 964
 965         mutex_lock(&active_config_lock);
 966         nodemap = nodemap_lookup(name);
 967         if (IS_ERR(nodemap)) {
 968                 mutex_unlock(&active_config_lock);
 969                 GOTO(out, rc = PTR_ERR(nodemap));
 970         }
 971
 972         rc = nodemap_set_fileset_helper(active_config, nodemap, fileset);
 973         mutex_unlock(&active_config_lock);
 974
 975         nodemap_putref(nodemap);
 976 out:
 977         return rc;
 978 }
 979 EXPORT_SYMBOL(nodemap_set_fileset);
 980
 981 /**
 982  * get fileset defined on nodemap
 983  * \param       nodemap         nodemap to get fileset from
 984  * \retval      fileset name, or NULL if not defined or not activated
 985  *
 986  * get the fileset defined on the nodemap
 987  */
 988 char *nodemap_get_fileset(const struct lu_nodemap *nodemap)
 989 {
 990         if (!nodemap_active)
 991                 return NULL;
 992
 993         return (char *)nodemap->nm_fileset;
 994 }
 995 EXPORT_SYMBOL(nodemap_get_fileset);
 996
 997 static int nodemap_validate_sepol(const char *sepol)
 998 {
 999         char buf[LUSTRE_NODEMAP_SEPOL_LENGTH + 1];
1000         char *p = (char *)sepol;
1001         char *q = buf;
1002         char polname[NAME_MAX + 1] = "";
1003         char hash[SELINUX_POLICY_HASH_LEN + 1] = "";
1004         unsigned char mode;
1005         unsigned short ver;
1006
1007         BUILD_BUG_ON(sizeof(buf) != sizeof(((struct lu_nodemap *)0)->nm_sepol));
1008
1009         if (sepol == NULL)
1010                 return -EINVAL;
1011
1012         /* we allow sepol = "" which means clear SELinux policy info */
1013         if (sepol[0] == '\0')
1014                 return 0;
1015
1016         /* make a copy of sepol, by replacing ':' with space
1017          * so that we can use sscanf over the string
1018          */
1019         while (p-sepol < sizeof(buf)) {
1020                 if (*p == ':')
1021                         *q = ' ';
1022                 else
1023                         *q = *p;
1024                 if (*p == '\0')
1025                         break;
1026                 p++;
1027                 q++;
1028         }
1029         if (p-sepol == sizeof(buf))
1030                 return -ENAMETOOLONG;
1031
1032         if (sscanf(buf, "%1hhu %s %hu %s", &mode, polname, &ver, hash) != 4)
1033                 return -EINVAL;
1034
1035         if (mode != 0 && mode != 1)
1036                 return -EINVAL;
1037
1038         return 0;
1039 }
1040
1041 /**
1042  * set SELinux policy on nodemap
1043  * \param       name            nodemap to set SELinux policy info on
1044  * \param       sepol           string containing SELinux policy info
1045  * \retval      0 on success
1046  *
1047  * set SELinux policy info on the named nodemap
1048  */
1049 int nodemap_set_sepol(const char *name, const char *sepol)
1050 {
1051         struct lu_nodemap       *nodemap = NULL;
1052         int                      rc;
1053
1054         rc = nodemap_validate_sepol(sepol);
1055         if (rc < 0)
1056                 GOTO(out, rc);
1057
1058         mutex_lock(&active_config_lock);
1059         nodemap = nodemap_lookup(name);
1060         if (IS_ERR(nodemap)) {
1061                 mutex_unlock(&active_config_lock);
1062                 GOTO(out, rc = PTR_ERR(nodemap));
1063         }
1064
1065         if (is_default_nodemap(nodemap)) {
1066                 /* We do not want nodes in the default nodemap to have
1067                  * SELinux restrictions. Sec admin should create dedicated
1068                  * nodemap entries for this.
1069                  */
1070                 GOTO(out_putref, rc = -EINVAL);
1071         }
1072
1073         /* truncation cannot happen, as string length was checked in
1074          * nodemap_validate_sepol()
1075          */
1076         strlcpy(nodemap->nm_sepol, sepol, sizeof(nodemap->nm_sepol));
1077
1078 out_putref:
1079         mutex_unlock(&active_config_lock);
1080         nodemap_putref(nodemap);
1081 out:
1082         return rc;
1083 }
1084 EXPORT_SYMBOL(nodemap_set_sepol);
1085
1086 /**
1087  * get SELinux policy info defined on nodemap
1088  * \param       nodemap         nodemap to get SELinux policy info from
1089  * \retval      SELinux policy info, or NULL if not defined or not activated
1090  *
1091  * get the SELinux policy info defined on the nodemap
1092  */
1093 const char *nodemap_get_sepol(const struct lu_nodemap *nodemap)
1094 {
1095         if (is_default_nodemap(nodemap))
1096                 return NULL;
1097         else
1098                 return (char *)nodemap->nm_sepol;
1099 }
1100 EXPORT_SYMBOL(nodemap_get_sepol);
1101
1102 /**
1103  * Nodemap constructor
1104  *
1105  * Creates an lu_nodemap structure and assigns sane default
1106  * member values. If this is the default nodemap, the defaults
1107  * are the most restrictive in terms of mapping behavior. Otherwise
1108  * the default flags should be inherited from the default nodemap.
1109  * The adds nodemap to nodemap_hash.
1110  *
1111  * Requires that the caller take the active_config_lock
1112  *
1113  * \param       name            name of nodemap
1114  * \param       is_default      true if default nodemap
1115  * \retval      nodemap         success
1116  * \retval      -EINVAL         invalid nodemap name
1117  * \retval      -EEXIST         nodemap already exists
1118  * \retval      -ENOMEM         cannot allocate memory for nodemap
1119  */
1120 struct lu_nodemap *nodemap_create(const char *name,
1121                                   struct nodemap_config *config,
1122                                   bool is_default)
1123 {
1124         struct lu_nodemap       *nodemap = NULL;
1125         struct lu_nodemap       *default_nodemap;
1126         struct cfs_hash         *hash = config->nmc_nodemap_hash;
1127         int                      rc = 0;
1128         ENTRY;
1129
1130         default_nodemap = config->nmc_default_nodemap;
1131
1132         if (!nodemap_name_is_valid(name))
1133                 GOTO(out, rc = -EINVAL);
1134
1135         if (hash == NULL) {
1136                 CERROR("Config nodemap hash is NULL, unable to add %s\n", name);
1137                 GOTO(out, rc = -EINVAL);
1138         }
1139
1140         OBD_ALLOC_PTR(nodemap);
1141         if (nodemap == NULL) {
1142                 CERROR("cannot allocate memory (%zu bytes) for nodemap '%s'\n",
1143                        sizeof(*nodemap), name);
1144                 GOTO(out, rc = -ENOMEM);
1145         }
1146
1147         /*
1148          * take an extra reference to prevent nodemap from being destroyed
1149          * while it's being created.
1150          */
1151         atomic_set(&nodemap->nm_refcount, 2);
1152         snprintf(nodemap->nm_name, sizeof(nodemap->nm_name), "%s", name);
1153         rc = cfs_hash_add_unique(hash, name, &nodemap->nm_hash);
1154         if (rc != 0) {
1155                 OBD_FREE_PTR(nodemap);
1156                 GOTO(out, rc = -EEXIST);
1157         }
1158
1159         INIT_LIST_HEAD(&nodemap->nm_ranges);
1160         INIT_LIST_HEAD(&nodemap->nm_list);
1161         INIT_LIST_HEAD(&nodemap->nm_member_list);
1162
1163         mutex_init(&nodemap->nm_member_list_lock);
1164         init_rwsem(&nodemap->nm_idmap_lock);
1165         nodemap->nm_fs_to_client_uidmap = RB_ROOT;
1166         nodemap->nm_client_to_fs_uidmap = RB_ROOT;
1167         nodemap->nm_fs_to_client_gidmap = RB_ROOT;
1168         nodemap->nm_client_to_fs_gidmap = RB_ROOT;
1169         nodemap->nm_fs_to_client_projidmap = RB_ROOT;
1170         nodemap->nm_client_to_fs_projidmap = RB_ROOT;
1171
1172         if (is_default) {
1173                 nodemap->nm_id = LUSTRE_NODEMAP_DEFAULT_ID;
1174                 config->nmc_default_nodemap = nodemap;
1175         } else {
1176                 config->nmc_nodemap_highest_id++;
1177                 nodemap->nm_id = config->nmc_nodemap_highest_id;
1178         }
1179
1180         if (is_default || default_nodemap == NULL) {
1181                 nodemap->nmf_trust_client_ids = 0;
1182                 nodemap->nmf_allow_root_access = 0;
1183                 nodemap->nmf_deny_unknown = 0;
1184                 nodemap->nmf_map_mode = NODEMAP_MAP_ALL;
1185                 nodemap->nmf_enable_audit = 1;
1186                 nodemap->nmf_forbid_encryption = 0;
1187
1188                 nodemap->nm_squash_uid = NODEMAP_NOBODY_UID;
1189                 nodemap->nm_squash_gid = NODEMAP_NOBODY_GID;
1190                 nodemap->nm_squash_projid = NODEMAP_NOBODY_PROJID;
1191                 nodemap->nm_fileset[0] = '\0';
1192                 nodemap->nm_sepol[0] = '\0';
1193                 if (!is_default)
1194                         CWARN("adding nodemap '%s' to config without"
1195                               " default nodemap\n", nodemap->nm_name);
1196         } else {
1197                 nodemap->nmf_trust_client_ids =
1198                                 default_nodemap->nmf_trust_client_ids;
1199                 nodemap->nmf_allow_root_access =
1200                                 default_nodemap->nmf_allow_root_access;
1201                 nodemap->nmf_deny_unknown = default_nodemap->nmf_deny_unknown;
1202                 nodemap->nmf_map_mode = default_nodemap->nmf_map_mode;
1203                 nodemap->nmf_enable_audit = default_nodemap->nmf_enable_audit;
1204                 nodemap->nmf_forbid_encryption =
1205                         default_nodemap->nmf_forbid_encryption;
1206
1207                 nodemap->nm_squash_uid = default_nodemap->nm_squash_uid;
1208                 nodemap->nm_squash_gid = default_nodemap->nm_squash_gid;
1209                 nodemap->nm_squash_projid = default_nodemap->nm_squash_projid;
1210                 nodemap->nm_fileset[0] = '\0';
1211                 nodemap->nm_sepol[0] = '\0';
1212         }
1213
1214         RETURN(nodemap);
1215
1216 out:
1217         CERROR("cannot add nodemap: '%s': rc = %d\n", name, rc);
1218         RETURN(ERR_PTR(rc));
1219 }
1220
1221 /**
1222  * Set the nmf_deny_unknown flag to true or false.
1223  * \param       name            nodemap name
1224  * \param       deny_unknown    if true, squashed users will get EACCES
1225  * \retval      0 on success
1226  *
1227  */
1228 int nodemap_set_deny_unknown(const char *name, bool deny_unknown)
1229 {
1230         struct lu_nodemap       *nodemap = NULL;
1231         int                     rc = 0;
1232
1233         mutex_lock(&active_config_lock);
1234         nodemap = nodemap_lookup(name);
1235         mutex_unlock(&active_config_lock);
1236         if (IS_ERR(nodemap))
1237                 GOTO(out, rc = PTR_ERR(nodemap));
1238
1239         nodemap->nmf_deny_unknown = deny_unknown;
1240         rc = nodemap_idx_nodemap_update(nodemap);
1241
1242         nm_member_revoke_locks(nodemap);
1243         nodemap_putref(nodemap);
1244 out:
1245         return rc;
1246 }
1247 EXPORT_SYMBOL(nodemap_set_deny_unknown);
1248
1249 /**
1250  * Set the nmf_allow_root_access flag to true or false.
1251  * \param       name            nodemap name
1252  * \param       allow_root      if true, nodemap will not squash the root user
1253  * \retval      0 on success
1254  *
1255  */
1256 int nodemap_set_allow_root(const char *name, bool allow_root)
1257 {
1258         struct lu_nodemap       *nodemap = NULL;
1259         int                     rc = 0;
1260
1261         mutex_lock(&active_config_lock);
1262         nodemap = nodemap_lookup(name);
1263         mutex_unlock(&active_config_lock);
1264         if (IS_ERR(nodemap))
1265                 GOTO(out, rc = PTR_ERR(nodemap));
1266
1267         nodemap->nmf_allow_root_access = allow_root;
1268         rc = nodemap_idx_nodemap_update(nodemap);
1269
1270         nm_member_revoke_locks(nodemap);
1271         nodemap_putref(nodemap);
1272 out:
1273         return rc;
1274 }
1275 EXPORT_SYMBOL(nodemap_set_allow_root);
1276
1277 /**
1278  * Set the nmf_trust_client_ids flag to true or false.
1279  *
1280  * \param       name                    nodemap name
1281  * \param       trust_client_ids        if true, nodemap will not map its IDs
1282  * \retval      0 on success
1283  *
1284  */
1285 int nodemap_set_trust_client_ids(const char *name, bool trust_client_ids)
1286 {
1287         struct lu_nodemap       *nodemap = NULL;
1288         int                     rc = 0;
1289
1290         mutex_lock(&active_config_lock);
1291         nodemap = nodemap_lookup(name);
1292         mutex_unlock(&active_config_lock);
1293         if (IS_ERR(nodemap))
1294                 GOTO(out, rc = PTR_ERR(nodemap));
1295
1296         nodemap->nmf_trust_client_ids = trust_client_ids;
1297         rc = nodemap_idx_nodemap_update(nodemap);
1298
1299         nm_member_revoke_locks(nodemap);
1300         nodemap_putref(nodemap);
1301 out:
1302         return rc;
1303 }
1304 EXPORT_SYMBOL(nodemap_set_trust_client_ids);
1305
1306 int nodemap_set_mapping_mode(const char *name,
1307                              enum nodemap_mapping_modes map_mode)
1308 {
1309         struct lu_nodemap       *nodemap = NULL;
1310         int                     rc = 0;
1311
1312         mutex_lock(&active_config_lock);
1313         nodemap = nodemap_lookup(name);
1314         mutex_unlock(&active_config_lock);
1315         if (IS_ERR(nodemap))
1316                 GOTO(out, rc = PTR_ERR(nodemap));
1317
1318         nodemap->nmf_map_mode = map_mode;
1319         rc = nodemap_idx_nodemap_update(nodemap);
1320
1321         nm_member_revoke_locks(nodemap);
1322         nodemap_putref(nodemap);
1323 out:
1324         return rc;
1325 }
1326 EXPORT_SYMBOL(nodemap_set_mapping_mode);
1327
1328 /**
1329  * Update the squash_uid for a nodemap.
1330  *
1331  * \param       name            nodemap name
1332  * \param       uid             the new uid to squash unknown users to
1333  * \retval      0 on success
1334  *
1335  * Update the squash_uid for a nodemap. The squash_uid is the uid
1336  * that the all client uids are mapped to if nodemap is active,
1337  * the trust_client_ids flag is not set, and the uid is not in
1338  * the idmap tree.
1339  */
1340 int nodemap_set_squash_uid(const char *name, uid_t uid)
1341 {
1342         struct lu_nodemap       *nodemap = NULL;
1343         int                     rc = 0;
1344
1345         mutex_lock(&active_config_lock);
1346         nodemap = nodemap_lookup(name);
1347         mutex_unlock(&active_config_lock);
1348         if (IS_ERR(nodemap))
1349                 GOTO(out, rc = PTR_ERR(nodemap));
1350
1351         nodemap->nm_squash_uid = uid;
1352         rc = nodemap_idx_nodemap_update(nodemap);
1353
1354         nm_member_revoke_locks(nodemap);
1355         nodemap_putref(nodemap);
1356 out:
1357         return rc;
1358 }
1359 EXPORT_SYMBOL(nodemap_set_squash_uid);
1360
1361 /**
1362  * Update the squash_gid for a nodemap.
1363  *
1364  * \param       name            nodemap name
1365  * \param       gid             the new gid to squash unknown gids to
1366  * \retval      0 on success
1367  *
1368  * Update the squash_gid for a nodemap. The squash_gid is the gid
1369  * that the all client gids are mapped to if nodemap is active,
1370  * the trust_client_ids flag is not set, and the gid is not in
1371  * the idmap tree.
1372  */
1373 int nodemap_set_squash_gid(const char *name, gid_t gid)
1374 {
1375         struct lu_nodemap       *nodemap = NULL;
1376         int                     rc = 0;
1377
1378         mutex_lock(&active_config_lock);
1379         nodemap = nodemap_lookup(name);
1380         mutex_unlock(&active_config_lock);
1381         if (IS_ERR(nodemap))
1382                 GOTO(out, rc = PTR_ERR(nodemap));
1383
1384         nodemap->nm_squash_gid = gid;
1385         rc = nodemap_idx_nodemap_update(nodemap);
1386
1387         nm_member_revoke_locks(nodemap);
1388         nodemap_putref(nodemap);
1389 out:
1390         return rc;
1391 }
1392 EXPORT_SYMBOL(nodemap_set_squash_gid);
1393
1394 /**
1395  * Update the squash_projid for a nodemap.
1396  *
1397  * \param       name            nodemap name
1398  * \param       gid             the new projid to squash unknown projids to
1399  * \retval      0 on success
1400  *
1401  * Update the squash_projid for a nodemap. The squash_projid is the projid
1402  * that the all client projids are mapped to if nodemap is active,
1403  * the trust_client_ids flag is not set, and the projid is not in
1404  * the idmap tree.
1405  */
1406 int nodemap_set_squash_projid(const char *name, projid_t projid)
1407 {
1408         struct lu_nodemap       *nodemap = NULL;
1409         int                     rc = 0;
1410
1411         mutex_lock(&active_config_lock);
1412         nodemap = nodemap_lookup(name);
1413         mutex_unlock(&active_config_lock);
1414         if (IS_ERR(nodemap))
1415                 GOTO(out, rc = PTR_ERR(nodemap));
1416
1417         nodemap->nm_squash_projid = projid;
1418         rc = nodemap_idx_nodemap_update(nodemap);
1419
1420         nm_member_revoke_locks(nodemap);
1421         nodemap_putref(nodemap);
1422 out:
1423         return rc;
1424 }
1425 EXPORT_SYMBOL(nodemap_set_squash_projid);
1426
1427 /**
1428  * Check if nodemap allows setting quota.
1429  *
1430  * If nodemap is not active, always allow.
1431  * For user and group quota, allow if the nodemap allows root access.
1432  * For project quota, allow if project id is not squashed or deny_unknown
1433  * is not set.
1434  *
1435  * \param       nodemap         nodemap to check access for
1436  * \param       qc_type         quota type
1437  * \param       id              client id to map
1438  * \retval      true is setquota is allowed, false otherwise
1439  */
1440 bool nodemap_can_setquota(struct lu_nodemap *nodemap, __u32 qc_type, __u32 id)
1441 {
1442         if (!nodemap_active)
1443                 return true;
1444
1445         if (!nodemap || !nodemap->nmf_allow_root_access)
1446                 return false;
1447
1448         if (qc_type == PRJQUOTA) {
1449                 id = nodemap_map_id(nodemap, NODEMAP_PROJID,
1450                                     NODEMAP_CLIENT_TO_FS, id);
1451
1452                 if (id == nodemap->nm_squash_projid &&
1453                     nodemap->nmf_deny_unknown)
1454                         return false;
1455         }
1456
1457         return true;
1458 }
1459 EXPORT_SYMBOL(nodemap_can_setquota);
1460
1461 /**
1462  * Set the nmf_enable_audit flag to true or false.
1463  * \param       name            nodemap name
1464  * \param       audit_mode      if true, allow audit
1465  * \retval      0 on success
1466  *
1467  */
1468 int nodemap_set_audit_mode(const char *name, bool enable_audit)
1469 {
1470         struct lu_nodemap       *nodemap = NULL;
1471         int                     rc = 0;
1472
1473         mutex_lock(&active_config_lock);
1474         nodemap = nodemap_lookup(name);
1475         mutex_unlock(&active_config_lock);
1476         if (IS_ERR(nodemap))
1477                 GOTO(out, rc = PTR_ERR(nodemap));
1478
1479         nodemap->nmf_enable_audit = enable_audit;
1480         rc = nodemap_idx_nodemap_update(nodemap);
1481
1482         nm_member_revoke_locks(nodemap);
1483         nodemap_putref(nodemap);
1484 out:
1485         return rc;
1486 }
1487 EXPORT_SYMBOL(nodemap_set_audit_mode);
1488
1489 /**
1490  * Set the nmf_forbid_encryption flag to true or false.
1491  * \param       name                    nodemap name
1492  * \param       forbid_encryption       if true, forbid encryption
1493  * \retval      0 on success
1494  *
1495  */
1496 int nodemap_set_forbid_encryption(const char *name, bool forbid_encryption)
1497 {
1498         struct lu_nodemap       *nodemap = NULL;
1499         int                     rc = 0;
1500
1501         mutex_lock(&active_config_lock);
1502         nodemap = nodemap_lookup(name);
1503         mutex_unlock(&active_config_lock);
1504         if (IS_ERR(nodemap))
1505                 GOTO(out, rc = PTR_ERR(nodemap));
1506
1507         nodemap->nmf_forbid_encryption = forbid_encryption;
1508         rc = nodemap_idx_nodemap_update(nodemap);
1509
1510         nm_member_revoke_locks(nodemap);
1511         nodemap_putref(nodemap);
1512 out:
1513         return rc;
1514 }
1515 EXPORT_SYMBOL(nodemap_set_forbid_encryption);
1516
1517
1518 /**
1519  * Add a nodemap
1520  *
1521  * \param       name            name of nodemap
1522  * \retval      0               success
1523  * \retval      -EINVAL         invalid nodemap name
1524  * \retval      -EEXIST         nodemap already exists
1525  * \retval      -ENOMEM         cannot allocate memory for nodemap
1526  */
1527 int nodemap_add(const char *nodemap_name)
1528 {
1529         struct lu_nodemap *nodemap;
1530         int rc;
1531
1532         mutex_lock(&active_config_lock);
1533         nodemap = nodemap_create(nodemap_name, active_config, 0);
1534         if (IS_ERR(nodemap)) {
1535                 mutex_unlock(&active_config_lock);
1536                 return PTR_ERR(nodemap);
1537         }
1538
1539         rc = nodemap_idx_nodemap_add(nodemap);
1540         if (rc == 0)
1541                 rc = lprocfs_nodemap_register(nodemap, 0);
1542
1543         mutex_unlock(&active_config_lock);
1544         nodemap_putref(nodemap);
1545
1546         return rc;
1547 }
1548 EXPORT_SYMBOL(nodemap_add);
1549
1550 /**
1551  * Delete a nodemap
1552  *
1553  * \param       name            name of nodemmap
1554  * \retval      0               success
1555  * \retval      -EINVAL         invalid input
1556  * \retval      -ENOENT         no existing nodemap
1557  */
1558 int nodemap_del(const char *nodemap_name)
1559 {
1560         struct lu_nodemap       *nodemap;
1561         struct lu_nid_range     *range;
1562         struct lu_nid_range     *range_temp;
1563         int                      rc = 0;
1564         int                      rc2 = 0;
1565
1566         if (strcmp(nodemap_name, DEFAULT_NODEMAP) == 0)
1567                 RETURN(-EINVAL);
1568
1569         mutex_lock(&active_config_lock);
1570         nodemap = cfs_hash_del_key(active_config->nmc_nodemap_hash,
1571                                    nodemap_name);
1572         if (nodemap == NULL) {
1573                 mutex_unlock(&active_config_lock);
1574                 GOTO(out, rc = -ENOENT);
1575         }
1576
1577         /* erase nodemap from active ranges to prevent client assignment */
1578         down_write(&active_config->nmc_range_tree_lock);
1579         list_for_each_entry_safe(range, range_temp, &nodemap->nm_ranges,
1580                                  rn_list) {
1581                 rc2 = nodemap_idx_range_del(range);
1582                 if (rc2 < 0)
1583                         rc = rc2;
1584
1585                 range_delete(&active_config->nmc_range_tree, range);
1586         }
1587         up_write(&active_config->nmc_range_tree_lock);
1588
1589         rc2 = nodemap_idx_nodemap_del(nodemap);
1590         if (rc2 < 0)
1591                 rc = rc2;
1592
1593         /*
1594          * remove procfs here in case nodemap_create called with same name
1595          * before nodemap_destroy is run.
1596          */
1597         lprocfs_nodemap_remove(nodemap->nm_pde_data);
1598         nodemap->nm_pde_data = NULL;
1599
1600         /* reclassify all member exports from nodemap, so they put their refs */
1601         down_read(&active_config->nmc_range_tree_lock);
1602         nm_member_reclassify_nodemap(nodemap);
1603         up_read(&active_config->nmc_range_tree_lock);
1604
1605         if (!list_empty(&nodemap->nm_member_list))
1606                 CWARN("nodemap_del failed to reclassify all members\n");
1607
1608         mutex_unlock(&active_config_lock);
1609
1610         nodemap_putref(nodemap);
1611
1612 out:
1613         return rc;
1614 }
1615 EXPORT_SYMBOL(nodemap_del);
1616
1617 /**
1618  * activate nodemap functions
1619  *
1620  * \param       value           1 for on, 0 for off
1621  */
1622 void nodemap_activate(const bool value)
1623 {
1624         mutex_lock(&active_config_lock);
1625         active_config->nmc_nodemap_is_active = value;
1626
1627         /* copy active value to global to avoid locking in map functions */
1628         nodemap_active = value;
1629         nodemap_idx_nodemap_activate(value);
1630         mutex_unlock(&active_config_lock);
1631         nm_member_revoke_all();
1632 }
1633 EXPORT_SYMBOL(nodemap_activate);
1634
1635 /**
1636  * Helper iterator to convert nodemap hash to list.
1637  *
1638  * \param       hs                      hash structure
1639  * \param       bd                      bucket descriptor
1640  * \param       hnode                   hash node
1641  * \param       nodemap_list_head       list head for list of nodemaps in hash
1642  */
1643 static int nodemap_cleanup_iter_cb(struct cfs_hash *hs, struct cfs_hash_bd *bd,
1644                                    struct hlist_node *hnode,
1645                                    void *nodemap_list_head)
1646 {
1647         struct lu_nodemap *nodemap;
1648
1649         nodemap = hlist_entry(hnode, struct lu_nodemap, nm_hash);
1650         list_add(&nodemap->nm_list, nodemap_list_head);
1651
1652         cfs_hash_bd_del_locked(hs, bd, hnode);
1653
1654         return 0;
1655 }
1656
1657 struct nodemap_config *nodemap_config_alloc(void)
1658 {
1659         struct nodemap_config *config;
1660         int rc = 0;
1661
1662         OBD_ALLOC_PTR(config);
1663         if (config == NULL)
1664                 return ERR_PTR(-ENOMEM);
1665
1666         rc = nodemap_init_hash(config);
1667         if (rc != 0) {
1668                 OBD_FREE_PTR(config);
1669                 return ERR_PTR(rc);
1670         }
1671
1672         init_rwsem(&config->nmc_range_tree_lock);
1673
1674         config->nmc_range_tree.nmrt_range_interval_root = INTERVAL_TREE_ROOT;
1675
1676         return config;
1677 }
1678 EXPORT_SYMBOL(nodemap_config_alloc);
1679
1680 /**
1681  * Walk the nodemap_hash and remove all nodemaps.
1682  */
1683 void nodemap_config_dealloc(struct nodemap_config *config)
1684 {
1685         struct lu_nodemap       *nodemap = NULL;
1686         struct lu_nodemap       *nodemap_temp;
1687         struct lu_nid_range     *range;
1688         struct lu_nid_range     *range_temp;
1689         LIST_HEAD(nodemap_list_head);
1690
1691         cfs_hash_for_each_safe(config->nmc_nodemap_hash,
1692                                nodemap_cleanup_iter_cb, &nodemap_list_head);
1693         cfs_hash_putref(config->nmc_nodemap_hash);
1694
1695         /* Because nodemap_destroy might sleep, we can't destroy them
1696          * in cfs_hash_for_each, so we build a list there and destroy here
1697          */
1698         list_for_each_entry_safe(nodemap, nodemap_temp, &nodemap_list_head,
1699                                  nm_list) {
1700                 mutex_lock(&active_config_lock);
1701                 down_write(&config->nmc_range_tree_lock);
1702
1703                 /* move members to new config, requires ac lock */
1704                 nm_member_reclassify_nodemap(nodemap);
1705                 list_for_each_entry_safe(range, range_temp, &nodemap->nm_ranges,
1706                                          rn_list)
1707                         range_delete(&config->nmc_range_tree, range);
1708                 up_write(&config->nmc_range_tree_lock);
1709                 mutex_unlock(&active_config_lock);
1710
1711                 /* putref must be outside of ac lock if nm could be destroyed */
1712                 nodemap_putref(nodemap);
1713         }
1714         OBD_FREE_PTR(config);
1715 }
1716 EXPORT_SYMBOL(nodemap_config_dealloc);
1717
1718 /*
1719  * callback for cfs_hash_for_each_safe used to convert a nodemap hash to a
1720  * nodemap list, generally for locking purposes as a hash cb can't sleep.
1721  */
1722 int nm_hash_list_cb(struct cfs_hash *hs, struct cfs_hash_bd *bd,
1723                     struct hlist_node *hnode,
1724                     void *nodemap_list_head)
1725 {
1726         struct lu_nodemap *nodemap;
1727
1728         nodemap = hlist_entry(hnode, struct lu_nodemap, nm_hash);
1729         list_add(&nodemap->nm_list, nodemap_list_head);
1730         return 0;
1731 }
1732
1733 void nodemap_config_set_active(struct nodemap_config *config)
1734 {
1735         struct nodemap_config   *old_config = active_config;
1736         struct lu_nodemap       *nodemap;
1737         struct lu_nodemap       *tmp;
1738         bool revoke_locks;
1739         LIST_HEAD(nodemap_list_head);
1740
1741         ENTRY;
1742
1743         LASSERT(active_config != config);
1744         LASSERT(config->nmc_default_nodemap);
1745
1746         mutex_lock(&active_config_lock);
1747
1748         /* move proc entries from already existing nms, create for new nms */
1749         cfs_hash_for_each_safe(config->nmc_nodemap_hash,
1750                                nm_hash_list_cb, &nodemap_list_head);
1751         list_for_each_entry_safe(nodemap, tmp, &nodemap_list_head, nm_list) {
1752                 struct lu_nodemap *old_nm = NULL;
1753
1754                 if (active_config != NULL)
1755                         old_nm = cfs_hash_lookup(
1756                                         active_config->nmc_nodemap_hash,
1757                                         nodemap->nm_name);
1758                 if (old_nm != NULL) {
1759                         nodemap->nm_pde_data = old_nm->nm_pde_data;
1760                         old_nm->nm_pde_data = NULL;
1761                         nodemap_putref(old_nm);
1762                 } else {
1763                         bool is_def = (nodemap == config->nmc_default_nodemap);
1764
1765                         lprocfs_nodemap_register(nodemap, is_def);
1766                 }
1767         }
1768
1769         /*
1770          * We only need to revoke locks if old nodemap was active, and new
1771          * config is now nodemap inactive. nodemap_config_dealloc will
1772          * reclassify exports, triggering a lock revoke if and only if new
1773          * nodemap is active.
1774          */
1775         revoke_locks = !config->nmc_nodemap_is_active && nodemap_active;
1776
1777         /* if new config is inactive, deactivate live config before switching */
1778         if (!config->nmc_nodemap_is_active)
1779                 nodemap_active = false;
1780         active_config = config;
1781         if (config->nmc_nodemap_is_active)
1782                 nodemap_active = true;
1783
1784         mutex_unlock(&active_config_lock);
1785
1786         if (old_config != NULL)
1787                 nodemap_config_dealloc(old_config);
1788
1789         if (revoke_locks)
1790                 nm_member_revoke_all();
1791
1792         EXIT;
1793 }
1794
1795 /**
1796  * Cleanup nodemap module on exit
1797  */
1798 void nodemap_mod_exit(void)
1799 {
1800         nodemap_config_dealloc(active_config);
1801         nodemap_procfs_exit();
1802 }
1803
1804 /**
1805  * Initialize the nodemap module
1806  */
1807 int nodemap_mod_init(void)
1808 {
1809         struct nodemap_config   *new_config;
1810         struct lu_nodemap       *nodemap;
1811         int                      rc = 0;
1812
1813         rc = nodemap_procfs_init();
1814         if (rc != 0)
1815                 return rc;
1816
1817         new_config = nodemap_config_alloc();
1818         if (IS_ERR(new_config)) {
1819                 nodemap_procfs_exit();
1820                 GOTO(out, rc = PTR_ERR(new_config));
1821         }
1822
1823         nodemap = nodemap_create(DEFAULT_NODEMAP, new_config, 1);
1824         if (IS_ERR(nodemap)) {
1825                 nodemap_config_dealloc(new_config);
1826                 nodemap_procfs_exit();
1827                 GOTO(out, rc = PTR_ERR(nodemap));
1828         }
1829
1830         nodemap_config_set_active(new_config);
1831         nodemap_putref(nodemap);
1832
1833 out:
1834         return rc;
1835 }
1836
1837 /**
1838  * Revoke locks for all nodemaps.
1839  */
1840 void nm_member_revoke_all(void)
1841 {
1842         struct lu_nodemap *nodemap;
1843         struct lu_nodemap *tmp;
1844         LIST_HEAD(nodemap_list_head);
1845
1846         mutex_lock(&active_config_lock);
1847         cfs_hash_for_each_safe(active_config->nmc_nodemap_hash,
1848                                nm_hash_list_cb, &nodemap_list_head);
1849
1850         /* revoke_locks sleeps, so can't call in cfs hash cb */
1851         list_for_each_entry_safe(nodemap, tmp, &nodemap_list_head, nm_list)
1852                 nm_member_revoke_locks_always(nodemap);
1853         mutex_unlock(&active_config_lock);
1854 }
1855
1856 /**
1857  * Returns the nodemap classification for a given nid into an ioctl buffer.
1858  * Useful for testing the nodemap configuration to make sure it is working as
1859  * expected.
1860  *
1861  * \param       nid             nid to classify
1862  * \param[out]  name_buf        buffer to write the nodemap name to
1863  * \param       name_len        length of buffer
1864  */
1865 void nodemap_test_nid(lnet_nid_t nid, char *name_buf, size_t name_len)
1866 {
1867         struct lu_nodemap       *nodemap;
1868
1869         mutex_lock(&active_config_lock);
1870         down_read(&active_config->nmc_range_tree_lock);
1871         nodemap = nodemap_classify_nid(nid);
1872         up_read(&active_config->nmc_range_tree_lock);
1873         mutex_unlock(&active_config_lock);
1874
1875         if (IS_ERR(nodemap))
1876                 return;
1877
1878         strncpy(name_buf, nodemap->nm_name, name_len);
1879         if (name_len > 0)
1880                 name_buf[name_len - 1] = '\0';
1881
1882         nodemap_putref(nodemap);
1883 }
1884 EXPORT_SYMBOL(nodemap_test_nid);
1885
1886 /**
1887  * Passes back the id mapping for a given nid/id pair. Useful for testing the
1888  * nodemap configuration to make sure it is working as expected.
1889  *
1890  * \param       nid             nid to classify
1891  * \param       idtype          uid or gid
1892  * \param       client_id       id to map to fs
1893  * \param       fs_id_buf       pointer to save mapped fs_id to
1894  *
1895  * \retval      0       success
1896  * \retval      -EINVAL invalid NID
1897  */
1898 int nodemap_test_id(lnet_nid_t nid, enum nodemap_id_type idtype,
1899                     __u32 client_id, __u32 *fs_id)
1900 {
1901         struct lu_nodemap       *nodemap;
1902
1903         mutex_lock(&active_config_lock);
1904         down_read(&active_config->nmc_range_tree_lock);
1905         nodemap = nodemap_classify_nid(nid);
1906         up_read(&active_config->nmc_range_tree_lock);
1907         mutex_unlock(&active_config_lock);
1908
1909         if (IS_ERR(nodemap))
1910                 return PTR_ERR(nodemap);
1911
1912         *fs_id = nodemap_map_id(nodemap, idtype, NODEMAP_CLIENT_TO_FS,
1913                                client_id);
1914         nodemap_putref(nodemap);
1915
1916         return 0;
1917 }
1918 EXPORT_SYMBOL(nodemap_test_id);