blob: 85cfc125a0cba46d4adf3cf98ffeaeef701d4056 [file] [log] [blame]
Lucas De Marchi586fc302011-11-21 14:35:35 -02001#ifndef _LIBKMOD_PRIVATE_H_
2#define _LIBKMOD_PRIVATE_H_
3
4#include <stdbool.h>
Lucas De Marchi4462c4a2011-11-29 18:05:43 -02005#include <stdio.h>
Lucas De Marchi586fc302011-11-21 14:35:35 -02006#include <syslog.h>
Gustavo Sverzut Barbierid917f272011-12-10 21:00:19 -02007#include <limits.h>
Lucas De Marchi586fc302011-11-21 14:35:35 -02008
Lucas De Marchi88e9c122011-11-23 12:23:46 -02009#include "macro.h"
Lucas De Marchi586fc302011-11-21 14:35:35 -020010#include "libkmod.h"
11
Lucas De Marchif87081b2011-11-23 12:21:29 -020012static __always_inline __printf_format(2, 3) void
Lucas De Marchi586fc302011-11-21 14:35:35 -020013 kmod_log_null(struct kmod_ctx *ctx, const char *format, ...) {}
14
15#define kmod_log_cond(ctx, prio, arg...) \
16 do { \
17 if (kmod_get_log_priority(ctx) >= prio) \
18 kmod_log(ctx, prio, __FILE__, __LINE__, __FUNCTION__, ## arg);\
19 } while (0)
20
21#ifdef ENABLE_LOGGING
22# ifdef ENABLE_DEBUG
Lucas De Marchiae6df842011-11-25 01:05:30 -020023# define DBG(ctx, arg...) kmod_log_cond(ctx, LOG_DEBUG, ## arg)
Lucas De Marchi586fc302011-11-21 14:35:35 -020024# else
Lucas De Marchiae6df842011-11-25 01:05:30 -020025# define DBG(ctx, arg...) kmod_log_null(ctx, ## arg)
Lucas De Marchi586fc302011-11-21 14:35:35 -020026# endif
Lucas De Marchiae6df842011-11-25 01:05:30 -020027# define INFO(ctx, arg...) kmod_log_cond(ctx, LOG_INFO, ## arg)
28# define ERR(ctx, arg...) kmod_log_cond(ctx, LOG_ERR, ## arg)
Lucas De Marchi586fc302011-11-21 14:35:35 -020029#else
Lucas De Marchiae6df842011-11-25 01:05:30 -020030# define DBG(ctx, arg...) kmod_log_null(ctx, ## arg)
31# define INFO(ctx, arg...) kmod_log_null(ctx, ## arg)
32# define ERR(ctx, arg...) kmod_log_null(ctx, ## arg)
Lucas De Marchi586fc302011-11-21 14:35:35 -020033#endif
34
35#define KMOD_EXPORT __attribute__ ((visibility("default")))
36
Lucas De Marchi1684e442011-12-14 17:19:19 -020037#define KCMD_LINE_SIZE 4096
38
Gustavo Sverzut Barbieri1bdd9512011-12-08 13:47:55 -020039void kmod_log(const struct kmod_ctx *ctx,
Lucas De Marchi586fc302011-11-21 14:35:35 -020040 int priority, const char *file, int line, const char *fn,
Gustavo Sverzut Barbieri12d94192011-12-02 20:34:58 -020041 const char *format, ...) __attribute__((format(printf, 6, 7))) __attribute__((nonnull(1, 3, 5)));
Lucas De Marchi586fc302011-11-21 14:35:35 -020042
Lucas De Marchi6924e472011-11-22 05:38:28 -020043struct list_node {
44 struct list_node *next, *prev;
45};
46
47struct kmod_list {
48 struct list_node node;
49 void *data;
50};
51
Gustavo Sverzut Barbieri12d94192011-12-02 20:34:58 -020052struct kmod_list *kmod_list_append(struct kmod_list *list, const void *data) __must_check __attribute__((nonnull(2)));
53struct kmod_list *kmod_list_prepend(struct kmod_list *list, const void *data) __must_check __attribute__((nonnull(2)));
54struct kmod_list *kmod_list_remove(struct kmod_list *list) __must_check;
Lucas De Marchi6924e472011-11-22 05:38:28 -020055struct kmod_list *kmod_list_remove_data(struct kmod_list *list,
Gustavo Sverzut Barbieri12d94192011-12-02 20:34:58 -020056 const void *data) __must_check __attribute__((nonnull(2)));
Lucas De Marchi62be7992011-12-01 15:27:42 -020057struct kmod_list *kmod_list_remove_n_latest(struct kmod_list *list,
58 unsigned int n) __must_check;
Lucas De Marchi86e87882011-12-05 23:41:14 -020059struct kmod_list *kmod_list_insert_after(struct kmod_list *list, const void *data) __attribute__((nonnull(2)));
Lucas De Marchib91a1c62011-12-05 23:53:56 -020060struct kmod_list *kmod_list_insert_before(struct kmod_list *list, const void *data) __attribute__((nonnull(2)));
Lucas De Marchi19650292011-12-06 00:47:06 -020061struct kmod_list *kmod_list_append_list(struct kmod_list *list1, struct kmod_list *list2) __must_check;
Lucas De Marchi86e87882011-12-05 23:41:14 -020062
Lucas De Marchicf915792011-12-05 11:33:15 -020063#undef kmod_list_foreach
64#define kmod_list_foreach(list_entry, first_entry) \
Lucas De Marchid2d648d2011-12-06 01:44:08 -020065 for (list_entry = ((first_entry) == NULL) ? NULL : (first_entry); \
Lucas De Marchicf915792011-12-05 11:33:15 -020066 list_entry != NULL; \
Lucas De Marchid2d648d2011-12-06 01:44:08 -020067 list_entry = (list_entry->node.next == &((first_entry)->node)) ? NULL : \
Lucas De Marchicf915792011-12-05 11:33:15 -020068 container_of(list_entry->node.next, struct kmod_list, node))
Lucas De Marchi60aa4d82011-11-30 18:57:38 -020069
70/* libkmod.c */
Gustavo Sverzut Barbieri1ce08a52011-12-02 20:24:07 -020071const char *kmod_get_dirname(const struct kmod_ctx *ctx) __attribute__((nonnull(1)));
Lucas De Marchifd186ae2011-12-06 03:38:37 -020072
Gustavo Sverzut Barbieri12d94192011-12-02 20:34:58 -020073int kmod_lookup_alias_from_config(struct kmod_ctx *ctx, const char *name, struct kmod_list **list) __attribute__((nonnull(1, 2, 3)));
74int kmod_lookup_alias_from_symbols_file(struct kmod_ctx *ctx, const char *name, struct kmod_list **list) __attribute__((nonnull(1, 2, 3)));
75int kmod_lookup_alias_from_aliases_file(struct kmod_ctx *ctx, const char *name, struct kmod_list **list) __attribute__((nonnull(1, 2, 3)));
76int kmod_lookup_alias_from_moddep_file(struct kmod_ctx *ctx, const char *name, struct kmod_list **list) __attribute__((nonnull(1, 2, 3)));
Lucas De Marchif4fc5522011-12-16 03:57:12 -020077int kmod_lookup_alias_from_commands(struct kmod_ctx *ctx, const char *name, struct kmod_list **list) __attribute__((nonnull(1, 2, 3)));
Lucas De Marchifd186ae2011-12-06 03:38:37 -020078
Lucas De Marchi671d4892011-12-05 20:23:05 -020079char *kmod_search_moddep(struct kmod_ctx *ctx, const char *name) __attribute__((nonnull(1,2)));
Lucas De Marchi221631d2011-11-24 16:41:01 -020080
Lucas De Marchi8bdeca12011-12-15 13:11:51 -020081struct kmod_module *kmod_pool_get_module(struct kmod_ctx *ctx, const char *key) __attribute__((nonnull(1,2)));
82void kmod_pool_add_module(struct kmod_ctx *ctx, struct kmod_module *mod, const char *key) __attribute__((nonnull(1,2, 3)));
83void kmod_pool_del_module(struct kmod_ctx *ctx, struct kmod_module *mod, const char *key) __attribute__((nonnull(1,2, 3)));
Lucas De Marchifd186ae2011-12-06 03:38:37 -020084
Gustavo Sverzut Barbieribd3f5532011-12-10 20:47:01 -020085const struct kmod_list *kmod_get_options(const struct kmod_ctx *ctx) __must_check __attribute__((nonnull(1)));
86const struct kmod_list *kmod_get_install_commands(const struct kmod_ctx *ctx) __must_check __attribute__((nonnull(1)));
87const struct kmod_list *kmod_get_remove_commands(const struct kmod_ctx *ctx) __must_check __attribute__((nonnull(1)));
Gustavo Sverzut Barbieri1c522602011-12-16 21:18:10 -020088const struct kmod_list *kmod_get_softdeps(const struct kmod_ctx *ctx) __must_check __attribute__((nonnull(1)));
Gustavo Sverzut Barbieribd3f5532011-12-10 20:47:01 -020089
Lucas De Marchifd186ae2011-12-06 03:38:37 -020090
Lucas De Marchi60aa4d82011-11-30 18:57:38 -020091/* libkmod-config.c */
Lucas De Marchi7c2ab352011-11-29 18:07:43 -020092struct kmod_config {
Gustavo Sverzut Barbierid13e6062011-12-02 21:40:22 -020093 struct kmod_ctx *ctx;
Lucas De Marchi7c2ab352011-11-29 18:07:43 -020094 struct kmod_list *aliases;
Lucas De Marchi81cf2062011-11-29 18:48:02 -020095 struct kmod_list *blacklists;
Lucas De Marchi615c42b2011-12-07 03:18:57 -020096 struct kmod_list *options;
Lucas De Marchia5cce6d2011-12-07 11:31:28 -020097 struct kmod_list *remove_commands;
98 struct kmod_list *install_commands;
Gustavo Sverzut Barbieri1c522602011-12-16 21:18:10 -020099 struct kmod_list *softdeps;
Lucas De Marchi7c2ab352011-11-29 18:07:43 -0200100};
Gustavo Sverzut Barbiericb8d4d32011-12-11 20:37:01 -0200101int kmod_config_new(struct kmod_ctx *ctx, struct kmod_config **config, const char * const *config_paths) __attribute__((nonnull(1, 2,3)));
Gustavo Sverzut Barbierid13e6062011-12-02 21:40:22 -0200102void kmod_config_free(struct kmod_config *config) __attribute__((nonnull(1)));
Gustavo Sverzut Barbieri12d94192011-12-02 20:34:58 -0200103const char *kmod_alias_get_name(const struct kmod_list *l) __attribute__((nonnull(1)));
104const char *kmod_alias_get_modname(const struct kmod_list *l) __attribute__((nonnull(1)));
Gustavo Sverzut Barbieribd3f5532011-12-10 20:47:01 -0200105const char *kmod_option_get_options(const struct kmod_list *l) __attribute__((nonnull(1)));
106const char *kmod_option_get_modname(const struct kmod_list *l) __attribute__((nonnull(1)));
107const char *kmod_command_get_command(const struct kmod_list *l) __attribute__((nonnull(1)));
108const char *kmod_command_get_modname(const struct kmod_list *l) __attribute__((nonnull(1)));
109
Gustavo Sverzut Barbieri1c522602011-12-16 21:18:10 -0200110const char *kmod_softdep_get_name(const struct kmod_list *l) __attribute__((nonnull(1)));
111const char * const *kmod_softdep_get_pre(const struct kmod_list *l, unsigned int *count) __attribute__((nonnull(1, 2)));
112const char * const *kmod_softdep_get_post(const struct kmod_list *l, unsigned int *count);
113
Lucas De Marchi7c2ab352011-11-29 18:07:43 -0200114
Lucas De Marchi7636e722011-12-01 17:56:03 -0200115/* libkmod-module.c */
Lucas De Marchi6ad5f262011-12-13 14:12:50 -0200116int kmod_module_new_from_alias(struct kmod_ctx *ctx, const char *alias, const char *name, struct kmod_module **mod);
Gustavo Sverzut Barbierid917f272011-12-10 21:00:19 -0200117char *modname_normalize(const char *modname, char buf[NAME_MAX], size_t *len) __attribute__((nonnull(1, 2)));
Lucas De Marchi671d4892011-12-05 20:23:05 -0200118int kmod_module_parse_depline(struct kmod_module *mod, char *line) __attribute__((nonnull(1, 2)));
Lucas De Marchif4fc5522011-12-16 03:57:12 -0200119void kmod_module_set_install_commands(struct kmod_module *mod, const char *cmd) __attribute__((nonnull(1)));
120void kmod_module_set_remove_commands(struct kmod_module *mod, const char *cmd) __attribute__((nonnull(1)));
Lucas De Marchi7636e722011-12-01 17:56:03 -0200121
Gustavo Sverzut Barbieri7db08652011-12-05 00:17:37 -0200122/* libkmod-hash.c */
123struct kmod_hash;
124struct kmod_hash *kmod_hash_new(unsigned int n_buckets, void (*free_value)(void *value));
125void kmod_hash_free(struct kmod_hash *hash);
126int kmod_hash_add(struct kmod_hash *hash, const char *key, const void *value);
127int kmod_hash_del(struct kmod_hash *hash, const char *key);
128void *kmod_hash_find(const struct kmod_hash *hash, const char *key);
129
Gustavo Sverzut Barbieri3d8226e2011-12-16 16:08:53 -0200130/* libkmod-file.c */
131struct kmod_file *kmod_file_open(const char *filename) __must_check __attribute__((nonnull(1)));
132void *kmod_file_get_contents(const struct kmod_file *file) __must_check __attribute__((nonnull(1)));
133off_t kmod_file_get_size(const struct kmod_file *file) __must_check __attribute__((nonnull(1)));
134void kmod_file_unref(struct kmod_file *file) __attribute__((nonnull(1)));
135
Gustavo Sverzut Barbieri7db08652011-12-05 00:17:37 -0200136
Lucas De Marchi60aa4d82011-11-30 18:57:38 -0200137/* util functions */
Lucas De Marchiad5555b2011-12-03 03:53:10 -0200138char *getline_wrapped(FILE *fp, unsigned int *linenum) __attribute__((nonnull(1)));
Gustavo Sverzut Barbieri12d94192011-12-02 20:34:58 -0200139char *underscores(struct kmod_ctx *ctx, char *s) __attribute__((nonnull(1, 2)));
Lucas De Marchi44a54602011-11-30 14:36:46 -0200140#define streq(a, b) (strcmp((a), (b)) == 0)
Gustavo Sverzut Barbieri12d94192011-12-02 20:34:58 -0200141bool startswith(const char *s, const char *prefix) __attribute__((nonnull(1, 2)));
Gustavo Sverzut Barbieri32c328d2011-12-04 14:18:19 -0200142void *memdup(const void *p, size_t n) __attribute__((nonnull(1)));
Lucas De Marchi4462c4a2011-11-29 18:05:43 -0200143
Gustavo Sverzut Barbierif12ae3c2011-12-04 12:40:00 -0200144ssize_t read_str_safe(int fd, char *buf, size_t buflen) __must_check __attribute__((nonnull(2)));
145int read_str_long(int fd, long *value, int base) __must_check __attribute__((nonnull(2)));
146int read_str_ulong(int fd, unsigned long *value, int base) __must_check __attribute__((nonnull(2)));
Lucas De Marchiafca7802011-12-07 10:59:17 -0200147char *strchr_replace(char *s, int c, char r);
Lucas De Marchi3a468802011-12-07 13:50:52 -0200148bool path_is_absolute(const char *p) __must_check __attribute__((nonnull(1)));
Lucas De Marchi06363cc2011-12-07 13:51:40 -0200149char *path_make_absolute_cwd(const char *p) __must_check __attribute__((nonnull(1)));
Lucas De Marchib148b862011-12-13 10:24:22 -0200150int alias_normalize(const char *alias, char buf[NAME_MAX], size_t *len) __must_check __attribute__((nonnull(1,2)));
Gustavo Sverzut Barbierif12ae3c2011-12-04 12:40:00 -0200151
152
Lucas De Marchi586fc302011-11-21 14:35:35 -0200153#endif