1 /*- 2 * Copyright (c) 2015 3 * Netflix Incorporated, All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 14 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 17 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24 * SUCH DAMAGE. 25 * 26 */ 27 #include <sys/cdefs.h> 28 __FBSDID("$FreeBSD$"); 29 30 #include <sys/types.h> 31 #include <sys/cdefs.h> 32 #include <sys/param.h> 33 #include <sys/systm.h> 34 #include <sys/bus.h> 35 #include <sys/callout.h> 36 #include <sys/module.h> 37 #include <sys/kernel.h> 38 #include <sys/ktr.h> 39 #include <sys/lock.h> 40 #include <sys/malloc.h> 41 #include <sys/mutex.h> 42 #include <sys/sdt.h> 43 #include <sys/sysctl.h> 44 #include <sys/taskqueue.h> 45 #include <sys/smp.h> 46 #include <sys/queue.h> 47 #include <tests/kern_testfrwk.h> 48 #ifdef SMP 49 #include <machine/cpu.h> 50 #endif 51 52 struct kern_test_list { 53 TAILQ_ENTRY(kern_test_list) next; 54 char name[TEST_NAME_LEN]; 55 kerntfunc func; 56 }; 57 58 TAILQ_HEAD(ktestlist, kern_test_list); 59 60 struct kern_test_entry { 61 TAILQ_ENTRY(kern_test_entry) next; 62 struct kern_test_list *kt_e; 63 struct kern_test kt_data; 64 }; 65 TAILQ_HEAD(ktestqueue, kern_test_entry); 66 67 MALLOC_DEFINE(M_KTFRWK, "kern_tfrwk", "Kernel Test Framework"); 68 struct kern_totfrwk { 69 struct taskqueue *kfrwk_tq; 70 struct task kfrwk_que; 71 struct ktestlist kfrwk_testlist; 72 struct ktestqueue kfrwk_testq; 73 struct mtx kfrwk_mtx; 74 int kfrwk_waiting; 75 }; 76 77 struct kern_totfrwk kfrwk; 78 static int ktest_frwk_inited=0; 79 80 #define KTFRWK_MUTEX_INIT() mtx_init(&kfrwk.kfrwk_mtx, "kern_test_frwk", "tfrwk", MTX_DEF) 81 82 #define KTFRWK_DESTROY() mtx_destroy(&kfrwk.kfrwk_mtx) 83 84 #define KTFRWK_LOCK() mtx_lock(&kfrwk.kfrwk_mtx) 85 86 #define KTFRWK_UNLOCK() mtx_unlock(&kfrwk.kfrwk_mtx) 87 88 static void 89 kfrwk_task(void *context, int pending) 90 { 91 struct kern_totfrwk *tf; 92 struct kern_test_entry *wk; 93 int free_mem=0; 94 struct kern_test kt_data; 95 kerntfunc ktf; 96 97 memset(&kt_data, 0, sizeof(kt_data)); 98 ktf = NULL; 99 tf = (struct kern_totfrwk *)context; 100 KTFRWK_LOCK(); 101 wk = TAILQ_FIRST(&tf->kfrwk_testq); 102 if (wk) { 103 wk->kt_data.tot_threads_running--; 104 tf->kfrwk_waiting--; 105 memcpy(&kt_data, &wk->kt_data, sizeof(kt_data)); 106 if (wk->kt_data.tot_threads_running == 0) { 107 TAILQ_REMOVE(&tf->kfrwk_testq, wk, next); 108 free_mem = 1; 109 } else { 110 /* Wake one of my colleages up to help too */ 111 taskqueue_enqueue(tf->kfrwk_tq, &tf->kfrwk_que); 112 } 113 if (wk->kt_e) { 114 ktf = wk->kt_e->func; 115 } 116 } 117 KTFRWK_UNLOCK(); 118 if (wk && free_mem) { 119 free(wk, M_KTFRWK); 120 } 121 /* Execute the test */ 122 if (ktf){ 123 (*ktf)(&kt_data); 124 } 125 /* We are done */ 126 atomic_add_int(&tf->kfrwk_waiting, 1); 127 } 128 129 static int 130 kerntest_frwk_init(void) 131 { 132 u_int ncpus = mp_ncpus ? mp_ncpus : MAXCPU; 133 134 KTFRWK_MUTEX_INIT(); 135 TAILQ_INIT(&kfrwk.kfrwk_testq); 136 TAILQ_INIT(&kfrwk.kfrwk_testlist); 137 /* Now lets start up a number of tasks to do the work */ 138 TASK_INIT(&kfrwk.kfrwk_que, 0, kfrwk_task, &kfrwk); 139 kfrwk.kfrwk_tq = taskqueue_create_fast("sbtls_task", M_NOWAIT, 140 taskqueue_thread_enqueue, &kfrwk.kfrwk_tq); 141 if (kfrwk.kfrwk_tq == NULL) { 142 printf("Can't start taskqueue for Kernel Test Framework\n"); 143 panic("Taskqueue init fails for kfrwk"); 144 } 145 taskqueue_start_threads(&kfrwk.kfrwk_tq, ncpus, PI_NET, "[kt_frwk task]"); 146 kfrwk.kfrwk_waiting = ncpus; 147 ktest_frwk_inited = 1; 148 return(0); 149 } 150 151 static int 152 kerntest_frwk_fini(void) 153 { 154 KTFRWK_LOCK(); 155 if (!TAILQ_EMPTY(&kfrwk.kfrwk_testlist)) { 156 /* Still modules registered */ 157 KTFRWK_UNLOCK(); 158 return (EBUSY); 159 } 160 ktest_frwk_inited = 0; 161 KTFRWK_UNLOCK(); 162 taskqueue_free(kfrwk.kfrwk_tq); 163 /* Ok lets destroy the mutex on the way outs */ 164 KTFRWK_DESTROY(); 165 return (0); 166 } 167 168 169 static int kerntest_execute(SYSCTL_HANDLER_ARGS); 170 171 SYSCTL_NODE(_kern, OID_AUTO, testfrwk, CTLFLAG_RW, 0, "Kernel Test Framework"); 172 SYSCTL_PROC(_kern_testfrwk, OID_AUTO, runtest, (CTLTYPE_STRUCT | CTLFLAG_RW), 173 0, 0, kerntest_execute, "IU", "Execute a kernel test"); 174 175 int 176 kerntest_execute(SYSCTL_HANDLER_ARGS) 177 { 178 struct kern_test kt; 179 struct kern_test_list *li, *te=NULL; 180 struct kern_test_entry *kte=NULL; 181 int error = 0; 182 183 if (ktest_frwk_inited == 0) { 184 return(ENOENT); 185 } 186 /* Find the entry if possible */ 187 error = SYSCTL_IN(req, &kt, sizeof(struct kern_test)); 188 if (error) { 189 return(error); 190 } 191 if (kt.num_threads <= 0) { 192 return (EINVAL); 193 } 194 /* Grab some memory */ 195 kte = malloc(sizeof(struct kern_test_entry), M_KTFRWK, M_WAITOK); 196 if (kte == NULL) { 197 error = ENOMEM; 198 goto out; 199 } 200 KTFRWK_LOCK(); 201 TAILQ_FOREACH(li, &kfrwk.kfrwk_testlist, next) { 202 if (strcmp(li->name, kt.name) == 0) { 203 te = li; 204 break; 205 } 206 } 207 if (te == NULL) { 208 printf("Can't find the test %s\n", kt.name); 209 error = ENOENT; 210 free(kte, M_KTFRWK); 211 goto out; 212 } 213 /* Ok we have a test item to run, can we? */ 214 if (!TAILQ_EMPTY(&kfrwk.kfrwk_testq)) { 215 /* We don't know if there is enough threads */ 216 error = EAGAIN; 217 free(kte, M_KTFRWK); 218 goto out; 219 } 220 if (kfrwk.kfrwk_waiting < kt.num_threads) { 221 error = E2BIG; 222 free(kte, M_KTFRWK); 223 goto out; 224 } 225 kt.tot_threads_running = kt.num_threads; 226 /* Ok it looks like we can do it, lets get an entry */ 227 kte->kt_e = li; 228 memcpy(&kte->kt_data, &kt, sizeof(kt)); 229 TAILQ_INSERT_TAIL(&kfrwk.kfrwk_testq, kte, next); 230 taskqueue_enqueue(kfrwk.kfrwk_tq, &kfrwk.kfrwk_que); 231 out: 232 KTFRWK_UNLOCK(); 233 return(error); 234 } 235 236 int 237 kern_testframework_register(const char *name, kerntfunc func) 238 { 239 int error = 0; 240 struct kern_test_list *li, *te=NULL; 241 int len; 242 243 len = strlen(name); 244 if (len >= TEST_NAME_LEN) { 245 return (E2BIG); 246 } 247 te = malloc(sizeof(struct kern_test_list), M_KTFRWK, M_WAITOK); 248 if (te == NULL) { 249 error = ENOMEM; 250 goto out; 251 } 252 KTFRWK_LOCK(); 253 /* First does it already exist? */ 254 TAILQ_FOREACH(li, &kfrwk.kfrwk_testlist, next) { 255 if (strcmp(li->name, name) == 0) { 256 error = EALREADY; 257 free(te, M_KTFRWK); 258 goto out; 259 } 260 } 261 /* Ok we can do it, lets add it to the list */ 262 te->func = func; 263 strcpy(te->name, name); 264 TAILQ_INSERT_TAIL(&kfrwk.kfrwk_testlist, te, next); 265 out: 266 KTFRWK_UNLOCK(); 267 return(error); 268 } 269 270 int 271 kern_testframework_deregister(const char *name) 272 { 273 struct kern_test_list *li, *te=NULL; 274 u_int ncpus = mp_ncpus ? mp_ncpus : MAXCPU; 275 int error = 0; 276 277 KTFRWK_LOCK(); 278 /* First does it already exist? */ 279 TAILQ_FOREACH (li, &kfrwk.kfrwk_testlist, next) { 280 if (strcmp(li->name, name) == 0) { 281 te = li; 282 break; 283 } 284 } 285 if (te == NULL) { 286 /* It is not registered so no problem */ 287 goto out; 288 } 289 if (ncpus != kfrwk.kfrwk_waiting) { 290 /* We are busy executing something -- can't unload */ 291 error = EBUSY; 292 goto out; 293 } 294 if (!TAILQ_EMPTY(&kfrwk.kfrwk_testq)) { 295 /* Something still to execute */ 296 error = EBUSY; 297 goto out; 298 } 299 /* Ok we can remove the dude safely */ 300 TAILQ_REMOVE(&kfrwk.kfrwk_testlist, te, next); 301 memset(te, 0, sizeof(struct kern_test_list)); 302 free(te, M_KTFRWK); 303 out: 304 KTFRWK_UNLOCK(); 305 return(error); 306 } 307 308 static int 309 kerntest_mod_init(module_t mod, int type, void *data) 310 { 311 int err; 312 313 switch (type) { 314 case MOD_LOAD: 315 err = kerntest_frwk_init(); 316 break; 317 case MOD_QUIESCE: 318 KTFRWK_LOCK(); 319 if (TAILQ_EMPTY(&kfrwk.kfrwk_testlist)) { 320 err = 0; 321 } else { 322 err = EBUSY; 323 } 324 KTFRWK_UNLOCK(); 325 break; 326 case MOD_UNLOAD: 327 err = kerntest_frwk_fini(); 328 break; 329 default: 330 return (EOPNOTSUPP); 331 } 332 return (err); 333 } 334 335 static moduledata_t kern_test_framework = { 336 .name = "kernel_testfrwk", 337 .evhand = kerntest_mod_init, 338 .priv = 0 339 }; 340 341 MODULE_VERSION(kern_testframework, 1); 342 DECLARE_MODULE(kern_testframework, kern_test_framework, SI_SUB_PSEUDO, SI_ORDER_ANY); 343