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/ptrace.h>
  63 #include <sys/racct.h>
  64 #include <sys/resourcevar.h>
  65 #include <sys/sched.h>
  66 #include <sys/signalvar.h>
  67 #include <sys/syscall.h>
  68 #include <sys/syscallsubr.h>
  69 #include <sys/sysent.h>
  70 #include <sys/systm.h>
  71 #include <sys/vmmeter.h>
  72 #ifdef KTRACE
  73 #include <sys/uio.h>
  74 #include <sys/ktrace.h>
  75 #endif
  76 #include <security/audit/audit.h>
  77
  78 #include <machine/cpu.h>
  79
  80 #ifdef VIMAGE
  81 #include <net/vnet.h>
  82 #endif
  83
  84 #ifdef  HWPMC_HOOKS
  85 #include <sys/pmckern.h>
  86 #endif
  87
  88 #include <security/mac/mac_framework.h>
  89
  90 void (*softdep_ast_cleanup)(struct thread *);
  91
  92 /*
  93  * Define the code needed before returning to user mode, for trap and
  94  * syscall.
  95  */
  96 void
  97 userret(struct thread *td, struct trapframe *frame)
  98 {
  99         struct proc *p = td->td_proc;
 100
 101         CTR3(KTR_SYSC, "userret: thread %p (pid %d, %s)", td, p->p_pid,
 102             td->td_name);
 103         KASSERT((p->p_flag & P_WEXIT) == 0,
 104             ("Exiting process returns to usermode"));
 105 #ifdef DIAGNOSTIC
 106         /*
 107          * Check that we called signotify() enough.  For
 108          * multi-threaded processes, where signal distribution might
 109          * change due to other threads changing sigmask, the check is
 110          * racy and cannot be performed reliably.
 111          * If current process is vfork child, indicated by P_PPWAIT, then
 112          * issignal() ignores stops, so we block the check to avoid
 113          * classifying pending signals.
 114          */
 115         if (p->p_numthreads == 1) {
 116                 PROC_LOCK(p);
 117                 thread_lock(td);
 118                 if ((p->p_flag & P_PPWAIT) == 0 &&
 119                     (td->td_pflags & TDP_SIGFASTBLOCK) == 0) {
 120                         if (SIGPENDING(td) && (td->td_flags &
 121                             (TDF_NEEDSIGCHK | TDF_ASTPENDING)) !=
 122                             (TDF_NEEDSIGCHK | TDF_ASTPENDING)) {
 123                                 thread_unlock(td);
 124                                 panic(
 125         "failed to set signal flags for ast p %p td %p fl %x",
 126                                     p, td, td->td_flags);
 127                         }
 128                 }
 129                 thread_unlock(td);
 130                 PROC_UNLOCK(p);
 131         }
 132 #endif
 133 #ifdef KTRACE
 134         KTRUSERRET(td);
 135 #endif
 136
 137         td_softdep_cleanup(td);
 138         MPASS(td->td_su == NULL);
 139
 140         /*
 141          * If this thread tickled GEOM, we need to wait for the giggling to
 142          * stop before we return to userland
 143          */
 144         if (__predict_false(td->td_pflags & TDP_GEOM))
 145                 g_waitidle();
 146
 147         /*
 148          * Charge system time if profiling.
 149          */
 150         if (__predict_false(p->p_flag & P_PROFIL))
 151                 addupc_task(td, TRAPF_PC(frame), td->td_pticks * psratio);
 152
 153 #ifdef HWPMC_HOOKS
 154         if (PMC_THREAD_HAS_SAMPLES(td))
 155                 PMC_CALL_HOOK(td, PMC_FN_THR_USERRET, NULL);
 156 #endif
 157         /*
 158          * Let the scheduler adjust our priority etc.
 159          */
 160         sched_userret(td);
 161
 162         /*
 163          * Check for misbehavior.
 164          *
 165          * In case there is a callchain tracing ongoing because of
 166          * hwpmc(4), skip the scheduler pinning check.
 167          * hwpmc(4) subsystem, infact, will collect callchain informations
 168          * at ast() checkpoint, which is past userret().
 169          */
 170         WITNESS_WARN(WARN_PANIC, NULL, "userret: returning");
 171         KASSERT(td->td_critnest == 0,
 172             ("userret: Returning in a critical section"));
 173         KASSERT(td->td_locks == 0,
 174             ("userret: Returning with %d locks held", td->td_locks));
 175         KASSERT(td->td_rw_rlocks == 0,
 176             ("userret: Returning with %d rwlocks held in read mode",
 177             td->td_rw_rlocks));
 178         KASSERT(td->td_sx_slocks == 0,
 179             ("userret: Returning with %d sx locks held in shared mode",
 180             td->td_sx_slocks));
 181         KASSERT(td->td_lk_slocks == 0,
 182             ("userret: Returning with %d lockmanager locks held in shared mode",
 183             td->td_lk_slocks));
 184         KASSERT((td->td_pflags & TDP_NOFAULTING) == 0,
 185             ("userret: Returning with pagefaults disabled"));
 186         if (__predict_false(!THREAD_CAN_SLEEP())) {
 187 #ifdef EPOCH_TRACE
 188                 epoch_trace_list(curthread);
 189 #endif
 190                 KASSERT(1, ("userret: Returning with sleep disabled"));
 191         }
 192         KASSERT(td->td_pinned == 0 || (td->td_pflags & TDP_CALLCHAIN) != 0,
 193             ("userret: Returning with with pinned thread"));
 194         KASSERT(td->td_vp_reserved == NULL,
 195             ("userret: Returning with preallocated vnode"));
 196         KASSERT((td->td_flags & (TDF_SBDRY | TDF_SEINTR | TDF_SERESTART)) == 0,
 197             ("userret: Returning with stop signals deferred"));
 198         KASSERT(td->td_su == NULL,
 199             ("userret: Returning with SU cleanup request not handled"));
 200         KASSERT(td->td_vslock_sz == 0,
 201             ("userret: Returning with vslock-wired space"));
 202 #ifdef VIMAGE
 203         /* Unfortunately td_vnet_lpush needs VNET_DEBUG. */
 204         VNET_ASSERT(curvnet == NULL,
 205             ("%s: Returning on td %p (pid %d, %s) with vnet %p set in %s",
 206             __func__, td, p->p_pid, td->td_name, curvnet,
 207             (td->td_vnet_lpush != NULL) ? td->td_vnet_lpush : "N/A"));
 208 #endif
 209 #ifdef RACCT
 210         if (__predict_false(racct_enable && p->p_throttled != 0))
 211                 racct_proc_throttled(p);
 212 #endif
 213 }
 214
 215 /*
 216  * Process an asynchronous software trap.
 217  * This is relatively easy.
 218  * This function will return with preemption disabled.
 219  */
 220 void
 221 ast(struct trapframe *framep)
 222 {
 223         struct thread *td;
 224         struct proc *p;
 225         int flags, sig;
 226
 227         td = curthread;
 228         p = td->td_proc;
 229
 230         CTR3(KTR_SYSC, "ast: thread %p (pid %d, %s)", td, p->p_pid,
 231             p->p_comm);
 232         KASSERT(TRAPF_USERMODE(framep), ("ast in kernel mode"));
 233         WITNESS_WARN(WARN_PANIC, NULL, "Returning to user mode");
 234         mtx_assert(&Giant, MA_NOTOWNED);
 235         THREAD_LOCK_ASSERT(td, MA_NOTOWNED);
 236         td->td_frame = framep;
 237         td->td_pticks = 0;
 238
 239         /*
 240          * This updates the td_flag's for the checks below in one
 241          * "atomic" operation with turning off the astpending flag.
 242          * If another AST is triggered while we are handling the
 243          * AST's saved in flags, the astpending flag will be set and
 244          * ast() will be called again.
 245          */
 246         thread_lock(td);
 247         flags = td->td_flags;
 248         td->td_flags &= ~(TDF_ASTPENDING | TDF_NEEDSIGCHK | TDF_NEEDSUSPCHK |
 249             TDF_NEEDRESCHED | TDF_ALRMPEND | TDF_PROFPEND | TDF_MACPEND);
 250         thread_unlock(td);
 251         VM_CNT_INC(v_trap);
 252
 253         if (td->td_cowgen != p->p_cowgen)
 254                 thread_cow_update(td);
 255         if (td->td_pflags & TDP_OWEUPC && p->p_flag & P_PROFIL) {
 256                 addupc_task(td, td->td_profil_addr, td->td_profil_ticks);
 257                 td->td_profil_ticks = 0;
 258                 td->td_pflags &= ~TDP_OWEUPC;
 259         }
 260 #ifdef HWPMC_HOOKS
 261         /* Handle Software PMC callchain capture. */
 262         if (PMC_IS_PENDING_CALLCHAIN(td))
 263                 PMC_CALL_HOOK_UNLOCKED(td, PMC_FN_USER_CALLCHAIN_SOFT, (void *) framep);
 264 #endif
 265         if (flags & TDF_ALRMPEND) {
 266                 PROC_LOCK(p);
 267                 kern_psignal(p, SIGVTALRM);
 268                 PROC_UNLOCK(p);
 269         }
 270         if (flags & TDF_PROFPEND) {
 271                 PROC_LOCK(p);
 272                 kern_psignal(p, SIGPROF);
 273                 PROC_UNLOCK(p);
 274         }
 275 #ifdef MAC
 276         if (flags & TDF_MACPEND)
 277                 mac_thread_userret(td);
 278 #endif
 279         if (flags & TDF_NEEDRESCHED) {
 280 #ifdef KTRACE
 281                 if (KTRPOINT(td, KTR_CSW))
 282                         ktrcsw(1, 1, __func__);
 283 #endif
 284                 thread_lock(td);
 285                 sched_prio(td, td->td_user_pri);
 286                 mi_switch(SW_INVOL | SWT_NEEDRESCHED);
 287 #ifdef KTRACE
 288                 if (KTRPOINT(td, KTR_CSW))
 289                         ktrcsw(0, 1, __func__);
 290 #endif
 291         }
 292
 293 #ifdef DIAGNOSTIC
 294         if (p->p_numthreads == 1 && (flags & TDF_NEEDSIGCHK) == 0) {
 295                 PROC_LOCK(p);
 296                 thread_lock(td);
 297                 /*
 298                  * Note that TDF_NEEDSIGCHK should be re-read from
 299                  * td_flags, since signal might have been delivered
 300                  * after we cleared td_flags above.  This is one of
 301                  * the reason for looping check for AST condition.
 302                  * See comment in userret() about P_PPWAIT.
 303                  */
 304                 if ((p->p_flag & P_PPWAIT) == 0 &&
 305                     (td->td_pflags & TDP_SIGFASTBLOCK) == 0) {
 306                         if (SIGPENDING(td) && (td->td_flags &
 307                             (TDF_NEEDSIGCHK | TDF_ASTPENDING)) !=
 308                             (TDF_NEEDSIGCHK | TDF_ASTPENDING)) {
 309                                 thread_unlock(td); /* fix dumps */
 310                                 panic(
 311         "failed2 to set signal flags for ast p %p td %p fl %x %x",
 312                                     p, td, flags, td->td_flags);
 313                         }
 314                 }
 315                 thread_unlock(td);
 316                 PROC_UNLOCK(p);
 317         }
 318 #endif
 319
 320         /*
 321          * Check for signals. Unlocked reads of p_pendingcnt or
 322          * p_siglist might cause process-directed signal to be handled
 323          * later.
 324          */
 325         if (flags & TDF_NEEDSIGCHK || p->p_pendingcnt > 0 ||
 326             !SIGISEMPTY(p->p_siglist)) {
 327                 sigfastblock_fetch(td);
 328                 if ((td->td_pflags & TDP_SIGFASTBLOCK) != 0 &&
 329                     td->td_sigblock_val != 0) {
 330                         sigfastblock_setpend(td, true);
 331                 } else {
 332                         PROC_LOCK(p);
 333                         mtx_lock(&p->p_sigacts->ps_mtx);
 334                         while ((sig = cursig(td)) != 0) {
 335                                 KASSERT(sig >= 0, ("sig %d", sig));
 336                                 postsig(sig);
 337                         }
 338                         mtx_unlock(&p->p_sigacts->ps_mtx);
 339                         PROC_UNLOCK(p);
 340                 }
 341         }
 342
 343         /*
 344          * Handle deferred update of the fast sigblock value, after
 345          * the postsig() loop was performed.
 346          */
 347         if (td->td_pflags & TDP_SIGFASTPENDING)
 348                 sigfastblock_setpend(td, false);
 349
 350         /*
 351          * We need to check to see if we have to exit or wait due to a
 352          * single threading requirement or some other STOP condition.
 353          */
 354         if (flags & TDF_NEEDSUSPCHK) {
 355                 PROC_LOCK(p);
 356                 thread_suspend_check(0);
 357                 PROC_UNLOCK(p);
 358         }
 359
 360         if (td->td_pflags & TDP_OLDMASK) {
 361                 td->td_pflags &= ~TDP_OLDMASK;
 362                 kern_sigprocmask(td, SIG_SETMASK, &td->td_oldsigmask, NULL, 0);
 363         }
 364
 365         userret(td, framep);
 366 }
 367
 368 const char *
 369 syscallname(struct proc *p, u_int code)
 370 {
 371         static const char unknown[] = "unknown";
 372         struct sysentvec *sv;
 373
 374         sv = p->p_sysent;
 375         if (sv->sv_syscallnames == NULL || code >= sv->sv_size)
 376                 return (unknown);
 377         return (sv->sv_syscallnames[code]);
 378 }