summaryrefslogtreecommitdiff
path: root/erts/emulator/test/ref_SUITE.erl
blob: ba590e0a60ac5f42d58725c7e56f13e87aa16a5d (plain)
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
%%
%% %CopyrightBegin%
%% 
%% Copyright Ericsson AB 1999-2021. 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%
%%

-module(ref_SUITE).

-export([all/0, suite/0]).
-export([wrap_1/1]).
-export([compare_list/1, compare_ets/1]).
-export([internal_size/1, external_size/1]).

-export([init_per_testcase/2, end_per_testcase/2]).

-export([loop_ref/1]).

-include_lib("common_test/include/ct.hrl").

suite() ->
    [{ct_hooks,[ts_install_cth]},
     {timetrap, {minutes, 2}}].

init_per_testcase(Func, Config) when is_atom(Func), is_list(Config) ->
    [{testcase, Func}|Config].

end_per_testcase(Func, Config) when is_atom(Func), is_list(Config) ->
    ok.

all() -> 
    [wrap_1, compare_list, compare_ets, internal_size, external_size].

%% Check that refs don't wrap around easily.
wrap_1(Config) when is_list(Config) ->
    spawn_link(?MODULE, loop_ref, [self()]),
    receive
        done ->
            ct:fail(wrapfast)
    after 30000 ->
              ok
    end,
    ok.

loop_ref(Parent) ->
    Ref0 = make_ref(),
    loop_ref(Ref0, first, 0),
    Parent ! done.

loop_ref(R, R, _) -> ok;
loop_ref(R0, _, N) ->
    loop_ref(R0, make_ref(), N+1).

%% Check that ref ordering works
compare_list(Config) when is_list(Config) ->
    %% Although this test uses external refs, it would apply the same to plain refs
    ExtRef1 = <<131,114,0,3,100,0,3,110,64,98,3, 0,0,173,156, 0,216,0,4, 0,0,0,0>>,
    ExtRef2 = <<131,114,0,3,100,0,3,110,64,98,3, 0,1,31,27,   129,4,0,1, 0,0,0,0>>,

    Ref1 = binary_to_term(ExtRef1), %% #Ref<n@b.0.14155780.44444>
    Ref2 = binary_to_term(ExtRef2), %% #Ref<n@b.0.2164523009.73499>
    OrderedList = [Ref1, Ref2],
    OrderedList = lists:sort(OrderedList),
    ok.

%% This is the scarier case since it makes terms "invisible" in ets or Mnesia
%% (the underlying fault cause is the same as compare_list/1)
compare_ets(Config) when is_list(Config) ->
    W2s = [610350147,899574699,2994196869,686384822,2397690439, 923302211],
    ExtRefBase = <<131,114,0,3,100,0,3,110,64,98,3>>,
    ExtRefs = [<<ExtRefBase/binary, 1:32, W2:32, 0:32>> || W2 <- W2s],
    Refs = [binary_to_term(Bin) || Bin <- ExtRefs],

    Ets = ets:new(refbug, [ordered_set]),
    ets:insert(Ets, [{Ref,Ref} || Ref <- Refs]),
    0 = length([R || R <- ets:tab2list(Ets), ets:lookup(Ets, element(1,R)) == []]),
    ok.

internal_size(Config) when is_list(Config) ->
    %% Verifies that the range of heap size used for internal references
    %% matches what the documentation say in the advanced chapter of the
    %% efficiency guide. Note that the values in the efficiency guide
    %% also add the word referencing the heap structure.

    %% Ordinary internal reference
    ORef = check_internal_size(make_ref()),
    io:format("ORef = ~p~n", [ORef]),

    %% Internal pid reference (reference containing a pid)
    PRef = check_internal_size(alias()),
    io:format("PRef = ~p~n", [PRef]),

    %% Internal magic reference
    MRef = check_internal_size(ets:new(blipp, [])),
    io:format("MRef = ~p~n", [MRef]),

    ok.

check_internal_size(Ref) when is_reference(Ref), node(Ref) == node() ->
    case erlang:system_info(wordsize) of
        4 ->
            case erts_debug:size(Ref) of
                Sz when 3 =< Sz, Sz =< 6 ->
                    Sz;
                Sz ->
                    error({internal_ref_size_out_of_range, Sz})
            end;
        8 ->
            case erts_debug:size(Ref) of
                Sz when 3 =< Sz, Sz =< 5 ->
                    Sz;
                Sz ->
                    error({internal_ref_size_out_of_range, Sz})
            end
    end.

external_size(Config) when is_list(Config) ->
    %% Verifies that the range of heap size used for external references
    %% matches what the documentation say in the advanced chapter of the
    %% efficiency guide. Note that the values in the efficiency guide
    %% also add the word referencing the heap structure.
    {ok, Node} = start_node(Config),

    %% Ordinary external reference
    ORef = check_external_size(erpc:call(Node, fun () -> make_ref() end)),
    io:format("ORef = ~p~n", [ORef]),

    %% External pid reference (reference containing a pid) (nothing produce
    %% this yet, but we need to handle it)
    PRef = check_external_size(erts_test_utils:mk_ext_ref({Node, 4711},
                                                          [1, 2, 3, 4, 5])),
    io:format("PRef = ~p~n", [PRef]),


    stop_node(Node),
    ok.

check_external_size(Ref) when is_reference(Ref) ->
    case erlang:system_info(wordsize) of
        4 ->
            case erts_debug:size(Ref) of
                Sz when 6 =< Sz, Sz =< 8 ->
                    Sz;
                Sz ->
                    error({internal_ref_size_out_of_range, Sz})
            end;
        8 ->
            case erts_debug:size(Ref) of
                Sz when 5 =< Sz, Sz =< 6 ->
                    Sz;
                Sz ->
                    error({internal_ref_size_out_of_range, Sz})
            end
    end.

%% Internal stuff...

make_nodename(Config) when is_list(Config) ->
    list_to_atom(atom_to_list(?MODULE)
                 ++ "-"
                 ++ atom_to_list(proplists:get_value(testcase, Config))
                 ++ "-"
                 ++ integer_to_list(erlang:system_time(second))
                 ++ "-"
                 ++ integer_to_list(erlang:unique_integer([positive]))).
    
start_node(Config) ->
    start_node(Config, "").

start_node(Config, Args) when is_list(Config) ->
    Pa = filename:dirname(code:which(?MODULE)),
    Name = make_nodename(Config),
    test_server:start_node(Name, slave, [{args, "-pa "++Pa++" "++Args}]).

stop_node(Node) ->
    test_server:stop_node(Node).