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);
  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)(struct kmod_ctx *ctx,
  43                                 int priority, const char *file, int line,
  44                                 const char *fn, const char *format,
  45                                 va_list args));
  46 int kmod_get_log_priority(const struct kmod_ctx *ctx);
  47 void kmod_set_log_priority(struct kmod_ctx *ctx, int priority);
  48 void *kmod_get_userdata(const struct kmod_ctx *ctx);
  49 void kmod_set_userdata(struct kmod_ctx *ctx, void *userdata);
  50
  51 /*
  52  * kmod_list
  53  *
  54  * access to kmod generated lists
  55  */
  56 struct kmod_list;
  57 struct kmod_list *kmod_list_next(struct kmod_list *first_entry,
  58                                                 struct kmod_list *list_entry);
  59 #define kmod_list_foreach(list_entry, first_entry) \
  60         for (list_entry = first_entry; \
  61                 list_entry != NULL; \
  62                 list_entry = kmod_list_next(first_entry, list_entry))
  63
  64 /*
  65  * kmod_loaded
  66  *
  67  * retrieve info from /proc/modules regarding loaded modules
  68  */
  69 struct kmod_loaded;
  70 int kmod_loaded_new(struct kmod_ctx *ctx, struct kmod_loaded **mod);
  71 struct kmod_loaded *kmod_loaded_ref(struct kmod_loaded *mod);
  72 struct kmod_loaded *kmod_loaded_unref(struct kmod_loaded *mod);
  73 int kmod_loaded_get_list(struct kmod_loaded *mod, struct kmod_list **list);
  74 int kmod_loaded_get_module_info(const struct kmod_list *entry,
  75                                 const char **name, long *size, int *use_count,
  76                                 const char **deps, uintptr_t *addr);
  77
  78 enum kmod_remove {
  79         KMOD_REMOVE_FORCE = O_TRUNC,
  80         KMOD_REMOVE_NOWAIT = O_NONBLOCK,
  81 };
  82
  83 int kmod_loaded_remove_module(struct kmod_loaded *kmod,
  84                                 struct kmod_list *entry, unsigned int flags);
  85
  86 enum kmod_insert {
  87         KMOD_INSERT_FORCE_VERMAGIC = 0x1,
  88         KMOD_INSERT_FORCE_MODVERSION = 0x2,
  89         KMOD_INSERT_HANDLE_DEPENDENCIES = 0x4,
  90         KMOD_INSERT_IGNORE_CONFIG = 0x8,
  91 };
  92
  93 /*
  94  * kmod_module
  95  *
  96  * Operate on kernel modules
  97  */
  98 struct kmod_module;
  99 int kmod_module_new_from_name(struct kmod_ctx *ctx, const char *name,
 100                                                 struct kmod_module **mod);
 101 int kmod_module_new_from_path(struct kmod_ctx *ctx, const char *path,
 102                                                 struct kmod_module **mod);
 103
 104 struct kmod_module *kmod_module_ref(struct kmod_module *mod);
 105 struct kmod_module *kmod_module_unref(struct kmod_module *mod);
 106
 107 int kmod_module_remove_module(struct kmod_module *mod, unsigned int flags);
 108 int kmod_module_insert_module(struct kmod_module *mod, unsigned int flags);
 109
 110 #ifdef __cplusplus
 111 } /* extern "C" */
 112 #endif
 113 #endif