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/>.
27 #include <sys/types.h>
29 #include <sys/utsname.h>
35 #include "libkmod-array.h"
40 static int log_priority
= LOG_CRIT
;
41 static int use_syslog
= 0;
42 #define LOG(...) log_printf(log_priority, __VA_ARGS__)
44 #define DEFAULT_VERBOSE LOG_WARNING
45 static int verbose
= DEFAULT_VERBOSE
;
46 static int do_show
= 0;
47 static int dry_run
= 0;
48 static int ignore_loaded
= 0;
49 static int lookup_only
= 0;
50 static int first_time
= 0;
51 static int ignore_commands
= 0;
52 static int use_blacklist
= 0;
54 static int strip_modversion
= 0;
55 static int strip_vermagic
= 0;
56 static int remove_dependencies
= 0;
57 static int quiet_inuse
= 0;
59 static const char cmdopts_s
[] = "arRibfDcnC:d:S:sqvVh";
60 static const struct option cmdopts
[] = {
61 {"all", no_argument
, 0, 'a'},
62 {"remove", no_argument
, 0, 'r'},
63 {"remove-dependencies", no_argument
, 0, 5},
64 {"resolve-alias", no_argument
, 0, 'R'},
65 {"first-time", no_argument
, 0, 3},
66 {"ignore-install", no_argument
, 0, 'i'},
67 {"ignore-remove", no_argument
, 0, 'i'},
68 {"use-blacklist", no_argument
, 0, 'b'},
69 {"force", no_argument
, 0, 'f'},
70 {"force-modversion", no_argument
, 0, 2},
71 {"force-vermagic", no_argument
, 0, 1},
73 {"show-depends", no_argument
, 0, 'D'},
74 {"showconfig", no_argument
, 0, 'c'},
75 {"show-config", no_argument
, 0, 'c'},
76 {"show-modversions", no_argument
, 0, 4},
77 {"dump-modversions", no_argument
, 0, 4},
79 {"dry-run", no_argument
, 0, 'n'},
80 {"show", no_argument
, 0, 'n'},
82 {"config", required_argument
, 0, 'C'},
83 {"dirname", required_argument
, 0, 'd'},
84 {"set-version", required_argument
, 0, 'S'},
86 {"syslog", no_argument
, 0, 's'},
87 {"quiet", no_argument
, 0, 'q'},
88 {"verbose", no_argument
, 0, 'v'},
89 {"version", no_argument
, 0, 'V'},
90 {"help", no_argument
, 0, 'h'},
94 static void help(void)
97 "\t%s [options] [-i] [-b] modulename\n"
98 "\t%s [options] -a [-i] [-b] modulename [modulename...]\n"
99 "\t%s [options] -r [-i] modulename\n"
100 "\t%s [options] -r -a [-i] modulename [modulename...]\n"
101 "\t%s [options] -c\n"
102 "\t%s [options] --dump-modversions filename\n"
103 "Management Options:\n"
104 "\t-a, --all Consider every non-argument to\n"
105 "\t be a module name to be inserted\n"
106 "\t or removed (-r)\n"
107 "\t-r, --remove Remove modules instead of inserting\n"
108 "\t --remove-dependencies Also remove modules depending on it\n"
109 "\t-R, --resolve-alias Only lookup and print alias and exit\n"
110 "\t --first-time Fail if module already inserted or removed\n"
111 "\t-i, --ignore-install Ignore install commands\n"
112 "\t-i, --ignore-remove Ignore remove commands\n"
113 "\t-b, --use-blacklist Apply blacklist to resolved alias.\n"
114 "\t-f, --force Force module insertion or removal.\n"
115 "\t implies --force-modversions and\n"
116 "\t --force-vermagic\n"
117 "\t --force-modversion Ignore module's version\n"
118 "\t --force-vermagic Ignore module's version magic\n"
121 "\t-D, --show-depends Only print module dependencies and exit\n"
122 "\t-c, --showconfig Print out known configuration and exit\n"
123 "\t-c, --show-config Same as --showconfig\n"
124 "\t --show-modversions Dump module symbol version and exit\n"
125 "\t --dump-modversions Same as --show-modversions\n"
128 "\t-n, --dry-run Do not execute operations, just print out\n"
129 "\t-n, --show Same as --dry-run\n"
131 "\t-C, --config=FILE Use FILE instead of default search paths\n"
132 "\t-d, --dirname=DIR Use DIR as filesystem root for /lib/modules\n"
133 "\t-S, --set-version=VERSION Use VERSION instead of `uname -r`\n"
135 "\t-s, --syslog print to syslog, not stderr\n"
136 "\t-q, --quiet disable messages\n"
137 "\t-v, --verbose enables more messages\n"
138 "\t-V, --version show version\n"
139 "\t-h, --help show this help\n",
140 program_invocation_short_name
, program_invocation_short_name
,
141 program_invocation_short_name
, program_invocation_short_name
,
142 program_invocation_short_name
, program_invocation_short_name
);
145 static inline void _show(const char *fmt
, ...)
149 if (!do_show
&& verbose
<= DEFAULT_VERBOSE
)
153 vfprintf(stdout
, fmt
, args
);
157 #define SHOW(...) _show(__VA_ARGS__)
159 static int show_config(struct kmod_ctx
*ctx
)
161 struct config_iterators
{
163 struct kmod_config_iter
*(*get_iter
)(const struct kmod_ctx
*ctx
);
165 { "blacklist", kmod_config_get_blacklists
},
166 { "install", kmod_config_get_install_commands
},
167 { "remove", kmod_config_get_remove_commands
},
168 { "alias", kmod_config_get_aliases
},
169 { "options", kmod_config_get_options
},
170 { "softdep", kmod_config_get_softdeps
},
174 for (i
= 0; i
< ARRAY_SIZE(ci
); i
++) {
175 struct kmod_config_iter
*iter
= ci
[i
].get_iter(ctx
);
180 while (kmod_config_iter_next(iter
)) {
183 printf("%s %s", ci
[i
].name
,
184 kmod_config_iter_get_key(iter
));
185 val
= kmod_config_iter_get_value(iter
);
193 kmod_config_iter_free_iter(iter
);
196 puts("\n# End of configuration files. Dumping indexes now:\n");
199 kmod_dump_index(ctx
, KMOD_INDEX_MODULES_ALIAS
, STDOUT_FILENO
);
200 kmod_dump_index(ctx
, KMOD_INDEX_MODULES_SYMBOL
, STDOUT_FILENO
);
205 static int show_modversions(struct kmod_ctx
*ctx
, const char *filename
)
207 struct kmod_list
*l
, *list
= NULL
;
208 struct kmod_module
*mod
;
209 int err
= kmod_module_new_from_path(ctx
, filename
, &mod
);
211 LOG("Module %s not found.\n", filename
);
215 err
= kmod_module_get_versions(mod
, &list
);
217 LOG("could not get modversions of %s: %s\n",
218 filename
, strerror(-err
));
219 kmod_module_unref(mod
);
223 kmod_list_foreach(l
, list
) {
224 const char *symbol
= kmod_module_version_get_symbol(l
);
225 uint64_t crc
= kmod_module_version_get_crc(l
);
226 printf("0x%08"PRIx64
"\t%s\n", crc
, symbol
);
228 kmod_module_versions_free_list(list
);
229 kmod_module_unref(mod
);
233 static int command_do(struct kmod_module
*module
, const char *type
,
234 const char *command
, const char *cmdline_opts
)
236 const char *modname
= kmod_module_get_name(module
);
237 char *p
, *cmd
= NULL
;
238 size_t cmdlen
, cmdline_opts_len
, varlen
;
241 if (cmdline_opts
== NULL
)
243 cmdline_opts_len
= strlen(cmdline_opts
);
245 cmd
= strdup(command
);
248 cmdlen
= strlen(cmd
);
249 varlen
= sizeof("$CMDLINE_OPTS") - 1;
250 while ((p
= strstr(cmd
, "$CMDLINE_OPTS")) != NULL
) {
251 size_t prefixlen
= p
- cmd
;
252 size_t suffixlen
= cmdlen
- prefixlen
- varlen
;
253 size_t slen
= cmdlen
- varlen
+ cmdline_opts_len
;
254 char *suffix
= p
+ varlen
;
255 char *s
= malloc(slen
+ 1);
260 memcpy(s
, cmd
, p
- cmd
);
261 memcpy(s
+ prefixlen
, cmdline_opts
, cmdline_opts_len
);
262 memcpy(s
+ prefixlen
+ cmdline_opts_len
, suffix
, suffixlen
);
270 SHOW("%s %s\n", type
, cmd
);
274 setenv("MODPROBE_MODULE", modname
, 1);
276 unsetenv("MODPROBE_MODULE");
277 if (ret
== -1 || WEXITSTATUS(ret
)) {
278 LOG("Error running %s command for %s\n", type
, modname
);
280 ret
= -WEXITSTATUS(ret
);
288 static int rmmod_do_remove_module(struct kmod_module
*mod
)
290 const char *modname
= kmod_module_get_name(mod
);
291 struct kmod_list
*deps
, *itr
;
294 SHOW("rmmod %s\n", kmod_module_get_name(mod
));
300 flags
|= KMOD_REMOVE_FORCE
;
302 err
= kmod_module_remove_module(mod
, flags
);
303 if (err
== -EEXIST
) {
307 LOG("Module %s is not in kernel.\n", modname
);
310 deps
= kmod_module_get_dependencies(mod
);
312 kmod_list_foreach(itr
, deps
) {
313 struct kmod_module
*dep
= kmod_module_get_module(itr
);
314 if (kmod_module_get_refcnt(dep
) == 0)
315 rmmod_do_remove_module(dep
);
316 kmod_module_unref(dep
);
318 kmod_module_unref_list(deps
);
324 static int rmmod_do_module(struct kmod_module
*mod
, bool do_dependencies
);
326 static int rmmod_do_deps_list(struct kmod_list
*list
, bool stop_on_errors
)
330 kmod_list_foreach_reverse(l
, list
) {
331 struct kmod_module
*m
= kmod_module_get_module(l
);
332 int r
= rmmod_do_module(m
, false);
333 kmod_module_unref(m
);
335 if (r
< 0 && stop_on_errors
)
342 static int rmmod_do_module(struct kmod_module
*mod
, bool do_dependencies
)
344 const char *modname
= kmod_module_get_name(mod
);
345 struct kmod_list
*pre
= NULL
, *post
= NULL
;
346 const char *cmd
= NULL
;
349 if (!ignore_commands
) {
350 err
= kmod_module_get_softdeps(mod
, &pre
, &post
);
352 WRN("could not get softdeps of '%s': %s\n",
353 modname
, strerror(-err
));
357 cmd
= kmod_module_get_remove_commands(mod
);
360 if (cmd
== NULL
&& !ignore_loaded
) {
361 int state
= kmod_module_get_initstate(mod
);
365 LOG("Module %s is not in kernel.\n", modname
);
371 } else if (state
== KMOD_MODULE_BUILTIN
) {
372 LOG("Module %s is builtin.\n", modname
);
378 rmmod_do_deps_list(post
, false);
380 if (do_dependencies
&& remove_dependencies
) {
381 struct kmod_list
*deps
= kmod_module_get_dependencies(mod
);
383 err
= rmmod_do_deps_list(deps
, true);
388 if (!ignore_loaded
) {
389 int usage
= kmod_module_get_refcnt(mod
);
393 LOG("Module %s is in use.\n", modname
);
401 err
= rmmod_do_remove_module(mod
);
403 err
= command_do(mod
, "remove", cmd
, NULL
);
408 rmmod_do_deps_list(pre
, false);
411 kmod_module_unref_list(pre
);
412 kmod_module_unref_list(post
);
417 static int rmmod(struct kmod_ctx
*ctx
, const char *alias
)
419 struct kmod_list
*l
, *list
= NULL
;
422 err
= kmod_module_new_from_lookup(ctx
, alias
, &list
);
427 LOG("Module %s not found.\n", alias
);
431 kmod_list_foreach(l
, list
) {
432 struct kmod_module
*mod
= kmod_module_get_module(l
);
433 err
= rmmod_do_module(mod
, true);
434 kmod_module_unref(mod
);
439 kmod_module_unref_list(list
);
443 static int rmmod_all(struct kmod_ctx
*ctx
, char **args
, int nargs
)
447 for (i
= 0; i
< nargs
; i
++) {
448 int r
= rmmod(ctx
, args
[i
]);
456 static int handle_failed_lookup(struct kmod_ctx
*ctx
, const char *alias
)
458 struct kmod_module
*mod
;
461 DBG("lookup failed - trying to check if it's builtin\n");
463 err
= kmod_module_new_from_name(ctx
, alias
, &mod
);
467 state
= kmod_module_get_initstate(mod
);
468 kmod_module_unref(mod
);
470 if (state
!= KMOD_MODULE_BUILTIN
) {
471 LOG("Module %s not found.\n", alias
);
476 LOG("Module %s already in kernel (builtin).\n", alias
);
480 SHOW("builtin %s\n", alias
);
484 static void print_action(struct kmod_module
*m
, bool install
,
490 printf("install %s %s\n", kmod_module_get_install_commands(m
),
495 path
= kmod_module_get_path(m
);
498 assert(kmod_module_get_initstate(m
) == KMOD_MODULE_BUILTIN
);
499 printf("builtin %s\n", kmod_module_get_name(m
));
501 printf("insmod %s %s\n", kmod_module_get_path(m
), options
);
504 static int insmod(struct kmod_ctx
*ctx
, const char *alias
,
505 const char *extra_options
)
507 struct kmod_list
*l
, *list
= NULL
;
510 void (*show
)(struct kmod_module
*m
, bool install
,
511 const char *options
) = NULL
;
513 err
= kmod_module_new_from_lookup(ctx
, alias
, &list
);
518 return handle_failed_lookup(ctx
, alias
);
520 if (strip_modversion
|| force
)
521 flags
|= KMOD_PROBE_FORCE_MODVERSION
;
522 if (strip_vermagic
|| force
)
523 flags
|= KMOD_PROBE_FORCE_VERMAGIC
;
525 flags
|= KMOD_PROBE_IGNORE_COMMAND
;
527 flags
|= KMOD_PROBE_IGNORE_LOADED
;
529 flags
|= KMOD_PROBE_DRY_RUN
;
530 if (do_show
|| verbose
> DEFAULT_VERBOSE
)
531 show
= &print_action
;
533 flags
|= KMOD_PROBE_APPLY_BLACKLIST_ALIAS_ONLY
;
536 flags
|= KMOD_PROBE_APPLY_BLACKLIST
;
538 flags
|= KMOD_PROBE_FAIL_ON_LOADED
;
540 kmod_list_foreach(l
, list
) {
541 struct kmod_module
*mod
= kmod_module_get_module(l
);
544 printf("%s\n", kmod_module_get_name(mod
));
546 err
= kmod_module_probe_insert_module(mod
, flags
,
547 extra_options
, NULL
, NULL
, show
);
551 /* ignore flag return values such as a mod being blacklisted */
556 ERR("could not insert '%s': Module already in kernel\n",
557 kmod_module_get_name(mod
));
560 ERR("could not insert '%s': Unknown symbol in module, "
561 "or unknown parameter (see dmesg)\n",
562 kmod_module_get_name(mod
));
565 ERR("could not insert '%s': %s\n",
566 kmod_module_get_name(mod
),
572 kmod_module_unref(mod
);
575 kmod_module_unref_list(list
);
579 static int insmod_all(struct kmod_ctx
*ctx
, char **args
, int nargs
)
583 for (i
= 0; i
< nargs
; i
++) {
584 int r
= insmod(ctx
, args
[i
], NULL
);
592 static void env_modprobe_options_append(const char *value
)
594 const char *old
= getenv("MODPROBE_OPTIONS");
598 setenv("MODPROBE_OPTIONS", value
, 1);
602 if (asprintf(&env
, "%s %s", old
, value
) < 0) {
603 ERR("could not append value to $MODPROBE_OPTIONS\n");
607 if (setenv("MODPROBE_OPTIONS", env
, 1) < 0)
608 ERR("could not setenv(MODPROBE_OPTIONS, \"%s\")\n", env
);
612 static int options_from_array(char **args
, int nargs
, char **output
)
618 for (i
= 1; i
< nargs
; i
++) {
619 size_t len
= strlen(args
[i
]);
624 value
= strchr(args
[i
], '=');
627 if (*value
!= '"' && *value
!= '\'') {
628 if (strchr(value
, ' '))
633 tmp
= realloc(opts
, optslen
+ len
+ qlen
+ 2);
638 ERR("could not gather module options: out-of-memory\n");
647 memcpy(opts
+ optslen
, args
[i
], len
+ 1);
650 size_t keylen
= value
- args
[i
];
651 size_t valuelen
= len
- keylen
;
652 memcpy(opts
+ optslen
, args
[i
], keylen
);
656 memcpy(opts
+ optslen
, value
, valuelen
);
660 opts
[optslen
] = '\0';
668 static char **prepend_options_from_env(int *p_argc
, char **orig_argv
)
670 const char *p
, *env
= getenv("MODPROBE_OPTIONS");
671 char **new_argv
, *str_start
, *str_end
, *str
, *s
, *quote
;
672 int i
, argc
= *p_argc
;
673 size_t envlen
, space_count
= 0;
678 for (p
= env
; *p
!= '\0'; p
++) {
684 new_argv
= malloc(sizeof(char *) * (argc
+ space_count
+ 3 + envlen
));
685 if (new_argv
== NULL
)
688 new_argv
[0] = orig_argv
[0];
689 str_start
= str
= (char *) (new_argv
+ argc
+ space_count
+ 3);
690 memcpy(str
, env
, envlen
+ 1);
692 str_end
= str_start
+ envlen
;
695 for (i
= 1, s
= str
; *s
!= '\0'; s
++) {
702 } else if (*s
== '"' || *s
== '\'')
707 new_argv
[i
] = str
+ 1;
713 for (it
= quote
; it
< s
- 1; it
++)
715 for (it
= s
- 1; it
< str_end
- 2; it
++)
730 memcpy(new_argv
+ i
, orig_argv
+ 1, sizeof(char *) * (argc
- 1));
731 new_argv
[i
+ argc
] = NULL
;
732 *p_argc
= i
+ argc
- 1;
737 static int do_modprobe(int argc
, char **orig_argv
)
739 struct kmod_ctx
*ctx
;
740 char **args
= NULL
, **argv
;
741 const char **config_paths
= NULL
;
742 int nargs
= 0, n_config_paths
= 0;
743 char dirname_buf
[PATH_MAX
];
744 const char *dirname
= NULL
;
745 const char *root
= NULL
;
746 const char *kversion
= NULL
;
749 int do_show_config
= 0;
750 int do_show_modversions
= 0;
753 argv
= prepend_options_from_env(&argc
, orig_argv
);
755 ERR("Could not prepend options from command line\n");
761 c
= getopt_long(argc
, argv
, cmdopts_s
, cmdopts
, &idx
);
766 log_priority
= LOG_WARNING
;
773 remove_dependencies
= 1;
791 strip_modversion
= 1;
805 do_show_modversions
= 1;
811 size_t bytes
= sizeof(char *) * (n_config_paths
+ 2);
812 void *tmp
= realloc(config_paths
, bytes
);
814 ERR("out-of-memory\n");
819 config_paths
[n_config_paths
] = optarg
;
821 config_paths
[n_config_paths
] = NULL
;
823 env_modprobe_options_append("-C");
824 env_modprobe_options_append(optarg
);
834 env_modprobe_options_append("-s");
838 env_modprobe_options_append("-q");
842 env_modprobe_options_append("-v");
846 puts(PACKAGE
" version " VERSION
);
857 ERR("unexpected getopt_long() value '%c'.\n", c
);
863 args
= argv
+ optind
;
864 nargs
= argc
- optind
;
866 log_open(use_syslog
);
868 if (!do_show_config
) {
870 ERR("missing parameters. See -h.\n");
876 if (root
!= NULL
|| kversion
!= NULL
) {
880 if (kversion
== NULL
) {
882 ERR("uname() failed: %m\n");
886 kversion
= u
.release
;
888 snprintf(dirname_buf
, sizeof(dirname_buf
),
889 "%s/lib/modules/%s", root
,
891 dirname
= dirname_buf
;
894 ctx
= kmod_new(dirname
, config_paths
);
896 ERR("kmod_new() failed!\n");
901 log_setup_kmod_log(ctx
, verbose
);
903 kmod_load_resources(ctx
);
906 err
= show_config(ctx
);
907 else if (do_show_modversions
)
908 err
= show_modversions(ctx
, args
[0]);
910 err
= rmmod_all(ctx
, args
, nargs
);
912 err
= insmod_all(ctx
, args
, nargs
);
915 err
= options_from_array(args
, nargs
, &opts
);
917 err
= insmod(ctx
, args
[0], opts
);
927 if (argv
!= orig_argv
)
932 return err
>= 0 ? EXIT_SUCCESS
: EXIT_FAILURE
;
935 const struct kmod_cmd kmod_cmd_compat_modprobe
= {
938 .help
= "compat modprobe command",