Merge branch 'sverker/trace-send-receive-matchspec/OTP-13507'

1 files changed, 227 insertions, 22 deletions

diff --git a/erts/emulator/test/trace_SUITE.erl b/erts/emulator/test/trace_SUITE.erl
index 29e043dd5c..da6a6bdea4 100644
--- a/erts/emulator/test/trace_SUITE.erl
+++ b/erts/emulator/test/trace_SUITE.erl
@@ -84,7 +84,6 @@ cpu_timestamp(Config) when is_list(Config) ->
 
 receive_trace(Config) when is_list(Config) ->
     Receiver = fun_spawn(fun receiver/0),
-    process_flag(trap_exit, true),
 
     %% Trace the process; make sure that we receive the trace messages.
     1 = erlang:trace(Receiver, true, ['receive']),
@@ -96,15 +95,116 @@ receive_trace(Config) when is_list(Config) ->
     {trace, Receiver, 'receive', Hello2} = receive_first_trace(),
     receive_nothing(),
 
+    %% Test 'receive' with matchspec
+    F1 = fun ({Pat, IsMatching}) ->
+		 set_trace_pattern('receive', Pat, []),
+		 Receiver ! Hello,
+		 case IsMatching of
+		     true ->
+			 {trace, Receiver, 'receive', Hello} = receive_first_trace();
+		     false ->
+			 ok
+		 end,
+		 receive_nothing()
+	 end,
+    From = self(),
+    Node = node(),
+    lists:foreach(F1, [{no, true},
+		       {[{[Node, undefined,"Unexpected"],[],[]}], false},
+		       {[{[Node, From,'_'],[],[]}], true},
+		       {[{[Node, '$1','_'],[{'=/=','$1',From}],[]}], false},
+		       {[{['$1', '_','_'],[{'=:=','$1',Node}],[]}], true},
+		       {false, false},
+		       {true, true}]),
+
+    %% Remote messages
+    OtherName = atom_to_list(?MODULE)++"_receive_trace",
+    {ok, OtherNode} = start_node(OtherName),
+    RemoteProc = spawn_link(OtherNode, ?MODULE, process, [self()]),
+    io:format("RemoteProc = ~p ~n", [RemoteProc]),
+
+    RemoteProc ! {send_please, Receiver, Hello},
+    {trace, Receiver, 'receive', Hello} = receive_first_trace(),
+    RemoteProc ! {send_please, Receiver, 99},
+    {trace, Receiver, 'receive', 99} = receive_first_trace(),
+
+    %% Remote with matchspec
+    F2 = fun (To, {Pat, IsMatching}) ->
+		 set_trace_pattern('receive', Pat, []),
+		 RemoteProc ! {send_please, To, Hello},
+		 case IsMatching of
+		     true ->
+			 {trace, Receiver, 'receive', Hello} = receive_first_trace();
+		     false ->
+			 ok
+		 end,
+		 receive_nothing()
+	 end,
+    F2(Receiver, {no, true}),
+    F2(Receiver, {[{[OtherNode, undefined,"Unexpected"],[],[]}], false}),
+    F2(Receiver, {[{[OtherNode, RemoteProc,'_'],[],[]},
+		   {[OtherNode, undefined,'_'],[],[]}], true}),
+    F2(Receiver, {[{[OtherNode, '$1','_'],
+		    [{'orelse',{'=:=','$1',undefined},{'=/=',{node,'$1'},{node}}}],
+		    []}], true}),
+    F2(Receiver, {[{['$1', '_','_'], [{'=:=','$1',OtherNode}], []}], true}),
+    F2(Receiver, {false, false}),
+    F2(Receiver, {true, true}),
+
+    %% Remote to named with matchspec
+    Name = trace_SUITE_receiver,
+    register(Name, Receiver),
+    NN = {Name, node()},
+    F2(NN, {no, true}),
+    F2(NN, {[{[OtherNode, undefined,"Unexpected"],[],[]}], false}),
+    F2(NN, {[{[OtherNode, RemoteProc,'_'],[],[]},
+	     {[OtherNode, undefined,'_'],[],[]}], true}),
+    F2(NN, {[{[OtherNode, '$1','_'],
+	      [{'orelse',{'=:=','$1',undefined},{'=/=',{node,'$1'},{node}}}],
+	      []}], true}),
+    F2(NN, {[{['$1', '_','_'], [{'==','$1',OtherNode}], []}], true}),
+    F2(NN, {false, false}),
+    F2(NN, {true, true}),
+
+    unlink(RemoteProc),
+    true = stop_node(OtherNode),
+
+    %% Timeout
+    Receiver ! {set_timeout, 10},
+    {trace, Receiver, 'receive', {set_timeout, 10}} = receive_first_trace(),
+    {trace, Receiver, 'receive', timeout} = receive_first_trace(),
+    erlang:trace_pattern('receive', [{[clock_service,undefined,timeout], [], []}], []),
+    Receiver ! {set_timeout, 7},
+    {trace, Receiver, 'receive', timeout} = receive_first_trace(),
+    erlang:trace_pattern('receive', true, []),
+
     %% Another process should not be able to trace Receiver.
+    process_flag(trap_exit, true),
     Intruder = fun_spawn(fun() -> erlang:trace(Receiver, true, ['receive']) end),
     {'EXIT', Intruder, {badarg, _}} = receive_first(),
 
     %% Untrace the process; we should not receive anything.
-    1 = erlang:trace(Receiver, false, ['receive']),
-    Receiver ! {hello, there},
-    Receiver ! any_garbage,
-    receive_nothing(),
+    ?line 1 = erlang:trace(Receiver, false, ['receive']),
+    ?line Receiver ! {hello, there},
+    ?line Receiver ! any_garbage,
+    ?line receive_nothing(),
+
+    %% Verify restrictions in matchspec for 'receive'
+    F3 = fun (Pat) -> {'EXIT', {badarg,_}} = (catch erlang:trace_pattern('receive', Pat, [])) end,
+    WC = ['_','_','_'],
+    F3([{WC,[],[{message, {process_dump}}]}]),
+    F3([{WC,[{is_seq_trace}],[]}]),
+    F3([{WC,[],[{set_seq_token,label,4711}]}]),
+    F3([{WC,[],[{get_seq_token}]}]),
+    F3([{WC,[],[{enable_trace,call}]}]),
+    F3([{WC,[],[{enable_trace,self(),call}]}]),
+    F3([{WC,[],[{disable_trace,call}]}]),
+    F3([{WC,[],[{disable_trace,self(),call}]}]),
+    F3([{WC,[],[{trace,[call],[]}]}]),
+    F3([{WC,[],[{trace,self(),[],[call]}]}]),
+    F3([{WC,[],[{caller}]}]),
+    F3([{WC,[],[{silent,true}]}]),
+
     ok.
 
 %% Tests that receive of a message always happens before a call with
@@ -257,30 +357,111 @@ send_trace(Config) when is_list(Config) ->
 
     %% Check that a message sent to another process is traced.
     1 = erlang:trace(Sender, true, [send]),
+    F1 = fun (Pat) ->
+		 set_trace_pattern(send, Pat, []),
+		 Sender ! {send_please, Receiver, to_receiver},
+		 {trace, Sender, send, to_receiver, Receiver} = receive_first_trace(),
+		 receive_nothing()
+	 end,
+    lists:foreach(F1, [no,
+		       [{[Receiver,to_receiver],[],[]}],
+		       [{['_','_'],[],[]}],
+		       [{['$1','_'],[{is_pid,'$1'}],[]}],
+		       [{['_','$1'],[{is_atom,'$1'}],[]}],
+		       true]),
+
+    %% Test {message, Msg}
+    F1m = fun ({Pat, Msg}) ->
+		 set_trace_pattern(send, Pat, []),
+		 Sender ! {send_please, Receiver, to_receiver},
+		 {trace, Sender, send, to_receiver, Receiver, Msg} = receive_first_trace(),
+		 receive_nothing()
+	 end,
+    lists:foreach(F1m, [{[{['_','_'],[],[{message, 4711}]}], 4711},
+			{[{['_','_'],[],[{message, "4711"}]}], "4711"}
+		       ]),
+
+    %% Test {message, {process_dump}}
+    set_trace_pattern(send, [{['_','_'],[],[{message, {process_dump}}]}], []),
     Sender ! {send_please, Receiver, to_receiver},
-    {trace, Sender, send, to_receiver, Receiver} = receive_first_trace(),
+    {trace, Sender, send, to_receiver, Receiver, ProcDump} = receive_first_trace(),
+    true = is_binary(ProcDump),
     receive_nothing(),
 
+    %% Same test with false match spec
+    F2 = fun (Pat) ->
+		 set_trace_pattern(send, Pat, []),
+		 Sender ! {send_please, Receiver, to_receiver},
+		 receive_nothing()
+	 end,
+    lists:foreach(F2, [[{[Sender,to_receiver],[],[]}],
+		       [{[Receiver,nomatch],[],[]}],
+		       [{['$1','_'],[{is_atom,'$1'}],[]}],
+		       [{['_','$1'],[{is_pid,'$1'}],[]}],
+		       false,
+		       [{['_','_'],[],[{message,false}]}],
+		       [{['_','_'],[],[{silent,true}]}]]),
+    erlang:trace_pattern(send, true, []),
+    erlang:trace(Sender, false, [silent]),
+
     %% Check that a message sent to another registered process is traced.
     register(?MODULE,Receiver),
-    Sender ! {send_please, ?MODULE, to_receiver},
-    {trace, Sender, send, to_receiver, ?MODULE} = receive_first_trace(),
-    receive_nothing(),
+    F3 = fun (Pat) ->
+		 set_trace_pattern(send, Pat, []),
+		 Sender ! {send_please, ?MODULE, to_receiver},
+		 {trace, Sender, send, to_receiver, ?MODULE} = receive_first_trace(),
+		 receive_nothing()
+	 end,
+    lists:foreach(F3, [no,
+		       [{[?MODULE,to_receiver],[],[]}],
+		       [{['_','_'],[],[]}],
+		       [{['$1','_'],[{is_atom,'$1'}],[]}],
+		       [{['_','$1'],[{is_atom,'$1'}],[]}],
+		       true]),
+    %% Again with false match spec
+    F4 = fun (Pat) ->
+		 set_trace_pattern(send, Pat, []),
+		 Sender ! {send_please, ?MODULE, to_receiver},
+		 receive_nothing()
+	 end,
+    lists:foreach(F4, [[{[nomatch,to_receiver],[],[]}],
+		       [{[?MODULE,nomatch],[],[]}],
+		       [{['$1','_'],[{is_pid,'$1'}],[]}],
+		       [{['_','$1'],[{is_pid,'$1'}],[]}],
+		       [{['_','_'],[],[{message,false}]}],
+		       [{['_','_'],[],[{silent,true}]}]
+		      ]),
     unregister(?MODULE),
+    erlang:trace_pattern(send, true, []),
+    erlang:trace(Sender, false, [silent]),
 
     %% Check that a message sent to this process is traced.
-    Sender ! {send_please, self(), to_myself},
-    receive to_myself -> ok end,
-    Self = self(),
-    {trace, Sender, send, to_myself, Self} = receive_first_trace(),
-    receive_nothing(),
+    F5 = fun (Pat) ->
+		 set_trace_pattern(send, Pat, []),
+		 Sender ! {send_please, self(), to_myself},
+		 receive to_myself -> ok end,
+		 Self = self(),
+		 {trace, Sender, send, to_myself, Self} = receive_first_trace(),
+		 receive_nothing()
+	 end,
+    lists:foreach(F5, [no,
+		       [{[self(),to_myself],[],[]}],
+		       [{['_','_'],[],[]}],
+		       true]),
 
     %% Check that a message sent to dead process is traced.
     {Pid,Ref} = spawn_monitor(fun() -> ok end),
     receive {'DOWN',Ref,_,_,_} -> ok end,
-    Sender ! {send_please, Pid, to_dead},
-    {trace, Sender, send_to_non_existing_process, to_dead, Pid} = receive_first_trace(),
-    receive_nothing(),
+    F6 = fun (Pat) ->
+		 set_trace_pattern(send, Pat, []),
+		 Sender ! {send_please, Pid, to_dead},
+		 {trace, Sender, send_to_non_existing_process, to_dead, Pid} = receive_first_trace(),
+		 receive_nothing()
+	 end,
+    lists:foreach(F6, [no,
+		       [{[Pid,to_dead],[],[]}],
+		       [{['_','_'],[],[]}],
+		       true]),
 
     %% Check that a message sent to unknown registrated process is traced.
     BadargSender = fun_spawn(fun sender/0),
@@ -301,8 +482,26 @@ send_trace(Config) when is_list(Config) ->
     Sender ! {send_please, self(), to_myself_again},
     receive to_myself_again -> ok end,
     receive_nothing(),
+    
+    {'EXIT',{badarg,_}} = (catch erlang:trace_pattern(send, true, [global])),
+    {'EXIT',{badarg,_}} = (catch erlang:trace_pattern(send, true, [local])),
+    {'EXIT',{badarg,_}} = (catch erlang:trace_pattern(send, true, [meta])),
+    {'EXIT',{badarg,_}} = (catch erlang:trace_pattern(send, true, [{meta,self()}])),
+    {'EXIT',{badarg,_}} = (catch erlang:trace_pattern(send, true, [call_count])),
+    {'EXIT',{badarg,_}} = (catch erlang:trace_pattern(send, true, [call_time])),
+    {'EXIT',{badarg,_}} = (catch erlang:trace_pattern(send, restart, [])),
+    {'EXIT',{badarg,_}} = (catch erlang:trace_pattern(send, pause, [])),
+    {'EXIT',{badarg,_}} = (catch erlang:trace_pattern(send, [{['_','_'],[],[{caller}]}], [])),
+
+    %% Done.
     ok.
 
+set_trace_pattern(_, no, _) -> 0;
+set_trace_pattern(MFA, Pat, Flg) ->
+    R = erlang:trace_pattern(MFA, Pat, Flg),
+    {match_spec, Pat} = erlang:trace_info(MFA, match_spec),
+    R.
+
 %% Test trace(Pid, How, [procs]).
 procs_trace(Config) when is_list(Config) ->
     Name = list_to_atom(atom_to_list(?MODULE)++"_procs_trace"),
@@ -438,6 +637,7 @@ dist_procs_trace(Config) when is_list(Config) ->
     Proc2 ! {unlink_please, Proc1},
     {trace, Proc1, getting_unlinked, Proc2} = receive_first_trace(),
     receive_nothing(),
+
     %%
     %% exit (with registered name, due to link)
     Name = list_to_atom(OtherName),
@@ -1516,8 +1716,8 @@ receive_nothing() ->
     receive
         Any ->
             ct:fail({unexpected_message, Any})
-    after 200 ->
-              ok
+    after 100 ->
+	    ok
     end.
 
 
@@ -1592,9 +1792,14 @@ sender() ->
 %% Just consumes messages from its message queue.
 
 receiver() ->
-    receive
-        _Any -> receiver()
-    end.
+    receiver(infinity).
+
+receiver(Timeout) ->
+    receiver(receive
+		 {set_timeout, NewTimeout} -> NewTimeout;
+		 _Any -> Timeout
+	     after Timeout -> infinity  %% reset
+	     end).
 
 %% Works as long as it receives CPU time.  Will always be RUNNABLE.