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
  54
  55 /*
  56  * Management of libkmod's resources
  57  */
  58 int kmod_load_resources(struct kmod_ctx *ctx);
  59 void kmod_unload_resources(struct kmod_ctx *ctx);
  60
  61 enum kmod_resources {
  62         KMOD_RESOURCES_OK = 0,
  63         KMOD_RESOURCES_MUST_RELOAD = 1,
  64         KMOD_RESOURCES_MUST_RECREATE = 2,
  65 };
  66 int kmod_validate_resources(struct kmod_ctx *ctx);
  67
  68 enum kmod_index {
  69         KMOD_INDEX_MODULES_DEP = 0,
  70         KMOD_INDEX_MODULES_ALIAS,
  71         KMOD_INDEX_MODULES_SYMBOL,
  72         /* Padding to make sure enum is not mapped to char */
  73         _KMOD_INDEX_PAD = (1 << 31),
  74 };
  75 int kmod_dump_index(struct kmod_ctx *ctx, enum kmod_index type, int fd);
  76
  77 /*
  78  * kmod_list
  79  *
  80  * access to kmod generated lists
  81  */
  82 struct kmod_list;
  83 struct kmod_list *kmod_list_next(const struct kmod_list *list,
  84                                                 const struct kmod_list *curr);
  85 struct kmod_list *kmod_list_prev(const struct kmod_list *list,
  86                                                 const struct kmod_list *curr);
  87 struct kmod_list *kmod_list_last(const struct kmod_list *list);
  88
  89 #define kmod_list_foreach(list_entry, first_entry) \
  90         for (list_entry = first_entry; \
  91                 list_entry != NULL; \
  92                 list_entry = kmod_list_next(first_entry, list_entry))
  93
  94 #define kmod_list_foreach_reverse(list_entry, first_entry) \
  95         for (list_entry = kmod_list_last(first_entry); \
  96                 list_entry != NULL; \
  97                 list_entry = kmod_list_prev(first_entry, list_entry))
  98
  99 /*
 100  * kmod_config_iter
 101  *
 102  * access to configuration lists - it allows to get each configuration's
 103  * key/value stored by kmod
 104  */
 105 struct kmod_config_iter;
 106 struct kmod_config_iter *kmod_config_get_blacklists(const struct kmod_ctx *ctx);
 107 struct kmod_config_iter *kmod_config_get_install_commands(const struct kmod_ctx *ctx);
 108 struct kmod_config_iter *kmod_config_get_remove_commands(const struct kmod_ctx *ctx);
 109 struct kmod_config_iter *kmod_config_get_aliases(const struct kmod_ctx *ctx);
 110 struct kmod_config_iter *kmod_config_get_options(const struct kmod_ctx *ctx);
 111 struct kmod_config_iter *kmod_config_get_softdeps(const struct kmod_ctx *ctx);
 112 const char *kmod_config_iter_get_key(const struct kmod_config_iter *iter);
 113 const char *kmod_config_iter_get_value(const struct kmod_config_iter *iter);
 114 bool kmod_config_iter_next(struct kmod_config_iter *iter);
 115 void kmod_config_iter_free_iter(struct kmod_config_iter *iter);
 116
 117 /*
 118  * kmod_module
 119  *
 120  * Operate on kernel modules
 121  */
 122 struct kmod_module;
 123 int kmod_module_new_from_name(struct kmod_ctx *ctx, const char *name,
 124                                                 struct kmod_module **mod);
 125 int kmod_module_new_from_path(struct kmod_ctx *ctx, const char *path,
 126                                                 struct kmod_module **mod);
 127 int kmod_module_new_from_lookup(struct kmod_ctx *ctx, const char *given_alias,
 128                                                 struct kmod_list **list);
 129 int kmod_module_new_from_loaded(struct kmod_ctx *ctx,
 130                                                 struct kmod_list **list);
 131
 132 struct kmod_module *kmod_module_ref(struct kmod_module *mod);
 133 struct kmod_module *kmod_module_unref(struct kmod_module *mod);
 134 int kmod_module_unref_list(struct kmod_list *list);
 135 struct kmod_module *kmod_module_get_module(const struct kmod_list *entry);
 136
 137
 138 /* Removal flags */
 139 enum kmod_remove {
 140         KMOD_REMOVE_FORCE = O_TRUNC,
 141         KMOD_REMOVE_NOWAIT = O_NONBLOCK,
 142 };
 143
 144 /* Insertion flags */
 145 enum kmod_insert {
 146         KMOD_INSERT_FORCE_VERMAGIC = 0x1,
 147         KMOD_INSERT_FORCE_MODVERSION = 0x2,
 148 };
 149
 150 /* Flags to kmod_module_probe_insert_module() */
 151 enum kmod_probe {
 152         KMOD_PROBE_FORCE_VERMAGIC =             0x00001,
 153         KMOD_PROBE_FORCE_MODVERSION =           0x00002,
 154         KMOD_PROBE_IGNORE_COMMAND =             0x00004,
 155         KMOD_PROBE_IGNORE_LOADED =              0x00008,
 156         KMOD_PROBE_DRY_RUN =                    0x00010,
 157         KMOD_PROBE_STOP_ON_ALREADY_LOADED =     0x00020,
 158
 159         /* codes below can be used in return value, too */
 160         KMOD_PROBE_APPLY_BLACKLIST_ALL =        0x10000,
 161         KMOD_PROBE_APPLY_BLACKLIST =            0x20000,
 162 };
 163
 164 int kmod_module_remove_module(struct kmod_module *mod, unsigned int flags);
 165 int kmod_module_insert_module(struct kmod_module *mod, unsigned int flags,
 166                                                         const char *options);
 167 int kmod_module_probe_insert_module(struct kmod_module *mod,
 168                         unsigned int flags, const char *extra_options,
 169                         int (*run_install)(struct kmod_module *m,
 170                                                 const char *cmdline, void *data),
 171                         const void *data,
 172                         void (*print_action)(struct kmod_module *m, bool install,
 173                                                 const char *options));
 174
 175
 176 const char *kmod_module_get_name(const struct kmod_module *mod);
 177 const char *kmod_module_get_path(const struct kmod_module *mod);
 178 const char *kmod_module_get_options(const struct kmod_module *mod);
 179 const char *kmod_module_get_install_commands(const struct kmod_module *mod);
 180 const char *kmod_module_get_remove_commands(const struct kmod_module *mod);
 181 struct kmod_list *kmod_module_get_dependencies(const struct kmod_module *mod);
 182 int kmod_module_get_softdeps(const struct kmod_module *mod,
 183                                 struct kmod_list **pre, struct kmod_list **post);
 184 int kmod_module_get_filtered_blacklist(const struct kmod_ctx *ctx,
 185                                         const struct kmod_list *input,
 186                                         struct kmod_list **output);
 187
 188
 189
 190 /*
 191  * Information regarding "live information" from module's state, as returned
 192  * by kernel
 193  */
 194
 195 enum kmod_module_initstate {
 196         KMOD_MODULE_BUILTIN = 0,
 197         KMOD_MODULE_LIVE,
 198         KMOD_MODULE_COMING,
 199         KMOD_MODULE_GOING,
 200         /* Padding to make sure enum is not mapped to char */
 201         _KMOD_MODULE_PAD = (1 << 31),
 202 };
 203 const char *kmod_module_initstate_str(enum kmod_module_initstate state);
 204 int kmod_module_get_initstate(const struct kmod_module *mod);
 205 int kmod_module_get_refcnt(const struct kmod_module *mod);
 206 struct kmod_list *kmod_module_get_holders(const struct kmod_module *mod);
 207 struct kmod_list *kmod_module_get_sections(const struct kmod_module *mod);
 208 const char *kmod_module_section_get_name(const struct kmod_list *entry);
 209 unsigned long kmod_module_section_get_address(const struct kmod_list *entry);
 210 void kmod_module_section_free_list(struct kmod_list *list);
 211 long kmod_module_get_size(const struct kmod_module *mod);
 212
 213
 214
 215 /*
 216  * Information retrieved from ELF headers and sections
 217  */
 218
 219 int kmod_module_get_info(const struct kmod_module *mod, struct kmod_list **list);
 220 const char *kmod_module_info_get_key(const struct kmod_list *entry);
 221 const char *kmod_module_info_get_value(const struct kmod_list *entry);
 222 void kmod_module_info_free_list(struct kmod_list *list);
 223
 224 int kmod_module_get_versions(const struct kmod_module *mod, struct kmod_list **list);
 225 const char *kmod_module_version_get_symbol(const struct kmod_list *entry);
 226 uint64_t kmod_module_version_get_crc(const struct kmod_list *entry);
 227 void kmod_module_versions_free_list(struct kmod_list *list);
 228
 229 int kmod_module_get_symbols(const struct kmod_module *mod, struct kmod_list **list);
 230 const char *kmod_module_symbol_get_symbol(const struct kmod_list *entry);
 231 uint64_t kmod_module_symbol_get_crc(const struct kmod_list *entry);
 232 void kmod_module_symbols_free_list(struct kmod_list *list);
 233
 234 enum kmod_symbol_bind {
 235         KMOD_SYMBOL_NONE = '\0',
 236         KMOD_SYMBOL_LOCAL = 'L',
 237         KMOD_SYMBOL_GLOBAL = 'G',
 238         KMOD_SYMBOL_WEAK = 'W',
 239         KMOD_SYMBOL_UNDEF = 'U'
 240 };
 241
 242 int kmod_module_get_dependency_symbols(const struct kmod_module *mod, struct kmod_list **list);
 243 const char *kmod_module_dependency_symbol_get_symbol(const struct kmod_list *entry);
 244 int kmod_module_dependency_symbol_get_bind(const struct kmod_list *entry);
 245 uint64_t kmod_module_dependency_symbol_get_crc(const struct kmod_list *entry);
 246 void kmod_module_dependency_symbols_free_list(struct kmod_list *list);
 247
 248 #ifdef __cplusplus
 249 } /* extern "C" */
 250 #endif
 251 #endif