Merge branch 'vinoski/dirty_process_main/OTP-13123'

* vinoski/dirty_process_main/OTP-13123:
  Add dirty_process_main function

2 files changed, 142 insertions, 7 deletions

diff --git a/erts/emulator/test/dirty_nif_SUITE.erl b/erts/emulator/test/dirty_nif_SUITE.erl
index c3afbc0803..83b098a704 100644
--- a/erts/emulator/test/dirty_nif_SUITE.erl
+++ b/erts/emulator/test/dirty_nif_SUITE.erl
@@ -32,19 +32,23 @@
 	 dirty_nif/1, dirty_nif_send/1,
 	 dirty_nif_exception/1, call_dirty_nif_exception/1,
 	 dirty_scheduler_exit/1, dirty_call_while_terminated/1,
-	 dirty_heap_access/1]).
+	 dirty_heap_access/1, dirty_process_info/1,
+	 dirty_process_register/1, dirty_process_trace/1]).
 
 -define(nif_stub,nif_stub_error(?LINE)).
 
 suite() -> [{ct_hooks,[ts_install_cth]}].
 
-all() -> 
+all() ->
     [dirty_nif,
      dirty_nif_send,
      dirty_nif_exception,
      dirty_scheduler_exit,
      dirty_call_while_terminated,
-     dirty_heap_access].
+     dirty_heap_access,
+     dirty_process_info,
+     dirty_process_register,
+     dirty_process_trace].
 
 init_per_suite(Config) ->
     try erlang:system_info(dirty_cpu_schedulers) of
@@ -187,7 +191,7 @@ dirty_call_while_terminated(Config) when is_list(Config) ->
 				    blipp:blupp(Bin)
 			    end,
 			    [monitor,link]),
-    receive {dirty_alive, Pid} -> ok end,
+    receive {dirty_alive, _Pid} -> ok end,
     {value, {BinAddr, 4711, 2}} = lists:keysearch(4711, 2,
 						  element(2,
 							  process_info(self(),
@@ -241,7 +245,7 @@ dirty_heap_access(Config) when is_list(Config) ->
 		       end),
     {N, R} = access_dirty_heap(Dirty, RGL, 0, 0),
     receive
-	{Pid, Res} ->
+	{_Pid, Res} ->
 	    1000 = length(Res),
 	    lists:foreach(fun (X) -> Ref = X end, Res)
     end,
@@ -269,12 +273,123 @@ access_dirty_heap(Dirty, RGL, N, R) ->
 					       end)
     end.
 
+%% These tests verify that processes that access a process executing a
+%% dirty NIF where the main lock is needed for that access do not get
+%% blocked. Each test passes its pid to dirty_sleeper, which sends a
+%% 'ready' message when it's running on a dirty scheduler and just before
+%% it starts a 6 second sleep. When it receives the message, it verifies
+%% that access to the dirty process is as it expects.  After the dirty
+%% process finishes its 6 second sleep but before it returns from the dirty
+%% scheduler, it sends a 'done' message. If the tester already received
+%% that message, the test fails because it means attempting to access the
+%% dirty process waited for that process to return to a regular scheduler,
+%% so verify that we haven't received that message, and also verify that
+%% the dirty process is still alive immediately after accessing it.
+dirty_process_info(Config) when is_list(Config) ->
+    access_dirty_process(
+      Config,
+      fun() -> ok end,
+      fun(NifPid) ->
+	      PI = process_info(NifPid),
+	      {current_function,{?MODULE,dirty_sleeper,1}} =
+		  lists:keyfind(current_function, 1, PI),
+	      ok
+      end,
+      fun(_) -> ok end).
+
+dirty_process_register(Config) when is_list(Config) ->
+    access_dirty_process(
+      Config,
+      fun() -> ok end,
+      fun(NifPid) ->
+	      register(test_dirty_process_register, NifPid),
+	      NifPid = whereis(test_dirty_process_register),
+	      unregister(test_dirty_process_register),
+	      false = lists:member(test_dirty_process_register,
+				   registered()),
+	      ok
+      end,
+      fun(_) -> ok end).
+
+dirty_process_trace(Config) when is_list(Config) ->
+    access_dirty_process(
+      Config,
+      fun() ->
+	      erlang:trace_pattern({?MODULE,dirty_sleeper,1},
+				   [{'_',[],[{return_trace}]}],
+				   [local,meta]),
+	      ok
+      end,
+      fun(NifPid) ->
+	      erlang:trace(NifPid, true, [call,timestamp]),
+	      ok
+      end,
+      fun(NifPid) ->
+	      receive
+		  done ->
+		      receive
+			  {trace_ts,NifPid,call,{?MODULE,dirty_sleeper,_},_} ->
+			      ok
+		      after
+			  0 ->
+			      error(missing_trace_call_message)
+		      end,
+		      receive
+			  {trace_ts,NifPid,return_from,{?MODULE,dirty_sleeper,1},
+			   ok,_} ->
+			      ok
+		      after
+			  100 ->
+			      error(missing_trace_return_message)
+		      end
+	      after
+		  6500 ->
+		      error(missing_done_message)
+	      end,
+	      ok
+      end).
+
 %%
 %% Internal...
 %%
 
+access_dirty_process(Config, Start, Test, Finish) ->
+    {ok, Node} = start_node(Config, ""),
+    [ok] = mcall(Node,
+		 [fun() ->
+                          Path = ?config(data_dir, Config),
+                          Lib = atom_to_list(?MODULE),
+                          ok = erlang:load_nif(filename:join(Path,Lib), []),
+			  ok = test_dirty_process_access(Start, Test, Finish)
+		  end]),
+    stop_node(Node),
+    ok.
+
+test_dirty_process_access(Start, Test, Finish) ->
+    ok = Start(),
+    Self = self(),
+    NifPid = spawn_link(fun() ->
+				ok = dirty_sleeper(Self)
+			end),
+    ok = receive
+	     ready ->
+		 ok = Test(NifPid),
+		 receive
+		     done ->
+			 error(dirty_process_info_blocked)
+		 after
+		     0 ->
+			 true = erlang:is_process_alive(NifPid),
+			 ok
+		 end
+	 after
+	     3000 ->
+		 error(timeout)
+	 end,
+    ok = Finish(NifPid).
+
 receive_any() ->
-    receive M -> M end.	     
+    receive M -> M end.
 
 start_node(Config) ->
     start_node(Config, "").
@@ -314,13 +429,13 @@ mcall(Node, Funs) ->
 
 %% The NIFs:
 lib_loaded() -> false.
-call_nif_schedule(_,_) -> ?nif_stub.
 call_dirty_nif(_,_,_) -> ?nif_stub.
 send_from_dirty_nif(_) -> ?nif_stub.
 call_dirty_nif_exception(_) -> ?nif_stub.
 call_dirty_nif_zero_args() -> ?nif_stub.
 dirty_call_while_terminated_nif(_) -> ?nif_stub.
 dirty_sleeper() -> ?nif_stub.
+dirty_sleeper(_) -> ?nif_stub.
 dirty_heap_access_nif(_) -> ?nif_stub.
 
 nif_stub_error(Line) ->
diff --git a/erts/emulator/test/dirty_nif_SUITE_data/dirty_nif_SUITE.c b/erts/emulator/test/dirty_nif_SUITE_data/dirty_nif_SUITE.c
index 2013c88167..1d2a099186 100644
--- a/erts/emulator/test/dirty_nif_SUITE_data/dirty_nif_SUITE.c
+++ b/erts/emulator/test/dirty_nif_SUITE_data/dirty_nif_SUITE.c
@@ -146,12 +146,31 @@ static ERL_NIF_TERM call_dirty_nif_zero_args(ErlNifEnv* env, int argc, const ERL
 static ERL_NIF_TERM
 dirty_sleeper(ErlNifEnv* env, int argc, const ERL_NIF_TERM argv[])
 {
+    ErlNifPid pid;
+    ErlNifEnv* msg_env = NULL;
+
     assert(enif_is_on_dirty_scheduler(env));
+
+    /* If we get a pid argument, it indicates a process involved in the
+       test wants a message from us. Prior to the sleep we send a 'ready'
+       message, and then after the sleep, send a 'done' message. */
+    if (argc == 1 && enif_get_local_pid(env, argv[0], &pid)) {
+        msg_env = enif_alloc_env();
+        enif_send(env, &pid, msg_env, enif_make_atom(msg_env, "ready"));
+    }
+
 #ifdef __WIN32__
     Sleep(6000);
 #else
     sleep(6);
 #endif
+
+    if (argc == 1) {
+        assert(msg_env != NULL);
+        enif_send(env, &pid, msg_env, enif_make_atom(msg_env, "done"));
+        enif_free_env(msg_env);
+    }
+
     return enif_make_atom(env, "ok");
 }
 
@@ -216,6 +235,7 @@ static ErlNifFunc nif_funcs[] =
     {"call_dirty_nif_exception", 1, call_dirty_nif_exception, ERL_NIF_DIRTY_JOB_IO_BOUND},
     {"call_dirty_nif_zero_args", 0, call_dirty_nif_zero_args, ERL_NIF_DIRTY_JOB_CPU_BOUND},
     {"dirty_sleeper", 0, dirty_sleeper, ERL_NIF_DIRTY_JOB_IO_BOUND},
+    {"dirty_sleeper", 1, dirty_sleeper, ERL_NIF_DIRTY_JOB_CPU_BOUND},
     {"dirty_call_while_terminated_nif", 1, dirty_call_while_terminated_nif, ERL_NIF_DIRTY_JOB_CPU_BOUND},
     {"dirty_heap_access_nif", 1, dirty_heap_access_nif, ERL_NIF_DIRTY_JOB_CPU_BOUND}
 };