lib/kunit/executor.c

   1 // SPDX-License-Identifier: GPL-2.0
   2
   3 #include <linux/reboot.h>
   4 #include <kunit/test.h>
   5 #include <kunit/attributes.h>
   6 #include <linux/glob.h>
   7 #include <linux/moduleparam.h>
   8
   9 /*
  10  * These symbols point to the .kunit_test_suites section and are defined in
  11  * include/asm-generic/vmlinux.lds.h, and consequently must be extern.
  12  */
  13 extern struct kunit_suite * const __kunit_suites_start[];
  14 extern struct kunit_suite * const __kunit_suites_end[];
  15
  16 static char *action_param;
  17
  18 module_param_named(action, action_param, charp, 0400);
  19 MODULE_PARM_DESC(action,
  20                  "Changes KUnit executor behavior, valid values are:\n"
  21                  "<none>: run the tests like normal\n"
  22                  "'list' to list test names instead of running them.\n"
  23                  "'list_attr' to list test names and attributes instead of running them.\n");
  24
  25 const char *kunit_action(void)
  26 {
  27         return action_param;
  28 }
  29
  30 static char *filter_glob_param;
  31 static char *filter_param;
  32 static char *filter_action_param;
  33
  34 module_param_named(filter_glob, filter_glob_param, charp, 0400);
  35 MODULE_PARM_DESC(filter_glob,
  36                 "Filter which KUnit test suites/tests run at boot-time, e.g. list* or list*.*del_test");
  37 module_param_named(filter, filter_param, charp, 0400);
  38 MODULE_PARM_DESC(filter,
  39                 "Filter which KUnit test suites/tests run at boot-time using attributes, e.g. speed>slow");
  40 module_param_named(filter_action, filter_action_param, charp, 0400);
  41 MODULE_PARM_DESC(filter_action,
  42                 "Changes behavior of filtered tests using attributes, valid values are:\n"
  43                 "<none>: do not run filtered tests as normal\n"
  44                 "'skip': skip all filtered tests instead so tests will appear in output\n");
  45
  46 const char *kunit_filter_glob(void)
  47 {
  48         return filter_glob_param;
  49 }
  50
  51 char *kunit_filter(void)
  52 {
  53         return filter_param;
  54 }
  55
  56 char *kunit_filter_action(void)
  57 {
  58         return filter_action_param;
  59 }
  60
  61 /* glob_match() needs NULL terminated strings, so we need a copy of filter_glob_param. */
  62 struct kunit_glob_filter {
  63         char *suite_glob;
  64         char *test_glob;
  65 };
  66
  67 /* Split "suite_glob.test_glob" into two. Assumes filter_glob is not empty. */
  68 static void kunit_parse_glob_filter(struct kunit_glob_filter *parsed,
  69                                     const char *filter_glob)
  70 {
  71         const int len = strlen(filter_glob);
  72         const char *period = strchr(filter_glob, '.');
  73
  74         if (!period) {
  75                 parsed->suite_glob = kzalloc(len + 1, GFP_KERNEL);
  76                 parsed->test_glob = NULL;
  77                 strcpy(parsed->suite_glob, filter_glob);
  78                 return;
  79         }
  80
  81         parsed->suite_glob = kzalloc(period - filter_glob + 1, GFP_KERNEL);
  82         parsed->test_glob = kzalloc(len - (period - filter_glob) + 1, GFP_KERNEL);
  83
  84         strncpy(parsed->suite_glob, filter_glob, period - filter_glob);
  85         strncpy(parsed->test_glob, period + 1, len - (period - filter_glob));
  86 }
  87
  88 /* Create a copy of suite with only tests that match test_glob. */
  89 static struct kunit_suite *
  90 kunit_filter_glob_tests(const struct kunit_suite *const suite, const char *test_glob)
  91 {
  92         int n = 0;
  93         struct kunit_case *filtered, *test_case;
  94         struct kunit_suite *copy;
  95
  96         kunit_suite_for_each_test_case(suite, test_case) {
  97                 if (!test_glob || glob_match(test_glob, test_case->name))
  98                         ++n;
  99         }
 100
 101         if (n == 0)
 102                 return NULL;
 103
 104         copy = kmemdup(suite, sizeof(*copy), GFP_KERNEL);
 105         if (!copy)
 106                 return ERR_PTR(-ENOMEM);
 107
 108         filtered = kcalloc(n + 1, sizeof(*filtered), GFP_KERNEL);
 109         if (!filtered) {
 110                 kfree(copy);
 111                 return ERR_PTR(-ENOMEM);
 112         }
 113
 114         n = 0;
 115         kunit_suite_for_each_test_case(suite, test_case) {
 116                 if (!test_glob || glob_match(test_glob, test_case->name))
 117                         filtered[n++] = *test_case;
 118         }
 119
 120         copy->test_cases = filtered;
 121         return copy;
 122 }
 123
 124 void kunit_free_suite_set(struct kunit_suite_set suite_set)
 125 {
 126         struct kunit_suite * const *suites;
 127
 128         for (suites = suite_set.start; suites < suite_set.end; suites++)
 129                 kfree(*suites);
 130         kfree(suite_set.start);
 131 }
 132
 133 struct kunit_suite_set
 134 kunit_filter_suites(const struct kunit_suite_set *suite_set,
 135                     const char *filter_glob,
 136                     char *filters,
 137                     char *filter_action,
 138                     int *err)
 139 {
 140         int i, j, k;
 141         int filter_count = 0;
 142         struct kunit_suite **copy, **copy_start, *filtered_suite, *new_filtered_suite;
 143         struct kunit_suite_set filtered = {NULL, NULL};
 144         struct kunit_glob_filter parsed_glob;
 145         struct kunit_attr_filter *parsed_filters = NULL;
 146
 147         const size_t max = suite_set->end - suite_set->start;
 148
 149         copy = kmalloc_array(max, sizeof(*filtered.start), GFP_KERNEL);
 150         if (!copy) { /* won't be able to run anything, return an empty set */
 151                 return filtered;
 152         }
 153         copy_start = copy;
 154
 155         if (filter_glob)
 156                 kunit_parse_glob_filter(&parsed_glob, filter_glob);
 157
 158         /* Parse attribute filters */
 159         if (filters) {
 160                 filter_count = kunit_get_filter_count(filters);
 161                 parsed_filters = kcalloc(filter_count, sizeof(*parsed_filters), GFP_KERNEL);
 162                 if (!parsed_filters) {
 163                         kfree(copy);
 164                         return filtered;
 165                 }
 166                 for (j = 0; j < filter_count; j++)
 167                         parsed_filters[j] = kunit_next_attr_filter(&filters, err);
 168                 if (*err)
 169                         goto err;
 170         }
 171
 172         for (i = 0; &suite_set->start[i] != suite_set->end; i++) {
 173                 filtered_suite = suite_set->start[i];
 174                 if (filter_glob) {
 175                         if (!glob_match(parsed_glob.suite_glob, filtered_suite->name))
 176                                 continue;
 177                         filtered_suite = kunit_filter_glob_tests(filtered_suite,
 178                                         parsed_glob.test_glob);
 179                         if (IS_ERR(filtered_suite)) {
 180                                 *err = PTR_ERR(filtered_suite);
 181                                 goto err;
 182                         }
 183                 }
 184                 if (filter_count > 0 && parsed_filters != NULL) {
 185                         for (k = 0; k < filter_count; k++) {
 186                                 new_filtered_suite = kunit_filter_attr_tests(filtered_suite,
 187                                                 parsed_filters[k], filter_action, err);
 188
 189                                 /* Free previous copy of suite */
 190                                 if (k > 0 || filter_glob) {
 191                                         kfree(filtered_suite->test_cases);
 192                                         kfree(filtered_suite);
 193                                 }
 194
 195                                 filtered_suite = new_filtered_suite;
 196
 197                                 if (*err)
 198                                         goto err;
 199                                 if (IS_ERR(filtered_suite)) {
 200                                         *err = PTR_ERR(filtered_suite);
 201                                         goto err;
 202                                 }
 203                                 if (!filtered_suite)
 204                                         break;
 205                         }
 206                 }
 207
 208                 if (!filtered_suite)
 209                         continue;
 210
 211                 *copy++ = filtered_suite;
 212         }
 213         filtered.start = copy_start;
 214         filtered.end = copy;
 215
 216 err:
 217         if (*err)
 218                 kfree(copy);
 219
 220         if (filter_glob) {
 221                 kfree(parsed_glob.suite_glob);
 222                 kfree(parsed_glob.test_glob);
 223         }
 224
 225         if (filter_count)
 226                 kfree(parsed_filters);
 227
 228         return filtered;
 229 }
 230
 231 void kunit_exec_run_tests(struct kunit_suite_set *suite_set, bool builtin)
 232 {
 233         size_t num_suites = suite_set->end - suite_set->start;
 234
 235         if (builtin || num_suites) {
 236                 pr_info("KTAP version 1\n");
 237                 pr_info("1..%zu\n", num_suites);
 238         }
 239
 240         __kunit_test_suites_init(suite_set->start, num_suites);
 241 }
 242
 243 void kunit_exec_list_tests(struct kunit_suite_set *suite_set, bool include_attr)
 244 {
 245         struct kunit_suite * const *suites;
 246         struct kunit_case *test_case;
 247
 248         /* Hack: print a ktap header so kunit.py can find the start of KUnit output. */
 249         pr_info("KTAP version 1\n");
 250
 251         for (suites = suite_set->start; suites < suite_set->end; suites++) {
 252                 /* Print suite name and suite attributes */
 253                 pr_info("%s\n", (*suites)->name);
 254                 if (include_attr)
 255                         kunit_print_attr((void *)(*suites), false, 0);
 256
 257                 /* Print test case name and attributes in suite */
 258                 kunit_suite_for_each_test_case((*suites), test_case) {
 259                         pr_info("%s.%s\n", (*suites)->name, test_case->name);
 260                         if (include_attr)
 261                                 kunit_print_attr((void *)test_case, true, 0);
 262                 }
 263         }
 264 }
 265
 266 #if IS_BUILTIN(CONFIG_KUNIT)
 267
 268 static char *kunit_shutdown;
 269 core_param(kunit_shutdown, kunit_shutdown, charp, 0644);
 270
 271 static void kunit_handle_shutdown(void)
 272 {
 273         if (!kunit_shutdown)
 274                 return;
 275
 276         if (!strcmp(kunit_shutdown, "poweroff"))
 277                 kernel_power_off();
 278         else if (!strcmp(kunit_shutdown, "halt"))
 279                 kernel_halt();
 280         else if (!strcmp(kunit_shutdown, "reboot"))
 281                 kernel_restart(NULL);
 282
 283 }
 284
 285 int kunit_run_all_tests(void)
 286 {
 287         struct kunit_suite_set suite_set = {
 288                 __kunit_suites_start, __kunit_suites_end,
 289         };
 290         int err = 0;
 291         if (!kunit_enabled()) {
 292                 pr_info("kunit: disabled\n");
 293                 goto out;
 294         }
 295
 296         if (filter_glob_param || filter_param) {
 297                 suite_set = kunit_filter_suites(&suite_set, filter_glob_param,
 298                                 filter_param, filter_action_param, &err);
 299                 if (err) {
 300                         pr_err("kunit executor: error filtering suites: %d\n", err);
 301                         goto out;
 302                 }
 303         }
 304
 305         if (!action_param)
 306                 kunit_exec_run_tests(&suite_set, true);
 307         else if (strcmp(action_param, "list") == 0)
 308                 kunit_exec_list_tests(&suite_set, false);
 309         else if (strcmp(action_param, "list_attr") == 0)
 310                 kunit_exec_list_tests(&suite_set, true);
 311         else
 312                 pr_err("kunit executor: unknown action '%s'\n", action_param);
 313
 314         if (filter_glob_param || filter_param) { /* a copy was made of each suite */
 315                 kunit_free_suite_set(suite_set);
 316         }
 317
 318 out:
 319         kunit_handle_shutdown();
 320         return err;
 321 }
 322
 323 #if IS_BUILTIN(CONFIG_KUNIT_TEST)
 324 #include "executor_test.c"
 325 #endif
 326
 327 #endif /* IS_BUILTIN(CONFIG_KUNIT) */