* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
-#define _GNU_SOURCE
+/**
+ * @file modprobe.c
+ *
+ * @brief modprobe related functions.
+ *
+ */
+
#define _LGPL_SOURCE
#include <assert.h>
#include <stdio.h>
#include "modprobe.h"
#include "kern-modules.h"
+#include "lttng-sessiond.h"
#define LTTNG_MOD_REQUIRED 1
#define LTTNG_MOD_OPTIONAL 0
/* LTTng kernel tracer mandatory core modules list */
struct kern_modules_param kern_modules_control_core[] = {
- { "lttng-tracer" }, /* MUST be loaded first so keep at top */
- { "lttng-lib-ring-buffer" },
{ "lttng-ring-buffer-client-discard" },
{ "lttng-ring-buffer-client-overwrite" },
{ "lttng-ring-buffer-metadata-client" },
{ "lttng-ring-buffer-metadata-mmap-client" },
};
-/* LTTng kernel tracer optional base modules list */
-struct kern_modules_param kern_modules_control_opt[] = {
- { "lttng-types" },
- { "lttng-ftrace" },
- { "lttng-kprobes" },
- { "lttng-kretprobes" },
-};
-
/* LTTng kernel tracer probe modules list */
struct kern_modules_param kern_modules_probes_default[] = {
{ "lttng-probe-asoc" },
{ "lttng-probe-ext3" },
{ "lttng-probe-ext4" },
{ "lttng-probe-gpio" },
+ { "lttng-probe-i2c" },
{ "lttng-probe-irq" },
{ "lttng-probe-jbd" },
{ "lttng-probe-jbd2" },
{ "lttng-probe-v4l2" },
{ "lttng-probe-workqueue" },
{ "lttng-probe-writeback" },
+ { "lttng-probe-x86-irq-vectors" },
+ { "lttng-probe-x86-exceptions" },
};
/* dynamic probe modules list */
static int nr_probes;
static int probes_capacity;
-static void modprobe_remove_lttng(const struct kern_modules_param *modules,
- int entries, int required)
-{
- int ret = 0, i;
- char modprobe[256];
-
- for (i = entries - 1; i >= 0; i--) {
- ret = snprintf(modprobe, sizeof(modprobe),
- "/sbin/modprobe -r -q %s",
- modules[i].name);
- if (ret < 0) {
- PERROR("snprintf modprobe -r");
- return;
- }
- modprobe[sizeof(modprobe) - 1] = '\0';
- ret = system(modprobe);
- if (ret == -1) {
- ERR("Unable to launch modprobe -r for module %s",
- modules[i].name);
- } else if (required && WEXITSTATUS(ret) != 0) {
- ERR("Unable to remove module %s",
- modules[i].name);
- } else {
- DBG("Modprobe removal successful %s",
- modules[i].name);
- }
- }
-}
+#if HAVE_KMOD
+#include <libkmod.h>
-/*
- * Remove control kernel module(s) in reverse load order.
+/**
+ * @brief Logging function for libkmod integration.
*/
-void modprobe_remove_lttng_control(void)
-{
- modprobe_remove_lttng(kern_modules_control_opt,
- ARRAY_SIZE(kern_modules_control_opt),
- LTTNG_MOD_OPTIONAL);
- modprobe_remove_lttng(kern_modules_control_core,
- ARRAY_SIZE(kern_modules_control_core),
- LTTNG_MOD_REQUIRED);
-}
-
-static void free_probes(void)
+static void log_kmod(void *data, int priority, const char *file, int line,
+ const char *fn, const char *format, va_list args)
{
- int i;
+ char *str;
- if (!probes) {
+ if (vasprintf(&str, format, args) < 0) {
return;
}
- for (i = 0; i < nr_probes; ++i) {
- free(probes[i].name);
- }
- free(probes);
- probes = NULL;
- nr_probes = 0;
-}
-/*
- * Remove data kernel modules in reverse load order.
- */
-void modprobe_remove_lttng_data(void)
-{
- if (!probes) {
- return;
- }
- modprobe_remove_lttng(probes, nr_probes, LTTNG_MOD_OPTIONAL);
- free_probes();
+ DBG("libkmod: %s", str);
+ free(str);
}
-/*
- * Remove all kernel modules in reverse order.
+/**
+ * @brief Setup the libkmod context.
+ *
+ * Create the context, add a custom logging function and preload the
+ * ressources for faster operation.
+ *
+ * @returns \c 0 on success
+ * \c < 0 on error
*/
-void modprobe_remove_lttng_all(void)
+static int setup_kmod_ctx(struct kmod_ctx **ctx)
{
- modprobe_remove_lttng_data();
- modprobe_remove_lttng_control();
-}
+ int ret = 0;
-#if HAVE_KMOD
-#include <libkmod.h>
-static void log_kmod(void *data, int priority, const char *file, int line,
- const char *fn, const char *format, va_list args)
-{
- char *str;
+ *ctx = kmod_new(NULL, NULL);
+ if (!ctx) {
+ PERROR("Unable to create kmod library context");
+ ret = -ENOMEM;
+ goto error;
+ }
- if (vasprintf(&str, format, args) < 0) {
- return;
+ kmod_set_log_fn(*ctx, log_kmod, NULL);
+ ret = kmod_load_resources(*ctx);
+ if (ret < 0) {
+ ERR("Failed to load kmod library resources");
+ goto error;
}
- DBG("libkmod: %s", str);
- free(str);
+error:
+ return ret;
}
+
+/**
+ * @brief Loads the kernel modules in \p modules
+ *
+ * @param modules List of modules to load
+ * @param entries Number of modules in the list
+ * @param required Are the modules required or optionnal
+ *
+ * If the modules are required, we will return with error after the
+ * first failed module load, otherwise we continue loading.
+ *
+ * @returns \c 0 on success
+ * \c < 0 on error
+ */
static int modprobe_lttng(struct kern_modules_param *modules,
int entries, int required)
{
int ret = 0, i;
struct kmod_ctx *ctx;
- ctx = kmod_new(NULL, NULL);
- if (!ctx) {
- PERROR("Unable to create kmod library context");
- ret = -ENOMEM;
+ ret = setup_kmod_ctx(&ctx);
+ if (ret < 0) {
goto error;
}
- kmod_set_log_fn(ctx, log_kmod, NULL);
- kmod_load_resources(ctx);
-
for (i = 0; i < entries; i++) {
struct kmod_module *mod = NULL;
goto error;
}
- ret = kmod_module_probe_insert_module(mod, KMOD_PROBE_IGNORE_LOADED,
+ ret = kmod_module_probe_insert_module(mod, 0,
NULL, NULL, NULL, NULL);
- if (ret < 0) {
+ if (ret == -EEXIST) {
+ DBG("Module %s is already loaded", modules[i].name);
+ ret = 0;
+ } else if (ret < 0) {
if (required) {
ERR("Unable to load required module %s",
modules[i].name);
}
} else {
DBG("Modprobe successfully %s", modules[i].name);
+ modules[i].loaded = true;
}
kmod_module_unref(mod);
return ret;
}
+/**
+ * @brief Recursively unload modules.
+ *
+ * This function implements the same modules unloading behavior as
+ * 'modprobe -r' or rmmod, it will recursevily go trought the \p module
+ * dependencies and unload modules with a refcount of 0.
+ *
+ * @param mod The module to unload
+ *
+ * @returns \c 0 on success
+ * \c < 0 on error
+ */
+static int rmmod_recurse(struct kmod_module *mod) {
+ int ret = 0;
+ struct kmod_list *deps, *itr;
+
+ if (kmod_module_get_initstate(mod) == KMOD_MODULE_BUILTIN) {
+ DBG("Module %s is builtin", kmod_module_get_name(mod));
+ return ret;
+ }
+
+ ret = kmod_module_remove_module(mod, 0);
+
+ deps = kmod_module_get_dependencies(mod);
+ if (deps != NULL) {
+ kmod_list_foreach(itr, deps) {
+ struct kmod_module *dep = kmod_module_get_module(itr);
+ if (kmod_module_get_refcnt(dep) == 0) {
+ DBG("Recursive remove module %s",
+ kmod_module_get_name(dep));
+ rmmod_recurse(dep);
+ }
+ kmod_module_unref(dep);
+ }
+ kmod_module_unref_list(deps);
+ }
+
+ return ret;
+}
+
+/**
+ * @brief Unloads the kernel modules in \p modules
+ *
+ * @param modules List of modules to unload
+ * @param entries Number of modules in the list
+ * @param required Are the modules required or optionnal
+ *
+ */
+static void modprobe_remove_lttng(const struct kern_modules_param *modules,
+ int entries, int required)
+{
+ int ret = 0, i;
+ struct kmod_ctx *ctx;
+
+ ret = setup_kmod_ctx(&ctx);
+ if (ret < 0) {
+ goto error;
+ }
+
+ for (i = entries - 1; i >= 0; i--) {
+ struct kmod_module *mod = NULL;
+
+ if (!modules[i].loaded) {
+ continue;
+ }
+
+ ret = kmod_module_new_from_name(ctx, modules[i].name, &mod);
+ if (ret < 0) {
+ PERROR("Failed to create kmod module for %s", modules[i].name);
+ goto error;
+ }
+
+ ret = rmmod_recurse(mod);
+ if (ret == -EEXIST) {
+ DBG("Module %s is not in kernel.", modules[i].name);
+ } else if (required && ret < 0) {
+ ERR("Unable to remove module %s", modules[i].name);
+ } else {
+ DBG("Modprobe removal successful %s",
+ modules[i].name);
+ }
+
+ kmod_module_unref(mod);
+ }
+
+error:
+ if (ctx) {
+ kmod_unref(ctx);
+ }
+}
+
#else /* HAVE_KMOD */
static int modprobe_lttng(struct kern_modules_param *modules,
}
} else {
DBG("Modprobe successfully %s", modules[i].name);
+ modules[i].loaded = true;
}
}
return ret;
}
+static void modprobe_remove_lttng(const struct kern_modules_param *modules,
+ int entries, int required)
+{
+ int ret = 0, i;
+ char modprobe[256];
+
+ for (i = entries - 1; i >= 0; i--) {
+ if (!modules[i].loaded) {
+ continue;
+ }
+ ret = snprintf(modprobe, sizeof(modprobe),
+ "/sbin/modprobe -r -q %s",
+ modules[i].name);
+ if (ret < 0) {
+ PERROR("snprintf modprobe -r");
+ return;
+ }
+ modprobe[sizeof(modprobe) - 1] = '\0';
+ ret = system(modprobe);
+ if (ret == -1) {
+ ERR("Unable to launch modprobe -r for module %s",
+ modules[i].name);
+ } else if (required && WEXITSTATUS(ret) != 0) {
+ ERR("Unable to remove module %s",
+ modules[i].name);
+ } else {
+ DBG("Modprobe removal successful %s",
+ modules[i].name);
+ }
+ }
+}
+
#endif /* HAVE_KMOD */
+/*
+ * Remove control kernel module(s) in reverse load order.
+ */
+void modprobe_remove_lttng_control(void)
+{
+ modprobe_remove_lttng(kern_modules_control_core,
+ ARRAY_SIZE(kern_modules_control_core),
+ LTTNG_MOD_REQUIRED);
+}
+
+static void free_probes(void)
+{
+ int i;
+
+ if (!probes) {
+ return;
+ }
+ for (i = 0; i < nr_probes; ++i) {
+ free(probes[i].name);
+ }
+ free(probes);
+ probes = NULL;
+ nr_probes = 0;
+}
+
+/*
+ * Remove data kernel modules in reverse load order.
+ */
+void modprobe_remove_lttng_data(void)
+{
+ if (!probes) {
+ return;
+ }
+ modprobe_remove_lttng(probes, nr_probes, LTTNG_MOD_OPTIONAL);
+ free_probes();
+}
+
+/*
+ * Remove all kernel modules in reverse order.
+ */
+void modprobe_remove_lttng_all(void)
+{
+ modprobe_remove_lttng_data();
+ modprobe_remove_lttng_control();
+}
+
/*
* Load control kernel module(s).
*/
ret = modprobe_lttng(kern_modules_control_core,
ARRAY_SIZE(kern_modules_control_core),
LTTNG_MOD_REQUIRED);
- if (ret != 0)
- return ret;
- ret = modprobe_lttng(kern_modules_control_opt,
- ARRAY_SIZE(kern_modules_control_opt),
- LTTNG_MOD_OPTIONAL);
return ret;
}
* Base probes: either from command line option, environment
* variable or default list.
*/
- if (kmod_probes_list) {
- list = kmod_probes_list;
- } else {
- list = utils_get_kmod_probes_list();
- }
-
+ list = config.kmod_probes_list.value;
if (list) {
/* User-specified probes. */
ret = append_list_to_probes(list);
/*
* Extra modules? Append them to current probes list.
*/
- if (kmod_extra_probes_list) {
- list = kmod_extra_probes_list;
- } else {
- list = utils_get_extra_kmod_probes_list();
- }
-
+ list = config.kmod_extra_probes_list.value;
if (list) {
ret = append_list_to_probes(list);
if (ret) {
projects / lttng-tools.git / blobdiff