4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 only,
8 * as published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License version 2 for more details (a copy is included
14 * in the LICENSE file that accompanied this code).
16 * You should have received a copy of the GNU General Public License
17 * version 2 along with this program; If not, see
18 * http://www.gnu.org/licenses/gpl-2.0.html
23 * Copyright (C) 2013, Trustees of Indiana University
25 * Copyright (c) 2014, 2017, Intel Corporation.
27 * Author: Joshua Walgenbach <jjw@iu.edu>
30 #define NODEMAP_LPROC_ID_LEN 16
31 #define NODEMAP_LPROC_FLAG_LEN 2
33 #include <lprocfs_status.h>
34 #include <lustre_net.h>
35 #include <lustre_export.h>
36 #include <obd_class.h>
37 #include <interval_tree.h>
38 #include "nodemap_internal.h"
40 static LIST_HEAD(nodemap_pde_list);
43 * Reads and prints the idmap for the given nodemap.
45 * \param m seq file in proc fs
49 static int nodemap_idmap_show(struct seq_file *m, void *data)
51 struct lu_nodemap *nodemap;
52 struct lu_idmap *idmap;
57 mutex_lock(&active_config_lock);
58 nodemap = nodemap_lookup(m->private);
59 mutex_unlock(&active_config_lock);
60 if (IS_ERR(nodemap)) {
61 rc = PTR_ERR(nodemap);
62 CERROR("cannot find nodemap '%s': rc = %d\n",
63 (char *)m->private, rc);
68 down_read(&nodemap->nm_idmap_lock);
69 for (node = rb_first(&nodemap->nm_client_to_fs_uidmap); node;
70 node = rb_next(node)) {
74 idmap = rb_entry(node, struct lu_idmap, id_client_to_fs);
76 seq_printf(m, " { idtype: uid, client_id: %u, "
77 "fs_id: %u }", idmap->id_client,
80 for (node = rb_first(&nodemap->nm_client_to_fs_gidmap);
81 node; node = rb_next(node)) {
84 idmap = rb_entry(node, struct lu_idmap, id_client_to_fs);
86 seq_printf(m, " { idtype: gid, client_id: %u, "
87 "fs_id: %u }", idmap->id_client,
90 up_read(&nodemap->nm_idmap_lock);
94 nodemap_putref(nodemap);
99 * Attaches nodemap_idmap_show to proc file.
101 * \param inode inode of seq file in proc fs
102 * \param file seq file
105 static int nodemap_idmap_open(struct inode *inode, struct file *file)
107 return single_open(file, nodemap_idmap_show, PDE_DATA(inode));
111 * Reads and prints the NID ranges for the given nodemap.
113 * \param m seq file in proc fs
117 static int nodemap_ranges_show(struct seq_file *m, void *data)
119 struct lu_nodemap *nodemap;
120 struct lu_nid_range *range;
121 struct interval_node_extent ext;
122 char start_nidstr[LNET_NIDSTR_SIZE];
123 char end_nidstr[LNET_NIDSTR_SIZE];
127 mutex_lock(&active_config_lock);
128 nodemap = nodemap_lookup(m->private);
129 if (IS_ERR(nodemap)) {
130 mutex_unlock(&active_config_lock);
131 rc = PTR_ERR(nodemap);
132 CERROR("cannot find nodemap '%s': rc = %d\n",
133 (char *)m->private, rc);
137 seq_printf(m, "[\n");
138 down_read(&active_config->nmc_range_tree_lock);
139 list_for_each_entry(range, &nodemap->nm_ranges, rn_list) {
141 seq_printf(m, ",\n");
143 ext = range->rn_node.in_extent;
144 libcfs_nid2str_r(ext.start, start_nidstr, sizeof(start_nidstr));
145 libcfs_nid2str_r(ext.end, end_nidstr, sizeof(end_nidstr));
146 seq_printf(m, " { id: %u, start_nid: %s, end_nid: %s }",
147 range->rn_id, start_nidstr, end_nidstr);
149 up_read(&active_config->nmc_range_tree_lock);
150 mutex_unlock(&active_config_lock);
152 seq_printf(m, "]\n");
154 nodemap_putref(nodemap);
159 * Connects nodemap_idmap_show to proc file.
161 * \param inode inode of seq file in proc fs
162 * \param file seq file
165 static int nodemap_ranges_open(struct inode *inode, struct file *file)
167 return single_open(file, nodemap_ranges_show, PDE_DATA(inode));
171 * Reads and prints the fileset for the given nodemap.
173 * \param m seq file in proc fs
177 static int nodemap_fileset_seq_show(struct seq_file *m, void *data)
179 struct lu_nodemap *nodemap;
182 mutex_lock(&active_config_lock);
183 nodemap = nodemap_lookup(m->private);
184 mutex_unlock(&active_config_lock);
185 if (IS_ERR(nodemap)) {
186 rc = PTR_ERR(nodemap);
187 CERROR("cannot find nodemap '%s': rc = %d\n",
188 (char *)m->private, rc);
192 seq_printf(m, "%s\n", nodemap->nm_fileset);
193 nodemap_putref(nodemap);
198 * Set a fileset on a nodemap.
200 * \param[in] file proc file
201 * \param[in] buffer string, "<fileset>"
202 * \param[in] count \a buffer length
203 * \param[in] off unused
204 * \retval \a count on success
205 * \retval negative number on error
208 nodemap_fileset_seq_write(struct file *file,
209 const char __user *buffer,
210 size_t count, loff_t *off)
212 struct seq_file *m = file->private_data;
220 if (count > PATH_MAX)
223 OBD_ALLOC(nm_fileset, count + 1);
224 /* OBD_ALLOC zero-fills the buffer */
225 if (nm_fileset == NULL)
228 if (copy_from_user(nm_fileset, buffer, count))
229 GOTO(out, rc = -EFAULT);
231 rc = nodemap_set_fileset(m->private, nm_fileset);
233 GOTO(out, rc = -EINVAL);
237 OBD_FREE(nm_fileset, count + 1);
241 LPROC_SEQ_FOPS(nodemap_fileset);
244 * Reads and prints the exports attached to the given nodemap.
246 * \param m seq file in proc fs, stores nodemap
250 static int nodemap_exports_show(struct seq_file *m, void *data)
252 struct lu_nodemap *nodemap;
253 struct obd_export *exp;
254 char nidstr[LNET_NIDSTR_SIZE] = "<unknown>";
257 mutex_lock(&active_config_lock);
258 nodemap = nodemap_lookup(m->private);
259 mutex_unlock(&active_config_lock);
260 if (IS_ERR(nodemap)) {
261 rc = PTR_ERR(nodemap);
262 CERROR("cannot find nodemap '%s': rc = %d\n",
263 (char *)m->private, rc);
267 seq_printf(m, "[\n");
269 mutex_lock(&nodemap->nm_member_list_lock);
270 list_for_each_entry(exp, &nodemap->nm_member_list,
271 exp_target_data.ted_nodemap_member) {
272 if (exp->exp_connection != NULL)
273 libcfs_nid2str_r(exp->exp_connection->c_peer.nid,
274 nidstr, sizeof(nidstr));
276 seq_printf(m, " { nid: %s, uuid: %s },",
277 nidstr, exp->exp_client_uuid.uuid);
279 mutex_unlock(&nodemap->nm_member_list_lock);
282 seq_printf(m, "]\n");
284 nodemap_putref(nodemap);
289 * Attaches nodemap_idmap_show to proc file.
291 * \param inode inode of seq file in proc fs
292 * \param file seq file
295 static int nodemap_exports_open(struct inode *inode, struct file *file)
297 return single_open(file, nodemap_exports_show, PDE_DATA(inode));
301 * Reads and prints the active flag for the given nodemap.
303 * \param m seq file in proc fs
307 static int nodemap_active_seq_show(struct seq_file *m, void *data)
309 seq_printf(m, "%u\n", (unsigned int)nodemap_active);
314 * Activate/deactivate nodemap.
316 * \param[in] file proc file
317 * \param[in] buffer string, "1" or "0" to activate/deactivate nodemap
318 * \param[in] count \a buffer length
319 * \param[in] off unused
320 * \retval \a count on success
321 * \retval negative number on error
324 nodemap_active_seq_write(struct file *file, const char __user *buffer,
325 size_t count, loff_t *off)
327 char active_string[NODEMAP_LPROC_FLAG_LEN + 1];
328 long unsigned int active;
334 if (count >= sizeof(active_string))
337 if (copy_from_user(active_string, buffer, count))
340 active_string[count] = '\0';
341 rc = kstrtoul(active_string, 10, &active);
345 nodemap_activate(active);
349 LPROC_SEQ_FOPS(nodemap_active);
352 * Reads and prints the nodemap ID for the given nodemap.
354 * \param m seq file in proc fs
358 static int nodemap_id_seq_show(struct seq_file *m, void *data)
360 struct lu_nodemap *nodemap;
362 mutex_lock(&active_config_lock);
363 nodemap = nodemap_lookup(m->private);
364 mutex_unlock(&active_config_lock);
365 if (IS_ERR(nodemap)) {
366 int rc = PTR_ERR(nodemap);
367 CERROR("cannot find nodemap '%s': rc = %d\n",
368 (char *)m->private, rc);
372 seq_printf(m, "%u\n", nodemap->nm_id);
373 nodemap_putref(nodemap);
376 LPROC_SEQ_FOPS_RO(nodemap_id);
379 * Reads and prints the root squash UID for the given nodemap.
381 * \param m seq file in proc fs
385 static int nodemap_squash_uid_seq_show(struct seq_file *m, void *data)
387 struct lu_nodemap *nodemap;
389 mutex_lock(&active_config_lock);
390 nodemap = nodemap_lookup(m->private);
391 mutex_unlock(&active_config_lock);
392 if (IS_ERR(nodemap)) {
393 int rc = PTR_ERR(nodemap);
394 CERROR("cannot find nodemap '%s': rc = %d\n",
395 (char *)m->private, rc);
399 seq_printf(m, "%u\n", nodemap->nm_squash_uid);
400 nodemap_putref(nodemap);
405 * Reads and prints the root squash GID for the given nodemap.
407 * \param m seq file in proc fs
411 static int nodemap_squash_gid_seq_show(struct seq_file *m, void *data)
413 struct lu_nodemap *nodemap;
415 mutex_lock(&active_config_lock);
416 nodemap = nodemap_lookup(m->private);
417 mutex_unlock(&active_config_lock);
418 if (IS_ERR(nodemap)) {
419 int rc = PTR_ERR(nodemap);
420 CERROR("cannot find nodemap '%s': rc = %d\n",
421 (char *)m->private, rc);
425 seq_printf(m, "%u\n", nodemap->nm_squash_gid);
426 nodemap_putref(nodemap);
431 * Reads and prints the trusted flag for the given nodemap.
433 * \param m seq file in proc fs
437 static int nodemap_trusted_seq_show(struct seq_file *m, void *data)
439 struct lu_nodemap *nodemap;
441 mutex_lock(&active_config_lock);
442 nodemap = nodemap_lookup(m->private);
443 mutex_unlock(&active_config_lock);
444 if (IS_ERR(nodemap)) {
445 int rc = PTR_ERR(nodemap);
447 CERROR("cannot find nodemap '%s': rc = %d\n",
448 (char *)m->private, rc);
452 seq_printf(m, "%d\n", (int)nodemap->nmf_trust_client_ids);
453 nodemap_putref(nodemap);
458 * Reads and prints the admin flag for the given nodemap.
460 * \param m seq file in proc fs
464 static int nodemap_admin_seq_show(struct seq_file *m, void *data)
466 struct lu_nodemap *nodemap;
469 mutex_lock(&active_config_lock);
470 nodemap = nodemap_lookup(m->private);
471 mutex_unlock(&active_config_lock);
472 if (IS_ERR(nodemap)) {
473 rc = PTR_ERR(nodemap);
474 CERROR("cannot find nodemap '%s': rc = %d\n",
475 (char *)m->private, rc);
479 seq_printf(m, "%d\n", (int)nodemap->nmf_allow_root_access);
480 nodemap_putref(nodemap);
485 * Reads and prints the mapping mode for the given nodemap.
487 * \param m seq file in proc fs
491 static int nodemap_map_mode_seq_show(struct seq_file *m, void *data)
493 struct lu_nodemap *nodemap;
496 mutex_lock(&active_config_lock);
497 nodemap = nodemap_lookup(m->private);
498 mutex_unlock(&active_config_lock);
499 if (IS_ERR(nodemap)) {
500 rc = PTR_ERR(nodemap);
501 CERROR("cannot find nodemap '%s': rc = %d\n",
502 (char *)m->private, rc);
506 if (nodemap->nmf_map_uid_only)
507 seq_printf(m, "uid_only\n");
508 else if (nodemap->nmf_map_gid_only)
509 seq_printf(m, "gid_only\n");
511 seq_printf(m, "both\n");
513 nodemap_putref(nodemap);
518 * Reads and prints the deny_unknown flag for the given nodemap.
520 * \param m seq file in proc fs
524 static int nodemap_deny_unknown_seq_show(struct seq_file *m, void *data)
526 struct lu_nodemap *nodemap;
529 mutex_lock(&active_config_lock);
530 nodemap = nodemap_lookup(m->private);
531 mutex_unlock(&active_config_lock);
532 if (IS_ERR(nodemap)) {
533 rc = PTR_ERR(nodemap);
534 CERROR("cannot find nodemap '%s': rc = %d\n",
535 (char *)m->private, rc);
539 seq_printf(m, "%d\n", (int)nodemap->nmf_deny_unknown);
540 nodemap_putref(nodemap);
545 * Reads and prints the audit_mode flag for the given nodemap.
547 * \param m seq file in proc fs
551 static int nodemap_audit_mode_seq_show(struct seq_file *m, void *data)
553 struct lu_nodemap *nodemap;
556 mutex_lock(&active_config_lock);
557 nodemap = nodemap_lookup(m->private);
558 mutex_unlock(&active_config_lock);
559 if (IS_ERR(nodemap)) {
560 rc = PTR_ERR(nodemap);
561 CERROR("cannot find nodemap '%s': rc = %d\n",
562 (char *)m->private, rc);
566 seq_printf(m, "%d\n", (int)nodemap->nmf_enable_audit);
567 nodemap_putref(nodemap);
571 static struct lprocfs_vars lprocfs_nm_module_vars[] = {
574 .fops = &nodemap_active_fops,
581 LPROC_SEQ_FOPS_RO(nodemap_trusted);
582 LPROC_SEQ_FOPS_RO(nodemap_admin);
583 LPROC_SEQ_FOPS_RO(nodemap_squash_uid);
584 LPROC_SEQ_FOPS_RO(nodemap_squash_gid);
586 LPROC_SEQ_FOPS_RO(nodemap_deny_unknown);
587 LPROC_SEQ_FOPS_RO(nodemap_map_mode);
588 LPROC_SEQ_FOPS_RO(nodemap_audit_mode);
590 const struct file_operations nodemap_ranges_fops = {
591 .open = nodemap_ranges_open,
594 .release = single_release
597 const struct file_operations nodemap_idmap_fops = {
598 .open = nodemap_idmap_open,
601 .release = single_release
604 const struct file_operations nodemap_exports_fops = {
605 .open = nodemap_exports_open,
608 .release = single_release
611 static struct lprocfs_vars lprocfs_nodemap_vars[] = {
614 .fops = &nodemap_id_fops,
617 .name = "trusted_nodemap",
618 .fops = &nodemap_trusted_fops,
621 .name = "admin_nodemap",
622 .fops = &nodemap_admin_fops,
625 .name = "deny_unknown",
626 .fops = &nodemap_deny_unknown_fops,
630 .fops = &nodemap_map_mode_fops,
633 .name = "audit_mode",
634 .fops = &nodemap_audit_mode_fops,
637 .name = "squash_uid",
638 .fops = &nodemap_squash_uid_fops,
641 .name = "squash_gid",
642 .fops = &nodemap_squash_gid_fops,
646 .fops = &nodemap_ranges_fops,
650 .fops = &nodemap_fileset_fops,
654 .fops = &nodemap_exports_fops,
658 .fops = &nodemap_idmap_fops,
665 static struct lprocfs_vars lprocfs_default_nodemap_vars[] = {
668 .fops = &nodemap_id_fops,
671 .name = "trusted_nodemap",
672 .fops = &nodemap_trusted_fops,
675 .name = "admin_nodemap",
676 .fops = &nodemap_admin_fops,
679 .name = "squash_uid",
680 .fops = &nodemap_squash_uid_fops,
683 .name = "squash_gid",
684 .fops = &nodemap_squash_gid_fops,
688 .fops = &nodemap_fileset_fops,
692 .fops = &nodemap_exports_fops,
695 .name = "audit_mode",
696 .fops = &nodemap_audit_mode_fops,
704 * Initialize the nodemap procfs directory.
708 int nodemap_procfs_init(void)
712 proc_lustre_nodemap_root = lprocfs_register(LUSTRE_NODEMAP_NAME,
714 lprocfs_nm_module_vars,
716 if (IS_ERR(proc_lustre_nodemap_root)) {
717 rc = PTR_ERR(proc_lustre_nodemap_root);
718 CERROR("cannot create 'nodemap' directory: rc = %d\n",
720 proc_lustre_nodemap_root = NULL;
726 * Cleanup nodemap proc entry data structures.
728 void nodemap_procfs_exit(void)
730 struct nodemap_pde *nm_pde;
731 struct nodemap_pde *tmp;
733 lprocfs_remove(&proc_lustre_nodemap_root);
734 list_for_each_entry_safe(nm_pde, tmp, &nodemap_pde_list,
736 list_del(&nm_pde->npe_list_member);
737 OBD_FREE_PTR(nm_pde);
742 * Remove a nodemap's procfs entry and related data.
744 void lprocfs_nodemap_remove(struct nodemap_pde *nm_pde)
746 lprocfs_remove(&nm_pde->npe_proc_entry);
747 list_del(&nm_pde->npe_list_member);
748 OBD_FREE_PTR(nm_pde);
752 * Register the proc directory for a nodemap
754 * \param nodemap nodemap to make the proc dir for
755 * \param is_default: 1 if default nodemap
758 int lprocfs_nodemap_register(struct lu_nodemap *nodemap, bool is_default)
760 struct nodemap_pde *nm_entry;
763 OBD_ALLOC_PTR(nm_entry);
764 if (nm_entry == NULL)
765 GOTO(out, rc = -ENOMEM);
767 nm_entry->npe_proc_entry = proc_mkdir(nodemap->nm_name,
768 proc_lustre_nodemap_root);
769 if (IS_ERR(nm_entry->npe_proc_entry))
770 GOTO(out, rc = PTR_ERR(nm_entry->npe_proc_entry));
772 snprintf(nm_entry->npe_name, sizeof(nm_entry->npe_name), "%s",
775 /* Use the nodemap name as stored on the PDE as the private data. This
776 * is so a nodemap struct can be replaced without updating the proc
779 rc = lprocfs_add_vars(nm_entry->npe_proc_entry,
780 (is_default ? lprocfs_default_nodemap_vars :
781 lprocfs_nodemap_vars),
784 lprocfs_remove(&nm_entry->npe_proc_entry);
786 list_add(&nm_entry->npe_list_member, &nodemap_pde_list);
790 CERROR("cannot create 'nodemap/%s': rc = %d\n",
791 nodemap->nm_name, rc);
792 if (nm_entry != NULL) {
793 OBD_FREE_PTR(nm_entry);
798 nodemap->nm_pde_data = nm_entry;