[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);
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,
	/* 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);

/* 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,

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

/*
 * 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);
struct kmod_list *kmod_module_get_dependencies(const struct kmod_module *mod);

int kmod_module_get_filtered_blacklist(const struct kmod_ctx *ctx, const struct kmod_list *input, struct kmod_list **output);

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);

const char *kmod_module_get_name(const struct kmod_module *mod);
const char *kmod_module_get_path(const struct kmod_module *mod);

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);

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);

int kmod_module_get_softdeps(const struct kmod_module *mod, struct kmod_list **pre, struct kmod_list **post);

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,
e4351b05 LDM	45	int priority, const char *file, int line,
e4351b05 LDM	46	const char fn, const char format,
1bdd951e GSB	47	va_list args),
1bdd951e GSB	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);
33bb69b9 LDM	53	int kmod_load_resources(struct kmod_ctx *ctx);
33bb69b9 LDM	54	void kmod_unload_resources(struct kmod_ctx *ctx);
586fc304	55
c4dc3ca8 LDM	56	enum kmod_resources {
	57	KMOD_RESOURCES_OK = 0,
	58	KMOD_RESOURCES_MUST_RELOAD = 1,
	59	KMOD_RESOURCES_MUST_RECREATE = 2,
	60	};
	61
	62	int kmod_validate_resources(struct kmod_ctx *ctx);
	63
b08314f7 LDM	64	enum kmod_index {
	65	KMOD_INDEX_MODULES_DEP = 0,
	66	KMOD_INDEX_MODULES_ALIAS,
	67	KMOD_INDEX_MODULES_SYMBOL,
	68	/* Padding to make sure enum is not mapped to char */
	69	_KMOD_INDEX_PAD = (1 << 31),
	70	};
	71
0224482e	72	int kmod_dump_index(struct kmod_ctx *ctx, enum kmod_index type, int fd);
758428a7	73
586fc304 LDM	74	/*
	75	* kmod_list
	76	*
	77	* access to kmod generated lists
	78	*/
6924e47a	79	struct kmod_list;
6a829211 LDM	80	struct kmod_list kmod_list_next(const struct kmod_list list,
	81	const struct kmod_list *curr);
	82	struct kmod_list kmod_list_prev(const struct kmod_list list,
	83	const struct kmod_list *curr);
	84	struct kmod_list kmod_list_last(const struct kmod_list list);
d5ec60bc	85
6924e47a	86	#define kmod_list_foreach(list_entry, first_entry) \
586fc304	87	for (list_entry = first_entry; \
e4351b05	88	list_entry != NULL; \
6924e47a	89	list_entry = kmod_list_next(first_entry, list_entry))
586fc304	90
d6b55b7d GSB	91	#define kmod_list_foreach_reverse(list_entry, first_entry) \
	92	for (list_entry = kmod_list_last(first_entry); \
	93	list_entry != NULL; \
	94	list_entry = kmod_list_prev(first_entry, list_entry))
	95
00178629 LDM	96	/*
	97	* kmod_config_iter
	98	*
	99	* access to configuration lists - it allows to get each configuration's
	100	* key/value stored by kmod
	101	*/
	102	struct kmod_config_iter;
	103	struct kmod_config_iter kmod_config_get_blacklists(const struct kmod_ctx ctx);
	104	struct kmod_config_iter kmod_config_get_install_commands(const struct kmod_ctx ctx);
	105	struct kmod_config_iter kmod_config_get_remove_commands(const struct kmod_ctx ctx);
	106	struct kmod_config_iter kmod_config_get_aliases(const struct kmod_ctx ctx);
	107	struct kmod_config_iter kmod_config_get_options(const struct kmod_ctx ctx);
	108	struct kmod_config_iter kmod_config_get_softdeps(const struct kmod_ctx ctx);
	109	const char kmod_config_iter_get_key(const struct kmod_config_iter iter);
	110	const char kmod_config_iter_get_value(const struct kmod_config_iter iter);
	111	bool kmod_config_iter_next(struct kmod_config_iter *iter);
	112	void kmod_config_iter_free_iter(struct kmod_config_iter *iter);
	113
f39dc70e	114	/* Removal flags */
423f856a	115	enum kmod_remove {
6806a043 LDM	116	KMOD_REMOVE_FORCE = O_TRUNC,
	117	KMOD_REMOVE_NOWAIT = O_NONBLOCK,
	118	};
	119
f39dc70e	120	/* Insertion flags */
8f788d58 LDM	121	enum kmod_insert {
	122	KMOD_INSERT_FORCE_VERMAGIC = 0x1,
	123	KMOD_INSERT_FORCE_MODVERSION = 0x2,
8f788d58 LDM	124	};
8f788d58 LDM	125
ddbda022 LDM	126	/* Flags to kmod_module_probe_insert_module() */
ddbda022 LDM	127	enum kmod_probe {
d851e9a1 LDM	128	KMOD_PROBE_FORCE_VERMAGIC = 0x00001,
	129	KMOD_PROBE_FORCE_MODVERSION = 0x00002,
	130	KMOD_PROBE_IGNORE_COMMAND = 0x00004,
b1a51256 LDM	131
b1a51256 LDM	132	/* codes below can be used in return value, too */
d851e9a1 LDM	133	KMOD_PROBE_APPLY_BLACKLIST_ALL = 0x10000,
	134	KMOD_PROBE_APPLY_BLACKLIST = 0x20000,
	135	KMOD_PROBE_STOP_ON_COMMAND = 0x40000,
	136	KMOD_PROBE_STOP_ON_ALREADY_LOADED = 0x80000,
ddbda022 LDM	137	};
ddbda022 LDM	138
8f788d58 LDM	139	/*
	140	* kmod_module
	141	*
	142	* Operate on kernel modules
	143	*/
	144	struct kmod_module;
	145	int kmod_module_new_from_name(struct kmod_ctx ctx, const char name,
	146	struct kmod_module **mod);
	147	int kmod_module_new_from_path(struct kmod_ctx ctx, const char path,
	148	struct kmod_module **mod);
6a829211	149	int kmod_module_new_from_lookup(struct kmod_ctx ctx, const char given_alias,
7f3eb0cc	150	struct kmod_list **list);
a102e262	151	int kmod_module_new_from_loaded(struct kmod_ctx ctx, struct kmod_list *list);
8f788d58 LDM	152
	153	struct kmod_module kmod_module_ref(struct kmod_module mod);
	154	struct kmod_module kmod_module_unref(struct kmod_module mod);
7f3eb0cc	155	int kmod_module_unref_list(struct kmod_list *list);
ad4d1ae5	156	struct kmod_module kmod_module_get_module(const struct kmod_list entry);
f1cd799f	157	struct kmod_list kmod_module_get_dependencies(const struct kmod_module mod);
8f788d58	158
1487a64f GSB	159	int kmod_module_get_filtered_blacklist(const struct kmod_ctx ctx, const struct kmod_list input, struct kmod_list **output);
1487a64f GSB	160
8f788d58	161	int kmod_module_remove_module(struct kmod_module *mod, unsigned int flags);
3a721bbc	162	int kmod_module_insert_module(struct kmod_module mod, unsigned int flags, const char options);
ddbda022	163	int kmod_module_probe_insert_module(struct kmod_module *mod,
6a829211	164	unsigned int flags, const char *extra_options,
ddbda022 LDM	165	int (run_install)(struct kmod_module m, const char cmdline, void data),
ddbda022 LDM	166	const void *data);
8f788d58	167
1ce08a56 GSB	168	const char kmod_module_get_name(const struct kmod_module mod);
1ce08a56 GSB	169	const char kmod_module_get_path(const struct kmod_module mod);
6e869df7	170
f12ae3c4 GSB	171	enum kmod_module_initstate {
	172	KMOD_MODULE_BUILTIN = 0,
	173	KMOD_MODULE_LIVE,
	174	KMOD_MODULE_COMING,
49b741d0 LDM	175	KMOD_MODULE_GOING,
	176	/* Padding to make sure enum is not mapped to char */
	177	_KMOD_MODULE_PAD = (1 << 31),
f12ae3c4	178	};
6a829211	179	const char *kmod_module_initstate_str(enum kmod_module_initstate state);
f12ae3c4 GSB	180	int kmod_module_get_initstate(const struct kmod_module *mod);
	181	int kmod_module_get_refcnt(const struct kmod_module *mod);
	182	struct kmod_list kmod_module_get_holders(const struct kmod_module mod);
	183
	184	struct kmod_list kmod_module_get_sections(const struct kmod_module mod);
	185	const char kmod_module_section_get_name(const struct kmod_list entry);
	186	unsigned long kmod_module_section_get_address(const struct kmod_list *entry);
	187	void kmod_module_section_free_list(struct kmod_list *list);
	188
69f9dd43	189	long kmod_module_get_size(const struct kmod_module *mod);
f12ae3c4	190
bd3f5535 GSB	191	const char kmod_module_get_options(const struct kmod_module mod);
	192	const char kmod_module_get_install_commands(const struct kmod_module mod);
	193	const char kmod_module_get_remove_commands(const struct kmod_module mod);
	194
1c522600 GSB	195	int kmod_module_get_softdeps(const struct kmod_module mod, struct kmod_list pre, struct kmod_list *post);
1c522600 GSB	196
708624a4 GSB	197	int kmod_module_get_info(const struct kmod_module mod, struct kmod_list *list);
	198	const char kmod_module_info_get_key(const struct kmod_list entry);
	199	const char kmod_module_info_get_value(const struct kmod_list entry);
	200	void kmod_module_info_free_list(struct kmod_list *list);
	201
	202	int kmod_module_get_versions(const struct kmod_module mod, struct kmod_list *list);
	203	const char kmod_module_version_get_symbol(const struct kmod_list entry);
	204	uint64_t kmod_module_version_get_crc(const struct kmod_list *entry);
	205	void kmod_module_versions_free_list(struct kmod_list *list);
	206
45e6db9c GSB	207	int kmod_module_get_symbols(const struct kmod_module mod, struct kmod_list *list);
	208	const char kmod_module_symbol_get_symbol(const struct kmod_list entry);
	209	uint64_t kmod_module_symbol_get_crc(const struct kmod_list *entry);
	210	void kmod_module_symbols_free_list(struct kmod_list *list);
	211
674f8590 GSB	212	enum kmod_symbol_bind {
	213	KMOD_SYMBOL_NONE = '\0',
	214	KMOD_SYMBOL_LOCAL = 'L',
	215	KMOD_SYMBOL_GLOBAL = 'G',
	216	KMOD_SYMBOL_WEAK = 'W',
	217	KMOD_SYMBOL_UNDEF = 'U'
	218	};
	219
	220	int kmod_module_get_dependency_symbols(const struct kmod_module mod, struct kmod_list *list);
	221	const char kmod_module_dependency_symbol_get_symbol(const struct kmod_list entry);
	222	int kmod_module_dependency_symbol_get_bind(const struct kmod_list *entry);
	223	uint64_t kmod_module_dependency_symbol_get_crc(const struct kmod_list *entry);
	224	void kmod_module_dependency_symbols_free_list(struct kmod_list *list);
	225
2bd6299d LDM	226	#ifdef __cplusplus
	227	} /* extern "C" */
	228	#endif
586fc304	229	#endif