libkmod/libkmod.h

   1 /*
   2  * libkmod - interface to kernel module operations
   3  *
   4  * Copyright (C) 2011-2012  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 <stdbool.h>
  27 #include <inttypes.h>
  28
  29 #ifdef __cplusplus
  30 extern "C" {
  31 #endif
  32
  33 /*
  34  * kmod_ctx
  35  *
  36  * library user context - reads the config and system
  37  * environment, user variables, allows custom logging
  38  */
  39 struct kmod_ctx;
  40 struct kmod_ctx *kmod_new(const char *dirname, const char * const *config_paths);
  41 struct kmod_ctx *kmod_ref(struct kmod_ctx *ctx);
  42 struct kmod_ctx *kmod_unref(struct kmod_ctx *ctx);
  43 void kmod_set_log_fn(struct kmod_ctx *ctx,
  44                         void (*log_fn)(void *log_data,
  45                                 int priority, const char *file, int line,
  46                                 const char *fn, const char *format,
  47                                 va_list args),
  48                         const void *data);
  49 int kmod_get_log_priority(const struct kmod_ctx *ctx);
  50 void kmod_set_log_priority(struct kmod_ctx *ctx, int priority);
  51 void *kmod_get_userdata(const struct kmod_ctx *ctx);
  52 void kmod_set_userdata(struct kmod_ctx *ctx, const void *userdata);
  53 int kmod_load_resources(struct kmod_ctx *ctx);
  54 void kmod_unload_resources(struct kmod_ctx *ctx);
  55
  56 enum kmod_resources {
  57         KMOD_RESOURCES_OK = 0,
  58         KMOD_RESOURCES_MUST_RELOAD = 1,
  59         KMOD_RESOURCES_MUST_RECREATE = 2,
  60 };
  61
  62 int kmod_validate_resources(struct kmod_ctx *ctx);
  63
  64 /*
  65  * kmod_list
  66  *
  67  * access to kmod generated lists
  68  */
  69 struct kmod_list;
  70 struct kmod_list *kmod_list_next(const struct kmod_list *list,
  71                                                 const struct kmod_list *curr);
  72 struct kmod_list *kmod_list_prev(const struct kmod_list *list,
  73                                                 const struct kmod_list *curr);
  74 struct kmod_list *kmod_list_last(const struct kmod_list *list);
  75
  76 #define kmod_list_foreach(list_entry, first_entry) \
  77         for (list_entry = first_entry; \
  78                 list_entry != NULL; \
  79                 list_entry = kmod_list_next(first_entry, list_entry))
  80
  81 #define kmod_list_foreach_reverse(list_entry, first_entry) \
  82         for (list_entry = kmod_list_last(first_entry); \
  83                 list_entry != NULL; \
  84                 list_entry = kmod_list_prev(first_entry, list_entry))
  85
  86 /*
  87  * kmod_config_iter
  88  *
  89  * access to configuration lists - it allows to get each configuration's
  90  * key/value stored by kmod
  91  */
  92 struct kmod_config_iter;
  93 struct kmod_config_iter *kmod_config_get_blacklists(const struct kmod_ctx *ctx);
  94 struct kmod_config_iter *kmod_config_get_install_commands(const struct kmod_ctx *ctx);
  95 struct kmod_config_iter *kmod_config_get_remove_commands(const struct kmod_ctx *ctx);
  96 struct kmod_config_iter *kmod_config_get_aliases(const struct kmod_ctx *ctx);
  97 struct kmod_config_iter *kmod_config_get_options(const struct kmod_ctx *ctx);
  98 struct kmod_config_iter *kmod_config_get_softdeps(const struct kmod_ctx *ctx);
  99 const char *kmod_config_iter_get_key(const struct kmod_config_iter *iter);
 100 const char *kmod_config_iter_get_value(const struct kmod_config_iter *iter);
 101 bool kmod_config_iter_next(struct kmod_config_iter *iter);
 102 void kmod_config_iter_free_iter(struct kmod_config_iter *iter);
 103
 104 /* Removal flags */
 105 enum kmod_remove {
 106         KMOD_REMOVE_FORCE = O_TRUNC,
 107         KMOD_REMOVE_NOWAIT = O_NONBLOCK,
 108 };
 109
 110 /* Insertion flags */
 111 enum kmod_insert {
 112         KMOD_INSERT_FORCE_VERMAGIC = 0x1,
 113         KMOD_INSERT_FORCE_MODVERSION = 0x2,
 114 };
 115
 116 /* Flags to kmod_module_probe_insert_module() */
 117 enum kmod_probe {
 118         KMOD_PROBE_FORCE_VERMAGIC = 0x1,
 119         KMOD_PROBE_FORCE_MODVERSION = 0x2,
 120         KMOD_PROBE_STOP_ON_BLACKLIST = 0x4,
 121         KMOD_PROBE_STOP_ON_FAILURE = 0x8,
 122         KMOD_PROBE_STOP_ON_COMMAND = 0x16,
 123 };
 124
 125 /*
 126  * kmod_module
 127  *
 128  * Operate on kernel modules
 129  */
 130 struct kmod_module;
 131 int kmod_module_new_from_name(struct kmod_ctx *ctx, const char *name,
 132                                                 struct kmod_module **mod);
 133 int kmod_module_new_from_path(struct kmod_ctx *ctx, const char *path,
 134                                                 struct kmod_module **mod);
 135 int kmod_module_new_from_lookup(struct kmod_ctx *ctx, const char *given_alias,
 136                                                 struct kmod_list **list);
 137 int kmod_module_new_from_loaded(struct kmod_ctx *ctx, struct kmod_list **list);
 138
 139 struct kmod_module *kmod_module_ref(struct kmod_module *mod);
 140 struct kmod_module *kmod_module_unref(struct kmod_module *mod);
 141 int kmod_module_unref_list(struct kmod_list *list);
 142 struct kmod_module *kmod_module_get_module(const struct kmod_list *entry);
 143 struct kmod_list *kmod_module_get_dependencies(const struct kmod_module *mod);
 144
 145 int kmod_module_get_filtered_blacklist(const struct kmod_ctx *ctx, const struct kmod_list *input, struct kmod_list **output);
 146
 147 int kmod_module_remove_module(struct kmod_module *mod, unsigned int flags);
 148 int kmod_module_insert_module(struct kmod_module *mod, unsigned int flags, const char *options);
 149 int kmod_module_probe_insert_module(struct kmod_module *mod,
 150                         unsigned int flags, const char *extra_options,
 151                         int (*run_install)(struct kmod_module *m, const char *cmdline, void *data),
 152                         const void *data);
 153
 154 const char *kmod_module_get_name(const struct kmod_module *mod);
 155 const char *kmod_module_get_path(const struct kmod_module *mod);
 156
 157 enum kmod_module_initstate {
 158         KMOD_MODULE_BUILTIN = 0,
 159         KMOD_MODULE_LIVE,
 160         KMOD_MODULE_COMING,
 161         KMOD_MODULE_GOING,
 162         /* Padding to make sure enum is not mapped to char */
 163         _KMOD_MODULE_PAD = (1 << 31),
 164 };
 165 const char *kmod_module_initstate_str(enum kmod_module_initstate state);
 166 int kmod_module_get_initstate(const struct kmod_module *mod);
 167 int kmod_module_get_refcnt(const struct kmod_module *mod);
 168 struct kmod_list *kmod_module_get_holders(const struct kmod_module *mod);
 169
 170 struct kmod_list *kmod_module_get_sections(const struct kmod_module *mod);
 171 const char *kmod_module_section_get_name(const struct kmod_list *entry);
 172 unsigned long kmod_module_section_get_address(const struct kmod_list *entry);
 173 void kmod_module_section_free_list(struct kmod_list *list);
 174
 175 long kmod_module_get_size(const struct kmod_module *mod);
 176
 177 const char *kmod_module_get_options(const struct kmod_module *mod);
 178 const char *kmod_module_get_install_commands(const struct kmod_module *mod);
 179 const char *kmod_module_get_remove_commands(const struct kmod_module *mod);
 180
 181 int kmod_module_get_softdeps(const struct kmod_module *mod, struct kmod_list **pre, struct kmod_list **post);
 182
 183 int kmod_module_get_info(const struct kmod_module *mod, struct kmod_list **list);
 184 const char *kmod_module_info_get_key(const struct kmod_list *entry);
 185 const char *kmod_module_info_get_value(const struct kmod_list *entry);
 186 void kmod_module_info_free_list(struct kmod_list *list);
 187
 188 int kmod_module_get_versions(const struct kmod_module *mod, struct kmod_list **list);
 189 const char *kmod_module_version_get_symbol(const struct kmod_list *entry);
 190 uint64_t kmod_module_version_get_crc(const struct kmod_list *entry);
 191 void kmod_module_versions_free_list(struct kmod_list *list);
 192
 193 int kmod_module_get_symbols(const struct kmod_module *mod, struct kmod_list **list);
 194 const char *kmod_module_symbol_get_symbol(const struct kmod_list *entry);
 195 uint64_t kmod_module_symbol_get_crc(const struct kmod_list *entry);
 196 void kmod_module_symbols_free_list(struct kmod_list *list);
 197
 198 enum kmod_symbol_bind {
 199         KMOD_SYMBOL_NONE = '\0',
 200         KMOD_SYMBOL_LOCAL = 'L',
 201         KMOD_SYMBOL_GLOBAL = 'G',
 202         KMOD_SYMBOL_WEAK = 'W',
 203         KMOD_SYMBOL_UNDEF = 'U'
 204 };
 205
 206 int kmod_module_get_dependency_symbols(const struct kmod_module *mod, struct kmod_list **list);
 207 const char *kmod_module_dependency_symbol_get_symbol(const struct kmod_list *entry);
 208 int kmod_module_dependency_symbol_get_bind(const struct kmod_list *entry);
 209 uint64_t kmod_module_dependency_symbol_get_crc(const struct kmod_list *entry);
 210 void kmod_module_dependency_symbols_free_list(struct kmod_list *list);
 211
 212 #ifdef __cplusplus
 213 } /* extern "C" */
 214 #endif
 215 #endif