/*
* libkmod - interface to kernel module operations
*
- * Copyright (C) 2011 ProFUSION embedded systems
+ * Copyright (C) 2011-2013 ProFUSION embedded systems
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
- * License along with this library; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+ * License along with this library; if not, see <http://www.gnu.org/licenses/>.
*/
-#include <stdio.h>
-#include <stdlib.h>
-#include <stddef.h>
-#include <stdarg.h>
-#include <limits.h>
-#include <unistd.h>
+#include <assert.h>
+#include <ctype.h>
#include <errno.h>
#include <fnmatch.h>
+#include <limits.h>
+#include <stdarg.h>
+#include <stddef.h>
+#include <stdio.h>
+#include <stdlib.h>
#include <string.h>
-#include <ctype.h>
+#include <unistd.h>
+#include <sys/stat.h>
#include <sys/utsname.h>
+#include <shared/hash.h>
+#include <shared/util.h>
+
#include "libkmod.h"
-#include "libkmod-private.h"
+#include "libkmod-internal.h"
#include "libkmod-index.h"
#define KMOD_HASH_SIZE (256)
#define KMOD_LRU_MAX (128)
+#define _KMOD_INDEX_MODULES_SIZE KMOD_INDEX_MODULES_BUILTIN + 1
/**
* SECTION:libkmod
* and is passed to all library operations.
*/
-enum kmod_index {
- KMOD_INDEX_DEP = 0,
- KMOD_INDEX_ALIAS,
- KMOD_INDEX_SYMBOL,
- _KMOD_INDEX_LAST,
-};
-
-static const char* index_files[] = {
- [KMOD_INDEX_DEP] = "modules.dep",
- [KMOD_INDEX_ALIAS] = "modules.alias",
- [KMOD_INDEX_SYMBOL] = "modules.symbols",
+static struct _index_files {
+ const char *fn;
+ const char *prefix;
+} index_files[] = {
+ [KMOD_INDEX_MODULES_DEP] = { .fn = "modules.dep", .prefix = "" },
+ [KMOD_INDEX_MODULES_ALIAS] = { .fn = "modules.alias", .prefix = "alias " },
+ [KMOD_INDEX_MODULES_SYMBOL] = { .fn = "modules.symbols", .prefix = "alias "},
+ [KMOD_INDEX_MODULES_BUILTIN_ALIAS] = { .fn = "modules.builtin.alias", .prefix = "" },
+ [KMOD_INDEX_MODULES_BUILTIN] = { .fn = "modules.builtin", .prefix = ""},
};
static const char *default_config_paths[] = {
- "/run/modprobe.d",
SYSCONFDIR "/modprobe.d",
- ROOTPREFIX "/lib/modprobe.d",
+ "/run/modprobe.d",
+ "/lib/modprobe.d",
NULL
};
char *dirname;
struct kmod_config *config;
struct hash *modules_by_name;
- struct index_mm *indexes[_KMOD_INDEX_LAST];
+ struct index_mm *indexes[_KMOD_INDEX_MODULES_SIZE];
+ unsigned long long indexes_stamp[_KMOD_INDEX_MODULES_SIZE];
};
void kmod_log(const struct kmod_ctx *ctx,
va_end(args);
}
+_printf_format_(6, 0)
static void log_filep(void *data,
int priority, const char *file, int line,
const char *fn, const char *format, va_list args)
{
FILE *fp = data;
+#ifdef ENABLE_DEBUG
+ char buf[16];
+ const char *priname;
+ switch (priority) {
+ case LOG_EMERG:
+ priname = "EMERGENCY";
+ break;
+ case LOG_ALERT:
+ priname = "ALERT";
+ break;
+ case LOG_CRIT:
+ priname = "CRITICAL";
+ break;
+ case LOG_ERR:
+ priname = "ERROR";
+ break;
+ case LOG_WARNING:
+ priname = "WARNING";
+ break;
+ case LOG_NOTICE:
+ priname = "NOTICE";
+ break;
+ case LOG_INFO:
+ priname = "INFO";
+ break;
+ case LOG_DEBUG:
+ priname = "DEBUG";
+ break;
+ default:
+ snprintf(buf, sizeof(buf), "L:%d", priority);
+ priname = buf;
+ }
+ fprintf(fp, "libkmod: %s %s:%d %s: ", priname, file, line, fn);
+#else
fprintf(fp, "libkmod: %s: ", fn);
+#endif
vfprintf(fp, format, args);
}
-const char *kmod_get_dirname(const struct kmod_ctx *ctx)
+
+/**
+ * kmod_get_dirname:
+ * @ctx: kmod library context
+ *
+ * Retrieve the absolute path used for linux modules in this context. The path
+ * is computed from the arguments to kmod_new().
+ */
+KMOD_EXPORT const char *kmod_get_dirname(const struct kmod_ctx *ctx)
{
return ctx->dirname;
}
return 0;
}
-static const char *dirname_default_prefix = ROOTPREFIX "/lib/modules";
+static const char *dirname_default_prefix = "/lib/modules";
static char *get_kernel_release(const char *dirname)
{
char *p;
if (dirname != NULL)
- return strdup(dirname);
+ return path_make_absolute_cwd(dirname);
if (uname(&u) < 0)
return NULL;
/**
* kmod_new:
+ * @dirname: what to consider as linux module's directory, if NULL
+ * defaults to /lib/modules/`uname -r`. If it's relative,
+ * it's treated as relative to the current working directory.
+ * Otherwise, give an absolute dirname.
+ * @config_paths: ordered array of paths (directories or files) where
+ * to load from user-defined configuration parameters such as
+ * alias, blacklists, commands (install, remove). If
+ * NULL defaults to /etc/modprobe.d, /run/modprobe.d and
+ * /lib/modprobe.d. Give an empty vector if configuration should
+ * not be read. This array must be null terminated.
*
* Create kmod library context. This reads the kmod configuration
* and fills in the default values.
* The initial refcount is 1, and needs to be decremented to
* release the resources of the kmod library context.
*
- * @dirname: what to consider as linux module's directory, if NULL
- * defaults to $rootprefix/lib/modules/`uname -r`.
- * @config_paths: ordered array of paths (directories or files) where
- * to load from user-defined configuration parameters such as
- * alias, blacklists, commands (install, remove). If
- * NULL defaults to /run/modprobe.d, /etc/modprobe.d and
- * $rootprefix/lib/modprobe.d. Give an empty vector if configuration should
- * not be read. This array must be null terminated.
- *
* Returns: a new kmod library context
*/
KMOD_EXPORT struct kmod_ctx *kmod_new(const char *dirname,
ctx->dirname = get_kernel_release(dirname);
/* environment overwrites config */
- env = getenv("KMOD_LOG");
+ env = secure_getenv("KMOD_LOG");
if (env != NULL)
kmod_set_log_priority(ctx, log_priority(env));
*
* Drop a reference of the kmod library context. If the refcount
* reaches zero, the resources of the context will be released.
+ *
+ * Returns: the passed kmod library context or NULL if it's freed
*/
KMOD_EXPORT struct kmod_ctx *kmod_unref(struct kmod_ctx *ctx)
{
* kmod_set_log_fn:
* @ctx: kmod library context
* @log_fn: function to be called for logging messages
+ * @data: data to pass to log function
*
* The built-in logging writes to stderr. It can be
* overridden by a custom function, to plug log messages
if (ctx->indexes[index_number] != NULL) {
DBG(ctx, "use mmaped index '%s' for name=%s\n",
- index_files[index_number], name);
+ index_files[index_number].fn, name);
realnames = index_mm_searchwild(ctx->indexes[index_number],
name);
- } else{
+ } else {
char fn[PATH_MAX];
snprintf(fn, sizeof(fn), "%s/%s.bin", ctx->dirname,
- index_files[index_number]);
+ index_files[index_number].fn);
DBG(ctx, "file=%s name=%s\n", fn, name);
err = kmod_module_new_from_alias(ctx, name, realname->value, &mod);
if (err < 0) {
- ERR(ctx, "%s\n", strerror(-err));
+ ERR(ctx, "Could not create module for alias=%s realname=%s: %s\n",
+ name, realname->value, strerror(-err));
goto fail;
}
fail:
*list = kmod_list_remove_n_latest(*list, nmatch);
+ index_values_free(realnames);
return err;
}
if (!strstartswith(name, "symbol:"))
return 0;
- return kmod_lookup_alias_from_alias_bin(ctx, KMOD_INDEX_SYMBOL, name,
- list);
+ return kmod_lookup_alias_from_alias_bin(ctx, KMOD_INDEX_MODULES_SYMBOL,
+ name, list);
}
int kmod_lookup_alias_from_aliases_file(struct kmod_ctx *ctx, const char *name,
struct kmod_list **list)
{
- return kmod_lookup_alias_from_alias_bin(ctx, KMOD_INDEX_ALIAS, name,
- list);
+ return kmod_lookup_alias_from_alias_bin(ctx, KMOD_INDEX_MODULES_ALIAS,
+ name, list);
+}
+
+static char *lookup_builtin_file(struct kmod_ctx *ctx, const char *name)
+{
+ char *line;
+
+ if (ctx->indexes[KMOD_INDEX_MODULES_BUILTIN]) {
+ DBG(ctx, "use mmaped index '%s' modname=%s\n",
+ index_files[KMOD_INDEX_MODULES_BUILTIN].fn,
+ name);
+ line = index_mm_search(ctx->indexes[KMOD_INDEX_MODULES_BUILTIN],
+ name);
+ } else {
+ struct index_file *idx;
+ char fn[PATH_MAX];
+
+ snprintf(fn, sizeof(fn), "%s/%s.bin", ctx->dirname,
+ index_files[KMOD_INDEX_MODULES_BUILTIN].fn);
+ DBG(ctx, "file=%s modname=%s\n", fn, name);
+
+ idx = index_file_open(fn);
+ if (idx == NULL) {
+ DBG(ctx, "could not open builtin file '%s'\n", fn);
+ return NULL;
+ }
+
+ line = index_search(idx, name);
+ index_file_close(idx);
+ }
+
+ return line;
+}
+
+int kmod_lookup_alias_from_kernel_builtin_file(struct kmod_ctx *ctx,
+ const char *name,
+ struct kmod_list **list)
+{
+ struct kmod_list *l;
+ int ret;
+
+ assert(*list == NULL);
+
+ ret = kmod_lookup_alias_from_alias_bin(ctx,
+ KMOD_INDEX_MODULES_BUILTIN_ALIAS,
+ name, list);
+
+ kmod_list_foreach(l, *list) {
+ struct kmod_module *mod = l->data;
+ kmod_module_set_builtin(mod, true);
+ }
+
+ return ret;
+}
+
+int kmod_lookup_alias_from_builtin_file(struct kmod_ctx *ctx, const char *name,
+ struct kmod_list **list)
+{
+ char *line;
+ int err = 0;
+
+ assert(*list == NULL);
+
+ line = lookup_builtin_file(ctx, name);
+ if (line != NULL) {
+ struct kmod_module *mod;
+
+ err = kmod_module_new_from_name(ctx, name, &mod);
+ if (err < 0) {
+ ERR(ctx, "Could not create module from name %s: %s\n",
+ name, strerror(-err));
+ goto finish;
+ }
+
+ /* already mark it as builtin since it's being created from
+ * this index */
+ kmod_module_set_builtin(mod, true);
+ *list = kmod_list_append(*list, mod);
+ if (*list == NULL)
+ err = -ENOMEM;
+ }
+
+finish:
+ free(line);
+ return err;
+}
+
+bool kmod_lookup_alias_is_builtin(struct kmod_ctx *ctx, const char *name)
+{
+ _cleanup_free_ char *line;
+
+ line = lookup_builtin_file(ctx, name);
+
+ return line != NULL;
}
char *kmod_search_moddep(struct kmod_ctx *ctx, const char *name)
char fn[PATH_MAX];
char *line;
- if (ctx->indexes[KMOD_INDEX_DEP]) {
+ if (ctx->indexes[KMOD_INDEX_MODULES_DEP]) {
DBG(ctx, "use mmaped index '%s' modname=%s\n",
- index_files[KMOD_INDEX_DEP], name);
- return index_mm_search(ctx->indexes[KMOD_INDEX_DEP], name);
+ index_files[KMOD_INDEX_MODULES_DEP].fn, name);
+ return index_mm_search(ctx->indexes[KMOD_INDEX_MODULES_DEP],
+ name);
}
snprintf(fn, sizeof(fn), "%s/%s.bin", ctx->dirname,
- index_files[KMOD_INDEX_DEP]);
+ index_files[KMOD_INDEX_MODULES_DEP].fn);
DBG(ctx, "file=%s modname=%s\n", fn, name);
idx = index_file_open(fn);
if (idx == NULL) {
- ERR(ctx, "Could not open moddep file '%s'\n", fn);
+ DBG(ctx, "could not open moddep file '%s'\n", fn);
return NULL;
}
n = kmod_module_new_from_name(ctx, name, &mod);
if (n < 0) {
- ERR(ctx, "%s\n", strerror(-n));
+ ERR(ctx, "Could not create module from name %s: %s\n",
+ name, strerror(-n));
goto finish;
}
err = kmod_module_new_from_alias(ctx, aliasname,
modname, &mod);
if (err < 0) {
- ERR(ctx, "%s\n", strerror(-err));
+ ERR(ctx, "Could not create module for alias=%s modname=%s: %s\n",
+ name, modname, strerror(-err));
goto fail;
}
err = kmod_module_new_from_name(ctx, modname, &mod);
if (err < 0) {
- ERR(ctx, "%s\n", strerror(-err));
+ ERR(ctx, "Could not create module from name %s: %s\n",
+ modname, strerror(-err));
return err;
}
err = kmod_module_new_from_name(ctx, modname, &mod);
if (err < 0) {
- ERR(ctx, "%s\n", strerror(-err));
+ ERR(ctx, "Could not create module from name %s: %s\n",
+ modname, strerror(-err));
return err;
}
return nmatch;
}
+void kmod_set_modules_visited(struct kmod_ctx *ctx, bool visited)
+{
+ struct hash_iter iter;
+ const void *v;
+
+ hash_iter_init(ctx->modules_by_name, &iter);
+ while (hash_iter_next(&iter, NULL, &v))
+ kmod_module_set_visited((struct kmod_module *)v, visited);
+}
+
+void kmod_set_modules_required(struct kmod_ctx *ctx, bool required)
+{
+ struct hash_iter iter;
+ const void *v;
+
+ hash_iter_init(ctx->modules_by_name, &iter);
+ while (hash_iter_next(&iter, NULL, &v))
+ kmod_module_set_required((struct kmod_module *)v, required);
+}
+
+static bool is_cache_invalid(const char *path, unsigned long long stamp)
+{
+ struct stat st;
+
+ if (stat(path, &st) < 0)
+ return true;
+
+ if (stamp != stat_mstamp(&st))
+ return true;
+
+ return false;
+}
+
+/**
+ * kmod_validate_resources:
+ * @ctx: kmod library context
+ *
+ * Check if indexes and configuration files changed on disk and the current
+ * context is not valid anymore.
+ *
+ * Returns: KMOD_RESOURCES_OK if resources are still valid,
+ * KMOD_RESOURCES_MUST_RELOAD if it's sufficient to call
+ * kmod_unload_resources() and kmod_load_resources() or
+ * KMOD_RESOURCES_MUST_RECREATE if @ctx must be re-created.
+ */
+KMOD_EXPORT int kmod_validate_resources(struct kmod_ctx *ctx)
+{
+ struct kmod_list *l;
+ size_t i;
+
+ if (ctx == NULL || ctx->config == NULL)
+ return KMOD_RESOURCES_MUST_RECREATE;
+
+ kmod_list_foreach(l, ctx->config->paths) {
+ struct kmod_config_path *cf = l->data;
+
+ if (is_cache_invalid(cf->path, cf->stamp))
+ return KMOD_RESOURCES_MUST_RECREATE;
+ }
+
+ for (i = 0; i < _KMOD_INDEX_MODULES_SIZE; i++) {
+ char path[PATH_MAX];
+
+ if (ctx->indexes[i] == NULL)
+ continue;
+
+ snprintf(path, sizeof(path), "%s/%s.bin", ctx->dirname,
+ index_files[i].fn);
+
+ if (is_cache_invalid(path, ctx->indexes_stamp[i]))
+ return KMOD_RESOURCES_MUST_RELOAD;
+ }
+
+ return KMOD_RESOURCES_OK;
+}
+
/**
* kmod_load_resources:
* @ctx: kmod library context
*/
KMOD_EXPORT int kmod_load_resources(struct kmod_ctx *ctx)
{
+ int ret = 0;
size_t i;
if (ctx == NULL)
return -ENOENT;
- for (i = 0; i < ARRAY_SIZE(index_files); i++) {
+ for (i = 0; i < _KMOD_INDEX_MODULES_SIZE; i++) {
char path[PATH_MAX];
if (ctx->indexes[i] != NULL) {
- INFO(ctx, "Index %s already loaded\n", index_files[i]);
+ INFO(ctx, "Index %s already loaded\n",
+ index_files[i].fn);
continue;
}
snprintf(path, sizeof(path), "%s/%s.bin", ctx->dirname,
- index_files[i]);
- ctx->indexes[i] = index_mm_open(ctx, path, true);
- if (ctx->indexes[i] == NULL)
- goto fail;
+ index_files[i].fn);
+ ret = index_mm_open(ctx, path, &ctx->indexes_stamp[i],
+ &ctx->indexes[i]);
+
+ /*
+ * modules.builtin.alias are considered optional since it's
+ * recently added and older installations may not have it;
+ * we allow failing for any reason
+ */
+ if (ret) {
+ if (i != KMOD_INDEX_MODULES_BUILTIN_ALIAS)
+ break;
+ ret = 0;
+ }
}
- return 0;
+ if (ret)
+ kmod_unload_resources(ctx);
-fail:
- kmod_unload_resources(ctx);
- return -ENOMEM;
+ return ret;
}
/**
if (ctx == NULL)
return;
- for (i = 0; i < ARRAY_SIZE(index_files); i++) {
+ for (i = 0; i < _KMOD_INDEX_MODULES_SIZE; i++) {
if (ctx->indexes[i] != NULL) {
index_mm_close(ctx->indexes[i]);
ctx->indexes[i] = NULL;
+ ctx->indexes_stamp[i] = 0;
}
}
}
-const struct kmod_list *kmod_get_blacklists(const struct kmod_ctx *ctx)
+/**
+ * kmod_dump_index:
+ * @ctx: kmod library context
+ * @type: index to dump, valid indexes are
+ * KMOD_INDEX_MODULES_DEP: index of module dependencies;
+ * KMOD_INDEX_MODULES_ALIAS: index of module aliases;
+ * KMOD_INDEX_MODULES_SYMBOL: index of symbol aliases;
+ * KMOD_INDEX_MODULES_BUILTIN: index of builtin module.
+ * @fd: file descriptor to dump index to
+ *
+ * Dump index to file descriptor. Note that this function doesn't use stdio.h
+ * so call fflush() before calling this function to be sure data is written in
+ * order.
+ *
+ * Returns: 0 on success or < 0 otherwise.
+ */
+KMOD_EXPORT int kmod_dump_index(struct kmod_ctx *ctx, enum kmod_index type,
+ int fd)
{
- return ctx->config->blacklists;
-}
+ if (ctx == NULL)
+ return -ENOSYS;
-const struct kmod_list *kmod_get_options(const struct kmod_ctx *ctx)
-{
- return ctx->config->options;
-}
+ if (type < 0 || type >= _KMOD_INDEX_MODULES_SIZE)
+ return -ENOENT;
-const struct kmod_list *kmod_get_install_commands(const struct kmod_ctx *ctx)
-{
- return ctx->config->install_commands;
-}
+ if (ctx->indexes[type] != NULL) {
+ DBG(ctx, "use mmaped index '%s'\n", index_files[type].fn);
+ index_mm_dump(ctx->indexes[type], fd,
+ index_files[type].prefix);
+ } else {
+ char fn[PATH_MAX];
+ struct index_file *idx;
-const struct kmod_list *kmod_get_remove_commands(const struct kmod_ctx *ctx)
-{
- return ctx->config->remove_commands;
+ snprintf(fn, sizeof(fn), "%s/%s.bin", ctx->dirname,
+ index_files[type].fn);
+
+ DBG(ctx, "file=%s\n", fn);
+
+ idx = index_file_open(fn);
+ if (idx == NULL)
+ return -ENOSYS;
+
+ index_dump(idx, fd, index_files[type].prefix);
+ index_file_close(idx);
+ }
+
+ return 0;
}
-const struct kmod_list *kmod_get_softdeps(const struct kmod_ctx *ctx)
+const struct kmod_config *kmod_get_config(const struct kmod_ctx *ctx)
{
- return ctx->config->softdeps;
+ return ctx->config;
}
projects / thirdparty / kmod.git / blobdiff