2 * kmod-modprobe - manage linux kernel modules 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/>.
30 #include <sys/types.h>
31 #include <sys/utsname.h>
34 #include <shared/array.h>
35 #include <shared/macro.h>
37 #include <libkmod/libkmod.h>
41 static int log_priority
= LOG_CRIT
;
42 static int use_syslog
= 0;
43 #define LOG(...) log_printf(log_priority, __VA_ARGS__)
45 #define DEFAULT_VERBOSE LOG_WARNING
46 static int verbose
= DEFAULT_VERBOSE
;
47 static int do_show
= 0;
48 static int dry_run
= 0;
49 static int ignore_loaded
= 0;
50 static int lookup_only
= 0;
51 static int first_time
= 0;
52 static int ignore_commands
= 0;
53 static int use_blacklist
= 0;
55 static int strip_modversion
= 0;
56 static int strip_vermagic
= 0;
57 static int remove_holders
= 0;
58 static int quiet_inuse
= 0;
60 static const char cmdopts_s
[] = "arRibfDcnC:d:S:sqvVh";
61 static const struct option cmdopts
[] = {
62 {"all", no_argument
, 0, 'a'},
63 {"remove", no_argument
, 0, 'r'},
64 {"remove-dependencies", no_argument
, 0, 5},
65 {"remove-holders", no_argument
, 0, 5},
66 {"resolve-alias", no_argument
, 0, 'R'},
67 {"first-time", no_argument
, 0, 3},
68 {"ignore-install", no_argument
, 0, 'i'},
69 {"ignore-remove", no_argument
, 0, 'i'},
70 {"use-blacklist", no_argument
, 0, 'b'},
71 {"force", no_argument
, 0, 'f'},
72 {"force-modversion", no_argument
, 0, 2},
73 {"force-vermagic", no_argument
, 0, 1},
75 {"show-depends", no_argument
, 0, 'D'},
76 {"showconfig", no_argument
, 0, 'c'},
77 {"show-config", no_argument
, 0, 'c'},
78 {"show-modversions", no_argument
, 0, 4},
79 {"dump-modversions", no_argument
, 0, 4},
80 {"show-exports", no_argument
, 0, 6},
82 {"dry-run", no_argument
, 0, 'n'},
83 {"show", no_argument
, 0, 'n'},
85 {"config", required_argument
, 0, 'C'},
86 {"dirname", required_argument
, 0, 'd'},
87 {"set-version", required_argument
, 0, 'S'},
89 {"syslog", no_argument
, 0, 's'},
90 {"quiet", no_argument
, 0, 'q'},
91 {"verbose", no_argument
, 0, 'v'},
92 {"version", no_argument
, 0, 'V'},
93 {"help", no_argument
, 0, 'h'},
97 static void help(void)
100 "\t%s [options] [-i] [-b] modulename\n"
101 "\t%s [options] -a [-i] [-b] modulename [modulename...]\n"
102 "\t%s [options] -r [-i] modulename\n"
103 "\t%s [options] -r -a [-i] modulename [modulename...]\n"
104 "\t%s [options] -c\n"
105 "\t%s [options] --dump-modversions filename\n"
106 "Management Options:\n"
107 "\t-a, --all Consider every non-argument to\n"
108 "\t be a module name to be inserted\n"
109 "\t or removed (-r)\n"
110 "\t-r, --remove Remove modules instead of inserting\n"
111 "\t --remove-dependencies Deprecated: use --remove-holders\n"
112 "\t --remove-holders Also remove module holders (use together with -r)\n"
113 "\t-R, --resolve-alias Only lookup and print alias and exit\n"
114 "\t --first-time Fail if module already inserted or removed\n"
115 "\t-i, --ignore-install Ignore install commands\n"
116 "\t-i, --ignore-remove Ignore remove commands\n"
117 "\t-b, --use-blacklist Apply blacklist to resolved alias.\n"
118 "\t-f, --force Force module insertion or removal.\n"
119 "\t implies --force-modversions and\n"
120 "\t --force-vermagic\n"
121 "\t --force-modversion Ignore module's version\n"
122 "\t --force-vermagic Ignore module's version magic\n"
125 "\t-D, --show-depends Only print module dependencies and exit\n"
126 "\t-c, --showconfig Print out known configuration and exit\n"
127 "\t-c, --show-config Same as --showconfig\n"
128 "\t --show-modversions Dump module symbol version and exit\n"
129 "\t --dump-modversions Same as --show-modversions\n"
130 "\t --show-exports Only print module exported symbol versions and exit\n"
133 "\t-n, --dry-run Do not execute operations, just print out\n"
134 "\t-n, --show Same as --dry-run\n"
136 "\t-C, --config=FILE Use FILE instead of default search paths\n"
137 "\t-d, --dirname=DIR Use DIR as filesystem root for /lib/modules\n"
138 "\t-S, --set-version=VERSION Use VERSION instead of `uname -r`\n"
140 "\t-s, --syslog print to syslog, not stderr\n"
141 "\t-q, --quiet disable messages\n"
142 "\t-v, --verbose enables more messages\n"
143 "\t-V, --version show version\n"
144 "\t-h, --help show this help\n",
145 program_invocation_short_name
, program_invocation_short_name
,
146 program_invocation_short_name
, program_invocation_short_name
,
147 program_invocation_short_name
, program_invocation_short_name
);
150 _printf_format_(1, 2)
151 static inline void _show(const char *fmt
, ...)
155 if (!do_show
&& verbose
<= DEFAULT_VERBOSE
)
159 vfprintf(stdout
, fmt
, args
);
163 #define SHOW(...) _show(__VA_ARGS__)
165 static int show_config(struct kmod_ctx
*ctx
)
167 struct config_iterators
{
169 struct kmod_config_iter
*(*get_iter
)(const struct kmod_ctx
*ctx
);
171 { "blacklist", kmod_config_get_blacklists
},
172 { "install", kmod_config_get_install_commands
},
173 { "remove", kmod_config_get_remove_commands
},
174 { "alias", kmod_config_get_aliases
},
175 { "options", kmod_config_get_options
},
176 { "softdep", kmod_config_get_softdeps
},
180 for (i
= 0; i
< ARRAY_SIZE(ci
); i
++) {
181 struct kmod_config_iter
*iter
= ci
[i
].get_iter(ctx
);
186 while (kmod_config_iter_next(iter
)) {
189 printf("%s %s", ci
[i
].name
,
190 kmod_config_iter_get_key(iter
));
191 val
= kmod_config_iter_get_value(iter
);
199 kmod_config_iter_free_iter(iter
);
202 puts("\n# End of configuration files. Dumping indexes now:\n");
205 kmod_dump_index(ctx
, KMOD_INDEX_MODULES_ALIAS
, STDOUT_FILENO
);
206 kmod_dump_index(ctx
, KMOD_INDEX_MODULES_SYMBOL
, STDOUT_FILENO
);
211 static int show_modversions(struct kmod_ctx
*ctx
, const char *filename
)
213 struct kmod_list
*l
, *list
= NULL
;
214 struct kmod_module
*mod
;
215 int err
= kmod_module_new_from_path(ctx
, filename
, &mod
);
217 LOG("Module %s not found.\n", filename
);
221 err
= kmod_module_get_versions(mod
, &list
);
223 LOG("could not get modversions of %s: %s\n",
224 filename
, strerror(-err
));
225 kmod_module_unref(mod
);
229 kmod_list_foreach(l
, list
) {
230 const char *symbol
= kmod_module_version_get_symbol(l
);
231 uint64_t crc
= kmod_module_version_get_crc(l
);
232 printf("0x%08"PRIx64
"\t%s\n", crc
, symbol
);
234 kmod_module_versions_free_list(list
);
235 kmod_module_unref(mod
);
239 static int show_exports(struct kmod_ctx
*ctx
, const char *filename
)
241 struct kmod_list
*l
, *list
= NULL
;
242 struct kmod_module
*mod
;
243 int err
= kmod_module_new_from_path(ctx
, filename
, &mod
);
245 LOG("Module %s not found.\n", filename
);
249 err
= kmod_module_get_symbols(mod
, &list
);
251 LOG("could not get symbols of %s: %s\n",
252 filename
, strerror(-err
));
253 kmod_module_unref(mod
);
257 kmod_list_foreach(l
, list
) {
258 const char *symbol
= kmod_module_symbol_get_symbol(l
);
259 uint64_t crc
= kmod_module_symbol_get_crc(l
);
260 printf("0x%08"PRIx64
"\t%s\n", crc
, symbol
);
262 kmod_module_symbols_free_list(list
);
263 kmod_module_unref(mod
);
267 static int command_do(struct kmod_module
*module
, const char *type
,
268 const char *command
, const char *cmdline_opts
)
270 const char *modname
= kmod_module_get_name(module
);
271 char *p
, *cmd
= NULL
;
272 size_t cmdlen
, cmdline_opts_len
, varlen
;
275 if (cmdline_opts
== NULL
)
277 cmdline_opts_len
= strlen(cmdline_opts
);
279 cmd
= strdup(command
);
282 cmdlen
= strlen(cmd
);
283 varlen
= sizeof("$CMDLINE_OPTS") - 1;
284 while ((p
= strstr(cmd
, "$CMDLINE_OPTS")) != NULL
) {
285 size_t prefixlen
= p
- cmd
;
286 size_t suffixlen
= cmdlen
- prefixlen
- varlen
;
287 size_t slen
= cmdlen
- varlen
+ cmdline_opts_len
;
288 char *suffix
= p
+ varlen
;
289 char *s
= malloc(slen
+ 1);
294 memcpy(s
, cmd
, p
- cmd
);
295 memcpy(s
+ prefixlen
, cmdline_opts
, cmdline_opts_len
);
296 memcpy(s
+ prefixlen
+ cmdline_opts_len
, suffix
, suffixlen
);
304 SHOW("%s %s\n", type
, cmd
);
308 setenv("MODPROBE_MODULE", modname
, 1);
310 unsetenv("MODPROBE_MODULE");
311 if (ret
== -1 || WEXITSTATUS(ret
)) {
312 LOG("Error running %s command for %s\n", type
, modname
);
314 ret
= -WEXITSTATUS(ret
);
322 static int rmmod_do_remove_module(struct kmod_module
*mod
)
324 const char *modname
= kmod_module_get_name(mod
);
327 SHOW("rmmod %s\n", modname
);
333 flags
|= KMOD_REMOVE_FORCE
;
335 err
= kmod_module_remove_module(mod
, flags
);
336 if (err
== -EEXIST
) {
340 LOG("Module %s is not in kernel.\n", modname
);
346 #define RMMOD_FLAG_REMOVE_HOLDERS 0x1
347 #define RMMOD_FLAG_IGNORE_BUILTIN 0x2
348 static int rmmod_do_module(struct kmod_module
*mod
, int flags
);
350 /* Remove modules in reverse order */
351 static int rmmod_do_modlist(struct kmod_list
*list
, bool stop_on_errors
)
355 kmod_list_foreach_reverse(l
, list
) {
356 struct kmod_module
*m
= kmod_module_get_module(l
);
357 int r
= rmmod_do_module(m
, RMMOD_FLAG_IGNORE_BUILTIN
);
358 kmod_module_unref(m
);
360 if (r
< 0 && stop_on_errors
)
367 static int rmmod_do_module(struct kmod_module
*mod
, int flags
)
369 const char *modname
= kmod_module_get_name(mod
);
370 struct kmod_list
*pre
= NULL
, *post
= NULL
;
371 const char *cmd
= NULL
;
374 if (!ignore_commands
) {
375 err
= kmod_module_get_softdeps(mod
, &pre
, &post
);
377 WRN("could not get softdeps of '%s': %s\n",
378 modname
, strerror(-err
));
382 cmd
= kmod_module_get_remove_commands(mod
);
385 /* Quick check if module is loaded, otherwise there's nothing to do */
386 if (!cmd
&& !ignore_loaded
) {
387 int state
= kmod_module_get_initstate(mod
);
391 LOG("Module %s is not in kernel.\n", modname
);
397 } else if (state
== KMOD_MODULE_BUILTIN
) {
398 if (flags
& RMMOD_FLAG_IGNORE_BUILTIN
) {
401 LOG("Module %s is builtin.\n", modname
);
408 /* 1. @mod's post-softdeps in reverse order */
409 rmmod_do_modlist(post
, false);
411 /* 2. Other modules holding @mod */
412 if (flags
& RMMOD_FLAG_REMOVE_HOLDERS
) {
413 struct kmod_list
*holders
= kmod_module_get_holders(mod
);
415 err
= rmmod_do_modlist(holders
, true);
420 /* 3. @mod itself, but check for refcnt first */
421 if (!cmd
&& !ignore_loaded
) {
422 int usage
= kmod_module_get_refcnt(mod
);
426 LOG("Module %s is in use.\n", modname
);
434 err
= rmmod_do_remove_module(mod
);
436 err
= command_do(mod
, "remove", cmd
, NULL
);
441 /* 4. Other modules that became unused: errors are non-fatal */
443 struct kmod_list
*deps
, *itr
;
445 deps
= kmod_module_get_dependencies(mod
);
446 kmod_list_foreach(itr
, deps
) {
447 struct kmod_module
*dep
= kmod_module_get_module(itr
);
448 if (kmod_module_get_refcnt(dep
) == 0)
449 rmmod_do_remove_module(dep
);
450 kmod_module_unref(dep
);
452 kmod_module_unref_list(deps
);
455 /* 5. @mod's pre-softdeps in reverse order: errors are non-fatal */
456 rmmod_do_modlist(pre
, false);
459 kmod_module_unref_list(pre
);
460 kmod_module_unref_list(post
);
465 static int rmmod(struct kmod_ctx
*ctx
, const char *alias
)
467 struct kmod_list
*l
, *list
= NULL
;
470 err
= kmod_module_new_from_lookup(ctx
, alias
, &list
);
475 LOG("Module %s not found.\n", alias
);
479 kmod_list_foreach(l
, list
) {
480 struct kmod_module
*mod
= kmod_module_get_module(l
);
481 int flags
= remove_holders
? RMMOD_FLAG_REMOVE_HOLDERS
: 0;
483 err
= rmmod_do_module(mod
, flags
);
484 kmod_module_unref(mod
);
489 kmod_module_unref_list(list
);
493 static int rmmod_all(struct kmod_ctx
*ctx
, char **args
, int nargs
)
497 for (i
= 0; i
< nargs
; i
++) {
498 int r
= rmmod(ctx
, args
[i
]);
506 static void print_action(struct kmod_module
*m
, bool install
,
512 printf("install %s %s\n", kmod_module_get_install_commands(m
),
517 path
= kmod_module_get_path(m
);
521 * Either a builtin module, or an alias, print only for
524 if (kmod_module_get_initstate(m
) == KMOD_MODULE_BUILTIN
)
525 printf("builtin %s\n", kmod_module_get_name(m
));
527 printf("insmod %s %s\n", kmod_module_get_path(m
), options
);
530 static int insmod(struct kmod_ctx
*ctx
, const char *alias
,
531 const char *extra_options
)
533 struct kmod_list
*l
, *list
= NULL
;
536 void (*show
)(struct kmod_module
*m
, bool install
,
537 const char *options
) = NULL
;
539 err
= kmod_module_new_from_lookup(ctx
, alias
, &list
);
541 if (list
== NULL
|| err
< 0) {
542 LOG("Module %s not found in directory %s\n", alias
,
543 ctx
? kmod_get_dirname(ctx
) : "(missing)");
547 if (strip_modversion
|| force
)
548 flags
|= KMOD_PROBE_FORCE_MODVERSION
;
549 if (strip_vermagic
|| force
)
550 flags
|= KMOD_PROBE_FORCE_VERMAGIC
;
552 flags
|= KMOD_PROBE_IGNORE_COMMAND
;
554 flags
|= KMOD_PROBE_IGNORE_LOADED
;
556 flags
|= KMOD_PROBE_DRY_RUN
;
557 if (do_show
|| verbose
> DEFAULT_VERBOSE
)
558 show
= &print_action
;
560 flags
|= KMOD_PROBE_APPLY_BLACKLIST_ALIAS_ONLY
;
563 flags
|= KMOD_PROBE_APPLY_BLACKLIST
;
565 flags
|= KMOD_PROBE_FAIL_ON_LOADED
;
567 kmod_list_foreach(l
, list
) {
568 struct kmod_module
*mod
= kmod_module_get_module(l
);
571 printf("%s\n", kmod_module_get_name(mod
));
573 err
= kmod_module_probe_insert_module(mod
, flags
,
574 extra_options
, NULL
, NULL
, show
);
578 /* ignore flag return values such as a mod being blacklisted */
583 ERR("could not insert '%s': Module already in kernel\n",
584 kmod_module_get_name(mod
));
587 ERR("could not insert '%s': Unknown symbol in module, "
588 "or unknown parameter (see dmesg)\n",
589 kmod_module_get_name(mod
));
592 ERR("could not insert '%s': %s\n",
593 kmod_module_get_name(mod
),
599 kmod_module_unref(mod
);
602 kmod_module_unref_list(list
);
606 static int insmod_all(struct kmod_ctx
*ctx
, char **args
, int nargs
)
610 for (i
= 0; i
< nargs
; i
++) {
611 int r
= insmod(ctx
, args
[i
], NULL
);
619 static void env_modprobe_options_append(const char *value
)
621 const char *old
= getenv("MODPROBE_OPTIONS");
625 setenv("MODPROBE_OPTIONS", value
, 1);
629 if (asprintf(&env
, "%s %s", old
, value
) < 0) {
630 ERR("could not append value to $MODPROBE_OPTIONS\n");
634 if (setenv("MODPROBE_OPTIONS", env
, 1) < 0)
635 ERR("could not setenv(MODPROBE_OPTIONS, \"%s\")\n", env
);
639 static int options_from_array(char **args
, int nargs
, char **output
)
645 for (i
= 1; i
< nargs
; i
++) {
646 size_t len
= strlen(args
[i
]);
651 value
= strchr(args
[i
], '=');
654 if (*value
!= '"' && *value
!= '\'') {
655 if (strchr(value
, ' '))
660 tmp
= realloc(opts
, optslen
+ len
+ qlen
+ 2);
665 ERR("could not gather module options: out-of-memory\n");
674 memcpy(opts
+ optslen
, args
[i
], len
+ 1);
677 size_t keylen
= value
- args
[i
];
678 size_t valuelen
= len
- keylen
;
679 memcpy(opts
+ optslen
, args
[i
], keylen
);
683 memcpy(opts
+ optslen
, value
, valuelen
);
687 opts
[optslen
] = '\0';
695 static char **prepend_options_from_env(int *p_argc
, char **orig_argv
)
697 const char *p
, *env
= getenv("MODPROBE_OPTIONS");
698 char **new_argv
, *str_end
, *str
, *s
, *quote
;
699 int i
, argc
= *p_argc
;
700 size_t envlen
, space_count
= 0;
705 for (p
= env
; *p
!= '\0'; p
++) {
711 new_argv
= malloc(sizeof(char *) * (argc
+ space_count
+ 3 + envlen
));
712 if (new_argv
== NULL
)
715 new_argv
[0] = orig_argv
[0];
716 str
= (char *) (new_argv
+ argc
+ space_count
+ 3);
717 memcpy(str
, env
, envlen
+ 1);
719 str_end
= str
+ envlen
;
722 for (i
= 1, s
= str
; *s
!= '\0'; s
++) {
729 } else if (*s
== '"' || *s
== '\'')
734 new_argv
[i
] = str
+ 1;
740 for (it
= quote
; it
< s
- 1; it
++)
742 for (it
= s
- 1; it
< str_end
- 2; it
++)
757 memcpy(new_argv
+ i
, orig_argv
+ 1, sizeof(char *) * (argc
- 1));
758 new_argv
[i
+ argc
- 1] = NULL
;
759 *p_argc
= i
+ argc
- 1;
764 static int do_modprobe(int argc
, char **orig_argv
)
766 struct kmod_ctx
*ctx
;
767 char **args
= NULL
, **argv
;
768 const char **config_paths
= NULL
;
769 int nargs
= 0, n_config_paths
= 0;
770 char dirname_buf
[PATH_MAX
];
771 const char *dirname
= NULL
;
772 const char *root
= NULL
;
773 const char *kversion
= NULL
;
776 int do_show_config
= 0;
777 int do_show_modversions
= 0;
778 int do_show_exports
= 0;
781 argv
= prepend_options_from_env(&argc
, orig_argv
);
783 ERR("Could not prepend options from command line\n");
789 c
= getopt_long(argc
, argv
, cmdopts_s
, cmdopts
, &idx
);
794 log_priority
= LOG_WARNING
;
819 strip_modversion
= 1;
833 do_show_modversions
= 1;
842 size_t bytes
= sizeof(char *) * (n_config_paths
+ 2);
843 void *tmp
= realloc(config_paths
, bytes
);
845 ERR("out-of-memory\n");
850 config_paths
[n_config_paths
] = optarg
;
852 config_paths
[n_config_paths
] = NULL
;
854 env_modprobe_options_append("-C");
855 env_modprobe_options_append(optarg
);
865 env_modprobe_options_append("-s");
869 env_modprobe_options_append("-q");
873 env_modprobe_options_append("-v");
877 puts(PACKAGE
" version " VERSION
);
889 ERR("unexpected getopt_long() value '%c'.\n", c
);
895 args
= argv
+ optind
;
896 nargs
= argc
- optind
;
898 log_open(use_syslog
);
900 if (!do_show_config
) {
902 ERR("missing parameters. See -h.\n");
908 if (root
!= NULL
|| kversion
!= NULL
) {
912 if (kversion
== NULL
) {
914 ERR("uname() failed: %m\n");
918 kversion
= u
.release
;
920 snprintf(dirname_buf
, sizeof(dirname_buf
),
921 "%s/lib/modules/%s", root
,
923 dirname
= dirname_buf
;
926 ctx
= kmod_new(dirname
, config_paths
);
928 ERR("kmod_new() failed!\n");
933 log_setup_kmod_log(ctx
, verbose
);
935 kmod_load_resources(ctx
);
938 err
= show_config(ctx
);
939 else if (do_show_modversions
)
940 err
= show_modversions(ctx
, args
[0]);
941 else if (do_show_exports
)
942 err
= show_exports(ctx
, args
[0]);
944 err
= rmmod_all(ctx
, args
, nargs
);
946 err
= insmod_all(ctx
, args
, nargs
);
949 err
= options_from_array(args
, nargs
, &opts
);
951 err
= insmod(ctx
, args
[0], opts
);
961 if (argv
!= orig_argv
)
966 return err
>= 0 ? EXIT_SUCCESS
: EXIT_FAILURE
;
969 const struct kmod_cmd kmod_cmd_compat_modprobe
= {
972 .help
= "compat modprobe command",