forked from arjunjm/SimpleScalar
-
Notifications
You must be signed in to change notification settings - Fork 0
/
ptrace.h
163 lines (140 loc) · 5.77 KB
/
ptrace.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
/* ptrace.h - pipeline tracing definitions and interfaces */
/* SimpleScalar(TM) Tool Suite
* Copyright (C) 1994-2003 by Todd M. Austin, Ph.D. and SimpleScalar, LLC.
* All Rights Reserved.
*
* THIS IS A LEGAL DOCUMENT, BY USING SIMPLESCALAR,
* YOU ARE AGREEING TO THESE TERMS AND CONDITIONS.
*
* No portion of this work may be used by any commercial entity, or for any
* commercial purpose, without the prior, written permission of SimpleScalar,
* LLC ([email protected]). Nonprofit and noncommercial use is permitted
* as described below.
*
* 1. SimpleScalar is provided AS IS, with no warranty of any kind, express
* or implied. The user of the program accepts full responsibility for the
* application of the program and the use of any results.
*
* 2. Nonprofit and noncommercial use is encouraged. SimpleScalar may be
* downloaded, compiled, executed, copied, and modified solely for nonprofit,
* educational, noncommercial research, and noncommercial scholarship
* purposes provided that this notice in its entirety accompanies all copies.
* Copies of the modified software can be delivered to persons who use it
* solely for nonprofit, educational, noncommercial research, and
* noncommercial scholarship purposes provided that this notice in its
* entirety accompanies all copies.
*
* 3. ALL COMMERCIAL USE, AND ALL USE BY FOR PROFIT ENTITIES, IS EXPRESSLY
* PROHIBITED WITHOUT A LICENSE FROM SIMPLESCALAR, LLC ([email protected]).
*
* 4. No nonprofit user may place any restrictions on the use of this software,
* including as modified by the user, by any other authorized user.
*
* 5. Noncommercial and nonprofit users may distribute copies of SimpleScalar
* in compiled or executable form as set forth in Section 2, provided that
* either: (A) it is accompanied by the corresponding machine-readable source
* code, or (B) it is accompanied by a written offer, with no time limit, to
* give anyone a machine-readable copy of the corresponding source code in
* return for reimbursement of the cost of distribution. This written offer
* must permit verbatim duplication by anyone, or (C) it is distributed by
* someone who received only the executable form, and is accompanied by a
* copy of the written offer of source code.
*
* 6. SimpleScalar was developed by Todd M. Austin, Ph.D. The tool suite is
* currently maintained by SimpleScalar LLC ([email protected]). US Mail:
* 2395 Timbercrest Court, Ann Arbor, MI 48105.
*
* Copyright (C) 1994-2003 by Todd M. Austin, Ph.D. and SimpleScalar, LLC.
*/
#ifndef PTRACE_H
#define PTRACE_H
#include "host.h"
#include "misc.h"
#include "machine.h"
#include "range.h"
/*
* pipeline events:
*
* + <iseq> <pc> <addr> <inst> - new instruction def
* - <iseq> - instruction squashed or retired
* @ <cycle> - new cycle def
* * <iseq> <stage> <events> - instruction stage transition
*
*/
/*
[IF] [DA] [EX] [WB] [CT]
aa dd jj ll nn
bb ee kk mm oo
cc pp
*/
/* pipeline stages */
#define PST_IFETCH "IF"
#define PST_DISPATCH "DA"
#define PST_EXECUTE "EX"
#define PST_WRITEBACK "WB"
#define PST_COMMIT "CT"
/* pipeline events */
#define PEV_CACHEMISS 0x00000001 /* I/D-cache miss */
#define PEV_TLBMISS 0x00000002 /* I/D-tlb miss */
#define PEV_MPOCCURED 0x00000004 /* mis-pred branch occurred */
#define PEV_MPDETECT 0x00000008 /* mis-pred branch detected */
#define PEV_AGEN 0x00000010 /* address generation */
/* pipetrace file */
extern FILE *ptrace_outfd;
/* pipetracing is active */
extern int ptrace_active;
/* pipetracing range */
extern struct range_range_t ptrace_range;
/* one-shot switch for pipetracing */
extern int ptrace_oneshot;
/* open pipeline trace */
void
ptrace_open(char *range, /* trace range */
char *fname); /* output filename */
/* close pipeline trace */
void
ptrace_close(void);
/* NOTE: pipetracing is a one-shot switch, since turning on a trace more than
once will mess up the pipetrace viewer */
#define ptrace_check_active(PC, ICNT, CYCLE) \
((ptrace_outfd != NULL \
&& !range_cmp_range1(&ptrace_range, (PC), (ICNT), (CYCLE))) \
? (!ptrace_oneshot ? (ptrace_active = ptrace_oneshot = TRUE) : FALSE)\
: (ptrace_active = FALSE))
/* main interfaces, with fast checks */
#define ptrace_newinst(A,B,C,D) \
if (ptrace_active) __ptrace_newinst((A),(B),(C),(D))
#define ptrace_newuop(A,B,C,D) \
if (ptrace_active) __ptrace_newuop((A),(B),(C),(D))
#define ptrace_endinst(A) \
if (ptrace_active) __ptrace_endinst((A))
#define ptrace_newcycle(A) \
if (ptrace_active) __ptrace_newcycle((A))
#define ptrace_newstage(A,B,C) \
if (ptrace_active) __ptrace_newstage((A),(B),(C))
#define ptrace_active(A,I,C) \
(ptrace_outfd != NULL && !range_cmp_range(&ptrace_range, (A), (I), (C)))
/* declare a new instruction */
void
__ptrace_newinst(unsigned int iseq, /* instruction sequence number */
md_inst_t inst, /* new instruction */
md_addr_t pc, /* program counter of instruction */
md_addr_t addr); /* address referenced, if load/store */
/* declare a new uop */
void
__ptrace_newuop(unsigned int iseq, /* instruction sequence number */
char *uop_desc, /* new uop description */
md_addr_t pc, /* program counter of instruction */
md_addr_t addr); /* address referenced, if load/store */
/* declare instruction retirement or squash */
void
__ptrace_endinst(unsigned int iseq); /* instruction sequence number */
/* declare a new cycle */
void
__ptrace_newcycle(tick_t cycle); /* new cycle */
/* indicate instruction transition to a new pipeline stage */
void
__ptrace_newstage(unsigned int iseq, /* instruction sequence number */
char *pstage, /* pipeline stage entered */
unsigned int pevents);/* pipeline events while in stage */
#endif /* PTRACE_H */