Add an initial FAQ
[oweals/busybox.git] / modutils / lsmod.c
1 /* vi: set sw=4 ts=4: */
2 /*
3  * Mini lsmod implementation for busybox
4  *
5  * Copyright (C) 1999-2004 by Erik Andersen <andersen@codepoet.org>
6  *
7  * Modified by Alcove, Julien Gaulmin <julien.gaulmin@alcove.fr> and
8  * Nicolas Ferre <nicolas.ferre@alcove.fr> to support pre 2.1 kernels
9  * (which lack the query_module() interface).
10  *
11  * This program is free software; you can redistribute it and/or modify
12  * it under the terms of the GNU General Public License as published by
13  * the Free Software Foundation; either version 2 of the License, or
14  * (at your option) any later version.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19  * General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program; if not, write to the Free Software
23  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
24  *
25  */
26
27 #include <stdlib.h>
28 #include <stdio.h>
29 #include <string.h>
30 #include <stddef.h>
31 #include <errno.h>
32 #include <unistd.h>
33 #include <dirent.h>
34 #include <ctype.h>
35 #include <assert.h>
36 #include <getopt.h>
37 #include <sys/utsname.h>
38 #include <sys/file.h>
39 #include "busybox.h"
40
41
42 #ifndef CONFIG_FEATURE_CHECK_TAINTED_MODULE
43 static inline void check_tainted(void) { printf("\n"); }
44 #else
45 #define TAINT_FILENAME                  "/proc/sys/kernel/tainted"
46 #define TAINT_PROPRIETORY_MODULE        (1<<0)
47 #define TAINT_FORCED_MODULE             (1<<1)
48 #define TAINT_UNSAFE_SMP                (1<<2)
49
50 static void check_tainted(void)
51 {
52         int tainted;
53         FILE *f;
54
55         tainted = 0;
56         if ((f = fopen(TAINT_FILENAME, "r"))) {
57                 fscanf(f, "%d", &tainted);
58                 fclose(f);
59         }
60         if (f && tainted) {
61                 printf("    Tainted: %c%c%c\n",
62                                 tainted & TAINT_PROPRIETORY_MODULE      ? 'P' : 'G',
63                                 tainted & TAINT_FORCED_MODULE           ? 'F' : ' ',
64                                 tainted & TAINT_UNSAFE_SMP              ? 'S' : ' ');
65         }
66         else {
67                 printf("    Not tainted\n");
68         }
69 }
70 #endif
71
72 #ifdef CONFIG_FEATURE_QUERY_MODULE_INTERFACE
73
74 struct module_info
75 {
76         unsigned long addr;
77         unsigned long size;
78         unsigned long flags;
79         long usecount;
80 };
81
82
83 int query_module(const char *name, int which, void *buf, size_t bufsize, size_t *ret);
84
85 /* Values for query_module's which.  */
86 static const int QM_MODULES = 1;
87 static const int QM_DEPS = 2;
88 static const int QM_REFS = 3;
89 static const int QM_SYMBOLS = 4;
90 static const int QM_INFO = 5;
91
92 /* Bits of module.flags.  */
93 static const int NEW_MOD_RUNNING = 1;
94 static const int NEW_MOD_DELETED = 2;
95 static const int NEW_MOD_AUTOCLEAN = 4;
96 static const int NEW_MOD_VISITED = 8;
97 static const int NEW_MOD_USED_ONCE = 16;
98 static const int NEW_MOD_INITIALIZING = 64;
99
100 extern int lsmod_main(int argc, char **argv)
101 {
102         struct module_info info;
103         char *module_names, *mn, *deps, *dn;
104         size_t bufsize, depsize, nmod, count, i, j;
105
106         module_names = xmalloc(bufsize = 256);
107         if (my_query_module(NULL, QM_MODULES, (void **)&module_names, &bufsize,
108                                 &nmod)) {
109                 bb_perror_msg_and_die("QM_MODULES");
110         }
111
112         deps = xmalloc(depsize = 256);
113         printf("Module                  Size  Used by");
114         check_tainted();
115
116         for (i = 0, mn = module_names; i < nmod; mn += strlen(mn) + 1, i++) {
117                 if (query_module(mn, QM_INFO, &info, sizeof(info), &count)) {
118                         if (errno == ENOENT) {
119                                 /* The module was removed out from underneath us. */
120                                 continue;
121                         }
122                         /* else choke */
123                         bb_perror_msg_and_die("module %s: QM_INFO", mn);
124                 }
125                 if (my_query_module(mn, QM_REFS, (void **)&deps, &depsize, &count)) {
126                         if (errno == ENOENT) {
127                                 /* The module was removed out from underneath us. */
128                                 continue;
129                         }
130                         bb_perror_msg_and_die("module %s: QM_REFS", mn);
131                 }
132                 printf("%-20s%8lu%4ld", mn, info.size, info.usecount);
133                 if (info.flags & NEW_MOD_DELETED)
134                         printf(" (deleted)");
135                 else if (info.flags & NEW_MOD_INITIALIZING)
136                         printf(" (initializing)");
137                 else if (!(info.flags & NEW_MOD_RUNNING))
138                         printf(" (uninitialized)");
139                 else {
140                         if (info.flags & NEW_MOD_AUTOCLEAN)
141                                 printf(" (autoclean) ");
142                         if (!(info.flags & NEW_MOD_USED_ONCE))
143                                 printf(" (unused)");
144                 }
145                 if (count) printf(" [");
146                 for (j = 0, dn = deps; j < count; dn += strlen(dn) + 1, j++) {
147                         printf("%s%s", dn, (j==count-1)? "":" ");
148                 }
149                 if (count) printf("]");
150
151                 printf("\n");
152         }
153
154 #ifdef CONFIG_FEATURE_CLEAN_UP
155         free(module_names);
156 #endif
157
158         return( 0);
159 }
160
161 #else /* CONFIG_FEATURE_QUERY_MODULE_INTERFACE */
162
163 extern int lsmod_main(int argc, char **argv)
164 {
165         printf("Module                  Size  Used by");
166         check_tainted();
167
168         if (bb_xprint_file_by_name("/proc/modules") < 0) {
169                 return 0;
170         }
171         return 1;
172 }
173
174 #endif /* CONFIG_FEATURE_QUERY_MODULE_INTERFACE */