libkmod/libkmod.h

   1 /*
   2  * libkmod - interface to kernel module operations
   3  *
   4  * Copyright (C) 2011  ProFUSION embedded systems
   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
   8  * License as published by the Free Software Foundation version 2.1.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Lesser General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General Public
  16  * License along with this library; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  18  */
  19
  20 #ifndef _LIBKMOD_H_
  21 #define _LIBKMOD_H_
  22
  23 #include <fcntl.h>
  24 #include <stdarg.h>
  25 #include <inttypes.h>
  26
  27 #ifdef __cplusplus
  28 extern "C" {
  29 #endif
  30
  31 /*
  32  * kmod_ctx
  33  *
  34  * library user context - reads the config and system
  35  * environment, user variables, allows custom logging
  36  */
  37 struct kmod_ctx;
  38 struct kmod_ctx *kmod_new(const char *dirname, const char * const *config_dirs);
  39 struct kmod_ctx *kmod_ref(struct kmod_ctx *ctx);
  40 struct kmod_ctx *kmod_unref(struct kmod_ctx *ctx);
  41 void kmod_set_log_fn(struct kmod_ctx *ctx,
  42                         void (*log_fn)(void *log_data,
  43                                 int priority, const char *file, int line,
  44                                 const char *fn, const char *format,
  45                                 va_list args),
  46                         const void *data);
  47 int kmod_get_log_priority(const struct kmod_ctx *ctx);
  48 void kmod_set_log_priority(struct kmod_ctx *ctx, int priority);
  49 void *kmod_get_userdata(const struct kmod_ctx *ctx);
  50 void kmod_set_userdata(struct kmod_ctx *ctx, const void *userdata);
  51 int kmod_load_resources(struct kmod_ctx *ctx);
  52 void kmod_unload_resources(struct kmod_ctx *ctx);
  53
  54 /*
  55  * kmod_list
  56  *
  57  * access to kmod generated lists
  58  */
  59 struct kmod_list;
  60 struct kmod_list *kmod_list_next(const struct kmod_list *first_entry,
  61                                                 const struct kmod_list *list_entry);
  62 struct kmod_list *kmod_list_prev(const struct kmod_list *first_entry,
  63                                                 const struct kmod_list *list_entry);
  64 #define kmod_list_foreach(list_entry, first_entry) \
  65         for (list_entry = first_entry; \
  66                 list_entry != NULL; \
  67                 list_entry = kmod_list_next(first_entry, list_entry))
  68
  69 int kmod_loaded_get_list(struct kmod_ctx *ctx, struct kmod_list **list);
  70
  71 enum kmod_remove {
  72         KMOD_REMOVE_FORCE = O_TRUNC,
  73         KMOD_REMOVE_NOWAIT = O_NONBLOCK,
  74 };
  75
  76 enum kmod_insert {
  77         KMOD_INSERT_FORCE_VERMAGIC = 0x1,
  78         KMOD_INSERT_FORCE_MODVERSION = 0x2,
  79         KMOD_INSERT_HANDLE_DEPENDENCIES = 0x4,
  80         KMOD_INSERT_IGNORE_CONFIG = 0x8,
  81 };
  82
  83 /*
  84  * kmod_module
  85  *
  86  * Operate on kernel modules
  87  */
  88 struct kmod_module;
  89 int kmod_module_new_from_name(struct kmod_ctx *ctx, const char *name,
  90                                                 struct kmod_module **mod);
  91 int kmod_module_new_from_path(struct kmod_ctx *ctx, const char *path,
  92                                                 struct kmod_module **mod);
  93 int kmod_module_new_from_lookup(struct kmod_ctx *ctx, const char *alias,
  94                                                 struct kmod_list **list);
  95
  96 struct kmod_module *kmod_module_ref(struct kmod_module *mod);
  97 struct kmod_module *kmod_module_unref(struct kmod_module *mod);
  98 int kmod_module_unref_list(struct kmod_list *list);
  99 struct kmod_module *kmod_module_get_module(const struct kmod_list *entry);
 100 struct kmod_list *kmod_module_get_dependencies(const struct kmod_module *mod);
 101
 102 int kmod_module_get_filtered_blacklist(const struct kmod_ctx *ctx, const struct kmod_list *input, struct kmod_list **output);
 103
 104 int kmod_module_remove_module(struct kmod_module *mod, unsigned int flags);
 105 int kmod_module_insert_module(struct kmod_module *mod, unsigned int flags, const char *options);
 106
 107 const char *kmod_module_get_name(const struct kmod_module *mod);
 108 const char *kmod_module_get_path(const struct kmod_module *mod);
 109
 110 enum kmod_module_initstate {
 111         KMOD_MODULE_BUILTIN = 0,
 112         KMOD_MODULE_LIVE,
 113         KMOD_MODULE_COMING,
 114         KMOD_MODULE_GOING,
 115         /* Padding to make sure enum is not mapped to char */
 116         _KMOD_MODULE_PAD = (1 << 31),
 117 };
 118 const char *kmod_module_initstate_str(enum kmod_module_initstate initstate);
 119 int kmod_module_get_initstate(const struct kmod_module *mod);
 120 int kmod_module_get_refcnt(const struct kmod_module *mod);
 121 struct kmod_list *kmod_module_get_holders(const struct kmod_module *mod);
 122
 123 struct kmod_list *kmod_module_get_sections(const struct kmod_module *mod);
 124 const char *kmod_module_section_get_name(const struct kmod_list *entry);
 125 unsigned long kmod_module_section_get_address(const struct kmod_list *entry);
 126 void kmod_module_section_free_list(struct kmod_list *list);
 127
 128 long kmod_module_get_size(const struct kmod_module *mod);
 129
 130 const char *kmod_module_get_options(const struct kmod_module *mod);
 131 const char *kmod_module_get_install_commands(const struct kmod_module *mod);
 132 const char *kmod_module_get_remove_commands(const struct kmod_module *mod);
 133
 134 int kmod_resolve_alias_options(struct kmod_ctx *ctx, const char *alias, char **options);
 135
 136 #ifdef __cplusplus
 137 } /* extern "C" */
 138 #endif
 139 #endif