2 * kmod-modprobe - manage linux kernel modules using libkmod.
4 * Copyright (C) 2011-2012 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>
36 #include "libkmod-array.h"
41 static int log_priority
= LOG_CRIT
;
42 static int use_syslog
= 0;
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 binname
, binname
, binname
, binname
, binname
, binname
);
143 static inline void _show(const char *fmt
, ...)
147 if (!do_show
&& verbose
<= DEFAULT_VERBOSE
)
151 vfprintf(stdout
, fmt
, args
);
156 static void _log(int prio
, const char *fmt
, ...)
158 const char *prioname
;
166 if (vasprintf(&msg
, fmt
, args
) < 0)
172 prioname
= prio_to_str(prio
);
175 syslog(prio
, "%s: %s", prioname
, msg
);
177 fprintf(stderr
, "modprobe: %s: %s", prioname
, msg
);
180 if (prio
<= LOG_CRIT
)
183 #define ERR(...) _log(LOG_ERR, __VA_ARGS__)
184 #define WRN(...) _log(LOG_WARNING, __VA_ARGS__)
185 #define INF(...) _log(LOG_INFO, __VA_ARGS__)
186 #define DBG(...) _log(LOG_DEBUG, __VA_ARGS__)
187 #define LOG(...) _log(log_priority, __VA_ARGS__)
188 #define SHOW(...) _show(__VA_ARGS__)
190 static int show_config(struct kmod_ctx
*ctx
)
192 struct config_iterators
{
194 struct kmod_config_iter
*(*get_iter
)(const struct kmod_ctx
*ctx
);
196 { "blacklist", kmod_config_get_blacklists
},
197 { "install", kmod_config_get_install_commands
},
198 { "remove", kmod_config_get_remove_commands
},
199 { "alias", kmod_config_get_aliases
},
200 { "options", kmod_config_get_options
},
201 { "softdep", kmod_config_get_softdeps
},
205 for (i
= 0; i
< ARRAY_SIZE(ci
); i
++) {
206 struct kmod_config_iter
*iter
= ci
[i
].get_iter(ctx
);
211 while (kmod_config_iter_next(iter
)) {
214 printf("%s %s", ci
[i
].name
,
215 kmod_config_iter_get_key(iter
));
216 val
= kmod_config_iter_get_value(iter
);
224 kmod_config_iter_free_iter(iter
);
227 puts("\n# End of configuration files. Dumping indexes now:\n");
230 kmod_dump_index(ctx
, KMOD_INDEX_MODULES_ALIAS
, STDOUT_FILENO
);
231 kmod_dump_index(ctx
, KMOD_INDEX_MODULES_SYMBOL
, STDOUT_FILENO
);
236 static int show_modversions(struct kmod_ctx
*ctx
, const char *filename
)
238 struct kmod_list
*l
, *list
= NULL
;
239 struct kmod_module
*mod
;
240 int err
= kmod_module_new_from_path(ctx
, filename
, &mod
);
242 LOG("Module %s not found.\n", filename
);
246 err
= kmod_module_get_versions(mod
, &list
);
248 LOG("could not get modversions of %s: %s\n",
249 filename
, strerror(-err
));
250 kmod_module_unref(mod
);
254 kmod_list_foreach(l
, list
) {
255 const char *symbol
= kmod_module_version_get_symbol(l
);
256 uint64_t crc
= kmod_module_version_get_crc(l
);
257 printf("0x%08"PRIx64
"\t%s\n", crc
, symbol
);
259 kmod_module_versions_free_list(list
);
260 kmod_module_unref(mod
);
264 static int command_do(struct kmod_module
*module
, const char *type
,
265 const char *command
, const char *cmdline_opts
)
267 const char *modname
= kmod_module_get_name(module
);
268 char *p
, *cmd
= NULL
;
269 size_t cmdlen
, cmdline_opts_len
, varlen
;
272 if (cmdline_opts
== NULL
)
274 cmdline_opts_len
= strlen(cmdline_opts
);
276 cmd
= strdup(command
);
279 cmdlen
= strlen(cmd
);
280 varlen
= sizeof("$CMDLINE_OPTS") - 1;
281 while ((p
= strstr(cmd
, "$CMDLINE_OPTS")) != NULL
) {
282 size_t prefixlen
= p
- cmd
;
283 size_t suffixlen
= cmdlen
- prefixlen
- varlen
;
284 size_t slen
= cmdlen
- varlen
+ cmdline_opts_len
;
285 char *suffix
= p
+ varlen
;
286 char *s
= malloc(slen
+ 1);
291 memcpy(s
, cmd
, p
- cmd
);
292 memcpy(s
+ prefixlen
, cmdline_opts
, cmdline_opts_len
);
293 memcpy(s
+ prefixlen
+ cmdline_opts_len
, suffix
, suffixlen
);
301 SHOW("%s %s\n", type
, cmd
);
305 setenv("MODPROBE_MODULE", modname
, 1);
307 unsetenv("MODPROBE_MODULE");
308 if (ret
== -1 || WEXITSTATUS(ret
)) {
309 LOG("Error running %s command for %s\n", type
, modname
);
311 ret
= -WEXITSTATUS(ret
);
319 static int rmmod_do_remove_module(struct kmod_module
*mod
)
321 const char *modname
= kmod_module_get_name(mod
);
322 struct kmod_list
*deps
, *itr
;
325 SHOW("rmmod %s\n", kmod_module_get_name(mod
));
331 flags
|= KMOD_REMOVE_FORCE
;
333 err
= kmod_module_remove_module(mod
, flags
);
334 if (err
== -EEXIST
) {
338 LOG("Module %s is not in kernel.\n", modname
);
341 deps
= kmod_module_get_dependencies(mod
);
343 kmod_list_foreach(itr
, deps
) {
344 struct kmod_module
*dep
= kmod_module_get_module(itr
);
345 if (kmod_module_get_refcnt(dep
) == 0)
346 rmmod_do_remove_module(dep
);
347 kmod_module_unref(dep
);
349 kmod_module_unref_list(deps
);
355 static int rmmod_do_module(struct kmod_module
*mod
, bool do_dependencies
);
357 static int rmmod_do_deps_list(struct kmod_list
*list
, bool stop_on_errors
)
361 kmod_list_foreach_reverse(l
, list
) {
362 struct kmod_module
*m
= kmod_module_get_module(l
);
363 int r
= rmmod_do_module(m
, false);
364 kmod_module_unref(m
);
366 if (r
< 0 && stop_on_errors
)
373 static int rmmod_do_module(struct kmod_module
*mod
, bool do_dependencies
)
375 const char *modname
= kmod_module_get_name(mod
);
376 struct kmod_list
*pre
= NULL
, *post
= NULL
;
377 const char *cmd
= NULL
;
380 if (!ignore_commands
) {
381 err
= kmod_module_get_softdeps(mod
, &pre
, &post
);
383 WRN("could not get softdeps of '%s': %s\n",
384 modname
, strerror(-err
));
388 cmd
= kmod_module_get_remove_commands(mod
);
391 if (cmd
== NULL
&& !ignore_loaded
) {
392 int state
= kmod_module_get_initstate(mod
);
396 LOG("Module %s is not in kernel.\n", modname
);
402 } else if (state
== KMOD_MODULE_BUILTIN
) {
403 LOG("Module %s is builtin.\n", modname
);
409 rmmod_do_deps_list(post
, false);
411 if (do_dependencies
&& remove_dependencies
) {
412 struct kmod_list
*deps
= kmod_module_get_dependencies(mod
);
414 err
= rmmod_do_deps_list(deps
, true);
419 if (!ignore_loaded
) {
420 int usage
= kmod_module_get_refcnt(mod
);
424 LOG("Module %s is in use.\n", modname
);
432 err
= rmmod_do_remove_module(mod
);
434 err
= command_do(mod
, "remove", cmd
, NULL
);
439 rmmod_do_deps_list(pre
, false);
442 kmod_module_unref_list(pre
);
443 kmod_module_unref_list(post
);
448 static int rmmod(struct kmod_ctx
*ctx
, const char *alias
)
450 struct kmod_list
*l
, *list
= NULL
;
453 err
= kmod_module_new_from_lookup(ctx
, alias
, &list
);
458 LOG("Module %s not found.\n", alias
);
462 kmod_list_foreach(l
, list
) {
463 struct kmod_module
*mod
= kmod_module_get_module(l
);
464 err
= rmmod_do_module(mod
, true);
465 kmod_module_unref(mod
);
470 kmod_module_unref_list(list
);
474 static int rmmod_all(struct kmod_ctx
*ctx
, char **args
, int nargs
)
478 for (i
= 0; i
< nargs
; i
++) {
479 int r
= rmmod(ctx
, args
[i
]);
487 static int handle_failed_lookup(struct kmod_ctx
*ctx
, const char *alias
)
489 struct kmod_module
*mod
;
492 DBG("lookup failed - trying to check if it's builtin\n");
494 err
= kmod_module_new_from_name(ctx
, alias
, &mod
);
498 state
= kmod_module_get_initstate(mod
);
499 kmod_module_unref(mod
);
501 if (state
!= KMOD_MODULE_BUILTIN
) {
502 LOG("Module %s not found.\n", alias
);
507 LOG("Module %s already in kernel (builtin).\n", alias
);
511 SHOW("builtin %s\n", alias
);
515 static void print_action(struct kmod_module
*m
, bool install
,
521 printf("install %s %s\n", kmod_module_get_install_commands(m
),
526 path
= kmod_module_get_path(m
);
529 assert(kmod_module_get_initstate(m
) == KMOD_MODULE_BUILTIN
);
530 printf("builtin %s\n", kmod_module_get_name(m
));
532 printf("insmod %s %s\n", kmod_module_get_path(m
), options
);
535 static int insmod(struct kmod_ctx
*ctx
, const char *alias
,
536 const char *extra_options
)
538 struct kmod_list
*l
, *list
= NULL
;
541 void (*show
)(struct kmod_module
*m
, bool install
,
542 const char *options
) = NULL
;
544 err
= kmod_module_new_from_lookup(ctx
, alias
, &list
);
549 return handle_failed_lookup(ctx
, alias
);
551 if (strip_modversion
|| force
)
552 flags
|= KMOD_PROBE_FORCE_MODVERSION
;
553 if (strip_vermagic
|| force
)
554 flags
|= KMOD_PROBE_FORCE_VERMAGIC
;
556 flags
|= KMOD_PROBE_IGNORE_COMMAND
;
558 flags
|= KMOD_PROBE_IGNORE_LOADED
;
560 flags
|= KMOD_PROBE_DRY_RUN
;
561 if (do_show
|| verbose
> DEFAULT_VERBOSE
)
562 show
= &print_action
;
564 flags
|= KMOD_PROBE_APPLY_BLACKLIST_ALIAS_ONLY
;
567 flags
|= KMOD_PROBE_APPLY_BLACKLIST
;
569 flags
|= KMOD_PROBE_FAIL_ON_LOADED
;
571 kmod_list_foreach(l
, list
) {
572 struct kmod_module
*mod
= kmod_module_get_module(l
);
575 printf("%s\n", kmod_module_get_name(mod
));
577 err
= kmod_module_probe_insert_module(mod
, flags
,
578 extra_options
, NULL
, NULL
, show
);
582 /* ignore flag return values such as a mod being blacklisted */
587 ERR("could not insert '%s': Module already in kernel\n",
588 kmod_module_get_name(mod
));
591 ERR("could not insert '%s': Unknown symbol in module, "
592 "or unknown parameter (see dmesg)\n",
593 kmod_module_get_name(mod
));
596 ERR("could not insert '%s': %s\n",
597 kmod_module_get_name(mod
),
603 kmod_module_unref(mod
);
606 kmod_module_unref_list(list
);
610 static int insmod_all(struct kmod_ctx
*ctx
, char **args
, int nargs
)
614 for (i
= 0; i
< nargs
; i
++) {
615 int r
= insmod(ctx
, args
[i
], NULL
);
623 static void env_modprobe_options_append(const char *value
)
625 const char *old
= getenv("MODPROBE_OPTIONS");
629 setenv("MODPROBE_OPTIONS", value
, 1);
633 if (asprintf(&env
, "%s %s", old
, value
) < 0) {
634 ERR("could not append value to $MODPROBE_OPTIONS\n");
638 if (setenv("MODPROBE_OPTIONS", env
, 1) < 0)
639 ERR("could not setenv(MODPROBE_OPTIONS, \"%s\")\n", env
);
643 static int options_from_array(char **args
, int nargs
, char **output
)
649 for (i
= 1; i
< nargs
; i
++) {
650 size_t len
= strlen(args
[i
]);
655 value
= strchr(args
[i
], '=');
658 if (*value
!= '"' && *value
!= '\'') {
659 if (strchr(value
, ' '))
664 tmp
= realloc(opts
, optslen
+ len
+ qlen
+ 2);
669 ERR("could not gather module options: out-of-memory\n");
678 memcpy(opts
+ optslen
, args
[i
], len
+ 1);
681 size_t keylen
= value
- args
[i
];
682 size_t valuelen
= len
- keylen
;
683 memcpy(opts
+ optslen
, args
[i
], keylen
);
687 memcpy(opts
+ optslen
, value
, valuelen
);
691 opts
[optslen
] = '\0';
699 static char **prepend_options_from_env(int *p_argc
, char **orig_argv
)
701 const char *p
, *env
= getenv("MODPROBE_OPTIONS");
702 char **new_argv
, *str_start
, *str_end
, *str
, *s
, *quote
;
703 int i
, argc
= *p_argc
;
704 size_t envlen
, space_count
= 0;
709 for (p
= env
; *p
!= '\0'; p
++) {
715 new_argv
= malloc(sizeof(char *) * (argc
+ space_count
+ 3 + envlen
));
716 if (new_argv
== NULL
)
719 new_argv
[0] = orig_argv
[0];
720 str_start
= str
= (char *) (new_argv
+ argc
+ space_count
+ 3);
721 memcpy(str
, env
, envlen
+ 1);
723 str_end
= str_start
+ envlen
;
726 for (i
= 1, s
= str
; *s
!= '\0'; s
++) {
733 } else if (*s
== '"' || *s
== '\'')
738 new_argv
[i
] = str
+ 1;
744 for (it
= quote
; it
< s
- 1; it
++)
746 for (it
= s
- 1; it
< str_end
- 2; it
++)
761 memcpy(new_argv
+ i
, orig_argv
+ 1, sizeof(char *) * (argc
- 1));
762 new_argv
[i
+ argc
] = NULL
;
763 *p_argc
= i
+ argc
- 1;
768 static int do_modprobe(int argc
, char **orig_argv
)
770 struct kmod_ctx
*ctx
;
771 char **args
= NULL
, **argv
;
772 const char **config_paths
= NULL
;
773 int nargs
= 0, n_config_paths
= 0;
774 char dirname_buf
[PATH_MAX
];
775 const char *dirname
= NULL
;
776 const char *root
= NULL
;
777 const char *kversion
= NULL
;
780 int do_show_config
= 0;
781 int do_show_modversions
= 0;
784 argv
= prepend_options_from_env(&argc
, orig_argv
);
786 ERR("Could not prepend options from command line\n");
792 c
= getopt_long(argc
, argv
, cmdopts_s
, cmdopts
, &idx
);
797 log_priority
= LOG_WARNING
;
804 remove_dependencies
= 1;
822 strip_modversion
= 1;
836 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
);
888 ERR("unexpected getopt_long() value '%c'.\n", c
);
894 args
= argv
+ optind
;
895 nargs
= argc
- optind
;
897 log_open(use_syslog
);
899 if (!do_show_config
) {
901 ERR("missing parameters. See -h.\n");
907 if (root
!= NULL
|| kversion
!= NULL
) {
911 if (kversion
== NULL
) {
913 ERR("uname() failed: %m\n");
917 kversion
= u
.release
;
919 snprintf(dirname_buf
, sizeof(dirname_buf
),
920 "%s/lib/modules/%s", root
,
922 dirname
= dirname_buf
;
925 ctx
= kmod_new(dirname
, config_paths
);
927 ERR("kmod_new() failed!\n");
932 log_setup_kmod_log(ctx
, verbose
);
934 kmod_load_resources(ctx
);
937 err
= show_config(ctx
);
938 else if (do_show_modversions
)
939 err
= show_modversions(ctx
, args
[0]);
941 err
= rmmod_all(ctx
, args
, nargs
);
943 err
= insmod_all(ctx
, args
, nargs
);
946 err
= options_from_array(args
, nargs
, &opts
);
948 err
= insmod(ctx
, args
[0], opts
);
958 if (argv
!= orig_argv
)
963 return err
>= 0 ? EXIT_SUCCESS
: EXIT_FAILURE
;
966 const struct kmod_cmd kmod_cmd_compat_modprobe
= {
969 .help
= "compat modprobe command",