libkmod/libkmod.h

   1 /*
   2  * libkmod - interface to kernel module operations
   3  *
   4  * Copyright (C) 2011  ProFUSION embedded systems
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * This library 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 GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with this library; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  19  */
  20
  21 #ifndef _LIBKMOD_H_
  22 #define _LIBKMOD_H_
  23
  24 #include <fcntl.h>
  25 #include <stdarg.h>
  26 #include <inttypes.h>
  27
  28 #ifdef __cplusplus
  29 extern "C" {
  30 #endif
  31
  32 /*
  33  * kmod_ctx
  34  *
  35  * library user context - reads the config and system
  36  * environment, user variables, allows custom logging
  37  */
  38 struct kmod_ctx;
  39 struct kmod_ctx *kmod_new(const char *dirname, const char * const *config_dirs);
  40 struct kmod_ctx *kmod_ref(struct kmod_ctx *ctx);
  41 struct kmod_ctx *kmod_unref(struct kmod_ctx *ctx);
  42 void kmod_set_log_fn(struct kmod_ctx *ctx,
  43                         void (*log_fn)(void *log_data,
  44                                 int priority, const char *file, int line,
  45                                 const char *fn, const char *format,
  46                                 va_list args),
  47                         const void *data);
  48 int kmod_get_log_priority(const struct kmod_ctx *ctx);
  49 void kmod_set_log_priority(struct kmod_ctx *ctx, int priority);
  50 void *kmod_get_userdata(const struct kmod_ctx *ctx);
  51 void kmod_set_userdata(struct kmod_ctx *ctx, const void *userdata);
  52 int kmod_load_resources(struct kmod_ctx *ctx);
  53 void kmod_unload_resources(struct kmod_ctx *ctx);
  54
  55 enum kmod_resources {
  56         KMOD_RESOURCES_OK = 0,
  57         KMOD_RESOURCES_MUST_RELOAD = 1,
  58         KMOD_RESOURCES_MUST_RECREATE = 2,
  59 };
  60
  61 int kmod_validate_resources(struct kmod_ctx *ctx);
  62
  63 /*
  64  * kmod_list
  65  *
  66  * access to kmod generated lists
  67  */
  68 struct kmod_list;
  69 struct kmod_list *kmod_list_next(const struct kmod_list *first_entry,
  70                                                 const struct kmod_list *list_entry);
  71 struct kmod_list *kmod_list_prev(const struct kmod_list *first_entry,
  72                                                 const struct kmod_list *list_entry);
  73 struct kmod_list *kmod_list_last(const struct kmod_list *first_entry);
  74
  75 #define kmod_list_foreach(list_entry, first_entry) \
  76         for (list_entry = first_entry; \
  77                 list_entry != NULL; \
  78                 list_entry = kmod_list_next(first_entry, list_entry))
  79
  80 #define kmod_list_foreach_reverse(list_entry, first_entry) \
  81         for (list_entry = kmod_list_last(first_entry); \
  82                 list_entry != NULL; \
  83                 list_entry = kmod_list_prev(first_entry, list_entry))
  84
  85 /* Removal flags */
  86 enum kmod_remove {
  87         KMOD_REMOVE_FORCE = O_TRUNC,
  88         KMOD_REMOVE_NOWAIT = O_NONBLOCK,
  89 };
  90
  91 /* Insertion flags */
  92 enum kmod_insert {
  93         KMOD_INSERT_FORCE_VERMAGIC = 0x1,
  94         KMOD_INSERT_FORCE_MODVERSION = 0x2,
  95 };
  96
  97 /* Flags to kmod_module_probe_insert_module() */
  98 enum kmod_probe {
  99         KMOD_PROBE_FORCE_VERMAGIC = 0x1,
 100         KMOD_PROBE_FORCE_MODVERSION = 0x2,
 101         KMOD_PROBE_STOP_ON_BLACKLIST = 0x4,
 102         KMOD_PROBE_STOP_ON_FAILURE = 0x8,
 103         KMOD_PROBE_STOP_ON_COMMAND = 0x16,
 104 };
 105
 106 /*
 107  * kmod_module
 108  *
 109  * Operate on kernel modules
 110  */
 111 struct kmod_module;
 112 int kmod_module_new_from_name(struct kmod_ctx *ctx, const char *name,
 113                                                 struct kmod_module **mod);
 114 int kmod_module_new_from_path(struct kmod_ctx *ctx, const char *path,
 115                                                 struct kmod_module **mod);
 116 int kmod_module_new_from_lookup(struct kmod_ctx *ctx, const char *alias,
 117                                                 struct kmod_list **list);
 118 int kmod_module_new_from_loaded(struct kmod_ctx *ctx, struct kmod_list **list);
 119
 120 struct kmod_module *kmod_module_ref(struct kmod_module *mod);
 121 struct kmod_module *kmod_module_unref(struct kmod_module *mod);
 122 int kmod_module_unref_list(struct kmod_list *list);
 123 struct kmod_module *kmod_module_get_module(const struct kmod_list *entry);
 124 struct kmod_list *kmod_module_get_dependencies(const struct kmod_module *mod);
 125
 126 int kmod_module_get_filtered_blacklist(const struct kmod_ctx *ctx, const struct kmod_list *input, struct kmod_list **output);
 127
 128 int kmod_module_remove_module(struct kmod_module *mod, unsigned int flags);
 129 int kmod_module_insert_module(struct kmod_module *mod, unsigned int flags, const char *options);
 130 int kmod_module_probe_insert_module(struct kmod_module *mod,
 131                         unsigned int flags, const char *options,
 132                         int (*run_install)(struct kmod_module *m, const char *cmdline, void *data),
 133                         const void *data);
 134
 135 const char *kmod_module_get_name(const struct kmod_module *mod);
 136 const char *kmod_module_get_path(const struct kmod_module *mod);
 137
 138 enum kmod_module_initstate {
 139         KMOD_MODULE_BUILTIN = 0,
 140         KMOD_MODULE_LIVE,
 141         KMOD_MODULE_COMING,
 142         KMOD_MODULE_GOING,
 143         /* Padding to make sure enum is not mapped to char */
 144         _KMOD_MODULE_PAD = (1 << 31),
 145 };
 146 const char *kmod_module_initstate_str(enum kmod_module_initstate initstate);
 147 int kmod_module_get_initstate(const struct kmod_module *mod);
 148 int kmod_module_get_refcnt(const struct kmod_module *mod);
 149 struct kmod_list *kmod_module_get_holders(const struct kmod_module *mod);
 150
 151 struct kmod_list *kmod_module_get_sections(const struct kmod_module *mod);
 152 const char *kmod_module_section_get_name(const struct kmod_list *entry);
 153 unsigned long kmod_module_section_get_address(const struct kmod_list *entry);
 154 void kmod_module_section_free_list(struct kmod_list *list);
 155
 156 long kmod_module_get_size(const struct kmod_module *mod);
 157
 158 const char *kmod_module_get_options(const struct kmod_module *mod);
 159 const char *kmod_module_get_install_commands(const struct kmod_module *mod);
 160 const char *kmod_module_get_remove_commands(const struct kmod_module *mod);
 161
 162 int kmod_module_get_softdeps(const struct kmod_module *mod, struct kmod_list **pre, struct kmod_list **post);
 163
 164 int kmod_module_get_info(const struct kmod_module *mod, struct kmod_list **list);
 165 const char *kmod_module_info_get_key(const struct kmod_list *entry);
 166 const char *kmod_module_info_get_value(const struct kmod_list *entry);
 167 void kmod_module_info_free_list(struct kmod_list *list);
 168
 169 int kmod_module_get_versions(const struct kmod_module *mod, struct kmod_list **list);
 170 const char *kmod_module_version_get_symbol(const struct kmod_list *entry);
 171 uint64_t kmod_module_version_get_crc(const struct kmod_list *entry);
 172 void kmod_module_versions_free_list(struct kmod_list *list);
 173
 174 int kmod_module_get_symbols(const struct kmod_module *mod, struct kmod_list **list);
 175 const char *kmod_module_symbol_get_symbol(const struct kmod_list *entry);
 176 uint64_t kmod_module_symbol_get_crc(const struct kmod_list *entry);
 177 void kmod_module_symbols_free_list(struct kmod_list *list);
 178
 179 enum kmod_symbol_bind {
 180         KMOD_SYMBOL_NONE = '\0',
 181         KMOD_SYMBOL_LOCAL = 'L',
 182         KMOD_SYMBOL_GLOBAL = 'G',
 183         KMOD_SYMBOL_WEAK = 'W',
 184         KMOD_SYMBOL_UNDEF = 'U'
 185 };
 186
 187 int kmod_module_get_dependency_symbols(const struct kmod_module *mod, struct kmod_list **list);
 188 const char *kmod_module_dependency_symbol_get_symbol(const struct kmod_list *entry);
 189 int kmod_module_dependency_symbol_get_bind(const struct kmod_list *entry);
 190 uint64_t kmod_module_dependency_symbol_get_crc(const struct kmod_list *entry);
 191 void kmod_module_dependency_symbols_free_list(struct kmod_list *list);
 192
 193 #ifdef __cplusplus
 194 } /* extern "C" */
 195 #endif
 196 #endif