2 * kmod-modinfo - query kernel module information using libkmod.
4 * Copyright (C) 2011-2013 ProFUSION embedded systems
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
28 #include <sys/utsname.h>
30 #include <shared/util.h>
32 #include <libkmod/libkmod.h>
36 static char separator
= '\n';
37 static const char *field
= NULL
;
49 static struct param
*add_param(const char *name
, int namelen
, const char *param
, int paramlen
, const char *type
, int typelen
, struct param
**list
)
53 for (it
= *list
; it
!= NULL
; it
= it
->next
) {
54 if (it
->namelen
== namelen
&&
55 memcmp(it
->name
, name
, namelen
) == 0)
60 it
= malloc(sizeof(struct param
));
66 it
->namelen
= namelen
;
75 it
->paramlen
= paramlen
;
80 it
->typelen
= typelen
;
86 static int process_parm(const char *key
, const char *value
, struct param
**params
)
88 const char *name
, *param
, *type
;
89 int namelen
, paramlen
, typelen
;
91 const char *colon
= strchr(value
, ':');
93 ERR("Found invalid \"%s=%s\": missing ':'\n",
99 namelen
= colon
- value
;
100 if (streq(key
, "parm")) {
102 paramlen
= strlen(param
);
109 typelen
= strlen(type
);
112 it
= add_param(name
, namelen
, param
, paramlen
, type
, typelen
, params
);
114 ERR("Out of memory!\n");
121 static int modinfo_params_do(const struct kmod_list
*list
)
123 const struct kmod_list
*l
;
124 struct param
*params
= NULL
;
127 kmod_list_foreach(l
, list
) {
128 const char *key
= kmod_module_info_get_key(l
);
129 const char *value
= kmod_module_info_get_value(l
);
130 if (!streq(key
, "parm") && !streq(key
, "parmtype"))
133 err
= process_parm(key
, value
, ¶ms
);
138 while (params
!= NULL
) {
139 struct param
*p
= params
;
142 if (p
->param
== NULL
)
143 printf("%.*s: (%.*s)%c",
144 p
->namelen
, p
->name
, p
->typelen
, p
->type
,
146 else if (p
->type
!= NULL
)
147 printf("%.*s:%.*s (%.*s)%c",
149 p
->paramlen
, p
->param
,
153 printf("%.*s:%.*s%c",
155 p
->paramlen
, p
->param
,
162 while (params
!= NULL
) {
164 params
= params
->next
;
171 static int modinfo_do(struct kmod_module
*mod
)
173 struct kmod_list
*l
, *list
= NULL
;
174 struct param
*params
= NULL
;
176 const char *filename
= kmod_module_get_path(mod
);
178 is_builtin
= (filename
== NULL
);
182 printf("%-16s%s%c", "name:",
183 kmod_module_get_name(mod
), separator
);
184 else if (field
!= NULL
&& streq(field
, "name"))
185 printf("%s%c", kmod_module_get_name(mod
), separator
);
186 filename
= "(builtin)";
189 if (field
!= NULL
&& streq(field
, "filename")) {
190 printf("%s%c", filename
, separator
);
192 } else if (field
== NULL
) {
193 printf("%-16s%s%c", "filename:",
194 filename
, separator
);
197 err
= kmod_module_get_info(mod
, &list
);
199 if (is_builtin
&& err
== -ENOENT
) {
201 * This is an old kernel that does not have a file
202 * with information about built-in modules.
206 ERR("could not get modinfo from '%s': %s\n",
207 kmod_module_get_name(mod
), strerror(-err
));
211 if (field
!= NULL
&& streq(field
, "parm")) {
212 err
= modinfo_params_do(list
);
216 kmod_list_foreach(l
, list
) {
217 const char *key
= kmod_module_info_get_key(l
);
218 const char *value
= kmod_module_info_get_value(l
);
222 if (!streq(field
, key
))
224 /* filtered output contains no key, just value */
225 printf("%s%c", value
, separator
);
229 if (streq(key
, "parm") || streq(key
, "parmtype")) {
230 err
= process_parm(key
, value
, ¶ms
);
236 if (separator
== '\0') {
237 printf("%s=%s%c", key
, value
, separator
);
241 keylen
= strlen(key
);
242 printf("%s:%-*s%s%c", key
, 15 - keylen
, "", value
, separator
);
248 while (params
!= NULL
) {
249 struct param
*p
= params
;
252 if (p
->param
== NULL
)
253 printf("%-16s%.*s:%.*s%c", "parm:",
254 p
->namelen
, p
->name
, p
->typelen
, p
->type
,
256 else if (p
->type
!= NULL
)
257 printf("%-16s%.*s:%.*s (%.*s)%c", "parm:",
259 p
->paramlen
, p
->param
,
263 printf("%-16s%.*s:%.*s%c",
266 p
->paramlen
, p
->param
,
273 while (params
!= NULL
) {
275 params
= params
->next
;
278 kmod_module_info_free_list(list
);
283 static int modinfo_path_do(struct kmod_ctx
*ctx
, const char *path
)
285 struct kmod_module
*mod
;
286 int err
= kmod_module_new_from_path(ctx
, path
, &mod
);
288 ERR("Module file %s not found.\n", path
);
291 err
= modinfo_do(mod
);
292 kmod_module_unref(mod
);
296 static int modinfo_alias_do(struct kmod_ctx
*ctx
, const char *alias
)
298 struct kmod_list
*l
, *list
= NULL
;
299 int err
= kmod_module_new_from_lookup(ctx
, alias
, &list
);
301 ERR("Module alias %s not found.\n", alias
);
306 ERR("Module %s not found.\n", alias
);
310 kmod_list_foreach(l
, list
) {
311 struct kmod_module
*mod
= kmod_module_get_module(l
);
312 int r
= modinfo_do(mod
);
313 kmod_module_unref(mod
);
317 kmod_module_unref_list(list
);
321 static const char cmdopts_s
[] = "adlpn0F:k:b:Vh";
322 static const struct option cmdopts
[] = {
323 {"author", no_argument
, 0, 'a'},
324 {"description", no_argument
, 0, 'd'},
325 {"license", no_argument
, 0, 'l'},
326 {"parameters", no_argument
, 0, 'p'},
327 {"filename", no_argument
, 0, 'n'},
328 {"null", no_argument
, 0, '0'},
329 {"field", required_argument
, 0, 'F'},
330 {"set-version", required_argument
, 0, 'k'},
331 {"basedir", required_argument
, 0, 'b'},
332 {"version", no_argument
, 0, 'V'},
333 {"help", no_argument
, 0, 'h'},
337 static void help(void)
340 "\t%s [options] filename [args]\n"
342 "\t-a, --author Print only 'author'\n"
343 "\t-d, --description Print only 'description'\n"
344 "\t-l, --license Print only 'license'\n"
345 "\t-p, --parameters Print only 'parm'\n"
346 "\t-n, --filename Print only 'filename'\n"
347 "\t-0, --null Use \\0 instead of \\n\n"
348 "\t-F, --field=FIELD Print only provided FIELD\n"
349 "\t-k, --set-version=VERSION Use VERSION instead of `uname -r`\n"
350 "\t-b, --basedir=DIR Use DIR as filesystem root for /lib/modules\n"
351 "\t-V, --version Show version\n"
352 "\t-h, --help Show this help\n",
353 program_invocation_short_name
);
356 static bool is_module_filename(const char *name
)
360 if (stat(name
, &st
) == 0 && S_ISREG(st
.st_mode
) &&
361 path_ends_with_kmod_ext(name
, strlen(name
)))
367 static int do_modinfo(int argc
, char *argv
[])
369 struct kmod_ctx
*ctx
;
370 char dirname_buf
[PATH_MAX
];
371 const char *dirname
= NULL
;
372 const char *kversion
= NULL
;
373 const char *root
= NULL
;
374 const char *null_config
= NULL
;
379 c
= getopt_long(argc
, argv
, cmdopts_s
, cmdopts
, &idx
);
387 field
= "description";
414 puts(PACKAGE
" version " VERSION
);
420 ERR("unexpected getopt_long() value '%c'.\n", c
);
425 if (optind
>= argc
) {
426 ERR("missing module or filename.\n");
430 if (root
!= NULL
|| kversion
!= NULL
) {
434 if (kversion
== NULL
) {
436 ERR("uname() failed: %m\n");
439 kversion
= u
.release
;
441 snprintf(dirname_buf
, sizeof(dirname_buf
), "%s/lib/modules/%s",
443 dirname
= dirname_buf
;
446 ctx
= kmod_new(dirname
, &null_config
);
448 ERR("kmod_new() failed!\n");
453 for (i
= optind
; i
< argc
; i
++) {
454 const char *name
= argv
[i
];
457 if (is_module_filename(name
))
458 r
= modinfo_path_do(ctx
, name
);
460 r
= modinfo_alias_do(ctx
, name
);
467 return err
>= 0 ? EXIT_SUCCESS
: EXIT_FAILURE
;
470 const struct kmod_cmd kmod_cmd_compat_modinfo
= {
473 .help
= "compat modinfo command",