libkmod/libkmod-internal.h

   1 #pragma once
   2
   3 #include <stdbool.h>
   4 #include <stdio.h>
   5 #include <syslog.h>
   6 #include <limits.h>
   7
   8 #include <shared/macro.h>
   9 #include <shared/missing.h>
  10
  11 #include "libkmod.h"
  12
  13 static _always_inline_ _printf_format_(2, 3) void
  14         kmod_log_null(const struct kmod_ctx *ctx, const char *format, ...) {}
  15
  16 #define kmod_log_cond(ctx, prio, arg...) \
  17         do { \
  18                 if (kmod_get_log_priority(ctx) >= prio) \
  19                 kmod_log(ctx, prio, __FILE__, __LINE__, __func__, ## arg);\
  20         } while (0)
  21
  22 #ifdef ENABLE_LOGGING
  23 #  ifdef ENABLE_DEBUG
  24 #    define DBG(ctx, arg...) kmod_log_cond(ctx, LOG_DEBUG, ## arg)
  25 #  else
  26 #    define DBG(ctx, arg...) kmod_log_null(ctx, ## arg)
  27 #  endif
  28 #  define NOTICE(ctx, arg...) kmod_log_cond(ctx, LOG_NOTICE, ## arg)
  29 #  define INFO(ctx, arg...) kmod_log_cond(ctx, LOG_INFO, ## arg)
  30 #  define ERR(ctx, arg...) kmod_log_cond(ctx, LOG_ERR, ## arg)
  31 #else
  32 #  define DBG(ctx, arg...) kmod_log_null(ctx, ## arg)
  33 #  define NOTICE(ctx, arg...) kmod_log_null(ctx, ## arg)
  34 #  define INFO(ctx, arg...) kmod_log_null(ctx, ## arg)
  35 #  define ERR(ctx, arg...) kmod_log_null(ctx, ## arg)
  36 #endif
  37
  38 #define KMOD_EXPORT __attribute__ ((visibility("default")))
  39
  40 #define KCMD_LINE_SIZE 4096
  41
  42 #ifndef HAVE_SECURE_GETENV
  43 #  ifdef HAVE___SECURE_GETENV
  44 #    define secure_getenv __secure_getenv
  45 #  else
  46 #    warning neither secure_getenv nor __secure_getenv is available
  47 #    define secure_getenv getenv
  48 #  endif
  49 #endif
  50
  51 void kmod_log(const struct kmod_ctx *ctx,
  52                 int priority, const char *file, int line, const char *fn,
  53                 const char *format, ...) __attribute__((format(printf, 6, 7))) __attribute__((nonnull(1, 3, 5)));
  54
  55 struct list_node {
  56         struct list_node *next, *prev;
  57 };
  58
  59 struct kmod_list {
  60         struct list_node node;
  61         void *data;
  62 };
  63
  64 struct kmod_list *kmod_list_append(struct kmod_list *list, const void *data) _must_check_ __attribute__((nonnull(2)));
  65 struct kmod_list *kmod_list_prepend(struct kmod_list *list, const void *data) _must_check_ __attribute__((nonnull(2)));
  66 struct kmod_list *kmod_list_remove(struct kmod_list *list) _must_check_;
  67 struct kmod_list *kmod_list_remove_data(struct kmod_list *list,
  68                                         const void *data) _must_check_ __attribute__((nonnull(2)));
  69 struct kmod_list *kmod_list_remove_n_latest(struct kmod_list *list,
  70                                                 unsigned int n) _must_check_;
  71 struct kmod_list *kmod_list_insert_after(struct kmod_list *list, const void *data) __attribute__((nonnull(2)));
  72 struct kmod_list *kmod_list_insert_before(struct kmod_list *list, const void *data) __attribute__((nonnull(2)));
  73 struct kmod_list *kmod_list_append_list(struct kmod_list *list1, struct kmod_list *list2) _must_check_;
  74
  75 #undef kmod_list_foreach
  76 #define kmod_list_foreach(list_entry, first_entry) \
  77         for (list_entry = ((first_entry) == NULL) ? NULL : (first_entry); \
  78                 list_entry != NULL; \
  79                 list_entry = (list_entry->node.next == &((first_entry)->node)) ? NULL : \
  80                 container_of(list_entry->node.next, struct kmod_list, node))
  81
  82 #undef kmod_list_foreach_reverse
  83 #define kmod_list_foreach_reverse(list_entry, first_entry) \
  84         for (list_entry = (((first_entry) == NULL) ? NULL : container_of(first_entry->node.prev, struct kmod_list, node)); \
  85                 list_entry != NULL; \
  86                 list_entry = ((list_entry == first_entry) ? NULL :      \
  87                 container_of(list_entry->node.prev, struct kmod_list, node)))
  88
  89 /* libkmod.c */
  90 int kmod_lookup_alias_from_config(struct kmod_ctx *ctx, const char *name, struct kmod_list **list) __attribute__((nonnull(1, 2, 3)));
  91 int kmod_lookup_alias_from_symbols_file(struct kmod_ctx *ctx, const char *name, struct kmod_list **list) __attribute__((nonnull(1, 2, 3)));
  92 int kmod_lookup_alias_from_aliases_file(struct kmod_ctx *ctx, const char *name, struct kmod_list **list) __attribute__((nonnull(1, 2, 3)));
  93 int kmod_lookup_alias_from_moddep_file(struct kmod_ctx *ctx, const char *name, struct kmod_list **list) __attribute__((nonnull(1, 2, 3)));
  94 int kmod_lookup_alias_from_kernel_builtin_file(struct kmod_ctx *ctx, const char *name, struct kmod_list **list) __attribute__((nonnull(1, 2, 3)));
  95 int kmod_lookup_alias_from_builtin_file(struct kmod_ctx *ctx, const char *name, struct kmod_list **list) __attribute__((nonnull(1, 2, 3)));
  96 bool kmod_lookup_alias_is_builtin(struct kmod_ctx *ctx, const char *name) __attribute__((nonnull(1, 2)));
  97 int kmod_lookup_alias_from_commands(struct kmod_ctx *ctx, const char *name, struct kmod_list **list) __attribute__((nonnull(1, 2, 3)));
  98 void kmod_set_modules_visited(struct kmod_ctx *ctx, bool visited) __attribute__((nonnull((1))));
  99 void kmod_set_modules_required(struct kmod_ctx *ctx, bool required) __attribute__((nonnull((1))));
 100
 101 char *kmod_search_moddep(struct kmod_ctx *ctx, const char *name) __attribute__((nonnull(1,2)));
 102
 103 struct kmod_module *kmod_pool_get_module(struct kmod_ctx *ctx, const char *key) __attribute__((nonnull(1,2)));
 104 void kmod_pool_add_module(struct kmod_ctx *ctx, struct kmod_module *mod, const char *key) __attribute__((nonnull(1, 2, 3)));
 105 void kmod_pool_del_module(struct kmod_ctx *ctx, struct kmod_module *mod, const char *key) __attribute__((nonnull(1, 2, 3)));
 106
 107 const struct kmod_config *kmod_get_config(const struct kmod_ctx *ctx) __attribute__((nonnull(1)));
 108
 109 /* libkmod-config.c */
 110 struct kmod_config_path {
 111         unsigned long long stamp;
 112         char path[];
 113 };
 114
 115 struct kmod_config {
 116         struct kmod_ctx *ctx;
 117         struct kmod_list *aliases;
 118         struct kmod_list *blacklists;
 119         struct kmod_list *options;
 120         struct kmod_list *remove_commands;
 121         struct kmod_list *install_commands;
 122         struct kmod_list *softdeps;
 123
 124         struct kmod_list *paths;
 125 };
 126
 127 int kmod_config_new(struct kmod_ctx *ctx, struct kmod_config **config, const char * const *config_paths) __attribute__((nonnull(1, 2,3)));
 128 void kmod_config_free(struct kmod_config *config) __attribute__((nonnull(1)));
 129 const char *kmod_blacklist_get_modname(const struct kmod_list *l) __attribute__((nonnull(1)));
 130 const char *kmod_alias_get_name(const struct kmod_list *l) __attribute__((nonnull(1)));
 131 const char *kmod_alias_get_modname(const struct kmod_list *l) __attribute__((nonnull(1)));
 132 const char *kmod_option_get_options(const struct kmod_list *l) __attribute__((nonnull(1)));
 133 const char *kmod_option_get_modname(const struct kmod_list *l) __attribute__((nonnull(1)));
 134 const char *kmod_command_get_command(const struct kmod_list *l) __attribute__((nonnull(1)));
 135 const char *kmod_command_get_modname(const struct kmod_list *l) __attribute__((nonnull(1)));
 136
 137 const char *kmod_softdep_get_name(const struct kmod_list *l) __attribute__((nonnull(1)));
 138 const char * const *kmod_softdep_get_pre(const struct kmod_list *l, unsigned int *count) __attribute__((nonnull(1, 2)));
 139 const char * const *kmod_softdep_get_post(const struct kmod_list *l, unsigned int *count);
 140
 141
 142 /* libkmod-module.c */
 143 int kmod_module_new_from_alias(struct kmod_ctx *ctx, const char *alias, const char *name, struct kmod_module **mod);
 144 int kmod_module_parse_depline(struct kmod_module *mod, char *line) __attribute__((nonnull(1, 2)));
 145 void kmod_module_set_install_commands(struct kmod_module *mod, const char *cmd) __attribute__((nonnull(1)));
 146 void kmod_module_set_remove_commands(struct kmod_module *mod, const char *cmd) __attribute__((nonnull(1)));
 147 void kmod_module_set_visited(struct kmod_module *mod, bool visited) __attribute__((nonnull(1)));
 148 void kmod_module_set_builtin(struct kmod_module *mod, bool builtin) __attribute__((nonnull((1))));
 149 void kmod_module_set_required(struct kmod_module *mod, bool required) __attribute__((nonnull(1)));
 150 bool kmod_module_is_builtin(struct kmod_module *mod) __attribute__((nonnull(1)));
 151
 152 /* libkmod-file.c */
 153 struct kmod_file *kmod_file_open(const struct kmod_ctx *ctx, const char *filename) _must_check_ __attribute__((nonnull(1,2)));
 154 struct kmod_elf *kmod_file_get_elf(struct kmod_file *file) __attribute__((nonnull(1)));
 155 void *kmod_file_get_contents(const struct kmod_file *file) _must_check_ __attribute__((nonnull(1)));
 156 off_t kmod_file_get_size(const struct kmod_file *file) _must_check_ __attribute__((nonnull(1)));
 157 bool kmod_file_get_direct(const struct kmod_file *file) _must_check_ __attribute__((nonnull(1)));
 158 int kmod_file_get_fd(const struct kmod_file *file) _must_check_ __attribute__((nonnull(1)));
 159 void kmod_file_unref(struct kmod_file *file) __attribute__((nonnull(1)));
 160
 161 /* libkmod-elf.c */
 162 struct kmod_elf;
 163 struct kmod_modversion {
 164         uint64_t crc;
 165         enum kmod_symbol_bind bind;
 166         char *symbol;
 167 };
 168
 169 struct kmod_elf *kmod_elf_new(const void *memory, off_t size) _must_check_ __attribute__((nonnull(1)));
 170 void kmod_elf_unref(struct kmod_elf *elf) __attribute__((nonnull(1)));
 171 const void *kmod_elf_get_memory(const struct kmod_elf *elf) _must_check_ __attribute__((nonnull(1)));
 172 int kmod_elf_get_strings(const struct kmod_elf *elf, const char *section, char ***array) _must_check_ __attribute__((nonnull(1,2,3)));
 173 int kmod_elf_get_modversions(const struct kmod_elf *elf, struct kmod_modversion **array) _must_check_ __attribute__((nonnull(1,2)));
 174 int kmod_elf_get_symbols(const struct kmod_elf *elf, struct kmod_modversion **array) _must_check_ __attribute__((nonnull(1,2)));
 175 int kmod_elf_get_dependency_symbols(const struct kmod_elf *elf, struct kmod_modversion **array) _must_check_ __attribute__((nonnull(1,2)));
 176 int kmod_elf_strip_section(struct kmod_elf *elf, const char *section) _must_check_ __attribute__((nonnull(1,2)));
 177 int kmod_elf_strip_vermagic(struct kmod_elf *elf) _must_check_ __attribute__((nonnull(1)));
 178
 179 /*
 180  * Debug mock lib need to find section ".gnu.linkonce.this_module" in order to
 181  * get modname
 182  */
 183 int kmod_elf_get_section(const struct kmod_elf *elf, const char *section, const void **buf, uint64_t *buf_size) _must_check_ __attribute__((nonnull(1,2,3,4)));
 184
 185 /* libkmod-signature.c */
 186 struct kmod_signature_info {
 187         const char *signer;
 188         size_t signer_len;
 189         const char *key_id;
 190         size_t key_id_len;
 191         const char *algo, *hash_algo, *id_type;
 192         const char *sig;
 193         size_t sig_len;
 194         void (*free)(void *);
 195         void *private;
 196 };
 197 bool kmod_module_signature_info(const struct kmod_file *file, struct kmod_signature_info *sig_info) _must_check_ __attribute__((nonnull(1, 2)));
 198 void kmod_module_signature_info_free(struct kmod_signature_info *sig_info) __attribute__((nonnull));
 199
 200 /* libkmod-builtin.c */
 201 struct kmod_builtin_iter;
 202 struct kmod_builtin_iter *kmod_builtin_iter_new(struct kmod_ctx *ctx) __attribute__((nonnull(1)));
 203 void kmod_builtin_iter_free(struct kmod_builtin_iter *iter) __attribute__((nonnull(1)));
 204 bool kmod_builtin_iter_next(struct kmod_builtin_iter *iter) __attribute__((nonnull(1)));
 205 bool kmod_builtin_iter_get_modname(struct kmod_builtin_iter *iter, char modname[static PATH_MAX]) __attribute__((nonnull(1, 2)));
 206 ssize_t kmod_builtin_get_modinfo(struct kmod_ctx *ctx, const char *modname, char ***modinfo) __attribute__((nonnull(1, 2, 3)));