*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
- * License as published by the Free Software Foundation version 2.1.
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
[KMOD_INDEX_SYMBOL] = "modules.symbols",
};
+static const char *default_config_paths[] = {
+ "/run/modprobe.d",
+ "/etc/modprobe.d",
+ "/lib/modprobe.d",
+ NULL
+};
+
/**
* kmod_ctx:
*
* @ctx: kmod library context
*
* Retrieve stored data pointer from library context. This might be useful
- * to access from callbacks like a custom logging function.
+ * to access from callbacks.
*
* Returns: stored userdata
- **/
+ */
KMOD_EXPORT void *kmod_get_userdata(const struct kmod_ctx *ctx)
{
if (ctx == NULL)
* @userdata: data pointer
*
* Store custom @userdata in the library context.
- **/
+ */
KMOD_EXPORT void kmod_set_userdata(struct kmod_ctx *ctx, const void *userdata)
{
if (ctx == NULL)
* 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 /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
+ * /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)
+ */
+KMOD_EXPORT struct kmod_ctx *kmod_new(const char *dirname,
+ const char * const *config_paths)
{
const char *env;
struct kmod_ctx *ctx;
if (env != NULL)
kmod_set_log_priority(ctx, log_priority(env));
- err = kmod_config_new(ctx, &ctx->config);
+ if (config_paths == NULL)
+ config_paths = default_config_paths;
+ err = kmod_config_new(ctx, &ctx->config, config_paths);
if (err < 0) {
ERR(ctx, "could not create config\n");
goto fail;
* Take a reference of the kmod library context.
*
* Returns: the passed kmod library context
- **/
+ */
KMOD_EXPORT struct kmod_ctx *kmod_ref(struct kmod_ctx *ctx)
{
if (ctx == NULL)
*
* Drop a reference of the kmod library context. If the refcount
* reaches zero, the resources of the context will be released.
- *
- **/
+ */
KMOD_EXPORT struct kmod_ctx *kmod_unref(struct kmod_ctx *ctx)
{
if (ctx == NULL)
* The built-in logging writes to stderr. It can be
* overridden by a custom function, to plug log messages
* into the user's logging functionality.
- *
- **/
+ */
KMOD_EXPORT void kmod_set_log_fn(struct kmod_ctx *ctx,
void (*log_fn)(void *data,
int priority, const char *file,
* @ctx: kmod library context
*
* Returns: the current logging priority
- **/
+ */
KMOD_EXPORT int kmod_get_log_priority(const struct kmod_ctx *ctx)
{
if (ctx == NULL)
*
* Set the current logging priority. The value controls which messages
* are logged.
- **/
+ */
KMOD_EXPORT void kmod_set_log_priority(struct kmod_ctx *ctx, int priority)
{
if (ctx == NULL)
}
struct kmod_module *kmod_pool_get_module(struct kmod_ctx *ctx,
- const char *name)
+ const char *key)
{
struct kmod_module *mod;
- mod = kmod_hash_find(ctx->modules_by_name, name);
+ mod = kmod_hash_find(ctx->modules_by_name, key);
- DBG(ctx, "get module name='%s' found=%p\n", name, mod);
+ DBG(ctx, "get module name='%s' found=%p\n", key, mod);
return mod;
}
-void kmod_pool_add_module(struct kmod_ctx *ctx, struct kmod_module *mod)
+void kmod_pool_add_module(struct kmod_ctx *ctx, struct kmod_module *mod,
+ const char *key)
{
- const char *name = kmod_module_get_name(mod);
-
- DBG(ctx, "add %p name='%s'\n", mod, name);
+ DBG(ctx, "add %p key='%s'\n", mod, key);
- kmod_hash_add(ctx->modules_by_name, name, mod);
+ kmod_hash_add(ctx->modules_by_name, key, mod);
}
-void kmod_pool_del_module(struct kmod_ctx *ctx, struct kmod_module *mod)
+void kmod_pool_del_module(struct kmod_ctx *ctx, struct kmod_module *mod,
+ const char *key)
{
- const char *name = kmod_module_get_name(mod);
-
- DBG(ctx, "del %p name='%s'\n", mod, name);
+ DBG(ctx, "del %p key='%s'\n", mod, key);
- kmod_hash_del(ctx->modules_by_name, name);
+ kmod_hash_del(ctx->modules_by_name, key);
}
static int kmod_lookup_alias_from_alias_bin(struct kmod_ctx *ctx,
- const char *file,
+ enum kmod_index index_number,
const char *name,
struct kmod_list **list)
{
- char *fn;
int err, nmatch = 0;
struct index_file *idx;
struct index_value *realnames, *realname;
- if (asprintf(&fn, "%s/%s.bin", ctx->dirname, file) < 0)
- return -ENOMEM;
+ if (ctx->indexes[index_number] != NULL) {
+ DBG(ctx, "use mmaped index '%s' for name=%s\n",
+ index_files[index_number], name);
+ realnames = index_mm_searchwild(ctx->indexes[index_number],
+ name);
+ } else{
+ char fn[PATH_MAX];
- DBG(ctx, "file=%s name=%s\n", fn, name);
+ snprintf(fn, sizeof(fn), "%s/%s.bin", ctx->dirname,
+ index_files[index_number]);
- idx = index_file_open(fn);
- if (idx == NULL) {
- free(fn);
- return -ENOSYS;
+ DBG(ctx, "file=%s name=%s\n", fn, name);
+
+ idx = index_file_open(fn);
+ if (idx == NULL)
+ return -ENOSYS;
+
+ realnames = index_searchwild(idx, name);
+ index_file_close(idx);
}
- realnames = index_searchwild(idx, name);
- for (realname = realnames; realname; realname = realnames->next) {
+ for (realname = realnames; realname; realname = realname->next) {
struct kmod_module *mod;
- err = kmod_module_new_from_name(ctx, realname->value, &mod);
+ err = kmod_module_new_from_alias(ctx, name, realname->value, &mod);
if (err < 0) {
ERR(ctx, "%s\n", strerror(-err));
goto fail;
}
index_values_free(realnames);
- index_file_close(idx);
- free(fn);
-
return nmatch;
fail:
if (!startswith(name, "symbol:"))
return 0;
- return kmod_lookup_alias_from_alias_bin(ctx,
- index_files[KMOD_INDEX_SYMBOL], name, list);
+ return kmod_lookup_alias_from_alias_bin(ctx, KMOD_INDEX_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,
- index_files[KMOD_INDEX_ALIAS], name, list);
+ return kmod_lookup_alias_from_alias_bin(ctx, KMOD_INDEX_ALIAS, name,
+ list);
}
char *kmod_search_moddep(struct kmod_ctx *ctx, const char *name)
char fn[PATH_MAX];
char *line;
+ if (ctx->indexes[KMOD_INDEX_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);
+ }
+
snprintf(fn, sizeof(fn), "%s/%s.bin", ctx->dirname,
index_files[KMOD_INDEX_DEP]);
idx = index_file_open(fn);
if (idx == NULL) {
- ERR(ctx, "Could not open moddep file '%s'", fn);
+ ERR(ctx, "Could not open moddep file '%s'\n", fn);
return NULL;
}
if (fnmatch(aliasname, name, 0) == 0) {
struct kmod_module *mod;
- err = kmod_module_new_from_name(ctx, modname, &mod);
+ err = kmod_module_new_from_alias(ctx, aliasname,
+ modname, &mod);
if (err < 0) {
- ERR(ctx, "%s", strerror(-err));
+ ERR(ctx, "%s\n", strerror(-err));
goto fail;
}
return err;
}
-KMOD_EXPORT int kmod_module_get_filtered_blacklist(const struct kmod_ctx *ctx, const struct kmod_list *input, struct kmod_list **output)
+int kmod_lookup_alias_from_commands(struct kmod_ctx *ctx, const char *name,
+ struct kmod_list **list)
+{
+ struct kmod_config *config = ctx->config;
+ struct kmod_list *l, *node;
+ int err, nmatch = 0;
+
+ kmod_list_foreach(l, config->install_commands) {
+ const char *modname = kmod_command_get_modname(l);
+
+ if (streq(modname, name)) {
+ const char *cmd = kmod_command_get_command(l);
+ struct kmod_module *mod;
+
+ err = kmod_module_new_from_name(ctx, modname, &mod);
+ if (err < 0) {
+ ERR(ctx, "%s\n", strerror(-err));
+ return err;
+ }
+
+ node = kmod_list_append(*list, mod);
+ if (node == NULL) {
+ ERR(ctx, "out of memory\n");
+ return -ENOMEM;
+ }
+
+ *list = node;
+ nmatch = 1;
+
+ kmod_module_set_install_commands(mod, cmd);
+
+ /*
+ * match only the first one, like modprobe from
+ * module-init-tools does
+ */
+ break;
+ }
+ }
+
+ if (nmatch)
+ return nmatch;
+
+ kmod_list_foreach(l, config->remove_commands) {
+ const char *modname = kmod_command_get_modname(l);
+
+ if (streq(modname, name)) {
+ const char *cmd = kmod_command_get_command(l);
+ struct kmod_module *mod;
+
+ err = kmod_module_new_from_name(ctx, modname, &mod);
+ if (err < 0) {
+ ERR(ctx, "%s\n", strerror(-err));
+ return err;
+ }
+
+ node = kmod_list_append(*list, mod);
+ if (node == NULL) {
+ ERR(ctx, "out of memory\n");
+ return -ENOMEM;
+ }
+
+ *list = node;
+ nmatch = 1;
+
+ kmod_module_set_remove_commands(mod, cmd);
+
+ /*
+ * match only the first one, like modprobe from
+ * module-init-tools does
+ */
+ break;
+ }
+ }
+
+ return nmatch;
+}
+
+/**
+ * kmod_module_get_filtered_blacklist:
+ * @ctx: kmod library context
+ * @input: list of kmod_module to be filtered with blacklist
+ * @output: where to save the new list
+ *
+ * Given a list @input, this function filter it out with config's blacklist
+ * ans save it in @output.
+ *
+ * Returns: 0 on success or < 0 otherwise. @output is saved with the updated
+ * list.
+ */
+KMOD_EXPORT int kmod_module_get_filtered_blacklist(const struct kmod_ctx *ctx,
+ const struct kmod_list *input,
+ struct kmod_list **output)
{
const struct kmod_config *config;
const struct kmod_list *li;
return -ENOMEM;
}
+/**
+ * kmod_load_resources:
+ * @ctx: kmod library context
+ *
+ * Load indexes and keep them open in @ctx. This way it's faster to lookup
+ * information within the indexes. If this function is not called before a
+ * search, the necessary index is always opened and closed.
+ *
+ * If user will do more than one or two lookups, insertions, deletions, most
+ * likely it's good to call this function first. Particularly in a daemon like
+ * udev that on bootup issues hundreds of calls to lookup the index, calling
+ * this function will speedup the searches.
+ *
+ * Returns: 0 on success or < 0 otherwise.
+ */
KMOD_EXPORT int kmod_load_resources(struct kmod_ctx *ctx)
{
size_t i;
return -ENOENT;
for (i = 0; i < ARRAY_SIZE(index_files); i++) {
- if (ctx->indexes[i] == NULL) {
- const char *fn = index_files[i];
+ char path[PATH_MAX];
- ctx->indexes[i] = index_mm_open(ctx, fn, true);
- if (ctx->indexes[i] == NULL)
- goto fail;
+ if (ctx->indexes[i] != NULL) {
+ INFO(ctx, "Index %s already loaded\n", index_files[i]);
+ 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;
}
return 0;
return -ENOMEM;
}
+/**
+ * kmod_unload_resources:
+ * @ctx: kmod library context
+ *
+ * Unload all the indexes. This will free the resources to maintain the index
+ * open and all subsequent searches will need to open and close the index.
+ *
+ * User is free to call kmod_load_resources() and kmod_unload_resources() as
+ * many times as wanted during the lifecycle of @ctx. For example, if a daemon
+ * knows that when starting up it will lookup a lot of modules, it could call
+ * kmod_load_resources() and after the first burst of searches is gone, it
+ * could free the resources by calling kmod_unload_resources().
+ *
+ * Returns: 0 on success or < 0 otherwise.
+ */
KMOD_EXPORT void kmod_unload_resources(struct kmod_ctx *ctx)
{
size_t i;
}
}
}
+
+const struct kmod_list *kmod_get_options(const struct kmod_ctx *ctx)
+{
+ return ctx->config->options;
+}
+
+const struct kmod_list *kmod_get_install_commands(const struct kmod_ctx *ctx)
+{
+ return ctx->config->install_commands;
+}
+
+const struct kmod_list *kmod_get_remove_commands(const struct kmod_ctx *ctx)
+{
+ return ctx->config->remove_commands;
+}
+
+const struct kmod_list *kmod_get_softdeps(const struct kmod_ctx *ctx)
+{
+ return ctx->config->softdeps;
+}
projects / thirdparty / kmod.git / blobdiff