]> git.ipfire.org Git - thirdparty/kmod.git/blame - libkmod/libkmod.h
Use #pragma once instead of #ifndef
[thirdparty/kmod.git] / libkmod / libkmod.h
CommitLineData
586fc304
LDM
1/*
2 * libkmod - interface to kernel module operations
3 *
a66a6a99 4 * Copyright (C) 2011-2012 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
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
e8fd8fec 21#pragma once
6ad98307
LDM
22#ifndef _LIBKMOD_H_
23#define _LIBKMOD_H_
586fc304 24
6806a043 25#include <fcntl.h>
586fc304 26#include <stdarg.h>
00178629 27#include <stdbool.h>
5369797d 28#include <inttypes.h>
586fc304
LDM
29
30#ifdef __cplusplus
31extern "C" {
32#endif
33
34/*
35 * kmod_ctx
36 *
37 * library user context - reads the config and system
38 * environment, user variables, allows custom logging
39 */
40struct kmod_ctx;
6a829211 41struct kmod_ctx *kmod_new(const char *dirname, const char * const *config_paths);
586fc304
LDM
42struct kmod_ctx *kmod_ref(struct kmod_ctx *ctx);
43struct kmod_ctx *kmod_unref(struct kmod_ctx *ctx);
586fc304 44void kmod_set_log_fn(struct kmod_ctx *ctx,
1bdd951e 45 void (*log_fn)(void *log_data,
9226ddad
LDM
46 int priority, const char *file, int line,
47 const char *fn, const char *format,
48 va_list args),
1bdd951e 49 const void *data);
6d177553 50int kmod_get_log_priority(const struct kmod_ctx *ctx);
586fc304 51void kmod_set_log_priority(struct kmod_ctx *ctx, int priority);
6d177553 52void *kmod_get_userdata(const struct kmod_ctx *ctx);
1ce08a56 53void kmod_set_userdata(struct kmod_ctx *ctx, const void *userdata);
9226ddad
LDM
54
55
56/*
57 * Management of libkmod's resources
58 */
33bb69b9
LDM
59int kmod_load_resources(struct kmod_ctx *ctx);
60void kmod_unload_resources(struct kmod_ctx *ctx);
586fc304 61
c4dc3ca8
LDM
62enum kmod_resources {
63 KMOD_RESOURCES_OK = 0,
64 KMOD_RESOURCES_MUST_RELOAD = 1,
65 KMOD_RESOURCES_MUST_RECREATE = 2,
66};
c4dc3ca8
LDM
67int kmod_validate_resources(struct kmod_ctx *ctx);
68
b08314f7
LDM
69enum kmod_index {
70 KMOD_INDEX_MODULES_DEP = 0,
71 KMOD_INDEX_MODULES_ALIAS,
72 KMOD_INDEX_MODULES_SYMBOL,
3805274b 73 KMOD_INDEX_MODULES_BUILTIN,
b08314f7
LDM
74 /* Padding to make sure enum is not mapped to char */
75 _KMOD_INDEX_PAD = (1 << 31),
76};
0224482e 77int kmod_dump_index(struct kmod_ctx *ctx, enum kmod_index type, int fd);
758428a7 78
586fc304
LDM
79/*
80 * kmod_list
81 *
82 * access to kmod generated lists
83 */
6924e47a 84struct kmod_list;
6a829211
LDM
85struct kmod_list *kmod_list_next(const struct kmod_list *list,
86 const struct kmod_list *curr);
87struct kmod_list *kmod_list_prev(const struct kmod_list *list,
88 const struct kmod_list *curr);
89struct kmod_list *kmod_list_last(const struct kmod_list *list);
d5ec60bc 90
6924e47a 91#define kmod_list_foreach(list_entry, first_entry) \
586fc304 92 for (list_entry = first_entry; \
e4351b05 93 list_entry != NULL; \
6924e47a 94 list_entry = kmod_list_next(first_entry, list_entry))
586fc304 95
d6b55b7d
GSB
96#define kmod_list_foreach_reverse(list_entry, first_entry) \
97 for (list_entry = kmod_list_last(first_entry); \
98 list_entry != NULL; \
99 list_entry = kmod_list_prev(first_entry, list_entry))
100
00178629
LDM
101/*
102 * kmod_config_iter
103 *
104 * access to configuration lists - it allows to get each configuration's
105 * key/value stored by kmod
106 */
107struct kmod_config_iter;
108struct kmod_config_iter *kmod_config_get_blacklists(const struct kmod_ctx *ctx);
109struct kmod_config_iter *kmod_config_get_install_commands(const struct kmod_ctx *ctx);
110struct kmod_config_iter *kmod_config_get_remove_commands(const struct kmod_ctx *ctx);
111struct kmod_config_iter *kmod_config_get_aliases(const struct kmod_ctx *ctx);
112struct kmod_config_iter *kmod_config_get_options(const struct kmod_ctx *ctx);
113struct kmod_config_iter *kmod_config_get_softdeps(const struct kmod_ctx *ctx);
114const char *kmod_config_iter_get_key(const struct kmod_config_iter *iter);
115const char *kmod_config_iter_get_value(const struct kmod_config_iter *iter);
116bool kmod_config_iter_next(struct kmod_config_iter *iter);
117void kmod_config_iter_free_iter(struct kmod_config_iter *iter);
118
9226ddad
LDM
119/*
120 * kmod_module
121 *
122 * Operate on kernel modules
123 */
124struct kmod_module;
125int kmod_module_new_from_name(struct kmod_ctx *ctx, const char *name,
126 struct kmod_module **mod);
127int kmod_module_new_from_path(struct kmod_ctx *ctx, const char *path,
128 struct kmod_module **mod);
129int kmod_module_new_from_lookup(struct kmod_ctx *ctx, const char *given_alias,
130 struct kmod_list **list);
131int kmod_module_new_from_loaded(struct kmod_ctx *ctx,
132 struct kmod_list **list);
133
134struct kmod_module *kmod_module_ref(struct kmod_module *mod);
135struct kmod_module *kmod_module_unref(struct kmod_module *mod);
136int kmod_module_unref_list(struct kmod_list *list);
137struct kmod_module *kmod_module_get_module(const struct kmod_list *entry);
138
139
f39dc70e 140/* Removal flags */
423f856a 141enum kmod_remove {
6806a043
LDM
142 KMOD_REMOVE_FORCE = O_TRUNC,
143 KMOD_REMOVE_NOWAIT = O_NONBLOCK,
144};
145
f39dc70e 146/* Insertion flags */
8f788d58
LDM
147enum kmod_insert {
148 KMOD_INSERT_FORCE_VERMAGIC = 0x1,
149 KMOD_INSERT_FORCE_MODVERSION = 0x2,
8f788d58
LDM
150};
151
ddbda022
LDM
152/* Flags to kmod_module_probe_insert_module() */
153enum kmod_probe {
d851e9a1
LDM
154 KMOD_PROBE_FORCE_VERMAGIC = 0x00001,
155 KMOD_PROBE_FORCE_MODVERSION = 0x00002,
156 KMOD_PROBE_IGNORE_COMMAND = 0x00004,
7c10c69c 157 KMOD_PROBE_IGNORE_LOADED = 0x00008,
4c1ffb75 158 KMOD_PROBE_DRY_RUN = 0x00010,
814a57ba 159 KMOD_PROBE_FAIL_ON_LOADED = 0x00020,
b1a51256
LDM
160
161 /* codes below can be used in return value, too */
d851e9a1
LDM
162 KMOD_PROBE_APPLY_BLACKLIST_ALL = 0x10000,
163 KMOD_PROBE_APPLY_BLACKLIST = 0x20000,
ddbda022
LDM
164};
165
d80b103c
DR
166/* Flags to kmod_module_apply_filter() */
167enum kmod_filter {
168 KMOD_FILTER_BLACKLIST = 0x00001,
169 KMOD_FILTER_BUILTIN = 0x00002,
170};
171
8f788d58 172int kmod_module_remove_module(struct kmod_module *mod, unsigned int flags);
9226ddad
LDM
173int kmod_module_insert_module(struct kmod_module *mod, unsigned int flags,
174 const char *options);
ddbda022 175int 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
184const char *kmod_module_get_name(const struct kmod_module *mod);
185const char *kmod_module_get_path(const struct kmod_module *mod);
9226ddad
LDM
186const char *kmod_module_get_options(const struct kmod_module *mod);
187const char *kmod_module_get_install_commands(const struct kmod_module *mod);
188const char *kmod_module_get_remove_commands(const struct kmod_module *mod);
189struct kmod_list *kmod_module_get_dependencies(const struct kmod_module *mod);
190int kmod_module_get_softdeps(const struct kmod_module *mod,
191 struct kmod_list **pre, struct kmod_list **post);
192int 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));
195int 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
207enum 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 215const char *kmod_module_initstate_str(enum kmod_module_initstate state);
f12ae3c4
GSB
216int kmod_module_get_initstate(const struct kmod_module *mod);
217int kmod_module_get_refcnt(const struct kmod_module *mod);
218struct kmod_list *kmod_module_get_holders(const struct kmod_module *mod);
f12ae3c4
GSB
219struct kmod_list *kmod_module_get_sections(const struct kmod_module *mod);
220const char *kmod_module_section_get_name(const struct kmod_list *entry);
221unsigned long kmod_module_section_get_address(const struct kmod_list *entry);
222void kmod_module_section_free_list(struct kmod_list *list);
69f9dd43 223long 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
231int kmod_module_get_info(const struct kmod_module *mod, struct kmod_list **list);
232const char *kmod_module_info_get_key(const struct kmod_list *entry);
233const char *kmod_module_info_get_value(const struct kmod_list *entry);
234void kmod_module_info_free_list(struct kmod_list *list);
235
236int kmod_module_get_versions(const struct kmod_module *mod, struct kmod_list **list);
237const char *kmod_module_version_get_symbol(const struct kmod_list *entry);
238uint64_t kmod_module_version_get_crc(const struct kmod_list *entry);
239void kmod_module_versions_free_list(struct kmod_list *list);
240
45e6db9c
GSB
241int kmod_module_get_symbols(const struct kmod_module *mod, struct kmod_list **list);
242const char *kmod_module_symbol_get_symbol(const struct kmod_list *entry);
243uint64_t kmod_module_symbol_get_crc(const struct kmod_list *entry);
244void kmod_module_symbols_free_list(struct kmod_list *list);
245
674f8590
GSB
246enum 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
254int kmod_module_get_dependency_symbols(const struct kmod_module *mod, struct kmod_list **list);
255const char *kmod_module_dependency_symbol_get_symbol(const struct kmod_list *entry);
256int kmod_module_dependency_symbol_get_bind(const struct kmod_list *entry);
257uint64_t kmod_module_dependency_symbol_get_crc(const struct kmod_list *entry);
258void kmod_module_dependency_symbols_free_list(struct kmod_list *list);
259
2bd6299d
LDM
260#ifdef __cplusplus
261} /* extern "C" */
262#endif
586fc304 263#endif