]> git.ipfire.org Git - thirdparty/kmod.git/blobdiff - libkmod/libkmod.h
Lookup aliases in the modules.builtin.modinfo
[thirdparty/kmod.git] / libkmod / libkmod.h
index cf4a7b7b7fee7f52dc31a8bd7df5c5d754bb46e3..3cab2e521656d70aefad4d4933bd2fa2464d4a6c 100644 (file)
@@ -1,7 +1,7 @@
 /*
  * libkmod - interface to kernel module operations
  *
- * Copyright (C) 2011-2012  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/>.
  */
 
+#pragma once
 #ifndef _LIBKMOD_H_
 #define _LIBKMOD_H_
 
@@ -42,14 +42,20 @@ struct kmod_ctx *kmod_ref(struct kmod_ctx *ctx);
 struct kmod_ctx *kmod_unref(struct kmod_ctx *ctx);
 void kmod_set_log_fn(struct kmod_ctx *ctx,
                        void (*log_fn)(void *log_data,
-                               int priority, const char *file, int line,
-                               const char *fn, const char *format,
-                               va_list args),
+                                       int priority, const char *file, int line,
+                                       const char *fn, const char *format,
+                                       va_list args),
                        const void *data);
 int kmod_get_log_priority(const struct kmod_ctx *ctx);
 void kmod_set_log_priority(struct kmod_ctx *ctx, int priority);
 void *kmod_get_userdata(const struct kmod_ctx *ctx);
 void kmod_set_userdata(struct kmod_ctx *ctx, const void *userdata);
+
+const char *kmod_get_dirname(const struct kmod_ctx *ctx);
+
+/*
+ * Management of libkmod's resources
+ */
 int kmod_load_resources(struct kmod_ctx *ctx);
 void kmod_unload_resources(struct kmod_ctx *ctx);
 
@@ -58,17 +64,17 @@ enum kmod_resources {
        KMOD_RESOURCES_MUST_RELOAD = 1,
        KMOD_RESOURCES_MUST_RECREATE = 2,
 };
-
 int kmod_validate_resources(struct kmod_ctx *ctx);
 
 enum kmod_index {
        KMOD_INDEX_MODULES_DEP = 0,
        KMOD_INDEX_MODULES_ALIAS,
        KMOD_INDEX_MODULES_SYMBOL,
+       KMOD_INDEX_MODULES_BUILTIN_ALIAS,
+       KMOD_INDEX_MODULES_BUILTIN,
        /* Padding to make sure enum is not mapped to char */
-       _KMOD_INDEX_PAD = (1 << 31),
+       _KMOD_INDEX_PAD = 1U << 31,
 };
-
 int kmod_dump_index(struct kmod_ctx *ctx, enum kmod_index type, int fd);
 
 /*
@@ -111,10 +117,31 @@ const char *kmod_config_iter_get_value(const struct kmod_config_iter *iter);
 bool kmod_config_iter_next(struct kmod_config_iter *iter);
 void kmod_config_iter_free_iter(struct kmod_config_iter *iter);
 
+/*
+ * kmod_module
+ *
+ * Operate on kernel modules
+ */
+struct kmod_module;
+int kmod_module_new_from_name(struct kmod_ctx *ctx, const char *name,
+                                               struct kmod_module **mod);
+int kmod_module_new_from_path(struct kmod_ctx *ctx, const char *path,
+                                               struct kmod_module **mod);
+int kmod_module_new_from_lookup(struct kmod_ctx *ctx, const char *given_alias,
+                                               struct kmod_list **list);
+int kmod_module_new_from_loaded(struct kmod_ctx *ctx,
+                                               struct kmod_list **list);
+
+struct kmod_module *kmod_module_ref(struct kmod_module *mod);
+struct kmod_module *kmod_module_unref(struct kmod_module *mod);
+int kmod_module_unref_list(struct kmod_list *list);
+struct kmod_module *kmod_module_get_module(const struct kmod_list *entry);
+
+
 /* Removal flags */
 enum kmod_remove {
        KMOD_REMOVE_FORCE = O_TRUNC,
-       KMOD_REMOVE_NOWAIT = O_NONBLOCK,
+       KMOD_REMOVE_NOWAIT = O_NONBLOCK, /* always set */
 };
 
 /* Insertion flags */
@@ -129,46 +156,55 @@ enum kmod_probe {
        KMOD_PROBE_FORCE_MODVERSION =           0x00002,
        KMOD_PROBE_IGNORE_COMMAND =             0x00004,
        KMOD_PROBE_IGNORE_LOADED =              0x00008,
+       KMOD_PROBE_DRY_RUN =                    0x00010,
+       KMOD_PROBE_FAIL_ON_LOADED =             0x00020,
 
        /* codes below can be used in return value, too */
        KMOD_PROBE_APPLY_BLACKLIST_ALL =        0x10000,
        KMOD_PROBE_APPLY_BLACKLIST =            0x20000,
-       KMOD_PROBE_STOP_ON_COMMAND =            0x40000,
-       KMOD_PROBE_STOP_ON_ALREADY_LOADED =     0x80000,
+       KMOD_PROBE_APPLY_BLACKLIST_ALIAS_ONLY = 0x40000,
 };
 
-/*
- * kmod_module
- *
- * Operate on kernel modules
- */
-struct kmod_module;
-int kmod_module_new_from_name(struct kmod_ctx *ctx, const char *name,
-                                               struct kmod_module **mod);
-int kmod_module_new_from_path(struct kmod_ctx *ctx, const char *path,
-                                               struct kmod_module **mod);
-int kmod_module_new_from_lookup(struct kmod_ctx *ctx, const char *given_alias,
-                                               struct kmod_list **list);
-int kmod_module_new_from_loaded(struct kmod_ctx *ctx, struct kmod_list **list);
-
-struct kmod_module *kmod_module_ref(struct kmod_module *mod);
-struct kmod_module *kmod_module_unref(struct kmod_module *mod);
-int kmod_module_unref_list(struct kmod_list *list);
-struct kmod_module *kmod_module_get_module(const struct kmod_list *entry);
-struct kmod_list *kmod_module_get_dependencies(const struct kmod_module *mod);
-
-int kmod_module_get_filtered_blacklist(const struct kmod_ctx *ctx, const struct kmod_list *input, struct kmod_list **output);
+/* Flags to kmod_module_apply_filter() */
+enum kmod_filter {
+       KMOD_FILTER_BLACKLIST = 0x00001,
+       KMOD_FILTER_BUILTIN = 0x00002,
+};
 
 int kmod_module_remove_module(struct kmod_module *mod, unsigned int flags);
-int kmod_module_insert_module(struct kmod_module *mod, unsigned int flags, const char *options);
+int kmod_module_insert_module(struct kmod_module *mod, unsigned int flags,
+                                                       const char *options);
 int kmod_module_probe_insert_module(struct kmod_module *mod,
                        unsigned int flags, const char *extra_options,
-                       int (*run_install)(struct kmod_module *m, const char *cmdline, void *data),
+                       int (*run_install)(struct kmod_module *m,
+                                               const char *cmdline, void *data),
                        const void *data,
-                       void (*print_action)(struct kmod_module *m, bool install, const char *options));
+                       void (*print_action)(struct kmod_module *m, bool install,
+                                               const char *options));
+
 
 const char *kmod_module_get_name(const struct kmod_module *mod);
 const char *kmod_module_get_path(const struct kmod_module *mod);
+const char *kmod_module_get_options(const struct kmod_module *mod);
+const char *kmod_module_get_install_commands(const struct kmod_module *mod);
+const char *kmod_module_get_remove_commands(const struct kmod_module *mod);
+struct kmod_list *kmod_module_get_dependencies(const struct kmod_module *mod);
+int kmod_module_get_softdeps(const struct kmod_module *mod,
+                               struct kmod_list **pre, struct kmod_list **post);
+int kmod_module_get_filtered_blacklist(const struct kmod_ctx *ctx,
+                                       const struct kmod_list *input,
+                                       struct kmod_list **output) __attribute__ ((deprecated));
+int kmod_module_apply_filter(const struct kmod_ctx *ctx,
+                                       enum kmod_filter filter_type,
+                                       const struct kmod_list *input,
+                                       struct kmod_list **output);
+
+
+
+/*
+ * Information regarding "live information" from module's state, as returned
+ * by kernel
+ */
 
 enum kmod_module_initstate {
        KMOD_MODULE_BUILTIN = 0,
@@ -176,25 +212,23 @@ enum kmod_module_initstate {
        KMOD_MODULE_COMING,
        KMOD_MODULE_GOING,
        /* Padding to make sure enum is not mapped to char */
-       _KMOD_MODULE_PAD = (1 << 31),
+       _KMOD_MODULE_PAD = 1U << 31,
 };
 const char *kmod_module_initstate_str(enum kmod_module_initstate state);
 int kmod_module_get_initstate(const struct kmod_module *mod);
 int kmod_module_get_refcnt(const struct kmod_module *mod);
 struct kmod_list *kmod_module_get_holders(const struct kmod_module *mod);
-
 struct kmod_list *kmod_module_get_sections(const struct kmod_module *mod);
 const char *kmod_module_section_get_name(const struct kmod_list *entry);
 unsigned long kmod_module_section_get_address(const struct kmod_list *entry);
 void kmod_module_section_free_list(struct kmod_list *list);
-
 long kmod_module_get_size(const struct kmod_module *mod);
 
-const char *kmod_module_get_options(const struct kmod_module *mod);
-const char *kmod_module_get_install_commands(const struct kmod_module *mod);
-const char *kmod_module_get_remove_commands(const struct kmod_module *mod);
 
-int kmod_module_get_softdeps(const struct kmod_module *mod, struct kmod_list **pre, struct kmod_list **post);
+
+/*
+ * Information retrieved from ELF headers and sections
+ */
 
 int kmod_module_get_info(const struct kmod_module *mod, struct kmod_list **list);
 const char *kmod_module_info_get_key(const struct kmod_list *entry);