From afa36d2081927c46a4c3ddceb40276fc7756bb51 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?John=20H=C3=B6gberg?= <john@erlang.org>
Date: Mon, 24 Sep 2018 08:03:21 +0200
Subject: hipe: Document new limitations and disable known failing tests

---
 lib/hipe/doc/src/hipe_app.xml                      |  7 +++
 lib/hipe/test/Makefile                             |  1 -
 .../basic_SUITE_data/basic_inline_function.erl     | 73 ----------------------
 3 files changed, 7 insertions(+), 74 deletions(-)
 delete mode 100644 lib/hipe/test/basic_SUITE_data/basic_inline_function.erl

(limited to 'lib/hipe')

diff --git a/lib/hipe/doc/src/hipe_app.xml b/lib/hipe/doc/src/hipe_app.xml
index 99759a2f2c..480290cd9e 100644
--- a/lib/hipe/doc/src/hipe_app.xml
+++ b/lib/hipe/doc/src/hipe_app.xml
@@ -62,6 +62,13 @@
       and the runtime system that have limited or no support for HiPE compiled modules.
     </p>
     <taglist>
+      <tag>Binary matching</tag>
+      <item><p>The HiPE compiler will crash on modules containing binary
+      matching unless they have been compiled with the <c>+no_bsm3</c> flag.
+      Note that this will disable all related optimizations done by the BEAM
+      compiler.</p>
+      </item>
+
       <tag>Stack traces</tag>
       <item><p>Stack traces returned from <seealso marker="erts:erlang#get_stacktrace/0">
       <c>erlang:get_stacktrace/0</c></seealso> or as part of <c>'EXIT'</c> terms
diff --git a/lib/hipe/test/Makefile b/lib/hipe/test/Makefile
index efeb0887ab..3650cda663 100644
--- a/lib/hipe/test/Makefile
+++ b/lib/hipe/test/Makefile
@@ -13,7 +13,6 @@ MODULES= \
 # .erl files for these modules are automatically generated
 GEN_MODULES= \
 	basic_SUITE \
-	bs_SUITE \
 	maps_SUITE \
 	sanity_SUITE
 
diff --git a/lib/hipe/test/basic_SUITE_data/basic_inline_function.erl b/lib/hipe/test/basic_SUITE_data/basic_inline_function.erl
deleted file mode 100644
index 4c08064670..0000000000
--- a/lib/hipe/test/basic_SUITE_data/basic_inline_function.erl
+++ /dev/null
@@ -1,73 +0,0 @@
-%%% -*- erlang-indent-level: 2 -*-
-%%%-------------------------------------------------------------------
-%%% Author: Kostis Sagonas
-%%%
-%%% Contains tests that depend on the compiler inliner being turned on.
-%%%-------------------------------------------------------------------
--module(basic_inline_function).
-
--export([test/0]).
-
--compile({inline, [{to_objects, 3}]}).
-
-test() ->
-  ok = test_inline_match(),
-  ok.
-
-%%--------------------------------------------------------------------
-
-test_inline_match() ->
-  bad_object = test1(a, {binary, foo, set}, c),
-  bad_object = test2(a, {binary, foo, set}, c),
-  bad_object = test3(a, {binary, foo, set}, c),
-  ok.
-
-%% Inlined
-test1(KeysObjs, C, Ts) ->
-  case catch to_objects(KeysObjs, C, Ts) of
-    {'EXIT', _} ->
-      bad_object;
-    ok ->
-      ok
-  end.
-
-%% "Inlined" by hand
-test2(KeysObjs, C, _Ts) ->
-  case catch (case C of
-		{binary, _, set} ->
-		  <<_ObjSz0:32, _T/binary>> = KeysObjs;
-		_ -> ok
-	      end) of
-    {'EXIT', _} ->
-      bad_object;
-    ok ->
-      ok
-  end.
-
-%% Not inlined
-test3(KeysObjs, C, Ts) ->
-  case catch fto_objects(KeysObjs, C, Ts) of
-    {'EXIT', _} ->
-      bad_object;
-    ok ->
-      ok
-  end.
-
-%% Inlined.
-to_objects(Bin, {binary, _, set}, _Ts) ->
-  <<_ObjSz0:32, _T/binary>> = Bin,
-  ok;
-to_objects(<<_ObjSz0:32, _T/binary>> ,_, _) ->
-  ok;
-to_objects(_Bin, _, _Ts) ->
-  ok.
-
-%% Not Inlined.
-fto_objects(Bin, {binary, _, set}, _Ts) ->
-  <<_ObjSz0:32, _T/binary>> = Bin,
-  ok;
-fto_objects(<<_ObjSz0:32, _T/binary>> ,_,_) ->
-  ok;
-fto_objects(_Bin, _, _Ts) ->
-  ok.
-
-- 
cgit v1.2.3