xref: /onnv-gate/usr/src/cmd/mdb/common/modules/genunix/findstack_subr.c (revision 12902:3bb859a7330c)
1*12902SBryan.Cantrill@Sun.COM /*
2*12902SBryan.Cantrill@Sun.COM  * CDDL HEADER START
3*12902SBryan.Cantrill@Sun.COM  *
4*12902SBryan.Cantrill@Sun.COM  * The contents of this file are subject to the terms of the
5*12902SBryan.Cantrill@Sun.COM  * Common Development and Distribution License (the "License").
6*12902SBryan.Cantrill@Sun.COM  * You may not use this file except in compliance with the License.
7*12902SBryan.Cantrill@Sun.COM  *
8*12902SBryan.Cantrill@Sun.COM  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9*12902SBryan.Cantrill@Sun.COM  * or http://www.opensolaris.org/os/licensing.
10*12902SBryan.Cantrill@Sun.COM  * See the License for the specific language governing permissions
11*12902SBryan.Cantrill@Sun.COM  * and limitations under the License.
12*12902SBryan.Cantrill@Sun.COM  *
13*12902SBryan.Cantrill@Sun.COM  * When distributing Covered Code, include this CDDL HEADER in each
14*12902SBryan.Cantrill@Sun.COM  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15*12902SBryan.Cantrill@Sun.COM  * If applicable, add the following below this CDDL HEADER, with the
16*12902SBryan.Cantrill@Sun.COM  * fields enclosed by brackets "[]" replaced with your own identifying
17*12902SBryan.Cantrill@Sun.COM  * information: Portions Copyright [yyyy] [name of copyright owner]
18*12902SBryan.Cantrill@Sun.COM  *
19*12902SBryan.Cantrill@Sun.COM  * CDDL HEADER END
20*12902SBryan.Cantrill@Sun.COM  */
21*12902SBryan.Cantrill@Sun.COM 
22*12902SBryan.Cantrill@Sun.COM /*
23*12902SBryan.Cantrill@Sun.COM  * Copyright (c) 2010, Oracle and/or its affiliates. All rights reserved.
24*12902SBryan.Cantrill@Sun.COM  */
25*12902SBryan.Cantrill@Sun.COM 
26*12902SBryan.Cantrill@Sun.COM #include <mdb/mdb_modapi.h>
27*12902SBryan.Cantrill@Sun.COM #include <mdb/mdb_ctf.h>
28*12902SBryan.Cantrill@Sun.COM 
29*12902SBryan.Cantrill@Sun.COM #include <sys/types.h>
30*12902SBryan.Cantrill@Sun.COM #include <sys/regset.h>
31*12902SBryan.Cantrill@Sun.COM #include <sys/stack.h>
32*12902SBryan.Cantrill@Sun.COM #include <sys/thread.h>
33*12902SBryan.Cantrill@Sun.COM #include <sys/modctl.h>
34*12902SBryan.Cantrill@Sun.COM 
35*12902SBryan.Cantrill@Sun.COM #include "findstack.h"
36*12902SBryan.Cantrill@Sun.COM #include "thread.h"
37*12902SBryan.Cantrill@Sun.COM #include "sobj.h"
38*12902SBryan.Cantrill@Sun.COM 
39*12902SBryan.Cantrill@Sun.COM #define	TOO_BIG_FOR_A_STACK (1024 * 1024)
40*12902SBryan.Cantrill@Sun.COM 
41*12902SBryan.Cantrill@Sun.COM #define	KTOU(p) ((p) - kbase + ubase)
42*12902SBryan.Cantrill@Sun.COM #define	UTOK(p) ((p) - ubase + kbase)
43*12902SBryan.Cantrill@Sun.COM 
44*12902SBryan.Cantrill@Sun.COM #define	CRAWL_FOUNDALL	(-1)
45*12902SBryan.Cantrill@Sun.COM 
46*12902SBryan.Cantrill@Sun.COM #if defined(__i386) || defined(__amd64)
47*12902SBryan.Cantrill@Sun.COM struct rwindow {
48*12902SBryan.Cantrill@Sun.COM 	uintptr_t rw_fp;
49*12902SBryan.Cantrill@Sun.COM 	uintptr_t rw_rtn;
50*12902SBryan.Cantrill@Sun.COM };
51*12902SBryan.Cantrill@Sun.COM #endif
52*12902SBryan.Cantrill@Sun.COM 
53*12902SBryan.Cantrill@Sun.COM #ifndef STACK_BIAS
54*12902SBryan.Cantrill@Sun.COM #define	STACK_BIAS	0
55*12902SBryan.Cantrill@Sun.COM #endif
56*12902SBryan.Cantrill@Sun.COM 
57*12902SBryan.Cantrill@Sun.COM /*
58*12902SBryan.Cantrill@Sun.COM  * Given a stack pointer, try to crawl down it to the bottom.
59*12902SBryan.Cantrill@Sun.COM  * "frame" is a VA in MDB's address space.
60*12902SBryan.Cantrill@Sun.COM  *
61*12902SBryan.Cantrill@Sun.COM  * Returns the number of frames successfully crawled down, or
62*12902SBryan.Cantrill@Sun.COM  * CRAWL_FOUNDALL if it got to the bottom of the stack.
63*12902SBryan.Cantrill@Sun.COM  */
64*12902SBryan.Cantrill@Sun.COM static int
crawl(uintptr_t frame,uintptr_t kbase,uintptr_t ktop,uintptr_t ubase,int kill_fp,findstack_info_t * fsip)65*12902SBryan.Cantrill@Sun.COM crawl(uintptr_t frame, uintptr_t kbase, uintptr_t ktop, uintptr_t ubase,
66*12902SBryan.Cantrill@Sun.COM     int kill_fp, findstack_info_t *fsip)
67*12902SBryan.Cantrill@Sun.COM {
68*12902SBryan.Cantrill@Sun.COM 	int levels = 0;
69*12902SBryan.Cantrill@Sun.COM 
70*12902SBryan.Cantrill@Sun.COM 	fsip->fsi_depth = 0;
71*12902SBryan.Cantrill@Sun.COM 	fsip->fsi_overflow = 0;
72*12902SBryan.Cantrill@Sun.COM 
73*12902SBryan.Cantrill@Sun.COM 	fs_dprintf(("<0> frame = %p, kbase = %p, ktop = %p, ubase = %p\n",
74*12902SBryan.Cantrill@Sun.COM 	    frame, kbase, ktop, ubase));
75*12902SBryan.Cantrill@Sun.COM 	for (;;) {
76*12902SBryan.Cantrill@Sun.COM 		uintptr_t fp;
77*12902SBryan.Cantrill@Sun.COM 		long *fpp = (long *)&((struct rwindow *)frame)->rw_fp;
78*12902SBryan.Cantrill@Sun.COM 
79*12902SBryan.Cantrill@Sun.COM 		fs_dprintf(("<1> fpp = %p, frame = %p\n", fpp, frame));
80*12902SBryan.Cantrill@Sun.COM 
81*12902SBryan.Cantrill@Sun.COM 		if ((frame & (STACK_ALIGN - 1)) != 0)
82*12902SBryan.Cantrill@Sun.COM 			break;
83*12902SBryan.Cantrill@Sun.COM 
84*12902SBryan.Cantrill@Sun.COM 		fp = ((struct rwindow *)frame)->rw_fp + STACK_BIAS;
85*12902SBryan.Cantrill@Sun.COM 		if (fsip->fsi_depth < fsip->fsi_max_depth)
86*12902SBryan.Cantrill@Sun.COM 			fsip->fsi_stack[fsip->fsi_depth++] =
87*12902SBryan.Cantrill@Sun.COM 			    ((struct rwindow *)frame)->rw_rtn;
88*12902SBryan.Cantrill@Sun.COM 		else
89*12902SBryan.Cantrill@Sun.COM 			fsip->fsi_overflow = 1;
90*12902SBryan.Cantrill@Sun.COM 
91*12902SBryan.Cantrill@Sun.COM 		fs_dprintf(("<2> fp = %p\n", fp));
92*12902SBryan.Cantrill@Sun.COM 
93*12902SBryan.Cantrill@Sun.COM 		if (fp == ktop)
94*12902SBryan.Cantrill@Sun.COM 			return (CRAWL_FOUNDALL);
95*12902SBryan.Cantrill@Sun.COM 		fs_dprintf(("<3> not at base\n"));
96*12902SBryan.Cantrill@Sun.COM 
97*12902SBryan.Cantrill@Sun.COM #if defined(__i386) || defined(__amd64)
98*12902SBryan.Cantrill@Sun.COM 		if (ktop - fp == sizeof (struct rwindow)) {
99*12902SBryan.Cantrill@Sun.COM 			fs_dprintf(("<4> found base\n"));
100*12902SBryan.Cantrill@Sun.COM 			return (CRAWL_FOUNDALL);
101*12902SBryan.Cantrill@Sun.COM 		}
102*12902SBryan.Cantrill@Sun.COM #endif
103*12902SBryan.Cantrill@Sun.COM 
104*12902SBryan.Cantrill@Sun.COM 		fs_dprintf(("<5> fp = %p, kbase = %p, ktop - size = %p\n",
105*12902SBryan.Cantrill@Sun.COM 		    fp, kbase, ktop - sizeof (struct rwindow)));
106*12902SBryan.Cantrill@Sun.COM 
107*12902SBryan.Cantrill@Sun.COM 		if (fp < kbase || fp >= (ktop - sizeof (struct rwindow)))
108*12902SBryan.Cantrill@Sun.COM 			break;
109*12902SBryan.Cantrill@Sun.COM 
110*12902SBryan.Cantrill@Sun.COM 		frame = KTOU(fp);
111*12902SBryan.Cantrill@Sun.COM 		fs_dprintf(("<6> frame = %p\n", frame));
112*12902SBryan.Cantrill@Sun.COM 
113*12902SBryan.Cantrill@Sun.COM 		/*
114*12902SBryan.Cantrill@Sun.COM 		 * NULL out the old %fp so we don't go down this stack
115*12902SBryan.Cantrill@Sun.COM 		 * more than once.
116*12902SBryan.Cantrill@Sun.COM 		 */
117*12902SBryan.Cantrill@Sun.COM 		if (kill_fp) {
118*12902SBryan.Cantrill@Sun.COM 			fs_dprintf(("<7> fpp = %p\n", fpp));
119*12902SBryan.Cantrill@Sun.COM 			*fpp = NULL;
120*12902SBryan.Cantrill@Sun.COM 		}
121*12902SBryan.Cantrill@Sun.COM 
122*12902SBryan.Cantrill@Sun.COM 		fs_dprintf(("<8> levels = %d\n", levels));
123*12902SBryan.Cantrill@Sun.COM 		levels++;
124*12902SBryan.Cantrill@Sun.COM 	}
125*12902SBryan.Cantrill@Sun.COM 
126*12902SBryan.Cantrill@Sun.COM 	return (levels);
127*12902SBryan.Cantrill@Sun.COM }
128*12902SBryan.Cantrill@Sun.COM 
129*12902SBryan.Cantrill@Sun.COM /*ARGSUSED*/
130*12902SBryan.Cantrill@Sun.COM int
stacks_findstack(uintptr_t addr,findstack_info_t * fsip,uint_t print_warnings)131*12902SBryan.Cantrill@Sun.COM stacks_findstack(uintptr_t addr, findstack_info_t *fsip, uint_t print_warnings)
132*12902SBryan.Cantrill@Sun.COM {
133*12902SBryan.Cantrill@Sun.COM 	kthread_t thr;
134*12902SBryan.Cantrill@Sun.COM 	size_t stksz;
135*12902SBryan.Cantrill@Sun.COM 	uintptr_t ubase, utop;
136*12902SBryan.Cantrill@Sun.COM 	uintptr_t kbase, ktop;
137*12902SBryan.Cantrill@Sun.COM 	uintptr_t win, sp;
138*12902SBryan.Cantrill@Sun.COM 
139*12902SBryan.Cantrill@Sun.COM 	fsip->fsi_failed = 0;
140*12902SBryan.Cantrill@Sun.COM 	fsip->fsi_pc = 0;
141*12902SBryan.Cantrill@Sun.COM 	fsip->fsi_sp = 0;
142*12902SBryan.Cantrill@Sun.COM 	fsip->fsi_depth = 0;
143*12902SBryan.Cantrill@Sun.COM 	fsip->fsi_overflow = 0;
144*12902SBryan.Cantrill@Sun.COM 
145*12902SBryan.Cantrill@Sun.COM 	bzero(&thr, sizeof (thr));
146*12902SBryan.Cantrill@Sun.COM 	if (mdb_ctf_vread(&thr, "kthread_t", addr,
147*12902SBryan.Cantrill@Sun.COM 	    MDB_CTF_VREAD_IGNORE_ALL) == -1) {
148*12902SBryan.Cantrill@Sun.COM 		if (print_warnings)
149*12902SBryan.Cantrill@Sun.COM 			mdb_warn("couldn't read thread at %p\n", addr);
150*12902SBryan.Cantrill@Sun.COM 		fsip->fsi_failed = FSI_FAIL_BADTHREAD;
151*12902SBryan.Cantrill@Sun.COM 		return (DCMD_ERR);
152*12902SBryan.Cantrill@Sun.COM 	}
153*12902SBryan.Cantrill@Sun.COM 
154*12902SBryan.Cantrill@Sun.COM 	fsip->fsi_sobj_ops = (uintptr_t)thr.t_sobj_ops;
155*12902SBryan.Cantrill@Sun.COM 	fsip->fsi_tstate = thr.t_state;
156*12902SBryan.Cantrill@Sun.COM 	fsip->fsi_panic = !!(thr.t_flag & T_PANIC);
157*12902SBryan.Cantrill@Sun.COM 
158*12902SBryan.Cantrill@Sun.COM 	if ((thr.t_schedflag & TS_LOAD) == 0) {
159*12902SBryan.Cantrill@Sun.COM 		if (print_warnings)
160*12902SBryan.Cantrill@Sun.COM 			mdb_warn("thread %p isn't in memory\n", addr);
161*12902SBryan.Cantrill@Sun.COM 		fsip->fsi_failed = FSI_FAIL_NOTINMEMORY;
162*12902SBryan.Cantrill@Sun.COM 		return (DCMD_ERR);
163*12902SBryan.Cantrill@Sun.COM 	}
164*12902SBryan.Cantrill@Sun.COM 
165*12902SBryan.Cantrill@Sun.COM 	if (thr.t_stk < thr.t_stkbase) {
166*12902SBryan.Cantrill@Sun.COM 		if (print_warnings)
167*12902SBryan.Cantrill@Sun.COM 			mdb_warn(
168*12902SBryan.Cantrill@Sun.COM 			    "stack base or stack top corrupt for thread %p\n",
169*12902SBryan.Cantrill@Sun.COM 			    addr);
170*12902SBryan.Cantrill@Sun.COM 		fsip->fsi_failed = FSI_FAIL_THREADCORRUPT;
171*12902SBryan.Cantrill@Sun.COM 		return (DCMD_ERR);
172*12902SBryan.Cantrill@Sun.COM 	}
173*12902SBryan.Cantrill@Sun.COM 
174*12902SBryan.Cantrill@Sun.COM 	kbase = (uintptr_t)thr.t_stkbase;
175*12902SBryan.Cantrill@Sun.COM 	ktop = (uintptr_t)thr.t_stk;
176*12902SBryan.Cantrill@Sun.COM 	stksz = ktop - kbase;
177*12902SBryan.Cantrill@Sun.COM 
178*12902SBryan.Cantrill@Sun.COM #ifdef __amd64
179*12902SBryan.Cantrill@Sun.COM 	/*
180*12902SBryan.Cantrill@Sun.COM 	 * The stack on amd64 is intentionally misaligned, so ignore the top
181*12902SBryan.Cantrill@Sun.COM 	 * half-frame.  See thread_stk_init().  When handling traps, the frame
182*12902SBryan.Cantrill@Sun.COM 	 * is automatically aligned by the hardware, so we only alter ktop if
183*12902SBryan.Cantrill@Sun.COM 	 * needed.
184*12902SBryan.Cantrill@Sun.COM 	 */
185*12902SBryan.Cantrill@Sun.COM 	if ((ktop & (STACK_ALIGN - 1)) != 0)
186*12902SBryan.Cantrill@Sun.COM 		ktop -= STACK_ENTRY_ALIGN;
187*12902SBryan.Cantrill@Sun.COM #endif
188*12902SBryan.Cantrill@Sun.COM 
189*12902SBryan.Cantrill@Sun.COM 	/*
190*12902SBryan.Cantrill@Sun.COM 	 * If the stack size is larger than a meg, assume that it's bogus.
191*12902SBryan.Cantrill@Sun.COM 	 */
192*12902SBryan.Cantrill@Sun.COM 	if (stksz > TOO_BIG_FOR_A_STACK) {
193*12902SBryan.Cantrill@Sun.COM 		if (print_warnings)
194*12902SBryan.Cantrill@Sun.COM 			mdb_warn("stack size for thread %p is too big to be "
195*12902SBryan.Cantrill@Sun.COM 			    "reasonable\n", addr);
196*12902SBryan.Cantrill@Sun.COM 		fsip->fsi_failed = FSI_FAIL_THREADCORRUPT;
197*12902SBryan.Cantrill@Sun.COM 		return (DCMD_ERR);
198*12902SBryan.Cantrill@Sun.COM 	}
199*12902SBryan.Cantrill@Sun.COM 
200*12902SBryan.Cantrill@Sun.COM 	/*
201*12902SBryan.Cantrill@Sun.COM 	 * This could be (and was) a UM_GC allocation.  Unfortunately,
202*12902SBryan.Cantrill@Sun.COM 	 * stksz tends to be very large.  As currently implemented, dcmds
203*12902SBryan.Cantrill@Sun.COM 	 * invoked as part of pipelines don't have their UM_GC-allocated
204*12902SBryan.Cantrill@Sun.COM 	 * memory freed until the pipeline completes.  With stksz in the
205*12902SBryan.Cantrill@Sun.COM 	 * neighborhood of 20k, the popular ::walk thread |::findstack
206*12902SBryan.Cantrill@Sun.COM 	 * pipeline can easily run memory-constrained debuggers (kmdb) out
207*12902SBryan.Cantrill@Sun.COM 	 * of memory.  This can be changed back to a gc-able allocation when
208*12902SBryan.Cantrill@Sun.COM 	 * the debugger is changed to free UM_GC memory more promptly.
209*12902SBryan.Cantrill@Sun.COM 	 */
210*12902SBryan.Cantrill@Sun.COM 	ubase = (uintptr_t)mdb_alloc(stksz, UM_SLEEP);
211*12902SBryan.Cantrill@Sun.COM 	utop = ubase + stksz;
212*12902SBryan.Cantrill@Sun.COM 	if (mdb_vread((caddr_t)ubase, stksz, kbase) != stksz) {
213*12902SBryan.Cantrill@Sun.COM 		mdb_free((void *)ubase, stksz);
214*12902SBryan.Cantrill@Sun.COM 		if (print_warnings)
215*12902SBryan.Cantrill@Sun.COM 			mdb_warn("couldn't read entire stack for thread %p\n",
216*12902SBryan.Cantrill@Sun.COM 			    addr);
217*12902SBryan.Cantrill@Sun.COM 		fsip->fsi_failed = FSI_FAIL_THREADCORRUPT;
218*12902SBryan.Cantrill@Sun.COM 		return (DCMD_ERR);
219*12902SBryan.Cantrill@Sun.COM 	}
220*12902SBryan.Cantrill@Sun.COM 
221*12902SBryan.Cantrill@Sun.COM 	/*
222*12902SBryan.Cantrill@Sun.COM 	 * Try the saved %sp first, if it looks reasonable.
223*12902SBryan.Cantrill@Sun.COM 	 */
224*12902SBryan.Cantrill@Sun.COM 	sp = KTOU((uintptr_t)thr.t_sp + STACK_BIAS);
225*12902SBryan.Cantrill@Sun.COM 	if (sp >= ubase && sp <= utop) {
226*12902SBryan.Cantrill@Sun.COM 		if (crawl(sp, kbase, ktop, ubase, 0, fsip) == CRAWL_FOUNDALL) {
227*12902SBryan.Cantrill@Sun.COM 			fsip->fsi_sp = (uintptr_t)thr.t_sp;
228*12902SBryan.Cantrill@Sun.COM #if !defined(__i386)
229*12902SBryan.Cantrill@Sun.COM 			fsip->fsi_pc = (uintptr_t)thr.t_pc;
230*12902SBryan.Cantrill@Sun.COM #endif
231*12902SBryan.Cantrill@Sun.COM 			goto found;
232*12902SBryan.Cantrill@Sun.COM 		}
233*12902SBryan.Cantrill@Sun.COM 	}
234*12902SBryan.Cantrill@Sun.COM 
235*12902SBryan.Cantrill@Sun.COM 	/*
236*12902SBryan.Cantrill@Sun.COM 	 * Now walk through the whole stack, starting at the base,
237*12902SBryan.Cantrill@Sun.COM 	 * trying every possible "window".
238*12902SBryan.Cantrill@Sun.COM 	 */
239*12902SBryan.Cantrill@Sun.COM 	for (win = ubase;
240*12902SBryan.Cantrill@Sun.COM 	    win + sizeof (struct rwindow) <= utop;
241*12902SBryan.Cantrill@Sun.COM 	    win += sizeof (struct rwindow *)) {
242*12902SBryan.Cantrill@Sun.COM 		if (crawl(win, kbase, ktop, ubase, 1, fsip) == CRAWL_FOUNDALL) {
243*12902SBryan.Cantrill@Sun.COM 			fsip->fsi_sp = UTOK(win) - STACK_BIAS;
244*12902SBryan.Cantrill@Sun.COM 			goto found;
245*12902SBryan.Cantrill@Sun.COM 		}
246*12902SBryan.Cantrill@Sun.COM 	}
247*12902SBryan.Cantrill@Sun.COM 
248*12902SBryan.Cantrill@Sun.COM 	/*
249*12902SBryan.Cantrill@Sun.COM 	 * We didn't conclusively find the stack.  So we'll take another lap,
250*12902SBryan.Cantrill@Sun.COM 	 * and print out anything that looks possible.
251*12902SBryan.Cantrill@Sun.COM 	 */
252*12902SBryan.Cantrill@Sun.COM 	if (print_warnings)
253*12902SBryan.Cantrill@Sun.COM 		mdb_printf("Possible stack pointers for thread %p:\n", addr);
254*12902SBryan.Cantrill@Sun.COM 	(void) mdb_vread((caddr_t)ubase, stksz, kbase);
255*12902SBryan.Cantrill@Sun.COM 
256*12902SBryan.Cantrill@Sun.COM 	for (win = ubase;
257*12902SBryan.Cantrill@Sun.COM 	    win + sizeof (struct rwindow) <= utop;
258*12902SBryan.Cantrill@Sun.COM 	    win += sizeof (struct rwindow *)) {
259*12902SBryan.Cantrill@Sun.COM 		uintptr_t fp = ((struct rwindow *)win)->rw_fp;
260*12902SBryan.Cantrill@Sun.COM 		int levels;
261*12902SBryan.Cantrill@Sun.COM 
262*12902SBryan.Cantrill@Sun.COM 		if ((levels = crawl(win, kbase, ktop, ubase, 1, fsip)) > 1) {
263*12902SBryan.Cantrill@Sun.COM 			if (print_warnings)
264*12902SBryan.Cantrill@Sun.COM 				mdb_printf("  %p (%d)\n", fp, levels);
265*12902SBryan.Cantrill@Sun.COM 		} else if (levels == CRAWL_FOUNDALL) {
266*12902SBryan.Cantrill@Sun.COM 			/*
267*12902SBryan.Cantrill@Sun.COM 			 * If this is a live system, the stack could change
268*12902SBryan.Cantrill@Sun.COM 			 * between the two mdb_vread(ubase, utop, kbase)'s,
269*12902SBryan.Cantrill@Sun.COM 			 * and we could have a fully valid stack here.
270*12902SBryan.Cantrill@Sun.COM 			 */
271*12902SBryan.Cantrill@Sun.COM 			fsip->fsi_sp = UTOK(win) - STACK_BIAS;
272*12902SBryan.Cantrill@Sun.COM 			goto found;
273*12902SBryan.Cantrill@Sun.COM 		}
274*12902SBryan.Cantrill@Sun.COM 	}
275*12902SBryan.Cantrill@Sun.COM 
276*12902SBryan.Cantrill@Sun.COM 	fsip->fsi_depth = 0;
277*12902SBryan.Cantrill@Sun.COM 	fsip->fsi_overflow = 0;
278*12902SBryan.Cantrill@Sun.COM 	fsip->fsi_failed = FSI_FAIL_STACKNOTFOUND;
279*12902SBryan.Cantrill@Sun.COM 
280*12902SBryan.Cantrill@Sun.COM 	mdb_free((void *)ubase, stksz);
281*12902SBryan.Cantrill@Sun.COM 	return (DCMD_ERR);
282*12902SBryan.Cantrill@Sun.COM found:
283*12902SBryan.Cantrill@Sun.COM 	mdb_free((void *)ubase, stksz);
284*12902SBryan.Cantrill@Sun.COM 	return (DCMD_OK);
285*12902SBryan.Cantrill@Sun.COM }
286*12902SBryan.Cantrill@Sun.COM 
287*12902SBryan.Cantrill@Sun.COM void
stacks_findstack_cleanup()288*12902SBryan.Cantrill@Sun.COM stacks_findstack_cleanup()
289*12902SBryan.Cantrill@Sun.COM {}
290*12902SBryan.Cantrill@Sun.COM 
291*12902SBryan.Cantrill@Sun.COM /*ARGSUSED*/
292*12902SBryan.Cantrill@Sun.COM int
stacks_module_cb(uintptr_t addr,const modctl_t * mp,stacks_module_t * smp)293*12902SBryan.Cantrill@Sun.COM stacks_module_cb(uintptr_t addr, const modctl_t *mp, stacks_module_t *smp)
294*12902SBryan.Cantrill@Sun.COM {
295*12902SBryan.Cantrill@Sun.COM 	char mod_modname[MODMAXNAMELEN + 1];
296*12902SBryan.Cantrill@Sun.COM 
297*12902SBryan.Cantrill@Sun.COM 	if (!mp->mod_modname)
298*12902SBryan.Cantrill@Sun.COM 		return (WALK_NEXT);
299*12902SBryan.Cantrill@Sun.COM 
300*12902SBryan.Cantrill@Sun.COM 	if (mdb_readstr(mod_modname, sizeof (mod_modname),
301*12902SBryan.Cantrill@Sun.COM 	    (uintptr_t)mp->mod_modname) == -1) {
302*12902SBryan.Cantrill@Sun.COM 		mdb_warn("failed to read mod_modname in \"modctl\" walk");
303*12902SBryan.Cantrill@Sun.COM 		return (WALK_ERR);
304*12902SBryan.Cantrill@Sun.COM 	}
305*12902SBryan.Cantrill@Sun.COM 
306*12902SBryan.Cantrill@Sun.COM 	if (strcmp(smp->sm_name, mod_modname))
307*12902SBryan.Cantrill@Sun.COM 		return (WALK_NEXT);
308*12902SBryan.Cantrill@Sun.COM 
309*12902SBryan.Cantrill@Sun.COM 	smp->sm_text = (uintptr_t)mp->mod_text;
310*12902SBryan.Cantrill@Sun.COM 	smp->sm_size = mp->mod_text_size;
311*12902SBryan.Cantrill@Sun.COM 
312*12902SBryan.Cantrill@Sun.COM 	return (WALK_DONE);
313*12902SBryan.Cantrill@Sun.COM }
314*12902SBryan.Cantrill@Sun.COM 
315*12902SBryan.Cantrill@Sun.COM int
stacks_module(stacks_module_t * smp)316*12902SBryan.Cantrill@Sun.COM stacks_module(stacks_module_t *smp)
317*12902SBryan.Cantrill@Sun.COM {
318*12902SBryan.Cantrill@Sun.COM 	if (mdb_walk("modctl", (mdb_walk_cb_t)stacks_module_cb, smp) != 0) {
319*12902SBryan.Cantrill@Sun.COM 		mdb_warn("cannot walk \"modctl\"");
320*12902SBryan.Cantrill@Sun.COM 		return (-1);
321*12902SBryan.Cantrill@Sun.COM 	}
322*12902SBryan.Cantrill@Sun.COM 
323*12902SBryan.Cantrill@Sun.COM 	return (0);
324*12902SBryan.Cantrill@Sun.COM }
325*12902SBryan.Cantrill@Sun.COM 
326*12902SBryan.Cantrill@Sun.COM /*ARGSUSED*/
327*12902SBryan.Cantrill@Sun.COM static void
print_sobj_help(int type,const char * name,const char * ops_name,void * ign)328*12902SBryan.Cantrill@Sun.COM print_sobj_help(int type, const char *name, const char *ops_name, void *ign)
329*12902SBryan.Cantrill@Sun.COM {
330*12902SBryan.Cantrill@Sun.COM 	mdb_printf(" %s", name);
331*12902SBryan.Cantrill@Sun.COM }
332*12902SBryan.Cantrill@Sun.COM 
333*12902SBryan.Cantrill@Sun.COM /*ARGSUSED*/
334*12902SBryan.Cantrill@Sun.COM static void
print_tstate_help(uint_t state,const char * name,void * ignored)335*12902SBryan.Cantrill@Sun.COM print_tstate_help(uint_t state, const char *name, void *ignored)
336*12902SBryan.Cantrill@Sun.COM {
337*12902SBryan.Cantrill@Sun.COM 	mdb_printf(" %s", name);
338*12902SBryan.Cantrill@Sun.COM }
339*12902SBryan.Cantrill@Sun.COM 
340*12902SBryan.Cantrill@Sun.COM void
stacks_help(void)341*12902SBryan.Cantrill@Sun.COM stacks_help(void)
342*12902SBryan.Cantrill@Sun.COM {
343*12902SBryan.Cantrill@Sun.COM 	mdb_printf(
344*12902SBryan.Cantrill@Sun.COM "::stacks processes all of the thread stacks on the system, grouping\n"
345*12902SBryan.Cantrill@Sun.COM "together threads which have the same:\n"
346*12902SBryan.Cantrill@Sun.COM "\n"
347*12902SBryan.Cantrill@Sun.COM "  * Thread state,\n"
348*12902SBryan.Cantrill@Sun.COM "  * Sync object type, and\n"
349*12902SBryan.Cantrill@Sun.COM "  * PCs in their stack trace.\n"
350*12902SBryan.Cantrill@Sun.COM "\n"
351*12902SBryan.Cantrill@Sun.COM "The default output (no address or options) is just a dump of the thread\n"
352*12902SBryan.Cantrill@Sun.COM "groups in the system.  For a view of active threads, use \"::stacks -i\",\n"
353*12902SBryan.Cantrill@Sun.COM "which filters out FREE threads (interrupt threads which are currently\n"
354*12902SBryan.Cantrill@Sun.COM "inactive) and threads sleeping on a CV. (Note that those threads may still\n"
355*12902SBryan.Cantrill@Sun.COM "be noteworthy; this is just for a first glance.)  More general filtering\n"
356*12902SBryan.Cantrill@Sun.COM "options are described below, in the \"FILTERS\" section.\n"
357*12902SBryan.Cantrill@Sun.COM "\n"
358*12902SBryan.Cantrill@Sun.COM "::stacks can be used in a pipeline.  The input to ::stacks is one or more\n"
359*12902SBryan.Cantrill@Sun.COM "thread pointers.  For example, to get a summary of threads in a process,\n"
360*12902SBryan.Cantrill@Sun.COM "you can do:\n"
361*12902SBryan.Cantrill@Sun.COM "\n"
362*12902SBryan.Cantrill@Sun.COM "  %<b>procp%</b>::walk thread | ::stacks\n"
363*12902SBryan.Cantrill@Sun.COM "\n"
364*12902SBryan.Cantrill@Sun.COM "When output into a pipe, ::stacks prints all of the threads input,\n"
365*12902SBryan.Cantrill@Sun.COM "filtered by the given filtering options.  This means that multiple\n"
366*12902SBryan.Cantrill@Sun.COM "::stacks invocations can be piped together to achieve more complicated\n"
367*12902SBryan.Cantrill@Sun.COM "filters.  For example, to get threads which have both 'fop_read' and\n"
368*12902SBryan.Cantrill@Sun.COM "'cv_wait_sig_swap' in their stack trace, you could do:\n"
369*12902SBryan.Cantrill@Sun.COM "\n"
370*12902SBryan.Cantrill@Sun.COM "  ::stacks -c fop_read | ::stacks -c cv_wait_sig_swap_core\n"
371*12902SBryan.Cantrill@Sun.COM "\n"
372*12902SBryan.Cantrill@Sun.COM "To get the full list of threads in each group, use the '-a' flag:\n"
373*12902SBryan.Cantrill@Sun.COM "\n"
374*12902SBryan.Cantrill@Sun.COM "  ::stacks -a\n"
375*12902SBryan.Cantrill@Sun.COM "\n");
376*12902SBryan.Cantrill@Sun.COM 	mdb_dec_indent(2);
377*12902SBryan.Cantrill@Sun.COM 	mdb_printf("%<b>OPTIONS%</b>\n");
378*12902SBryan.Cantrill@Sun.COM 	mdb_inc_indent(2);
379*12902SBryan.Cantrill@Sun.COM 	mdb_printf("%s",
380*12902SBryan.Cantrill@Sun.COM "  -a    Print all of the grouped threads, instead of just a count.\n"
381*12902SBryan.Cantrill@Sun.COM "  -f    Force a re-run of the thread stack gathering.\n"
382*12902SBryan.Cantrill@Sun.COM "  -v    Be verbose about thread stack gathering.\n"
383*12902SBryan.Cantrill@Sun.COM "\n");
384*12902SBryan.Cantrill@Sun.COM 	mdb_dec_indent(2);
385*12902SBryan.Cantrill@Sun.COM 	mdb_printf("%<b>FILTERS%</b>\n");
386*12902SBryan.Cantrill@Sun.COM 	mdb_inc_indent(2);
387*12902SBryan.Cantrill@Sun.COM 	mdb_printf("%s",
388*12902SBryan.Cantrill@Sun.COM "  -i    Show active threads; equivalent to '-S CV -T FREE'.\n"
389*12902SBryan.Cantrill@Sun.COM "  -c func[+offset]\n"
390*12902SBryan.Cantrill@Sun.COM "        Only print threads whose stacks contain func/func+offset.\n"
391*12902SBryan.Cantrill@Sun.COM "  -C func[+offset]\n"
392*12902SBryan.Cantrill@Sun.COM "        Only print threads whose stacks do not contain func/func+offset.\n"
393*12902SBryan.Cantrill@Sun.COM "  -m module\n"
394*12902SBryan.Cantrill@Sun.COM "        Only print threads whose stacks contain functions from module.\n"
395*12902SBryan.Cantrill@Sun.COM "  -M module\n"
396*12902SBryan.Cantrill@Sun.COM "        Only print threads whose stacks do not contain functions from\n"
397*12902SBryan.Cantrill@Sun.COM "        module.\n"
398*12902SBryan.Cantrill@Sun.COM "  -s {type | ALL}\n"
399*12902SBryan.Cantrill@Sun.COM "        Only print threads which are on a 'type' synchronization object\n"
400*12902SBryan.Cantrill@Sun.COM "        (SOBJ).\n"
401*12902SBryan.Cantrill@Sun.COM "  -S {type | ALL}\n"
402*12902SBryan.Cantrill@Sun.COM "        Only print threads which are not on a 'type' SOBJ.\n"
403*12902SBryan.Cantrill@Sun.COM "  -t tstate\n"
404*12902SBryan.Cantrill@Sun.COM "        Only print threads which are in thread state 'tstate'.\n"
405*12902SBryan.Cantrill@Sun.COM "  -T tstate\n"
406*12902SBryan.Cantrill@Sun.COM "        Only print threads which are not in thread state 'tstate'.\n"
407*12902SBryan.Cantrill@Sun.COM "\n");
408*12902SBryan.Cantrill@Sun.COM 	mdb_printf("   SOBJ types:");
409*12902SBryan.Cantrill@Sun.COM 	sobj_type_walk(print_sobj_help, NULL);
410*12902SBryan.Cantrill@Sun.COM 	mdb_printf("\n");
411*12902SBryan.Cantrill@Sun.COM 	mdb_printf("Thread states:");
412*12902SBryan.Cantrill@Sun.COM 	thread_walk_states(print_tstate_help, NULL);
413*12902SBryan.Cantrill@Sun.COM 	mdb_printf(" panic\n");
414*12902SBryan.Cantrill@Sun.COM }
415