xref: /linux-6.15/kernel/module/procfs.c (revision 0ffc40f6)
1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /*
3  * Module proc support
4  *
5  * Copyright (C) 2008 Alexey Dobriyan
6  */
7 
8 #include <linux/module.h>
9 #include <linux/kallsyms.h>
10 #include <linux/mutex.h>
11 #include <linux/seq_file.h>
12 #include <linux/proc_fs.h>
13 #include "internal.h"
14 
15 #ifdef CONFIG_MODULE_UNLOAD
16 static inline void print_unload_info(struct seq_file *m, struct module *mod)
17 {
18 	struct module_use *use;
19 	int printed_something = 0;
20 
21 	seq_printf(m, " %i ", module_refcount(mod));
22 
23 	/*
24 	 * Always include a trailing , so userspace can differentiate
25 	 * between this and the old multi-field proc format.
26 	 */
27 	list_for_each_entry(use, &mod->source_list, source_list) {
28 		printed_something = 1;
29 		seq_printf(m, "%s,", use->source->name);
30 	}
31 
32 	if (mod->init && !mod->exit) {
33 		printed_something = 1;
34 		seq_puts(m, "[permanent],");
35 	}
36 
37 	if (!printed_something)
38 		seq_puts(m, "-");
39 }
40 #else /* !CONFIG_MODULE_UNLOAD */
41 static inline void print_unload_info(struct seq_file *m, struct module *mod)
42 {
43 	/* We don't know the usage count, or what modules are using. */
44 	seq_puts(m, " - -");
45 }
46 #endif /* CONFIG_MODULE_UNLOAD */
47 
48 /* Called by the /proc file system to return a list of modules. */
49 static void *m_start(struct seq_file *m, loff_t *pos)
50 {
51 	mutex_lock(&module_mutex);
52 	return seq_list_start(&modules, *pos);
53 }
54 
55 static void *m_next(struct seq_file *m, void *p, loff_t *pos)
56 {
57 	return seq_list_next(p, &modules, pos);
58 }
59 
60 static void m_stop(struct seq_file *m, void *p)
61 {
62 	mutex_unlock(&module_mutex);
63 }
64 
65 static int m_show(struct seq_file *m, void *p)
66 {
67 	struct module *mod = list_entry(p, struct module, list);
68 	char buf[MODULE_FLAGS_BUF_SIZE];
69 	void *value;
70 
71 	/* We always ignore unformed modules. */
72 	if (mod->state == MODULE_STATE_UNFORMED)
73 		return 0;
74 
75 	seq_printf(m, "%s %u",
76 		   mod->name, mod->init_layout.size + mod->core_layout.size);
77 	print_unload_info(m, mod);
78 
79 	/* Informative for users. */
80 	seq_printf(m, " %s",
81 		   mod->state == MODULE_STATE_GOING ? "Unloading" :
82 		   mod->state == MODULE_STATE_COMING ? "Loading" :
83 		   "Live");
84 	/* Used by oprofile and other similar tools. */
85 	value = m->private ? NULL : mod->core_layout.base;
86 	seq_printf(m, " 0x%px", value);
87 
88 	/* Taints info */
89 	if (mod->taints)
90 		seq_printf(m, " %s", module_flags(mod, buf));
91 
92 	seq_puts(m, "\n");
93 	return 0;
94 }
95 
96 /*
97  * Format: modulename size refcount deps address
98  *
99  * Where refcount is a number or -, and deps is a comma-separated list
100  * of depends or -.
101  */
102 static const struct seq_operations modules_op = {
103 	.start	= m_start,
104 	.next	= m_next,
105 	.stop	= m_stop,
106 	.show	= m_show
107 };
108 
109 /*
110  * This also sets the "private" pointer to non-NULL if the
111  * kernel pointers should be hidden (so you can just test
112  * "m->private" to see if you should keep the values private).
113  *
114  * We use the same logic as for /proc/kallsyms.
115  */
116 static int modules_open(struct inode *inode, struct file *file)
117 {
118 	int err = seq_open(file, &modules_op);
119 
120 	if (!err) {
121 		struct seq_file *m = file->private_data;
122 
123 		m->private = kallsyms_show_value(file->f_cred) ? NULL : (void *)8ul;
124 	}
125 
126 	return err;
127 }
128 
129 static const struct proc_ops modules_proc_ops = {
130 	.proc_flags	= PROC_ENTRY_PERMANENT,
131 	.proc_open	= modules_open,
132 	.proc_read	= seq_read,
133 	.proc_lseek	= seq_lseek,
134 	.proc_release	= seq_release,
135 };
136 
137 static int __init proc_modules_init(void)
138 {
139 	proc_create("modules", 0, NULL, &modules_proc_ops);
140 	return 0;
141 }
142 module_init(proc_modules_init);
143