sys/kern/subr_trap.c

   1 /*-
   2  * SPDX-License-Identifier: BSD-4-Clause
   3  *
   4  * Copyright (C) 1994, David Greenman
   5  * Copyright (c) 1990, 1993
   6  *      The Regents of the University of California.  All rights reserved.
   7  * Copyright (c) 2007 The FreeBSD Foundation
   8  *
   9  * This code is derived from software contributed to Berkeley by
  10  * the University of Utah, and William Jolitz.
  11  *
  12  * Portions of this software were developed by A. Joseph Koshy under
  13  * sponsorship from the FreeBSD Foundation and Google, Inc.
  14  *
  15  * Redistribution and use in source and binary forms, with or without
  16  * modification, are permitted provided that the following conditions
  17  * are met:
  18  * 1. Redistributions of source code must retain the above copyright
  19  *    notice, this list of conditions and the following disclaimer.
  20  * 2. Redistributions in binary form must reproduce the above copyright
  21  *    notice, this list of conditions and the following disclaimer in the
  22  *    documentation and/or other materials provided with the distribution.
  23  * 3. All advertising materials mentioning features or use of this software
  24  *    must display the following acknowledgement:
  25  *      This product includes software developed by the University of
  26  *      California, Berkeley and its contributors.
  27  * 4. Neither the name of the University nor the names of its contributors
  28  *    may be used to endorse or promote products derived from this software
  29  *    without specific prior written permission.
  30  *
  31  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  32  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  33  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  34  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  35  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  36  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  37  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  38  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  39  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  40  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  41  * SUCH DAMAGE.
  42  *
  43  *      from: @(#)trap.c        7.4 (Berkeley) 5/13/91
  44  */
  45
  46 #include <sys/cdefs.h>
  47 __FBSDID("$FreeBSD$");
  48
  49 #include "opt_hwpmc_hooks.h"
  50 #include "opt_ktrace.h"
  51 #include "opt_sched.h"
  52
  53 #include <sys/param.h>
  54 #include <sys/bus.h>
  55 #include <sys/capsicum.h>
  56 #include <sys/kernel.h>
  57 #include <sys/lock.h>
  58 #include <sys/mutex.h>
  59 #include <sys/pmckern.h>
  60 #include <sys/proc.h>
  61 #include <sys/ktr.h>
  62 #include <sys/pioctl.h>
  63 #include <sys/ptrace.h>
  64 #include <sys/racct.h>
  65 #include <sys/resourcevar.h>
  66 #include <sys/sched.h>
  67 #include <sys/signalvar.h>
  68 #include <sys/syscall.h>
  69 #include <sys/syscallsubr.h>
  70 #include <sys/sysent.h>
  71 #include <sys/systm.h>
  72 #include <sys/vmmeter.h>
  73 #ifdef KTRACE
  74 #include <sys/uio.h>
  75 #include <sys/ktrace.h>
  76 #endif
  77 #include <security/audit/audit.h>
  78
  79 #include <machine/cpu.h>
  80
  81 #ifdef VIMAGE
  82 #include <net/vnet.h>
  83 #endif
  84
  85 #ifdef  HWPMC_HOOKS
  86 #include <sys/pmckern.h>
  87 #endif
  88
  89 #include <security/mac/mac_framework.h>
  90
  91 void (*softdep_ast_cleanup)(struct thread *);
  92
  93 /*
  94  * Define the code needed before returning to user mode, for trap and
  95  * syscall.
  96  */
  97 void
  98 userret(struct thread *td, struct trapframe *frame)
  99 {
 100         struct proc *p = td->td_proc;
 101
 102         CTR3(KTR_SYSC, "userret: thread %p (pid %d, %s)", td, p->p_pid,
 103             td->td_name);
 104         KASSERT((p->p_flag & P_WEXIT) == 0,
 105             ("Exiting process returns to usermode"));
 106 #ifdef DIAGNOSTIC
 107         /*
 108          * Check that we called signotify() enough.  For
 109          * multi-threaded processes, where signal distribution might
 110          * change due to other threads changing sigmask, the check is
 111          * racy and cannot be performed reliably.
 112          * If current process is vfork child, indicated by P_PPWAIT, then
 113          * issignal() ignores stops, so we block the check to avoid
 114          * classifying pending signals.
 115          */
 116         if (p->p_numthreads == 1) {
 117                 PROC_LOCK(p);
 118                 thread_lock(td);
 119                 if ((p->p_flag & P_PPWAIT) == 0 &&
 120                     (td->td_pflags & TDP_SIGFASTBLOCK) == 0) {
 121                         if (SIGPENDING(td) && (td->td_flags &
 122                             (TDF_NEEDSIGCHK | TDF_ASTPENDING)) !=
 123                             (TDF_NEEDSIGCHK | TDF_ASTPENDING)) {
 124                                 thread_unlock(td);
 125                                 panic(
 126         "failed to set signal flags for ast p %p td %p fl %x",
 127                                     p, td, td->td_flags);
 128                         }
 129                 }
 130                 thread_unlock(td);
 131                 PROC_UNLOCK(p);
 132         }
 133 #endif
 134 #ifdef KTRACE
 135         KTRUSERRET(td);
 136 #endif
 137
 138         td_softdep_cleanup(td);
 139         MPASS(td->td_su == NULL);
 140
 141         /*
 142          * If this thread tickled GEOM, we need to wait for the giggling to
 143          * stop before we return to userland
 144          */
 145         if (__predict_false(td->td_pflags & TDP_GEOM))
 146                 g_waitidle();
 147
 148         /*
 149          * Charge system time if profiling.
 150          */
 151         if (__predict_false(p->p_flag & P_PROFIL))
 152                 addupc_task(td, TRAPF_PC(frame), td->td_pticks * psratio);
 153
 154 #ifdef HWPMC_HOOKS
 155         if (PMC_THREAD_HAS_SAMPLES(td))
 156                 PMC_CALL_HOOK(td, PMC_FN_THR_USERRET, NULL);
 157 #endif
 158         /*
 159          * Let the scheduler adjust our priority etc.
 160          */
 161         sched_userret(td);
 162
 163         /*
 164          * Check for misbehavior.
 165          *
 166          * In case there is a callchain tracing ongoing because of
 167          * hwpmc(4), skip the scheduler pinning check.
 168          * hwpmc(4) subsystem, infact, will collect callchain informations
 169          * at ast() checkpoint, which is past userret().
 170          */
 171         WITNESS_WARN(WARN_PANIC, NULL, "userret: returning");
 172         KASSERT(td->td_critnest == 0,
 173             ("userret: Returning in a critical section"));
 174         KASSERT(td->td_locks == 0,
 175             ("userret: Returning with %d locks held", td->td_locks));
 176         KASSERT(td->td_rw_rlocks == 0,
 177             ("userret: Returning with %d rwlocks held in read mode",
 178             td->td_rw_rlocks));
 179         KASSERT(td->td_sx_slocks == 0,
 180             ("userret: Returning with %d sx locks held in shared mode",
 181             td->td_sx_slocks));
 182         KASSERT(td->td_lk_slocks == 0,
 183             ("userret: Returning with %d lockmanager locks held in shared mode",
 184             td->td_lk_slocks));
 185         KASSERT((td->td_pflags & TDP_NOFAULTING) == 0,
 186             ("userret: Returning with pagefaults disabled"));
 187         if (__predict_false(!THREAD_CAN_SLEEP())) {
 188 #ifdef EPOCH_TRACE
 189                 epoch_trace_list(curthread);
 190 #endif
 191                 KASSERT(1, ("userret: Returning with sleep disabled"));
 192         }
 193         KASSERT(td->td_pinned == 0 || (td->td_pflags & TDP_CALLCHAIN) != 0,
 194             ("userret: Returning with with pinned thread"));
 195         KASSERT(td->td_vp_reserved == NULL,
 196             ("userret: Returning with preallocated vnode"));
 197         KASSERT((td->td_flags & (TDF_SBDRY | TDF_SEINTR | TDF_SERESTART)) == 0,
 198             ("userret: Returning with stop signals deferred"));
 199         KASSERT(td->td_su == NULL,
 200             ("userret: Returning with SU cleanup request not handled"));
 201         KASSERT(td->td_vslock_sz == 0,
 202             ("userret: Returning with vslock-wired space"));
 203 #ifdef VIMAGE
 204         /* Unfortunately td_vnet_lpush needs VNET_DEBUG. */
 205         VNET_ASSERT(curvnet == NULL,
 206             ("%s: Returning on td %p (pid %d, %s) with vnet %p set in %s",
 207             __func__, td, p->p_pid, td->td_name, curvnet,
 208             (td->td_vnet_lpush != NULL) ? td->td_vnet_lpush : "N/A"));
 209 #endif
 210 #ifdef RACCT
 211         if (__predict_false(racct_enable && p->p_throttled != 0))
 212                 racct_proc_throttled(p);
 213 #endif
 214 }
 215
 216 /*
 217  * Process an asynchronous software trap.
 218  * This is relatively easy.
 219  * This function will return with preemption disabled.
 220  */
 221 void
 222 ast(struct trapframe *framep)
 223 {
 224         struct thread *td;
 225         struct proc *p;
 226         int flags, sig;
 227
 228         td = curthread;
 229         p = td->td_proc;
 230
 231         CTR3(KTR_SYSC, "ast: thread %p (pid %d, %s)", td, p->p_pid,
 232             p->p_comm);
 233         KASSERT(TRAPF_USERMODE(framep), ("ast in kernel mode"));
 234         WITNESS_WARN(WARN_PANIC, NULL, "Returning to user mode");
 235         mtx_assert(&Giant, MA_NOTOWNED);
 236         THREAD_LOCK_ASSERT(td, MA_NOTOWNED);
 237         td->td_frame = framep;
 238         td->td_pticks = 0;
 239
 240         /*
 241          * This updates the td_flag's for the checks below in one
 242          * "atomic" operation with turning off the astpending flag.
 243          * If another AST is triggered while we are handling the
 244          * AST's saved in flags, the astpending flag will be set and
 245          * ast() will be called again.
 246          */
 247         thread_lock(td);
 248         flags = td->td_flags;
 249         td->td_flags &= ~(TDF_ASTPENDING | TDF_NEEDSIGCHK | TDF_NEEDSUSPCHK |
 250             TDF_NEEDRESCHED | TDF_ALRMPEND | TDF_PROFPEND | TDF_MACPEND);
 251         thread_unlock(td);
 252         VM_CNT_INC(v_trap);
 253
 254         if (td->td_cowgen != p->p_cowgen)
 255                 thread_cow_update(td);
 256         if (td->td_pflags & TDP_OWEUPC && p->p_flag & P_PROFIL) {
 257                 addupc_task(td, td->td_profil_addr, td->td_profil_ticks);
 258                 td->td_profil_ticks = 0;
 259                 td->td_pflags &= ~TDP_OWEUPC;
 260         }
 261 #ifdef HWPMC_HOOKS
 262         /* Handle Software PMC callchain capture. */
 263         if (PMC_IS_PENDING_CALLCHAIN(td))
 264                 PMC_CALL_HOOK_UNLOCKED(td, PMC_FN_USER_CALLCHAIN_SOFT, (void *) framep);
 265 #endif
 266         if (flags & TDF_ALRMPEND) {
 267                 PROC_LOCK(p);
 268                 kern_psignal(p, SIGVTALRM);
 269                 PROC_UNLOCK(p);
 270         }
 271         if (flags & TDF_PROFPEND) {
 272                 PROC_LOCK(p);
 273                 kern_psignal(p, SIGPROF);
 274                 PROC_UNLOCK(p);
 275         }
 276 #ifdef MAC
 277         if (flags & TDF_MACPEND)
 278                 mac_thread_userret(td);
 279 #endif
 280         if (flags & TDF_NEEDRESCHED) {
 281 #ifdef KTRACE
 282                 if (KTRPOINT(td, KTR_CSW))
 283                         ktrcsw(1, 1, __func__);
 284 #endif
 285                 thread_lock(td);
 286                 sched_prio(td, td->td_user_pri);
 287                 mi_switch(SW_INVOL | SWT_NEEDRESCHED);
 288 #ifdef KTRACE
 289                 if (KTRPOINT(td, KTR_CSW))
 290                         ktrcsw(0, 1, __func__);
 291 #endif
 292         }
 293
 294 #ifdef DIAGNOSTIC
 295         if (p->p_numthreads == 1 && (flags & TDF_NEEDSIGCHK) == 0) {
 296                 PROC_LOCK(p);
 297                 thread_lock(td);
 298                 /*
 299                  * Note that TDF_NEEDSIGCHK should be re-read from
 300                  * td_flags, since signal might have been delivered
 301                  * after we cleared td_flags above.  This is one of
 302                  * the reason for looping check for AST condition.
 303                  * See comment in userret() about P_PPWAIT.
 304                  */
 305                 if ((p->p_flag & P_PPWAIT) == 0 &&
 306                     (td->td_pflags & TDP_SIGFASTBLOCK) == 0) {
 307                         if (SIGPENDING(td) && (td->td_flags &
 308                             (TDF_NEEDSIGCHK | TDF_ASTPENDING)) !=
 309                             (TDF_NEEDSIGCHK | TDF_ASTPENDING)) {
 310                                 thread_unlock(td); /* fix dumps */
 311                                 panic(
 312         "failed2 to set signal flags for ast p %p td %p fl %x %x",
 313                                     p, td, flags, td->td_flags);
 314                         }
 315                 }
 316                 thread_unlock(td);
 317                 PROC_UNLOCK(p);
 318         }
 319 #endif
 320
 321         /*
 322          * Check for signals. Unlocked reads of p_pendingcnt or
 323          * p_siglist might cause process-directed signal to be handled
 324          * later.
 325          */
 326         if (flags & TDF_NEEDSIGCHK || p->p_pendingcnt > 0 ||
 327             !SIGISEMPTY(p->p_siglist)) {
 328                 sigfastblock_fetch(td);
 329                 if ((td->td_pflags & TDP_SIGFASTBLOCK) != 0 &&
 330                     td->td_sigblock_val != 0) {
 331                         sigfastblock_setpend(td, true);
 332                 } else {
 333                         PROC_LOCK(p);
 334                         mtx_lock(&p->p_sigacts->ps_mtx);
 335                         while ((sig = cursig(td)) != 0) {
 336                                 KASSERT(sig >= 0, ("sig %d", sig));
 337                                 postsig(sig);
 338                         }
 339                         mtx_unlock(&p->p_sigacts->ps_mtx);
 340                         PROC_UNLOCK(p);
 341                 }
 342         }
 343
 344         /*
 345          * Handle deferred update of the fast sigblock value, after
 346          * the postsig() loop was performed.
 347          */
 348         if (td->td_pflags & TDP_SIGFASTPENDING)
 349                 sigfastblock_setpend(td, false);
 350
 351         /*
 352          * We need to check to see if we have to exit or wait due to a
 353          * single threading requirement or some other STOP condition.
 354          */
 355         if (flags & TDF_NEEDSUSPCHK) {
 356                 PROC_LOCK(p);
 357                 thread_suspend_check(0);
 358                 PROC_UNLOCK(p);
 359         }
 360
 361         if (td->td_pflags & TDP_OLDMASK) {
 362                 td->td_pflags &= ~TDP_OLDMASK;
 363                 kern_sigprocmask(td, SIG_SETMASK, &td->td_oldsigmask, NULL, 0);
 364         }
 365
 366         userret(td, framep);
 367 }
 368
 369 const char *
 370 syscallname(struct proc *p, u_int code)
 371 {
 372         static const char unknown[] = "unknown";
 373         struct sysentvec *sv;
 374
 375         sv = p->p_sysent;
 376         if (sv->sv_syscallnames == NULL || code >= sv->sv_size)
 377                 return (unknown);
 378         return (sv->sv_syscallnames[code]);
 379 }