libkmod/libkmod.h

   1 /*
   2  * libkmod - interface to kernel module operations
   3  *
   4  * Copyright (C) 2011  ProFUSION embedded systems
   5  * Copyright (C) 2011  Lucas De Marchi <lucas.de.marchi@gmail.com>
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Lesser General Public
   9  * License as published by the Free Software Foundation version 2.1.
  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
  21 #ifndef _LIBKMOD_H_
  22 #define _LIBKMOD_H_
  23
  24 #include <fcntl.h>
  25 #include <stdarg.h>
  26 #include <inttypes.h>
  27
  28 #ifdef __cplusplus
  29 extern "C" {
  30 #endif
  31
  32 /*
  33  * kmod_ctx
  34  *
  35  * library user context - reads the config and system
  36  * environment, user variables, allows custom logging
  37  */
  38 struct kmod_ctx;
  39 struct kmod_ctx *kmod_new(const char *dirname);
  40 struct kmod_ctx *kmod_ref(struct kmod_ctx *ctx);
  41 struct kmod_ctx *kmod_unref(struct kmod_ctx *ctx);
  42 void kmod_set_log_fn(struct kmod_ctx *ctx,
  43                         void (*log_fn)(struct kmod_ctx *ctx,
  44                                 int priority, const char *file, int line,
  45                                 const char *fn, const char *format,
  46                                 va_list args));
  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, void *userdata);
  51
  52 /*
  53  * kmod_list
  54  *
  55  * access to kmod generated lists
  56  */
  57 struct kmod_list;
  58 struct kmod_list *kmod_list_next(struct kmod_list *first_entry,
  59                                                 struct kmod_list *list_entry);
  60 #define kmod_list_foreach(list_entry, first_entry) \
  61         for (list_entry = first_entry; \
  62                 list_entry != NULL; \
  63                 list_entry = kmod_list_next(first_entry, list_entry))
  64
  65 /*
  66  * kmod_loaded
  67  *
  68  * retrieve info from /proc/modules regarding loaded modules
  69  */
  70 struct kmod_loaded;
  71 int kmod_loaded_new(struct kmod_ctx *ctx, struct kmod_loaded **mod);
  72 struct kmod_loaded *kmod_loaded_ref(struct kmod_loaded *mod);
  73 struct kmod_loaded *kmod_loaded_unref(struct kmod_loaded *mod);
  74 int kmod_loaded_get_list(struct kmod_loaded *mod, struct kmod_list **list);
  75 int kmod_loaded_get_module_info(const struct kmod_list *entry,
  76                                 const char **name, long *size, int *use_count,
  77                                 const char **deps, uintptr_t *addr);
  78
  79 enum kmod_remove {
  80         KMOD_REMOVE_FORCE = O_TRUNC,
  81         KMOD_REMOVE_NOWAIT = O_NONBLOCK,
  82 };
  83
  84 int kmod_loaded_remove_module(struct kmod_loaded *kmod,
  85                                 struct kmod_list *entry, unsigned int flags);
  86
  87 enum kmod_insert {
  88         KMOD_INSERT_FORCE_VERMAGIC = 0x1,
  89         KMOD_INSERT_FORCE_MODVERSION = 0x2,
  90         KMOD_INSERT_HANDLE_DEPENDENCIES = 0x4,
  91         KMOD_INSERT_IGNORE_CONFIG = 0x8,
  92 };
  93
  94 /*
  95  * kmod_module
  96  *
  97  * Operate on kernel modules
  98  */
  99 struct kmod_module;
 100 int kmod_module_new_from_name(struct kmod_ctx *ctx, const char *name,
 101                                                 struct kmod_module **mod);
 102 int kmod_module_new_from_path(struct kmod_ctx *ctx, const char *path,
 103                                                 struct kmod_module **mod);
 104
 105 struct kmod_module *kmod_module_ref(struct kmod_module *mod);
 106 struct kmod_module *kmod_module_unref(struct kmod_module *mod);
 107
 108 int kmod_module_remove_module(struct kmod_module *mod, unsigned int flags);
 109 int kmod_module_insert_module(struct kmod_module *mod, unsigned int flags);
 110
 111 #ifdef __cplusplus
 112 } /* extern "C" */
 113 #endif
 114 #endif