improve "const" keyword usage.

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

diff --git a/libkmod/libkmod.h b/libkmod/libkmod.h
index ff8c6a68b8f8094e629f7e73fcd9ff7b5be1a387..d7687bef72d8a4a3839e5a7a272b4243d85de10c 100644 (file)
--- a/libkmod/libkmod.h
+++ b/libkmod/libkmod.h
@@ -2,7 +2,6 @@
  * libkmod - interface to kernel module operations
  *
  * Copyright (C) 2011  ProFUSION embedded systems
- * Copyright (C) 2011  Lucas De Marchi <lucas.de.marchi@gmail.com>
  *
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
@@ -18,10 +17,12 @@
  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  */
 
-#ifndef _LIBABC_H_
-#define _LIBABC_H_
+#ifndef _LIBKMOD_H_
+#define _LIBKMOD_H_
 
+#include <fcntl.h>
 #include <stdarg.h>
+#include <inttypes.h>
 
 #ifdef __cplusplus
 extern "C" {
@@ -34,7 +35,7 @@ extern "C" {
  * environment, user variables, allows custom logging
  */
 struct kmod_ctx;
-struct kmod_ctx *kmod_new(void);
+struct kmod_ctx *kmod_new(const char *dirname);
 struct kmod_ctx *kmod_ref(struct kmod_ctx *ctx);
 struct kmod_ctx *kmod_unref(struct kmod_ctx *ctx);
 void kmod_set_log_fn(struct kmod_ctx *ctx,
@@ -42,25 +43,81 @@ void kmod_set_log_fn(struct kmod_ctx *ctx,
                                int priority, const char *file, int line,
                                const char *fn, const char *format,
                                va_list args));
-int kmod_get_log_priority(struct kmod_ctx *ctx);
+int kmod_get_log_priority(const struct kmod_ctx *ctx);
 void kmod_set_log_priority(struct kmod_ctx *ctx, int priority);
-void *kmod_get_userdata(struct kmod_ctx *ctx);
-void kmod_set_userdata(struct kmod_ctx *ctx, void *userdata);
+void *kmod_get_userdata(const struct kmod_ctx *ctx);
+void kmod_set_userdata(struct kmod_ctx *ctx, const void *userdata);
 
 /*
  * kmod_list
  *
  * access to kmod generated lists
  */
-struct kmod_list_entry;
-struct kmod_list_entry *kmod_list_entry_get_next(struct kmod_list_entry *list_entry);
-#define kmod_list_entry_foreach(list_entry, first_entry) \
+struct kmod_list;
+struct kmod_list *kmod_list_next(const struct kmod_list *first_entry,
+                                               const struct kmod_list *list_entry);
+struct kmod_list *kmod_list_prev(const struct kmod_list *first_entry,
+                                               const struct kmod_list *list_entry);
+#define kmod_list_foreach(list_entry, first_entry) \
        for (list_entry = first_entry; \
                list_entry != NULL; \
-               list_entry = kmod_list_entry_get_next(list_entry))
+               list_entry = kmod_list_next(first_entry, list_entry))
+
+/*
+ * kmod_loaded
+ *
+ * retrieve info from /proc/modules regarding loaded modules
+ */
+struct kmod_loaded;
+int kmod_loaded_new(struct kmod_ctx *ctx, struct kmod_loaded **mod);
+struct kmod_loaded *kmod_loaded_ref(struct kmod_loaded *mod);
+struct kmod_loaded *kmod_loaded_unref(struct kmod_loaded *mod);
+int kmod_loaded_get_list(struct kmod_loaded *mod, struct kmod_list **list);
+int kmod_loaded_get_module_info(const struct kmod_list *entry,
+                               const char **name, long *size, int *use_count,
+                               const char **deps, uintptr_t *addr);
+
+enum kmod_remove {
+       KMOD_REMOVE_FORCE = O_TRUNC,
+       KMOD_REMOVE_NOWAIT = O_NONBLOCK,
+};
+
+int kmod_loaded_remove_module(struct kmod_loaded *kmod,
+                               struct kmod_list *entry, unsigned int flags);
+
+enum kmod_insert {
+       KMOD_INSERT_FORCE_VERMAGIC = 0x1,
+       KMOD_INSERT_FORCE_MODVERSION = 0x2,
+       KMOD_INSERT_HANDLE_DEPENDENCIES = 0x4,
+       KMOD_INSERT_IGNORE_CONFIG = 0x8,
+};
+
+/*
+ * kmod_module
+ *
+ * Operate on kernel modules
+ */
+struct kmod_module;
+int kmod_module_new_from_name(struct kmod_ctx *ctx, const char *name,
+                                               struct kmod_module **mod);
+int kmod_module_new_from_path(struct kmod_ctx *ctx, const char *path,
+                                               struct kmod_module **mod);
+int kmod_module_new_from_lookup(struct kmod_ctx *ctx, const char *alias,
+                                               struct kmod_list **list);
+
+struct kmod_module *kmod_module_ref(struct kmod_module *mod);
+struct kmod_module *kmod_module_unref(struct kmod_module *mod);
+int kmod_module_unref_list(struct kmod_list *list);
+struct kmod_module *kmod_module_get_module(const struct kmod_list *l);
+struct kmod_list *kmod_module_get_dependency(const struct kmod_module *mod);
+
+int kmod_module_remove_module(struct kmod_module *mod, unsigned int flags);
+int kmod_module_insert_module(struct kmod_module *mod, unsigned int flags);
+
+const char *kmod_module_get_name(const struct kmod_module *mod);
+const char *kmod_module_get_path(const struct kmod_module *mod);
 
 #ifdef __cplusplus
 } /* extern "C" */
 #endif
-
 #endif