sessiond: kernel: make modules required/optional property per-module
[lttng-tools.git] / src / bin / lttng-sessiond / modprobe.c
index ca0467eb37973f169cdebc7966bbb613e83285a9..e1f52afd972b48aab29df0a6ac9a9d33f7b47c19 100644 (file)
@@ -1,19 +1,9 @@
 /*
- * Copyright (C) 2011 David Goulet <dgoulet@efficios.com>
- *               2014 - Jan Glauber <jan.glauber@gmail.com>
+ * Copyright (C) 2011 David Goulet <dgoulet@efficios.com>
+ * Copyright (C) 2014 Jan Glauber <jan.glauber@gmail.com>
  *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License, version 2 only,
- * as published by the Free Software Foundation.
+ * SPDX-License-Identifier: GPL-2.0-only
  *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License along
- * with this program; if not, write to the Free Software Foundation, Inc.,
- * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  */
 
 /**
 
 #include "modprobe.h"
 #include "kern-modules.h"
-
-#define LTTNG_MOD_REQUIRED     1
-#define LTTNG_MOD_OPTIONAL     0
+#include "lttng-sessiond.h"
 
 /* LTTng kernel tracer mandatory core modules list */
 struct kern_modules_param kern_modules_control_core[] = {
-       { "lttng-ring-buffer-client-discard" },
-       { "lttng-ring-buffer-client-overwrite" },
-       { "lttng-ring-buffer-metadata-client" },
-       { "lttng-ring-buffer-client-mmap-discard" },
-       { "lttng-ring-buffer-client-mmap-overwrite" },
-       { "lttng-ring-buffer-metadata-mmap-client" },
+       {
+               .name = (char *) "lttng-ring-buffer-client-discard",
+               .load_policy = KERNEL_MODULE_PROPERTY_LOAD_POLICY_REQUIRED,
+       },
+       {
+               .name = (char *) "lttng-ring-buffer-client-overwrite",
+               .load_policy = KERNEL_MODULE_PROPERTY_LOAD_POLICY_REQUIRED,
+       },
+       {
+               .name = (char *) "lttng-ring-buffer-metadata-client",
+               .load_policy = KERNEL_MODULE_PROPERTY_LOAD_POLICY_REQUIRED,
+       },
+       {
+               .name = (char *) "lttng-ring-buffer-client-mmap-discard",
+               .load_policy = KERNEL_MODULE_PROPERTY_LOAD_POLICY_REQUIRED,
+       },
+       {
+               .name = (char *) "lttng-ring-buffer-client-mmap-overwrite",
+               .load_policy = KERNEL_MODULE_PROPERTY_LOAD_POLICY_REQUIRED,
+       },
+       {
+               .name = (char *) "lttng-ring-buffer-metadata-mmap-client",
+               .load_policy = KERNEL_MODULE_PROPERTY_LOAD_POLICY_REQUIRED,
+       },
 };
 
-/* LTTng kernel tracer probe modules list */
+/* LTTng kerneltracer probe modules list */
 struct kern_modules_param kern_modules_probes_default[] = {
-       { "lttng-probe-asoc" },
-       { "lttng-probe-block" },
-       { "lttng-probe-btrfs" },
-       { "lttng-probe-compaction" },
-       { "lttng-probe-ext3" },
-       { "lttng-probe-ext4" },
-       { "lttng-probe-gpio" },
-       { "lttng-probe-irq" },
-       { "lttng-probe-jbd" },
-       { "lttng-probe-jbd2" },
-       { "lttng-probe-kmem" },
-       { "lttng-probe-kvm" },
-       { "lttng-probe-kvm-x86" },
-       { "lttng-probe-kvm-x86-mmu" },
-       { "lttng-probe-lock" },
-       { "lttng-probe-module" },
-       { "lttng-probe-napi" },
-       { "lttng-probe-net" },
-       { "lttng-probe-power" },
-       { "lttng-probe-printk" },
-       { "lttng-probe-random" },
-       { "lttng-probe-rcu" },
-       { "lttng-probe-regmap" },
-       { "lttng-probe-regulator" },
-       { "lttng-probe-rpm" },
-       { "lttng-probe-sched" },
-       { "lttng-probe-scsi" },
-       { "lttng-probe-signal" },
-       { "lttng-probe-skb" },
-       { "lttng-probe-sock" },
-       { "lttng-probe-statedump" },
-       { "lttng-probe-sunrpc" },
-       { "lttng-probe-timer" },
-       { "lttng-probe-udp" },
-       { "lttng-probe-vmscan" },
-       { "lttng-probe-v4l2" },
-       { "lttng-probe-workqueue" },
-       { "lttng-probe-writeback" },
-       { "lttng-probe-x86-irq-vectors" },
-       { "lttng-probe-x86-exceptions" },
+       {
+               .name = (char *) "lttng-probe-asoc",
+               .load_policy = KERNEL_MODULE_PROPERTY_LOAD_POLICY_OPTIONAL,
+       },
+       {
+               .name = (char *) "lttng-probe-block",
+               .load_policy = KERNEL_MODULE_PROPERTY_LOAD_POLICY_OPTIONAL,
+       },
+       {
+               .name = (char *) "lttng-probe-btrfs",
+               .load_policy = KERNEL_MODULE_PROPERTY_LOAD_POLICY_OPTIONAL,
+       },
+       {
+               .name = (char *) "lttng-probe-compaction",
+               .load_policy = KERNEL_MODULE_PROPERTY_LOAD_POLICY_OPTIONAL,
+       },
+       {
+               .name = (char *) "lttng-probe-ext3",
+               .load_policy = KERNEL_MODULE_PROPERTY_LOAD_POLICY_OPTIONAL,
+       },
+       {
+               .name = (char *) "lttng-probe-ext4",
+               .load_policy = KERNEL_MODULE_PROPERTY_LOAD_POLICY_OPTIONAL,
+       },
+       {
+               .name = (char *) "lttng-probe-gpio",
+               .load_policy = KERNEL_MODULE_PROPERTY_LOAD_POLICY_OPTIONAL,
+       },
+       {
+               .name = (char *) "lttng-probe-i2c",
+               .load_policy = KERNEL_MODULE_PROPERTY_LOAD_POLICY_OPTIONAL,
+       },
+       {
+               .name = (char *) "lttng-probe-irq",
+               .load_policy = KERNEL_MODULE_PROPERTY_LOAD_POLICY_OPTIONAL,
+       },
+       {
+               .name = (char *) "lttng-probe-jbd",
+               .load_policy = KERNEL_MODULE_PROPERTY_LOAD_POLICY_OPTIONAL,
+       },
+       {
+               .name = (char *) "lttng-probe-jbd2",
+               .load_policy = KERNEL_MODULE_PROPERTY_LOAD_POLICY_OPTIONAL,
+       },
+       {
+               .name = (char *) "lttng-probe-kmem",
+               .load_policy = KERNEL_MODULE_PROPERTY_LOAD_POLICY_OPTIONAL,
+       },
+       {
+               .name = (char *) "lttng-probe-kvm",
+               .load_policy = KERNEL_MODULE_PROPERTY_LOAD_POLICY_OPTIONAL,
+       },
+       {
+               .name = (char *) "lttng-probe-kvm-x86",
+               .load_policy = KERNEL_MODULE_PROPERTY_LOAD_POLICY_OPTIONAL,
+       },
+       {
+               .name = (char *) "lttng-probe-kvm-x86-mmu",
+               .load_policy = KERNEL_MODULE_PROPERTY_LOAD_POLICY_OPTIONAL,
+       },
+       {
+               .name = (char *) "lttng-probe-lock",
+               .load_policy = KERNEL_MODULE_PROPERTY_LOAD_POLICY_OPTIONAL,
+       },
+       {
+               .name = (char *) "lttng-probe-module",
+               .load_policy = KERNEL_MODULE_PROPERTY_LOAD_POLICY_OPTIONAL,
+       },
+       {
+               .name = (char *) "lttng-probe-napi",
+               .load_policy = KERNEL_MODULE_PROPERTY_LOAD_POLICY_OPTIONAL,
+       },
+       {
+               .name = (char *) "lttng-probe-net",
+               .load_policy = KERNEL_MODULE_PROPERTY_LOAD_POLICY_OPTIONAL,
+       },
+       {
+               .name = (char *) "lttng-probe-power",
+               .load_policy = KERNEL_MODULE_PROPERTY_LOAD_POLICY_OPTIONAL,
+       },
+       {
+               .name = (char *) "lttng-probe-preemptirq",
+               .load_policy = KERNEL_MODULE_PROPERTY_LOAD_POLICY_OPTIONAL,
+       },
+       {
+               .name = (char *) "lttng-probe-printk",
+               .load_policy = KERNEL_MODULE_PROPERTY_LOAD_POLICY_OPTIONAL,
+       },
+       {
+               .name = (char *) "lttng-probe-random",
+               .load_policy = KERNEL_MODULE_PROPERTY_LOAD_POLICY_OPTIONAL,
+       },
+       {
+               .name = (char *) "lttng-probe-rcu",
+               .load_policy = KERNEL_MODULE_PROPERTY_LOAD_POLICY_OPTIONAL,
+       },
+       {
+               .name = (char *) "lttng-probe-regmap",
+               .load_policy = KERNEL_MODULE_PROPERTY_LOAD_POLICY_OPTIONAL,
+       },
+       {
+               .name = (char *) "lttng-probe-regulator",
+               .load_policy = KERNEL_MODULE_PROPERTY_LOAD_POLICY_OPTIONAL,
+       },
+       {
+               .name = (char *) "lttng-probe-rpm",
+               .load_policy = KERNEL_MODULE_PROPERTY_LOAD_POLICY_OPTIONAL,
+       },
+       {
+               .name = (char *) "lttng-probe-sched",
+               .load_policy = KERNEL_MODULE_PROPERTY_LOAD_POLICY_OPTIONAL,
+       },
+       {
+               .name = (char *) "lttng-probe-scsi",
+               .load_policy = KERNEL_MODULE_PROPERTY_LOAD_POLICY_OPTIONAL,
+       },
+       {
+               .name = (char *) "lttng-probe-signal",
+               .load_policy = KERNEL_MODULE_PROPERTY_LOAD_POLICY_OPTIONAL,
+       },
+       {
+               .name = (char *) "lttng-probe-skb",
+               .load_policy = KERNEL_MODULE_PROPERTY_LOAD_POLICY_OPTIONAL,
+       },
+       {
+               .name = (char *) "lttng-probe-sock",
+               .load_policy = KERNEL_MODULE_PROPERTY_LOAD_POLICY_OPTIONAL,
+       },
+       {
+               .name = (char *) "lttng-probe-statedump",
+               .load_policy = KERNEL_MODULE_PROPERTY_LOAD_POLICY_OPTIONAL,
+       },
+       {
+               .name = (char *) "lttng-probe-sunrpc",
+               .load_policy = KERNEL_MODULE_PROPERTY_LOAD_POLICY_OPTIONAL,
+       },
+       {
+               .name = (char *) "lttng-probe-timer",
+               .load_policy = KERNEL_MODULE_PROPERTY_LOAD_POLICY_OPTIONAL,
+       },
+       {
+               .name = (char *) "lttng-probe-udp",
+               .load_policy = KERNEL_MODULE_PROPERTY_LOAD_POLICY_OPTIONAL,
+       },
+       {
+               .name = (char *) "lttng-probe-vmscan",
+               .load_policy = KERNEL_MODULE_PROPERTY_LOAD_POLICY_OPTIONAL,
+       },
+       {
+               .name = (char *) "lttng-probe-v4l2",
+               .load_policy = KERNEL_MODULE_PROPERTY_LOAD_POLICY_OPTIONAL,
+       },
+       {
+               .name = (char *) "lttng-probe-workqueue",
+               .load_policy = KERNEL_MODULE_PROPERTY_LOAD_POLICY_OPTIONAL,
+       },
+       {
+               .name = (char *) "lttng-probe-writeback",
+               .load_policy = KERNEL_MODULE_PROPERTY_LOAD_POLICY_OPTIONAL,
+       },
+       {
+               .name = (char *) "lttng-probe-x86-irq-vectors",
+               .load_policy = KERNEL_MODULE_PROPERTY_LOAD_POLICY_OPTIONAL,
+       },
+       {
+               .name = (char *) "lttng-probe-x86-exceptions",
+               .load_policy = KERNEL_MODULE_PROPERTY_LOAD_POLICY_OPTIONAL,
+       },
 };
 
 /* dynamic probe modules list */
@@ -152,7 +286,6 @@ error:
  *
  * @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.
@@ -161,7 +294,7 @@ error:
  *                     \c < 0 on error
  */
 static int modprobe_lttng(struct kern_modules_param *modules,
-               int entries, int required)
+               int entries)
 {
        int ret = 0, i;
        struct kmod_ctx *ctx;
@@ -186,7 +319,7 @@ static int modprobe_lttng(struct kern_modules_param *modules,
                        DBG("Module %s is already loaded", modules[i].name);
                        ret = 0;
                } else if (ret < 0) {
-                       if (required) {
+                       if (modules[i].load_policy == KERNEL_MODULE_PROPERTY_LOAD_POLICY_REQUIRED) {
                                ERR("Unable to load required module %s",
                                                modules[i].name);
                                goto error;
@@ -197,6 +330,7 @@ static int modprobe_lttng(struct kern_modules_param *modules,
                        }
                } else {
                        DBG("Modprobe successfully %s", modules[i].name);
+                       modules[i].loaded = true;
                }
 
                kmod_module_unref(mod);
@@ -254,11 +388,10 @@ static int rmmod_recurse(struct kmod_module *mod) {
  *
  * @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 entries)
 {
        int ret = 0, i;
        struct kmod_ctx *ctx;
@@ -271,6 +404,10 @@ static void modprobe_remove_lttng(const struct kern_modules_param *modules,
        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);
@@ -280,7 +417,7 @@ static void modprobe_remove_lttng(const struct kern_modules_param *modules,
                ret = rmmod_recurse(mod);
                if (ret == -EEXIST) {
                        DBG("Module %s is not in kernel.", modules[i].name);
-               } else if (required && ret < 0) {
+               } else if (modules[i].load_policy == KERNEL_MODULE_PROPERTY_LOAD_POLICY_REQUIRED && ret < 0) {
                        ERR("Unable to remove module %s", modules[i].name);
                } else {
                        DBG("Modprobe removal successful %s",
@@ -299,7 +436,7 @@ error:
 #else /* HAVE_KMOD */
 
 static int modprobe_lttng(struct kern_modules_param *modules,
-               int entries, int required)
+               int entries)
 {
        int ret = 0, i;
        char modprobe[256];
@@ -307,7 +444,7 @@ static int modprobe_lttng(struct kern_modules_param *modules,
        for (i = 0; i < entries; i++) {
                ret = snprintf(modprobe, sizeof(modprobe),
                                "/sbin/modprobe %s%s",
-                               required ? "" : "-q ",
+                               modules[i].load_policy == KERNEL_MODULE_PROPERTY_LOAD_POLICY_REQUIRED ? "" : "-q ",
                                modules[i].name);
                if (ret < 0) {
                        PERROR("snprintf modprobe");
@@ -316,7 +453,7 @@ static int modprobe_lttng(struct kern_modules_param *modules,
                modprobe[sizeof(modprobe) - 1] = '\0';
                ret = system(modprobe);
                if (ret == -1) {
-                       if (required) {
+                       if (modules[i].load_policy == KERNEL_MODULE_PROPERTY_LOAD_POLICY_REQUIRED) {
                                ERR("Unable to launch modprobe for required module %s",
                                                modules[i].name);
                                goto error;
@@ -326,7 +463,7 @@ static int modprobe_lttng(struct kern_modules_param *modules,
                                ret = 0;
                        }
                } else if (WEXITSTATUS(ret) != 0) {
-                       if (required) {
+                       if (modules[i].load_policy == KERNEL_MODULE_PROPERTY_LOAD_POLICY_REQUIRED) {
                                ERR("Unable to load required module %s",
                                                modules[i].name);
                                goto error;
@@ -337,6 +474,7 @@ static int modprobe_lttng(struct kern_modules_param *modules,
                        }
                } else {
                        DBG("Modprobe successfully %s", modules[i].name);
+                       modules[i].loaded = true;
                }
        }
 
@@ -345,12 +483,15 @@ error:
 }
 
 static void modprobe_remove_lttng(const struct kern_modules_param *modules,
-               int entries, int required)
+               int entries)
 {
        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);
@@ -363,7 +504,7 @@ static void modprobe_remove_lttng(const struct kern_modules_param *modules,
                if (ret == -1) {
                        ERR("Unable to launch modprobe -r for module %s",
                                        modules[i].name);
-               } else if (required && WEXITSTATUS(ret) != 0) {
+               } else if (modules[i].load_policy == KERNEL_MODULE_PROPERTY_LOAD_POLICY_REQUIRED && WEXITSTATUS(ret) != 0) {
                        ERR("Unable to remove module %s",
                                        modules[i].name);
                } else {
@@ -381,8 +522,7 @@ static void modprobe_remove_lttng(const struct kern_modules_param *modules,
 void modprobe_remove_lttng_control(void)
 {
        modprobe_remove_lttng(kern_modules_control_core,
-                             ARRAY_SIZE(kern_modules_control_core),
-                             LTTNG_MOD_REQUIRED);
+                       ARRAY_SIZE(kern_modules_control_core));
 }
 
 static void free_probes(void)
@@ -408,7 +548,8 @@ void modprobe_remove_lttng_data(void)
        if (!probes) {
                return;
        }
-       modprobe_remove_lttng(probes, nr_probes, LTTNG_MOD_OPTIONAL);
+
+       modprobe_remove_lttng(probes, nr_probes);
        free_probes();
 }
 
@@ -426,12 +567,8 @@ void modprobe_remove_lttng_all(void)
  */
 int modprobe_lttng_control(void)
 {
-       int ret;
-
-       ret = modprobe_lttng(kern_modules_control_core,
-                            ARRAY_SIZE(kern_modules_control_core),
-                            LTTNG_MOD_REQUIRED);
-       return ret;
+       return modprobe_lttng(kern_modules_control_core,
+                       ARRAY_SIZE(kern_modules_control_core));
 }
 
 /**
@@ -465,8 +602,8 @@ static int grow_probes(void)
        }
 
        for (i = 0; i < nr_probes; ++i) {
-               /* Move name pointer. */
-               tmp_probes[i].name = probes[i].name;
+               /* Ownership of 'name' field is transferred. */
+               tmp_probes[i] = probes[i];
        }
 
        /* Replace probes with larger copy. */
@@ -534,6 +671,8 @@ static int append_list_to_probes(const char *list)
                        goto error;
                }
 
+               cur_mod->load_policy = KERNEL_MODULE_PROPERTY_LOAD_POLICY_OPTIONAL;
+
                nr_probes++;
        }
 
@@ -558,12 +697,7 @@ int modprobe_lttng_data(void)
         * 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);
@@ -592,18 +726,14 @@ int modprobe_lttng_data(void)
                        }
 
                        probes[i].name = name;
+                       probes[i].load_policy = kern_modules_probes_default[i].load_policy;
                }
        }
 
        /*
         * 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) {
@@ -614,7 +744,7 @@ int modprobe_lttng_data(void)
        /*
         * Load probes modules now.
         */
-       ret = modprobe_lttng(probes, nr_probes, LTTNG_MOD_OPTIONAL);
+       ret = modprobe_lttng(probes, nr_probes);
        if (ret) {
                goto error;
        }
This page took 0.029393 seconds and 4 git commands to generate.