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 SELinux policy info for the given nodemap.
246 * \param m seq file in proc fs
250 static int nodemap_sepol_seq_show(struct seq_file *m, void *data)
252 struct lu_nodemap *nodemap;
255 mutex_lock(&active_config_lock);
256 nodemap = nodemap_lookup(m->private);
257 mutex_unlock(&active_config_lock);
258 if (IS_ERR(nodemap)) {
259 rc = PTR_ERR(nodemap);
260 CERROR("cannot find nodemap '%s': rc = %d\n",
261 (char *)m->private, rc);
265 seq_printf(m, "%s\n", nodemap_get_sepol(nodemap));
266 nodemap_putref(nodemap);
271 * Set SELinux policy info on a nodemap.
273 * \param[in] file proc file
274 * \param[in] buffer string, "<sepol>"
275 * \param[in] count \a buffer length
276 * \param[in] off unused
277 * \retval \a count on success
278 * \retval negative number on error
281 nodemap_sepol_seq_write(struct file *file,
282 const char __user *buffer,
283 size_t count, loff_t *off)
285 struct seq_file *m = file->private_data;
286 char sepol[LUSTRE_NODEMAP_SEPOL_LENGTH + 1];
289 CLASSERT(sizeof(sepol) == sizeof(((struct lu_nodemap *)0)->nm_sepol));
292 if (count >= sizeof(sepol))
293 GOTO(out, rc = -ENAMETOOLONG);
295 if (copy_from_user(sepol, buffer, count))
296 GOTO(out, rc = -EFAULT);
300 rc = nodemap_set_sepol(m->private, sepol);
309 LPROC_SEQ_FOPS(nodemap_sepol);
312 * Reads and prints the exports attached to the given nodemap.
314 * \param m seq file in proc fs, stores nodemap
318 static int nodemap_exports_show(struct seq_file *m, void *data)
320 struct lu_nodemap *nodemap;
321 struct obd_export *exp;
322 char nidstr[LNET_NIDSTR_SIZE] = "<unknown>";
325 mutex_lock(&active_config_lock);
326 nodemap = nodemap_lookup(m->private);
327 mutex_unlock(&active_config_lock);
328 if (IS_ERR(nodemap)) {
329 rc = PTR_ERR(nodemap);
330 CERROR("cannot find nodemap '%s': rc = %d\n",
331 (char *)m->private, rc);
335 seq_printf(m, "[\n");
337 mutex_lock(&nodemap->nm_member_list_lock);
338 list_for_each_entry(exp, &nodemap->nm_member_list,
339 exp_target_data.ted_nodemap_member) {
340 if (exp->exp_connection != NULL)
341 libcfs_nid2str_r(exp->exp_connection->c_peer.nid,
342 nidstr, sizeof(nidstr));
344 seq_printf(m, " { nid: %s, uuid: %s },",
345 nidstr, exp->exp_client_uuid.uuid);
347 mutex_unlock(&nodemap->nm_member_list_lock);
350 seq_printf(m, "]\n");
352 nodemap_putref(nodemap);
357 * Attaches nodemap_idmap_show to proc file.
359 * \param inode inode of seq file in proc fs
360 * \param file seq file
363 static int nodemap_exports_open(struct inode *inode, struct file *file)
365 return single_open(file, nodemap_exports_show, PDE_DATA(inode));
369 * Reads and prints the active flag for the given nodemap.
371 * \param m seq file in proc fs
375 static int nodemap_active_seq_show(struct seq_file *m, void *data)
377 seq_printf(m, "%u\n", (unsigned int)nodemap_active);
382 * Activate/deactivate nodemap.
384 * \param[in] file proc file
385 * \param[in] buffer string, "1" or "0" to activate/deactivate nodemap
386 * \param[in] count \a buffer length
387 * \param[in] off unused
388 * \retval \a count on success
389 * \retval negative number on error
392 nodemap_active_seq_write(struct file *file, const char __user *buffer,
393 size_t count, loff_t *off)
395 char active_string[NODEMAP_LPROC_FLAG_LEN + 1];
396 long unsigned int active;
402 if (count >= sizeof(active_string))
405 if (copy_from_user(active_string, buffer, count))
408 active_string[count] = '\0';
409 rc = kstrtoul(active_string, 10, &active);
413 nodemap_activate(active);
417 LPROC_SEQ_FOPS(nodemap_active);
420 * Reads and prints the nodemap ID for the given nodemap.
422 * \param m seq file in proc fs
426 static int nodemap_id_seq_show(struct seq_file *m, void *data)
428 struct lu_nodemap *nodemap;
430 mutex_lock(&active_config_lock);
431 nodemap = nodemap_lookup(m->private);
432 mutex_unlock(&active_config_lock);
433 if (IS_ERR(nodemap)) {
434 int rc = PTR_ERR(nodemap);
435 CERROR("cannot find nodemap '%s': rc = %d\n",
436 (char *)m->private, rc);
440 seq_printf(m, "%u\n", nodemap->nm_id);
441 nodemap_putref(nodemap);
444 LPROC_SEQ_FOPS_RO(nodemap_id);
447 * Reads and prints the root squash UID for the given nodemap.
449 * \param m seq file in proc fs
453 static int nodemap_squash_uid_seq_show(struct seq_file *m, void *data)
455 struct lu_nodemap *nodemap;
457 mutex_lock(&active_config_lock);
458 nodemap = nodemap_lookup(m->private);
459 mutex_unlock(&active_config_lock);
460 if (IS_ERR(nodemap)) {
461 int rc = PTR_ERR(nodemap);
462 CERROR("cannot find nodemap '%s': rc = %d\n",
463 (char *)m->private, rc);
467 seq_printf(m, "%u\n", nodemap->nm_squash_uid);
468 nodemap_putref(nodemap);
473 * Reads and prints the root squash GID for the given nodemap.
475 * \param m seq file in proc fs
479 static int nodemap_squash_gid_seq_show(struct seq_file *m, void *data)
481 struct lu_nodemap *nodemap;
483 mutex_lock(&active_config_lock);
484 nodemap = nodemap_lookup(m->private);
485 mutex_unlock(&active_config_lock);
486 if (IS_ERR(nodemap)) {
487 int rc = PTR_ERR(nodemap);
488 CERROR("cannot find nodemap '%s': rc = %d\n",
489 (char *)m->private, rc);
493 seq_printf(m, "%u\n", nodemap->nm_squash_gid);
494 nodemap_putref(nodemap);
499 * Reads and prints the trusted flag for the given nodemap.
501 * \param m seq file in proc fs
505 static int nodemap_trusted_seq_show(struct seq_file *m, void *data)
507 struct lu_nodemap *nodemap;
509 mutex_lock(&active_config_lock);
510 nodemap = nodemap_lookup(m->private);
511 mutex_unlock(&active_config_lock);
512 if (IS_ERR(nodemap)) {
513 int rc = PTR_ERR(nodemap);
515 CERROR("cannot find nodemap '%s': rc = %d\n",
516 (char *)m->private, rc);
520 seq_printf(m, "%d\n", (int)nodemap->nmf_trust_client_ids);
521 nodemap_putref(nodemap);
526 * Reads and prints the admin flag for the given nodemap.
528 * \param m seq file in proc fs
532 static int nodemap_admin_seq_show(struct seq_file *m, void *data)
534 struct lu_nodemap *nodemap;
537 mutex_lock(&active_config_lock);
538 nodemap = nodemap_lookup(m->private);
539 mutex_unlock(&active_config_lock);
540 if (IS_ERR(nodemap)) {
541 rc = PTR_ERR(nodemap);
542 CERROR("cannot find nodemap '%s': rc = %d\n",
543 (char *)m->private, rc);
547 seq_printf(m, "%d\n", (int)nodemap->nmf_allow_root_access);
548 nodemap_putref(nodemap);
553 * Reads and prints the mapping mode for the given nodemap.
555 * \param m seq file in proc fs
559 static int nodemap_map_mode_seq_show(struct seq_file *m, void *data)
561 struct lu_nodemap *nodemap;
564 mutex_lock(&active_config_lock);
565 nodemap = nodemap_lookup(m->private);
566 mutex_unlock(&active_config_lock);
567 if (IS_ERR(nodemap)) {
568 rc = PTR_ERR(nodemap);
569 CERROR("cannot find nodemap '%s': rc = %d\n",
570 (char *)m->private, rc);
574 if (nodemap->nmf_map_uid_only)
575 seq_printf(m, "uid_only\n");
576 else if (nodemap->nmf_map_gid_only)
577 seq_printf(m, "gid_only\n");
579 seq_printf(m, "both\n");
581 nodemap_putref(nodemap);
586 * Reads and prints the deny_unknown flag for the given nodemap.
588 * \param m seq file in proc fs
592 static int nodemap_deny_unknown_seq_show(struct seq_file *m, void *data)
594 struct lu_nodemap *nodemap;
597 mutex_lock(&active_config_lock);
598 nodemap = nodemap_lookup(m->private);
599 mutex_unlock(&active_config_lock);
600 if (IS_ERR(nodemap)) {
601 rc = PTR_ERR(nodemap);
602 CERROR("cannot find nodemap '%s': rc = %d\n",
603 (char *)m->private, rc);
607 seq_printf(m, "%d\n", (int)nodemap->nmf_deny_unknown);
608 nodemap_putref(nodemap);
613 * Reads and prints the audit_mode flag for the given nodemap.
615 * \param m seq file in proc fs
619 static int nodemap_audit_mode_seq_show(struct seq_file *m, void *data)
621 struct lu_nodemap *nodemap;
624 mutex_lock(&active_config_lock);
625 nodemap = nodemap_lookup(m->private);
626 mutex_unlock(&active_config_lock);
627 if (IS_ERR(nodemap)) {
628 rc = PTR_ERR(nodemap);
629 CERROR("cannot find nodemap '%s': rc = %d\n",
630 (char *)m->private, rc);
634 seq_printf(m, "%d\n", (int)nodemap->nmf_enable_audit);
635 nodemap_putref(nodemap);
639 static struct lprocfs_vars lprocfs_nm_module_vars[] = {
642 .fops = &nodemap_active_fops,
649 LPROC_SEQ_FOPS_RO(nodemap_trusted);
650 LPROC_SEQ_FOPS_RO(nodemap_admin);
651 LPROC_SEQ_FOPS_RO(nodemap_squash_uid);
652 LPROC_SEQ_FOPS_RO(nodemap_squash_gid);
654 LPROC_SEQ_FOPS_RO(nodemap_deny_unknown);
655 LPROC_SEQ_FOPS_RO(nodemap_map_mode);
656 LPROC_SEQ_FOPS_RO(nodemap_audit_mode);
658 const struct file_operations nodemap_ranges_fops = {
659 .open = nodemap_ranges_open,
662 .release = single_release
665 const struct file_operations nodemap_idmap_fops = {
666 .open = nodemap_idmap_open,
669 .release = single_release
672 const struct file_operations nodemap_exports_fops = {
673 .open = nodemap_exports_open,
676 .release = single_release
679 static struct lprocfs_vars lprocfs_nodemap_vars[] = {
682 .fops = &nodemap_id_fops,
685 .name = "trusted_nodemap",
686 .fops = &nodemap_trusted_fops,
689 .name = "admin_nodemap",
690 .fops = &nodemap_admin_fops,
693 .name = "deny_unknown",
694 .fops = &nodemap_deny_unknown_fops,
698 .fops = &nodemap_map_mode_fops,
701 .name = "audit_mode",
702 .fops = &nodemap_audit_mode_fops,
705 .name = "squash_uid",
706 .fops = &nodemap_squash_uid_fops,
709 .name = "squash_gid",
710 .fops = &nodemap_squash_gid_fops,
714 .fops = &nodemap_ranges_fops,
718 .fops = &nodemap_fileset_fops,
722 .fops = &nodemap_sepol_fops,
726 .fops = &nodemap_exports_fops,
730 .fops = &nodemap_idmap_fops,
737 static struct lprocfs_vars lprocfs_default_nodemap_vars[] = {
740 .fops = &nodemap_id_fops,
743 .name = "trusted_nodemap",
744 .fops = &nodemap_trusted_fops,
747 .name = "admin_nodemap",
748 .fops = &nodemap_admin_fops,
751 .name = "squash_uid",
752 .fops = &nodemap_squash_uid_fops,
755 .name = "squash_gid",
756 .fops = &nodemap_squash_gid_fops,
760 .fops = &nodemap_fileset_fops,
764 .fops = &nodemap_exports_fops,
767 .name = "audit_mode",
768 .fops = &nodemap_audit_mode_fops,
776 * Initialize the nodemap procfs directory.
780 int nodemap_procfs_init(void)
784 proc_lustre_nodemap_root = lprocfs_register(LUSTRE_NODEMAP_NAME,
786 lprocfs_nm_module_vars,
788 if (IS_ERR(proc_lustre_nodemap_root)) {
789 rc = PTR_ERR(proc_lustre_nodemap_root);
790 CERROR("cannot create 'nodemap' directory: rc = %d\n",
792 proc_lustre_nodemap_root = NULL;
798 * Cleanup nodemap proc entry data structures.
800 void nodemap_procfs_exit(void)
802 struct nodemap_pde *nm_pde;
803 struct nodemap_pde *tmp;
805 lprocfs_remove(&proc_lustre_nodemap_root);
806 list_for_each_entry_safe(nm_pde, tmp, &nodemap_pde_list,
808 list_del(&nm_pde->npe_list_member);
809 OBD_FREE_PTR(nm_pde);
814 * Remove a nodemap's procfs entry and related data.
816 void lprocfs_nodemap_remove(struct nodemap_pde *nm_pde)
818 lprocfs_remove(&nm_pde->npe_proc_entry);
819 list_del(&nm_pde->npe_list_member);
820 OBD_FREE_PTR(nm_pde);
824 * Register the proc directory for a nodemap
826 * \param nodemap nodemap to make the proc dir for
827 * \param is_default: 1 if default nodemap
830 int lprocfs_nodemap_register(struct lu_nodemap *nodemap, bool is_default)
832 struct nodemap_pde *nm_entry;
835 OBD_ALLOC_PTR(nm_entry);
836 if (nm_entry == NULL)
837 GOTO(out, rc = -ENOMEM);
839 nm_entry->npe_proc_entry = proc_mkdir(nodemap->nm_name,
840 proc_lustre_nodemap_root);
841 if (IS_ERR(nm_entry->npe_proc_entry))
842 GOTO(out, rc = PTR_ERR(nm_entry->npe_proc_entry));
844 snprintf(nm_entry->npe_name, sizeof(nm_entry->npe_name), "%s",
847 /* Use the nodemap name as stored on the PDE as the private data. This
848 * is so a nodemap struct can be replaced without updating the proc
851 rc = lprocfs_add_vars(nm_entry->npe_proc_entry,
852 (is_default ? lprocfs_default_nodemap_vars :
853 lprocfs_nodemap_vars),
856 lprocfs_remove(&nm_entry->npe_proc_entry);
858 list_add(&nm_entry->npe_list_member, &nodemap_pde_list);
862 CERROR("cannot create 'nodemap/%s': rc = %d\n",
863 nodemap->nm_name, rc);
864 if (nm_entry != NULL) {
865 OBD_FREE_PTR(nm_entry);
870 nodemap->nm_pde_data = nm_entry;