1 /* Simulator tracing/debugging support.
2 Copyright (C) 1997, 1998 Free Software Foundation, Inc.
3 Contributed by Cygnus Support.
5 This file is part of GDB, the GNU debugger.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2, or (at your option)
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License along
18 with this program; if not, write to the Free Software Foundation, Inc.,
19 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */
21 /* This file is meant to be included by sim-basics.h. */
26 /* Standard traceable entities. */
29 /* Trace insn execution. */
32 /* Trace insn decoding.
33 ??? This is more of a simulator debugging operation and might best be
34 moved to --debug-decode. */
37 /* Trace insn extraction.
38 ??? This is more of a simulator debugging operation and might best be
39 moved to --debug-extract. */
42 /* Trace insn execution but include line numbers. */
45 /* Trace memory operations.
46 The difference between this and TRACE_CORE_IDX is (I think) that this
47 is intended to apply to a higher level. TRACE_CORE_IDX applies to the
48 low level core operations. */
51 /* Include model performance data in tracing output. */
54 /* Trace ALU operations. */
57 /* Trace memory core operations. */
63 /* Trace fpu operations. */
66 /* Trace branching. */
69 /* Add information useful for debugging the simulator to trace output. */
72 /* Simulator specific trace bits begin here. */
76 /* Maximum number of traceable entities. */
77 #ifndef MAX_TRACE_VALUES
78 #define MAX_TRACE_VALUES 32
81 /* The -t option only prints useful values. It's easy to type and shouldn't
82 splat on the screen everything under the sun making nothing easy to
84 #define TRACE_USEFUL_MASK \
85 ((1 << TRACE_INSN_IDX) \
86 | (1 << TRACE_LINENUM_IDX) \
87 | (1 << TRACE_MEMORY_IDX) \
88 | (1 << TRACE_MODEL_IDX))
90 /* Masks so WITH_TRACE can have symbolic values.
91 The case choice here is on purpose. The lowercase parts are args to
93 #define TRACE_insn (1 << TRACE_INSN_IDX)
94 #define TRACE_decode (1 << TRACE_DECODE_IDX)
95 #define TRACE_extract (1 << TRACE_EXTRACT_IDX)
96 #define TRACE_linenum (1 << TRACE_LINENUM_IDX)
97 #define TRACE_memory (1 << TRACE_MEMORY_IDX)
98 #define TRACE_model (1 << TRACE_MODEL_IDX)
99 #define TRACE_alu (1 << TRACE_ALU_IDX)
100 #define TRACE_core (1 << TRACE_CORE_IDX)
101 #define TRACE_events (1 << TRACE_EVENTS_IDX)
102 #define TRACE_fpu (1 << TRACE_FPU_IDX)
103 #define TRACE_branch (1 << TRACE_BRANCH_IDX)
104 #define TRACE_debug (1 << TRACE_DEBUG_IDX)
106 /* Preprocessor macros to simplify tests of WITH_TRACE. */
107 #define WITH_TRACE_INSN_P (WITH_TRACE & TRACE_insn)
108 #define WITH_TRACE_DECODE_P (WITH_TRACE & TRACE_decode)
109 #define WITH_TRACE_EXTRACT_P (WITH_TRACE & TRACE_extract)
110 #define WITH_TRACE_LINENUM_P (WITH_TRACE & TRACE_linenum)
111 #define WITH_TRACE_MEMORY_P (WITH_TRACE & TRACE_memory)
112 #define WITH_TRACE_MODEL_P (WITH_TRACE & TRACE_model)
113 #define WITH_TRACE_ALU_P (WITH_TRACE & TRACE_alu)
114 #define WITH_TRACE_CORE_P (WITH_TRACE & TRACE_core)
115 #define WITH_TRACE_EVENTS_P (WITH_TRACE & TRACE_events)
116 #define WITH_TRACE_FPU_P (WITH_TRACE & TRACE_fpu)
117 #define WITH_TRACE_BRANCH_P (WITH_TRACE & TRACE_branch)
118 #define WITH_TRACE_DEBUG_P (WITH_TRACE & TRACE_debug)
120 /* Tracing install handler. */
121 MODULE_INSTALL_FN trace_install
;
123 /* Struct containing all system and cpu trace data.
125 System trace data is stored with the associated module.
126 System and cpu tracing must share the same space of bitmasks as they
127 are arguments to --with-trace. One could have --with-trace and
128 --with-cpu-trace or some such but that's an over-complication at this point
129 in time. Also, there may be occasions where system and cpu tracing may
130 wish to share a name. */
132 typedef struct _trace_data
{
134 /* Global summary of all the current trace options */
137 /* Boolean array of specified tracing flags. */
138 /* ??? It's not clear that using an array vs a bit mask is faster.
139 Consider the case where one wants to test whether any of several bits
141 char trace_flags
[MAX_TRACE_VALUES
];
142 #define TRACE_FLAGS(t) ((t)->trace_flags)
144 /* Tracing output goes to this or stderr if NULL.
145 We can't store `stderr' here as stderr goes through a callback. */
147 #define TRACE_FILE(t) ((t)->trace_file)
149 /* Buffer to store the prefix to be printed before any trace line. */
150 char trace_prefix
[256];
151 #define TRACE_PREFIX(t) ((t)->trace_prefix)
153 /* Buffer to save the inputs for the current instruction. Use a
154 union to force the buffer into correct alignment */
160 } trace_input_data
[16];
161 unsigned8 trace_input_fmt
[16];
162 unsigned8 trace_input_size
[16];
164 #define TRACE_INPUT_DATA(t) ((t)->trace_input_data)
165 #define TRACE_INPUT_FMT(t) ((t)->trace_input_fmt)
166 #define TRACE_INPUT_SIZE(t) ((t)->trace_input_size)
167 #define TRACE_INPUT_IDX(t) ((t)->trace_input_idx)
169 /* Category of trace being performed */
171 #define TRACE_IDX(t) ((t)->trace_idx)
174 ??? Not all cpu's support this. */
176 #define TRACE_RANGE(t) (& (t)->range)
179 /* System tracing support. */
181 #define STATE_TRACE_FLAGS(sd) TRACE_FLAGS (STATE_TRACE_DATA (sd))
183 /* Return non-zero if tracing of IDX is enabled for non-cpu specific
184 components. The "S" in "STRACE" refers to "System". */
185 #define STRACE_P(sd,idx) \
186 ((WITH_TRACE & (1 << (idx))) != 0 \
187 && STATE_TRACE_FLAGS (sd)[idx] != 0)
189 /* Non-zero if --trace-<xxxx> was specified for SD. */
190 #define STRACE_DEBUG_P(sd) STRACE_P (sd, TRACE_DEBUG_IDX)
192 /* CPU tracing support. */
194 #define CPU_TRACE_FLAGS(cpu) TRACE_FLAGS (CPU_TRACE_DATA (cpu))
196 /* Return non-zero if tracing of IDX is enabled for CPU. */
197 #define TRACE_P(cpu,idx) \
198 ((WITH_TRACE & (1 << (idx))) != 0 \
199 && CPU_TRACE_FLAGS (cpu)[idx] != 0)
201 /* Non-zero if --trace-<xxxx> was specified for CPU. */
202 #define TRACE_ANY_P(cpu) ((WITH_TRACE) && (CPU_TRACE_DATA (cpu)->trace_any_p))
203 #define TRACE_INSN_P(cpu) TRACE_P (cpu, TRACE_INSN_IDX)
204 #define TRACE_DECODE_P(cpu) TRACE_P (cpu, TRACE_DECODE_IDX)
205 #define TRACE_EXTRACT_P(cpu) TRACE_P (cpu, TRACE_EXTRACT_IDX)
206 #define TRACE_LINENUM_P(cpu) TRACE_P (cpu, TRACE_LINENUM_IDX)
207 #define TRACE_MEMORY_P(cpu) TRACE_P (cpu, TRACE_MEMORY_IDX)
208 #define TRACE_MODEL_P(cpu) TRACE_P (cpu, TRACE_MODEL_IDX)
209 #define TRACE_ALU_P(cpu) TRACE_P (cpu, TRACE_ALU_IDX)
210 #define TRACE_CORE_P(cpu) TRACE_P (cpu, TRACE_CORE_IDX)
211 #define TRACE_EVENTS_P(cpu) TRACE_P (cpu, TRACE_EVENTS_IDX)
212 #define TRACE_FPU_P(cpu) TRACE_P (cpu, TRACE_FPU_IDX)
213 #define TRACE_BRANCH_P(cpu) TRACE_P (cpu, TRACE_BRANCH_IDX)
214 #define TRACE_DEBUG_P(cpu) TRACE_P (cpu, TRACE_DEBUG_IDX)
216 /* Traceing functions.
220 /* Prime the trace buffers ready for any trace output.
221 Must be called prior to any other trace operation */
222 extern void trace_prefix
PARAMS ((SIM_DESC sd
,
227 const char *file_name
,
231 __attribute__((format (printf
, 8, 9)));
233 /* Generic trace print, assumes trace_prefix() has been called */
235 extern void trace_generic
PARAMS ((SIM_DESC sd
,
240 __attribute__((format (printf
, 4, 5)));
242 /* Trace a varying number of word sized inputs/outputs. trace_result*
243 must be called to close the trace operation. */
245 extern void trace_input0
PARAMS ((SIM_DESC sd
,
249 extern void trace_input_word1
PARAMS ((SIM_DESC sd
,
254 extern void trace_input_word2
PARAMS ((SIM_DESC sd
,
260 extern void trace_input_word3
PARAMS ((SIM_DESC sd
,
267 extern void trace_input_word4
PARAMS ((SIM_DESC sd
,
275 extern void trace_input_addr1
PARAMS ((SIM_DESC sd
,
280 extern void trace_input_bool1
PARAMS ((SIM_DESC sd
,
285 extern void trace_input_fp1
PARAMS ((SIM_DESC sd
,
290 extern void trace_input_fp2
PARAMS ((SIM_DESC sd
,
296 extern void trace_input_fp3
PARAMS ((SIM_DESC sd
,
303 extern void trace_input_fpu1
PARAMS ((SIM_DESC sd
,
306 struct _sim_fpu
*f0
));
308 extern void trace_input_fpu2
PARAMS ((SIM_DESC sd
,
312 struct _sim_fpu
*f1
));
314 extern void trace_input_fpu3
PARAMS ((SIM_DESC sd
,
319 struct _sim_fpu
*f2
));
321 /* Other trace_input{_<fmt><nr-inputs>} functions can go here */
323 extern void trace_result0
PARAMS ((SIM_DESC sd
,
327 extern void trace_result_word1
PARAMS ((SIM_DESC sd
,
332 extern void trace_result_word2
PARAMS ((SIM_DESC sd
,
338 extern void trace_result_word4
PARAMS ((SIM_DESC sd
,
346 extern void trace_result_bool1
PARAMS ((SIM_DESC sd
,
351 extern void trace_result_addr1
PARAMS ((SIM_DESC sd
,
356 extern void trace_result_fp1
PARAMS ((SIM_DESC sd
,
361 extern void trace_result_fp2
PARAMS ((SIM_DESC sd
,
367 extern void trace_result_fpu1
PARAMS ((SIM_DESC sd
,
370 struct _sim_fpu
*f0
));
372 extern void trace_result_string1
PARAMS ((SIM_DESC sd
,
377 extern void trace_result_word1_string1
PARAMS ((SIM_DESC sd
,
383 /* Other trace_result{_<type><nr-results>} */
386 /* Macros for tracing ALU instructions */
388 #define TRACE_ALU_INPUT0() \
390 if (TRACE_ALU_P (CPU)) \
391 trace_input0 (SD, CPU, TRACE_ALU_IDX); \
394 #define TRACE_ALU_INPUT1(V0) \
396 if (TRACE_ALU_P (CPU)) \
397 trace_input_word1 (SD, CPU, TRACE_ALU_IDX, (V0)); \
400 #define TRACE_ALU_INPUT2(V0,V1) \
402 if (TRACE_ALU_P (CPU)) \
403 trace_input_word2 (SD, CPU, TRACE_ALU_IDX, (V0), (V1)); \
406 #define TRACE_ALU_INPUT3(V0,V1,V2) \
408 if (TRACE_ALU_P (CPU)) \
409 trace_input_word3 (SD, CPU, TRACE_ALU_IDX, (V0), (V1), (V2)); \
412 #define TRACE_ALU_INPUT4(V0,V1,V2,V3) \
414 if (TRACE_ALU_P (CPU)) \
415 trace_input_word4 (SD, CPU, TRACE_ALU_IDX, (V0), (V1), (V2), (V3)); \
418 #define TRACE_ALU_RESULT(R0) TRACE_ALU_RESULT1(R0)
420 #define TRACE_ALU_RESULT0() \
422 if (TRACE_ALU_P (CPU)) \
423 trace_result0 (SD, CPU, TRACE_ALU_IDX); \
426 #define TRACE_ALU_RESULT1(R0) \
428 if (TRACE_ALU_P (CPU)) \
429 trace_result_word1 (SD, CPU, TRACE_ALU_IDX, (R0)); \
432 #define TRACE_ALU_RESULT2(R0,R1) \
434 if (TRACE_ALU_P (CPU)) \
435 trace_result_word2 (SD, CPU, TRACE_ALU_IDX, (R0), (R1)); \
438 #define TRACE_ALU_RESULT4(R0,R1,R2,R3) \
440 if (TRACE_ALU_P (CPU)) \
441 trace_result_word4 (SD, CPU, TRACE_ALU_IDX, (R0), (R1), (R2), (R3)); \
444 /* Macros for tracing inputs to comparative branch instructions. */
446 #define TRACE_BRANCH_INPUT1(V0) \
448 if (TRACE_BRANCH_P (CPU)) \
449 trace_input_word1 (SD, CPU, TRACE_BRANCH_IDX, (V0)); \
452 #define TRACE_BRANCH_INPUT2(V0,V1) \
454 if (TRACE_BRANCH_P (CPU)) \
455 trace_input_word2 (SD, CPU, TRACE_BRANCH_IDX, (V0), (V1)); \
458 /* Macros for tracing FPU instructions */
460 #define TRACE_FP_INPUT0() \
462 if (TRACE_FPU_P (CPU)) \
463 trace_input0 (SD, CPU, TRACE_FPU_IDX); \
466 #define TRACE_FP_INPUT1(V0) \
468 if (TRACE_FPU_P (CPU)) \
469 trace_input_fp1 (SD, CPU, TRACE_FPU_IDX, (V0)); \
472 #define TRACE_FP_INPUT2(V0,V1) \
474 if (TRACE_FPU_P (CPU)) \
475 trace_input_fp2 (SD, CPU, TRACE_FPU_IDX, (V0), (V1)); \
478 #define TRACE_FP_INPUT3(V0,V1,V2) \
480 if (TRACE_FPU_P (CPU)) \
481 trace_input_fp3 (SD, CPU, TRACE_FPU_IDX, (V0), (V1), (V2)); \
484 #define TRACE_FP_INPUT_WORD1(V0) \
486 if (TRACE_FPU_P (CPU)) \
487 trace_input_word1 (SD, CPU, TRACE_FPU_IDX, (V0)); \
490 #define TRACE_FP_RESULT(R0) \
492 if (TRACE_FPU_P (CPU)) \
493 trace_result_fp1 (SD, CPU, TRACE_FPU_IDX, (R0)); \
496 #define TRACE_FP_RESULT2(R0,R1) \
498 if (TRACE_FPU_P (CPU)) \
499 trace_result_fp2 (SD, CPU, TRACE_FPU_IDX, (R0), (R1)); \
502 #define TRACE_FP_RESULT_BOOL(R0) \
504 if (TRACE_FPU_P (CPU)) \
505 trace_result_bool1 (SD, CPU, TRACE_FPU_IDX, (R0)); \
508 #define TRACE_FP_RESULT_WORD(R0) \
510 if (TRACE_FPU_P (CPU)) \
511 trace_result_word1 (SD, CPU, TRACE_FPU_IDX, (R0)); \
515 /* Macros for tracing branches */
517 #define TRACE_BRANCH_INPUT(COND) \
519 if (TRACE_BRANCH_P (CPU)) \
520 trace_input_bool1 (SD, CPU, TRACE_BRANCH_IDX, (COND)); \
523 #define TRACE_BRANCH_RESULT(DEST) \
525 if (TRACE_BRANCH_P (CPU)) \
526 trace_result_addr1 (SD, CPU, TRACE_BRANCH_IDX, (DEST)); \
530 /* The function trace_one_insn has been replaced by the function pair
531 trace_prefix() + trace_generic() */
532 extern void trace_one_insn
PARAMS ((SIM_DESC sd
,
536 const char *file_name
,
541 __attribute__((format (printf
, 8, 9)));
543 extern void trace_printf
PARAMS ((SIM_DESC
, sim_cpu
*, const char *, ...))
544 __attribute__((format (printf
, 3, 4)));
546 extern void trace_vprintf
PARAMS ((SIM_DESC
, sim_cpu
*, const char *, va_list));
549 This is included here because there isn't enough of it to justify
552 /* Return non-zero if debugging of IDX for CPU is enabled. */
553 #define DEBUG_P(cpu, idx) \
554 ((WITH_DEBUG & (1 << (idx))) != 0 \
555 && CPU_DEBUG_FLAGS (cpu)[idx] != 0)
557 /* Non-zero if "--debug-insn" specified. */
558 #define DEBUG_INSN_P(cpu) DEBUG_P (cpu, DEBUG_INSN_IDX)
560 extern void debug_printf
PARAMS ((sim_cpu
*, const char *, ...))
561 __attribute__((format (printf
, 2, 3)));
563 #endif /* SIM_TRACE_H */