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 /*
  56  * kmod_list
  57  *
  58  * access to kmod generated lists
  59  */
  60 struct kmod_list;
  61 struct kmod_list *kmod_list_next(const struct kmod_list *first_entry,
  62                                                 const struct kmod_list *list_entry);
  63 struct kmod_list *kmod_list_prev(const struct kmod_list *first_entry,
  64                                                 const struct kmod_list *list_entry);
  65 struct kmod_list *kmod_list_last(const struct kmod_list *first_entry);
  66
  67 #define kmod_list_foreach(list_entry, first_entry) \
  68         for (list_entry = first_entry; \
  69                 list_entry != NULL; \
  70                 list_entry = kmod_list_next(first_entry, list_entry))
  71
  72 #define kmod_list_foreach_reverse(list_entry, first_entry) \
  73         for (list_entry = kmod_list_last(first_entry); \
  74                 list_entry != NULL; \
  75                 list_entry = kmod_list_prev(first_entry, list_entry))
  76
  77 /* Removal flags */
  78 enum kmod_remove {
  79         KMOD_REMOVE_FORCE = O_TRUNC,
  80         KMOD_REMOVE_NOWAIT = O_NONBLOCK,
  81 };
  82
  83 /* Insertion flags */
  84 enum kmod_insert {
  85         KMOD_INSERT_FORCE_VERMAGIC = 0x1,
  86         KMOD_INSERT_FORCE_MODVERSION = 0x2,
  87 };
  88
  89 /* Flags to kmod_module_probe_insert_module() */
  90 enum kmod_probe {
  91         KMOD_PROBE_FORCE_VERMAGIC = 0x1,
  92         KMOD_PROBE_FORCE_MODVERSION = 0x2,
  93         KMOD_PROBE_STOP_ON_BLACKLIST = 0x4,
  94         KMOD_PROBE_STOP_ON_FAILURE = 0x8,
  95         KMOD_PROBE_STOP_ON_COMMAND = 0x16,
  96 };
  97
  98 /*
  99  * kmod_module
 100  *
 101  * Operate on kernel modules
 102  */
 103 struct kmod_module;
 104 int kmod_module_new_from_name(struct kmod_ctx *ctx, const char *name,
 105                                                 struct kmod_module **mod);
 106 int kmod_module_new_from_path(struct kmod_ctx *ctx, const char *path,
 107                                                 struct kmod_module **mod);
 108 int kmod_module_new_from_lookup(struct kmod_ctx *ctx, const char *alias,
 109                                                 struct kmod_list **list);
 110 int kmod_module_new_from_loaded(struct kmod_ctx *ctx, struct kmod_list **list);
 111
 112 struct kmod_module *kmod_module_ref(struct kmod_module *mod);
 113 struct kmod_module *kmod_module_unref(struct kmod_module *mod);
 114 int kmod_module_unref_list(struct kmod_list *list);
 115 struct kmod_module *kmod_module_get_module(const struct kmod_list *entry);
 116 struct kmod_list *kmod_module_get_dependencies(const struct kmod_module *mod);
 117
 118 int kmod_module_get_filtered_blacklist(const struct kmod_ctx *ctx, const struct kmod_list *input, struct kmod_list **output);
 119
 120 int kmod_module_remove_module(struct kmod_module *mod, unsigned int flags);
 121 int kmod_module_insert_module(struct kmod_module *mod, unsigned int flags, const char *options);
 122 int kmod_module_probe_insert_module(struct kmod_module *mod,
 123                         unsigned int flags, const char *options,
 124                         int (*run_install)(struct kmod_module *m, const char *cmdline, void *data),
 125                         const void *data);
 126
 127 const char *kmod_module_get_name(const struct kmod_module *mod);
 128 const char *kmod_module_get_path(const struct kmod_module *mod);
 129
 130 enum kmod_module_initstate {
 131         KMOD_MODULE_BUILTIN = 0,
 132         KMOD_MODULE_LIVE,
 133         KMOD_MODULE_COMING,
 134         KMOD_MODULE_GOING,
 135         /* Padding to make sure enum is not mapped to char */
 136         _KMOD_MODULE_PAD = (1 << 31),
 137 };
 138 const char *kmod_module_initstate_str(enum kmod_module_initstate initstate);
 139 int kmod_module_get_initstate(const struct kmod_module *mod);
 140 int kmod_module_get_refcnt(const struct kmod_module *mod);
 141 struct kmod_list *kmod_module_get_holders(const struct kmod_module *mod);
 142
 143 struct kmod_list *kmod_module_get_sections(const struct kmod_module *mod);
 144 const char *kmod_module_section_get_name(const struct kmod_list *entry);
 145 unsigned long kmod_module_section_get_address(const struct kmod_list *entry);
 146 void kmod_module_section_free_list(struct kmod_list *list);
 147
 148 long kmod_module_get_size(const struct kmod_module *mod);
 149
 150 const char *kmod_module_get_options(const struct kmod_module *mod);
 151 const char *kmod_module_get_install_commands(const struct kmod_module *mod);
 152 const char *kmod_module_get_remove_commands(const struct kmod_module *mod);
 153
 154 int kmod_module_get_softdeps(const struct kmod_module *mod, struct kmod_list **pre, struct kmod_list **post);
 155
 156 int kmod_module_get_info(const struct kmod_module *mod, struct kmod_list **list);
 157 const char *kmod_module_info_get_key(const struct kmod_list *entry);
 158 const char *kmod_module_info_get_value(const struct kmod_list *entry);
 159 void kmod_module_info_free_list(struct kmod_list *list);
 160
 161 int kmod_module_get_versions(const struct kmod_module *mod, struct kmod_list **list);
 162 const char *kmod_module_version_get_symbol(const struct kmod_list *entry);
 163 uint64_t kmod_module_version_get_crc(const struct kmod_list *entry);
 164 void kmod_module_versions_free_list(struct kmod_list *list);
 165
 166 int kmod_module_get_symbols(const struct kmod_module *mod, struct kmod_list **list);
 167 const char *kmod_module_symbol_get_symbol(const struct kmod_list *entry);
 168 uint64_t kmod_module_symbol_get_crc(const struct kmod_list *entry);
 169 void kmod_module_symbols_free_list(struct kmod_list *list);
 170
 171 enum kmod_symbol_bind {
 172         KMOD_SYMBOL_NONE = '\0',
 173         KMOD_SYMBOL_LOCAL = 'L',
 174         KMOD_SYMBOL_GLOBAL = 'G',
 175         KMOD_SYMBOL_WEAK = 'W',
 176         KMOD_SYMBOL_UNDEF = 'U'
 177 };
 178
 179 int kmod_module_get_dependency_symbols(const struct kmod_module *mod, struct kmod_list **list);
 180 const char *kmod_module_dependency_symbol_get_symbol(const struct kmod_list *entry);
 181 int kmod_module_dependency_symbol_get_bind(const struct kmod_list *entry);
 182 uint64_t kmod_module_dependency_symbol_get_crc(const struct kmod_list *entry);
 183 void kmod_module_dependency_symbols_free_list(struct kmod_list *list);
 184
 185 #ifdef __cplusplus
 186 } /* extern "C" */
 187 #endif
 188 #endif