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/resourcevar.h>
  40 #include <sys/sched.h>
  41 #include <sys/sysctl.h>
  42 #include <sys/smp.h>
  43 #include <sys/syscallsubr.h>
  44 #include <sys/sysent.h>
  45 #include <sys/systm.h>
  46 #include <sys/sysproto.h>
  47 #include <sys/signalvar.h>
  48 #include <sys/ucontext.h>
  49 #include <sys/thr.h>
  50 #include <sys/rtprio.h>
  51 #include <sys/umtx.h>
  52 #include <sys/limits.h>
  53
  54 #include <machine/frame.h>
  55
  56 #include <security/audit/audit.h>
  57
  58 #ifdef COMPAT_FREEBSD32
  59
  60 static inline int
  61 suword_lwpid(void *addr, lwpid_t lwpid)
  62 {
  63         int error;
  64
  65         if (SV_CURPROC_FLAG(SV_LP64))
  66                 error = suword(addr, lwpid);
  67         else
  68                 error = suword32(addr, lwpid);
  69         return (error);
  70 }
  71
  72 #else
  73 #define suword_lwpid    suword
  74 #endif
  75
  76 extern int max_threads_per_proc;
  77 extern int max_threads_hits;
  78
  79 static int create_thread(struct thread *td, mcontext_t *ctx,
  80                          void (*start_func)(void *), void *arg,
  81                          char *stack_base, size_t stack_size,
  82                          char *tls_base,
  83                          long *child_tid, long *parent_tid,
  84                          int flags, struct rtprio *rtp);
  85
  86 /*
  87  * System call interface.
  88  */
  89 int
  90 thr_create(struct thread *td, struct thr_create_args *uap)
  91     /* ucontext_t *ctx, long *id, int flags */
  92 {
  93         ucontext_t ctx;
  94         int error;
  95
  96         if ((error = copyin(uap->ctx, &ctx, sizeof(ctx))))
  97                 return (error);
  98
  99         error = create_thread(td, &ctx.uc_mcontext, NULL, NULL,
 100                 NULL, 0, NULL, uap->id, NULL, uap->flags, NULL);
 101         return (error);
 102 }
 103
 104 int
 105 thr_new(struct thread *td, struct thr_new_args *uap)
 106     /* struct thr_param * */
 107 {
 108         struct thr_param param;
 109         int error;
 110
 111         if (uap->param_size < 0 || uap->param_size > sizeof(param))
 112                 return (EINVAL);
 113         bzero(&param, sizeof(param));
 114         if ((error = copyin(uap->param, &param, uap->param_size)))
 115                 return (error);
 116         return (kern_thr_new(td, &param));
 117 }
 118
 119 int
 120 kern_thr_new(struct thread *td, struct thr_param *param)
 121 {
 122         struct rtprio rtp, *rtpp;
 123         int error;
 124
 125         rtpp = NULL;
 126         if (param->rtp != 0) {
 127                 error = copyin(param->rtp, &rtp, sizeof(struct rtprio));
 128                 if (error)
 129                         return (error);
 130                 rtpp = &rtp;
 131         }
 132         error = create_thread(td, NULL, param->start_func, param->arg,
 133                 param->stack_base, param->stack_size, param->tls_base,
 134                 param->child_tid, param->parent_tid, param->flags,
 135                 rtpp);
 136         return (error);
 137 }
 138
 139 static int
 140 create_thread(struct thread *td, mcontext_t *ctx,
 141             void (*start_func)(void *), void *arg,
 142             char *stack_base, size_t stack_size,
 143             char *tls_base,
 144             long *child_tid, long *parent_tid,
 145             int flags, struct rtprio *rtp)
 146 {
 147         stack_t stack;
 148         struct thread *newtd;
 149         struct proc *p;
 150         int error;
 151
 152         p = td->td_proc;
 153
 154         /* Have race condition but it is cheap. */
 155         if (p->p_numthreads >= max_threads_per_proc) {
 156                 ++max_threads_hits;
 157                 return (EPROCLIM);
 158         }
 159
 160         if (rtp != NULL) {
 161                 switch(rtp->type) {
 162                 case RTP_PRIO_REALTIME:
 163                 case RTP_PRIO_FIFO:
 164                         /* Only root can set scheduler policy */
 165                         if (priv_check(td, PRIV_SCHED_SETPOLICY) != 0)
 166                                 return (EPERM);
 167                         if (rtp->prio > RTP_PRIO_MAX)
 168                                 return (EINVAL);
 169                         break;
 170                 case RTP_PRIO_NORMAL:
 171                         rtp->prio = 0;
 172                         break;
 173                 default:
 174                         return (EINVAL);
 175                 }
 176         }
 177
 178         /* Initialize our td */
 179         newtd = thread_alloc(0);
 180         if (newtd == NULL)
 181                 return (ENOMEM);
 182
 183         /*
 184          * Try the copyout as soon as we allocate the td so we don't
 185          * have to tear things down in a failure case below.
 186          * Here we copy out tid to two places, one for child and one
 187          * for parent, because pthread can create a detached thread,
 188          * if parent wants to safely access child tid, it has to provide
 189          * its storage, because child thread may exit quickly and
 190          * memory is freed before parent thread can access it.
 191          */
 192         if ((child_tid != NULL &&
 193             suword_lwpid(child_tid, newtd->td_tid)) ||
 194             (parent_tid != NULL &&
 195             suword_lwpid(parent_tid, newtd->td_tid))) {
 196                 thread_free(newtd);
 197                 return (EFAULT);
 198         }
 199
 200         bzero(&newtd->td_startzero,
 201             __rangeof(struct thread, td_startzero, td_endzero));
 202         bzero(&newtd->td_rux, sizeof(newtd->td_rux));
 203         bcopy(&td->td_startcopy, &newtd->td_startcopy,
 204             __rangeof(struct thread, td_startcopy, td_endcopy));
 205         newtd->td_proc = td->td_proc;
 206         newtd->td_ucred = crhold(td->td_ucred);
 207
 208         cpu_set_upcall(newtd, td);
 209
 210         if (ctx != NULL) { /* old way to set user context */
 211                 error = set_mcontext(newtd, ctx);
 212                 if (error != 0) {
 213                         thread_free(newtd);
 214                         crfree(td->td_ucred);
 215                         return (error);
 216                 }
 217         } else {
 218                 /* Set up our machine context. */
 219                 stack.ss_sp = stack_base;
 220                 stack.ss_size = stack_size;
 221                 /* Set upcall address to user thread entry function. */
 222                 cpu_set_upcall_kse(newtd, start_func, arg, &stack);
 223                 /* Setup user TLS address and TLS pointer register. */
 224                 error = cpu_set_user_tls(newtd, tls_base);
 225                 if (error != 0) {
 226                         thread_free(newtd);
 227                         crfree(td->td_ucred);
 228                         return (error);
 229                 }
 230         }
 231
 232         PROC_LOCK(td->td_proc);
 233         td->td_proc->p_flag |= P_HADTHREADS;
 234         newtd->td_sigmask = td->td_sigmask;
 235         thread_link(newtd, p);
 236         bcopy(p->p_comm, newtd->td_name, sizeof(newtd->td_name));
 237         thread_lock(td);
 238         /* let the scheduler know about these things. */
 239         sched_fork_thread(td, newtd);
 240         thread_unlock(td);
 241         if (P_SHOULDSTOP(p))
 242                 newtd->td_flags |= TDF_ASTPENDING | TDF_NEEDSUSPCHK;
 243         PROC_UNLOCK(p);
 244         thread_lock(newtd);
 245         if (rtp != NULL) {
 246                 if (!(td->td_pri_class == PRI_TIMESHARE &&
 247                       rtp->type == RTP_PRIO_NORMAL)) {
 248                         rtp_to_pri(rtp, newtd);
 249                         sched_prio(newtd, newtd->td_user_pri);
 250                 } /* ignore timesharing class */
 251         }
 252         TD_SET_CAN_RUN(newtd);
 253         sched_add(newtd, SRQ_BORING);
 254         thread_unlock(newtd);
 255
 256         return (0);
 257 }
 258
 259 int
 260 thr_self(struct thread *td, struct thr_self_args *uap)
 261     /* long *id */
 262 {
 263         int error;
 264
 265         error = suword_lwpid(uap->id, (unsigned)td->td_tid);
 266         if (error == -1)
 267                 return (EFAULT);
 268         return (0);
 269 }
 270
 271 int
 272 thr_exit(struct thread *td, struct thr_exit_args *uap)
 273     /* long *state */
 274 {
 275         struct proc *p;
 276
 277         p = td->td_proc;
 278
 279         /* Signal userland that it can free the stack. */
 280         if ((void *)uap->state != NULL) {
 281                 suword_lwpid(uap->state, 1);
 282                 kern_umtx_wake(td, uap->state, INT_MAX, 0);
 283         }
 284
 285         PROC_LOCK(p);
 286         tdsigcleanup(td);
 287         PROC_SLOCK(p);
 288
 289         /*
 290          * Shutting down last thread in the proc.  This will actually
 291          * call exit() in the trampoline when it returns.
 292          */
 293         if (p->p_numthreads != 1) {
 294                 thread_stopped(p);
 295                 thread_exit();
 296                 /* NOTREACHED */
 297         }
 298         PROC_SUNLOCK(p);
 299         PROC_UNLOCK(p);
 300         return (0);
 301 }
 302
 303 int
 304 thr_kill(struct thread *td, struct thr_kill_args *uap)
 305     /* long id, int sig */
 306 {
 307         ksiginfo_t ksi;
 308         struct thread *ttd;
 309         struct proc *p;
 310         int error;
 311
 312         p = td->td_proc;
 313         error = 0;
 314         ksiginfo_init(&ksi);
 315         ksi.ksi_signo = uap->sig;
 316         ksi.ksi_code = SI_USER;
 317         ksi.ksi_pid = p->p_pid;
 318         ksi.ksi_uid = td->td_ucred->cr_ruid;
 319         PROC_LOCK(p);
 320         if (uap->id == -1) {
 321                 if (uap->sig != 0 && !_SIG_VALID(uap->sig)) {
 322                         error = EINVAL;
 323                 } else {
 324                         error = ESRCH;
 325                         FOREACH_THREAD_IN_PROC(p, ttd) {
 326                                 if (ttd != td) {
 327                                         error = 0;
 328                                         if (uap->sig == 0)
 329                                                 break;
 330                                         tdsignal(p, ttd, uap->sig, &ksi);
 331                                 }
 332                         }
 333                 }
 334         } else {
 335                 if (uap->id != td->td_tid)
 336                         ttd = thread_find(p, uap->id);
 337                 else
 338                         ttd = td;
 339                 if (ttd == NULL)
 340                         error = ESRCH;
 341                 else if (uap->sig == 0)
 342                         ;
 343                 else if (!_SIG_VALID(uap->sig))
 344                         error = EINVAL;
 345                 else
 346                         tdsignal(p, ttd, uap->sig, &ksi);
 347         }
 348         PROC_UNLOCK(p);
 349         return (error);
 350 }
 351
 352 int
 353 thr_kill2(struct thread *td, struct thr_kill2_args *uap)
 354     /* pid_t pid, long id, int sig */
 355 {
 356         ksiginfo_t ksi;
 357         struct thread *ttd;
 358         struct proc *p;
 359         int error;
 360
 361         AUDIT_ARG_SIGNUM(uap->sig);
 362
 363         if (uap->pid == td->td_proc->p_pid) {
 364                 p = td->td_proc;
 365                 PROC_LOCK(p);
 366         } else if ((p = pfind(uap->pid)) == NULL) {
 367                 return (ESRCH);
 368         }
 369         AUDIT_ARG_PROCESS(p);
 370
 371         error = p_cansignal(td, p, uap->sig);
 372         if (error == 0) {
 373                 ksiginfo_init(&ksi);
 374                 ksi.ksi_signo = uap->sig;
 375                 ksi.ksi_code = SI_USER;
 376                 ksi.ksi_pid = td->td_proc->p_pid;
 377                 ksi.ksi_uid = td->td_ucred->cr_ruid;
 378                 if (uap->id == -1) {
 379                         if (uap->sig != 0 && !_SIG_VALID(uap->sig)) {
 380                                 error = EINVAL;
 381                         } else {
 382                                 error = ESRCH;
 383                                 FOREACH_THREAD_IN_PROC(p, ttd) {
 384                                         if (ttd != td) {
 385                                                 error = 0;
 386                                                 if (uap->sig == 0)
 387                                                         break;
 388                                                 tdsignal(p, ttd, uap->sig,
 389                                                     &ksi);
 390                                         }
 391                                 }
 392                         }
 393                 } else {
 394                         if (uap->id != td->td_tid)
 395                                 ttd = thread_find(p, uap->id);
 396                         else
 397                                 ttd = td;
 398                         if (ttd == NULL)
 399                                 error = ESRCH;
 400                         else if (uap->sig == 0)
 401                                 ;
 402                         else if (!_SIG_VALID(uap->sig))
 403                                 error = EINVAL;
 404                         else
 405                                 tdsignal(p, ttd, uap->sig, &ksi);
 406                 }
 407         }
 408         PROC_UNLOCK(p);
 409         return (error);
 410 }
 411
 412 int
 413 thr_suspend(struct thread *td, struct thr_suspend_args *uap)
 414         /* const struct timespec *timeout */
 415 {
 416         struct timespec ts, *tsp;
 417         int error;
 418
 419         tsp = NULL;
 420         if (uap->timeout != NULL) {
 421                 error = copyin((const void *)uap->timeout, (void *)&ts,
 422                     sizeof(struct timespec));
 423                 if (error != 0)
 424                         return (error);
 425                 tsp = &ts;
 426         }
 427
 428         return (kern_thr_suspend(td, tsp));
 429 }
 430
 431 int
 432 kern_thr_suspend(struct thread *td, struct timespec *tsp)
 433 {
 434         struct timeval tv;
 435         int error = 0, hz = 0;
 436
 437         if (tsp != NULL) {
 438                 if (tsp->tv_nsec < 0 || tsp->tv_nsec > 1000000000)
 439                         return (EINVAL);
 440                 if (tsp->tv_sec == 0 && tsp->tv_nsec == 0)
 441                         return (ETIMEDOUT);
 442                 TIMESPEC_TO_TIMEVAL(&tv, tsp);
 443                 hz = tvtohz(&tv);
 444         }
 445
 446         if (td->td_pflags & TDP_WAKEUP) {
 447                 td->td_pflags &= ~TDP_WAKEUP;
 448                 return (0);
 449         }
 450
 451         PROC_LOCK(td->td_proc);
 452         if ((td->td_flags & TDF_THRWAKEUP) == 0)
 453                 error = msleep((void *)td, &td->td_proc->p_mtx, PCATCH, "lthr",
 454                     hz);
 455         if (td->td_flags & TDF_THRWAKEUP) {
 456                 thread_lock(td);
 457                 td->td_flags &= ~TDF_THRWAKEUP;
 458                 thread_unlock(td);
 459                 PROC_UNLOCK(td->td_proc);
 460                 return (0);
 461         }
 462         PROC_UNLOCK(td->td_proc);
 463         if (error == EWOULDBLOCK)
 464                 error = ETIMEDOUT;
 465         else if (error == ERESTART) {
 466                 if (hz != 0)
 467                         error = EINTR;
 468         }
 469         return (error);
 470 }
 471
 472 int
 473 thr_wake(struct thread *td, struct thr_wake_args *uap)
 474         /* long id */
 475 {
 476         struct proc *p;
 477         struct thread *ttd;
 478
 479         if (uap->id == td->td_tid) {
 480                 td->td_pflags |= TDP_WAKEUP;
 481                 return (0);
 482         }
 483
 484         p = td->td_proc;
 485         PROC_LOCK(p);
 486         ttd = thread_find(p, uap->id);
 487         if (ttd == NULL) {
 488                 PROC_UNLOCK(p);
 489                 return (ESRCH);
 490         }
 491         thread_lock(ttd);
 492         ttd->td_flags |= TDF_THRWAKEUP;
 493         thread_unlock(ttd);
 494         wakeup((void *)ttd);
 495         PROC_UNLOCK(p);
 496         return (0);
 497 }
 498
 499 int
 500 thr_set_name(struct thread *td, struct thr_set_name_args *uap)
 501 {
 502         struct proc *p = td->td_proc;
 503         char name[MAXCOMLEN + 1];
 504         struct thread *ttd;
 505         int error;
 506
 507         error = 0;
 508         name[0] = '\0';
 509         if (uap->name != NULL) {
 510                 error = copyinstr(uap->name, name, sizeof(name),
 511                         NULL);
 512                 if (error)
 513                         return (error);
 514         }
 515         PROC_LOCK(p);
 516         if (uap->id == td->td_tid)
 517                 ttd = td;
 518         else
 519                 ttd = thread_find(p, uap->id);
 520         if (ttd != NULL)
 521                 strcpy(ttd->td_name, name);
 522         else
 523                 error = ESRCH;
 524         PROC_UNLOCK(p);
 525         return (error);
 526 }