1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD 3 * 4 * Copyright (c) 1999 Peter Wemm <peter@FreeBSD.org> 5 * All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26 * SUCH DAMAGE. 27 */ 28 29 #include <sys/cdefs.h> 30 __FBSDID("$FreeBSD$"); 31 32 #include <sys/param.h> 33 #include <sys/systm.h> 34 #include <sys/cpuset.h> 35 #include <sys/kthread.h> 36 #include <sys/lock.h> 37 #include <sys/mutex.h> 38 #include <sys/proc.h> 39 #include <sys/resourcevar.h> 40 #include <sys/rwlock.h> 41 #include <sys/signalvar.h> 42 #include <sys/sx.h> 43 #include <sys/umtx.h> 44 #include <sys/unistd.h> 45 #include <sys/wait.h> 46 #include <sys/sched.h> 47 #include <sys/tslog.h> 48 #include <vm/vm.h> 49 #include <vm/vm_extern.h> 50 51 #include <machine/stdarg.h> 52 53 /* 54 * Start a kernel process. This is called after a fork() call in 55 * mi_startup() in the file kern/init_main.c. 56 * 57 * This function is used to start "internal" daemons and intended 58 * to be called from SYSINIT(). 59 */ 60 void 61 kproc_start(const void *udata) 62 { 63 const struct kproc_desc *kp = udata; 64 int error; 65 66 error = kproc_create((void (*)(void *))kp->func, NULL, 67 kp->global_procpp, 0, 0, "%s", kp->arg0); 68 if (error) 69 panic("kproc_start: %s: error %d", kp->arg0, error); 70 } 71 72 /* 73 * Create a kernel process/thread/whatever. It shares its address space 74 * with proc0 - ie: kernel only. 75 * 76 * func is the function to start. 77 * arg is the parameter to pass to function on first startup. 78 * newpp is the return value pointing to the thread's struct proc. 79 * flags are flags to fork1 (in unistd.h) 80 * fmt and following will be *printf'd into (*newpp)->p_comm (for ps, etc.). 81 */ 82 int 83 kproc_create(void (*func)(void *), void *arg, 84 struct proc **newpp, int flags, int pages, const char *fmt, ...) 85 { 86 struct fork_req fr; 87 int error; 88 va_list ap; 89 struct thread *td; 90 struct proc *p2; 91 92 if (!proc0.p_stats) 93 panic("kproc_create called too soon"); 94 95 bzero(&fr, sizeof(fr)); 96 fr.fr_flags = RFMEM | RFFDG | RFPROC | RFSTOPPED | flags; 97 fr.fr_pages = pages; 98 fr.fr_procp = &p2; 99 error = fork1(&thread0, &fr); 100 if (error) 101 return error; 102 103 /* save a global descriptor, if desired */ 104 if (newpp != NULL) 105 *newpp = p2; 106 107 /* this is a non-swapped system process */ 108 PROC_LOCK(p2); 109 td = FIRST_THREAD_IN_PROC(p2); 110 p2->p_flag |= P_SYSTEM | P_KPROC; 111 td->td_pflags |= TDP_KTHREAD; 112 mtx_lock(&p2->p_sigacts->ps_mtx); 113 p2->p_sigacts->ps_flag |= PS_NOCLDWAIT; 114 mtx_unlock(&p2->p_sigacts->ps_mtx); 115 PROC_UNLOCK(p2); 116 117 /* set up arg0 for 'ps', et al */ 118 va_start(ap, fmt); 119 vsnprintf(p2->p_comm, sizeof(p2->p_comm), fmt, ap); 120 va_end(ap); 121 /* set up arg0 for 'ps', et al */ 122 va_start(ap, fmt); 123 vsnprintf(td->td_name, sizeof(td->td_name), fmt, ap); 124 va_end(ap); 125 #ifdef KTR 126 sched_clear_tdname(td); 127 #endif 128 TSTHREAD(td, td->td_name); 129 #ifdef HWPMC_HOOKS 130 if (PMC_SYSTEM_SAMPLING_ACTIVE()) { 131 PMC_CALL_HOOK_UNLOCKED(td, PMC_FN_PROC_CREATE_LOG, p2); 132 PMC_CALL_HOOK_UNLOCKED(td, PMC_FN_THR_CREATE_LOG, NULL); 133 } 134 #endif 135 136 /* call the processes' main()... */ 137 cpu_fork_kthread_handler(td, func, arg); 138 139 /* Avoid inheriting affinity from a random parent. */ 140 cpuset_kernthread(td); 141 thread_lock(td); 142 TD_SET_CAN_RUN(td); 143 sched_prio(td, PVM); 144 sched_user_prio(td, PUSER); 145 146 /* Delay putting it on the run queue until now. */ 147 if (!(flags & RFSTOPPED)) 148 sched_add(td, SRQ_BORING); 149 else 150 thread_unlock(td); 151 152 return 0; 153 } 154 155 void 156 kproc_exit(int ecode) 157 { 158 struct thread *td; 159 struct proc *p; 160 161 td = curthread; 162 p = td->td_proc; 163 164 /* 165 * Reparent curthread from proc0 to init so that the zombie 166 * is harvested. 167 */ 168 sx_xlock(&proctree_lock); 169 PROC_LOCK(p); 170 proc_reparent(p, initproc, true); 171 PROC_UNLOCK(p); 172 sx_xunlock(&proctree_lock); 173 174 /* 175 * Wakeup anyone waiting for us to exit. 176 */ 177 wakeup(p); 178 179 /* Buh-bye! */ 180 exit1(td, ecode, 0); 181 } 182 183 /* 184 * Advise a kernel process to suspend (or resume) in its main loop. 185 * Participation is voluntary. 186 */ 187 int 188 kproc_suspend(struct proc *p, int timo) 189 { 190 /* 191 * Make sure this is indeed a system process and we can safely 192 * use the p_siglist field. 193 */ 194 PROC_LOCK(p); 195 if ((p->p_flag & P_KPROC) == 0) { 196 PROC_UNLOCK(p); 197 return (EINVAL); 198 } 199 SIGADDSET(p->p_siglist, SIGSTOP); 200 wakeup(p); 201 return msleep(&p->p_siglist, &p->p_mtx, PPAUSE | PDROP, "suspkp", timo); 202 } 203 204 int 205 kproc_resume(struct proc *p) 206 { 207 /* 208 * Make sure this is indeed a system process and we can safely 209 * use the p_siglist field. 210 */ 211 PROC_LOCK(p); 212 if ((p->p_flag & P_KPROC) == 0) { 213 PROC_UNLOCK(p); 214 return (EINVAL); 215 } 216 SIGDELSET(p->p_siglist, SIGSTOP); 217 PROC_UNLOCK(p); 218 wakeup(&p->p_siglist); 219 return (0); 220 } 221 222 void 223 kproc_suspend_check(struct proc *p) 224 { 225 PROC_LOCK(p); 226 while (SIGISMEMBER(p->p_siglist, SIGSTOP)) { 227 wakeup(&p->p_siglist); 228 msleep(&p->p_siglist, &p->p_mtx, PPAUSE, "kpsusp", 0); 229 } 230 PROC_UNLOCK(p); 231 } 232 233 /* 234 * Start a kernel thread. 235 * 236 * This function is used to start "internal" daemons and intended 237 * to be called from SYSINIT(). 238 */ 239 240 void 241 kthread_start(const void *udata) 242 { 243 const struct kthread_desc *kp = udata; 244 int error; 245 246 error = kthread_add((void (*)(void *))kp->func, NULL, 247 NULL, kp->global_threadpp, 0, 0, "%s", kp->arg0); 248 if (error) 249 panic("kthread_start: %s: error %d", kp->arg0, error); 250 } 251 252 /* 253 * Create a kernel thread. It shares its address space 254 * with proc0 - ie: kernel only. 255 * 256 * func is the function to start. 257 * arg is the parameter to pass to function on first startup. 258 * newtdp is the return value pointing to the thread's struct thread. 259 * ** XXX fix this --> flags are flags to fork1 (in unistd.h) 260 * fmt and following will be *printf'd into (*newtd)->td_name (for ps, etc.). 261 */ 262 int 263 kthread_add(void (*func)(void *), void *arg, struct proc *p, 264 struct thread **newtdp, int flags, int pages, const char *fmt, ...) 265 { 266 va_list ap; 267 struct thread *newtd, *oldtd; 268 269 if (!proc0.p_stats) 270 panic("kthread_add called too soon"); 271 272 /* If no process supplied, put it on proc0 */ 273 if (p == NULL) 274 p = &proc0; 275 276 /* Initialize our new td */ 277 newtd = thread_alloc(pages); 278 if (newtd == NULL) 279 return (ENOMEM); 280 281 PROC_LOCK(p); 282 oldtd = FIRST_THREAD_IN_PROC(p); 283 284 bzero(&newtd->td_startzero, 285 __rangeof(struct thread, td_startzero, td_endzero)); 286 bcopy(&oldtd->td_startcopy, &newtd->td_startcopy, 287 __rangeof(struct thread, td_startcopy, td_endcopy)); 288 289 /* set up arg0 for 'ps', et al */ 290 va_start(ap, fmt); 291 vsnprintf(newtd->td_name, sizeof(newtd->td_name), fmt, ap); 292 va_end(ap); 293 294 TSTHREAD(newtd, newtd->td_name); 295 296 newtd->td_proc = p; /* needed for cpu_copy_thread */ 297 /* might be further optimized for kthread */ 298 cpu_copy_thread(newtd, oldtd); 299 /* put the designated function(arg) as the resume context */ 300 cpu_fork_kthread_handler(newtd, func, arg); 301 302 newtd->td_pflags |= TDP_KTHREAD; 303 thread_cow_get_proc(newtd, p); 304 305 /* this code almost the same as create_thread() in kern_thr.c */ 306 p->p_flag |= P_HADTHREADS; 307 thread_link(newtd, p); 308 thread_lock(oldtd); 309 /* let the scheduler know about these things. */ 310 sched_fork_thread(oldtd, newtd); 311 TD_SET_CAN_RUN(newtd); 312 thread_unlock(oldtd); 313 PROC_UNLOCK(p); 314 315 tidhash_add(newtd); 316 317 /* Avoid inheriting affinity from a random parent. */ 318 cpuset_kernthread(newtd); 319 #ifdef HWPMC_HOOKS 320 if (PMC_SYSTEM_SAMPLING_ACTIVE()) 321 PMC_CALL_HOOK_UNLOCKED(td, PMC_FN_THR_CREATE_LOG, NULL); 322 #endif 323 /* Delay putting it on the run queue until now. */ 324 if (!(flags & RFSTOPPED)) { 325 thread_lock(newtd); 326 sched_add(newtd, SRQ_BORING); 327 } 328 if (newtdp) 329 *newtdp = newtd; 330 return 0; 331 } 332 333 void 334 kthread_exit(void) 335 { 336 struct proc *p; 337 struct thread *td; 338 339 td = curthread; 340 p = td->td_proc; 341 342 #ifdef HWPMC_HOOKS 343 if (PMC_SYSTEM_SAMPLING_ACTIVE()) 344 PMC_CALL_HOOK_UNLOCKED(td, PMC_FN_THR_EXIT_LOG, NULL); 345 #endif 346 /* A module may be waiting for us to exit. */ 347 wakeup(td); 348 349 /* 350 * The last exiting thread in a kernel process must tear down 351 * the whole process. 352 */ 353 rw_wlock(&tidhash_lock); 354 PROC_LOCK(p); 355 if (p->p_numthreads == 1) { 356 PROC_UNLOCK(p); 357 rw_wunlock(&tidhash_lock); 358 kproc_exit(0); 359 } 360 LIST_REMOVE(td, td_hash); 361 rw_wunlock(&tidhash_lock); 362 umtx_thread_exit(td); 363 tdsigcleanup(td); 364 PROC_SLOCK(p); 365 thread_exit(); 366 } 367 368 /* 369 * Advise a kernel process to suspend (or resume) in its main loop. 370 * Participation is voluntary. 371 */ 372 int 373 kthread_suspend(struct thread *td, int timo) 374 { 375 struct proc *p; 376 377 p = td->td_proc; 378 379 /* 380 * td_pflags should not be read by any thread other than 381 * curthread, but as long as this flag is invariant during the 382 * thread's lifetime, it is OK to check its state. 383 */ 384 if ((td->td_pflags & TDP_KTHREAD) == 0) 385 return (EINVAL); 386 387 /* 388 * The caller of the primitive should have already checked that the 389 * thread is up and running, thus not being blocked by other 390 * conditions. 391 */ 392 PROC_LOCK(p); 393 thread_lock(td); 394 td->td_flags |= TDF_KTH_SUSP; 395 thread_unlock(td); 396 return (msleep(&td->td_flags, &p->p_mtx, PPAUSE | PDROP, "suspkt", 397 timo)); 398 } 399 400 /* 401 * Resume a thread previously put asleep with kthread_suspend(). 402 */ 403 int 404 kthread_resume(struct thread *td) 405 { 406 struct proc *p; 407 408 p = td->td_proc; 409 410 /* 411 * td_pflags should not be read by any thread other than 412 * curthread, but as long as this flag is invariant during the 413 * thread's lifetime, it is OK to check its state. 414 */ 415 if ((td->td_pflags & TDP_KTHREAD) == 0) 416 return (EINVAL); 417 418 PROC_LOCK(p); 419 thread_lock(td); 420 td->td_flags &= ~TDF_KTH_SUSP; 421 thread_unlock(td); 422 wakeup(&td->td_flags); 423 PROC_UNLOCK(p); 424 return (0); 425 } 426 427 /* 428 * Used by the thread to poll as to whether it should yield/sleep 429 * and notify the caller that is has happened. 430 */ 431 void 432 kthread_suspend_check(void) 433 { 434 struct proc *p; 435 struct thread *td; 436 437 td = curthread; 438 p = td->td_proc; 439 440 if ((td->td_pflags & TDP_KTHREAD) == 0) 441 panic("%s: curthread is not a valid kthread", __func__); 442 443 /* 444 * Setting the TDF_KTH_SUSP flag is protected by process lock. 445 * 446 * Do an unlocked read first to avoid serializing with all other threads 447 * in the common case of not suspending. 448 */ 449 if ((td->td_flags & TDF_KTH_SUSP) == 0) 450 return; 451 PROC_LOCK(p); 452 while ((td->td_flags & TDF_KTH_SUSP) != 0) { 453 wakeup(&td->td_flags); 454 msleep(&td->td_flags, &p->p_mtx, PPAUSE, "ktsusp", 0); 455 } 456 PROC_UNLOCK(p); 457 } 458 459 int 460 kproc_kthread_add(void (*func)(void *), void *arg, 461 struct proc **procptr, struct thread **tdptr, 462 int flags, int pages, const char *procname, const char *fmt, ...) 463 { 464 int error; 465 va_list ap; 466 char buf[100]; 467 struct thread *td; 468 469 if (*procptr == NULL) { 470 error = kproc_create(func, arg, 471 procptr, flags, pages, "%s", procname); 472 if (error) 473 return (error); 474 td = FIRST_THREAD_IN_PROC(*procptr); 475 if (tdptr) 476 *tdptr = td; 477 va_start(ap, fmt); 478 vsnprintf(td->td_name, sizeof(td->td_name), fmt, ap); 479 va_end(ap); 480 #ifdef KTR 481 sched_clear_tdname(td); 482 #endif 483 return (0); 484 } 485 va_start(ap, fmt); 486 vsnprintf(buf, sizeof(buf), fmt, ap); 487 va_end(ap); 488 error = kthread_add(func, arg, *procptr, 489 tdptr, flags, pages, "%s", buf); 490 return (error); 491 } 492