2 * SPDX-License-Identifier: BSD-3-Clause
4 * Copyright (c) 1993 The Regents of the University of California.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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 * 3. Neither the name of the University nor the names of its contributors
16 * may be used to endorse or promote products derived from this software
17 * without specific prior written permission.
19 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 #include <sys/cdefs.h>
33 __FBSDID("$FreeBSD$");
35 #include "opt_kstack_pages.h"
37 #include <sys/param.h>
41 #include <sys/kernel.h>
43 #include <sys/sysent.h>
44 #include <sys/systm.h>
45 #include <sys/_kstack_cache.h>
47 #include <vm/vm_param.h>
49 #include <vm/vm_map.h>
56 static void dumpthread(volatile struct proc *p, volatile struct thread *td,
61 * At least one non-optional show-command must be implemented using
62 * DB_SHOW_ALL_COMMAND() so that db_show_all_cmd_set gets created.
65 DB_SHOW_ALL_COMMAND(procs, db_procs_cmd)
67 db_ps(addr, have_addr, count, modif);
71 dump_args(volatile struct proc *p)
76 if (p->p_args == NULL)
78 args = p->p_args->ar_args;
79 len = (int)p->p_args->ar_length;
80 for (i = 0; i < len; i++) {
84 db_printf("%c", args[i]);
92 * - single-threaded process
93 * - multi-threaded process
94 * - thread in a MT process
97 * 1234567890123456789012345678901234567890123456789012345678901234567890
98 * pid ppid pgrp uid state wmesg wchan cmd
99 * <pid> <ppi> <pgi> <uid> <stat> <wmesg> <wchan > <name>
100 * <pid> <ppi> <pgi> <uid> <stat> (threaded) <command>
101 * <tid > <stat> <wmesg> <wchan > <name>
103 * For machines with 64-bit pointers, we expand the wchan field 8 more
107 db_ps(db_expr_t addr, bool hasaddr, db_expr_t count, char *modif)
109 volatile struct proc *p, *pp;
110 volatile struct thread *td;
114 int np, rflag, sflag, dflag, lflag, wflag;
116 ps_mode = modif[0] == 'a' ? PRINT_ARGS : PRINT_NONE;
119 if (!LIST_EMPTY(&allproc))
120 p = LIST_FIRST(&allproc);
125 db_printf(" pid ppid pgrp uid state wmesg wchan cmd\n");
127 db_printf(" pid ppid pgrp uid state wmesg wchan cmd\n");
129 while (--np >= 0 && !db_pager_quit) {
131 db_printf("oops, ran out of processes early!\n");
140 db_printf("%5d %5d %5d %5d ", p->p_pid, pp->p_pid,
141 pgrp != NULL ? pgrp->pg_id : 0,
142 cred != NULL ? cred->cr_ruid : 0);
144 /* Determine our primary process state. */
145 switch (p->p_state) {
151 * One of D, L, R, S, W. For a
152 * multithreaded process we will use
153 * the state of the thread with the
154 * highest precedence. The
155 * precendence order from high to low
156 * is R, L, D, S, W. If no thread is
157 * in a sane state we use '?' for our
160 rflag = sflag = dflag = lflag = wflag = 0;
161 FOREACH_THREAD_IN_PROC(p, td) {
162 if (td->td_state == TDS_RUNNING ||
163 td->td_state == TDS_RUNQ ||
164 td->td_state == TDS_CAN_RUN)
168 if (TD_IS_SLEEPING(td)) {
169 if (!(td->td_flags & TDF_SINTR))
174 if (TD_AWAITING_INTR(td))
203 /* Additional process state flags. */
204 if (!(p->p_flag & P_INMEM))
205 strlcat(state, "W", sizeof(state));
206 if (p->p_flag & P_TRACED)
207 strlcat(state, "X", sizeof(state));
208 if (p->p_flag & P_WEXIT && p->p_state != PRS_ZOMBIE)
209 strlcat(state, "E", sizeof(state));
210 if (p->p_flag & P_PPWAIT)
211 strlcat(state, "V", sizeof(state));
212 if (p->p_flag & P_SYSTEM || p->p_lock > 0)
213 strlcat(state, "L", sizeof(state));
214 if (p->p_pgrp != NULL && p->p_session != NULL &&
216 strlcat(state, "s", sizeof(state));
217 /* Cheated here and didn't compare pgid's. */
218 if (p->p_flag & P_CONTROLT)
219 strlcat(state, "+", sizeof(state));
220 if (cred != NULL && jailed(cred))
221 strlcat(state, "J", sizeof(state));
222 db_printf(" %-6.6s ", state);
223 if (p->p_flag & P_HADTHREADS) {
225 db_printf(" (threaded) ");
227 db_printf(" (threaded) ");
229 if (p->p_flag & P_SYSTEM)
231 db_printf("%s", p->p_comm);
232 if (p->p_flag & P_SYSTEM)
234 if (ps_mode == PRINT_ARGS) {
240 FOREACH_THREAD_IN_PROC(p, td) {
241 dumpthread(p, td, p->p_flag & P_HADTHREADS);
246 p = LIST_NEXT(p, p_list);
247 if (p == NULL && np > 0)
248 p = LIST_FIRST(&zombproc);
253 dumpthread(volatile struct proc *p, volatile struct thread *td, int all)
255 char state[9], wprefix;
260 db_printf("%6d ", td->td_tid);
261 switch (td->td_state) {
263 snprintf(state, sizeof(state), "Run");
266 snprintf(state, sizeof(state), "RunQ");
269 snprintf(state, sizeof(state), "CanRun");
272 snprintf(state, sizeof(state), "Inactv");
277 strlcat(state, "L", sizeof(state));
278 if (TD_IS_SLEEPING(td)) {
279 if (td->td_flags & TDF_SINTR)
280 strlcat(state, "S", sizeof(state));
282 strlcat(state, "D", sizeof(state));
284 if (TD_IS_SWAPPED(td))
285 strlcat(state, "W", sizeof(state));
286 if (TD_AWAITING_INTR(td))
287 strlcat(state, "I", sizeof(state));
288 if (TD_IS_SUSPENDED(td))
289 strlcat(state, "s", sizeof(state));
290 if (state[0] != '\0')
293 snprintf(state, sizeof(state), "???");
295 db_printf(" %-6.6s ", state);
298 if (TD_ON_LOCK(td)) {
300 wmesg = td->td_lockname;
301 wchan = td->td_blocked;
302 } else if (TD_ON_SLEEPQ(td)) {
303 wmesg = td->td_wmesg;
304 wchan = td->td_wchan;
305 } else if (TD_IS_RUNNING(td)) {
306 snprintf(state, sizeof(state), "CPU %d", td->td_oncpu);
313 db_printf("%c%-7.7s ", wprefix, wmesg);
316 db_printf("%18s ", "");
318 db_printf("%10s ", "");
321 db_printf("%p ", wchan);
322 if (p->p_flag & P_SYSTEM)
324 if (td->td_name[0] != '\0')
325 db_printf("%s", td->td_name);
327 db_printf("%s", td->td_proc->p_comm);
328 if (p->p_flag & P_SYSTEM)
330 if (ps_mode == PRINT_ARGS && all == 0) {
337 DB_SHOW_COMMAND(thread, db_show_thread)
340 struct lock_object *lock;
344 /* Determine which thread to examine. */
346 td = db_lookup_thread(addr, false);
349 lock = (struct lock_object *)td->td_lock;
351 db_printf("Thread %d at %p:\n", td->td_tid, td);
352 db_printf(" proc (pid %d): %p\n", td->td_proc->p_pid, td->td_proc);
353 if (td->td_name[0] != '\0')
354 db_printf(" name: %s\n", td->td_name);
355 db_printf(" stack: %p-%p\n", (void *)td->td_kstack,
356 (void *)(td->td_kstack + td->td_kstack_pages * PAGE_SIZE - 1));
357 db_printf(" flags: %#x ", td->td_flags);
358 db_printf(" pflags: %#x\n", td->td_pflags);
359 db_printf(" state: ");
360 switch (td->td_state) {
362 db_printf("INACTIVE\n");
365 db_printf("CAN RUN\n");
371 db_printf("RUNNING (CPU %d)\n", td->td_oncpu);
374 db_printf("INHIBITED: {");
376 if (TD_IS_SLEEPING(td)) {
377 db_printf("SLEEPING");
380 if (TD_IS_SUSPENDED(td)) {
383 db_printf("SUSPENDED");
386 if (TD_IS_SWAPPED(td)) {
389 db_printf("SWAPPED");
392 if (TD_ON_LOCK(td)) {
398 if (TD_AWAITING_INTR(td)) {
406 db_printf("??? (%#x)\n", td->td_state);
410 db_printf(" lock: %s turnstile: %p\n", td->td_lockname,
412 if (TD_ON_SLEEPQ(td))
414 " wmesg: %s wchan: %p sleeptimo %lx. %jx (curr %lx. %jx)\n",
415 td->td_wmesg, td->td_wchan,
416 (long)sbttobt(td->td_sleeptimo).sec,
417 (uintmax_t)sbttobt(td->td_sleeptimo).frac,
418 (long)sbttobt(sbinuptime()).sec,
419 (uintmax_t)sbttobt(sbinuptime()).frac);
420 db_printf(" priority: %d\n", td->td_priority);
421 db_printf(" container lock: %s (%p)\n", lock->lo_name, lock);
422 if (td->td_swvoltick != 0) {
423 delta = (u_int)ticks - (u_int)td->td_swvoltick;
424 db_printf(" last voluntary switch: %d ms ago\n",
427 if (td->td_swinvoltick != 0) {
428 delta = (u_int)ticks - (u_int)td->td_swinvoltick;
429 db_printf(" last involuntary switch: %d ms ago\n",
434 DB_SHOW_COMMAND(proc, db_show_proc)
440 /* Determine which process to examine. */
442 p = db_lookup_proc(addr);
444 p = kdb_thread->td_proc;
446 db_printf("Process %d (%s) at %p:\n", p->p_pid, p->p_comm, p);
447 db_printf(" state: ");
448 switch (p->p_state) {
453 db_printf("NORMAL\n");
456 db_printf("ZOMBIE\n");
459 db_printf("??? (%#x)\n", p->p_state);
461 if (p->p_ucred != NULL) {
462 db_printf(" uid: %d gids: ", p->p_ucred->cr_uid);
463 for (i = 0; i < p->p_ucred->cr_ngroups; i++) {
464 db_printf("%d", p->p_ucred->cr_groups[i]);
465 if (i < (p->p_ucred->cr_ngroups - 1))
470 if (p->p_pptr != NULL)
471 db_printf(" parent: pid %d at %p\n", p->p_pptr->p_pid,
473 if (p->p_leader != NULL && p->p_leader != p)
474 db_printf(" leader: pid %d at %p\n", p->p_leader->p_pid,
476 if (p->p_sysent != NULL)
477 db_printf(" ABI: %s\n", p->p_sysent->sv_name);
478 if (p->p_args != NULL) {
479 db_printf(" arguments: ");
483 db_printf(" repear: %p reapsubtree: %d\n",
484 p->p_reaper, p->p_reapsubtree);
485 db_printf(" sigparent: %d\n", p->p_sigparent);
486 db_printf(" vmspace: %p\n", p->p_vmspace);
487 db_printf(" (map %p)\n",
488 (p->p_vmspace != NULL) ? &p->p_vmspace->vm_map : 0);
489 db_printf(" (map.pmap %p)\n",
490 (p->p_vmspace != NULL) ? &p->p_vmspace->vm_map.pmap : 0);
491 db_printf(" (pmap %p)\n",
492 (p->p_vmspace != NULL) ? &p->p_vmspace->vm_pmap : 0);
493 db_printf(" threads: %d\n", p->p_numthreads);
494 FOREACH_THREAD_IN_PROC(p, td) {
495 dumpthread(p, td, 1);
502 db_findstack_cmd(db_expr_t addr, bool have_addr, db_expr_t dummy3 __unused,
503 char *dummy4 __unused)
507 struct kstack_cache_entry *ks_ce;
513 db_printf("Usage: findstack <address>\n");
517 FOREACH_PROC_IN_SYSTEM(p) {
518 FOREACH_THREAD_IN_PROC(p, td) {
519 if (td->td_kstack <= saddr && saddr < td->td_kstack +
520 PAGE_SIZE * td->td_kstack_pages) {
521 db_printf("Thread %p\n", td);
527 for (ks_ce = kstack_cache; ks_ce != NULL;
528 ks_ce = ks_ce->next_ks_entry) {
529 if ((vm_offset_t)ks_ce <= saddr && saddr < (vm_offset_t)ks_ce +
530 PAGE_SIZE * kstack_pages) {
531 db_printf("Cached stack %p\n", ks_ce);