]> git.ipfire.org Git - thirdparty/kmod.git/blobdiff - tools/modprobe.c
modprobe: Move -R to "Query options"
[thirdparty/kmod.git] / tools / modprobe.c
index 4cd664595ae59956b57e57862a31ae84eec9ee1e..caaf87f443dbafcede18186868d2154026f36f8f 100644 (file)
@@ -1,7 +1,7 @@
 /*
  * kmod-modprobe - manage linux kernel modules using libkmod.
  *
- * Copyright (C) 2011-2012  ProFUSION embedded systems
+ * Copyright (C) 2011-2013  ProFUSION embedded systems
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  */
 
 #include <assert.h>
+#include <errno.h>
+#include <getopt.h>
+#include <limits.h>
+#include <stdbool.h>
 #include <stdio.h>
 #include <stdlib.h>
-#include <stdbool.h>
-#include <getopt.h>
-#include <errno.h>
 #include <string.h>
-#include <sys/types.h>
+#include <unistd.h>
 #include <sys/stat.h>
+#include <sys/types.h>
 #include <sys/utsname.h>
 #include <sys/wait.h>
-#include <unistd.h>
-#include <syslog.h>
-#include <limits.h>
 
-#include "libkmod.h"
-#include "libkmod-array.h"
-#include "macro.h"
+#include <shared/array.h>
+#include <shared/macro.h>
+
+#include <libkmod/libkmod.h>
 
 #include "kmod.h"
 
 static int log_priority = LOG_CRIT;
 static int use_syslog = 0;
+#define LOG(...) log_printf(log_priority, __VA_ARGS__)
 
 #define DEFAULT_VERBOSE LOG_WARNING
 static int verbose = DEFAULT_VERBOSE;
@@ -53,7 +54,7 @@ static int use_blacklist = 0;
 static int force = 0;
 static int strip_modversion = 0;
 static int strip_vermagic = 0;
-static int remove_dependencies = 0;
+static int remove_holders = 0;
 static int quiet_inuse = 0;
 
 static const char cmdopts_s[] = "arRibfDcnC:d:S:sqvVh";
@@ -61,6 +62,7 @@ static const struct option cmdopts[] = {
        {"all", no_argument, 0, 'a'},
        {"remove", no_argument, 0, 'r'},
        {"remove-dependencies", no_argument, 0, 5},
+       {"remove-holders", no_argument, 0, 5},
        {"resolve-alias", no_argument, 0, 'R'},
        {"first-time", no_argument, 0, 3},
        {"ignore-install", no_argument, 0, 'i'},
@@ -75,6 +77,7 @@ static const struct option cmdopts[] = {
        {"show-config", no_argument, 0, 'c'},
        {"show-modversions", no_argument, 0, 4},
        {"dump-modversions", no_argument, 0, 4},
+       {"show-exports", no_argument, 0, 6},
 
        {"dry-run", no_argument, 0, 'n'},
        {"show", no_argument, 0, 'n'},
@@ -93,8 +96,7 @@ static const struct option cmdopts[] = {
 
 static void help(void)
 {
-       fprintf(stderr,
-               "Usage:\n"
+       printf("Usage:\n"
                "\t%s [options] [-i] [-b] modulename\n"
                "\t%s [options] -a [-i] [-b] modulename [modulename...]\n"
                "\t%s [options] -r [-i] modulename\n"
@@ -106,8 +108,8 @@ static void help(void)
                "\t                            be a module name to be inserted\n"
                "\t                            or removed (-r)\n"
                "\t-r, --remove                Remove modules instead of inserting\n"
-               "\t    --remove-dependencies   Also remove modules depending on it\n"
-               "\t-R, --resolve-alias         Only lookup and print alias and exit\n"
+               "\t    --remove-dependencies   Deprecated: use --remove-holders\n"
+               "\t    --remove-holders        Also remove module holders (use together with -r)\n"
                "\t    --first-time            Fail if module already inserted or removed\n"
                "\t-i, --ignore-install        Ignore install commands\n"
                "\t-i, --ignore-remove         Ignore remove commands\n"
@@ -119,11 +121,13 @@ static void help(void)
                "\t    --force-vermagic        Ignore module's version magic\n"
                "\n"
                "Query Options:\n"
+               "\t-R, --resolve-alias         Only lookup and print alias and exit\n"
                "\t-D, --show-depends          Only print module dependencies and exit\n"
                "\t-c, --showconfig            Print out known configuration and exit\n"
                "\t-c, --show-config           Same as --showconfig\n"
                "\t    --show-modversions      Dump module symbol version and exit\n"
                "\t    --dump-modversions      Same as --show-modversions\n"
+               "\t    --show-exports          Only print module exported symbol versions and exit\n"
                "\n"
                "General Options:\n"
                "\t-n, --dry-run               Do not execute operations, just print out\n"
@@ -138,9 +142,12 @@ static void help(void)
                "\t-v, --verbose               enables more messages\n"
                "\t-V, --version               show version\n"
                "\t-h, --help                  show this help\n",
-               binname, binname, binname, binname, binname, binname);
+               program_invocation_short_name, program_invocation_short_name,
+               program_invocation_short_name, program_invocation_short_name,
+               program_invocation_short_name, program_invocation_short_name);
 }
 
+_printf_format_(1, 2)
 static inline void _show(const char *fmt, ...)
 {
        va_list args;
@@ -153,68 +160,6 @@ static inline void _show(const char *fmt, ...)
        fflush(stdout);
        va_end(args);
 }
-
-static void log_modprobe(void *data, int priority, const char *file, int line,
-                       const char *fn, const char *format, va_list args)
-{
-       const char *prioname = prio_to_str(priority);
-       char *str;
-
-       if (vasprintf(&str, format, args) < 0)
-               return;
-
-       if (use_syslog > 1) {
-#ifdef ENABLE_DEBUG
-               syslog(priority, "%s: %s:%d %s() %s", prioname, file, line,
-                      fn, str);
-#else
-               syslog(priority, "%s: %s", prioname, str);
-#endif
-       } else {
-#ifdef ENABLE_DEBUG
-               fprintf(stderr, "modprobe: %s: %s:%d %s() %s", prioname, file,
-                       line, fn, str);
-#else
-               fprintf(stderr, "modprobe: %s: %s", prioname, str);
-#endif
-       }
-
-       free(str);
-       (void)data;
-}
-
-static void _log(int prio, const char *fmt, ...)
-{
-       const char *prioname;
-       char *msg;
-       va_list args;
-
-       if (prio > verbose)
-               return;
-
-       va_start(args, fmt);
-       if (vasprintf(&msg, fmt, args) < 0)
-               msg = NULL;
-       va_end(args);
-       if (msg == NULL)
-               return;
-
-       prioname = prio_to_str(prio);
-
-       if (use_syslog > 1)
-               syslog(prio, "%s: %s", prioname, msg);
-       else
-               fprintf(stderr, "modprobe: %s: %s", prioname, msg);
-       free(msg);
-
-       if (prio <= LOG_CRIT)
-               exit(EXIT_FAILURE);
-}
-#define ERR(...) _log(LOG_ERR, __VA_ARGS__)
-#define WRN(...) _log(LOG_WARNING, __VA_ARGS__)
-#define INF(...) _log(LOG_INFO, __VA_ARGS__)
-#define DBG(...) _log(LOG_DEBUG, __VA_ARGS__)
-#define LOG(...) _log(log_priority, __VA_ARGS__)
 #define SHOW(...) _show(__VA_ARGS__)
 
 static int show_config(struct kmod_ctx *ctx)
@@ -291,6 +236,34 @@ static int show_modversions(struct kmod_ctx *ctx, const char *filename)
        return 0;
 }
 
+static int show_exports(struct kmod_ctx *ctx, const char *filename)
+{
+       struct kmod_list *l, *list = NULL;
+       struct kmod_module *mod;
+       int err = kmod_module_new_from_path(ctx, filename, &mod);
+       if (err < 0) {
+               LOG("Module %s not found.\n", filename);
+               return err;
+       }
+
+       err = kmod_module_get_symbols(mod, &list);
+       if (err < 0) {
+               LOG("could not get symbols of %s: %s\n",
+                       filename, strerror(-err));
+               kmod_module_unref(mod);
+               return err;
+       }
+
+       kmod_list_foreach(l, list) {
+               const char *symbol = kmod_module_symbol_get_symbol(l);
+               uint64_t crc = kmod_module_symbol_get_crc(l);
+               printf("0x%08"PRIx64"\t%s\n", crc, symbol);
+       }
+       kmod_module_symbols_free_list(list);
+       kmod_module_unref(mod);
+       return 0;
+}
+
 static int command_do(struct kmod_module *module, const char *type,
                                const char *command, const char *cmdline_opts)
 {
@@ -349,10 +322,9 @@ end:
 static int rmmod_do_remove_module(struct kmod_module *mod)
 {
        const char *modname = kmod_module_get_name(mod);
-       struct kmod_list *deps, *itr;
        int flags = 0, err;
 
-       SHOW("rmmod %s\n", kmod_module_get_name(mod));
+       SHOW("rmmod %s\n", modname);
 
        if (dry_run)
                return 0;
@@ -368,29 +340,21 @@ static int rmmod_do_remove_module(struct kmod_module *mod)
                        LOG("Module %s is not in kernel.\n", modname);
        }
 
-       deps = kmod_module_get_dependencies(mod);
-       if (deps != NULL) {
-               kmod_list_foreach(itr, deps) {
-                       struct kmod_module *dep = kmod_module_get_module(itr);
-                       if (kmod_module_get_refcnt(dep) == 0)
-                               rmmod_do_remove_module(dep);
-                       kmod_module_unref(dep);
-               }
-               kmod_module_unref_list(deps);
-       }
-
        return err;
 }
 
-static int rmmod_do_module(struct kmod_module *mod, bool do_dependencies);
+#define RMMOD_FLAG_REMOVE_HOLDERS      0x1
+#define RMMOD_FLAG_IGNORE_BUILTIN      0x2
+static int rmmod_do_module(struct kmod_module *mod, int flags);
 
-static int rmmod_do_deps_list(struct kmod_list *list, bool stop_on_errors)
+/* Remove modules in reverse order */
+static int rmmod_do_modlist(struct kmod_list *list, bool stop_on_errors)
 {
        struct kmod_list *l;
 
        kmod_list_foreach_reverse(l, list) {
                struct kmod_module *m = kmod_module_get_module(l);
-               int r = rmmod_do_module(m, false);
+               int r = rmmod_do_module(m, RMMOD_FLAG_IGNORE_BUILTIN);
                kmod_module_unref(m);
 
                if (r < 0 && stop_on_errors)
@@ -400,7 +364,7 @@ static int rmmod_do_deps_list(struct kmod_list *list, bool stop_on_errors)
        return 0;
 }
 
-static int rmmod_do_module(struct kmod_module *mod, bool do_dependencies)
+static int rmmod_do_module(struct kmod_module *mod, int flags)
 {
        const char *modname = kmod_module_get_name(mod);
        struct kmod_list *pre = NULL, *post = NULL;
@@ -418,7 +382,8 @@ static int rmmod_do_module(struct kmod_module *mod, bool do_dependencies)
                cmd = kmod_module_get_remove_commands(mod);
        }
 
-       if (cmd == NULL && !ignore_loaded) {
+       /* Quick check if module is loaded, otherwise there's nothing to do */
+       if (!cmd && !ignore_loaded) {
                int state = kmod_module_get_initstate(mod);
 
                if (state < 0) {
@@ -430,23 +395,30 @@ static int rmmod_do_module(struct kmod_module *mod, bool do_dependencies)
                        }
                        goto error;
                } else if (state == KMOD_MODULE_BUILTIN) {
-                       LOG("Module %s is builtin.\n", modname);
-                       err = -ENOENT;
+                       if (flags & RMMOD_FLAG_IGNORE_BUILTIN) {
+                               err = 0;
+                       } else {
+                               LOG("Module %s is builtin.\n", modname);
+                               err = -ENOENT;
+                       }
                        goto error;
                }
        }
 
-       rmmod_do_deps_list(post, false);
+       /* 1. @mod's post-softdeps in reverse order */
+       rmmod_do_modlist(post, false);
 
-       if (do_dependencies && remove_dependencies) {
-               struct kmod_list *deps = kmod_module_get_dependencies(mod);
+       /* 2. Other modules holding @mod */
+       if (flags & RMMOD_FLAG_REMOVE_HOLDERS) {
+               struct kmod_list *holders = kmod_module_get_holders(mod);
 
-               err = rmmod_do_deps_list(deps, true);
+               err = rmmod_do_modlist(holders, true);
                if (err < 0)
                        goto error;
        }
 
-       if (!ignore_loaded) {
+       /* 3. @mod itself, but check for refcnt first */
+       if (!cmd && !ignore_loaded) {
                int usage = kmod_module_get_refcnt(mod);
 
                if (usage > 0) {
@@ -458,7 +430,7 @@ static int rmmod_do_module(struct kmod_module *mod, bool do_dependencies)
                }
        }
 
-       if (cmd == NULL)
+       if (!cmd)
                err = rmmod_do_remove_module(mod);
        else
                err = command_do(mod, "remove", cmd, NULL);
@@ -466,7 +438,22 @@ static int rmmod_do_module(struct kmod_module *mod, bool do_dependencies)
        if (err < 0)
                goto error;
 
-       rmmod_do_deps_list(pre, false);
+       /* 4. Other modules that became unused: errors are non-fatal */
+       if (!cmd) {
+               struct kmod_list *deps, *itr;
+
+               deps = kmod_module_get_dependencies(mod);
+               kmod_list_foreach(itr, deps) {
+                       struct kmod_module *dep = kmod_module_get_module(itr);
+                       if (kmod_module_get_refcnt(dep) == 0)
+                               rmmod_do_remove_module(dep);
+                       kmod_module_unref(dep);
+               }
+               kmod_module_unref_list(deps);
+       }
+
+       /* 5. @mod's pre-softdeps in reverse order: errors are non-fatal */
+       rmmod_do_modlist(pre, false);
 
 error:
        kmod_module_unref_list(pre);
@@ -491,7 +478,9 @@ static int rmmod(struct kmod_ctx *ctx, const char *alias)
 
        kmod_list_foreach(l, list) {
                struct kmod_module *mod = kmod_module_get_module(l);
-               err = rmmod_do_module(mod, true);
+               int flags = remove_holders ? RMMOD_FLAG_REMOVE_HOLDERS : 0;
+
+               err = rmmod_do_module(mod, flags);
                kmod_module_unref(mod);
                if (err < 0)
                        break;
@@ -514,34 +503,6 @@ static int rmmod_all(struct kmod_ctx *ctx, char **args, int nargs)
        return err;
 }
 
-static int handle_failed_lookup(struct kmod_ctx *ctx, const char *alias)
-{
-       struct kmod_module *mod;
-       int state, err;
-
-       DBG("lookup failed - trying to check if it's builtin\n");
-
-       err = kmod_module_new_from_name(ctx, alias, &mod);
-       if (err < 0)
-               return err;
-
-       state = kmod_module_get_initstate(mod);
-       kmod_module_unref(mod);
-
-       if (state != KMOD_MODULE_BUILTIN) {
-               LOG("Module %s not found.\n", alias);
-               return -ENOENT;
-       }
-
-       if (first_time) {
-               LOG("Module %s already in kernel (builtin).\n", alias);
-               return -ENOENT;
-       }
-
-       SHOW("builtin %s\n", alias);
-       return 0;
-}
-
 static void print_action(struct kmod_module *m, bool install,
                                                        const char *options)
 {
@@ -556,8 +517,12 @@ static void print_action(struct kmod_module *m, bool install,
        path = kmod_module_get_path(m);
 
        if (path == NULL) {
-               assert(kmod_module_get_initstate(m) == KMOD_MODULE_BUILTIN);
-               printf("builtin %s\n", kmod_module_get_name(m));
+               /*
+                * Either a builtin module, or an alias, print only for
+                * builtin
+                */
+               if (kmod_module_get_initstate(m) == KMOD_MODULE_BUILTIN)
+                       printf("builtin %s\n", kmod_module_get_name(m));
        } else
                printf("insmod %s %s\n", kmod_module_get_path(m), options);
 }
@@ -572,11 +537,12 @@ static int insmod(struct kmod_ctx *ctx, const char *alias,
                                                const char *options) = NULL;
 
        err = kmod_module_new_from_lookup(ctx, alias, &list);
-       if (err < 0)
-               return err;
 
-       if (list == NULL)
-               return handle_failed_lookup(ctx, alias);
+       if (list == NULL || err < 0) {
+               LOG("Module %s not found in directory %s\n", alias,
+                       ctx ? kmod_get_dirname(ctx) : "(missing)");
+               return -ENOENT;
+       }
 
        if (strip_modversion || force)
                flags |= KMOD_PROBE_FORCE_MODVERSION;
@@ -729,7 +695,7 @@ static int options_from_array(char **args, int nargs, char **output)
 static char **prepend_options_from_env(int *p_argc, char **orig_argv)
 {
        const char *p, *env = getenv("MODPROBE_OPTIONS");
-       char **new_argv, *str_start, *str_end, *str, *s, *quote;
+       char **new_argv, *str_end, *str, *s, *quote;
        int i, argc = *p_argc;
        size_t envlen, space_count = 0;
 
@@ -747,10 +713,10 @@ static char **prepend_options_from_env(int *p_argc, char **orig_argv)
                return NULL;
 
        new_argv[0] = orig_argv[0];
-       str_start = str = (char *) (new_argv + argc + space_count + 3);
+       str = (char *) (new_argv + argc + space_count + 3);
        memcpy(str, env, envlen + 1);
 
-       str_end = str_start + envlen;
+       str_end = str + envlen;
 
        quote = NULL;
        for (i = 1, s = str; *s != '\0'; s++) {
@@ -789,7 +755,7 @@ static char **prepend_options_from_env(int *p_argc, char **orig_argv)
        }
 
        memcpy(new_argv + i, orig_argv + 1, sizeof(char *) * (argc - 1));
-       new_argv[i + argc] = NULL;
+       new_argv[i + argc - 1] = NULL;
        *p_argc = i + argc - 1;
 
        return new_argv;
@@ -809,6 +775,7 @@ static int do_modprobe(int argc, char **orig_argv)
        int do_remove = 0;
        int do_show_config = 0;
        int do_show_modversions = 0;
+       int do_show_exports = 0;
        int err;
 
        argv = prepend_options_from_env(&argc, orig_argv);
@@ -831,10 +798,7 @@ static int do_modprobe(int argc, char **orig_argv)
                        do_remove = 1;
                        break;
                case 5:
-                       remove_dependencies = 1;
-                       break;
-               case 'R':
-                       lookup_only = 1;
+                       remove_holders = 1;
                        break;
                case 3:
                        first_time = 1;
@@ -859,12 +823,18 @@ static int do_modprobe(int argc, char **orig_argv)
                        dry_run = 1;
                        do_show = 1;
                        break;
+               case 'R':
+                       lookup_only = 1;
+                       break;
                case 'c':
                        do_show_config = 1;
                        break;
                case 4:
                        do_show_modversions = 1;
                        break;
+               case 6:
+                       do_show_exports = 1;
+                       break;
                case 'n':
                        dry_run = 1;
                        break;
@@ -905,6 +875,7 @@ static int do_modprobe(int argc, char **orig_argv)
                        break;
                case 'V':
                        puts(PACKAGE " version " VERSION);
+                       puts(KMOD_FEATURES);
                        err = 0;
                        goto done;
                case 'h':
@@ -924,10 +895,7 @@ static int do_modprobe(int argc, char **orig_argv)
        args = argv + optind;
        nargs = argc - optind;
 
-       if (use_syslog) {
-               openlog("modprobe", LOG_CONS, LOG_DAEMON);
-               use_syslog++;
-       }
+       log_open(use_syslog);
 
        if (!do_show_config) {
                if (nargs == 0) {
@@ -962,8 +930,7 @@ static int do_modprobe(int argc, char **orig_argv)
                goto done;
        }
 
-       kmod_set_log_priority(ctx, verbose);
-       kmod_set_log_fn(ctx, log_modprobe, NULL);
+       log_setup_kmod_log(ctx, verbose);
 
        kmod_load_resources(ctx);
 
@@ -971,6 +938,8 @@ static int do_modprobe(int argc, char **orig_argv)
                err = show_config(ctx);
        else if (do_show_modversions)
                err = show_modversions(ctx, args[0]);
+       else if (do_show_exports)
+               err = show_exports(ctx, args[0]);
        else if (do_remove)
                err = rmmod_all(ctx, args, nargs);
        else if (use_all)
@@ -987,8 +956,7 @@ static int do_modprobe(int argc, char **orig_argv)
        kmod_unref(ctx);
 
 done:
-       if (use_syslog > 1)
-               closelog();
+       log_close();
 
        if (argv != orig_argv)
                free(argv);