2 * libkmod - interface to kernel module operations
4 * Copyright (C) 2011-2013 ProFUSION embedded systems
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.
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.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, see <http://www.gnu.org/licenses/>.
36 * library user context - reads the config and system
37 * environment, user variables, allows custom logging
40 struct kmod_ctx
*kmod_new(const char *dirname
, const char * const *config_paths
);
41 struct kmod_ctx
*kmod_ref(struct kmod_ctx
*ctx
);
42 struct kmod_ctx
*kmod_unref(struct kmod_ctx
*ctx
);
43 void kmod_set_log_fn(struct kmod_ctx
*ctx
,
44 void (*log_fn
)(void *log_data
,
45 int priority
, const char *file
, int line
,
46 const char *fn
, const char *format
,
49 int kmod_get_log_priority(const struct kmod_ctx
*ctx
);
50 void kmod_set_log_priority(struct kmod_ctx
*ctx
, int priority
);
51 void *kmod_get_userdata(const struct kmod_ctx
*ctx
);
52 void kmod_set_userdata(struct kmod_ctx
*ctx
, const void *userdata
);
54 const char *kmod_get_dirname(const struct kmod_ctx
*ctx
);
57 * Management of libkmod's resources
59 int kmod_load_resources(struct kmod_ctx
*ctx
);
60 void kmod_unload_resources(struct kmod_ctx
*ctx
);
63 KMOD_RESOURCES_OK
= 0,
64 KMOD_RESOURCES_MUST_RELOAD
= 1,
65 KMOD_RESOURCES_MUST_RECREATE
= 2,
67 int kmod_validate_resources(struct kmod_ctx
*ctx
);
70 KMOD_INDEX_MODULES_DEP
= 0,
71 KMOD_INDEX_MODULES_ALIAS
,
72 KMOD_INDEX_MODULES_SYMBOL
,
73 KMOD_INDEX_MODULES_BUILTIN
,
74 /* Padding to make sure enum is not mapped to char */
75 _KMOD_INDEX_PAD
= (1 << 31),
77 int kmod_dump_index(struct kmod_ctx
*ctx
, enum kmod_index type
, int fd
);
82 * access to kmod generated lists
85 struct kmod_list
*kmod_list_next(const struct kmod_list
*list
,
86 const struct kmod_list
*curr
);
87 struct kmod_list
*kmod_list_prev(const struct kmod_list
*list
,
88 const struct kmod_list
*curr
);
89 struct kmod_list
*kmod_list_last(const struct kmod_list
*list
);
91 #define kmod_list_foreach(list_entry, first_entry) \
92 for (list_entry = first_entry; \
94 list_entry = kmod_list_next(first_entry, list_entry))
96 #define kmod_list_foreach_reverse(list_entry, first_entry) \
97 for (list_entry = kmod_list_last(first_entry); \
99 list_entry = kmod_list_prev(first_entry, list_entry))
104 * access to configuration lists - it allows to get each configuration's
105 * key/value stored by kmod
107 struct kmod_config_iter
;
108 struct kmod_config_iter
*kmod_config_get_blacklists(const struct kmod_ctx
*ctx
);
109 struct kmod_config_iter
*kmod_config_get_install_commands(const struct kmod_ctx
*ctx
);
110 struct kmod_config_iter
*kmod_config_get_remove_commands(const struct kmod_ctx
*ctx
);
111 struct kmod_config_iter
*kmod_config_get_aliases(const struct kmod_ctx
*ctx
);
112 struct kmod_config_iter
*kmod_config_get_options(const struct kmod_ctx
*ctx
);
113 struct kmod_config_iter
*kmod_config_get_softdeps(const struct kmod_ctx
*ctx
);
114 const char *kmod_config_iter_get_key(const struct kmod_config_iter
*iter
);
115 const char *kmod_config_iter_get_value(const struct kmod_config_iter
*iter
);
116 bool kmod_config_iter_next(struct kmod_config_iter
*iter
);
117 void kmod_config_iter_free_iter(struct kmod_config_iter
*iter
);
122 * Operate on kernel modules
125 int kmod_module_new_from_name(struct kmod_ctx
*ctx
, const char *name
,
126 struct kmod_module
**mod
);
127 int kmod_module_new_from_path(struct kmod_ctx
*ctx
, const char *path
,
128 struct kmod_module
**mod
);
129 int kmod_module_new_from_lookup(struct kmod_ctx
*ctx
, const char *given_alias
,
130 struct kmod_list
**list
);
131 int kmod_module_new_from_loaded(struct kmod_ctx
*ctx
,
132 struct kmod_list
**list
);
134 struct kmod_module
*kmod_module_ref(struct kmod_module
*mod
);
135 struct kmod_module
*kmod_module_unref(struct kmod_module
*mod
);
136 int kmod_module_unref_list(struct kmod_list
*list
);
137 struct kmod_module
*kmod_module_get_module(const struct kmod_list
*entry
);
142 KMOD_REMOVE_FORCE
= O_TRUNC
,
143 KMOD_REMOVE_NOWAIT
= O_NONBLOCK
, /* always set */
146 /* Insertion flags */
148 KMOD_INSERT_FORCE_VERMAGIC
= 0x1,
149 KMOD_INSERT_FORCE_MODVERSION
= 0x2,
152 /* Flags to kmod_module_probe_insert_module() */
154 KMOD_PROBE_FORCE_VERMAGIC
= 0x00001,
155 KMOD_PROBE_FORCE_MODVERSION
= 0x00002,
156 KMOD_PROBE_IGNORE_COMMAND
= 0x00004,
157 KMOD_PROBE_IGNORE_LOADED
= 0x00008,
158 KMOD_PROBE_DRY_RUN
= 0x00010,
159 KMOD_PROBE_FAIL_ON_LOADED
= 0x00020,
161 /* codes below can be used in return value, too */
162 KMOD_PROBE_APPLY_BLACKLIST_ALL
= 0x10000,
163 KMOD_PROBE_APPLY_BLACKLIST
= 0x20000,
164 KMOD_PROBE_APPLY_BLACKLIST_ALIAS_ONLY
= 0x40000,
167 /* Flags to kmod_module_apply_filter() */
169 KMOD_FILTER_BLACKLIST
= 0x00001,
170 KMOD_FILTER_BUILTIN
= 0x00002,
173 int kmod_module_remove_module(struct kmod_module
*mod
, unsigned int flags
);
174 int kmod_module_insert_module(struct kmod_module
*mod
, unsigned int flags
,
175 const char *options
);
176 int kmod_module_probe_insert_module(struct kmod_module
*mod
,
177 unsigned int flags
, const char *extra_options
,
178 int (*run_install
)(struct kmod_module
*m
,
179 const char *cmdline
, void *data
),
181 void (*print_action
)(struct kmod_module
*m
, bool install
,
182 const char *options
));
185 const char *kmod_module_get_name(const struct kmod_module
*mod
);
186 const char *kmod_module_get_path(const struct kmod_module
*mod
);
187 const char *kmod_module_get_options(const struct kmod_module
*mod
);
188 const char *kmod_module_get_install_commands(const struct kmod_module
*mod
);
189 const char *kmod_module_get_remove_commands(const struct kmod_module
*mod
);
190 struct kmod_list
*kmod_module_get_dependencies(const struct kmod_module
*mod
);
191 int kmod_module_get_softdeps(const struct kmod_module
*mod
,
192 struct kmod_list
**pre
, struct kmod_list
**post
);
193 int kmod_module_get_filtered_blacklist(const struct kmod_ctx
*ctx
,
194 const struct kmod_list
*input
,
195 struct kmod_list
**output
) __attribute__ ((deprecated
));
196 int kmod_module_apply_filter(const struct kmod_ctx
*ctx
,
197 enum kmod_filter filter_type
,
198 const struct kmod_list
*input
,
199 struct kmod_list
**output
);
204 * Information regarding "live information" from module's state, as returned
208 enum kmod_module_initstate
{
209 KMOD_MODULE_BUILTIN
= 0,
213 /* Padding to make sure enum is not mapped to char */
214 _KMOD_MODULE_PAD
= (1 << 31),
216 const char *kmod_module_initstate_str(enum kmod_module_initstate state
);
217 int kmod_module_get_initstate(const struct kmod_module
*mod
);
218 int kmod_module_get_refcnt(const struct kmod_module
*mod
);
219 struct kmod_list
*kmod_module_get_holders(const struct kmod_module
*mod
);
220 struct kmod_list
*kmod_module_get_sections(const struct kmod_module
*mod
);
221 const char *kmod_module_section_get_name(const struct kmod_list
*entry
);
222 unsigned long kmod_module_section_get_address(const struct kmod_list
*entry
);
223 void kmod_module_section_free_list(struct kmod_list
*list
);
224 long kmod_module_get_size(const struct kmod_module
*mod
);
229 * Information retrieved from ELF headers and sections
232 int kmod_module_get_info(const struct kmod_module
*mod
, struct kmod_list
**list
);
233 const char *kmod_module_info_get_key(const struct kmod_list
*entry
);
234 const char *kmod_module_info_get_value(const struct kmod_list
*entry
);
235 void kmod_module_info_free_list(struct kmod_list
*list
);
237 int kmod_module_get_versions(const struct kmod_module
*mod
, struct kmod_list
**list
);
238 const char *kmod_module_version_get_symbol(const struct kmod_list
*entry
);
239 uint64_t kmod_module_version_get_crc(const struct kmod_list
*entry
);
240 void kmod_module_versions_free_list(struct kmod_list
*list
);
242 int kmod_module_get_symbols(const struct kmod_module
*mod
, struct kmod_list
**list
);
243 const char *kmod_module_symbol_get_symbol(const struct kmod_list
*entry
);
244 uint64_t kmod_module_symbol_get_crc(const struct kmod_list
*entry
);
245 void kmod_module_symbols_free_list(struct kmod_list
*list
);
247 enum kmod_symbol_bind
{
248 KMOD_SYMBOL_NONE
= '\0',
249 KMOD_SYMBOL_LOCAL
= 'L',
250 KMOD_SYMBOL_GLOBAL
= 'G',
251 KMOD_SYMBOL_WEAK
= 'W',
252 KMOD_SYMBOL_UNDEF
= 'U'
255 int kmod_module_get_dependency_symbols(const struct kmod_module
*mod
, struct kmod_list
**list
);
256 const char *kmod_module_dependency_symbol_get_symbol(const struct kmod_list
*entry
);
257 int kmod_module_dependency_symbol_get_bind(const struct kmod_list
*entry
);
258 uint64_t kmod_module_dependency_symbol_get_crc(const struct kmod_list
*entry
);
259 void kmod_module_dependency_symbols_free_list(struct kmod_list
*list
);