xref: /freebsd/sys/ddb/db_ps.c (revision 90d30dd1a9dc7f1dc7ef75e86a85f732754dd9d7)
1 /*-
2  * Copyright (c) 1993 The Regents of the University of California.
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, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 4. Neither the name of the University nor the names of its contributors
14  *    may be used to endorse or promote products derived from this software
15  *    without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  */
29 
30 #include <sys/cdefs.h>
31 __FBSDID("$FreeBSD$");
32 
33 #include "opt_kstack_pages.h"
34 
35 #include <sys/param.h>
36 #include <sys/cons.h>
37 #include <sys/jail.h>
38 #include <sys/kdb.h>
39 #include <sys/kernel.h>
40 #include <sys/proc.h>
41 #include <sys/sysent.h>
42 #include <sys/systm.h>
43 #include <sys/_kstack_cache.h>
44 #include <vm/vm.h>
45 #include <vm/vm_param.h>
46 #include <vm/pmap.h>
47 
48 #include <ddb/ddb.h>
49 
50 static void	dumpthread(volatile struct proc *p, volatile struct thread *td,
51 		    int all);
52 /*
53  * At least one non-optional show-command must be implemented using
54  * DB_SHOW_ALL_COMMAND() so that db_show_all_cmd_set gets created.
55  * Here is one.
56  */
57 DB_SHOW_ALL_COMMAND(procs, db_procs_cmd)
58 {
59 	db_ps(addr, have_addr, count, modif);
60 }
61 
62 /*
63  * Layout:
64  * - column counts
65  * - header
66  * - single-threaded process
67  * - multi-threaded process
68  * - thread in a MT process
69  *
70  *          1         2         3         4         5         6         7
71  * 1234567890123456789012345678901234567890123456789012345678901234567890
72  *   pid  ppid  pgrp   uid   state   wmesg     wchan    cmd
73  * <pid> <ppi> <pgi> <uid>  <stat> < wmesg > < wchan  > <name>
74  * <pid> <ppi> <pgi> <uid>  <stat>  (threaded)          <command>
75  * <tid >                   <stat> < wmesg > < wchan  > <name>
76  *
77  * For machines with 64-bit pointers, we expand the wchan field 8 more
78  * characters.
79  */
80 void
81 db_ps(db_expr_t addr, bool hasaddr, db_expr_t count, char *modif)
82 {
83 	volatile struct proc *p, *pp;
84 	volatile struct thread *td;
85 	struct ucred *cred;
86 	struct pgrp *pgrp;
87 	char state[9];
88 	int np, rflag, sflag, dflag, lflag, wflag;
89 
90 	np = nprocs;
91 
92 	if (!LIST_EMPTY(&allproc))
93 		p = LIST_FIRST(&allproc);
94 	else
95 		p = &proc0;
96 
97 #ifdef __LP64__
98 	db_printf("  pid  ppid  pgrp   uid   state   wmesg         wchan        cmd\n");
99 #else
100 	db_printf("  pid  ppid  pgrp   uid   state   wmesg     wchan    cmd\n");
101 #endif
102 	while (--np >= 0 && !db_pager_quit) {
103 		if (p == NULL) {
104 			db_printf("oops, ran out of processes early!\n");
105 			break;
106 		}
107 		pp = p->p_pptr;
108 		if (pp == NULL)
109 			pp = p;
110 
111 		cred = p->p_ucred;
112 		pgrp = p->p_pgrp;
113 		db_printf("%5d %5d %5d %5d ", p->p_pid, pp->p_pid,
114 		    pgrp != NULL ? pgrp->pg_id : 0,
115 		    cred != NULL ? cred->cr_ruid : 0);
116 
117 		/* Determine our primary process state. */
118 		switch (p->p_state) {
119 		case PRS_NORMAL:
120 			if (P_SHOULDSTOP(p))
121 				state[0] = 'T';
122 			else {
123 				/*
124 				 * One of D, L, R, S, W.  For a
125 				 * multithreaded process we will use
126 				 * the state of the thread with the
127 				 * highest precedence.  The
128 				 * precendence order from high to low
129 				 * is R, L, D, S, W.  If no thread is
130 				 * in a sane state we use '?' for our
131 				 * primary state.
132 				 */
133 				rflag = sflag = dflag = lflag = wflag = 0;
134 				FOREACH_THREAD_IN_PROC(p, td) {
135 					if (td->td_state == TDS_RUNNING ||
136 					    td->td_state == TDS_RUNQ ||
137 					    td->td_state == TDS_CAN_RUN)
138 						rflag++;
139 					if (TD_ON_LOCK(td))
140 						lflag++;
141 					if (TD_IS_SLEEPING(td)) {
142 						if (!(td->td_flags & TDF_SINTR))
143 							dflag++;
144 						else
145 							sflag++;
146 					}
147 					if (TD_AWAITING_INTR(td))
148 						wflag++;
149 				}
150 				if (rflag)
151 					state[0] = 'R';
152 				else if (lflag)
153 					state[0] = 'L';
154 				else if (dflag)
155 					state[0] = 'D';
156 				else if (sflag)
157 					state[0] = 'S';
158 				else if (wflag)
159 					state[0] = 'W';
160 				else
161 					state[0] = '?';
162 			}
163 			break;
164 		case PRS_NEW:
165 			state[0] = 'N';
166 			break;
167 		case PRS_ZOMBIE:
168 			state[0] = 'Z';
169 			break;
170 		default:
171 			state[0] = 'U';
172 			break;
173 		}
174 		state[1] = '\0';
175 
176 		/* Additional process state flags. */
177 		if (!(p->p_flag & P_INMEM))
178 			strlcat(state, "W", sizeof(state));
179 		if (p->p_flag & P_TRACED)
180 			strlcat(state, "X", sizeof(state));
181 		if (p->p_flag & P_WEXIT && p->p_state != PRS_ZOMBIE)
182 			strlcat(state, "E", sizeof(state));
183 		if (p->p_flag & P_PPWAIT)
184 			strlcat(state, "V", sizeof(state));
185 		if (p->p_flag & P_SYSTEM || p->p_lock > 0)
186 			strlcat(state, "L", sizeof(state));
187 		if (p->p_session != NULL && SESS_LEADER(p))
188 			strlcat(state, "s", sizeof(state));
189 		/* Cheated here and didn't compare pgid's. */
190 		if (p->p_flag & P_CONTROLT)
191 			strlcat(state, "+", sizeof(state));
192 		if (cred != NULL && jailed(cred))
193 			strlcat(state, "J", sizeof(state));
194 		db_printf(" %-6.6s ", state);
195 		if (p->p_flag & P_HADTHREADS) {
196 #ifdef __LP64__
197 			db_printf(" (threaded)                  ");
198 #else
199 			db_printf(" (threaded)          ");
200 #endif
201 			if (p->p_flag & P_SYSTEM)
202 				db_printf("[");
203 			db_printf("%s", p->p_comm);
204 			if (p->p_flag & P_SYSTEM)
205 				db_printf("]");
206 			db_printf("\n");
207 		}
208 		FOREACH_THREAD_IN_PROC(p, td) {
209 			dumpthread(p, td, p->p_flag & P_HADTHREADS);
210 			if (db_pager_quit)
211 				break;
212 		}
213 
214 		p = LIST_NEXT(p, p_list);
215 		if (p == NULL && np > 0)
216 			p = LIST_FIRST(&zombproc);
217 	}
218 }
219 
220 static void
221 dumpthread(volatile struct proc *p, volatile struct thread *td, int all)
222 {
223 	char state[9], wprefix;
224 	const char *wmesg;
225 	void *wchan;
226 
227 	if (all) {
228 		db_printf("%6d                  ", td->td_tid);
229 		switch (td->td_state) {
230 		case TDS_RUNNING:
231 			snprintf(state, sizeof(state), "Run");
232 			break;
233 		case TDS_RUNQ:
234 			snprintf(state, sizeof(state), "RunQ");
235 			break;
236 		case TDS_CAN_RUN:
237 			snprintf(state, sizeof(state), "CanRun");
238 			break;
239 		case TDS_INACTIVE:
240 			snprintf(state, sizeof(state), "Inactv");
241 			break;
242 		case TDS_INHIBITED:
243 			state[0] = '\0';
244 			if (TD_ON_LOCK(td))
245 				strlcat(state, "L", sizeof(state));
246 			if (TD_IS_SLEEPING(td)) {
247 				if (td->td_flags & TDF_SINTR)
248 					strlcat(state, "S", sizeof(state));
249 				else
250 					strlcat(state, "D", sizeof(state));
251 			}
252 			if (TD_IS_SWAPPED(td))
253 				strlcat(state, "W", sizeof(state));
254 			if (TD_AWAITING_INTR(td))
255 				strlcat(state, "I", sizeof(state));
256 			if (TD_IS_SUSPENDED(td))
257 				strlcat(state, "s", sizeof(state));
258 			if (state[0] != '\0')
259 				break;
260 		default:
261 			snprintf(state, sizeof(state), "???");
262 		}
263 		db_printf(" %-6.6s ", state);
264 	}
265 	wprefix = ' ';
266 	if (TD_ON_LOCK(td)) {
267 		wprefix = '*';
268 		wmesg = td->td_lockname;
269 		wchan = td->td_blocked;
270 	} else if (TD_ON_SLEEPQ(td)) {
271 		wmesg = td->td_wmesg;
272 		wchan = td->td_wchan;
273 	} else if (TD_IS_RUNNING(td)) {
274 		snprintf(state, sizeof(state), "CPU %d", td->td_oncpu);
275 		wmesg = state;
276 		wchan = NULL;
277 	} else {
278 		wmesg = "";
279 		wchan = NULL;
280 	}
281 	db_printf("%c%-8.8s ", wprefix, wmesg);
282 	if (wchan == NULL)
283 #ifdef __LP64__
284 		db_printf("%18s ", "");
285 #else
286 		db_printf("%10s ", "");
287 #endif
288 	else
289 		db_printf("%p ", wchan);
290 	if (p->p_flag & P_SYSTEM)
291 		db_printf("[");
292 	if (td->td_name[0] != '\0')
293 		db_printf("%s", td->td_name);
294 	else
295 		db_printf("%s", td->td_proc->p_comm);
296 	if (p->p_flag & P_SYSTEM)
297 		db_printf("]");
298 	db_printf("\n");
299 }
300 
301 DB_SHOW_COMMAND(thread, db_show_thread)
302 {
303 	struct thread *td;
304 	struct lock_object *lock;
305 	bool comma;
306 	int delta;
307 
308 	/* Determine which thread to examine. */
309 	if (have_addr)
310 		td = db_lookup_thread(addr, false);
311 	else
312 		td = kdb_thread;
313 	lock = (struct lock_object *)td->td_lock;
314 
315 	db_printf("Thread %d at %p:\n", td->td_tid, td);
316 	db_printf(" proc (pid %d): %p\n", td->td_proc->p_pid, td->td_proc);
317 	if (td->td_name[0] != '\0')
318 		db_printf(" name: %s\n", td->td_name);
319 	db_printf(" stack: %p-%p\n", (void *)td->td_kstack,
320 	    (void *)(td->td_kstack + td->td_kstack_pages * PAGE_SIZE - 1));
321 	db_printf(" flags: %#x ", td->td_flags);
322 	db_printf(" pflags: %#x\n", td->td_pflags);
323 	db_printf(" state: ");
324 	switch (td->td_state) {
325 	case TDS_INACTIVE:
326 		db_printf("INACTIVE\n");
327 		break;
328 	case TDS_CAN_RUN:
329 		db_printf("CAN RUN\n");
330 		break;
331 	case TDS_RUNQ:
332 		db_printf("RUNQ\n");
333 		break;
334 	case TDS_RUNNING:
335 		db_printf("RUNNING (CPU %d)\n", td->td_oncpu);
336 		break;
337 	case TDS_INHIBITED:
338 		db_printf("INHIBITED: {");
339 		comma = false;
340 		if (TD_IS_SLEEPING(td)) {
341 			db_printf("SLEEPING");
342 			comma = true;
343 		}
344 		if (TD_IS_SUSPENDED(td)) {
345 			if (comma)
346 				db_printf(", ");
347 			db_printf("SUSPENDED");
348 			comma = true;
349 		}
350 		if (TD_IS_SWAPPED(td)) {
351 			if (comma)
352 				db_printf(", ");
353 			db_printf("SWAPPED");
354 			comma = true;
355 		}
356 		if (TD_ON_LOCK(td)) {
357 			if (comma)
358 				db_printf(", ");
359 			db_printf("LOCK");
360 			comma = true;
361 		}
362 		if (TD_AWAITING_INTR(td)) {
363 			if (comma)
364 				db_printf(", ");
365 			db_printf("IWAIT");
366 		}
367 		db_printf("}\n");
368 		break;
369 	default:
370 		db_printf("??? (%#x)\n", td->td_state);
371 		break;
372 	}
373 	if (TD_ON_LOCK(td))
374 		db_printf(" lock: %s  turnstile: %p\n", td->td_lockname,
375 		    td->td_blocked);
376 	if (TD_ON_SLEEPQ(td))
377 		db_printf(" wmesg: %s  wchan: %p\n", td->td_wmesg,
378 		    td->td_wchan);
379 	db_printf(" priority: %d\n", td->td_priority);
380 	db_printf(" container lock: %s (%p)\n", lock->lo_name, lock);
381 	if (td->td_swvoltick != 0) {
382 		delta = (u_int)ticks - (u_int)td->td_swvoltick;
383 		db_printf(" last voluntary switch: %d ms ago\n",
384 		    1000 * delta / hz);
385 	}
386 	if (td->td_swinvoltick != 0) {
387 		delta = (u_int)ticks - (u_int)td->td_swinvoltick;
388 		db_printf(" last involuntary switch: %d ms ago\n",
389 		    1000 * delta / hz);
390 	}
391 }
392 
393 DB_SHOW_COMMAND(proc, db_show_proc)
394 {
395 	struct thread *td;
396 	struct proc *p;
397 	int i;
398 
399 	/* Determine which process to examine. */
400 	if (have_addr)
401 		p = db_lookup_proc(addr);
402 	else
403 		p = kdb_thread->td_proc;
404 
405 	db_printf("Process %d (%s) at %p:\n", p->p_pid, p->p_comm, p);
406 	db_printf(" state: ");
407 	switch (p->p_state) {
408 	case PRS_NEW:
409 		db_printf("NEW\n");
410 		break;
411 	case PRS_NORMAL:
412 		db_printf("NORMAL\n");
413 		break;
414 	case PRS_ZOMBIE:
415 		db_printf("ZOMBIE\n");
416 		break;
417 	default:
418 		db_printf("??? (%#x)\n", p->p_state);
419 	}
420 	if (p->p_ucred != NULL) {
421 		db_printf(" uid: %d  gids: ", p->p_ucred->cr_uid);
422 		for (i = 0; i < p->p_ucred->cr_ngroups; i++) {
423 			db_printf("%d", p->p_ucred->cr_groups[i]);
424 			if (i < (p->p_ucred->cr_ngroups - 1))
425 				db_printf(", ");
426 		}
427 		db_printf("\n");
428 	}
429 	if (p->p_pptr != NULL)
430 		db_printf(" parent: pid %d at %p\n", p->p_pptr->p_pid,
431 		    p->p_pptr);
432 	if (p->p_leader != NULL && p->p_leader != p)
433 		db_printf(" leader: pid %d at %p\n", p->p_leader->p_pid,
434 		    p->p_leader);
435 	if (p->p_sysent != NULL)
436 		db_printf(" ABI: %s\n", p->p_sysent->sv_name);
437 	if (p->p_args != NULL)
438 		db_printf(" arguments: %.*s\n", (int)p->p_args->ar_length,
439 		    p->p_args->ar_args);
440 	db_printf(" threads: %d\n", p->p_numthreads);
441 	FOREACH_THREAD_IN_PROC(p, td) {
442 		dumpthread(p, td, 1);
443 		if (db_pager_quit)
444 			break;
445 	}
446 }
447 
448 void
449 db_findstack_cmd(db_expr_t addr, bool have_addr, db_expr_t dummy3 __unused,
450     char *dummy4 __unused)
451 {
452 	struct proc *p;
453 	struct thread *td;
454 	struct kstack_cache_entry *ks_ce;
455 	vm_offset_t saddr;
456 
457 	if (have_addr)
458 		saddr = addr;
459 	else {
460 		db_printf("Usage: findstack <address>\n");
461 		return;
462 	}
463 
464 	FOREACH_PROC_IN_SYSTEM(p) {
465 		FOREACH_THREAD_IN_PROC(p, td) {
466 			if (td->td_kstack <= saddr && saddr < td->td_kstack +
467 			    PAGE_SIZE * td->td_kstack_pages) {
468 				db_printf("Thread %p\n", td);
469 				return;
470 			}
471 		}
472 	}
473 
474 	for (ks_ce = kstack_cache; ks_ce != NULL;
475 	     ks_ce = ks_ce->next_ks_entry) {
476 		if ((vm_offset_t)ks_ce <= saddr && saddr < (vm_offset_t)ks_ce +
477 		    PAGE_SIZE * kstack_pages) {
478 			db_printf("Cached stack %p\n", ks_ce);
479 			return;
480 		}
481 	}
482 }
483