sys/kern/kern_thr.c

   1 /*-
   2  * Copyright (c) 2003, Jeffrey Roberson <jeff@freebsd.org>
   3  * 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 unmodified, this list of conditions, and the following
  10  *    disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  16  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  17  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  18  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  19  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  20  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  21  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  22  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  24  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25  */
  26
  27 #include <sys/cdefs.h>
  28 __FBSDID("$FreeBSD$");
  29
  30 #include "opt_compat.h"
  31 #include "opt_posix.h"
  32 #include <sys/param.h>
  33 #include <sys/kernel.h>
  34 #include <sys/lock.h>
  35 #include <sys/mutex.h>
  36 #include <sys/priv.h>
  37 #include <sys/proc.h>
  38 #include <sys/posix4.h>
  39 #include <sys/ptrace.h>
  40 #include <sys/racct.h>
  41 #include <sys/resourcevar.h>
  42 #include <sys/rwlock.h>
  43 #include <sys/sched.h>
  44 #include <sys/sysctl.h>
  45 #include <sys/smp.h>
  46 #include <sys/syscallsubr.h>
  47 #include <sys/sysent.h>
  48 #include <sys/systm.h>
  49 #include <sys/sysproto.h>
  50 #include <sys/signalvar.h>
  51 #include <sys/sysctl.h>
  52 #include <sys/ucontext.h>
  53 #include <sys/thr.h>
  54 #include <sys/rtprio.h>
  55 #include <sys/umtx.h>
  56 #include <sys/limits.h>
  57
  58 #include <vm/vm_domain.h>
  59
  60 #include <machine/frame.h>
  61
  62 #include <security/audit/audit.h>
  63
  64 static SYSCTL_NODE(_kern, OID_AUTO, threads, CTLFLAG_RW, 0,
  65     "thread allocation");
  66
  67 static int max_threads_per_proc = 1500;
  68 SYSCTL_INT(_kern_threads, OID_AUTO, max_threads_per_proc, CTLFLAG_RW,
  69     &max_threads_per_proc, 0, "Limit on threads per proc");
  70
  71 static int max_threads_hits;
  72 SYSCTL_INT(_kern_threads, OID_AUTO, max_threads_hits, CTLFLAG_RD,
  73     &max_threads_hits, 0, "kern.threads.max_threads_per_proc hit count");
  74
  75 #ifdef COMPAT_FREEBSD32
  76
  77 static inline int
  78 suword_lwpid(void *addr, lwpid_t lwpid)
  79 {
  80         int error;
  81
  82         if (SV_CURPROC_FLAG(SV_LP64))
  83                 error = suword(addr, lwpid);
  84         else
  85                 error = suword32(addr, lwpid);
  86         return (error);
  87 }
  88
  89 #else
  90 #define suword_lwpid    suword
  91 #endif
  92
  93 /*
  94  * System call interface.
  95  */
  96
  97 struct thr_create_initthr_args {
  98         ucontext_t ctx;
  99         long *tid;
 100 };
 101
 102 static int
 103 thr_create_initthr(struct thread *td, void *thunk)
 104 {
 105         struct thr_create_initthr_args *args;
 106
 107         /* Copy out the child tid. */
 108         args = thunk;
 109         if (args->tid != NULL && suword_lwpid(args->tid, td->td_tid))
 110                 return (EFAULT);
 111
 112         return (set_mcontext(td, &args->ctx.uc_mcontext));
 113 }
 114
 115 int
 116 sys_thr_create(struct thread *td, struct thr_create_args *uap)
 117     /* ucontext_t *ctx, long *id, int flags */
 118 {
 119         struct thr_create_initthr_args args;
 120         int error;
 121
 122         if ((error = copyin(uap->ctx, &args.ctx, sizeof(args.ctx))))
 123                 return (error);
 124         args.tid = uap->id;
 125         return (thread_create(td, NULL, thr_create_initthr, &args));
 126 }
 127
 128 int
 129 sys_thr_new(struct thread *td, struct thr_new_args *uap)
 130     /* struct thr_param * */
 131 {
 132         struct thr_param param;
 133         int error;
 134
 135         if (uap->param_size < 0 || uap->param_size > sizeof(param))
 136                 return (EINVAL);
 137         bzero(&param, sizeof(param));
 138         if ((error = copyin(uap->param, &param, uap->param_size)))
 139                 return (error);
 140         return (kern_thr_new(td, &param));
 141 }
 142
 143 static int
 144 thr_new_initthr(struct thread *td, void *thunk)
 145 {
 146         stack_t stack;
 147         struct thr_param *param;
 148
 149         /*
 150          * Here we copy out tid to two places, one for child and one
 151          * for parent, because pthread can create a detached thread,
 152          * if parent wants to safely access child tid, it has to provide
 153          * its storage, because child thread may exit quickly and
 154          * memory is freed before parent thread can access it.
 155          */
 156         param = thunk;
 157         if ((param->child_tid != NULL &&
 158             suword_lwpid(param->child_tid, td->td_tid)) ||
 159             (param->parent_tid != NULL &&
 160             suword_lwpid(param->parent_tid, td->td_tid)))
 161                 return (EFAULT);
 162
 163         /* Set up our machine context. */
 164         stack.ss_sp = param->stack_base;
 165         stack.ss_size = param->stack_size;
 166         /* Set upcall address to user thread entry function. */
 167         cpu_set_upcall(td, param->start_func, param->arg, &stack);
 168         /* Setup user TLS address and TLS pointer register. */
 169         return (cpu_set_user_tls(td, param->tls_base));
 170 }
 171
 172 int
 173 kern_thr_new(struct thread *td, struct thr_param *param)
 174 {
 175         struct rtprio rtp, *rtpp;
 176         int error;
 177
 178         rtpp = NULL;
 179         if (param->rtp != 0) {
 180                 error = copyin(param->rtp, &rtp, sizeof(struct rtprio));
 181                 if (error)
 182                         return (error);
 183                 rtpp = &rtp;
 184         }
 185         return (thread_create(td, rtpp, thr_new_initthr, param));
 186 }
 187
 188 int
 189 thread_create(struct thread *td, struct rtprio *rtp,
 190     int (*initialize_thread)(struct thread *, void *), void *thunk)
 191 {
 192         struct thread *newtd;
 193         struct proc *p;
 194         int error;
 195
 196         p = td->td_proc;
 197
 198         if (rtp != NULL) {
 199                 switch(rtp->type) {
 200                 case RTP_PRIO_REALTIME:
 201                 case RTP_PRIO_FIFO:
 202                         /* Only root can set scheduler policy */
 203                         if (priv_check(td, PRIV_SCHED_SETPOLICY) != 0)
 204                                 return (EPERM);
 205                         if (rtp->prio > RTP_PRIO_MAX)
 206                                 return (EINVAL);
 207                         break;
 208                 case RTP_PRIO_NORMAL:
 209                         rtp->prio = 0;
 210                         break;
 211                 default:
 212                         return (EINVAL);
 213                 }
 214         }
 215
 216 #ifdef RACCT
 217         if (racct_enable) {
 218                 PROC_LOCK(p);
 219                 error = racct_add(p, RACCT_NTHR, 1);
 220                 PROC_UNLOCK(p);
 221                 if (error != 0)
 222                         return (EPROCLIM);
 223         }
 224 #endif
 225
 226         /* Initialize our td */
 227         error = kern_thr_alloc(p, 0, &newtd);
 228         if (error)
 229                 goto fail;
 230
 231         cpu_copy_thread(newtd, td);
 232
 233         bzero(&newtd->td_startzero,
 234             __rangeof(struct thread, td_startzero, td_endzero));
 235         newtd->td_sleeptimo = 0;
 236         newtd->td_vslock_sz = 0;
 237         bzero(&newtd->td_si, sizeof(newtd->td_si));
 238         bcopy(&td->td_startcopy, &newtd->td_startcopy,
 239             __rangeof(struct thread, td_startcopy, td_endcopy));
 240         newtd->td_sa = td->td_sa;
 241         newtd->td_proc = td->td_proc;
 242         newtd->td_rb_list = newtd->td_rbp_list = newtd->td_rb_inact = 0;
 243         thread_cow_get(newtd, td);
 244
 245         error = initialize_thread(newtd, thunk);
 246         if (error != 0) {
 247                 thread_cow_free(newtd);
 248                 thread_free(newtd);
 249                 goto fail;
 250         }
 251
 252         PROC_LOCK(p);
 253         p->p_flag |= P_HADTHREADS;
 254         thread_link(newtd, p);
 255         bcopy(p->p_comm, newtd->td_name, sizeof(newtd->td_name));
 256         thread_lock(td);
 257         /* let the scheduler know about these things. */
 258         sched_fork_thread(td, newtd);
 259         thread_unlock(td);
 260         if (P_SHOULDSTOP(p))
 261                 newtd->td_flags |= TDF_ASTPENDING | TDF_NEEDSUSPCHK;
 262         if (p->p_ptevents & PTRACE_LWP)
 263                 newtd->td_dbgflags |= TDB_BORN;
 264
 265         /*
 266          * Copy the existing thread VM policy into the new thread.
 267          */
 268         vm_domain_policy_localcopy(&newtd->td_vm_dom_policy,
 269             &td->td_vm_dom_policy);
 270
 271         PROC_UNLOCK(p);
 272
 273         tidhash_add(newtd);
 274
 275         thread_lock(newtd);
 276         if (rtp != NULL) {
 277                 if (!(td->td_pri_class == PRI_TIMESHARE &&
 278                       rtp->type == RTP_PRIO_NORMAL)) {
 279                         rtp_to_pri(rtp, newtd);
 280                         sched_prio(newtd, newtd->td_user_pri);
 281                 } /* ignore timesharing class */
 282         }
 283         TD_SET_CAN_RUN(newtd);
 284         sched_add(newtd, SRQ_BORING);
 285         thread_unlock(newtd);
 286
 287         return (0);
 288
 289 fail:
 290 #ifdef RACCT
 291         if (racct_enable) {
 292                 PROC_LOCK(p);
 293                 racct_sub(p, RACCT_NTHR, 1);
 294                 PROC_UNLOCK(p);
 295         }
 296 #endif
 297         return (error);
 298 }
 299
 300 int
 301 sys_thr_self(struct thread *td, struct thr_self_args *uap)
 302     /* long *id */
 303 {
 304         int error;
 305
 306         error = suword_lwpid(uap->id, (unsigned)td->td_tid);
 307         if (error == -1)
 308                 return (EFAULT);
 309         return (0);
 310 }
 311
 312 int
 313 sys_thr_exit(struct thread *td, struct thr_exit_args *uap)
 314     /* long *state */
 315 {
 316
 317         umtx_thread_exit(td);
 318
 319         /* Signal userland that it can free the stack. */
 320         if ((void *)uap->state != NULL) {
 321                 suword_lwpid(uap->state, 1);
 322                 kern_umtx_wake(td, uap->state, INT_MAX, 0);
 323         }
 324
 325         return (kern_thr_exit(td));
 326 }
 327
 328 int
 329 kern_thr_exit(struct thread *td)
 330 {
 331         struct proc *p;
 332
 333         p = td->td_proc;
 334
 335         /*
 336          * If all of the threads in a process call this routine to
 337          * exit (e.g. all threads call pthread_exit()), exactly one
 338          * thread should return to the caller to terminate the process
 339          * instead of the thread.
 340          *
 341          * Checking p_numthreads alone is not sufficient since threads
 342          * might be committed to terminating while the PROC_LOCK is
 343          * dropped in either ptracestop() or while removing this thread
 344          * from the tidhash.  Instead, the p_pendingexits field holds
 345          * the count of threads in either of those states and a thread
 346          * is considered the "last" thread if all of the other threads
 347          * in a process are already terminating.
 348          */
 349         PROC_LOCK(p);
 350         if (p->p_numthreads == p->p_pendingexits + 1) {
 351                 /*
 352                  * Ignore attempts to shut down last thread in the
 353                  * proc.  This will actually call _exit(2) in the
 354                  * usermode trampoline when it returns.
 355                  */
 356                 PROC_UNLOCK(p);
 357                 return (0);
 358         }
 359
 360         p->p_pendingexits++;
 361         td->td_dbgflags |= TDB_EXIT;
 362         if (p->p_ptevents & PTRACE_LWP)
 363                 ptracestop(td, SIGTRAP, NULL);
 364         PROC_UNLOCK(p);
 365         tidhash_remove(td);
 366         PROC_LOCK(p);
 367         p->p_pendingexits--;
 368
 369         /*
 370          * The check above should prevent all other threads from this
 371          * process from exiting while the PROC_LOCK is dropped, so
 372          * there must be at least one other thread other than the
 373          * current thread.
 374          */
 375         KASSERT(p->p_numthreads > 1, ("too few threads"));
 376         racct_sub(p, RACCT_NTHR, 1);
 377         tdsigcleanup(td);
 378
 379 #ifdef AUDIT
 380         AUDIT_SYSCALL_EXIT(0, td);
 381 #endif
 382
 383         PROC_SLOCK(p);
 384         thread_stopped(p);
 385         thread_exit();
 386         /* NOTREACHED */
 387 }
 388
 389 int
 390 sys_thr_kill(struct thread *td, struct thr_kill_args *uap)
 391     /* long id, int sig */
 392 {
 393         ksiginfo_t ksi;
 394         struct thread *ttd;
 395         struct proc *p;
 396         int error;
 397
 398         p = td->td_proc;
 399         ksiginfo_init(&ksi);
 400         ksi.ksi_signo = uap->sig;
 401         ksi.ksi_code = SI_LWP;
 402         ksi.ksi_pid = p->p_pid;
 403         ksi.ksi_uid = td->td_ucred->cr_ruid;
 404         if (uap->id == -1) {
 405                 if (uap->sig != 0 && !_SIG_VALID(uap->sig)) {
 406                         error = EINVAL;
 407                 } else {
 408                         error = ESRCH;
 409                         PROC_LOCK(p);
 410                         FOREACH_THREAD_IN_PROC(p, ttd) {
 411                                 if (ttd != td) {
 412                                         error = 0;
 413                                         if (uap->sig == 0)
 414                                                 break;
 415                                         tdksignal(ttd, uap->sig, &ksi);
 416                                 }
 417                         }
 418                         PROC_UNLOCK(p);
 419                 }
 420         } else {
 421                 error = 0;
 422                 ttd = tdfind((lwpid_t)uap->id, p->p_pid);
 423                 if (ttd == NULL)
 424                         return (ESRCH);
 425                 if (uap->sig == 0)
 426                         ;
 427                 else if (!_SIG_VALID(uap->sig))
 428                         error = EINVAL;
 429                 else
 430                         tdksignal(ttd, uap->sig, &ksi);
 431                 PROC_UNLOCK(ttd->td_proc);
 432         }
 433         return (error);
 434 }
 435
 436 int
 437 sys_thr_kill2(struct thread *td, struct thr_kill2_args *uap)
 438     /* pid_t pid, long id, int sig */
 439 {
 440         ksiginfo_t ksi;
 441         struct thread *ttd;
 442         struct proc *p;
 443         int error;
 444
 445         AUDIT_ARG_SIGNUM(uap->sig);
 446
 447         ksiginfo_init(&ksi);
 448         ksi.ksi_signo = uap->sig;
 449         ksi.ksi_code = SI_LWP;
 450         ksi.ksi_pid = td->td_proc->p_pid;
 451         ksi.ksi_uid = td->td_ucred->cr_ruid;
 452         if (uap->id == -1) {
 453                 if ((p = pfind(uap->pid)) == NULL)
 454                         return (ESRCH);
 455                 AUDIT_ARG_PROCESS(p);
 456                 error = p_cansignal(td, p, uap->sig);
 457                 if (error) {
 458                         PROC_UNLOCK(p);
 459                         return (error);
 460                 }
 461                 if (uap->sig != 0 && !_SIG_VALID(uap->sig)) {
 462                         error = EINVAL;
 463                 } else {
 464                         error = ESRCH;
 465                         FOREACH_THREAD_IN_PROC(p, ttd) {
 466                                 if (ttd != td) {
 467                                         error = 0;
 468                                         if (uap->sig == 0)
 469                                                 break;
 470                                         tdksignal(ttd, uap->sig, &ksi);
 471                                 }
 472                         }
 473                 }
 474                 PROC_UNLOCK(p);
 475         } else {
 476                 ttd = tdfind((lwpid_t)uap->id, uap->pid);
 477                 if (ttd == NULL)
 478                         return (ESRCH);
 479                 p = ttd->td_proc;
 480                 AUDIT_ARG_PROCESS(p);
 481                 error = p_cansignal(td, p, uap->sig);
 482                 if (uap->sig == 0)
 483                         ;
 484                 else if (!_SIG_VALID(uap->sig))
 485                         error = EINVAL;
 486                 else
 487                         tdksignal(ttd, uap->sig, &ksi);
 488                 PROC_UNLOCK(p);
 489         }
 490         return (error);
 491 }
 492
 493 int
 494 sys_thr_suspend(struct thread *td, struct thr_suspend_args *uap)
 495         /* const struct timespec *timeout */
 496 {
 497         struct timespec ts, *tsp;
 498         int error;
 499
 500         tsp = NULL;
 501         if (uap->timeout != NULL) {
 502                 error = umtx_copyin_timeout(uap->timeout, &ts);
 503                 if (error != 0)
 504                         return (error);
 505                 tsp = &ts;
 506         }
 507
 508         return (kern_thr_suspend(td, tsp));
 509 }
 510
 511 int
 512 kern_thr_suspend(struct thread *td, struct timespec *tsp)
 513 {
 514         struct proc *p = td->td_proc;
 515         struct timeval tv;
 516         int error = 0;
 517         int timo = 0;
 518
 519         if (td->td_pflags & TDP_WAKEUP) {
 520                 td->td_pflags &= ~TDP_WAKEUP;
 521                 return (0);
 522         }
 523
 524         if (tsp != NULL) {
 525                 if (tsp->tv_sec == 0 && tsp->tv_nsec == 0)
 526                         error = EWOULDBLOCK;
 527                 else {
 528                         TIMESPEC_TO_TIMEVAL(&tv, tsp);
 529                         timo = tvtohz(&tv);
 530                 }
 531         }
 532
 533         PROC_LOCK(p);
 534         if (error == 0 && (td->td_flags & TDF_THRWAKEUP) == 0)
 535                 error = msleep((void *)td, &p->p_mtx,
 536                          PCATCH, "lthr", timo);
 537
 538         if (td->td_flags & TDF_THRWAKEUP) {
 539                 thread_lock(td);
 540                 td->td_flags &= ~TDF_THRWAKEUP;
 541                 thread_unlock(td);
 542                 PROC_UNLOCK(p);
 543                 return (0);
 544         }
 545         PROC_UNLOCK(p);
 546         if (error == EWOULDBLOCK)
 547                 error = ETIMEDOUT;
 548         else if (error == ERESTART) {
 549                 if (timo != 0)
 550                         error = EINTR;
 551         }
 552         return (error);
 553 }
 554
 555 int
 556 sys_thr_wake(struct thread *td, struct thr_wake_args *uap)
 557         /* long id */
 558 {
 559         struct proc *p;
 560         struct thread *ttd;
 561
 562         if (uap->id == td->td_tid) {
 563                 td->td_pflags |= TDP_WAKEUP;
 564                 return (0);
 565         }
 566
 567         p = td->td_proc;
 568         ttd = tdfind((lwpid_t)uap->id, p->p_pid);
 569         if (ttd == NULL)
 570                 return (ESRCH);
 571         thread_lock(ttd);
 572         ttd->td_flags |= TDF_THRWAKEUP;
 573         thread_unlock(ttd);
 574         wakeup((void *)ttd);
 575         PROC_UNLOCK(p);
 576         return (0);
 577 }
 578
 579 int
 580 sys_thr_set_name(struct thread *td, struct thr_set_name_args *uap)
 581 {
 582         struct proc *p;
 583         char name[MAXCOMLEN + 1];
 584         struct thread *ttd;
 585         int error;
 586
 587         error = 0;
 588         name[0] = '\0';
 589         if (uap->name != NULL) {
 590                 error = copyinstr(uap->name, name, sizeof(name), NULL);
 591                 if (error == ENAMETOOLONG) {
 592                         error = copyin(uap->name, name, sizeof(name) - 1);
 593                         name[sizeof(name) - 1] = '\0';
 594                 }
 595                 if (error)
 596                         return (error);
 597         }
 598         p = td->td_proc;
 599         ttd = tdfind((lwpid_t)uap->id, p->p_pid);
 600         if (ttd == NULL)
 601                 return (ESRCH);
 602         strcpy(ttd->td_name, name);
 603 #ifdef KTR
 604         sched_clear_tdname(ttd);
 605 #endif
 606         PROC_UNLOCK(p);
 607         return (error);
 608 }
 609
 610 int
 611 kern_thr_alloc(struct proc *p, int pages, struct thread **ntd)
 612 {
 613
 614         /* Have race condition but it is cheap. */
 615         if (p->p_numthreads >= max_threads_per_proc) {
 616                 ++max_threads_hits;
 617                 return (EPROCLIM);
 618         }
 619
 620         *ntd = thread_alloc(pages);
 621         if (*ntd == NULL)
 622                 return (ENOMEM);
 623
 624         return (0);
 625 }