xref: /trueos/sys/contrib/ia64/libuwx/src/uwx_trace.h (revision cf1af765652056615e9133119e2c8c051fe90f27)
1 /*
2 Copyright (c) 2003-2006 Hewlett-Packard Development Company, L.P.
3 Permission is hereby granted, free of charge, to any person
4 obtaining a copy of this software and associated documentation
5 files (the "Software"), to deal in the Software without
6 restriction, including without limitation the rights to use,
7 copy, modify, merge, publish, distribute, sublicense, and/or sell
8 copies of the Software, and to permit persons to whom the
9 Software is furnished to do so, subject to the following
10 conditions:
11 
12 The above copyright notice and this permission notice shall be
13 included in all copies or substantial portions of the Software.
14 
15 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
16 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
17 OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
18 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
19 HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
20 WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
22 OTHER DEALINGS IN THE SOFTWARE.
23 */
24 
25 #define UWX_TRACE_SB		1	/* UWX_TRACE=b: scoreboard mgmt */
26 #define UWX_TRACE_UINFO		2	/* UWX_TRACE=i: unwind info */
27 #define UWX_TRACE_RSTATE	4	/* UWX_TRACE=r: reg state vector */
28 #define UWX_TRACE_STEP		8	/* UWX_TRACE=s: step */
29 #define UWX_TRACE_UTABLE	16	/* UWX_TRACE=t: unwind tbl search */
30 #define UWX_TRACE_CONTEXT	32	/* UWX_TRACE=c: context */
31 #define UWX_TRACE_COPYIN	64	/* UWX_TRACE=C: copyin callback */
32 #define UWX_TRACE_LOOKUPIP	128	/* UWX_TRACE=L: lookupip callback */
33 
34 #ifdef UWX_TRACE_ENABLE
35 
36 #ifdef _KERNEL
37 #define	fprintf(f, ...)		printf(__VA_ARGS__)
38 #endif
39 
40 extern void uwx_trace_init(struct uwx_env *env);
41 
42 struct uwx_utable_entry;
43 
44 extern void uwx_dump_uinfo_block(struct uwx_utable_entry *, unsigned int);
45 
46 extern void uwx_dump_rstate(int regid, uint64_t rstate);
47 
48 struct uwx_rhdr;
49 
50 extern void uwx_dump_scoreboard(
51     struct uwx_scoreboard *scoreboard,
52     int nsbreg,
53     struct uwx_rhdr *rhdr,
54     int cur_slot,
55     int ip_slot);
56 
57 #define TRACE_INIT uwx_trace_init(env);
58 
59 #define TRACE_B_REUSE(id) \
60     if (env->trace & UWX_TRACE_SB) \
61 	fprintf(stderr, "uwx_alloc_scoreboard: reuse id %d\n", (id));
62 
63 #define TRACE_B_PREALLOC(id) \
64     if (env->trace & UWX_TRACE_SB) \
65 	fprintf(stderr, "uwx_prealloc_scoreboard: prealloc id %d\n", (id));
66 
67 #define TRACE_B_ALLOC(id) \
68     if (env->trace & UWX_TRACE_SB) \
69 	fprintf(stderr, "uwx_alloc_scoreboard: alloc id %d\n", (id));
70 
71 #define TRACE_B_POP(id) \
72     if (env->trace & UWX_TRACE_SB) \
73 	fprintf(stderr, "uwx_pop_scoreboards: free id %d\n", (id));
74 
75 #define TRACE_B_LABEL(label) \
76     if (env->trace & UWX_TRACE_SB) \
77 	fprintf(stderr, "uwx_label_scoreboard: label %d\n", (label));
78 
79 #define TRACE_B_LABEL_COPY(id) \
80     if (env->trace & UWX_TRACE_SB) \
81 	fprintf(stderr, "uwx_label_scoreboard: copy id %d\n", (id));
82 
83 #define TRACE_B_LABEL_REVERSE(back, new) \
84     if (env->trace & UWX_TRACE_SB) \
85 	fprintf(stderr, "uwx_label_scoreboard: reverse link %d -> %d\n", \
86 			    (new)->id, ((back) == 0) ? -1 : (back)->id);
87 
88 #define TRACE_B_COPY(label, id) \
89     if (env->trace & UWX_TRACE_SB) \
90 	fprintf(stderr, "uwx_copy_scoreboard: label %d, cur sb id %d\n", (label), (id));
91 
92 #define TRACE_B_COPY_FREE(id) \
93     if (env->trace & UWX_TRACE_SB) \
94 	fprintf(stderr, "uwx_copy_scoreboard: free id %d\n", (id));
95 
96 #define TRACE_B_COPY_FOUND(id) \
97     if (env->trace & UWX_TRACE_SB) \
98 	fprintf(stderr, "uwx_copy_scoreboard: found id %d\n", (id));
99 
100 #define TRACE_B_COPY_COPY(id) \
101     if (env->trace & UWX_TRACE_SB) \
102 	fprintf(stderr, "uwx_copy_scoreboard: copy id %d\n", (id));
103 
104 #define TRACE_B_COPY_REVERSE(back, new) \
105     if (env->trace & UWX_TRACE_SB) \
106 	fprintf(stderr, "uwx_copy_scoreboard: reverse link %d -> %d\n", \
107 			    (new)->id, ((back) == 0) ? -1 : (back)->id);
108 
109 #define TRACE_B_FREE(id) \
110     if (env->trace & UWX_TRACE_SB) \
111 	fprintf(stderr, "uwx_free_scoreboards: free id %d\n", (id));
112 
113 #define TRACE_I_DECODE_RHDR_1(name, b0) \
114     if (env->trace & UWX_TRACE_UINFO) \
115 	fprintf(stderr, "uwx_decode_rhdr:     %02x                   %s\n", \
116 			(b0), (name));
117 
118 #define TRACE_I_DECODE_RHDR_1L(name, b0, val) \
119     if (env->trace & UWX_TRACE_UINFO) \
120 	fprintf(stderr, "uwx_decode_rhdr:     %02x %08x          %s\n", \
121 			(b0), (int)(val), (name));
122 
123 #define TRACE_I_DECODE_RHDR_2L(name, b0, b1, val) \
124     if (env->trace & UWX_TRACE_UINFO) \
125 	fprintf(stderr, "uwx_decode_rhdr:     %02x %02x %08x       %s\n", \
126 			(b0), (b1), (int)(val), (name));
127 
128 #define TRACE_I_DECODE_PROLOGUE_1(name, b0) \
129     if (env->trace & UWX_TRACE_UINFO) \
130 	fprintf(stderr, "uwx_decode_prologue: %02x                   %s\n", \
131 			(b0), (name));
132 
133 #define TRACE_I_DECODE_PROLOGUE_1L(name, b0, val) \
134     if (env->trace & UWX_TRACE_UINFO) \
135 	fprintf(stderr, "uwx_decode_prologue: %02x %08x          %s\n", \
136 			(b0), (int)(val), (name));
137 
138 #define TRACE_I_DECODE_PROLOGUE_1LL(name, b0, val1, val2) \
139     if (env->trace & UWX_TRACE_UINFO) \
140 	fprintf(stderr, "uwx_decode_prologue: %02x %08x %08x %s\n", \
141 			(b0), (int)(val1), (int)(val2), (name));
142 
143 #define TRACE_I_DECODE_PROLOGUE_2(name, b0, b1) \
144     if (env->trace & UWX_TRACE_UINFO) \
145 	fprintf(stderr, "uwx_decode_prologue: %02x %02x                %s\n", \
146 			(b0), (b1), (name));
147 
148 #define TRACE_I_DECODE_PROLOGUE_2L(name, b0, b1, val) \
149     if (env->trace & UWX_TRACE_UINFO) \
150 	fprintf(stderr, "uwx_decode_prologue: %02x %02x %08x       %s\n", \
151 			(b0), (b1), (int)(val), (name));
152 
153 #define TRACE_I_DECODE_PROLOGUE_3(name, b0, b1, b2) \
154     if (env->trace & UWX_TRACE_UINFO) \
155 	fprintf(stderr, "uwx_decode_prologue: %02x %02x %02x             %s\n", \
156 			(b0), (b1), (b2), (name));
157 
158 #define TRACE_I_DECODE_PROLOGUE_4(name, b0, b1, b2, b3) \
159     if (env->trace & UWX_TRACE_UINFO) \
160 	fprintf(stderr, "uwx_decode_prologue: %02x %02x %02x %02x          %s\n", \
161 			(b0), (b1), (b2), (b3), (name));
162 
163 #define TRACE_I_DECODE_PROLOGUE_SPILL_BASE(spill_base) \
164     if (env->trace & UWX_TRACE_UINFO) \
165 	fprintf(stderr, "uwx_decode_prologue: spill base = %08x\n", (int)(spill_base));
166 
167 #define TRACE_I_DECODE_PROLOGUE_MASKS(gr_mem_mask, gr_gr_mask) \
168     if (env->trace & UWX_TRACE_UINFO) \
169 	fprintf(stderr, "uwx_decode_prologue: gr_mem_mask = %02x; gr_gr_mask = %02x\n", \
170 			(gr_mem_mask), (gr_gr_mask));
171 
172 #define TRACE_I_DECODE_PROLOGUE_NSPILL(ngr) \
173     if (env->trace & UWX_TRACE_UINFO) \
174 	fprintf(stderr, "uwx_decode_prologue: ngr = %d\n", (ngr));
175 
176 #define TRACE_I_DECODE_BODY_1(name, b0) \
177     if (env->trace & UWX_TRACE_UINFO) \
178 	fprintf(stderr, "uwx_decode_body:     %02x                   %s\n", \
179 			(b0), (name));
180 
181 #define TRACE_I_DECODE_BODY_1L(name, b0, val) \
182     if (env->trace & UWX_TRACE_UINFO) \
183 	fprintf(stderr, "uwx_decode_body:     %02x %08x          %s\n", \
184 			(b0), (int)(val), (name));
185 
186 #define TRACE_I_DECODE_BODY_1LL(name, b0, val1, val2) \
187     if (env->trace & UWX_TRACE_UINFO) \
188 	fprintf(stderr, "uwx_decode_body:     %02x %08x %08x %s\n", \
189 			(b0), (int)(val1), (int)(val2), (name));
190 
191 #define TRACE_R_UIB(uentry, ulen) \
192     if (env->trace & UWX_TRACE_RSTATE) { \
193 	fprintf(stderr, "Unwind info block (info = %08x %08x, flags = %08x %08x, ulen = %d)\n", \
194 		    (unsigned int)((uentry)->unwind_info >> 32), \
195 		    (unsigned int)(uentry)->unwind_info, \
196 		    (unsigned int)((uentry)->unwind_flags >> 32), \
197 		    (unsigned int)(uentry)->unwind_flags, \
198 		    (ulen)); \
199 	if (!env->remote) uwx_dump_uinfo_block(uentry, ulen); \
200     }
201 
202 #define TRACE_R_DUMP_SB(scoreboard, rhdr, cur_slot, ip_slot) \
203     if (env->trace & UWX_TRACE_RSTATE) \
204 	uwx_dump_scoreboard(scoreboard, env->nsbreg, \
205 				&(rhdr), cur_slot, ip_slot);
206 
207 #define TRACE_S_STEP(rstate) \
208     if (env->trace & UWX_TRACE_STEP) { \
209 	fprintf(stderr, "uwx_restore_markers:\n"); \
210 	uwx_dump_rstate(SBREG_RP, (rstate)[SBREG_RP]); \
211 	uwx_dump_rstate(SBREG_PSP, (rstate)[SBREG_PSP]); \
212 	uwx_dump_rstate(SBREG_PFS, (rstate)[SBREG_PFS]); \
213     }
214 
215 #define TRACE_S_RESTORE_REG(regname, rstate, val) \
216     if (env->trace & UWX_TRACE_STEP) \
217 	fprintf(stderr, "  restore %-7s (rstate = %08x %08x) = %08x %08x\n", \
218 			regname, \
219 			(unsigned int) ((rstate) >> 32), \
220 			(unsigned int) (rstate), \
221 			(unsigned int) ((val) >> 32), \
222 			(unsigned int) (val));
223 
224 #define TRACE_S_RESTORE_GR(regid, rstate, val) \
225     if (env->trace & UWX_TRACE_STEP) \
226 	fprintf(stderr, "  restore GR%d     (rstate = %08x %08x) = %08x %08x\n", \
227 			(regid) + 4, \
228 			(unsigned int) ((rstate) >> 32), \
229 			(unsigned int) (rstate), \
230 			(unsigned int) ((val) >> 32), \
231 			(unsigned int) (val));
232 
233 #define TRACE_S_RESTORE_BR(regid, rstate, val) \
234     if (env->trace & UWX_TRACE_STEP) \
235 	fprintf(stderr, "  restore BR%d     (rstate = %08x %08x) = %08x %08x\n", \
236 			(regid) + 1, \
237 			(unsigned int) ((rstate) >> 32), \
238 			(unsigned int) (rstate), \
239 			(unsigned int) ((val) >> 32), \
240 			(unsigned int) (val));
241 
242 #define TRACE_S_RESTORE_FR(regid, rstate, fval) \
243     if (env->trace & UWX_TRACE_STEP) \
244 	fprintf(stderr, "  restore FR%d     (rstate = %08x %08x) = %08x %08x %08x %08x\n", \
245 			(regid) + 1, \
246 			(unsigned int) ((rstate) >> 32), \
247 			(unsigned int) (rstate), \
248 			(unsigned int) ((fval[0]) >> 32), \
249 			(unsigned int) (fval[0]), \
250 			(unsigned int) ((fval[1]) >> 32), \
251 			(unsigned int) (fval[1]));
252 
253 #define TRACE_T_SEARCH32(ip) \
254     if (env->trace & UWX_TRACE_UTABLE) \
255 	fprintf(stderr, "uwx_search_utable32 (relative ip = %08x)\n", (ip));
256 
257 #define TRACE_T_BINSEARCH32(lb, ub, mid, code_start, code_end) \
258     if (env->trace & UWX_TRACE_UTABLE) \
259 	fprintf(stderr, "    lb/ub = %d/%d, mid = %d, start/end = %08x %08x\n", \
260 			    lb, ub, mid, code_start, code_end);
261 
262 #define TRACE_C_GET_REG(regid, bsp) \
263 	if (env->trace & UWX_TRACE_CONTEXT) \
264 	    fprintf(stderr, "uwx_get_reg (gr%d, bsp = %08x %08x)\n", \
265 			(regid) - UWX_REG_GR(0), \
266 			(unsigned int) ((bsp) >> 32), \
267 			(unsigned int) (bsp));
268 
269 #define TRACE_C_ROTATE_GR(regid, sor, rrb_gr, newregid) \
270 	if (env->trace & UWX_TRACE_CONTEXT) \
271 	    fprintf(stderr, "uwx_get_reg (gr%d, sor = %d, rrb = %d) --> gr%d\n", \
272 			(regid) + 32, \
273 			(sor), \
274 			(rrb_gr), \
275 			(newregid) + 32);
276 
277 #define TRACE_SELF_COPYIN4(rem, len, wp) \
278     if (info->trace & UWX_TRACE_COPYIN) \
279 	fprintf(stderr, "copyin (rem = %08x %08x, len = %d, val = %08x)\n", \
280 			(unsigned int) ((rem) >> 32), \
281 			(unsigned int) (rem), \
282 			(len), *(wp));
283 
284 #define TRACE_SELF_COPYIN8(rem, len, dp) \
285     if (info->trace & UWX_TRACE_COPYIN) \
286 	fprintf(stderr, "copyin (rem = %08x %08x, len = %d, val = %08x %08x)\n", \
287 			(unsigned int) ((rem) >> 32), \
288 			(unsigned int) (rem), \
289 			(len), \
290 			((unsigned int *)(dp))[0], \
291 			((unsigned int *)(dp))[1]);
292 
293 #define TRACE_SELF_LOOKUP(ip) \
294     if (info->trace & UWX_TRACE_LOOKUPIP) \
295 	fprintf(stderr, "Lookup IP callback: ip = %08x %08x\n", \
296 			(unsigned int) ((ip) >> 32), \
297 			(unsigned int) (ip));
298 
299 #define TRACE_SELF_LOOKUP_DESC(text_base, linkage_ptr, unwind_base) \
300 	if (info->trace & UWX_TRACE_LOOKUPIP) { \
301 	    fprintf(stderr, "  text base:    %08x %08x\n", \
302 			(unsigned int) ((text_base) >> 32), \
303 			(unsigned int) (text_base)); \
304 	    fprintf(stderr, "  linkage ptr:  %08x %08x\n", \
305 			(unsigned int) ((linkage_ptr) >> 32), \
306 			(unsigned int) (linkage_ptr)); \
307 	    fprintf(stderr, "  unwind base:  %08x %08x\n", \
308 			(unsigned int) ((uint64_t)(unwind_base) >> 32), \
309 			(unsigned int) (unwind_base)); \
310 	    fprintf(stderr, "  unwind flags: %08x %08x\n", \
311 			(unsigned int) ((unwind_base)[0] >> 32), \
312 			(unsigned int) (unwind_base)[0]); \
313 	    fprintf(stderr, "  unwind start: %08x %08x\n", \
314 			(unsigned int) (((text_base)+(unwind_base)[1]) >> 32), \
315 			(unsigned int) ((text_base)+(unwind_base)[1])); \
316 	    fprintf(stderr, "  unwind end:   %08x %08x\n", \
317 			(unsigned int) (((text_base)+(unwind_base)[2]) >> 32), \
318 			(unsigned int) ((text_base)+(unwind_base)[2])); \
319 	}
320 
321 #else /* !UWX_TRACE_ENABLE */
322 
323 #define TRACE_INIT
324 #define TRACE_B_REUSE(id)
325 #define TRACE_B_PREALLOC(id)
326 #define TRACE_B_ALLOC(id)
327 #define TRACE_B_POP(id)
328 #define TRACE_B_LABEL(label)
329 #define TRACE_B_LABEL_COPY(id)
330 #define TRACE_B_LABEL_REVERSE(back, new)
331 #define TRACE_B_COPY(label, id)
332 #define TRACE_B_COPY_FREE(id)
333 #define TRACE_B_COPY_FOUND(id)
334 #define TRACE_B_COPY_COPY(id)
335 #define TRACE_B_COPY_REVERSE(back, new)
336 #define TRACE_B_FREE(id)
337 #define TRACE_I_DECODE_RHDR_1(name, b0)
338 #define TRACE_I_DECODE_RHDR_1L(name, b0, val)
339 #define TRACE_I_DECODE_RHDR_2L(name, b0, b1, val)
340 #define TRACE_I_DECODE_PROLOGUE_1(name, b0)
341 #define TRACE_I_DECODE_PROLOGUE_1L(name, b0, val)
342 #define TRACE_I_DECODE_PROLOGUE_1LL(name, b0, val1, val2)
343 #define TRACE_I_DECODE_PROLOGUE_2(name, b0, b1)
344 #define TRACE_I_DECODE_PROLOGUE_2L(name, b0, b1, parm1)
345 #define TRACE_I_DECODE_PROLOGUE_3(name, b0, b1, b2)
346 #define TRACE_I_DECODE_PROLOGUE_4(name, b0, b1, b2, b3)
347 #define TRACE_I_DECODE_PROLOGUE_SPILL_BASE(spill_base)
348 #define TRACE_I_DECODE_PROLOGUE_MASKS(gr_mem_mask, gr_gr_mask)
349 #define TRACE_I_DECODE_PROLOGUE_NSPILL(ngr)
350 #define TRACE_I_DECODE_BODY_1(name, b0)
351 #define TRACE_I_DECODE_BODY_1L(name, b0, parm1)
352 #define TRACE_I_DECODE_BODY_1LL(name, b0, parm1, parm2)
353 #define TRACE_R_UIB(uentry, ulen)
354 #define TRACE_R_DUMP_SB(scoreboard, rhdr, cur_slot, ip_slot)
355 #define TRACE_S_STEP(rstate)
356 #define TRACE_S_RESTORE_REG(regname, rstate, val)
357 #define TRACE_S_RESTORE_GR(regid, rstate, val)
358 #define TRACE_S_RESTORE_BR(regid, rstate, val)
359 #define TRACE_S_RESTORE_FR(regid, rstate, val)
360 #define TRACE_T_SEARCH32(ip)
361 #define TRACE_T_BINSEARCH32(lb, ub, mid, code_start, code_end)
362 #define TRACE_C_GET_REG(regid, bsp)
363 #define TRACE_C_ROTATE_GR(regid, sor, rrb_gr, newregid)
364 #define TRACE_SELF_COPYIN4(rem, len, wp)
365 #define TRACE_SELF_COPYIN8(rem, len, dp)
366 #define TRACE_SELF_LOOKUP(ip)
367 #define TRACE_SELF_LOOKUP_DESC(text_base, linkage_ptr, unwind_base)
368 
369 #endif /* UWX_TRACE_ENABLE */
370 
371