xref: /freebsd/sys/ddb/db_thread.c (revision eb69d1f144a6fcc765d1b9d44a5ae8082353e70b)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3  *
4  * Copyright (c) 2004 Marcel Moolenaar
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28 
29 #include <sys/cdefs.h>
30 __FBSDID("$FreeBSD$");
31 
32 #include <sys/param.h>
33 #include <sys/systm.h>
34 #include <sys/kdb.h>
35 #include <sys/proc.h>
36 
37 #include <machine/pcb.h>
38 
39 #include <ddb/ddb.h>
40 #include <ddb/db_command.h>
41 #include <ddb/db_sym.h>
42 
43 void
44 db_print_thread(void)
45 {
46 	pid_t pid;
47 
48 	pid = -1;
49 	if (kdb_thread->td_proc != NULL)
50 		pid = kdb_thread->td_proc->p_pid;
51 	db_printf("[ thread pid %d tid %ld ]\n", pid, (long)kdb_thread->td_tid);
52 }
53 
54 void
55 db_set_thread(db_expr_t tid, bool hastid, db_expr_t cnt, char *mod)
56 {
57 	struct thread *thr;
58 	db_expr_t radix;
59 	int err;
60 
61 	/*
62 	 * We parse our own arguments. We don't like the default radix.
63 	 */
64 	radix = db_radix;
65 	db_radix = 10;
66 	hastid = db_expression(&tid);
67 	db_radix = radix;
68 	db_skip_to_eol();
69 
70 	if (hastid) {
71 		thr = kdb_thr_lookup(tid);
72 		if (thr != NULL) {
73 			err = kdb_thr_select(thr);
74 			if (err != 0) {
75 				db_printf("unable to switch to thread %ld\n",
76 				    (long)thr->td_tid);
77 				return;
78 			}
79 			db_dot = PC_REGS();
80 		} else {
81 			db_printf("%d: invalid thread\n", (int)tid);
82 			return;
83 		}
84 	}
85 
86 	db_print_thread();
87 	db_print_loc_and_inst(PC_REGS());
88 }
89 
90 void
91 db_show_threads(db_expr_t addr, bool hasaddr, db_expr_t cnt, char *mod)
92 {
93 	jmp_buf jb;
94 	void *prev_jb;
95 	struct thread *thr;
96 
97 	thr = kdb_thr_first();
98 	while (!db_pager_quit && thr != NULL) {
99 		db_printf("  %6ld (%p) (stack %p)  ", (long)thr->td_tid, thr,
100 		    (void *)thr->td_kstack);
101 		prev_jb = kdb_jmpbuf(jb);
102 		if (setjmp(jb) == 0) {
103 			if (db_trace_thread(thr, 1) != 0)
104 				db_printf("***\n");
105 		}
106 		kdb_jmpbuf(prev_jb);
107 		thr = kdb_thr_next(thr);
108 	}
109 }
110 
111 /*
112  * Lookup a thread based on a db expression address.  We assume that the
113  * address was parsed in hexadecimal.  We reparse the address in decimal
114  * first and try to treat it as a thread ID to find an associated thread.
115  * If that fails and check_pid is true, we treat the decimal value as a
116  * PID.  If that matches a process, we return the first thread in that
117  * process.  Otherwise, we treat the addr as a pointer to a thread.
118  */
119 struct thread *
120 db_lookup_thread(db_expr_t addr, bool check_pid)
121 {
122 	struct thread *td;
123 	db_expr_t decaddr;
124 	struct proc *p;
125 
126 	/*
127 	 * If the parsed address was not a valid decimal expression,
128 	 * assume it is a thread pointer.
129 	 */
130 	decaddr = db_hex2dec(addr);
131 	if (decaddr == -1)
132 		return ((struct thread *)addr);
133 
134 	td = kdb_thr_lookup(decaddr);
135 	if (td != NULL)
136 		return (td);
137 	if (check_pid) {
138 		FOREACH_PROC_IN_SYSTEM(p) {
139 			if (p->p_pid == decaddr)
140 				return (FIRST_THREAD_IN_PROC(p));
141 		}
142 		LIST_FOREACH(p, &zombproc, p_list) {
143 			if (p->p_pid == decaddr)
144 				return (FIRST_THREAD_IN_PROC(p));
145 		}
146 	}
147 	return ((struct thread *)addr);
148 }
149 
150 /*
151  * Lookup a process based on a db expression address.  We assume that the
152  * address was parsed in hexadecimal.  We reparse the address in decimal
153  * first and try to treat it as a PID to find an associated process.
154  * If that fails we treat the addr as a pointer to a process.
155  */
156 struct proc *
157 db_lookup_proc(db_expr_t addr)
158 {
159 	db_expr_t decaddr;
160 	struct proc *p;
161 
162 	decaddr = db_hex2dec(addr);
163 	if (decaddr != -1) {
164 		FOREACH_PROC_IN_SYSTEM(p) {
165 			if (p->p_pid == decaddr)
166 				return (p);
167 		}
168 		LIST_FOREACH(p, &zombproc, p_list) {
169 			if (p->p_pid == decaddr)
170 				return (p);
171 		}
172 	}
173 	return ((struct proc *)addr);
174 }
175