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

#pragma once

#include <stdbool.h>
#include <stdio.h>
#include <syslog.h>
#include <limits.h>

#include "macro.h"
#include "libkmod.h"

static _always_inline_ _printf_format_(2, 3) void
	kmod_log_null(struct kmod_ctx *ctx, const char *format, ...) {}

#define kmod_log_cond(ctx, prio, arg...) \
	do { \
		if (kmod_get_log_priority(ctx) >= prio) \
		kmod_log(ctx, prio, __FILE__, __LINE__, __func__, ## arg);\
	} while (0)

#ifdef ENABLE_LOGGING
#  ifdef ENABLE_DEBUG
#    define DBG(ctx, arg...) kmod_log_cond(ctx, LOG_DEBUG, ## arg)
#  else
#    define DBG(ctx, arg...) kmod_log_null(ctx, ## arg)
#  endif
#  define INFO(ctx, arg...) kmod_log_cond(ctx, LOG_INFO, ## arg)
#  define ERR(ctx, arg...) kmod_log_cond(ctx, LOG_ERR, ## arg)
#else
#  define DBG(ctx, arg...) kmod_log_null(ctx, ## arg)
#  define INFO(ctx, arg...) kmod_log_null(ctx, ## arg)
#  define ERR(ctx, arg...) kmod_log_null(ctx, ## arg)
#endif

#define KMOD_EXPORT __attribute__ ((visibility("default")))

#define KCMD_LINE_SIZE 4096

void kmod_log(const struct kmod_ctx *ctx,
		int priority, const char *file, int line, const char *fn,
		const char *format, ...) __attribute__((format(printf, 6, 7))) __attribute__((nonnull(1, 3, 5)));

struct list_node {
	struct list_node *next, *prev;
};

struct kmod_list {
	struct list_node node;
	void *data;
};

struct kmod_list *kmod_list_append(struct kmod_list *list, const void *data) _must_check_ __attribute__((nonnull(2)));
struct kmod_list *kmod_list_prepend(struct kmod_list *list, const void *data) _must_check_ __attribute__((nonnull(2)));
struct kmod_list *kmod_list_remove(struct kmod_list *list) _must_check_;
struct kmod_list *kmod_list_remove_data(struct kmod_list *list,
					const void *data) _must_check_ __attribute__((nonnull(2)));
struct kmod_list *kmod_list_remove_n_latest(struct kmod_list *list,
						unsigned int n) _must_check_;
struct kmod_list *kmod_list_insert_after(struct kmod_list *list, const void *data) __attribute__((nonnull(2)));
struct kmod_list *kmod_list_insert_before(struct kmod_list *list, const void *data) __attribute__((nonnull(2)));
struct kmod_list *kmod_list_append_list(struct kmod_list *list1, struct kmod_list *list2) _must_check_;

#undef kmod_list_foreach
#define kmod_list_foreach(list_entry, first_entry) \
	for (list_entry = ((first_entry) == NULL) ? NULL : (first_entry); \
		list_entry != NULL; \
		list_entry = (list_entry->node.next == &((first_entry)->node)) ? NULL : \
		container_of(list_entry->node.next, struct kmod_list, node))

#undef kmod_list_foreach_reverse
#define kmod_list_foreach_reverse(list_entry, first_entry) \
	for (list_entry = (((first_entry) == NULL) ? NULL : container_of(first_entry->node.prev, struct kmod_list, node)); \
		list_entry != NULL; \
		list_entry = ((list_entry == first_entry) ? NULL :	\
		container_of(list_entry->node.prev, struct kmod_list, node)))

/* libkmod.c */
const char *kmod_get_dirname(const struct kmod_ctx *ctx) __attribute__((nonnull(1)));

int kmod_lookup_alias_from_config(struct kmod_ctx *ctx, const char *name, struct kmod_list **list) __attribute__((nonnull(1, 2, 3)));
int kmod_lookup_alias_from_symbols_file(struct kmod_ctx *ctx, const char *name, struct kmod_list **list) __attribute__((nonnull(1, 2, 3)));
int kmod_lookup_alias_from_aliases_file(struct kmod_ctx *ctx, const char *name, struct kmod_list **list) __attribute__((nonnull(1, 2, 3)));
int kmod_lookup_alias_from_moddep_file(struct kmod_ctx *ctx, const char *name, struct kmod_list **list) __attribute__((nonnull(1, 2, 3)));
int kmod_lookup_alias_from_builtin_file(struct kmod_ctx *ctx, const char *name, struct kmod_list **list) __attribute__((nonnull(1, 2, 3)));
int kmod_lookup_alias_from_commands(struct kmod_ctx *ctx, const char *name, struct kmod_list **list) __attribute__((nonnull(1, 2, 3)));
void kmod_set_modules_visited(struct kmod_ctx *ctx, bool visited) __attribute__((nonnull((1))));

char *kmod_search_moddep(struct kmod_ctx *ctx, const char *name) __attribute__((nonnull(1,2)));

struct kmod_module *kmod_pool_get_module(struct kmod_ctx *ctx, const char *key) __attribute__((nonnull(1,2)));
void kmod_pool_add_module(struct kmod_ctx *ctx, struct kmod_module *mod, const char *key) __attribute__((nonnull(1,2, 3)));
void kmod_pool_del_module(struct kmod_ctx *ctx, struct kmod_module *mod, const char *key) __attribute__((nonnull(1,2, 3)));

const struct kmod_config *kmod_get_config(const struct kmod_ctx *ctx) __attribute__((nonnull(1)));

/* libkmod-config.c */
struct kmod_config_path {
	unsigned long long stamp;
	char path[];
};

struct kmod_config {
	struct kmod_ctx *ctx;
	struct kmod_list *aliases;
	struct kmod_list *blacklists;
	struct kmod_list *options;
	struct kmod_list *remove_commands;
	struct kmod_list *install_commands;
	struct kmod_list *softdeps;

	struct kmod_list *paths;
};

int kmod_config_new(struct kmod_ctx *ctx, struct kmod_config **config, const char * const *config_paths) __attribute__((nonnull(1, 2,3)));
void kmod_config_free(struct kmod_config *config) __attribute__((nonnull(1)));
const char *kmod_blacklist_get_modname(const struct kmod_list *l) __attribute__((nonnull(1)));
const char *kmod_alias_get_name(const struct kmod_list *l) __attribute__((nonnull(1)));
const char *kmod_alias_get_modname(const struct kmod_list *l) __attribute__((nonnull(1)));
const char *kmod_option_get_options(const struct kmod_list *l) __attribute__((nonnull(1)));
const char *kmod_option_get_modname(const struct kmod_list *l) __attribute__((nonnull(1)));
const char *kmod_command_get_command(const struct kmod_list *l) __attribute__((nonnull(1)));
const char *kmod_command_get_modname(const struct kmod_list *l) __attribute__((nonnull(1)));

const char *kmod_softdep_get_name(const struct kmod_list *l) __attribute__((nonnull(1)));
const char * const *kmod_softdep_get_pre(const struct kmod_list *l, unsigned int *count) __attribute__((nonnull(1, 2)));
const char * const *kmod_softdep_get_post(const struct kmod_list *l, unsigned int *count);


/* libkmod-module.c */
int kmod_module_new_from_alias(struct kmod_ctx *ctx, const char *alias, const char *name, struct kmod_module **mod);
int kmod_module_parse_depline(struct kmod_module *mod, char *line) __attribute__((nonnull(1, 2)));
void kmod_module_set_install_commands(struct kmod_module *mod, const char *cmd) __attribute__((nonnull(1)));
void kmod_module_set_remove_commands(struct kmod_module *mod, const char *cmd) __attribute__((nonnull(1)));
void kmod_module_set_visited(struct kmod_module *mod, bool visited) __attribute__((nonnull(1)));
void kmod_module_set_builtin(struct kmod_module *mod, bool builtin) __attribute__((nonnull((1))));

/* libkmod-hash.c */

#include "libkmod-hash.h"

/* libkmod-file.c */
struct kmod_file *kmod_file_open(const struct kmod_ctx *ctx, const char *filename) _must_check_ __attribute__((nonnull(1,2)));
struct kmod_elf *kmod_file_get_elf(struct kmod_file *file) __attribute__((nonnull(1)));
void *kmod_file_get_contents(const struct kmod_file *file) _must_check_ __attribute__((nonnull(1)));
off_t kmod_file_get_size(const struct kmod_file *file) _must_check_ __attribute__((nonnull(1)));
void kmod_file_unref(struct kmod_file *file) __attribute__((nonnull(1)));

/* libkmod-elf.c */
struct kmod_elf;
struct kmod_modversion {
	uint64_t crc;
	enum kmod_symbol_bind bind;
	char *symbol;
};

struct kmod_elf *kmod_elf_new(const void *memory, off_t size) _must_check_ __attribute__((nonnull(1)));
void kmod_elf_unref(struct kmod_elf *elf) __attribute__((nonnull(1)));
const void *kmod_elf_get_memory(const struct kmod_elf *elf) _must_check_ __attribute__((nonnull(1)));
int kmod_elf_get_strings(const struct kmod_elf *elf, const char *section, char ***array) _must_check_ __attribute__((nonnull(1,2,3)));
int kmod_elf_get_modversions(const struct kmod_elf *elf, struct kmod_modversion **array) _must_check_ __attribute__((nonnull(1,2)));
int kmod_elf_get_symbols(const struct kmod_elf *elf, struct kmod_modversion **array) _must_check_ __attribute__((nonnull(1,2)));
int kmod_elf_get_dependency_symbols(const struct kmod_elf *elf, struct kmod_modversion **array) _must_check_ __attribute__((nonnull(1,2)));
int kmod_elf_strip_section(struct kmod_elf *elf, const char *section) _must_check_ __attribute__((nonnull(1,2)));
int kmod_elf_strip_vermagic(struct kmod_elf *elf) _must_check_ __attribute__((nonnull(1)));

/*
 * Debug mock lib need to find section ".gnu.linkonce.this_module" in order to
 * get modname
 */
int kmod_elf_get_section(const struct kmod_elf *elf, const char *section, const void **buf, uint64_t *buf_size) _must_check_ __attribute__((nonnull(1,2,3,4)));

/* util functions */
#include "libkmod-util.h"
Commit	Line	Data
e8fd8fec	1	#pragma once
586fc304 LDM	2
586fc304 LDM	3	#include <stdbool.h>
4462c4ac	4	#include <stdio.h>
586fc304	5	#include <syslog.h>
d917f274	6	#include <limits.h>
586fc304	7
88e9c12e	8	#include "macro.h"
586fc304 LDM	9	#include "libkmod.h"
586fc304 LDM	10
a70c1e77	11	static _always_inline_ _printf_format_(2, 3) void
586fc304 LDM	12	kmod_log_null(struct kmod_ctx ctx, const char format, ...) {}
	13
	14	#define kmod_log_cond(ctx, prio, arg...) \
	15	do { \
	16	if (kmod_get_log_priority(ctx) >= prio) \
87beacc9	17	kmod_log(ctx, prio, __FILE__, __LINE__, __func__, ## arg);\
586fc304 LDM	18	} while (0)
	19
	20	#ifdef ENABLE_LOGGING
	21	# ifdef ENABLE_DEBUG
ae6df84a	22	# define DBG(ctx, arg...) kmod_log_cond(ctx, LOG_DEBUG, ## arg)
586fc304	23	# else
ae6df84a	24	# define DBG(ctx, arg...) kmod_log_null(ctx, ## arg)
586fc304	25	# endif
ae6df84a LDM	26	# define INFO(ctx, arg...) kmod_log_cond(ctx, LOG_INFO, ## arg)
ae6df84a LDM	27	# define ERR(ctx, arg...) kmod_log_cond(ctx, LOG_ERR, ## arg)
586fc304	28	#else
ae6df84a LDM	29	# define DBG(ctx, arg...) kmod_log_null(ctx, ## arg)
	30	# define INFO(ctx, arg...) kmod_log_null(ctx, ## arg)
	31	# define ERR(ctx, arg...) kmod_log_null(ctx, ## arg)
586fc304 LDM	32	#endif
	33
	34	#define KMOD_EXPORT __attribute__ ((visibility("default")))
	35
1684e440 LDM	36	#define KCMD_LINE_SIZE 4096
1684e440 LDM	37
1bdd951e	38	void kmod_log(const struct kmod_ctx *ctx,
586fc304	39	int priority, const char file, int line, const char fn,
12d9419d	40	const char *format, ...) __attribute__((format(printf, 6, 7))) __attribute__((nonnull(1, 3, 5)));
586fc304	41
6924e47a LDM	42	struct list_node {
	43	struct list_node next, prev;
	44	};
	45
	46	struct kmod_list {
	47	struct list_node node;
	48	void *data;
	49	};
	50
a70c1e77 LDM	51	struct kmod_list kmod_list_append(struct kmod_list list, const void *data) _must_check_ __attribute__((nonnull(2)));
	52	struct kmod_list kmod_list_prepend(struct kmod_list list, const void *data) _must_check_ __attribute__((nonnull(2)));
	53	struct kmod_list kmod_list_remove(struct kmod_list list) _must_check_;
6924e47a	54	struct kmod_list kmod_list_remove_data(struct kmod_list list,
a70c1e77	55	const void *data) _must_check_ __attribute__((nonnull(2)));
62be7995	56	struct kmod_list kmod_list_remove_n_latest(struct kmod_list list,
a70c1e77	57	unsigned int n) _must_check_;
86e87885	58	struct kmod_list kmod_list_insert_after(struct kmod_list list, const void *data) __attribute__((nonnull(2)));
b91a1c6d	59	struct kmod_list kmod_list_insert_before(struct kmod_list list, const void *data) __attribute__((nonnull(2)));
a70c1e77	60	struct kmod_list kmod_list_append_list(struct kmod_list list1, struct kmod_list *list2) _must_check_;
86e87885	61
cf91579b LDM	62	#undef kmod_list_foreach
cf91579b LDM	63	#define kmod_list_foreach(list_entry, first_entry) \
d2d648df	64	for (list_entry = ((first_entry) == NULL) ? NULL : (first_entry); \
cf91579b	65	list_entry != NULL; \
d2d648df	66	list_entry = (list_entry->node.next == &((first_entry)->node)) ? NULL : \
cf91579b	67	container_of(list_entry->node.next, struct kmod_list, node))
60aa4d8b	68
d6b55b7d GSB	69	#undef kmod_list_foreach_reverse
	70	#define kmod_list_foreach_reverse(list_entry, first_entry) \
	71	for (list_entry = (((first_entry) == NULL) ? NULL : container_of(first_entry->node.prev, struct kmod_list, node)); \
	72	list_entry != NULL; \
	73	list_entry = ((list_entry == first_entry) ? NULL : \
	74	container_of(list_entry->node.prev, struct kmod_list, node)))
	75
60aa4d8b	76	/* libkmod.c */
1ce08a56	77	const char kmod_get_dirname(const struct kmod_ctx ctx) __attribute__((nonnull(1)));
fd186ae9	78
12d9419d GSB	79	int kmod_lookup_alias_from_config(struct kmod_ctx ctx, const char name, struct kmod_list **list) __attribute__((nonnull(1, 2, 3)));
	80	int kmod_lookup_alias_from_symbols_file(struct kmod_ctx ctx, const char name, struct kmod_list **list) __attribute__((nonnull(1, 2, 3)));
	81	int kmod_lookup_alias_from_aliases_file(struct kmod_ctx ctx, const char name, struct kmod_list **list) __attribute__((nonnull(1, 2, 3)));
	82	int kmod_lookup_alias_from_moddep_file(struct kmod_ctx ctx, const char name, struct kmod_list **list) __attribute__((nonnull(1, 2, 3)));
3805274b	83	int kmod_lookup_alias_from_builtin_file(struct kmod_ctx ctx, const char name, struct kmod_list **list) __attribute__((nonnull(1, 2, 3)));
f4fc5523	84	int kmod_lookup_alias_from_commands(struct kmod_ctx ctx, const char name, struct kmod_list **list) __attribute__((nonnull(1, 2, 3)));
ece09aac	85	void kmod_set_modules_visited(struct kmod_ctx *ctx, bool visited) __attribute__((nonnull((1))));
fd186ae9	86
671d4894	87	char kmod_search_moddep(struct kmod_ctx ctx, const char *name) __attribute__((nonnull(1,2)));
221631d5	88
8bdeca11 LDM	89	struct kmod_module kmod_pool_get_module(struct kmod_ctx ctx, const char *key) __attribute__((nonnull(1,2)));
	90	void kmod_pool_add_module(struct kmod_ctx ctx, struct kmod_module mod, const char *key) __attribute__((nonnull(1,2, 3)));
	91	void kmod_pool_del_module(struct kmod_ctx ctx, struct kmod_module mod, const char *key) __attribute__((nonnull(1,2, 3)));
fd186ae9	92
e7fc2c86	93	const struct kmod_config kmod_get_config(const struct kmod_ctx ctx) __attribute__((nonnull(1)));
fd186ae9	94
60aa4d8b	95	/* libkmod-config.c */
b6a4dfb1 LDM	96	struct kmod_config_path {
	97	unsigned long long stamp;
	98	char path[];
	99	};
	100
7c2ab358	101	struct kmod_config {
d13e606f	102	struct kmod_ctx *ctx;
7c2ab358	103	struct kmod_list *aliases;
81cf2060	104	struct kmod_list *blacklists;
615c42be	105	struct kmod_list *options;
a5cce6d6 LDM	106	struct kmod_list *remove_commands;
a5cce6d6 LDM	107	struct kmod_list *install_commands;
1c522600	108	struct kmod_list *softdeps;
b6a4dfb1 LDM	109
b6a4dfb1 LDM	110	struct kmod_list *paths;
7c2ab358	111	};
b6a4dfb1	112
cb8d4d3e	113	int kmod_config_new(struct kmod_ctx ctx, struct kmod_config config, const char const *config_paths) __attribute__((nonnull(1, 2,3)));
d13e606f	114	void kmod_config_free(struct kmod_config *config) __attribute__((nonnull(1)));
c1c9c446	115	const char kmod_blacklist_get_modname(const struct kmod_list l) __attribute__((nonnull(1)));
12d9419d GSB	116	const char kmod_alias_get_name(const struct kmod_list l) __attribute__((nonnull(1)));
12d9419d GSB	117	const char kmod_alias_get_modname(const struct kmod_list l) __attribute__((nonnull(1)));
bd3f5535 GSB	118	const char kmod_option_get_options(const struct kmod_list l) __attribute__((nonnull(1)));
	119	const char kmod_option_get_modname(const struct kmod_list l) __attribute__((nonnull(1)));
	120	const char kmod_command_get_command(const struct kmod_list l) __attribute__((nonnull(1)));
	121	const char kmod_command_get_modname(const struct kmod_list l) __attribute__((nonnull(1)));
	122
1c522600 GSB	123	const char kmod_softdep_get_name(const struct kmod_list l) __attribute__((nonnull(1)));
	124	const char * const kmod_softdep_get_pre(const struct kmod_list l, unsigned int *count) __attribute__((nonnull(1, 2)));
	125	const char * const kmod_softdep_get_post(const struct kmod_list l, unsigned int *count);
	126
7c2ab358	127
7636e72b	128	/* libkmod-module.c */
6ad5f263	129	int kmod_module_new_from_alias(struct kmod_ctx ctx, const char alias, const char name, struct kmod_module *mod);
671d4894	130	int kmod_module_parse_depline(struct kmod_module mod, char line) __attribute__((nonnull(1, 2)));
f4fc5523 LDM	131	void kmod_module_set_install_commands(struct kmod_module mod, const char cmd) __attribute__((nonnull(1)));
f4fc5523 LDM	132	void kmod_module_set_remove_commands(struct kmod_module mod, const char cmd) __attribute__((nonnull(1)));
ece09aac	133	void kmod_module_set_visited(struct kmod_module *mod, bool visited) __attribute__((nonnull(1)));
3805274b	134	void kmod_module_set_builtin(struct kmod_module *mod, bool builtin) __attribute__((nonnull((1))));
7636e72b	135
7db08652	136	/* libkmod-hash.c */
529148ea LDM	137
529148ea LDM	138	#include "libkmod-hash.h"
7db08652	139
3d8226ed	140	/* libkmod-file.c */
a70c1e77	141	struct kmod_file kmod_file_open(const struct kmod_ctx ctx, const char *filename) _must_check_ __attribute__((nonnull(1,2)));
1eff942e	142	struct kmod_elf kmod_file_get_elf(struct kmod_file file) __attribute__((nonnull(1)));
a70c1e77 LDM	143	void kmod_file_get_contents(const struct kmod_file file) _must_check_ __attribute__((nonnull(1)));
a70c1e77 LDM	144	off_t kmod_file_get_size(const struct kmod_file *file) _must_check_ __attribute__((nonnull(1)));
3d8226ed GSB	145	void kmod_file_unref(struct kmod_file *file) __attribute__((nonnull(1)));
3d8226ed GSB	146
708624a4 GSB	147	/* libkmod-elf.c */
	148	struct kmod_elf;
	149	struct kmod_modversion {
	150	uint64_t crc;
674f8590	151	enum kmod_symbol_bind bind;
708624a4 GSB	152	char *symbol;
	153	};
	154
a70c1e77	155	struct kmod_elf kmod_elf_new(const void memory, off_t size) _must_check_ __attribute__((nonnull(1)));
708624a4	156	void kmod_elf_unref(struct kmod_elf *elf) __attribute__((nonnull(1)));
a70c1e77 LDM	157	const void kmod_elf_get_memory(const struct kmod_elf elf) _must_check_ __attribute__((nonnull(1)));
	158	int kmod_elf_get_strings(const struct kmod_elf elf, const char section, char ***array) _must_check_ __attribute__((nonnull(1,2,3)));
	159	int kmod_elf_get_modversions(const struct kmod_elf elf, struct kmod_modversion *array) _must_check_ __attribute__((nonnull(1,2)));
	160	int kmod_elf_get_symbols(const struct kmod_elf elf, struct kmod_modversion *array) _must_check_ __attribute__((nonnull(1,2)));
	161	int kmod_elf_get_dependency_symbols(const struct kmod_elf elf, struct kmod_modversion *array) _must_check_ __attribute__((nonnull(1,2)));
	162	int kmod_elf_strip_section(struct kmod_elf elf, const char section) _must_check_ __attribute__((nonnull(1,2)));
	163	int kmod_elf_strip_vermagic(struct kmod_elf *elf) _must_check_ __attribute__((nonnull(1)));
7db08652	164
ea17e2b0 LDM	165	/*
	166	* Debug mock lib need to find section ".gnu.linkonce.this_module" in order to
	167	* get modname
	168	*/
a70c1e77	169	int kmod_elf_get_section(const struct kmod_elf elf, const char section, const void *buf, uint64_t buf_size) _must_check_ __attribute__((nonnull(1,2,3,4)));
ea17e2b0	170
60aa4d8b	171	/* util functions */
a4848e24	172	#include "libkmod-util.h"