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