[thirdparty/kmod.git] / libkmod / libkmod.h

/*
 * libkmod - interface to kernel module operations
 *
 * Copyright (C) 2011-2012  ProFUSION embedded systems
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 */

#ifndef _LIBKMOD_H_
#define _LIBKMOD_H_

#include <fcntl.h>
#include <stdarg.h>
#include <stdbool.h>
#include <inttypes.h>

#ifdef __cplusplus
extern "C" {
#endif

/*
 * kmod_ctx
 *
 * library user context - reads the config and system
 * environment, user variables, allows custom logging
 */
struct kmod_ctx;
struct kmod_ctx *kmod_new(const char *dirname, const char * const *config_paths);
struct kmod_ctx *kmod_ref(struct kmod_ctx *ctx);
struct kmod_ctx *kmod_unref(struct kmod_ctx *ctx);
void kmod_set_log_fn(struct kmod_ctx *ctx,
			void (*log_fn)(void *log_data,
					int priority, const char *file, int line,
					const char *fn, const char *format,
					va_list args),
			const void *data);
int kmod_get_log_priority(const struct kmod_ctx *ctx);
void kmod_set_log_priority(struct kmod_ctx *ctx, int priority);
void *kmod_get_userdata(const struct kmod_ctx *ctx);
void kmod_set_userdata(struct kmod_ctx *ctx, const void *userdata);


/*
 * Management of libkmod's resources
 */
int kmod_load_resources(struct kmod_ctx *ctx);
void kmod_unload_resources(struct kmod_ctx *ctx);

enum kmod_resources {
	KMOD_RESOURCES_OK = 0,
	KMOD_RESOURCES_MUST_RELOAD = 1,
	KMOD_RESOURCES_MUST_RECREATE = 2,
};
int kmod_validate_resources(struct kmod_ctx *ctx);

enum kmod_index {
	KMOD_INDEX_MODULES_DEP = 0,
	KMOD_INDEX_MODULES_ALIAS,
	KMOD_INDEX_MODULES_SYMBOL,
	KMOD_INDEX_MODULES_BUILTIN,
	/* Padding to make sure enum is not mapped to char */
	_KMOD_INDEX_PAD = (1 << 31),
};
int kmod_dump_index(struct kmod_ctx *ctx, enum kmod_index type, int fd);

/*
 * kmod_list
 *
 * access to kmod generated lists
 */
struct kmod_list;
struct kmod_list *kmod_list_next(const struct kmod_list *list,
						const struct kmod_list *curr);
struct kmod_list *kmod_list_prev(const struct kmod_list *list,
						const struct kmod_list *curr);
struct kmod_list *kmod_list_last(const struct kmod_list *list);

#define kmod_list_foreach(list_entry, first_entry) \
	for (list_entry = first_entry; \
		list_entry != NULL; \
		list_entry = kmod_list_next(first_entry, list_entry))

#define kmod_list_foreach_reverse(list_entry, first_entry) \
	for (list_entry = kmod_list_last(first_entry); \
		list_entry != NULL; \
		list_entry = kmod_list_prev(first_entry, list_entry))

/*
 * kmod_config_iter
 *
 * access to configuration lists - it allows to get each configuration's
 * key/value stored by kmod
 */
struct kmod_config_iter;
struct kmod_config_iter *kmod_config_get_blacklists(const struct kmod_ctx *ctx);
struct kmod_config_iter *kmod_config_get_install_commands(const struct kmod_ctx *ctx);
struct kmod_config_iter *kmod_config_get_remove_commands(const struct kmod_ctx *ctx);
struct kmod_config_iter *kmod_config_get_aliases(const struct kmod_ctx *ctx);
struct kmod_config_iter *kmod_config_get_options(const struct kmod_ctx *ctx);
struct kmod_config_iter *kmod_config_get_softdeps(const struct kmod_ctx *ctx);
const char *kmod_config_iter_get_key(const struct kmod_config_iter *iter);
const char *kmod_config_iter_get_value(const struct kmod_config_iter *iter);
bool kmod_config_iter_next(struct kmod_config_iter *iter);
void kmod_config_iter_free_iter(struct kmod_config_iter *iter);

/*
 * kmod_module
 *
 * Operate on kernel modules
 */
struct kmod_module;
int kmod_module_new_from_name(struct kmod_ctx *ctx, const char *name,
						struct kmod_module **mod);
int kmod_module_new_from_path(struct kmod_ctx *ctx, const char *path,
						struct kmod_module **mod);
int kmod_module_new_from_lookup(struct kmod_ctx *ctx, const char *given_alias,
						struct kmod_list **list);
int kmod_module_new_from_loaded(struct kmod_ctx *ctx,
						struct kmod_list **list);

struct kmod_module *kmod_module_ref(struct kmod_module *mod);
struct kmod_module *kmod_module_unref(struct kmod_module *mod);
int kmod_module_unref_list(struct kmod_list *list);
struct kmod_module *kmod_module_get_module(const struct kmod_list *entry);


/* Removal flags */
enum kmod_remove {
	KMOD_REMOVE_FORCE = O_TRUNC,
	KMOD_REMOVE_NOWAIT = O_NONBLOCK,
};

/* Insertion flags */
enum kmod_insert {
	KMOD_INSERT_FORCE_VERMAGIC = 0x1,
	KMOD_INSERT_FORCE_MODVERSION = 0x2,
};

/* Flags to kmod_module_probe_insert_module() */
enum kmod_probe {
	KMOD_PROBE_FORCE_VERMAGIC =		0x00001,
	KMOD_PROBE_FORCE_MODVERSION =		0x00002,
	KMOD_PROBE_IGNORE_COMMAND =		0x00004,
	KMOD_PROBE_IGNORE_LOADED =		0x00008,
	KMOD_PROBE_DRY_RUN =			0x00010,
	KMOD_PROBE_FAIL_ON_LOADED =		0x00020,

	/* codes below can be used in return value, too */
	KMOD_PROBE_APPLY_BLACKLIST_ALL =	0x10000,
	KMOD_PROBE_APPLY_BLACKLIST =		0x20000,
};

int kmod_module_remove_module(struct kmod_module *mod, unsigned int flags);
int kmod_module_insert_module(struct kmod_module *mod, unsigned int flags,
							const char *options);
int kmod_module_probe_insert_module(struct kmod_module *mod,
			unsigned int flags, const char *extra_options,
			int (*run_install)(struct kmod_module *m,
						const char *cmdline, void *data),
			const void *data,
			void (*print_action)(struct kmod_module *m, bool install,
						const char *options));


const char *kmod_module_get_name(const struct kmod_module *mod);
const char *kmod_module_get_path(const struct kmod_module *mod);
const char *kmod_module_get_options(const struct kmod_module *mod);
const char *kmod_module_get_install_commands(const struct kmod_module *mod);
const char *kmod_module_get_remove_commands(const struct kmod_module *mod);
struct kmod_list *kmod_module_get_dependencies(const struct kmod_module *mod);
int kmod_module_get_softdeps(const struct kmod_module *mod,
				struct kmod_list **pre, struct kmod_list **post);
int kmod_module_get_filtered_blacklist(const struct kmod_ctx *ctx,
					const struct kmod_list *input,
					struct kmod_list **output);


/*
 * Information regarding "live information" from module's state, as returned
 * by kernel
 */

enum kmod_module_initstate {
	KMOD_MODULE_BUILTIN = 0,
	KMOD_MODULE_LIVE,
	KMOD_MODULE_COMING,
	KMOD_MODULE_GOING,
	/* Padding to make sure enum is not mapped to char */
	_KMOD_MODULE_PAD = (1 << 31),
};
const char *kmod_module_initstate_str(enum kmod_module_initstate state);
int kmod_module_get_initstate(const struct kmod_module *mod);
int kmod_module_get_refcnt(const struct kmod_module *mod);
struct kmod_list *kmod_module_get_holders(const struct kmod_module *mod);
struct kmod_list *kmod_module_get_sections(const struct kmod_module *mod);
const char *kmod_module_section_get_name(const struct kmod_list *entry);
unsigned long kmod_module_section_get_address(const struct kmod_list *entry);
void kmod_module_section_free_list(struct kmod_list *list);
long kmod_module_get_size(const struct kmod_module *mod);


/*
 * Information retrieved from ELF headers and sections
 */

int kmod_module_get_info(const struct kmod_module *mod, struct kmod_list **list);
const char *kmod_module_info_get_key(const struct kmod_list *entry);
const char *kmod_module_info_get_value(const struct kmod_list *entry);
void kmod_module_info_free_list(struct kmod_list *list);

int kmod_module_get_versions(const struct kmod_module *mod, struct kmod_list **list);
const char *kmod_module_version_get_symbol(const struct kmod_list *entry);
uint64_t kmod_module_version_get_crc(const struct kmod_list *entry);
void kmod_module_versions_free_list(struct kmod_list *list);

int kmod_module_get_symbols(const struct kmod_module *mod, struct kmod_list **list);
const char *kmod_module_symbol_get_symbol(const struct kmod_list *entry);
uint64_t kmod_module_symbol_get_crc(const struct kmod_list *entry);
void kmod_module_symbols_free_list(struct kmod_list *list);

enum kmod_symbol_bind {
	KMOD_SYMBOL_NONE = '\0',
	KMOD_SYMBOL_LOCAL = 'L',
	KMOD_SYMBOL_GLOBAL = 'G',
	KMOD_SYMBOL_WEAK = 'W',
	KMOD_SYMBOL_UNDEF = 'U'
};

int kmod_module_get_dependency_symbols(const struct kmod_module *mod, struct kmod_list **list);
const char *kmod_module_dependency_symbol_get_symbol(const struct kmod_list *entry);
int kmod_module_dependency_symbol_get_bind(const struct kmod_list *entry);
uint64_t kmod_module_dependency_symbol_get_crc(const struct kmod_list *entry);
void kmod_module_dependency_symbols_free_list(struct kmod_list *list);

#ifdef __cplusplus
} /* extern "C" */
#endif
#endif
Commit	Line	Data
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
cb451f35 LDM	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
6ad98307 LDM	21	#ifndef _LIBKMOD_H_
6ad98307 LDM	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);
586fc304 LDM	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);
33bb69b9 LDM	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);
c4dc3ca8 LDM	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 LDM	141	KMOD_REMOVE_FORCE = O_TRUNC,
	142	KMOD_REMOVE_NOWAIT = O_NONBLOCK,
	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	};
8f788d58 LDM	150
ddbda022 LDM	151	/* Flags to kmod_module_probe_insert_module() */
ddbda022 LDM	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
b1a51256 LDM	160	/* codes below can be used in return value, too */
d851e9a1 LDM	161	KMOD_PROBE_APPLY_BLACKLIST_ALL = 0x10000,
d851e9a1 LDM	162	KMOD_PROBE_APPLY_BLACKLIST = 0x20000,
ddbda022 LDM	163	};
ddbda022 LDM	164
8f788d58	165	int kmod_module_remove_module(struct kmod_module *mod, unsigned int flags);
9226ddad LDM	166	int kmod_module_insert_module(struct kmod_module *mod, unsigned int flags,
9226ddad LDM	167	const char *options);
ddbda022	168	int kmod_module_probe_insert_module(struct kmod_module *mod,
6a829211	169	unsigned int flags, const char *extra_options,
9226ddad LDM	170	int (run_install)(struct kmod_module m,
9226ddad LDM	171	const char cmdline, void data),
6bd0713d	172	const void *data,
9226ddad LDM	173	void (print_action)(struct kmod_module m, bool install,
	174	const char *options));
	175
8f788d58	176
1ce08a56 GSB	177	const char kmod_module_get_name(const struct kmod_module mod);
1ce08a56 GSB	178	const char kmod_module_get_path(const struct kmod_module mod);
9226ddad LDM	179	const char kmod_module_get_options(const struct kmod_module mod);
	180	const char kmod_module_get_install_commands(const struct kmod_module mod);
	181	const char kmod_module_get_remove_commands(const struct kmod_module mod);
	182	struct kmod_list kmod_module_get_dependencies(const struct kmod_module mod);
	183	int kmod_module_get_softdeps(const struct kmod_module *mod,
	184	struct kmod_list pre, struct kmod_list post);
	185	int kmod_module_get_filtered_blacklist(const struct kmod_ctx *ctx,
	186	const struct kmod_list *input,
	187	struct kmod_list **output);
	188
	189
	190
	191	/*
	192	* Information regarding "live information" from module's state, as returned
	193	* by kernel
	194	*/
6e869df7	195
f12ae3c4 GSB	196	enum kmod_module_initstate {
	197	KMOD_MODULE_BUILTIN = 0,
	198	KMOD_MODULE_LIVE,
	199	KMOD_MODULE_COMING,
49b741d0 LDM	200	KMOD_MODULE_GOING,
	201	/* Padding to make sure enum is not mapped to char */
	202	_KMOD_MODULE_PAD = (1 << 31),
f12ae3c4	203	};
6a829211	204	const char *kmod_module_initstate_str(enum kmod_module_initstate state);
f12ae3c4 GSB	205	int kmod_module_get_initstate(const struct kmod_module *mod);
	206	int kmod_module_get_refcnt(const struct kmod_module *mod);
	207	struct kmod_list kmod_module_get_holders(const struct kmod_module mod);
f12ae3c4 GSB	208	struct kmod_list kmod_module_get_sections(const struct kmod_module mod);
	209	const char kmod_module_section_get_name(const struct kmod_list entry);
	210	unsigned long kmod_module_section_get_address(const struct kmod_list *entry);
	211	void kmod_module_section_free_list(struct kmod_list *list);
69f9dd43	212	long kmod_module_get_size(const struct kmod_module *mod);
f12ae3c4	213
bd3f5535	214
9226ddad LDM	215
	216	/*
	217	* Information retrieved from ELF headers and sections
	218	*/
1c522600	219
708624a4 GSB	220	int kmod_module_get_info(const struct kmod_module mod, struct kmod_list *list);
	221	const char kmod_module_info_get_key(const struct kmod_list entry);
	222	const char kmod_module_info_get_value(const struct kmod_list entry);
	223	void kmod_module_info_free_list(struct kmod_list *list);
	224
	225	int kmod_module_get_versions(const struct kmod_module mod, struct kmod_list *list);
	226	const char kmod_module_version_get_symbol(const struct kmod_list entry);
	227	uint64_t kmod_module_version_get_crc(const struct kmod_list *entry);
	228	void kmod_module_versions_free_list(struct kmod_list *list);
	229
45e6db9c GSB	230	int kmod_module_get_symbols(const struct kmod_module mod, struct kmod_list *list);
	231	const char kmod_module_symbol_get_symbol(const struct kmod_list entry);
	232	uint64_t kmod_module_symbol_get_crc(const struct kmod_list *entry);
	233	void kmod_module_symbols_free_list(struct kmod_list *list);
	234
674f8590 GSB	235	enum kmod_symbol_bind {
	236	KMOD_SYMBOL_NONE = '\0',
	237	KMOD_SYMBOL_LOCAL = 'L',
	238	KMOD_SYMBOL_GLOBAL = 'G',
	239	KMOD_SYMBOL_WEAK = 'W',
	240	KMOD_SYMBOL_UNDEF = 'U'
	241	};
	242
	243	int kmod_module_get_dependency_symbols(const struct kmod_module mod, struct kmod_list *list);
	244	const char kmod_module_dependency_symbol_get_symbol(const struct kmod_list entry);
	245	int kmod_module_dependency_symbol_get_bind(const struct kmod_list *entry);
	246	uint64_t kmod_module_dependency_symbol_get_crc(const struct kmod_list *entry);
	247	void kmod_module_dependency_symbols_free_list(struct kmod_list *list);
	248
2bd6299d LDM	249	#ifdef __cplusplus
	250	} /* extern "C" */
	251	#endif
586fc304	252	#endif