]>
Commit | Line | Data |
---|---|---|
586fc304 LDM |
1 | /* |
2 | * libkmod - interface to kernel module operations | |
3 | * | |
e6b0e49b | 4 | * Copyright (C) 2011-2013 ProFUSION embedded systems |
586fc304 LDM |
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 | |
cb451f35 LDM |
8 | * License as published by the Free Software Foundation; either |
9 | * version 2.1 of the License, or (at your option) any later version. | |
586fc304 LDM |
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 | |
dea2dfee | 17 | * License along with this library; if not, see <http://www.gnu.org/licenses/>. |
586fc304 LDM |
18 | */ |
19 | ||
e8fd8fec | 20 | #pragma once |
6ad98307 LDM |
21 | #ifndef _LIBKMOD_H_ |
22 | #define _LIBKMOD_H_ | |
586fc304 | 23 | |
6806a043 | 24 | #include <fcntl.h> |
586fc304 | 25 | #include <stdarg.h> |
00178629 | 26 | #include <stdbool.h> |
5369797d | 27 | #include <inttypes.h> |
586fc304 LDM |
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; | |
6a829211 | 40 | struct kmod_ctx *kmod_new(const char *dirname, const char * const *config_paths); |
586fc304 LDM |
41 | struct kmod_ctx *kmod_ref(struct kmod_ctx *ctx); |
42 | struct kmod_ctx *kmod_unref(struct kmod_ctx *ctx); | |
586fc304 | 43 | void kmod_set_log_fn(struct kmod_ctx *ctx, |
1bdd951e | 44 | void (*log_fn)(void *log_data, |
9226ddad LDM |
45 | int priority, const char *file, int line, |
46 | const char *fn, const char *format, | |
47 | va_list args), | |
1bdd951e | 48 | const void *data); |
6d177553 | 49 | int kmod_get_log_priority(const struct kmod_ctx *ctx); |
586fc304 | 50 | void kmod_set_log_priority(struct kmod_ctx *ctx, int priority); |
6d177553 | 51 | void *kmod_get_userdata(const struct kmod_ctx *ctx); |
1ce08a56 | 52 | void kmod_set_userdata(struct kmod_ctx *ctx, const void *userdata); |
9226ddad LDM |
53 | |
54 | ||
55 | /* | |
56 | * Management of libkmod's resources | |
57 | */ | |
33bb69b9 LDM |
58 | int kmod_load_resources(struct kmod_ctx *ctx); |
59 | void kmod_unload_resources(struct kmod_ctx *ctx); | |
586fc304 | 60 | |
c4dc3ca8 LDM |
61 | enum kmod_resources { |
62 | KMOD_RESOURCES_OK = 0, | |
63 | KMOD_RESOURCES_MUST_RELOAD = 1, | |
64 | KMOD_RESOURCES_MUST_RECREATE = 2, | |
65 | }; | |
c4dc3ca8 LDM |
66 | int kmod_validate_resources(struct kmod_ctx *ctx); |
67 | ||
b08314f7 LDM |
68 | enum kmod_index { |
69 | KMOD_INDEX_MODULES_DEP = 0, | |
70 | KMOD_INDEX_MODULES_ALIAS, | |
71 | KMOD_INDEX_MODULES_SYMBOL, | |
3805274b | 72 | KMOD_INDEX_MODULES_BUILTIN, |
b08314f7 LDM |
73 | /* Padding to make sure enum is not mapped to char */ |
74 | _KMOD_INDEX_PAD = (1 << 31), | |
75 | }; | |
0224482e | 76 | int kmod_dump_index(struct kmod_ctx *ctx, enum kmod_index type, int fd); |
758428a7 | 77 | |
586fc304 LDM |
78 | /* |
79 | * kmod_list | |
80 | * | |
81 | * access to kmod generated lists | |
82 | */ | |
6924e47a | 83 | struct kmod_list; |
6a829211 LDM |
84 | struct kmod_list *kmod_list_next(const struct kmod_list *list, |
85 | const struct kmod_list *curr); | |
86 | struct kmod_list *kmod_list_prev(const struct kmod_list *list, | |
87 | const struct kmod_list *curr); | |
88 | struct kmod_list *kmod_list_last(const struct kmod_list *list); | |
d5ec60bc | 89 | |
6924e47a | 90 | #define kmod_list_foreach(list_entry, first_entry) \ |
586fc304 | 91 | for (list_entry = first_entry; \ |
e4351b05 | 92 | list_entry != NULL; \ |
6924e47a | 93 | list_entry = kmod_list_next(first_entry, list_entry)) |
586fc304 | 94 | |
d6b55b7d GSB |
95 | #define kmod_list_foreach_reverse(list_entry, first_entry) \ |
96 | for (list_entry = kmod_list_last(first_entry); \ | |
97 | list_entry != NULL; \ | |
98 | list_entry = kmod_list_prev(first_entry, list_entry)) | |
99 | ||
00178629 LDM |
100 | /* |
101 | * kmod_config_iter | |
102 | * | |
103 | * access to configuration lists - it allows to get each configuration's | |
104 | * key/value stored by kmod | |
105 | */ | |
106 | struct kmod_config_iter; | |
107 | struct kmod_config_iter *kmod_config_get_blacklists(const struct kmod_ctx *ctx); | |
108 | struct kmod_config_iter *kmod_config_get_install_commands(const struct kmod_ctx *ctx); | |
109 | struct kmod_config_iter *kmod_config_get_remove_commands(const struct kmod_ctx *ctx); | |
110 | struct kmod_config_iter *kmod_config_get_aliases(const struct kmod_ctx *ctx); | |
111 | struct kmod_config_iter *kmod_config_get_options(const struct kmod_ctx *ctx); | |
112 | struct kmod_config_iter *kmod_config_get_softdeps(const struct kmod_ctx *ctx); | |
113 | const char *kmod_config_iter_get_key(const struct kmod_config_iter *iter); | |
114 | const char *kmod_config_iter_get_value(const struct kmod_config_iter *iter); | |
115 | bool kmod_config_iter_next(struct kmod_config_iter *iter); | |
116 | void kmod_config_iter_free_iter(struct kmod_config_iter *iter); | |
117 | ||
9226ddad LDM |
118 | /* |
119 | * kmod_module | |
120 | * | |
121 | * Operate on kernel modules | |
122 | */ | |
123 | struct kmod_module; | |
124 | int kmod_module_new_from_name(struct kmod_ctx *ctx, const char *name, | |
125 | struct kmod_module **mod); | |
126 | int kmod_module_new_from_path(struct kmod_ctx *ctx, const char *path, | |
127 | struct kmod_module **mod); | |
128 | int kmod_module_new_from_lookup(struct kmod_ctx *ctx, const char *given_alias, | |
129 | struct kmod_list **list); | |
130 | int kmod_module_new_from_loaded(struct kmod_ctx *ctx, | |
131 | struct kmod_list **list); | |
132 | ||
133 | struct kmod_module *kmod_module_ref(struct kmod_module *mod); | |
134 | struct kmod_module *kmod_module_unref(struct kmod_module *mod); | |
135 | int kmod_module_unref_list(struct kmod_list *list); | |
136 | struct kmod_module *kmod_module_get_module(const struct kmod_list *entry); | |
137 | ||
138 | ||
f39dc70e | 139 | /* Removal flags */ |
423f856a | 140 | enum kmod_remove { |
6806a043 | 141 | KMOD_REMOVE_FORCE = O_TRUNC, |
7ab88044 | 142 | KMOD_REMOVE_NOWAIT = O_NONBLOCK, /* always set */ |
6806a043 LDM |
143 | }; |
144 | ||
f39dc70e | 145 | /* Insertion flags */ |
8f788d58 LDM |
146 | enum kmod_insert { |
147 | KMOD_INSERT_FORCE_VERMAGIC = 0x1, | |
148 | KMOD_INSERT_FORCE_MODVERSION = 0x2, | |
8f788d58 LDM |
149 | }; |
150 | ||
ddbda022 LDM |
151 | /* Flags to kmod_module_probe_insert_module() */ |
152 | enum kmod_probe { | |
d851e9a1 LDM |
153 | KMOD_PROBE_FORCE_VERMAGIC = 0x00001, |
154 | KMOD_PROBE_FORCE_MODVERSION = 0x00002, | |
155 | KMOD_PROBE_IGNORE_COMMAND = 0x00004, | |
7c10c69c | 156 | KMOD_PROBE_IGNORE_LOADED = 0x00008, |
4c1ffb75 | 157 | KMOD_PROBE_DRY_RUN = 0x00010, |
814a57ba | 158 | KMOD_PROBE_FAIL_ON_LOADED = 0x00020, |
b1a51256 LDM |
159 | |
160 | /* codes below can be used in return value, too */ | |
d851e9a1 LDM |
161 | KMOD_PROBE_APPLY_BLACKLIST_ALL = 0x10000, |
162 | KMOD_PROBE_APPLY_BLACKLIST = 0x20000, | |
6882017f | 163 | KMOD_PROBE_APPLY_BLACKLIST_ALIAS_ONLY = 0x40000, |
ddbda022 LDM |
164 | }; |
165 | ||
d80b103c DR |
166 | /* Flags to kmod_module_apply_filter() */ |
167 | enum kmod_filter { | |
168 | KMOD_FILTER_BLACKLIST = 0x00001, | |
169 | KMOD_FILTER_BUILTIN = 0x00002, | |
170 | }; | |
171 | ||
8f788d58 | 172 | int kmod_module_remove_module(struct kmod_module *mod, unsigned int flags); |
9226ddad LDM |
173 | int kmod_module_insert_module(struct kmod_module *mod, unsigned int flags, |
174 | const char *options); | |
ddbda022 | 175 | int kmod_module_probe_insert_module(struct kmod_module *mod, |
6a829211 | 176 | unsigned int flags, const char *extra_options, |
9226ddad LDM |
177 | int (*run_install)(struct kmod_module *m, |
178 | const char *cmdline, void *data), | |
6bd0713d | 179 | const void *data, |
9226ddad LDM |
180 | void (*print_action)(struct kmod_module *m, bool install, |
181 | const char *options)); | |
182 | ||
8f788d58 | 183 | |
1ce08a56 GSB |
184 | const char *kmod_module_get_name(const struct kmod_module *mod); |
185 | const char *kmod_module_get_path(const struct kmod_module *mod); | |
9226ddad LDM |
186 | const char *kmod_module_get_options(const struct kmod_module *mod); |
187 | const char *kmod_module_get_install_commands(const struct kmod_module *mod); | |
188 | const char *kmod_module_get_remove_commands(const struct kmod_module *mod); | |
189 | struct kmod_list *kmod_module_get_dependencies(const struct kmod_module *mod); | |
190 | int kmod_module_get_softdeps(const struct kmod_module *mod, | |
191 | struct kmod_list **pre, struct kmod_list **post); | |
192 | int kmod_module_get_filtered_blacklist(const struct kmod_ctx *ctx, | |
d80b103c DR |
193 | const struct kmod_list *input, |
194 | struct kmod_list **output) __attribute__ ((deprecated)); | |
195 | int kmod_module_apply_filter(const struct kmod_ctx *ctx, | |
196 | enum kmod_filter filter_type, | |
9226ddad LDM |
197 | const struct kmod_list *input, |
198 | struct kmod_list **output); | |
199 | ||
200 | ||
201 | ||
202 | /* | |
203 | * Information regarding "live information" from module's state, as returned | |
204 | * by kernel | |
205 | */ | |
6e869df7 | 206 | |
f12ae3c4 GSB |
207 | enum kmod_module_initstate { |
208 | KMOD_MODULE_BUILTIN = 0, | |
209 | KMOD_MODULE_LIVE, | |
210 | KMOD_MODULE_COMING, | |
49b741d0 LDM |
211 | KMOD_MODULE_GOING, |
212 | /* Padding to make sure enum is not mapped to char */ | |
213 | _KMOD_MODULE_PAD = (1 << 31), | |
f12ae3c4 | 214 | }; |
6a829211 | 215 | const char *kmod_module_initstate_str(enum kmod_module_initstate state); |
f12ae3c4 GSB |
216 | int kmod_module_get_initstate(const struct kmod_module *mod); |
217 | int kmod_module_get_refcnt(const struct kmod_module *mod); | |
218 | struct kmod_list *kmod_module_get_holders(const struct kmod_module *mod); | |
f12ae3c4 GSB |
219 | struct kmod_list *kmod_module_get_sections(const struct kmod_module *mod); |
220 | const char *kmod_module_section_get_name(const struct kmod_list *entry); | |
221 | unsigned long kmod_module_section_get_address(const struct kmod_list *entry); | |
222 | void kmod_module_section_free_list(struct kmod_list *list); | |
69f9dd43 | 223 | long kmod_module_get_size(const struct kmod_module *mod); |
f12ae3c4 | 224 | |
bd3f5535 | 225 | |
9226ddad LDM |
226 | |
227 | /* | |
228 | * Information retrieved from ELF headers and sections | |
229 | */ | |
1c522600 | 230 | |
708624a4 GSB |
231 | int kmod_module_get_info(const struct kmod_module *mod, struct kmod_list **list); |
232 | const char *kmod_module_info_get_key(const struct kmod_list *entry); | |
233 | const char *kmod_module_info_get_value(const struct kmod_list *entry); | |
234 | void kmod_module_info_free_list(struct kmod_list *list); | |
235 | ||
236 | int kmod_module_get_versions(const struct kmod_module *mod, struct kmod_list **list); | |
237 | const char *kmod_module_version_get_symbol(const struct kmod_list *entry); | |
238 | uint64_t kmod_module_version_get_crc(const struct kmod_list *entry); | |
239 | void kmod_module_versions_free_list(struct kmod_list *list); | |
240 | ||
45e6db9c GSB |
241 | int kmod_module_get_symbols(const struct kmod_module *mod, struct kmod_list **list); |
242 | const char *kmod_module_symbol_get_symbol(const struct kmod_list *entry); | |
243 | uint64_t kmod_module_symbol_get_crc(const struct kmod_list *entry); | |
244 | void kmod_module_symbols_free_list(struct kmod_list *list); | |
245 | ||
674f8590 GSB |
246 | enum kmod_symbol_bind { |
247 | KMOD_SYMBOL_NONE = '\0', | |
248 | KMOD_SYMBOL_LOCAL = 'L', | |
249 | KMOD_SYMBOL_GLOBAL = 'G', | |
250 | KMOD_SYMBOL_WEAK = 'W', | |
251 | KMOD_SYMBOL_UNDEF = 'U' | |
252 | }; | |
253 | ||
254 | int kmod_module_get_dependency_symbols(const struct kmod_module *mod, struct kmod_list **list); | |
255 | const char *kmod_module_dependency_symbol_get_symbol(const struct kmod_list *entry); | |
256 | int kmod_module_dependency_symbol_get_bind(const struct kmod_list *entry); | |
257 | uint64_t kmod_module_dependency_symbol_get_crc(const struct kmod_list *entry); | |
258 | void kmod_module_dependency_symbols_free_list(struct kmod_list *list); | |
259 | ||
2bd6299d LDM |
260 | #ifdef __cplusplus |
261 | } /* extern "C" */ | |
262 | #endif | |
586fc304 | 263 | #endif |