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
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
|
%%
%% %CopyrightBegin%
%%
%% Copyright Ericsson AB 1999-2012. 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%
%%
-module(erts_debug).
%% Low-level debugging support. EXPERIMENTAL!
-export([size/1,df/1,df/2,df/3]).
%% This module contains the following *experimental* BIFs:
%% disassemble/1
%% breakpoint/2
%% same/2
%% flat_size/1
%%% BIFs
-export([breakpoint/2, disassemble/1, display/1, dist_ext_to_term/2,
dump_monitors/1, dump_links/1, flat_size/1,
get_internal_state/1, instructions/0, lock_counters/1,
same/2, set_internal_state/2]).
-spec breakpoint(MFA, Flag) -> non_neg_integer() when
MFA :: {Module :: module(),
Function :: atom(),
Arity :: arity() | '_'},
Flag :: boolean().
breakpoint(_, _) ->
erlang:nif_error(undef).
-spec disassemble(What) -> false | undef | Result when
What :: MFA | Address,
Result :: {Address, Code, MFA},
MFA :: mfa(),
Address :: non_neg_integer(),
Code :: binary().
disassemble(_) ->
erlang:nif_error(undef).
-spec display(Term) -> string() when
Term :: term().
display(_) ->
erlang:nif_error(undef).
-spec dist_ext_to_term(Tuple, Binary) -> term() when
Tuple :: tuple(),
Binary :: binary().
dist_ext_to_term(_, _) ->
erlang:nif_error(undef).
-spec dump_monitors(Id) -> true when
Id :: pid() | atom().
dump_monitors(_) ->
erlang:nif_error(undef).
-spec dump_links(Id) -> true when
Id :: pid() | port() | atom().
dump_links(_) ->
erlang:nif_error(undef).
-spec flat_size(Term) -> non_neg_integer() when
Term :: term().
flat_size(_) ->
erlang:nif_error(undef).
-spec get_internal_state(W) -> term() when
W :: reds_left | node_and_dist_references | monitoring_nodes
| next_pid | 'DbTable_words' | check_io_debug
| process_info_args | processes | processes_bif_info
| max_atom_out_cache_index | nbalance | available_internal_state
| force_heap_frags | memory
| {process_status, pid()}
| {link_list, pid() | port() | node()}
| {monitor_list, pid() | node()}
| {channel_number, non_neg_integer()}
| {have_pending_exit, pid() | port() | atom()}
| {binary_info, binary()}
| {term_to_binary_no_funs, term()}
| {dist_port, port()}
| {atom_out_cache_index, atom()}
| {fake_scheduler_bindings,
default_bind | spread | processor_spread | thread_spread
| thread_no_node_processor_spread | no_node_processor_spread
| no_node_thread_spread | no_spread | unbound}
| {reader_groups_map, non_neg_integer()}.
get_internal_state(_) ->
erlang:nif_error(undef).
-spec instructions() -> [string()].
instructions() ->
erlang:nif_error(undef).
-spec lock_counters(info) -> term();
(clear) -> ok;
({copy_save, boolean()}) -> boolean();
({process_locks, boolean()}) -> boolean().
lock_counters(_) ->
erlang:nif_error(undef).
-spec same(Term1, Term2) -> boolean() when
Term1 :: term(),
Term2 :: term().
same(_, _) ->
erlang:nif_error(undef).
-spec set_internal_state(available_internal_state, boolean()) -> boolean();
(reds_left, non_neg_integer()) -> true;
(block, non_neg_integer()) -> true;
(sleep, non_neg_integer()) -> true;
(block_scheduler, non_neg_integer()) -> true;
(next_pid, non_neg_integer()) -> false | integer();
(force_gc, pid() | atom()) -> boolean();
(send_fake_exit_signal, {pid() | port(), pid(), term()}) -> dead | message | unaffected | exit;
(colliding_names, {atom(), non_neg_integer()}) ->
[atom()];
(binary_loop_limit, default) -> -1;
(binary_loop_limit, non_neg_integer()) -> non_neg_integer();
(re_loop_limit, default) -> -1;
(re_loop_limit, non_neg_integer()) -> non_neg_integer();
(unicode_loop_limit, default) -> -1;
(unicode_loop_limit, non_neg_integer()) -> non_neg_integer();
(hipe_test_reschedule_suspend, term()) -> nil();
(hipe_test_reschedule_resume, pid() | port()) -> boolean();
(test_long_gc_sleep, non_neg_integer()) -> true;
(kill_dist_connection, port()) -> boolean();
(not_running_optimization, boolean()) -> boolean();
(wait, deallocations) -> ok.
set_internal_state(_, _) ->
erlang:nif_error(undef).
%%% End of BIFs
%% size(Term)
%% Returns the size of Term in actual heap words. Shared subterms are
%% counted once. Example: If A = [a,b], B =[A,A] then size(B) returns 8,
%% while flat_size(B) returns 12.
-spec size(term()) -> non_neg_integer().
size(Term) ->
{Sum,_} = size(Term, gb_trees:empty(), 0),
Sum.
size([H|T]=Term, Seen0, Sum0) ->
case remember_term(Term, Seen0) of
seen -> {Sum0,Seen0};
Seen1 ->
{Sum,Seen} = size(H, Seen1, Sum0+2),
size(T, Seen, Sum)
end;
size(Tuple, Seen0, Sum0) when is_tuple(Tuple) ->
case remember_term(Tuple, Seen0) of
seen -> {Sum0,Seen0};
Seen ->
Sum = Sum0 + 1 + tuple_size(Tuple),
tuple_size(1, tuple_size(Tuple), Tuple, Seen, Sum)
end;
size(Fun, Seen0, Sum) when is_function(Fun) ->
case remember_term(Fun, Seen0) of
seen -> {Sum,Seen0};
Seen -> fun_size(Fun, Seen, Sum)
end;
size(Term, Seen0, Sum) ->
case erts_debug:flat_size(Term) of
0 -> {Sum,Seen0};
Sz ->
case remember_term(Term, Seen0) of
seen -> {Sum,Seen0};
Seen -> {Sum+Sz,Seen}
end
end.
tuple_size(I, Sz, _, Seen, Sum) when I > Sz ->
{Sum,Seen};
tuple_size(I, Sz, Tuple, Seen0, Sum0) ->
{Sum,Seen} = size(element(I, Tuple), Seen0, Sum0),
tuple_size(I+1, Sz, Tuple, Seen, Sum).
fun_size(Fun, Seen, Sum) ->
case erlang:fun_info(Fun, type) of
{type,external} ->
{Sum + erts_debug:flat_size(Fun),Seen};
{type,local} ->
Sz = erts_debug:flat_size(fun() -> ok end),
{env,Env} = erlang:fun_info(Fun, env),
fun_size_1(Env, Seen, Sum+Sz+length(Env))
end.
fun_size_1([H|T], Seen0, Sum0) ->
{Sum,Seen} = size(H, Seen0, Sum0),
fun_size_1(T, Seen, Sum);
fun_size_1([], Seen, Sum) -> {Sum,Seen}.
remember_term(Term, Seen) ->
case gb_trees:lookup(Term, Seen) of
none -> gb_trees:insert(Term, [Term], Seen);
{value,Terms} ->
case is_term_seen(Term, Terms) of
false -> gb_trees:update(Term, [Term|Terms], Seen);
true -> seen
end
end.
-spec is_term_seen(term(), [term()]) -> boolean().
is_term_seen(Term, [H|T]) ->
case erts_debug:same(Term, H) of
true -> true;
false -> is_term_seen(Term, T)
end;
is_term_seen(_, []) -> false.
%% df(Mod) -- Disassemble Mod to file Mod.dis.
%% df(Mod, Func) -- Disassemble Mod:Func/Any to file Mod_Func.dis.
%% df(Mod, Func, Arity) -- Disassemble Mod:Func/Arity to file Mod_Func_Arity.dis.
-type df_ret() :: 'ok' | {'error', {'badopen', module()}} | {'undef', module()}.
-spec df(module()) -> df_ret().
df(Mod) when is_atom(Mod) ->
try Mod:module_info(functions) of
Fs0 when is_list(Fs0) ->
Name = lists:concat([Mod, ".dis"]),
Fs = [{Mod,Func,Arity} || {Func,Arity} <- Fs0],
dff(Name, Fs)
catch _:_ -> {undef,Mod}
end.
-spec df(module(), atom()) -> df_ret().
df(Mod, Func) when is_atom(Mod), is_atom(Func) ->
try Mod:module_info(functions) of
Fs0 when is_list(Fs0) ->
Name = lists:concat([Mod, "_", Func, ".dis"]),
Fs = [{Mod,Func1,Arity} || {Func1,Arity} <- Fs0, Func1 =:= Func],
dff(Name, Fs)
catch _:_ -> {undef,Mod}
end.
-spec df(module(), atom(), arity()) -> df_ret().
df(Mod, Func, Arity) when is_atom(Mod), is_atom(Func) ->
try Mod:module_info(functions) of
Fs0 when is_list(Fs0) ->
Name = lists:concat([Mod, "_", Func, "_", Arity, ".dis"]),
Fs = [{Mod,Func1,Arity1} || {Func1,Arity1} <- Fs0,
Func1 =:= Func, Arity1 =:= Arity],
dff(Name, Fs)
catch _:_ -> {undef,Mod}
end.
dff(File, Fs) when is_pid(File), is_list(Fs) ->
lists:foreach(fun(Mfa) ->
disassemble_function(File, Mfa),
io:nl(File)
end, Fs);
dff(Name, Fs) when is_list(Name) ->
case file:open(Name, [write]) of
{ok,F} ->
try
dff(F, Fs)
after
file:close(F)
end;
{error,Reason} ->
{error,{badopen,Reason}}
end.
disassemble_function(File, {_,_,_}=MFA) ->
cont_dis(File, erts_debug:disassemble(MFA), MFA).
cont_dis(_, false, _) -> ok;
cont_dis(File, {Addr,Str,MFA}, MFA) ->
io:put_chars(File, binary_to_list(Str)),
cont_dis(File, erts_debug:disassemble(Addr), MFA);
cont_dis(_, {_,_,_}, _) -> ok.
|
