Automatic Copyright Year update after running gdb/copyright.py
[deliverable/binutils-gdb.git] / sim / common / sim-trace.h
CommitLineData
c906108c 1/* Simulator tracing/debugging support.
88b9d363 2 Copyright (C) 1997-2022 Free Software Foundation, Inc.
c906108c
SS
3 Contributed by Cygnus Support.
4
5This file is part of GDB, the GNU debugger.
6
7This program is free software; you can redistribute it and/or modify
8it under the terms of the GNU General Public License as published by
4744ac1b
JB
9the Free Software Foundation; either version 3 of the License, or
10(at your option) any later version.
c906108c
SS
11
12This program is distributed in the hope that it will be useful,
13but WITHOUT ANY WARRANTY; without even the implied warranty of
14MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15GNU General Public License for more details.
16
4744ac1b
JB
17You should have received a copy of the GNU General Public License
18along with this program. If not, see <http://www.gnu.org/licenses/>. */
c906108c
SS
19
20/* This file is meant to be included by sim-basics.h. */
21
22#ifndef SIM_TRACE_H
23#define SIM_TRACE_H
24
bfb2629c
MF
25#include "dis-asm.h"
26
c906108c
SS
27/* Standard traceable entities. */
28
29enum {
bfb2629c
MF
30 /* Trace insn execution. The port itself is responsible for displaying what
31 it thinks it is decoding. */
c906108c
SS
32 TRACE_INSN_IDX = 1,
33
bfb2629c
MF
34 /* Disassemble code addresses. Like insn tracing, but relies on the opcode
35 framework for displaying code. Can be slower, more accurate as to what
36 the binary code actually is, but not how the sim is decoding it. */
37 TRACE_DISASM_IDX,
38
c906108c
SS
39 /* Trace insn decoding.
40 ??? This is more of a simulator debugging operation and might best be
41 moved to --debug-decode. */
42 TRACE_DECODE_IDX,
43
44 /* Trace insn extraction.
45 ??? This is more of a simulator debugging operation and might best be
46 moved to --debug-extract. */
47 TRACE_EXTRACT_IDX,
48
49 /* Trace insn execution but include line numbers. */
50 TRACE_LINENUM_IDX,
51
52 /* Trace memory operations.
53 The difference between this and TRACE_CORE_IDX is (I think) that this
54 is intended to apply to a higher level. TRACE_CORE_IDX applies to the
55 low level core operations. */
56 TRACE_MEMORY_IDX,
57
58 /* Include model performance data in tracing output. */
59 TRACE_MODEL_IDX,
60
8371bf0c 61 /* Trace ALU (Arithmetic Logic Unit) operations. */
c906108c
SS
62 TRACE_ALU_IDX,
63
64 /* Trace memory core operations. */
65 TRACE_CORE_IDX,
66
67 /* Trace events. */
68 TRACE_EVENTS_IDX,
69
8371bf0c 70 /* Trace FPU (Floating Point Unit) operations. */
c906108c
SS
71 TRACE_FPU_IDX,
72
8371bf0c 73 /* Trace VPU (Vector Processing Unit) operations. */
01816cd8
BE
74 TRACE_VPU_IDX,
75
c906108c
SS
76 /* Trace branching. */
77 TRACE_BRANCH_IDX,
78
3a49ea9f
MF
79 /* Trace syscalls. */
80 TRACE_SYSCALL_IDX,
81
fa8f87e5
MF
82 /* Trace cpu register accesses. Registers that are part of hardware devices
83 should use the HW_TRACE macros instead. */
84 TRACE_REGISTER_IDX,
85
c906108c
SS
86 /* Add information useful for debugging the simulator to trace output. */
87 TRACE_DEBUG_IDX,
88
89 /* Simulator specific trace bits begin here. */
90 TRACE_NEXT_IDX,
91
92};
93/* Maximum number of traceable entities. */
94#ifndef MAX_TRACE_VALUES
95#define MAX_TRACE_VALUES 32
96#endif
97
98/* The -t option only prints useful values. It's easy to type and shouldn't
99 splat on the screen everything under the sun making nothing easy to
100 find. */
101#define TRACE_USEFUL_MASK \
a6c2a374 102 (TRACE_insn | TRACE_linenum | TRACE_memory | TRACE_model)
c906108c
SS
103\f
104/* Masks so WITH_TRACE can have symbolic values.
105 The case choice here is on purpose. The lowercase parts are args to
106 --with-trace. */
107#define TRACE_insn (1 << TRACE_INSN_IDX)
bfb2629c 108#define TRACE_disasm (1 << TRACE_DISASM_IDX)
c906108c
SS
109#define TRACE_decode (1 << TRACE_DECODE_IDX)
110#define TRACE_extract (1 << TRACE_EXTRACT_IDX)
111#define TRACE_linenum (1 << TRACE_LINENUM_IDX)
112#define TRACE_memory (1 << TRACE_MEMORY_IDX)
113#define TRACE_model (1 << TRACE_MODEL_IDX)
114#define TRACE_alu (1 << TRACE_ALU_IDX)
115#define TRACE_core (1 << TRACE_CORE_IDX)
116#define TRACE_events (1 << TRACE_EVENTS_IDX)
117#define TRACE_fpu (1 << TRACE_FPU_IDX)
01816cd8 118#define TRACE_vpu (1 << TRACE_VPU_IDX)
c906108c 119#define TRACE_branch (1 << TRACE_BRANCH_IDX)
3a49ea9f 120#define TRACE_syscall (1 << TRACE_SYSCALL_IDX)
fa8f87e5 121#define TRACE_register (1 << TRACE_REGISTER_IDX)
c906108c
SS
122#define TRACE_debug (1 << TRACE_DEBUG_IDX)
123
bffcfec8 124/* Return non-zero if tracing of idx is enabled (compiled in). */
9b9c712c 125#define WITH_TRACE_P(idx) (WITH_TRACE & (1 << idx))
bffcfec8
MF
126
127/* Preprocessor macros to simplify tests of WITH_TRACE. */
128#define WITH_TRACE_ANY_P (WITH_TRACE)
9b9c712c 129#define WITH_TRACE_INSN_P WITH_TRACE_P (TRACE_INSN_IDX)
bfb2629c 130#define WITH_TRACE_DISASM_P WITH_TRACE_P (TRACE_DISASM_IDX)
9b9c712c
MF
131#define WITH_TRACE_DECODE_P WITH_TRACE_P (TRACE_DECODE_IDX)
132#define WITH_TRACE_EXTRACT_P WITH_TRACE_P (TRACE_EXTRACT_IDX)
133#define WITH_TRACE_LINENUM_P WITH_TRACE_P (TRACE_LINENUM_IDX)
134#define WITH_TRACE_MEMORY_P WITH_TRACE_P (TRACE_MEMORY_IDX)
135#define WITH_TRACE_MODEL_P WITH_TRACE_P (TRACE_MODEL_IDX)
136#define WITH_TRACE_ALU_P WITH_TRACE_P (TRACE_ALU_IDX)
137#define WITH_TRACE_CORE_P WITH_TRACE_P (TRACE_CORE_IDX)
138#define WITH_TRACE_EVENTS_P WITH_TRACE_P (TRACE_EVENTS_IDX)
139#define WITH_TRACE_FPU_P WITH_TRACE_P (TRACE_FPU_IDX)
140#define WITH_TRACE_VPU_P WITH_TRACE_P (TRACE_VPU_IDX)
141#define WITH_TRACE_BRANCH_P WITH_TRACE_P (TRACE_BRANCH_IDX)
142#define WITH_TRACE_SYSCALL_P WITH_TRACE_P (TRACE_SYSCALL_IDX)
fa8f87e5 143#define WITH_TRACE_REGISTER_P WITH_TRACE_P (TRACE_REGISTER_IDX)
9b9c712c 144#define WITH_TRACE_DEBUG_P WITH_TRACE_P (TRACE_DEBUG_IDX)
c906108c
SS
145\f
146/* Struct containing all system and cpu trace data.
147
148 System trace data is stored with the associated module.
149 System and cpu tracing must share the same space of bitmasks as they
150 are arguments to --with-trace. One could have --with-trace and
151 --with-cpu-trace or some such but that's an over-complication at this point
152 in time. Also, there may be occasions where system and cpu tracing may
153 wish to share a name. */
154
155typedef struct _trace_data {
156
157 /* Global summary of all the current trace options */
158 char trace_any_p;
159
160 /* Boolean array of specified tracing flags. */
161 /* ??? It's not clear that using an array vs a bit mask is faster.
162 Consider the case where one wants to test whether any of several bits
163 are set. */
164 char trace_flags[MAX_TRACE_VALUES];
165#define TRACE_FLAGS(t) ((t)->trace_flags)
166
167 /* Tracing output goes to this or stderr if NULL.
168 We can't store `stderr' here as stderr goes through a callback. */
169 FILE *trace_file;
170#define TRACE_FILE(t) ((t)->trace_file)
171
172 /* Buffer to store the prefix to be printed before any trace line. */
173 char trace_prefix[256];
174#define TRACE_PREFIX(t) ((t)->trace_prefix)
175
176 /* Buffer to save the inputs for the current instruction. Use a
177 union to force the buffer into correct alignment */
178 union {
179 unsigned8 i8;
180 unsigned16 i16;
181 unsigned32 i32;
182 unsigned64 i64;
183 } trace_input_data[16];
184 unsigned8 trace_input_fmt[16];
185 unsigned8 trace_input_size[16];
186 int trace_input_idx;
187#define TRACE_INPUT_DATA(t) ((t)->trace_input_data)
188#define TRACE_INPUT_FMT(t) ((t)->trace_input_fmt)
189#define TRACE_INPUT_SIZE(t) ((t)->trace_input_size)
190#define TRACE_INPUT_IDX(t) ((t)->trace_input_idx)
191
192 /* Category of trace being performed */
193 int trace_idx;
194#define TRACE_IDX(t) ((t)->trace_idx)
195
196 /* Trace range.
197 ??? Not all cpu's support this. */
198 ADDR_RANGE range;
199#define TRACE_RANGE(t) (& (t)->range)
bfb2629c
MF
200
201 /* The bfd used to disassemble code. Should compare against STATE_PROG_BFD
202 before using the disassembler helper.
203 Meant for use by the internal trace module only. */
204 struct bfd *dis_bfd;
205
206 /* The function used to actually disassemble code.
207 Meant for use by the internal trace module only. */
208 disassembler_ftype disassembler;
209
210 /* State used with the disassemble function.
211 Meant for use by the internal trace module only. */
212 disassemble_info dis_info;
c906108c
SS
213} TRACE_DATA;
214\f
215/* System tracing support. */
216
217#define STATE_TRACE_FLAGS(sd) TRACE_FLAGS (STATE_TRACE_DATA (sd))
218
219/* Return non-zero if tracing of IDX is enabled for non-cpu specific
220 components. The "S" in "STRACE" refers to "System". */
221#define STRACE_P(sd,idx) \
9b9c712c 222 (WITH_TRACE_P (idx) && STATE_TRACE_FLAGS (sd)[idx] != 0)
c906108c
SS
223
224/* Non-zero if --trace-<xxxx> was specified for SD. */
bffcfec8 225#define STRACE_ANY_P(sd) (WITH_TRACE_ANY_P && (STATE_TRACE_DATA (sd)->trace_any_p))
ce4eda4a 226#define STRACE_INSN_P(sd) STRACE_P (sd, TRACE_INSN_IDX)
bfb2629c 227#define STRACE_DISASM_P(sd) STRACE_P (sd, TRACE_DISASM_IDX)
ce4eda4a
MF
228#define STRACE_DECODE_P(sd) STRACE_P (sd, TRACE_DECODE_IDX)
229#define STRACE_EXTRACT_P(sd) STRACE_P (sd, TRACE_EXTRACT_IDX)
230#define STRACE_LINENUM_P(sd) STRACE_P (sd, TRACE_LINENUM_IDX)
231#define STRACE_MEMORY_P(sd) STRACE_P (sd, TRACE_MEMORY_IDX)
232#define STRACE_MODEL_P(sd) STRACE_P (sd, TRACE_MODEL_IDX)
233#define STRACE_ALU_P(sd) STRACE_P (sd, TRACE_ALU_IDX)
234#define STRACE_CORE_P(sd) STRACE_P (sd, TRACE_CORE_IDX)
235#define STRACE_EVENTS_P(sd) STRACE_P (sd, TRACE_EVENTS_IDX)
236#define STRACE_FPU_P(sd) STRACE_P (sd, TRACE_FPU_IDX)
237#define STRACE_VPU_P(sd) STRACE_P (sd, TRACE_VPU_IDX)
238#define STRACE_BRANCH_P(sd) STRACE_P (sd, TRACE_BRANCH_IDX)
239#define STRACE_SYSCALL_P(sd) STRACE_P (sd, TRACE_SYSCALL_IDX)
fa8f87e5 240#define STRACE_REGISTER_P(sd) STRACE_P (sd, TRACE_REGISTER_IDX)
c906108c 241#define STRACE_DEBUG_P(sd) STRACE_P (sd, TRACE_DEBUG_IDX)
cf304b56
MF
242
243/* Helper functions for printing messages. */
244#define STRACE(sd, idx, fmt, args...) \
245 do { \
246 if (STRACE_P (sd, idx)) \
247 trace_generic (sd, NULL, idx, fmt, ## args); \
248 } while (0)
249#define STRACE_INSN(sd, fmt, args...) STRACE (sd, TRACE_INSN_IDX, fmt, ## args)
bfb2629c 250#define STRACE_DISASM(sd, fmt, args...) STRACE (sd, TRACE_DISASM_IDX, fmt, ## args)
cf304b56
MF
251#define STRACE_DECODE(sd, fmt, args...) STRACE (sd, TRACE_DECODE_IDX, fmt, ## args)
252#define STRACE_EXTRACT(sd, fmt, args...) STRACE (sd, TRACE_EXTRACT_IDX, fmt, ## args)
253#define STRACE_LINENUM(sd, fmt, args...) STRACE (sd, TRACE_LINENUM_IDX, fmt, ## args)
254#define STRACE_MEMORY(sd, fmt, args...) STRACE (sd, TRACE_MEMORY_IDX, fmt, ## args)
255#define STRACE_MODEL(sd, fmt, args...) STRACE (sd, TRACE_MODEL_IDX, fmt, ## args)
256#define STRACE_ALU(sd, fmt, args...) STRACE (sd, TRACE_ALU_IDX, fmt, ## args)
257#define STRACE_CORE(sd, fmt, args...) STRACE (sd, TRACE_CORE_IDX, fmt, ## args)
258#define STRACE_EVENTS(sd, fmt, args...) STRACE (sd, TRACE_EVENTS_IDX, fmt, ## args)
259#define STRACE_FPU(sd, fmt, args...) STRACE (sd, TRACE_FPU_IDX, fmt, ## args)
260#define STRACE_VPU(sd, fmt, args...) STRACE (sd, TRACE_VPU_IDX, fmt, ## args)
261#define STRACE_BRANCH(sd, fmt, args...) STRACE (sd, TRACE_BRANCH_IDX, fmt, ## args)
262#define STRACE_SYSCALL(sd, fmt, args...) STRACE (sd, TRACE_SYSCALL_IDX, fmt, ## args)
fa8f87e5 263#define STRACE_REGISTER(sd, fmt, args...) STRACE (sd, TRACE_REGISTER_IDX, fmt, ## args)
cf304b56 264#define STRACE_DEBUG(sd, fmt, args...) STRACE (sd, TRACE_DEBUG_IDX, fmt, ## args)
c906108c
SS
265\f
266/* CPU tracing support. */
267
268#define CPU_TRACE_FLAGS(cpu) TRACE_FLAGS (CPU_TRACE_DATA (cpu))
269
270/* Return non-zero if tracing of IDX is enabled for CPU. */
271#define TRACE_P(cpu,idx) \
9b9c712c 272 (WITH_TRACE_P (idx) && CPU_TRACE_FLAGS (cpu)[idx] != 0)
c906108c
SS
273
274/* Non-zero if --trace-<xxxx> was specified for CPU. */
bffcfec8 275#define TRACE_ANY_P(cpu) (WITH_TRACE_ANY_P && (CPU_TRACE_DATA (cpu)->trace_any_p))
c906108c 276#define TRACE_INSN_P(cpu) TRACE_P (cpu, TRACE_INSN_IDX)
bfb2629c 277#define TRACE_DISASM_P(cpu) TRACE_P (cpu, TRACE_DISASM_IDX)
c906108c
SS
278#define TRACE_DECODE_P(cpu) TRACE_P (cpu, TRACE_DECODE_IDX)
279#define TRACE_EXTRACT_P(cpu) TRACE_P (cpu, TRACE_EXTRACT_IDX)
280#define TRACE_LINENUM_P(cpu) TRACE_P (cpu, TRACE_LINENUM_IDX)
281#define TRACE_MEMORY_P(cpu) TRACE_P (cpu, TRACE_MEMORY_IDX)
282#define TRACE_MODEL_P(cpu) TRACE_P (cpu, TRACE_MODEL_IDX)
283#define TRACE_ALU_P(cpu) TRACE_P (cpu, TRACE_ALU_IDX)
284#define TRACE_CORE_P(cpu) TRACE_P (cpu, TRACE_CORE_IDX)
285#define TRACE_EVENTS_P(cpu) TRACE_P (cpu, TRACE_EVENTS_IDX)
286#define TRACE_FPU_P(cpu) TRACE_P (cpu, TRACE_FPU_IDX)
01816cd8 287#define TRACE_VPU_P(cpu) TRACE_P (cpu, TRACE_VPU_IDX)
c906108c 288#define TRACE_BRANCH_P(cpu) TRACE_P (cpu, TRACE_BRANCH_IDX)
3a49ea9f 289#define TRACE_SYSCALL_P(cpu) TRACE_P (cpu, TRACE_SYSCALL_IDX)
fa8f87e5 290#define TRACE_REGISTER_P(cpu) TRACE_P (cpu, TRACE_REGISTER_IDX)
c906108c 291#define TRACE_DEBUG_P(cpu) TRACE_P (cpu, TRACE_DEBUG_IDX)
bfb2629c 292#define TRACE_DISASM_P(cpu) TRACE_P (cpu, TRACE_DISASM_IDX)
bb11f3ed
MF
293
294/* Helper functions for printing messages. */
295#define TRACE(cpu, idx, fmt, args...) \
296 do { \
297 if (TRACE_P (cpu, idx)) \
298 trace_generic (CPU_STATE (cpu), cpu, idx, fmt, ## args); \
299 } while (0)
300#define TRACE_INSN(cpu, fmt, args...) TRACE (cpu, TRACE_INSN_IDX, fmt, ## args)
301#define TRACE_DECODE(cpu, fmt, args...) TRACE (cpu, TRACE_DECODE_IDX, fmt, ## args)
302#define TRACE_EXTRACT(cpu, fmt, args...) TRACE (cpu, TRACE_EXTRACT_IDX, fmt, ## args)
303#define TRACE_LINENUM(cpu, fmt, args...) TRACE (cpu, TRACE_LINENUM_IDX, fmt, ## args)
304#define TRACE_MEMORY(cpu, fmt, args...) TRACE (cpu, TRACE_MEMORY_IDX, fmt, ## args)
305#define TRACE_MODEL(cpu, fmt, args...) TRACE (cpu, TRACE_MODEL_IDX, fmt, ## args)
306#define TRACE_ALU(cpu, fmt, args...) TRACE (cpu, TRACE_ALU_IDX, fmt, ## args)
307#define TRACE_CORE(cpu, fmt, args...) TRACE (cpu, TRACE_CORE_IDX, fmt, ## args)
308#define TRACE_EVENTS(cpu, fmt, args...) TRACE (cpu, TRACE_EVENTS_IDX, fmt, ## args)
309#define TRACE_FPU(cpu, fmt, args...) TRACE (cpu, TRACE_FPU_IDX, fmt, ## args)
310#define TRACE_VPU(cpu, fmt, args...) TRACE (cpu, TRACE_VPU_IDX, fmt, ## args)
311#define TRACE_BRANCH(cpu, fmt, args...) TRACE (cpu, TRACE_BRANCH_IDX, fmt, ## args)
312#define TRACE_SYSCALL(cpu, fmt, args...) TRACE (cpu, TRACE_SYSCALL_IDX, fmt, ## args)
fa8f87e5 313#define TRACE_REGISTER(cpu, fmt, args...) TRACE (cpu, TRACE_REGISTER_IDX, fmt, ## args)
bb11f3ed 314#define TRACE_DEBUG(cpu, fmt, args...) TRACE (cpu, TRACE_DEBUG_IDX, fmt, ## args)
bfb2629c
MF
315#define TRACE_DISASM(cpu, addr) \
316 do { \
317 if (TRACE_DISASM_P (cpu)) \
318 trace_disasm (CPU_STATE (cpu), cpu, addr); \
319 } while (0)
c906108c 320\f
01816cd8 321/* Tracing functions. */
c906108c
SS
322
323/* Prime the trace buffers ready for any trace output.
324 Must be called prior to any other trace operation */
bdca5ee4
TT
325extern void trace_prefix (SIM_DESC sd,
326 sim_cpu *cpu,
327 sim_cia cia,
328 address_word pc,
329 int print_linenum_p,
330 const char *file_name,
331 int line_nr,
332 const char *fmt,
f0c4dc40 333 ...) ATTRIBUTE_PRINTF (8, 9);
c906108c
SS
334
335/* Generic trace print, assumes trace_prefix() has been called */
336
bdca5ee4
TT
337extern void trace_generic (SIM_DESC sd,
338 sim_cpu *cpu,
339 int trace_idx,
340 const char *fmt,
f0c4dc40 341 ...) ATTRIBUTE_PRINTF (4, 5);
c906108c 342
bfb2629c
MF
343/* Disassemble the specified address. */
344
345extern void trace_disasm (SIM_DESC sd, sim_cpu *cpu, address_word addr);
346
2aaed979
KB
347typedef enum {
348 trace_fmt_invalid,
349 trace_fmt_word,
350 trace_fmt_fp,
351 trace_fmt_fpu,
352 trace_fmt_string,
353 trace_fmt_bool,
354 trace_fmt_addr,
355 trace_fmt_instruction_incomplete,
356} data_fmt;
357
c906108c
SS
358/* Trace a varying number of word sized inputs/outputs. trace_result*
359 must be called to close the trace operation. */
360
bdca5ee4
TT
361extern void save_data (SIM_DESC sd,
362 TRACE_DATA *data,
363 data_fmt fmt,
364 long size,
365 const void *buf);
c906108c 366
bdca5ee4
TT
367extern void trace_input0 (SIM_DESC sd,
368 sim_cpu *cpu,
369 int trace_idx);
c906108c 370
bdca5ee4
TT
371extern void trace_input_word1 (SIM_DESC sd,
372 sim_cpu *cpu,
373 int trace_idx,
374 unsigned_word d0);
c906108c 375
bdca5ee4
TT
376extern void trace_input_word2 (SIM_DESC sd,
377 sim_cpu *cpu,
378 int trace_idx,
379 unsigned_word d0,
380 unsigned_word d1);
c906108c 381
bdca5ee4 382extern void trace_input_word3 (SIM_DESC sd,
c906108c
SS
383 sim_cpu *cpu,
384 int trace_idx,
385 unsigned_word d0,
386 unsigned_word d1,
bdca5ee4
TT
387 unsigned_word d2);
388
389extern void trace_input_word4 (SIM_DESC sd,
390 sim_cpu *cpu,
391 int trace_idx,
392 unsigned_word d0,
393 unsigned_word d1,
394 unsigned_word d2,
395 unsigned_word d3);
396
397extern void trace_input_addr1 (SIM_DESC sd,
398 sim_cpu *cpu,
399 int trace_idx,
400 address_word d0);
401
402extern void trace_input_bool1 (SIM_DESC sd,
403 sim_cpu *cpu,
404 int trace_idx,
405 int d0);
406
407extern void trace_input_fp1 (SIM_DESC sd,
408 sim_cpu *cpu,
409 int trace_idx,
410 fp_word f0);
411
412extern void trace_input_fp2 (SIM_DESC sd,
413 sim_cpu *cpu,
414 int trace_idx,
415 fp_word f0,
416 fp_word f1);
417
418extern void trace_input_fp3 (SIM_DESC sd,
419 sim_cpu *cpu,
420 int trace_idx,
421 fp_word f0,
422 fp_word f1,
423 fp_word f2);
424
425extern void trace_input_fpu1 (SIM_DESC sd,
426 sim_cpu *cpu,
427 int trace_idx,
428 struct _sim_fpu *f0);
429
430extern void trace_input_fpu2 (SIM_DESC sd,
431 sim_cpu *cpu,
432 int trace_idx,
433 struct _sim_fpu *f0,
434 struct _sim_fpu *f1);
435
436extern void trace_input_fpu3 (SIM_DESC sd,
437 sim_cpu *cpu,
438 int trace_idx,
439 struct _sim_fpu *f0,
440 struct _sim_fpu *f1,
441 struct _sim_fpu *f2);
c906108c
SS
442
443/* Other trace_input{_<fmt><nr-inputs>} functions can go here */
444
bdca5ee4
TT
445extern void trace_result0 (SIM_DESC sd,
446 sim_cpu *cpu,
447 int trace_idx);
448
449extern void trace_result_word1 (SIM_DESC sd,
450 sim_cpu *cpu,
451 int trace_idx,
452 unsigned_word r0);
453
454extern void trace_result_word2 (SIM_DESC sd,
455 sim_cpu *cpu,
456 int trace_idx,
457 unsigned_word r0,
458 unsigned_word r1);
459
460extern void trace_result_word4 (SIM_DESC sd,
461 sim_cpu *cpu,
462 int trace_idx,
463 unsigned_word r0,
464 unsigned_word r1,
465 unsigned_word r2,
466 unsigned_word r3);
467
468extern void trace_result_bool1 (SIM_DESC sd,
469 sim_cpu *cpu,
470 int trace_idx,
471 int r0);
472
473extern void trace_result_addr1 (SIM_DESC sd,
474 sim_cpu *cpu,
475 int trace_idx,
476 address_word r0);
477
478extern void trace_result_fp1 (SIM_DESC sd,
479 sim_cpu *cpu,
480 int trace_idx,
481 fp_word f0);
482
483extern void trace_result_fp2 (SIM_DESC sd,
484 sim_cpu *cpu,
485 int trace_idx,
486 fp_word f0,
487 fp_word f1);
488
489extern void trace_result_fpu1 (SIM_DESC sd,
490 sim_cpu *cpu,
491 int trace_idx,
492 struct _sim_fpu *f0);
493
494extern void trace_result_string1 (SIM_DESC sd,
495 sim_cpu *cpu,
496 int trace_idx,
497 char *str0);
c906108c 498
bdca5ee4 499extern void trace_result_word1_string1 (SIM_DESC sd,
c906108c
SS
500 sim_cpu *cpu,
501 int trace_idx,
502 unsigned_word r0,
bdca5ee4 503 char *s0);
c906108c
SS
504
505/* Other trace_result{_<type><nr-results>} */
506
507
44a9331c 508/* Macros for tracing ALU instructions */
c906108c
SS
509
510#define TRACE_ALU_INPUT0() \
511do { \
512 if (TRACE_ALU_P (CPU)) \
513 trace_input0 (SD, CPU, TRACE_ALU_IDX); \
514} while (0)
028f6515 515
c906108c
SS
516#define TRACE_ALU_INPUT1(V0) \
517do { \
518 if (TRACE_ALU_P (CPU)) \
519 trace_input_word1 (SD, CPU, TRACE_ALU_IDX, (V0)); \
520} while (0)
521
522#define TRACE_ALU_INPUT2(V0,V1) \
523do { \
524 if (TRACE_ALU_P (CPU)) \
525 trace_input_word2 (SD, CPU, TRACE_ALU_IDX, (V0), (V1)); \
526} while (0)
527
528#define TRACE_ALU_INPUT3(V0,V1,V2) \
529do { \
530 if (TRACE_ALU_P (CPU)) \
531 trace_input_word3 (SD, CPU, TRACE_ALU_IDX, (V0), (V1), (V2)); \
532} while (0)
533
534#define TRACE_ALU_INPUT4(V0,V1,V2,V3) \
535do { \
536 if (TRACE_ALU_P (CPU)) \
537 trace_input_word4 (SD, CPU, TRACE_ALU_IDX, (V0), (V1), (V2), (V3)); \
538} while (0)
539
540#define TRACE_ALU_RESULT(R0) TRACE_ALU_RESULT1(R0)
541
542#define TRACE_ALU_RESULT0() \
543do { \
544 if (TRACE_ALU_P (CPU)) \
545 trace_result0 (SD, CPU, TRACE_ALU_IDX); \
546} while (0)
547
548#define TRACE_ALU_RESULT1(R0) \
549do { \
550 if (TRACE_ALU_P (CPU)) \
551 trace_result_word1 (SD, CPU, TRACE_ALU_IDX, (R0)); \
552} while (0)
553
554#define TRACE_ALU_RESULT2(R0,R1) \
555do { \
556 if (TRACE_ALU_P (CPU)) \
557 trace_result_word2 (SD, CPU, TRACE_ALU_IDX, (R0), (R1)); \
558} while (0)
559
560#define TRACE_ALU_RESULT4(R0,R1,R2,R3) \
561do { \
562 if (TRACE_ALU_P (CPU)) \
563 trace_result_word4 (SD, CPU, TRACE_ALU_IDX, (R0), (R1), (R2), (R3)); \
564} while (0)
565
44a9331c 566/* Macros for tracing inputs to comparative branch instructions. */
c906108c 567
44a9331c
BE
568#define TRACE_BRANCH_INPUT1(V0) \
569do { \
570 if (TRACE_BRANCH_P (CPU)) \
571 trace_input_word1 (SD, CPU, TRACE_BRANCH_IDX, (V0)); \
572} while (0)
573
574#define TRACE_BRANCH_INPUT2(V0,V1) \
575do { \
576 if (TRACE_BRANCH_P (CPU)) \
577 trace_input_word2 (SD, CPU, TRACE_BRANCH_IDX, (V0), (V1)); \
578} while (0)
579
580/* Macros for tracing FPU instructions */
c906108c
SS
581
582#define TRACE_FP_INPUT0() \
583do { \
584 if (TRACE_FPU_P (CPU)) \
585 trace_input0 (SD, CPU, TRACE_FPU_IDX); \
586} while (0)
028f6515 587
c906108c
SS
588#define TRACE_FP_INPUT1(V0) \
589do { \
590 if (TRACE_FPU_P (CPU)) \
591 trace_input_fp1 (SD, CPU, TRACE_FPU_IDX, (V0)); \
592} while (0)
593
594#define TRACE_FP_INPUT2(V0,V1) \
595do { \
596 if (TRACE_FPU_P (CPU)) \
597 trace_input_fp2 (SD, CPU, TRACE_FPU_IDX, (V0), (V1)); \
598} while (0)
599
600#define TRACE_FP_INPUT3(V0,V1,V2) \
601do { \
602 if (TRACE_FPU_P (CPU)) \
603 trace_input_fp3 (SD, CPU, TRACE_FPU_IDX, (V0), (V1), (V2)); \
604} while (0)
605
606#define TRACE_FP_INPUT_WORD1(V0) \
607do { \
608 if (TRACE_FPU_P (CPU)) \
609 trace_input_word1 (SD, CPU, TRACE_FPU_IDX, (V0)); \
610} while (0)
028f6515 611
c906108c
SS
612#define TRACE_FP_RESULT(R0) \
613do { \
614 if (TRACE_FPU_P (CPU)) \
615 trace_result_fp1 (SD, CPU, TRACE_FPU_IDX, (R0)); \
616} while (0)
617
618#define TRACE_FP_RESULT2(R0,R1) \
619do { \
620 if (TRACE_FPU_P (CPU)) \
621 trace_result_fp2 (SD, CPU, TRACE_FPU_IDX, (R0), (R1)); \
622} while (0)
623
624#define TRACE_FP_RESULT_BOOL(R0) \
625do { \
626 if (TRACE_FPU_P (CPU)) \
627 trace_result_bool1 (SD, CPU, TRACE_FPU_IDX, (R0)); \
628} while (0)
629
630#define TRACE_FP_RESULT_WORD(R0) \
631do { \
632 if (TRACE_FPU_P (CPU)) \
633 trace_result_word1 (SD, CPU, TRACE_FPU_IDX, (R0)); \
634} while (0)
635
636
637/* Macros for tracing branches */
638
639#define TRACE_BRANCH_INPUT(COND) \
640do { \
641 if (TRACE_BRANCH_P (CPU)) \
642 trace_input_bool1 (SD, CPU, TRACE_BRANCH_IDX, (COND)); \
643} while (0)
644
645#define TRACE_BRANCH_RESULT(DEST) \
646do { \
647 if (TRACE_BRANCH_P (CPU)) \
648 trace_result_addr1 (SD, CPU, TRACE_BRANCH_IDX, (DEST)); \
649} while (0)
650
651\f
bdca5ee4 652extern void trace_printf (SIM_DESC, sim_cpu *, const char *, ...)
f08708cb 653 ATTRIBUTE_PRINTF (3, 4);
c906108c 654
f08708cb
SM
655extern void trace_vprintf (SIM_DESC, sim_cpu *, const char *, va_list)
656 ATTRIBUTE_PRINTF (3, 0);
c906108c
SS
657
658/* Debug support.
659 This is included here because there isn't enough of it to justify
660 a sim-debug.h. */
661
662/* Return non-zero if debugging of IDX for CPU is enabled. */
663#define DEBUG_P(cpu, idx) \
664((WITH_DEBUG & (1 << (idx))) != 0 \
665 && CPU_DEBUG_FLAGS (cpu)[idx] != 0)
666
667/* Non-zero if "--debug-insn" specified. */
668#define DEBUG_INSN_P(cpu) DEBUG_P (cpu, DEBUG_INSN_IDX)
669
5357150c
MF
670/* Symbol related helpers. */
671int trace_load_symbols (SIM_DESC);
672bfd_vma trace_sym_value (SIM_DESC, const char *name);
673
9b6025d1 674extern void sim_debug_printf (sim_cpu *, const char *, ...)
f0c4dc40 675 ATTRIBUTE_PRINTF (2, 3);
c906108c
SS
676
677#endif /* SIM_TRACE_H */
This page took 1.121197 seconds and 4 git commands to generate.