aboutsummaryrefslogtreecommitdiffstats
path: root/erts/emulator/beam/beam_bp.h
blob: 515a06e220de186b69c77683d908bc5e106bc6bc (plain) (blame)
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
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
/*
 * %CopyrightBegin%
 *
 * Copyright Ericsson AB 2000-2010. All Rights Reserved.
 *
 * The contents of this file are subject to the Erlang Public License,
 * Version 1.1, (the "License"); you may not use this file except in
 * compliance with the License. You should have received a copy of the
 * Erlang Public License along with this software. If not, it can be
 * retrieved online at http://www.erlang.org/.
 *
 * Software distributed under the License is distributed on an "AS IS"
 * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
 * the License for the specific language governing rights and limitations
 * under the License.
 *
 * %CopyrightEnd%
 */


#ifndef _BEAM_BP_H
#define _BEAM_BP_H

#include "sys.h"
#include "erl_vm.h"
#include "global.h"



/*
** Common struct to all bp_data_*
**
** Two gotchas: 
**
** 1) The type of bp_data structure in the ring is deduced from the 
**    orig_instr field of the structure _before_ in the ring, except for 
**    the first structure in the ring that has its instruction in
**    pc[0] of the code to execute.
**
** 2) pc[-4] points to the _last_ structure in the ring before the
**    breakpoints are being executed.
**
** So, as an example, when a breakpointed function starts to execute,
** the first instruction that is a breakpoint instruction at pc[0] finds
** its data at ((BpData *) pc[-4])->next and has to cast that pointer 
** to the correct bp_data type.
*/
typedef struct bp_data {
    struct bp_data *next; /* Doubly linked ring pointers */
    struct bp_data *prev; /* -"-                         */
    BeamInstr orig_instr;      /* The original instruction to execute */
} BpData;
/*
** All the following bp_data_.. structs must begin the same way
*/

typedef struct bp_data_trace {
    struct bp_data *next;
    struct bp_data *prev;
    BeamInstr      orig_instr;
    Binary         *match_spec;
    Eterm          tracer_pid;
} BpDataTrace;

typedef struct bp_data_debug {
    struct bp_data *next;
    struct bp_data *prev;
    BeamInstr      orig_instr;
} BpDataDebug;

typedef struct bp_data_count { /* Call count */
    struct bp_data *next;
    struct bp_data *prev;
    BeamInstr       orig_instr;
    Sint            count;
} BpDataCount;

typedef struct {
    Eterm pid;
    Sint  count;
    Uint  s_time;
    Uint  us_time;
} bp_data_time_item_t;

typedef struct {
    Uint n;
    Uint used;
    bp_data_time_item_t *item;
} bp_time_hash_t;

typedef struct bp_data_time { /* Call time */
    struct bp_data *next;
    struct bp_data *prev;
    Uint            orig_instr;
    Uint	    pause;
    Uint	    n;
    bp_time_hash_t  *hash;
} BpDataTime;

typedef struct {
    Uint ms;
    Uint s;
    Uint us;
    BpDataTime *bdt;
} process_breakpoint_time_t; /* used within psd */

extern erts_smp_spinlock_t erts_bp_lock;

#define ERTS_BP_CALL_TIME_SCHEDULE_IN      (0)
#define ERTS_BP_CALL_TIME_SCHEDULE_OUT     (1)
#define ERTS_BP_CALL_TIME_SCHEDULE_EXITING (2)

#define ERTS_BP_CALL_TIME_CALL      (0)
#define ERTS_BP_CALL_TIME_RETURN    (1)
#define ERTS_BP_CALL_TIME_TAIL_CALL (2)

#ifdef ERTS_SMP
#define ErtsSmpBPLock(BDC) erts_smp_spin_lock(&erts_bp_lock)
#define ErtsSmpBPUnlock(BDC) erts_smp_spin_unlock(&erts_bp_lock)
#else
#define ErtsSmpBPLock(BDC)
#define ErtsSmpBPUnlock(BDC)
#endif

#define ErtsCountBreak(pc,instr_result)                     \
do {                                                        \
    BpDataCount *bdc = (BpDataCount *) (pc)[-4];            \
                                                            \
    ASSERT((pc)[-5] == (BeamInstr) BeamOp(op_i_func_info_IaaI)); \
    ASSERT(bdc);                                            \
    bdc = (BpDataCount *) bdc->next;                        \
    ASSERT(bdc);                                            \
    (pc)[-4] = (BeamInstr) bdc;                                  \
    ErtsSmpBPLock(bdc);                                     \
    if (bdc->count >= 0) bdc->count++;                      \
    ErtsSmpBPUnlock(bdc);                                   \
    *(instr_result) = bdc->orig_instr;                      \
} while (0)

#define ErtsTimeBreak(pc,instr_result)                      \
do {                                                        \
    BpDataTime *bdt = (BpDataTime *) (pc)[-4];              \
    Uint ms,s,u;                                            \
                                                            \
    ASSERT((pc)[-5] == (Uint) BeamOp(op_i_func_info_IaaI)); \
    ASSERT(bdt);                                            \
    bdt = (BpDataTime *) bdt->next;                         \
    ASSERT(bdc);                                            \
    (pc)[-4] = (Uint) bdt;                                  \
    get_now(&ms,&s,&u);                                     \
    ErtsSmpBPLock(bdt);                                     \
    if (bdt->count >= 0)                                    \
	bdt->count++;                                       \
    bdt->s_time = 1;                                        \
    bdt->us_time = 1;                                       \
    ErtsSmpBPUnlock(bdt);                                   \
    *(instr_result) = bdt->orig_instr;                      \
} while (0)


#define ErtsBreakSkip(pc,instr_result)                      \
do {                                                        \
    BpData *bd = (BpData *) (pc)[-4];                       \
                                                            \
    ASSERT((pc)[-5] == (BeamInstr) BeamOp(op_i_func_info_IaaI)); \
    ASSERT(bd);                                             \
    bd = bd->next;                                          \
    ASSERT(bd);                                             \
    (pc)[-4] = (BeamInstr) bd;                                   \
    *(instr_result) = bd->orig_instr;                       \
} while (0)

enum erts_break_op{
    erts_break_nop   =  0, /* Must be false */
    erts_break_set   = !0, /* Must be true */
    erts_break_reset,
    erts_break_stop
};



/*
** Function interface exported from beam_bp.c
*/

void erts_bp_init(void);

int erts_set_trace_break(Eterm mfa[3], int specified, Binary *match_spec,
			 Eterm tracer_pid);
int erts_clear_trace_break(Eterm mfa[3], int specified);
int erts_set_mtrace_break(Eterm mfa[3], int specified, Binary *match_spec,
			  Eterm tracer_pid);
int erts_clear_mtrace_break(Eterm mfa[3], int specified);
void erts_set_mtrace_bif(BeamInstr *pc, Binary *match_spec,
			 Eterm tracer_pid);
void erts_clear_mtrace_bif(BeamInstr *pc);
int erts_set_debug_break(Eterm mfa[3], int specified);
int erts_clear_debug_break(Eterm mfa[3], int specified);
int erts_set_count_break(Eterm mfa[3], int specified, enum erts_break_op);
int erts_clear_count_break(Eterm mfa[3], int specified);
int erts_set_time_break(Eterm mfa[3], int specified, enum erts_break_op);
int erts_clear_time_break(Eterm mfa[3], int specified);


int erts_clear_break(Eterm mfa[3], int specified);
int erts_clear_module_break(Module *modp);
int erts_clear_function_break(Module *modp, BeamInstr *pc);

BeamInstr erts_trace_break(Process *p, BeamInstr *pc, Eterm *args,
		      Uint32 *ret_flags, Eterm *tracer_pid);
Uint32 erts_bif_mtrace(Process *p, BeamInstr *pc, Eterm *args,
		       int local, Eterm *tracer_pid);

int erts_is_trace_break(BeamInstr *pc, Binary **match_spec_ret,
			Eterm *tracer_pid_ret);
int erts_is_mtrace_break(BeamInstr *pc, Binary **match_spec_ret,
			 Eterm *tracer_pid_rte);
int erts_is_mtrace_bif(BeamInstr *pc, Binary **match_spec_ret,
		       Eterm *tracer_pid_ret);
int erts_is_native_break(BeamInstr *pc);
int erts_is_count_break(BeamInstr *pc, Sint *count_ret);
int erts_is_time_break(Process *p, BeamInstr *pc, Eterm *call_time);

void erts_do_time_break(Process *p, BpDataTime *bdt, Uint type);
void erts_schedule_time_break(Process *p, Uint out);

BeamInstr *erts_find_local_func(Eterm mfa[3]);

#endif /* _BEAM_BP_H */