xref: /freebsd/sys/ddb/db_ps.c (revision ea906c4152774dff300bb26fbfc1e4188351c89a)
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 <sys/param.h>
34 #include <sys/cons.h>
35 #include <sys/jail.h>
36 #include <sys/kdb.h>
37 #include <sys/linker_set.h>
38 #include <sys/proc.h>
39 #include <sys/sysent.h>
40 #include <sys/systm.h>
41 #include <vm/vm.h>
42 #include <vm/vm_param.h>
43 #include <vm/pmap.h>
44 
45 #include <ddb/ddb.h>
46 
47 static void	dumpthread(volatile struct proc *p, volatile struct thread *td,
48 		    int all);
49 /*
50  * At least one non-optional show-command must be implemented using
51  * DB_SHOW_ALL_COMMAND() so that db_show_all_cmd_set gets created.
52  * Here is one.
53  */
54 DB_SHOW_ALL_COMMAND(procs, db_procs_cmd)
55 {
56 	db_ps(addr, have_addr, count, modif);
57 }
58 
59 /*
60  * Layout:
61  * - column counts
62  * - header
63  * - single-threaded process
64  * - multi-threaded process
65  * - thread in a MT process
66  *
67  *          1         2         3         4         5         6         7
68  * 1234567890123456789012345678901234567890123456789012345678901234567890
69  *   pid  ppid  pgrp   uid   state   wmesg     wchan    cmd
70  * <pid> <ppi> <pgi> <uid>  <stat> < wmesg > < wchan  > <name>
71  * <pid> <ppi> <pgi> <uid>  <stat>  (threaded)          <command>
72  * <tid >                   <stat> < wmesg > < wchan  > <name>
73  *
74  * For machines with 64-bit pointers, we expand the wchan field 8 more
75  * characters.
76  */
77 void
78 db_ps(db_expr_t addr, boolean_t hasaddr, db_expr_t count, char *modif)
79 {
80 	volatile struct proc *p, *pp;
81 	volatile struct thread *td;
82 	struct ucred *cred;
83 	struct pgrp *pgrp;
84 	char state[9];
85 	int np, rflag, sflag, dflag, lflag, wflag;
86 
87 	np = nprocs;
88 
89 	if (!LIST_EMPTY(&allproc))
90 		p = LIST_FIRST(&allproc);
91 	else
92 		p = &proc0;
93 
94 #ifdef __LP64__
95 	db_printf("  pid  ppid  pgrp   uid   state   wmesg         wchan        cmd\n");
96 #else
97 	db_printf("  pid  ppid  pgrp   uid   state   wmesg     wchan    cmd\n");
98 #endif
99 	while (--np >= 0 && !db_pager_quit) {
100 		if (p == NULL) {
101 			db_printf("oops, ran out of processes early!\n");
102 			break;
103 		}
104 		pp = p->p_pptr;
105 		if (pp == NULL)
106 			pp = p;
107 
108 		cred = p->p_ucred;
109 		pgrp = p->p_pgrp;
110 		db_printf("%5d %5d %5d %5d ", p->p_pid, pp->p_pid,
111 		    pgrp != NULL ? pgrp->pg_id : 0,
112 		    cred != NULL ? cred->cr_ruid : 0);
113 
114 		/* Determine our primary process state. */
115 		switch (p->p_state) {
116 		case PRS_NORMAL:
117 			if (P_SHOULDSTOP(p))
118 				state[0] = 'T';
119 			else {
120 				/*
121 				 * One of D, L, R, S, W.  For a
122 				 * multithreaded process we will use
123 				 * the state of the thread with the
124 				 * highest precedence.  The
125 				 * precendence order from high to low
126 				 * is R, L, D, S, W.  If no thread is
127 				 * in a sane state we use '?' for our
128 				 * primary state.
129 				 */
130 				rflag = sflag = dflag = lflag = wflag = 0;
131 				FOREACH_THREAD_IN_PROC(p, td) {
132 					if (td->td_state == TDS_RUNNING ||
133 					    td->td_state == TDS_RUNQ ||
134 					    td->td_state == TDS_CAN_RUN)
135 						rflag++;
136 					if (TD_ON_LOCK(td))
137 						lflag++;
138 					if (TD_IS_SLEEPING(td)) {
139 						if (!td->td_flags & TDF_SINTR)
140 							dflag++;
141 						else
142 							sflag++;
143 					}
144 					if (TD_AWAITING_INTR(td))
145 						wflag++;
146 				}
147 				if (rflag)
148 					state[0] = 'R';
149 				else if (lflag)
150 					state[0] = 'L';
151 				else if (dflag)
152 					state[0] = 'D';
153 				else if (sflag)
154 					state[0] = 'S';
155 				else if (wflag)
156 					state[0] = 'W';
157 				else
158 					state[0] = '?';
159 			}
160 			break;
161 		case PRS_NEW:
162 			state[0] = 'N';
163 			break;
164 		case PRS_ZOMBIE:
165 			state[0] = 'Z';
166 			break;
167 		default:
168 			state[0] = 'U';
169 			break;
170 		}
171 		state[1] = '\0';
172 
173 		/* Additional process state flags. */
174 		if (!p->p_flag & P_INMEM)
175 			strlcat(state, "W", sizeof(state));
176 		if (p->p_flag & P_TRACED)
177 			strlcat(state, "X", sizeof(state));
178 		if (p->p_flag & P_WEXIT && p->p_state != PRS_ZOMBIE)
179 			strlcat(state, "E", sizeof(state));
180 		if (p->p_flag & P_PPWAIT)
181 			strlcat(state, "V", sizeof(state));
182 		if (p->p_flag & P_SYSTEM || p->p_lock > 0)
183 			strlcat(state, "L", sizeof(state));
184 		if (p->p_session != NULL && SESS_LEADER(p))
185 			strlcat(state, "s", sizeof(state));
186 		/* Cheated here and didn't compare pgid's. */
187 		if (p->p_flag & P_CONTROLT)
188 			strlcat(state, "+", sizeof(state));
189 		if (cred != NULL && jailed(cred))
190 			strlcat(state, "J", sizeof(state));
191 		db_printf(" %-6.6s ", state);
192 		if (p->p_flag & P_HADTHREADS)
193 #ifdef __LP64__
194 			db_printf(" (threaded)                  %s\n",
195 			    p->p_comm);
196 #else
197 			db_printf(" (threaded)          %s\n", p->p_comm);
198 #endif
199 		FOREACH_THREAD_IN_PROC(p, td) {
200 			dumpthread(p, td, p->p_flag & P_HADTHREADS);
201 			if (db_pager_quit)
202 				break;
203 		}
204 
205 		p = LIST_NEXT(p, p_list);
206 		if (p == NULL && np > 0)
207 			p = LIST_FIRST(&zombproc);
208     	}
209 }
210 
211 static void
212 dumpthread(volatile struct proc *p, volatile struct thread *td, int all)
213 {
214 	char state[9], wprefix;
215 	const char *wmesg;
216 	void *wchan;
217 
218 	if (all) {
219 		db_printf("%6d                  ", td->td_tid);
220 		switch (td->td_state) {
221 		case TDS_RUNNING:
222 			snprintf(state, sizeof(state), "Run");
223 			break;
224 		case TDS_RUNQ:
225 			snprintf(state, sizeof(state), "RunQ");
226 			break;
227 		case TDS_CAN_RUN:
228 			snprintf(state, sizeof(state), "CanRun");
229 			break;
230 		case TDS_INACTIVE:
231 			snprintf(state, sizeof(state), "Inactv");
232 			break;
233 		case TDS_INHIBITED:
234 			state[0] = '\0';
235 			if (TD_ON_LOCK(td))
236 				strlcat(state, "L", sizeof(state));
237 			if (TD_IS_SLEEPING(td)) {
238 				if (td->td_flags & TDF_SINTR)
239 					strlcat(state, "S", sizeof(state));
240 				else
241 					strlcat(state, "D", sizeof(state));
242 			}
243 			if (TD_IS_SWAPPED(td))
244 				strlcat(state, "W", sizeof(state));
245 			if (TD_AWAITING_INTR(td))
246 				strlcat(state, "I", sizeof(state));
247 			if (TD_IS_SUSPENDED(td))
248 				strlcat(state, "s", sizeof(state));
249 			if (state[0] != '\0')
250 				break;
251 		default:
252 			snprintf(state, sizeof(state), "???");
253 		}
254 		db_printf(" %-6.6s ", state);
255 	}
256 	wprefix = ' ';
257 	if (TD_ON_LOCK(td)) {
258 		wprefix = '*';
259 		wmesg = td->td_lockname;
260 		wchan = td->td_blocked;
261 	} else if (TD_ON_SLEEPQ(td)) {
262 		wmesg = td->td_wmesg;
263 		wchan = td->td_wchan;
264 	} else if (TD_IS_RUNNING(td)) {
265 		snprintf(state, sizeof(state), "CPU %d", td->td_oncpu);
266 		wmesg = state;
267 		wchan = NULL;
268 	} else {
269 		wmesg = "";
270 		wchan = NULL;
271 	}
272 	db_printf("%c%-8.8s ", wprefix, wmesg);
273 	if (wchan == NULL)
274 #ifdef __LP64__
275 		db_printf("%18s ", "");
276 #else
277 		db_printf("%10s ", "");
278 #endif
279 	else
280 		db_printf("%p ", wchan);
281 	if (p->p_flag & P_SYSTEM)
282 		db_printf("[");
283 	if (td->td_name[0] != '\0')
284 		db_printf("%s", td->td_name);
285 	else
286 		db_printf("%s", td->td_proc->p_comm);
287 	if (p->p_flag & P_SYSTEM)
288 		db_printf("]");
289 	db_printf("\n");
290 }
291 
292 DB_SHOW_COMMAND(thread, db_show_thread)
293 {
294 	struct thread *td;
295 	struct lock_object *lock;
296 	boolean_t comma;
297 
298 	/* Determine which thread to examine. */
299 	if (have_addr)
300 		td = db_lookup_thread(addr, FALSE);
301 	else
302 		td = kdb_thread;
303 	lock = (struct lock_object *)td->td_lock;
304 
305 	db_printf("Thread %d at %p:\n", td->td_tid, td);
306 	db_printf(" proc (pid %d): %p\n", td->td_proc->p_pid, td->td_proc);
307 	if (td->td_name[0] != '\0')
308 		db_printf(" name: %s\n", td->td_name);
309 	db_printf(" stack: %p-%p\n", (void *)td->td_kstack,
310 	    (void *)(td->td_kstack + td->td_kstack_pages * PAGE_SIZE - 1));
311 	db_printf(" flags: %#x ", td->td_flags);
312 	db_printf(" pflags: %#x\n", td->td_pflags);
313 	db_printf(" state: ");
314 	switch (td->td_state) {
315 	case TDS_INACTIVE:
316 		db_printf("INACTIVE\n");
317 		break;
318 	case TDS_CAN_RUN:
319 		db_printf("CAN RUN\n");
320 		break;
321 	case TDS_RUNQ:
322 		db_printf("RUNQ\n");
323 		break;
324 	case TDS_RUNNING:
325 		db_printf("RUNNING (CPU %d)\n", td->td_oncpu);
326 		break;
327 	case TDS_INHIBITED:
328 		db_printf("INHIBITED: {");
329 		comma = FALSE;
330 		if (TD_IS_SLEEPING(td)) {
331 			db_printf("SLEEPING");
332 			comma = TRUE;
333 		}
334 		if (TD_IS_SUSPENDED(td)) {
335 			if (comma)
336 				db_printf(", ");
337 			db_printf("SUSPENDED");
338 			comma = TRUE;
339 		}
340 		if (TD_IS_SWAPPED(td)) {
341 			if (comma)
342 				db_printf(", ");
343 			db_printf("SWAPPED");
344 			comma = TRUE;
345 		}
346 		if (TD_ON_LOCK(td)) {
347 			if (comma)
348 				db_printf(", ");
349 			db_printf("LOCK");
350 			comma = TRUE;
351 		}
352 		if (TD_AWAITING_INTR(td)) {
353 			if (comma)
354 				db_printf(", ");
355 			db_printf("IWAIT");
356 		}
357 		db_printf("}\n");
358 		break;
359 	default:
360 		db_printf("??? (%#x)\n", td->td_state);
361 		break;
362 	}
363 	if (TD_ON_LOCK(td))
364 		db_printf(" lock: %s  turnstile: %p\n", td->td_lockname,
365 		    td->td_blocked);
366 	if (TD_ON_SLEEPQ(td))
367 		db_printf(" wmesg: %s  wchan: %p\n", td->td_wmesg,
368 		    td->td_wchan);
369 	db_printf(" priority: %d\n", td->td_priority);
370 	db_printf(" container lock: %s (%p)\n", lock->lo_name, lock);
371 }
372 
373 DB_SHOW_COMMAND(proc, db_show_proc)
374 {
375 	struct thread *td;
376 	struct proc *p;
377 	int i;
378 
379 	/* Determine which process to examine. */
380 	if (have_addr)
381 		p = db_lookup_proc(addr);
382 	else
383 		p = kdb_thread->td_proc;
384 
385 	db_printf("Process %d (%s) at %p:\n", p->p_pid, p->p_comm, p);
386 	db_printf(" state: ");
387 	switch (p->p_state) {
388 	case PRS_NEW:
389 		db_printf("NEW\n");
390 		break;
391 	case PRS_NORMAL:
392 		db_printf("NORMAL\n");
393 		break;
394 	case PRS_ZOMBIE:
395 		db_printf("ZOMBIE\n");
396 		break;
397 	default:
398 		db_printf("??? (%#x)\n", p->p_state);
399 	}
400 	if (p->p_ucred != NULL) {
401 		db_printf(" uid: %d  gids: ", p->p_ucred->cr_uid);
402 		for (i = 0; i < p->p_ucred->cr_ngroups; i++) {
403 			db_printf("%d", p->p_ucred->cr_groups[i]);
404 			if (i < (p->p_ucred->cr_ngroups - 1))
405 				db_printf(", ");
406 		}
407 		db_printf("\n");
408 	}
409 	if (p->p_pptr != NULL)
410 		db_printf(" parent: pid %d at %p\n", p->p_pptr->p_pid,
411 		    p->p_pptr);
412 	if (p->p_leader != NULL && p->p_leader != p)
413 		db_printf(" leader: pid %d at %p\n", p->p_leader->p_pid,
414 		    p->p_leader);
415 	if (p->p_sysent != NULL)
416 		db_printf(" ABI: %s\n", p->p_sysent->sv_name);
417 	if (p->p_args != NULL)
418 		db_printf(" arguments: %.*s\n", (int)p->p_args->ar_length,
419 		    p->p_args->ar_args);
420 	db_printf(" threads: %d\n", p->p_numthreads);
421 	FOREACH_THREAD_IN_PROC(p, td) {
422 		dumpthread(p, td, 1);
423 		if (db_pager_quit)
424 			break;
425 	}
426 }
427