Merge branch 'lukas/erts/tracing/fix-non-smp-trace/OTP-13503'

* lukas/erts/tracing/fix-non-smp-trace/OTP-13503:
  erts: Fix erl_tracer xml doc errors
  erts: Fix bug when tracing in non-smp non-scheduler thread

4 files changed, 114 insertions, 46 deletions

diff --git a/erts/doc/src/erl_tracer.xml b/erts/doc/src/erl_tracer.xml
index 7fd5512b33..d4c8bbad31 100644
--- a/erts/doc/src/erl_tracer.xml
+++ b/erts/doc/src/erl_tracer.xml
@@ -67,7 +67,7 @@
       <desc>
 	<p>The different trace tags that the tracer will be called with.
         Each trace tag is described in greater detail in
-        <seealso marker="#trace">Module:trace/6</seealso>
+        <seealso marker="#Module:trace/6">Module:trace/6</seealso>
         </p>
       </desc>
     </datatype>
@@ -81,7 +81,7 @@
     <datatype>
       <name name="trace_opts" />
       <desc>
-	<p>The options for the tracee.
+	<p>The options for the tracee.</p>
         <taglist>
           <tag><c>timestamp</c></tag>
           <item>If not set to <c>undefined</c>, the tracer has been requested to
@@ -93,7 +93,6 @@
           <item>Set to a number if the scheduler id is to be included by the tracer.
           Otherwise it is set to <c>undefined</c>.</item>
         </taglist>
-        </p>
       </desc>
     </datatype>
     <datatype>
@@ -114,30 +113,30 @@
     <p>The following functions
       should be exported from a <c>erl_tracer</c> callback module.</p>
    <taglist>
-       <tag><seealso marker="#enabled"><c>Module:enabled/3</c></seealso></tag>
+       <tag><seealso marker="#Module:enabled/3"><c>Module:enabled/3</c></seealso></tag>
        <item>Mandatory</item>
-       <tag><seealso marker="#trace"><c>Module:trace/6</c></seealso></tag>
+       <tag><seealso marker="#Module:trace/6"><c>Module:trace/6</c></seealso></tag>
        <item>Mandatory</item>
-       <tag><seealso marker="#enabled_procs"><c>Module:enabled_procs/3</c></seealso></tag>
+       <tag><seealso marker="#Module:enabled_procs/3"><c>Module:enabled_procs/3</c></seealso></tag>
        <item>Optional</item>
-       <tag><seealso marker="#trace_procs"><c>Module:trace_procs/6</c></seealso></tag>
+       <tag><seealso marker="#Module:trace_procs/6"><c>Module:trace_procs/6</c></seealso></tag>
        <item>Optional</item>
-       <tag><seealso marker="#enabled_ports"><c>Module:enabled_ports/3</c></seealso></tag>
+       <tag><seealso marker="#Module:enabled_ports/3"><c>Module:enabled_ports/3</c></seealso></tag>
        <item>Optional</item>
-       <tag><seealso marker="#trace_ports"><c>Module:trace_ports/6</c></seealso></tag>
+       <tag><seealso marker="#Module:trace_ports/6"><c>Module:trace_ports/6</c></seealso></tag>
        <item>Optional</item>
-       <tag><seealso marker="#enabled_running_ports"><c>Module:enabled_running_ports/3</c></seealso></tag>
+       <tag><seealso marker="#Module:enabled_running_ports/3"><c>Module:enabled_running_ports/3</c></seealso></tag>
        <item>Optional</item>
-       <tag><seealso marker="#trace_running_ports"><c>Module:trace_running_ports/6</c></seealso></tag>
+       <tag><seealso marker="#Module:trace_running_ports/6"><c>Module:trace_running_ports/6</c></seealso></tag>
        <item>Optional</item>
-       <tag><seealso marker="#enabled_running_procs"><c>Module:enabled_running_procs/3</c></seealso></tag>
+       <tag><seealso marker="#Module:enabled_running_procs/3"><c>Module:enabled_running_procs/3</c></seealso></tag>
        <item>Optional</item>
-       <tag><seealso marker="#trace_running_procs"><c>Module:trace_running_procs/6</c></seealso></tag>
+       <tag><seealso marker="#Module:trace_running_procs/6"><c>Module:trace_running_procs/6</c></seealso></tag>
        <item>Optional</item>
    </taglist>
 
   </section>
-  <marker id="enabled"></marker>
+
   <funcs>
     <func>
       <name>Module:enabled(TraceTag, TracerState, Tracee) -> Result</name>
@@ -166,7 +165,6 @@
         is important that it is both fast and side effect free.</p>
       </desc>
     </func>
-    <marker id="trace"></marker>
     <func>
       <name>Module:trace(TraceTag, TracerState, Tracee, FirstTraceTerm, SecondTraceTerm, Opts) -> Result</name>
       <fsummary>Check if a trace event should be generated.</fsummary>
@@ -181,7 +179,7 @@
       </type>
       <desc>
         <p>This callback will be called when a tracepoint is triggered and
-        the <seealso marker="#enabled">Module:enabled/3</seealso>
+        the <seealso marker="#Module:enabled/3">Module:enabled/3</seealso>
         callback returned <c>trace</c>. In it any side effects needed by
         the tracer should be done. The tracepoint payload is located in
         the <c>FirstTraceTerm</c> and <c>SecondTraceTerm</c>. The content
@@ -212,7 +210,6 @@
       </desc>
     </func>
 
-    <marker id="enabled_procs"></marker>
     <func>
         <name>Module:enabled_procs(TraceTag, TracerState, Tracee) -> Result</name>
         <fsummary>Check if a trace event should be generated.</fsummary>
@@ -230,7 +227,6 @@
         </desc>
     </func>
 
-    <marker id="trace_procs"></marker>
     <func>
         <name>Module:trace_procs(TraceTag, TracerState, Tracee, FirstTraceTerm, SecondTraceTerm, Opts) -> Result</name>
         <fsummary>Check if a trace event should be generated.</fsummary>
@@ -245,13 +241,12 @@
         </type>
         <desc>
             <p>This callback will be called when a tracepoint is triggered and
-                the <seealso marker="#enabled_procs">Module:enabled_procs/3</seealso>
+                the <seealso marker="#Module:enabled_procs/3">Module:enabled_procs/3</seealso>
                 callback returned <c>trace</c>.</p>
             <p>If <c>trace_procs/6</c> is not defined <c>trace/6</c> will be called instead.</p>
         </desc>
     </func>
 
-    <marker id="enabled_ports"></marker>
     <func>
         <name>Module:enabled_ports(TraceTag, TracerState, Tracee) -> Result</name>
         <fsummary>Check if a trace event should be generated.</fsummary>
@@ -269,7 +264,6 @@
         </desc>
     </func>
 
-    <marker id="trace_ports"></marker>
     <func>
         <name>Module:trace_ports(TraceTag, TracerState, Tracee, FirstTraceTerm, SecondTraceTerm, Opts) -> Result</name>
         <fsummary>Check if a trace event should be generated.</fsummary>
@@ -284,13 +278,12 @@
         </type>
         <desc>
             <p>This callback will be called when a tracepoint is triggered and
-                the <seealso marker="#enabled_ports">Module:enabled_ports/3</seealso>
+                the <seealso marker="#Module:enabled_ports/3">Module:enabled_ports/3</seealso>
                 callback returned <c>trace</c>.</p>
             <p>If <c>trace_ports/6</c> is not defined <c>trace/6</c> will be called instead.</p>
         </desc>
     </func>
 
-    <marker id="enabled_running_procs"></marker>
     <func>
         <name>Module:enabled_running_procs(TraceTag, TracerState, Tracee) -> Result</name>
         <fsummary>Check if a trace event should be generated.</fsummary>
@@ -308,7 +301,6 @@
         </desc>
     </func>
 
-    <marker id="trace_running_procs"></marker>
     <func>
         <name>Module:trace_running_procs(TraceTag, TracerState, Tracee, FirstTraceTerm, SecondTraceTerm, Opts) -> Result</name>
         <fsummary>Check if a trace event should be generated.</fsummary>
@@ -323,13 +315,12 @@
         </type>
         <desc>
             <p>This callback will be called when a tracepoint is triggered and
-                the <seealso marker="#enabled_running_procs">Module:enabled_running_procs/3</seealso>
+                the <seealso marker="#Module:enabled_running_procs/3">Module:enabled_running_procs/3</seealso>
                 callback returned <c>trace</c>.</p>
             <p>If <c>trace_running_procs/6</c> is not defined <c>trace/6</c> will be called instead.</p>
         </desc>
     </func>
 
-    <marker id="enabled_running_ports"></marker>
     <func>
         <name>Module:enabled_running_ports(TraceTag, TracerState, Tracee) -> Result</name>
         <fsummary>Check if a trace event should be generated.</fsummary>
@@ -347,7 +338,6 @@
         </desc>
     </func>
 
-    <marker id="trace_running_ports"></marker>
     <func>
         <name>Module:trace_running_ports(TraceTag, TracerState, Tracee, FirstTraceTerm, SecondTraceTerm, Opts) -> Result</name>
         <fsummary>Check if a trace event should be generated.</fsummary>
@@ -362,13 +352,12 @@
         </type>
         <desc>
             <p>This callback will be called when a tracepoint is triggered and
-                the <seealso marker="#enabled_running_ports">Module:enabled_running_ports/3</seealso>
+                the <seealso marker="#Module:enabled_running_ports/3">Module:enabled_running_ports/3</seealso>
                 callback returned <c>trace</c>.</p>
             <p>If <c>trace_running_ports/6</c> is not defined <c>trace/6</c> will be called instead.</p>
         </desc>
     </func>
 
-    <marker id="enabled_call"></marker>
     <func>
         <name>Module:enabled_call(TraceTag, TracerState, Tracee) -> Result</name>
         <fsummary>Check if a trace event should be generated.</fsummary>
@@ -386,7 +375,6 @@
         </desc>
     </func>
 
-    <marker id="trace_call"></marker>
     <func>
         <name>Module:trace_call(TraceTag, TracerState, Tracee, FirstTraceTerm, SecondTraceTerm, Opts) -> Result</name>
         <fsummary>Check if a trace event should be generated.</fsummary>
@@ -401,13 +389,12 @@
         </type>
         <desc>
             <p>This callback will be called when a tracepoint is triggered and
-                the <seealso marker="#enabled_call">Module:enabled_call/3</seealso>
+                the <seealso marker="#Module:enabled_call/3">Module:enabled_call/3</seealso>
                 callback returned <c>trace</c>.</p>
             <p>If <c>trace_call/6</c> is not defined <c>trace/6</c> will be called instead.</p>
         </desc>
     </func>
 
-    <marker id="enabled_send"></marker>
     <func>
         <name>Module:enabled_send(TraceTag, TracerState, Tracee) -> Result</name>
         <fsummary>Check if a trace event should be generated.</fsummary>
@@ -425,7 +412,6 @@
         </desc>
     </func>
 
-    <marker id="trace_send"></marker>
     <func>
         <name>Module:trace_send(TraceTag, TracerState, Tracee, FirstTraceTerm, SecondTraceTerm, Opts) -> Result</name>
         <fsummary>Check if a trace event should be generated.</fsummary>
@@ -440,13 +426,12 @@
         </type>
         <desc>
             <p>This callback will be called when a tracepoint is triggered and
-                the <seealso marker="#enabled_send">Module:enabled_send/3</seealso>
+                the <seealso marker="#Module:enabled_send/3">Module:enabled_send/3</seealso>
                 callback returned <c>trace</c>.</p>
             <p>If <c>trace_send/6</c> is not defined <c>trace/6</c> will be called instead.</p>
         </desc>
     </func>
 
-    <marker id="enabled_receive"></marker>
     <func>
         <name>Module:enabled_receive(TraceTag, TracerState, Tracee) -> Result</name>
         <fsummary>Check if a trace event should be generated.</fsummary>
@@ -464,7 +449,6 @@
         </desc>
     </func>
 
-    <marker id="trace_receive"></marker>
     <func>
         <name>Module:trace_receive(TraceTag, TracerState, Tracee, FirstTraceTerm, SecondTraceTerm, Opts) -> Result</name>
         <fsummary>Check if a trace event should be generated.</fsummary>
@@ -479,13 +463,12 @@
         </type>
         <desc>
             <p>This callback will be called when a tracepoint is triggered and
-                the <seealso marker="#enabled_receive">Module:enabled_receive/3</seealso>
+                the <seealso marker="#Module:enabled_receive/3">Module:enabled_receive/3</seealso>
                 callback returned <c>trace</c>.</p>
             <p>If <c>trace_receive/6</c> is not defined <c>trace/6</c> will be called instead.</p>
         </desc>
     </func>
 
-    <marker id="enabled_garbage_collection"></marker>
     <func>
         <name>Module:enabled_garbage_collection(TraceTag, TracerState, Tracee) -> Result</name>
         <fsummary>Check if a trace event should be generated.</fsummary>
@@ -503,7 +486,6 @@
         </desc>
     </func>
 
-    <marker id="trace_garbage_collection"></marker>
     <func>
         <name>Module:trace_garbage_collection(TraceTag, TracerState, Tracee, FirstTraceTerm, SecondTraceTerm, Opts) -> Result</name>
         <fsummary>Check if a trace event should be generated.</fsummary>
@@ -518,7 +500,7 @@
         </type>
         <desc>
             <p>This callback will be called when a tracepoint is triggered and
-                the <seealso marker="#enabled_garbage_collection">Module:enabled_garbage_collection/3</seealso>
+                the <seealso marker="#Module:enabled_garbage_collection/3">Module:enabled_garbage_collection/3</seealso>
                 callback returned <c>trace</c>.</p>
             <p>If <c>trace_garbage_collection/6</c> is not defined <c>trace/6</c> will be called instead.</p>
         </desc>
diff --git a/erts/emulator/beam/erl_nif.c b/erts/emulator/beam/erl_nif.c
index 159dc66ad5..bd9367a3d5 100644
--- a/erts/emulator/beam/erl_nif.c
+++ b/erts/emulator/beam/erl_nif.c
@@ -667,6 +667,9 @@ int enif_send(ErlNifEnv* env, const ErlNifPid* to_pid,
             erts_smp_proc_trylock(rp, ERTS_PROC_LOCK_MSGQ) == EBUSY) {
 
             if (!msgq) {
+#ifdef ERTS_SMP
+                ErtsThrPrgrDelayHandle dhndl;
+#endif
 
                 msgq = erts_alloc(ERTS_ALC_T_TRACE_MSG_QUEUE,
                                   sizeof(ErlTraceMessageQueue));
@@ -681,8 +684,15 @@ int enif_send(ErlNifEnv* env, const ErlNifPid* to_pid,
 
                 erts_smp_proc_unlock(t_p, ERTS_PROC_LOCK_TRACE);
 
+#ifdef ERTS_SMP
+                if (!scheduler)
+                    dhndl = erts_thr_progress_unmanaged_delay();
+#endif
                 erts_schedule_flush_trace_messages(t_p->common.id);
-
+#ifdef ERTS_SMP
+                if (!scheduler)
+                    erts_thr_progress_unmanaged_continue(dhndl);
+#endif
             } else {
                 msgq->len++;
                 *msgq->last = mp;
@@ -1669,7 +1679,8 @@ int enif_is_process_alive(ErlNifEnv* env, ErlNifPid *proc)
 	return !!rp;
 #else
 	erts_exit(ERTS_ABORT_EXIT, "enif_is_process_alive: "
-		  "called from non-scheduler thread");
+		  "called from non-scheduler thread "
+                  "in non-smp emulator");
 	return 0;
 #endif
     }
@@ -1694,7 +1705,8 @@ int enif_is_port_alive(ErlNifEnv *env, ErlNifPort *port)
 	return !!prt;
 #else
 	erts_exit(ERTS_ABORT_EXIT, "enif_is_port_alive: "
-		  "called from non-scheduler thread");
+		  "called from non-scheduler thread "
+                  "in non-smp emulator");
 	return 0;
 #endif
     }
diff --git a/erts/emulator/test/port_trace_SUITE.erl b/erts/emulator/test/port_trace_SUITE.erl
index bfdea0761b..5d9a75bcd3 100644
--- a/erts/emulator/test/port_trace_SUITE.erl
+++ b/erts/emulator/test/port_trace_SUITE.erl
@@ -31,7 +31,8 @@
          failure_atom/1, failure_posix/1,
          failure/1, output_term/1,
          driver_output_term/1,
-         send_term/1, driver_send_term/1]).
+         send_term/1, driver_send_term/1,
+         driver_remote_send_term/1]).
 
 -define(ECHO_DRV_NOOP, 0).
 -define(ECHO_DRV_OUTPUT, 1).
@@ -48,6 +49,7 @@
 -define(ECHO_DRV_SEND_TERM, 12).
 -define(ECHO_DRV_DRIVER_SEND_TERM, 13).
 -define(ECHO_DRV_SAVE_CALLER, 14).
+-define(ECHO_DRV_REMOTE_SEND_TERM, 15).
 
 suite() -> [{ct_hooks,[ts_install_cth]},
             {timetrap, {seconds, 30}}].
@@ -60,7 +62,8 @@ all() ->
      failure_atom, failure_posix,
      failure, output_term,
      driver_output_term,
-     send_term, driver_send_term].
+     send_term, driver_send_term,
+     driver_remote_send_term].
 
 init_per_suite(Config) ->
     Config.
@@ -75,6 +78,13 @@ end_per_group(_GroupName, Config) ->
     Config.
 
 
+init_per_testcase(driver_remote_send_term, Config) ->
+    case erlang:system_info(smp_support) of
+        false ->
+            {skip,"Only supported on smp systems"};
+        true ->
+            init_per_testcase(driver_remote_send_term_smp, Config)
+    end;
 init_per_testcase(Func, Config) when is_atom(Func), is_list(Config) ->
     erlang:trace(all, false, [all]),
     os:unsetenv("OUTPUTV"),
@@ -543,6 +553,34 @@ driver_send_term(_Config) ->
 
     ok.
 
+%% Test that driver_send_term from non-scheduler thread does not
+%% generate trace messages.
+driver_remote_send_term(_Config) ->
+
+    Flags = [send],
+    {Prt, S} = trace_and_open(Flags,[binary]),
+
+    erlang:port_command(Prt, <<?ECHO_DRV_REMOTE_SEND_TERM, 123456:32>>),
+    recv({echo, Prt, <<123456:32>>}),
+    [] = flush(),
+
+    Pid = spawn_link(
+            fun() ->
+                    erlang:port_command(Prt, <<?ECHO_DRV_SAVE_CALLER>>),
+                    S ! ok,
+                    receive M -> S ! M end
+            end),
+    recv(ok),
+    erlang:trace(Pid, true, ['receive']),
+
+    erlang:port_command(Prt, <<?ECHO_DRV_REMOTE_SEND_TERM, 123456:32>>),
+    recv({echo, Prt, <<123456:32>>}),
+    [{trace, Pid, 'receive', {echo, Prt, <<123456:32>>}}] = flush(),
+
+    close(Prt, Flags),
+
+    ok.
+
 %%%%%%%%%%%%%%%%%%%
 %% Helper functions
 %%%%%%%%%%%%%%%%%%%
@@ -598,7 +636,7 @@ f(From) ->
     end.
 
 recv(Msg) ->
-    receive Msg -> ok after 100 -> ct:fail({did_not_get_data,Msg,flush()}) end.
+    receive Msg -> ok after 1000 -> ct:fail({did_not_get_data,Msg,flush()}) end.
 
 load_drv(Config) ->
     Path = proplists:get_value(data_dir, Config),
diff --git a/erts/emulator/test/port_trace_SUITE_data/echo_drv.c b/erts/emulator/test/port_trace_SUITE_data/echo_drv.c
index b5ae9389b4..b545523192 100644
--- a/erts/emulator/test/port_trace_SUITE_data/echo_drv.c
+++ b/erts/emulator/test/port_trace_SUITE_data/echo_drv.c
@@ -14,6 +14,13 @@ typedef struct _erl_drv_data {
     ErlDrvTermData caller;
 } EchoDrvData;
 
+struct remote_send_term {
+    char *buf;
+    int len;
+    ErlDrvTermData port;
+    ErlDrvTermData caller;
+};
+
 #define ECHO_DRV_NOOP                 0
 #define ECHO_DRV_OUTPUT               1
 #define ECHO_DRV_OUTPUT2              2
@@ -29,6 +36,7 @@ typedef struct _erl_drv_data {
 #define ECHO_DRV_SEND_TERM           12
 #define ECHO_DRV_DRIVER_SEND_TERM    13
 #define ECHO_DRV_SAVE_CALLER         14
+#define ECHO_DRV_REMOTE_SEND_TERM    15
 
 
 /* -------------------------------------------------------------------------
@@ -78,6 +86,8 @@ static ErlDrvEntry echo_drv_entry = {
     NULL
 };
 
+static void send_term_thread(void *);
+
 /* -------------------------------------------------------------------------
 ** Entry functions
 **/
@@ -200,6 +210,18 @@ static void echo_drv_output(ErlDrvData drv_data, char *buf, ErlDrvSizeT len) {
         }
         break;
     }
+    case ECHO_DRV_REMOTE_SEND_TERM:
+    {
+        ErlDrvTid tid;
+        struct remote_send_term *t = malloc(sizeof(struct remote_send_term));
+        t->len = len-1;
+        t->buf = malloc(len-1);
+        t->port = driver_mk_port(port);
+        t->caller = data_p->caller;
+        memcpy(t->buf, buf+1, t->len);
+        erl_drv_thread_create("tmp_thread", &tid, send_term_thread, t, NULL);
+        break;
+    }
     case ECHO_DRV_SAVE_CALLER:
         data_p->caller = driver_caller(port);
         break;
@@ -239,3 +261,17 @@ static ErlDrvSSizeT echo_drv_call(ErlDrvData drv_data,
     memcpy(*rbuf, buf+command, len-command);
     return len-command;
 }
+
+static void send_term_thread(void *a)
+{
+    struct remote_send_term *t = (struct remote_send_term*)a;
+    ErlDrvTermData term[] = {
+            ERL_DRV_ATOM, driver_mk_atom("echo"),
+            ERL_DRV_PORT, t->port,
+            ERL_DRV_BUF2BINARY, (ErlDrvTermData)(t->buf),
+                                (ErlDrvTermData)(t->len),
+            ERL_DRV_TUPLE, 3};
+    erl_drv_send_term(t->port, t->caller,
+                      term, sizeof(term) / sizeof(ErlDrvTermData));
+    return;
+}