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
|
%%
%% %CopyrightBegin%
%%
%% Copyright Ericsson AB 1997-2016. All Rights Reserved.
%%
%% Licensed under the Apache License, Version 2.0 (the "License");
%% you may not use this file except in compliance with the License.
%% You may obtain a copy of the License at
%%
%% http://www.apache.org/licenses/LICENSE-2.0
%%
%% Unless required by applicable law or agreed to in writing, software
%% distributed under the License is distributed on an "AS IS" BASIS,
%% WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
%% See the License for the specific language governing permissions and
%% limitations under the License.
%%
%% %CopyrightEnd%
%%
%% Test the garbage collector (or Memory Recycler)
-module(gc_SUITE).
-include_lib("common_test/include/ct.hrl").
-include_lib("eunit/include/eunit.hrl").
-export([all/0, suite/0]).
-export([
grow_heap/1,
grow_stack/1,
grow_stack_heap/1,
max_heap_size/1,
minor_major_gc_option_async/1,
minor_major_gc_option_self/1
]).
suite() ->
[{ct_hooks,[ts_install_cth]}].
all() ->
[grow_heap, grow_stack, grow_stack_heap, max_heap_size,
minor_major_gc_option_self,
minor_major_gc_option_async].
%% Produce a growing list of elements,
%% for X calls, then drop one item per call
%% until the list is empty.
grow_heap(Config) when is_list(Config) ->
ct:timetrap({minutes, 40}),
ok = grow_heap1(256),
ok = grow_heap1(512),
ok = grow_heap1(1024),
ok = grow_heap1(2048),
ok.
grow_heap1(Len) ->
io:format("~ngrow_heap with ~p items.",[Len]),
show_heap("before:"),
grow_heap1([], Len, 0, up),
show_heap("after:").
grow_heap1(List, MaxLen, MaxLen, up) ->
show_heap("top:"),
grow_heap1(List, MaxLen, MaxLen-1, down);
grow_heap1(List, MaxLen, CurLen, up) ->
NewList=[make_arbit()|List],
grow_heap1(NewList, MaxLen, CurLen+1, up);
grow_heap1([], _MaxLen, _, down) ->
ok;
grow_heap1([_|List], MaxLen, CurLen, down) ->
C=erlang:unique_integer([positive]),
Num = C rem (length(List))+1,
Elem = lists:nth(Num, List),
NewList = lists:delete(Elem, List),
grow_heap1(NewList, MaxLen, CurLen-1, down).
%% Increase and decrease stack size, and
%% drop off some garbage from time to time.
grow_stack(Config) when is_list(Config) ->
ct:timetrap({minutes, 80}),
show_heap("before:"),
grow_stack1(200, 0),
show_heap("after:"),
ok.
grow_stack1(0, _) ->
ok;
grow_stack1(Recs, 0) ->
% show_heap("running:"),
grow_stack1(Recs-1, Recs),
grow_stack1(0,0);
grow_stack1(Recs, CurRecs) ->
grow_stack1(Recs, CurRecs-1),
make_arbit(),
grow_stack1(1,0),
ok.
%% Let's see how BEAM handles this one...
%% While growing the heap, bounces the size of the
%% stack, and while reducing the heap, bounces the stack usage.
grow_stack_heap(Config) when is_list(Config) ->
ct:timetrap({minutes, 40}),
grow_stack_heap1(16),
grow_stack_heap1(32),
ok.
grow_stack_heap1(MaxLen) ->
io:format("~ngrow_stack_heap with ~p items.",[MaxLen]),
show_heap("before:"),
grow_stack_heap1([], MaxLen, 0, up),
show_heap("after:").
grow_stack_heap1(List, MaxLen, MaxLen, up) ->
show_heap("top:"),
grow_stack_heap1(List, MaxLen, MaxLen-1, down);
grow_stack_heap1(List, MaxLen, CurLen, up) ->
grow_stack1(CurLen*2,0),
grow_stack_heap1([make_arbit()|List], MaxLen, CurLen+1, up),
ok;
grow_stack_heap1([], _MaxLen, _, down) -> ok;
grow_stack_heap1([_|List], MaxLen, CurLen, down) ->
grow_stack1(CurLen*2,0),
C=erlang:unique_integer([positive]),
Num=C rem (length(List))+1,
Elem=lists:nth(Num, List),
NewList=lists:delete(Elem, List),
grow_stack_heap1(NewList, MaxLen, CurLen-1, down),
ok.
%% Create an arbitrary element/term.
make_arbit() ->
{AA,BB,CC}=erlang:timestamp(),
A=AA+1, B=BB+1, C=(CC+erlang:unique_integer([positive])) rem 1000000 + 1,
New =
case C rem 9 of
0 -> make_string((B div C) +5);
1 -> C;
2 -> make_ref();
3 -> self();
4 -> list_to_binary(make_string((C div B) + 12));
5 -> (C*B)/(A+1);
6 -> list_to_tuple(make_string((B div C) +5));
7 -> list_to_atom(make_string(((C div B) rem 254) + 2));
8 -> fun(X) -> {X,AA,make_string((B div C)+10)} end
end,
New.
%% Create an arbitrary string of a certain length.
make_string(Length) ->
Alph="abcdefghjiklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ"++
"0123456789",
make_string(Alph, Length, []).
make_string(_, 0, Acc) ->
Acc;
make_string(Alph, Length, Acc) ->
C=erlang:unique_integer([positive]),
Pos=1+(Length*C rem length(Alph)),
make_string(Alph, Length-1,
[lists:nth(Pos,Alph)|Acc]).
show_heap(String) ->
garbage_collect(self()),
receive after 1 -> ok end,
{heap_size, HSize}=process_info(self(), heap_size),
{stack_size, SSize}=process_info(self(), stack_size),
io:format("Heap/Stack "++String++"~p/~p", [HSize, SSize]).
%% Test that doing a remote GC that triggers the max heap size
%% kills the process.
max_heap_size(_Config) ->
Pid = spawn_opt(fun long_receive/0,[{max_heap_size, 1024},
{message_queue_data, on_heap}]),
[Pid ! lists:duplicate(I,I) || I <- lists:seq(1,100)],
Ref = erlang:monitor(process, Pid),
%% Force messages to be viewed as part of heap
erlang:process_info(Pid, messages),
%% Do the GC that triggers max heap
erlang:garbage_collect(Pid),
%% Verify that max heap was triggered
receive
{'DOWN', Ref, process, Pid, killed} -> ok
after 5000 ->
ct:fail({process_did_not_die, Pid, erlang:process_info(Pid)})
end.
long_receive() ->
receive
after 10000 ->
ok
end.
minor_major_gc_option_self(_Config) ->
Endless = fun Endless() ->
receive
{gc, Type} -> erlang:garbage_collect(self(), [{type, Type}])
after 100 -> ok end,
Endless()
end,
%% Try as major, a test process will self-trigger GC
P1 = spawn(Endless),
erlang:garbage_collect(P1, []),
erlang:trace(P1, true, [garbage_collection]),
P1 ! {gc, major},
expect_trace_messages(P1, [gc_major_start, gc_major_end]),
erlang:trace(P1, false, [garbage_collection]),
erlang:exit(P1, kill),
%% Try as minor, a test process will self-trigger GC
P2 = spawn(Endless),
erlang:garbage_collect(P2, []),
erlang:trace(P2, true, [garbage_collection]),
P2 ! {gc, minor},
expect_trace_messages(P2, [gc_minor_start, gc_minor_end]),
erlang:trace(P2, false, [garbage_collection]),
erlang:exit(P2, kill).
minor_major_gc_option_async(_Config) ->
Endless = fun Endless() ->
receive after 100 -> ok end,
Endless()
end,
%% Try with default option, must be major gc
P1 = spawn(Endless),
erlang:garbage_collect(P1, []),
erlang:trace(P1, true, [garbage_collection]),
erlang:garbage_collect(P1, []),
expect_trace_messages(P1, [gc_major_start, gc_major_end]),
erlang:trace(P1, false, [garbage_collection]),
erlang:exit(P1, kill),
%% Try with the 'major' type
P2 = spawn(Endless),
erlang:garbage_collect(P2, []),
erlang:trace(P2, true, [garbage_collection]),
erlang:garbage_collect(P2, [{type, major}]),
expect_trace_messages(P2, [gc_major_start, gc_major_end]),
erlang:trace(P2, false, [garbage_collection]),
erlang:exit(P2, kill),
%% Try with 'minor' option, once
P3 = spawn(Endless),
erlang:garbage_collect(P3, []),
erlang:trace(P3, true, [garbage_collection]),
erlang:garbage_collect(P3, [{type, minor}]),
expect_trace_messages(P3, [gc_minor_start, gc_minor_end]),
erlang:trace(P3, false, [garbage_collection]),
erlang:exit(P3, kill),
%% Try with 'minor' option, once, async
P4 = spawn(Endless),
Ref = erlang:make_ref(),
erlang:garbage_collect(P4, []),
erlang:trace(P4, true, [garbage_collection]),
?assertEqual(async,
erlang:garbage_collect(P4, [{type, minor}, {async, Ref}])),
receive
{garbage_collect, Ref, true} ->
ok
after 10000 ->
ct:pal("Did not receive an async GC notification", []),
?assert(false)
end,
expect_trace_messages(P4, [gc_minor_start, gc_minor_end]),
erlang:trace(P4, false, [garbage_collection]),
erlang:exit(P4, kill).
%% Ensures that trace messages with the provided tags have all been received.
%% The test fails if there's any unmatched messages left in the mailbox after
%% all tags have been matched.
expect_trace_messages(_Pid, []) ->
receive
Anything ->
ct:pal("Unexpected message: ~p", [Anything]),
?assert(false)
after 0 ->
ok
end;
expect_trace_messages(Pid, [Tag | TraceTags]) ->
receive
{trace, Pid, Tag, _Data} -> ok
end,
expect_trace_messages(Pid, TraceTags).
|