Merge branch 'egil/enforce-tuple-specification-size/OTP-10633'

* egil/enforce-tuple-specification-size/OTP-10633:
  erts: Use memcpy instead of while in setelement/3
  test: Refactor away ?line macro in tuple_SUITE
  erts: Enforce tuple max size on BIFs
  erts: Define max tuple size to 24 bits

4 files changed, 164 insertions, 126 deletions

diff --git a/erts/emulator/beam/bif.c b/erts/emulator/beam/bif.c
index 98dc9a3902..c4ff4fe982 100644
--- a/erts/emulator/beam/bif.c
+++ b/erts/emulator/beam/bif.c
@@ -2421,9 +2421,7 @@ BIF_RETTYPE setelement_3(BIF_ALIST_3)
 
     /* copy the tuple */
     resp = hp;
-    while (size--) {		/* XXX use memcpy? */
-	*hp++ = *ptr++;
-    }
+    sys_memcpy(hp, ptr, sizeof(Eterm)*size);
     resp[ix] = BIF_ARG_3;
     BIF_RET(make_tuple(resp));
 }
@@ -2436,7 +2434,7 @@ BIF_RETTYPE make_tuple_2(BIF_ALIST_2)
     Eterm* hp;
     Eterm res;
 
-    if (is_not_small(BIF_ARG_1) || (n = signed_val(BIF_ARG_1)) < 0) {
+    if (is_not_small(BIF_ARG_1) || (n = signed_val(BIF_ARG_1)) < 0 || n > ERTS_MAX_TUPLE_SIZE) {
 	BIF_ERROR(BIF_P, BADARG);
     }
     hp = HAlloc(BIF_P, n+1);
@@ -2457,7 +2455,7 @@ BIF_RETTYPE make_tuple_3(BIF_ALIST_3)
     Eterm list = BIF_ARG_3;
     Eterm* tup;
 
-    if (is_not_small(BIF_ARG_1) || (n = signed_val(BIF_ARG_1)) < 0) {
+    if (is_not_small(BIF_ARG_1) || (n = signed_val(BIF_ARG_1)) < 0 || n > ERTS_MAX_TUPLE_SIZE) {
     error:
 	BIF_ERROR(BIF_P, BADARG);
     }
@@ -2509,11 +2507,16 @@ BIF_RETTYPE append_element_2(BIF_ALIST_2)
     Eterm res;
 
     if (is_not_tuple(BIF_ARG_1)) {
+    error:
 	BIF_ERROR(BIF_P, BADARG);
     }
-    ptr = tuple_val(BIF_ARG_1);
+    ptr   = tuple_val(BIF_ARG_1);
     arity = arityval(*ptr);
-    hp = HAlloc(BIF_P, arity + 2);
+
+    if (arity + 1 > ERTS_MAX_TUPLE_SIZE)
+	goto error;
+
+    hp  = HAlloc(BIF_P, arity + 2);
     res = make_tuple(hp);
     *hp = make_arityval(arity+1);
     while (arity--) {
@@ -3097,7 +3100,7 @@ BIF_RETTYPE list_to_tuple_1(BIF_ALIST_1)
     Eterm* hp;
     int len;
 
-    if ((len = list_length(list)) < 0) {
+    if ((len = list_length(list)) < 0 || len > ERTS_MAX_TUPLE_SIZE) {
 	BIF_ERROR(BIF_P, BADARG);
     }
 
diff --git a/erts/emulator/beam/erl_term.c b/erts/emulator/beam/erl_term.c
index 6a04c6fc0b..4587cd84d1 100644
--- a/erts/emulator/beam/erl_term.c
+++ b/erts/emulator/beam/erl_term.c
@@ -133,7 +133,7 @@ ET_DEFINE_CHECKED(Uint,unsigned_val,Eterm,is_small);
 ET_DEFINE_CHECKED(Sint,signed_val,Eterm,is_small);
 ET_DEFINE_CHECKED(Uint,atom_val,Eterm,is_atom);
 ET_DEFINE_CHECKED(Uint,header_arity,Eterm,is_header);
-ET_DEFINE_CHECKED(Uint,arityval,Eterm,is_arity_value);
+ET_DEFINE_CHECKED(Uint,arityval,Eterm,is_sane_arity_value);
 ET_DEFINE_CHECKED(Uint,thing_arityval,Eterm,is_thing);
 ET_DEFINE_CHECKED(Uint,thing_subtag,Eterm,is_thing);
 ET_DEFINE_CHECKED(Eterm*,binary_val,Wterm,is_binary);
diff --git a/erts/emulator/beam/erl_term.h b/erts/emulator/beam/erl_term.h
index bc4c3a09a0..fb3ef9cd6c 100644
--- a/erts/emulator/beam/erl_term.h
+++ b/erts/emulator/beam/erl_term.h
@@ -300,8 +300,17 @@ _ET_DECLARE_CHECKED(Uint,header_arity,Eterm)
 #define header_arity(x)	_ET_APPLY(header_arity,(x))
 
 /* arityval access methods */
+/* Erlang Spec. 4.7.3 defines max arity to 65535
+ * we will however enforce max arity of 16777215 (24 bits)
+ * (checked in bifs and asserted in debug)
+ */
+#define MAX_ARITYVAL            ((((Uint)1) << 24) - 1)
+#define ERTS_MAX_TUPLE_SIZE     MAX_ARITYVAL
+
 #define make_arityval(sz)	_make_header((sz),_TAG_HEADER_ARITYVAL)
 #define is_arity_value(x)	(((x) & _TAG_HEADER_MASK) == _TAG_HEADER_ARITYVAL)
+#define is_sane_arity_value(x)	((((x) & _TAG_HEADER_MASK) == _TAG_HEADER_ARITYVAL) && \
+				 (((x) >> _HEADER_ARITY_OFFS) <= MAX_ARITYVAL))
 #define is_not_arity_value(x)	(!is_arity_value((x)))
 #define _unchecked_arityval(x)	_unchecked_header_arity((x))
 _ET_DECLARE_CHECKED(Uint,arityval,Eterm)
diff --git a/erts/emulator/test/tuple_SUITE.erl b/erts/emulator/test/tuple_SUITE.erl
index bfc3910742..978d96a110 100644
--- a/erts/emulator/test/tuple_SUITE.erl
+++ b/erts/emulator/test/tuple_SUITE.erl
@@ -60,40 +60,40 @@ end_per_group(_GroupName, Config) ->
 
 
 build_and_match(Config) when is_list(Config) ->
-    ?line {} = id({}),
-    ?line {1} = id({1}),
-    ?line {1, 2} = id({1, 2}),
-    ?line {1, 2, 3} = id({1, 2, 3}),
-    ?line {1, 2, 3, 4} = id({1, 2, 3, 4}),
-    ?line {1, 2, 3, 4, 5} = id({1, 2, 3, 4, 5}),
-    ?line {1, 2, 3, 4, 5, 6} = id({1, 2, 3, 4, 5, 6}),
-    ?line {1, 2, 3, 4, 5, 6} = id({1, 2, 3, 4, 5, 6}),
-    ?line {1, 2, 3, 4, 5, 6, 7} = id({1, 2, 3, 4, 5, 6, 7}),
-    ?line {1, 2, 3, 4, 5, 6, 7, 8} = id({1, 2, 3, 4, 5, 6, 7, 8}),
+    {} = id({}),
+    {1} = id({1}),
+    {1, 2} = id({1, 2}),
+    {1, 2, 3} = id({1, 2, 3}),
+    {1, 2, 3, 4} = id({1, 2, 3, 4}),
+    {1, 2, 3, 4, 5} = id({1, 2, 3, 4, 5}),
+    {1, 2, 3, 4, 5, 6} = id({1, 2, 3, 4, 5, 6}),
+    {1, 2, 3, 4, 5, 6} = id({1, 2, 3, 4, 5, 6}),
+    {1, 2, 3, 4, 5, 6, 7} = id({1, 2, 3, 4, 5, 6, 7}),
+    {1, 2, 3, 4, 5, 6, 7, 8} = id({1, 2, 3, 4, 5, 6, 7, 8}),
     ok.
 
 %% Tests size(Tuple).
 
 t_size(Config) when is_list(Config) ->
-    ?line 0 = size({}),
-    ?line 1 = size({a}),
-    ?line 1 = size({{a}}),
-    ?line 2 = size({{a}, {b}}),
-    ?line 3 = size({1, 2, 3}),
+    0 = size({}),
+    1 = size({a}),
+    1 = size({{a}}),
+    2 = size({{a}, {b}}),
+    3 = size({1, 2, 3}),
     ok.
 
 t_tuple_size(Config) when is_list(Config) ->
-    ?line 0 = tuple_size(id({})),
-    ?line 1 = tuple_size(id({a})),
-    ?line 1 = tuple_size(id({{a}})),
-    ?line 2 = tuple_size(id({{a},{b}})),
-    ?line 3 = tuple_size(id({1,2,3})),
+    0 = tuple_size(id({})),
+    1 = tuple_size(id({a})),
+    1 = tuple_size(id({{a}})),
+    2 = tuple_size(id({{a},{b}})),
+    3 = tuple_size(id({1,2,3})),
 
     %% Error cases.
-    ?line {'EXIT',{badarg,_}} = (catch tuple_size([])),
-    ?line {'EXIT',{badarg,_}} = (catch tuple_size(<<1,2,3>>)),
-    ?line error = ludicrous_tuple_size({a,b,c}),
-    ?line error = ludicrous_tuple_size([a,b,c]),
+    {'EXIT',{badarg,_}} = (catch tuple_size([])),
+    {'EXIT',{badarg,_}} = (catch tuple_size(<<1,2,3>>)),
+    error = ludicrous_tuple_size({a,b,c}),
+    error = ludicrous_tuple_size([a,b,c]),
     ok.
 
 
@@ -104,44 +104,44 @@ ludicrous_tuple_size(_) -> error.
 %% Tests element/2.
 
 t_element(Config) when is_list(Config) ->
-    ?line a = element(1, {a}),
-    ?line a = element(1, {a, b}),
+    a = element(1, {a}),
+    a = element(1, {a, b}),
 
-    ?line List = lists:seq(1, 4096),
-    ?line Tuple = list_to_tuple(lists:seq(1, 4096)),
-    ?line get_elements(List, Tuple, 1),
+    List = lists:seq(1, 4096),
+    Tuple = list_to_tuple(lists:seq(1, 4096)),
+    get_elements(List, Tuple, 1),
 
-    ?line {'EXIT', {badarg, _}} = (catch element(0, id({a,b}))),
-    ?line {'EXIT', {badarg, _}} = (catch element(3, id({a,b}))),
-    ?line {'EXIT', {badarg, _}} = (catch element(1, id({}))),
-    ?line {'EXIT', {badarg, _}} = (catch element(1, id([a,b]))),
-    ?line {'EXIT', {badarg, _}} = (catch element(1, id(42))),
-    ?line {'EXIT', {badarg, _}} = (catch element(id(1.5), id({a,b}))),
+    {'EXIT', {badarg, _}} = (catch element(0, id({a,b}))),
+    {'EXIT', {badarg, _}} = (catch element(3, id({a,b}))),
+    {'EXIT', {badarg, _}} = (catch element(1, id({}))),
+    {'EXIT', {badarg, _}} = (catch element(1, id([a,b]))),
+    {'EXIT', {badarg, _}} = (catch element(1, id(42))),
+    {'EXIT', {badarg, _}} = (catch element(id(1.5), id({a,b}))),
 
     ok.
 
 get_elements([Element|Rest], Tuple, Pos) ->
-    ?line Element = element(Pos, Tuple),
-    ?line get_elements(Rest, Tuple, Pos+1);
+    Element = element(Pos, Tuple),
+    get_elements(Rest, Tuple, Pos+1);
 get_elements([], _Tuple, _Pos) ->
     ok.
     
 %% Tests set_element/3.
 
 t_setelement(Config) when is_list(Config) ->
-    ?line {x} = setelement(1, id({1}), x),
-    ?line {x,2} = setelement(1, id({1,2}), x),
-    ?line {1,x} = setelement(2, id({1,2}), x),
+    {x} = setelement(1, id({1}), x),
+    {x,2} = setelement(1, id({1,2}), x),
+    {1,x} = setelement(2, id({1,2}), x),
 
-    ?line Tuple = list_to_tuple(lists:duplicate(2048, x)),
-    ?line NewTuple = set_all_elements(Tuple, 1),
-    ?line NewTuple = list_to_tuple(lists:seq(1+7, 2048+7)),
+    Tuple = list_to_tuple(lists:duplicate(2048, x)),
+    NewTuple = set_all_elements(Tuple, 1),
+    NewTuple = list_to_tuple(lists:seq(1+7, 2048+7)),
 
-    ?line {'EXIT', {badarg, _}} = (catch setelement(0, {a, b}, x)),
-    ?line {'EXIT', {badarg, _}} = (catch setelement(3, {a, b}, x)),
-    ?line {'EXIT', {badarg, _}} = (catch setelement(1, {}, x)),
-    ?line {'EXIT', {badarg, _}} = (catch setelement(1, [a, b], x)),
-    ?line {'EXIT', {badarg, _}} = (catch setelement(1.5, {a, b}, x)),
+    {'EXIT', {badarg, _}} = (catch setelement(0, {a, b}, x)),
+    {'EXIT', {badarg, _}} = (catch setelement(3, {a, b}, x)),
+    {'EXIT', {badarg, _}} = (catch setelement(1, {}, x)),
+    {'EXIT', {badarg, _}} = (catch setelement(1, [a, b], x)),
+    {'EXIT', {badarg, _}} = (catch setelement(1.5, {a, b}, x)),
 
     %% Nested setelement with literals.
     AnotherTuple = id({0,0,a,b,c}),
@@ -159,52 +159,68 @@ set_all_elements(Tuple, Pos) when Pos > size(Tuple) ->
 %% Tests list_to_tuple/1.
 
 t_list_to_tuple(Config) when is_list(Config) ->
-    ?line {} = list_to_tuple([]),
-    ?line {a} = list_to_tuple([a]),
-    ?line {a, b} = list_to_tuple([a, b]),
-    ?line {a, b, c} = list_to_tuple([a, b, c]),
-    ?line {a, b, c, d} = list_to_tuple([a, b, c, d]),
-    ?line {a, b, c, d, e} = list_to_tuple([a, b, c, d, e]),
-
-    ?line Size = 4096,
-    ?line Tuple = list_to_tuple(lists:seq(1, Size)),
-    ?line Size = size(Tuple),
-
-    ?line {'EXIT', {badarg, _}} = (catch list_to_tuple(id({a,b}))),
-    ?line {'EXIT', {badarg, _}} = (catch list_to_tuple(id([a|b]))),
-    ?line {'EXIT', {badarg, _}} = (catch list_to_tuple(id([a|b]))),
-
+    {} = list_to_tuple([]),
+    {a} = list_to_tuple([a]),
+    {a, b} = list_to_tuple([a, b]),
+    {a, b, c} = list_to_tuple([a, b, c]),
+    {a, b, c, d} = list_to_tuple([a, b, c, d]),
+    {a, b, c, d, e} = list_to_tuple([a, b, c, d, e]),
+
+    Size  = 4096,
+    Tuple = list_to_tuple(lists:seq(1, Size)),
+    Size  = size(Tuple),
+
+    {'EXIT', {badarg, _}} = (catch list_to_tuple(id({a,b}))),
+    {'EXIT', {badarg, _}} = (catch list_to_tuple(id([a|b]))),
+    {'EXIT', {badarg, _}} = (catch list_to_tuple(id([a|b]))),
+
+    % test upper boundry, 16777215 elements
+    MaxSize  = 1 bsl 24 - 1,
+    MaxTuple = list_to_tuple(lists:seq(1, MaxSize)),
+    MaxSize  = size(MaxTuple),
+
+    {'EXIT', {badarg,_}} = (catch list_to_tuple(lists:seq(1, 1 bsl 24))),
     ok.
 
 %% Tests tuple_to_list/1.
 
 t_tuple_to_list(Config) when is_list(Config) ->
-    ?line [] = tuple_to_list({}),
-    ?line [a] = tuple_to_list({a}),
-    ?line [a, b] = tuple_to_list({a, b}),
-    ?line [a, b, c] = tuple_to_list({a, b, c}),
-    ?line [a, b, c, d] = tuple_to_list({a, b, c, d}),
-    ?line [a, b, c, d] = tuple_to_list({a, b, c, d}),
-
-    ?line Size = 4096,
-    ?line List = lists:seq(1, Size),
-    ?line Tuple = list_to_tuple(List),
-    ?line Size = size(Tuple),
-    ?line List = tuple_to_list(Tuple),
-
-    ?line {'EXIT', {badarg,_}} = (catch tuple_to_list(id(a))),
-    ?line {'EXIT', {badarg,_}} = (catch tuple_to_list(id(42))),
+    [] = tuple_to_list({}),
+    [a] = tuple_to_list({a}),
+    [a, b] = tuple_to_list({a, b}),
+    [a, b, c] = tuple_to_list({a, b, c}),
+    [a, b, c, d] = tuple_to_list({a, b, c, d}),
+    [a, b, c, d] = tuple_to_list({a, b, c, d}),
+
+    Size = 4096,
+    List = lists:seq(1, Size),
+    Tuple = list_to_tuple(List),
+    Size = size(Tuple),
+    List = tuple_to_list(Tuple),
+
+    {'EXIT', {badarg,_}} = (catch tuple_to_list(id(a))),
+    {'EXIT', {badarg,_}} = (catch tuple_to_list(id(42))),
 
     ok.
 
 %% Tests the make_tuple/2 BIF.
 t_make_tuple_2(Config) when is_list(Config) ->
-    ?line t_make_tuple1([]),
-    ?line t_make_tuple1(42),
-    ?line t_make_tuple1(a),
-    ?line t_make_tuple1({}),
-    ?line t_make_tuple1({a}),
-    ?line t_make_tuple1(erlang:make_tuple(400, [])),
+    t_make_tuple1([]),
+    t_make_tuple1(42),
+    t_make_tuple1(a),
+    t_make_tuple1({}),
+    t_make_tuple1({a}),
+    t_make_tuple1(erlang:make_tuple(400, [])),
+
+    % test upper boundry, 16777215 elements
+    t_make_tuple(1 bsl 24 - 1, a),
+    {'EXIT', {badarg,_}} = (catch erlang:make_tuple(1 bsl 24, a)),
+
+    {'EXIT', {badarg,_}} = (catch erlang:make_tuple(-1, a)),
+    % 26 bits is the total header arity room (for now)
+    {'EXIT', {badarg,_}} = (catch erlang:make_tuple(1 bsl 26 + 3, a)),
+    % bignum
+    {'EXIT', {badarg,_}} = (catch erlang:make_tuple(1 bsl 65 + 3, a)),
     ok.
 
 t_make_tuple1(Element) ->
@@ -222,29 +238,39 @@ t_make_tuple(Size, Element) ->
 
 %% Tests the erlang:make_tuple/3 BIF.
 t_make_tuple_3(Config) when is_list(Config) ->
-    ?line {} = erlang:make_tuple(0, def, []),
-    ?line {def} = erlang:make_tuple(1, def, []),
-    ?line {a} = erlang:make_tuple(1, def, [{1,a}]),
-    ?line {a,def,c,def,e} = erlang:make_tuple(5, def, [{5,e},{1,a},{3,c}]),
-    ?line {a,def,c,def,e} = erlang:make_tuple(5, def,
-					      [{1,blurf},{5,e},{3,blurf},
-					       {1,a},{3,c}]),
+    {}    = erlang:make_tuple(0, def, []),
+    {def} = erlang:make_tuple(1, def, []),
+    {a}   = erlang:make_tuple(1, def, [{1,a}]),
+
+    {a,def,c,def,e} = erlang:make_tuple(5, def, [{5,e},{1,a},{3,c}]),
+    {a,def,c,def,e} = erlang:make_tuple(5, def, [{1,blurf},{5,e},{3,blurf},{1,a},{3,c}]),
+    MaxSize  = 1 bsl 16 - 1,
+    MaxTuple = erlang:make_tuple(MaxSize, def, [{1,blurf},{5,e},{3,blurf},{1,a},{3,c}]),
+    MaxSize  = size(MaxTuple),
 
     %% Error cases.
-    ?line {'EXIT',{badarg,_}} = (catch erlang:make_tuple(0, def, [{1,a}])),
-    ?line {'EXIT',{badarg,_}} = (catch erlang:make_tuple(5, def, [{-1,a}])),
-    ?line {'EXIT',{badarg,_}} = (catch erlang:make_tuple(5, def, [{0,a}])),
-    ?line {'EXIT',{badarg,_}} = (catch erlang:make_tuple(5, def, [{6,z}])),
-    ?line {'EXIT',{badarg,_}} = (catch erlang:make_tuple(a, def, [{6,z}])),
-    ?line {'EXIT',{badarg,_}} = (catch erlang:make_tuple(5, def, [{1,a}|b])),
-    ?line {'EXIT',{badarg,_}} = (catch erlang:make_tuple(5, def, [42])),
-    ?line {'EXIT',{badarg,_}} = (catch erlang:make_tuple(5, def, [[a,b,c]])),
-    ?line {'EXIT',{badarg,_}} = (catch erlang:make_tuple(5, def, non_list)),
+    {'EXIT',{badarg,_}} = (catch erlang:make_tuple(0, def, [{1,a}])),
+    {'EXIT',{badarg,_}} = (catch erlang:make_tuple(5, def, [{-1,a}])),
+    {'EXIT',{badarg,_}} = (catch erlang:make_tuple(5, def, [{0,a}])),
+    {'EXIT',{badarg,_}} = (catch erlang:make_tuple(5, def, [{6,z}])),
+    {'EXIT',{badarg,_}} = (catch erlang:make_tuple(a, def, [{6,z}])),
+    {'EXIT',{badarg,_}} = (catch erlang:make_tuple(5, def, [{1,a}|b])),
+    {'EXIT',{badarg,_}} = (catch erlang:make_tuple(5, def, [42])),
+    {'EXIT',{badarg,_}} = (catch erlang:make_tuple(5, def, [[a,b,c]])),
+    {'EXIT',{badarg,_}} = (catch erlang:make_tuple(5, def, non_list)),
+    {'EXIT',{badarg,_}} = (catch erlang:make_tuple(1 bsl 24, def, [{5,e},{1,a},{3,c}])),
+
     ok.
 
 %% Tests the append_element/2 BIF.
 t_append_element(Config) when is_list(Config) ->
-    t_append_element({}, 2048, 2048).
+    ok = t_append_element({}, 2048, 2048),
+
+    % test upper boundry, 16777215 elements
+    MaxSize  = 1 bsl 24 - 1,
+    MaxTuple = list_to_tuple(lists:seq(1, MaxSize)),
+    {'EXIT',{badarg,_}} = (catch erlang:append_element(MaxTuple, a)),
+    ok.
 
 t_append_element(_Tuple, 0, _High) -> ok;
 t_append_element(Tuple, N, High) ->
@@ -261,7 +287,7 @@ verify_seq([High|T], High, Lower) ->
 %% (This is known to crash earlier versions of BEAM.)
 
 tuple_with_case(Config) when is_list(Config) ->
-    ?line {reply, true} = tuple_with_case(),
+    {reply, true} = tuple_with_case(),
     ok.
 
 tuple_with_case() ->
@@ -280,21 +306,21 @@ foo() -> ignored.
 %% Test to build a tuple in a guard.
 
 tuple_in_guard(Config) when is_list(Config) ->
-    ?line Tuple1 = id({a,b}),
-    ?line Tuple2 = id({a,b,c}),
-    ?line if
-	      Tuple1 == {element(1, Tuple2),element(2, Tuple2)} ->
-		  ok;
-	      true ->
-		  ?line test_server:fail()
-	  end,
-    ?line if
-	      Tuple2 == {element(1, Tuple2),element(2, Tuple2),
-			 element(3, Tuple2)} ->
-		  ok;
-	      true ->
-		  ?line test_server:fail()
-	  end,
+    Tuple1 = id({a,b}),
+    Tuple2 = id({a,b,c}),
+    if
+	Tuple1 == {element(1, Tuple2),element(2, Tuple2)} ->
+	    ok;
+	true ->
+	    test_server:fail()
+    end,
+    if
+	Tuple2 == {element(1, Tuple2),element(2, Tuple2),
+	    element(3, Tuple2)} ->
+	    ok;
+	true ->
+	    test_server:fail()
+    end,
     ok.
 
 %% Use this function to avoid compile-time evaluation of an expression.