Merge PR-1632 from margnus1/hipe-receive-opt OTP-14785

HiPE: Optimise receives matching unique references

6 files changed, 133 insertions, 14 deletions

diff --git a/lib/hipe/doc/src/hipe_app.xml b/lib/hipe/doc/src/hipe_app.xml
index 9299c6d73f..aaeb06193d 100644
--- a/lib/hipe/doc/src/hipe_app.xml
+++ b/lib/hipe/doc/src/hipe_app.xml
@@ -99,17 +99,6 @@
       each mode.</p>
       </item>
 
-      <tag>Optimization for <c>receive</c> with unique references</tag>
-      <item><p>The BEAM compiler can do an optimization when
-      a <c>receive</c> statement is <em>only</em> waiting for messages
-      containing a reference created before the receive. All messages
-      that existed in the queue when the reference was created will be
-      bypassed, as they cannot possibly contain the reference. HiPE
-      does not implement this optimization.</p>
-      <p>An example of this is when
-      <c>gen_server:call()</c> waits for the reply message.</p>
-      </item>
-
     </taglist>
   </section>
   <section>
diff --git a/lib/hipe/icode/hipe_beam_to_icode.erl b/lib/hipe/icode/hipe_beam_to_icode.erl
index cb4c1cfbd3..4c7fbad711 100644
--- a/lib/hipe/icode/hipe_beam_to_icode.erl
+++ b/lib/hipe/icode/hipe_beam_to_icode.erl
@@ -415,11 +415,13 @@ trans_fun([{wait_timeout,{_,Lbl},Reg}|Instructions], Env) ->
   SuspTmout = hipe_icode:mk_if(suspend_msg_timeout,[],
 			       map_label(Lbl),hipe_icode:label_name(DoneLbl)),
   Movs ++ [SetTmout, SuspTmout, DoneLbl | trans_fun(Instructions,Env1)];
-%%--- recv_mark/1 & recv_set/1 ---  XXX: Handle better??
+%%--- recv_mark/1 & recv_set/1 ---
 trans_fun([{recv_mark,{f,_}}|Instructions], Env) ->
-  trans_fun(Instructions,Env);
+  Mark = hipe_icode:mk_primop([],recv_mark,[]),
+  [Mark | trans_fun(Instructions,Env)];
 trans_fun([{recv_set,{f,_}}|Instructions], Env) ->
-  trans_fun(Instructions,Env);
+  Set = hipe_icode:mk_primop([],recv_set,[]),
+  [Set | trans_fun(Instructions,Env)];
 %%--------------------------------------------------------------------
 %%--- Translation of arithmetics {bif,ArithOp, ...} ---
 %%--------------------------------------------------------------------
diff --git a/lib/hipe/icode/hipe_icode_primops.erl b/lib/hipe/icode/hipe_icode_primops.erl
index 50ece05259..ec9e3c8608 100644
--- a/lib/hipe/icode/hipe_icode_primops.erl
+++ b/lib/hipe/icode/hipe_icode_primops.erl
@@ -67,6 +67,8 @@ is_safe(fp_mul) -> false;
 is_safe(fp_sub) -> false;
 is_safe(mktuple) -> true;
 is_safe(next_msg) -> false;
+is_safe(recv_mark) -> false;
+is_safe(recv_set) -> false;
 is_safe(redtest) -> false;
 is_safe(select_msg) -> false;
 is_safe(self) -> true;
@@ -165,6 +167,8 @@ fails(fp_mul) -> false;
 fails(fp_sub) -> false;
 fails(mktuple) -> false;
 fails(next_msg) -> false;
+fails(recv_mark) -> false;
+fails(recv_set) -> false;
 fails(redtest) -> false;
 fails(select_msg) -> false;
 fails(self) -> false;
@@ -709,6 +713,10 @@ type(Primop, Args) ->
       erl_types:t_any();
     next_msg ->
       erl_types:t_any();
+    recv_mark ->
+      erl_types:t_any();
+    recv_set ->
+      erl_types:t_any();
     select_msg ->
       erl_types:t_any();
     set_timeout ->
@@ -883,6 +891,10 @@ type(Primop) ->
       erl_types:t_any();
     next_msg ->
       erl_types:t_any();
+    recv_mark ->
+      erl_types:t_any();
+    recv_set ->
+      erl_types:t_any();
     select_msg ->
       erl_types:t_any();
     set_timeout ->
diff --git a/lib/hipe/icode/hipe_icode_range.erl b/lib/hipe/icode/hipe_icode_range.erl
index 287b1c80fe..37360cee73 100644
--- a/lib/hipe/icode/hipe_icode_range.erl
+++ b/lib/hipe/icode/hipe_icode_range.erl
@@ -1160,6 +1160,8 @@ basic_type(#gc_test{}) -> not_analysed;
 %% Message handling
 basic_type(check_get_msg) -> not_analysed;
 basic_type(next_msg) -> not_analysed;
+basic_type(recv_mark) -> not_analysed;
+basic_type(recv_set) -> not_analysed;
 basic_type(select_msg) -> not_analysed;
 basic_type(suspend_msg) -> not_analysed;
 %% Functions
diff --git a/lib/hipe/rtl/hipe_rtl_primops.erl b/lib/hipe/rtl/hipe_rtl_primops.erl
index 850a75f71b..35ae2da895 100644
--- a/lib/hipe/rtl/hipe_rtl_primops.erl
+++ b/lib/hipe/rtl/hipe_rtl_primops.erl
@@ -291,6 +291,10 @@ gen_primop({Op,Dst,Args,Cont,Fail}, IsGuard, ConstTab) ->
 	    gen_select_msg(Dst, Cont);
 	  clear_timeout ->
 	    gen_clear_timeout(Dst, GotoCont);
+          recv_mark ->
+            gen_recv_mark(Dst, GotoCont);
+	  recv_set ->
+            gen_recv_set(Dst, Cont);
 	  set_timeout ->
 	    %% BIF call: am_set_timeout -> nbif_set_timeout -> hipe_set_timeout
 	    [hipe_rtl:mk_call(Dst, set_timeout, Args, Cont, Fail, not_remote)];
@@ -1064,6 +1068,27 @@ gen_tuple_header(Ptr, Arity) ->
 %%%
 %%% Receives
 
+%%% recv_mark is:
+%%%	p->msg.saved_last = p->msg.last;
+gen_recv_mark([], GotoCont) ->
+  TmpLast = hipe_rtl:mk_new_reg(),
+  [load_p_field(TmpLast, ?P_MSG_LAST),
+   store_p_field(TmpLast, ?P_MSG_SAVED_LAST),
+   GotoCont].
+
+%%% recv_set is:
+%%%	if (p->msg.saved_last)
+%%%	    p->msg.save = p->msg.saved_last;
+gen_recv_set([], Cont) ->
+  TmpSave = hipe_rtl:mk_new_reg(),
+  TrueLbl = hipe_rtl:mk_new_label(),
+  [load_p_field(TmpSave, ?P_MSG_SAVED_LAST),
+   hipe_rtl:mk_branch(TmpSave, ne, hipe_rtl:mk_imm(0),
+                      hipe_rtl:label_name(TrueLbl), Cont),
+   TrueLbl,
+   store_p_field(TmpSave, ?P_MSG_SAVE),
+   hipe_rtl:mk_goto(Cont)].
+
 gen_check_get_msg(Dsts, GotoCont, Fail) ->
   gen_check_get_msg_outofline(Dsts, GotoCont, Fail).
 
diff --git a/lib/hipe/test/basic_SUITE_data/basic_receive.erl b/lib/hipe/test/basic_SUITE_data/basic_receive.erl
index 5f865d7b7a..20e3f350e8 100644
--- a/lib/hipe/test/basic_SUITE_data/basic_receive.erl
+++ b/lib/hipe/test/basic_SUITE_data/basic_receive.erl
@@ -12,6 +12,7 @@ test() ->
   ok = test_wait_timeout(),
   ok = test_double_timeout(),
   ok = test_reschedule(),
+  ok = test_recv_mark(),
   ok.
 
 %%--------------------------------------------------------------------
@@ -54,3 +55,91 @@ doit(First) ->
   erts_debug:set_internal_state(hipe_test_reschedule_suspend, 1).
 
 %%--------------------------------------------------------------------
+%% Check that we cannot cause a recv_mark,recv_set pair to misbehave and
+%% deadlock the process.
+
+test_recv_mark() ->
+  ok = test_recv_mark(fun disturber_nop/0),
+  ok = test_recv_mark(fun disturber_receive/0),
+  ok = test_recv_mark(fun disturber_other/0),
+  ok = test_recv_mark(fun disturber_recurse/0),
+  ok = test_recv_mark_after(self(), fun disturber_after_recurse/0, false),
+  ok = test_recv_mark(fun disturber_other_recurse/0),
+  ok = test_recv_mark(fun disturber_other_after/0),
+  ok = test_recv_mark_nested().
+
+test_recv_mark(Disturber) ->
+  Ref = make_ref(),
+  self() ! Ref,
+  Disturber(),
+  receive Ref -> ok
+  after 0 -> error(failure)
+  end.
+
+disturber_nop() -> ok.
+
+disturber_receive() ->
+  self() ! message,
+  receive message -> ok end.
+
+disturber_other() ->
+  Ref = make_ref(),
+  self() ! Ref,
+  receive Ref -> ok end.
+
+disturber_recurse() ->
+  aborted = (catch test_recv_mark(fun() -> throw(aborted) end)),
+  ok.
+
+test_recv_mark_after(Recipient, Disturber, IsInner) ->
+  Ref = make_ref(),
+  Recipient ! Ref,
+  Disturber(),
+  receive
+      Ref -> ok
+  after 0 ->
+          case IsInner of
+              true -> expected;
+              false -> error(failure)
+          end
+  end.
+
+disturber_after_recurse() ->
+  NoOp = fun() -> ok end,
+  BlackHole = spawn(NoOp),
+  expected = test_recv_mark_after(BlackHole, NoOp, true),
+  ok.
+
+disturber_other_recurse() ->
+  aborted = (catch disturber_other_recurse(fun() -> throw(aborted) end)),
+  ok.
+
+disturber_other_recurse(InnerD) ->
+  Ref = make_ref(),
+  self() ! Ref,
+  InnerD(),
+  receive Ref -> ok
+  after 0 -> error(failure)
+  end.
+
+disturber_other_after() ->
+  BlackHole = spawn(fun() -> ok end),
+  Ref = make_ref(),
+  BlackHole ! Ref,
+  receive Ref -> error(imposible)
+  after 0 -> ok
+  end.
+
+test_recv_mark_nested() ->
+  Ref1 = make_ref(),
+  self() ! Ref1,
+  begin
+    Ref2 = make_ref(),
+    self() ! Ref2,
+    receive Ref2 -> ok end
+  end,
+  receive Ref1 -> ok
+  after 0 -> error(failure)
+  end.
+
+%%--------------------------------------------------------------------