erts: Implement tracer modules

Add the possibility to use modules as trace data receivers. The functions
in the module have to be nifs as otherwise complex trace probes will be
very hard to handle (complex means trace probes for ports for example).

This commit changes the way that the ptab->tracer field works from always
being an immediate, to now be NIL if no tracer is present or else be
the tuple {TracerModule, TracerState} where TracerModule is an atom that
is later used to lookup the appropriate tracer callbacks to call and
TracerState is just passed to the tracer callback. The default process and
port tracers have been rewritten to use the new API.

This commit also changes the order which trace messages are delivered to the
potential tracer process. Any enif_send done in a tracer module may be delayed
indefinitely because of lock order issues. If a message is delayed any other
trace message send from that process is also delayed so that order is preserved
for each traced entity. This means that for some trace events (i.e. send/receive)
the events may come in an unintuitive order (receive before send) to the
trace receiver. Timestamps are taken when the trace message is generated so
trace messages from differented processes may arrive with the timestamp
out of order.

Both the erlang:trace and seq_trace:set_system_tracer accept the new tracer
module tracers and also the backwards compatible arguments.

OTP-10267

1 files changed, 67 insertions, 31 deletions

diff --git a/erts/emulator/test/match_spec_SUITE.erl b/erts/emulator/test/match_spec_SUITE.erl
index 6b8d14b487..ea973276db 100644
--- a/erts/emulator/test/match_spec_SUITE.erl
+++ b/erts/emulator/test/match_spec_SUITE.erl
@@ -23,7 +23,7 @@
 -export([all/0, suite/0, not_run/1]).
 -export([test_1/1, test_2/1, test_3/1, bad_match_spec_bin/1,
 	 trace_control_word/1, silent/1, silent_no_ms/1, silent_test/1,
-	 ms_trace2/1, ms_trace3/1, boxed_and_small/1,
+	 ms_trace2/1, ms_trace3/1, ms_trace_dead/1, boxed_and_small/1,
 	 destructive_in_test_bif/1, guard_exceptions/1,
 	 empty_list/1,
 	 unary_plus/1, unary_minus/1, moving_labels/1]).
@@ -49,7 +49,7 @@ all() ->
 	false ->
 	    [test_1, test_2, test_3, bad_match_spec_bin,
 	     trace_control_word, silent, silent_no_ms, silent_test, ms_trace2,
-	     ms_trace3, boxed_and_small, destructive_in_test_bif,
+	     ms_trace3, ms_trace_dead, boxed_and_small, destructive_in_test_bif,
 	     guard_exceptions, unary_plus, unary_minus, fpe,
 	     moving_labels,
 	     faulty_seq_trace,
@@ -500,6 +500,8 @@ ms_trace2(Config) when is_list(Config) ->
                  [[call,return_to],[]]},
                 ms_trace2}]
       end),
+    %% Silence valgrind
+    erlang:trace_pattern({?MODULE,fn,'_'},[],[]),
     ok.
 
 
@@ -595,7 +597,35 @@ ms_trace3(Config) when is_list(Config) ->
       end),
     ok.
 
-
+ms_trace_dead(doc) ->
+    ["Test that a dead tracer is removed using ms"];
+ms_trace_dead(suite) -> [];
+ms_trace_dead(Config) when is_list(Config) ->
+    Self = self(),
+    TFun = fun F() -> receive M -> Self ! M, F() end end,
+    {Tracer, MRef} = spawn_monitor(TFun),
+    MetaTracer = spawn_link(TFun),
+    erlang:trace_pattern({?MODULE, f1, '_'},
+                         [{'_',[],[{trace,[],
+                                    [call,{const,{tracer,Tracer}}]}]}],
+                         [{meta, MetaTracer}]),
+    erlang:trace_pattern({?MODULE, f2, '_'}, []),
+    ?MODULE:f2(1,2),
+    ?MODULE:f1(1),
+    {tracer,Tracer} = erlang:trace_info(self(), tracer),
+    {flags,[call]} = erlang:trace_info(self(), flags),
+    ?MODULE:f2(2,3),
+    receive {trace, Self, call, {?MODULE, f2, _}} -> ok end,
+    exit(Tracer, stop),
+    receive {'DOWN',MRef,_,_,_} -> ok end,
+    ?MODULE:f1(2),
+    {tracer,[]} = erlang:trace_info(self(), tracer),
+    ?MODULE:f2(3,4),
+    TRef = erlang:trace_delivered(all),
+    receive {trace_delivered, _, TRef} -> ok end,
+    receive {trace_ts, Self, call, {?MODULE, f1, _}, _} -> ok end,
+    receive {trace_ts, Self, call, {?MODULE, f1, _}, _} -> ok end,
+    receive M -> ct:fail({unexpected, M}) after 10 -> ok end.
 
 %% Test that destructive operations in test bif does not really happen
 destructive_in_test_bif(Config) when is_list(Config) ->
@@ -905,34 +935,40 @@ collect([]) ->
 collect([TM | TMs]) ->
     io:format(        "Expecting:      ~p~n", [TM]),
     receive
-        M0 ->
-            M = case element(1, M0) of
-                    trace_ts ->
-                        list_to_tuple(lists:reverse(
-                                        tl(lists:reverse(tuple_to_list(M0)))));
-                    _ -> M0
-                end,
-            case is_function(TM,1) of
-                true ->
-                    case (catch TM(M)) of
-                        true ->
-                            io:format("Got:            ~p~n", [M]),
-                            collect(TMs);
-                        _ ->
-                            io:format("Got unexpected: ~p~n", [M]),
-                            flush({got_unexpected,M})
-                    end;
-
-                false ->
-                    case M of
-                        TM ->
-                            io:format("Got:            ~p~n", [M]),
-                            collect(TMs);
-                        _ ->
-                            io:format("Got unexpected: ~p~n", [M]),
-                            flush({got_unexpected,M})
-                    end
-            end
+        %% We only look at trace messages with the same tracee
+        %% as the message we are looking for. This because
+        %% the order of trace messages is only guaranteed from
+        %% within a single process.
+	M0 when element(2, M0) =:= element(2, TM); is_function(TM, 1) ->
+	    M = case element(1, M0) of
+		    trace_ts ->
+			list_to_tuple(lists:reverse(
+					tl(lists:reverse(tuple_to_list(M0)))));
+		    _ -> M0
+		end,
+	    case is_function(TM,1) of
+		true ->
+		    case (catch TM(M)) of
+			true ->
+			    io:format("Got:            ~p~n", [M]),
+			    collect(TMs);
+			_ ->
+			    io:format("Got unexpected: ~p~n", [M]),
+			    flush({got_unexpected,M})
+		    end;
+
+		false ->
+		    case M of
+			TM ->
+			    io:format("Got:            ~p~n", [M]),
+			    collect(TMs);
+			_ ->
+			    io:format("Got unexpected: ~p~n", [M]),
+			    flush({got_unexpected,M})
+		    end
+	    end
+    after 15000 ->
+            flush(timeout)
     end.
 
 flush(Reason) ->