Merge branch 'siri/sync-stop-gen/OTP-11173'

* siri/sync-stop-gen/OTP-11173:
  Add synchronous stop function to wx_object
  Fix minor bugs in gen_server and gen_fsm documentation
  Update gen_event:stop to be synchronous
  Add synchronous stop functions to gen_server and gen_fsm
  Add synchronous stop function to proc_lib
  Add system message 'terminate'
  Remove old code from stdlib/test/sys_sp2.erl

6 files changed, 162 insertions, 61 deletions

diff --git a/lib/stdlib/src/gen.erl b/lib/stdlib/src/gen.erl
index 63116fa16e..6d7ca3d75c 100644
--- a/lib/stdlib/src/gen.erl
+++ b/lib/stdlib/src/gen.erl
@@ -26,7 +26,7 @@
 %%% The standard behaviour should export init_it/6.
 %%%-----------------------------------------------------------------
 -export([start/5, start/6, debug_options/1,
-	 call/3, call/4, reply/2]).
+	 call/3, call/4, reply/2, stop/1, stop/3]).
 
 -export([init_it/6, init_it/7]).
 
@@ -145,56 +145,10 @@ init_it2(GenMod, Starter, Parent, Name, Mod, Args, Options) ->
 call(Process, Label, Request) -> 
     call(Process, Label, Request, ?default_timeout).
 
-%% Local or remote by pid
-call(Pid, Label, Request, Timeout) 
-  when is_pid(Pid), Timeout =:= infinity;
-       is_pid(Pid), is_integer(Timeout), Timeout >= 0 ->
-    do_call(Pid, Label, Request, Timeout);
-%% Local by name
-call(Name, Label, Request, Timeout) 
-  when is_atom(Name), Timeout =:= infinity;
-       is_atom(Name), is_integer(Timeout), Timeout >= 0 ->
-    case whereis(Name) of
-	Pid when is_pid(Pid) ->
-	    do_call(Pid, Label, Request, Timeout);
-	undefined ->
-	    exit(noproc)
-    end;
-%% Global by name
 call(Process, Label, Request, Timeout)
-  when ((tuple_size(Process) == 2 andalso element(1, Process) == global)
-	orelse
-	  (tuple_size(Process) == 3 andalso element(1, Process) == via))
-       andalso
-       (Timeout =:= infinity orelse (is_integer(Timeout) andalso Timeout >= 0)) ->
-    case where(Process) of
-	Pid when is_pid(Pid) ->
-	    Node = node(Pid),
- 	    try do_call(Pid, Label, Request, Timeout)
- 	    catch
- 		exit:{nodedown, Node} ->
- 		    %% A nodedown not yet detected by global,
- 		    %% pretend that it was.
- 		    exit(noproc)
-	    end;
-	undefined ->
-	    exit(noproc)
-    end;
-%% Local by name in disguise
-call({Name, Node}, Label, Request, Timeout)
-  when Node =:= node(), Timeout =:= infinity;
-       Node =:= node(), is_integer(Timeout), Timeout >= 0 ->
-    call(Name, Label, Request, Timeout);
-%% Remote by name
-call({_Name, Node}=Process, Label, Request, Timeout)
-  when is_atom(Node), Timeout =:= infinity;
-       is_atom(Node), is_integer(Timeout), Timeout >= 0 ->
-    if
- 	node() =:= nonode@nohost ->
- 	    exit({nodedown, Node});
- 	true ->
- 	    do_call(Process, Label, Request, Timeout)
-    end.
+  when Timeout =:= infinity; is_integer(Timeout), Timeout >= 0 ->
+    Fun = fun(Pid) -> do_call(Pid, Label, Request, Timeout) end,
+    do_for_proc(Process, Fun).
 
 do_call(Process, Label, Request, Timeout) ->
     try erlang:monitor(process, Process) of
@@ -276,6 +230,65 @@ reply({To, Tag}, Reply) ->
     Msg = {Tag, Reply},
     try To ! Msg catch _:_ -> Msg end.
 
+%%-----------------------------------------------------------------
+%% Syncronously stop a generic process
+%%-----------------------------------------------------------------
+stop(Process) ->
+    stop(Process, normal, infinity).
+
+stop(Process, Reason, Timeout)
+  when Timeout =:= infinity; is_integer(Timeout), Timeout >= 0 ->
+    Fun = fun(Pid) -> proc_lib:stop(Pid, Reason, Timeout) end,
+    do_for_proc(Process, Fun).
+
+%%-----------------------------------------------------------------
+%% Map different specifications of a process to either Pid or
+%% {Name,Node}. Execute the given Fun with the process as only
+%% argument.
+%% -----------------------------------------------------------------
+
+%% Local or remote by pid
+do_for_proc(Pid, Fun) when is_pid(Pid) ->
+    Fun(Pid);
+%% Local by name
+do_for_proc(Name, Fun) when is_atom(Name) ->
+    case whereis(Name) of
+	Pid when is_pid(Pid) ->
+	    Fun(Pid);
+	undefined ->
+	    exit(noproc)
+    end;
+%% Global by name
+do_for_proc(Process, Fun)
+  when ((tuple_size(Process) == 2 andalso element(1, Process) == global)
+	orelse
+	  (tuple_size(Process) == 3 andalso element(1, Process) == via)) ->
+    case where(Process) of
+	Pid when is_pid(Pid) ->
+	    Node = node(Pid),
+	    try Fun(Pid)
+	    catch
+		exit:{nodedown, Node} ->
+		    %% A nodedown not yet detected by global,
+		    %% pretend that it was.
+		    exit(noproc)
+	    end;
+	undefined ->
+	    exit(noproc)
+    end;
+%% Local by name in disguise
+do_for_proc({Name, Node}, Fun) when Node =:= node() ->
+    do_for_proc(Name, Fun);
+%% Remote by name
+do_for_proc({_Name, Node} = Process, Fun) when is_atom(Node) ->
+    if
+	node() =:= nonode@nohost ->
+	    exit({nodedown, Node});
+	true ->
+	    Fun(Process)
+    end.
+
+
 %%%-----------------------------------------------------------------
 %%%  Misc. functions.
 %%%-----------------------------------------------------------------
diff --git a/lib/stdlib/src/gen_event.erl b/lib/stdlib/src/gen_event.erl
index bb0ff46268..934b112f6f 100644
--- a/lib/stdlib/src/gen_event.erl
+++ b/lib/stdlib/src/gen_event.erl
@@ -31,8 +31,8 @@
 %%% Modified by Martin - uses proc_lib, sys and gen!
 
 
--export([start/0, start/1, start_link/0, start_link/1, stop/1, notify/2, 
-	 sync_notify/2,
+-export([start/0, start/1, start_link/0, start_link/1, stop/1, stop/3,
+	 notify/2, sync_notify/2,
 	 add_handler/3, add_sup_handler/3, delete_handler/3, swap_handler/3,
 	 swap_sup_handler/3, which_handlers/1, call/3, call/4, wake_hib/4]).
 
@@ -193,7 +193,11 @@ swap_sup_handler(M, {H1, A1}, {H2, A2}) ->
 which_handlers(M) -> rpc(M, which_handlers).
 
 -spec stop(emgr_ref()) -> 'ok'.
-stop(M) -> rpc(M, stop).
+stop(M) ->
+    gen:stop(M).
+
+stop(M, Reason, Timeout) ->
+    gen:stop(M, Reason, Timeout).
 
 rpc(M, Cmd) -> 
     {ok, Reply} = gen:call(M, self(), Cmd, infinity),
@@ -292,9 +296,6 @@ handle_msg(Msg, Parent, ServerName, MSL, Debug) ->
 						Args2, MSL, Sup, ServerName),
 	    ?reply(Reply),
 	    loop(Parent, ServerName, MSL1, Debug, Hib);
-	{From, Tag, stop} ->
-	    catch terminate_server(normal, Parent, MSL, ServerName),
-	    ?reply(ok);
 	{From, Tag, which_handlers} ->
 	    ?reply(the_handlers(MSL)),
 	    loop(Parent, ServerName, MSL, Debug, false);
diff --git a/lib/stdlib/src/gen_fsm.erl b/lib/stdlib/src/gen_fsm.erl
index 56137cde13..29b1d80088 100644
--- a/lib/stdlib/src/gen_fsm.erl
+++ b/lib/stdlib/src/gen_fsm.erl
@@ -106,6 +106,7 @@
 
 -export([start/3, start/4,
 	 start_link/3, start_link/4,
+	 stop/1, stop/3,
 	 send_event/2, sync_send_event/2, sync_send_event/3,
 	 send_all_state_event/2,
 	 sync_send_all_state_event/2, sync_send_all_state_event/3,
@@ -197,6 +198,11 @@ start_link(Mod, Args, Options) ->
 start_link(Name, Mod, Args, Options) ->
     gen:start(?MODULE, link, Name, Mod, Args, Options).
 
+stop(Name) ->
+    gen:stop(Name).
+
+stop(Name, Reason, Timeout) ->
+    gen:stop(Name, Reason, Timeout).
 
 send_event({global, Name}, Event) ->
     catch global:send(Name, {'$gen_event', Event}),
diff --git a/lib/stdlib/src/gen_server.erl b/lib/stdlib/src/gen_server.erl
index 22acdf10b7..9794c73cc2 100644
--- a/lib/stdlib/src/gen_server.erl
+++ b/lib/stdlib/src/gen_server.erl
@@ -88,6 +88,7 @@
 %% API
 -export([start/3, start/4,
 	 start_link/3, start_link/4,
+	 stop/1, stop/3,
 	 call/2, call/3,
 	 cast/2, reply/2,
 	 abcast/2, abcast/3,
@@ -177,6 +178,17 @@ start_link(Name, Mod, Args, Options) ->
 
 
 %% -----------------------------------------------------------------
+%% Stop a generic server and wait for it to terminate.
+%% If the server is located at another node, that node will
+%% be monitored.
+%% -----------------------------------------------------------------
+stop(Name) ->
+    gen:stop(Name).
+
+stop(Name, Reason, Timeout) ->
+    gen:stop(Name, Reason, Timeout).
+
+%% -----------------------------------------------------------------
 %% Make a call to a generic server.
 %% If the server is located at another node, that node will
 %% be monitored.
diff --git a/lib/stdlib/src/proc_lib.erl b/lib/stdlib/src/proc_lib.erl
index 1eb6fc2e86..c925e70613 100644
--- a/lib/stdlib/src/proc_lib.erl
+++ b/lib/stdlib/src/proc_lib.erl
@@ -1,7 +1,7 @@
 %%
 %% %CopyrightBegin%
 %%
-%% Copyright Ericsson AB 1996-2013. All Rights Reserved.
+%% Copyright Ericsson AB 1996-2014. All Rights Reserved.
 %%
 %% The contents of this file are subject to the Erlang Public License,
 %% Version 1.1, (the "License"); you may not use this file except in
@@ -30,7 +30,8 @@
 	 hibernate/3,
 	 init_ack/1, init_ack/2,
 	 init_p/3,init_p/5,format/1,format/2,initial_call/1,
-         translate_initial_call/1]).
+         translate_initial_call/1,
+	 stop/1, stop/3]).
 
 %% Internal exports.
 -export([wake_up/3]).
@@ -750,3 +751,50 @@ format_tag(Tag, Data) ->
 
 modifier(latin1) -> "";
 modifier(_) -> "t".
+
+
+%%% -----------------------------------------------------------
+%%% Stop a process and wait for it to terminate
+%%% -----------------------------------------------------------
+-spec stop(Process) -> 'ok' when
+      Process :: pid() | RegName | {RegName,node()},
+      RegName :: atom().
+stop(Process) ->
+    stop(Process, normal, infinity).
+
+-spec stop(Process, Reason, Timeout) -> 'ok' when
+      Process :: pid() | RegName | {RegName,node()},
+      RegName :: atom(),
+      Reason :: term(),
+      Timeout :: timeout().
+stop(Process, Reason, Timeout) ->
+    {Pid, Mref} = erlang:spawn_monitor(do_stop(Process, Reason)),
+    receive
+	{'DOWN', Mref, _, _, Reason} ->
+	    ok;
+	{'DOWN', Mref, _, _, {noproc,{sys,terminate,_}}} ->
+	    exit(noproc);
+	{'DOWN', Mref, _, _, CrashReason} ->
+	    exit(CrashReason)
+    after Timeout ->
+	    exit(Pid, kill),
+	    receive
+		{'DOWN', Mref, _, _, _} ->
+		    exit(timeout)
+	    end
+    end.
+
+-spec do_stop(Process, Reason) -> Fun when
+      Process :: pid() | RegName | {RegName,node()},
+      RegName :: atom(),
+      Reason :: term(),
+      Fun :: fun(() -> no_return()).
+do_stop(Process, Reason) ->
+    fun() ->
+	    Mref = erlang:monitor(process, Process),
+	    ok = sys:terminate(Process, Reason, infinity),
+	    receive
+		{'DOWN', Mref, _, _, ExitReason} ->
+		    exit(ExitReason)
+	    end
+    end.
diff --git a/lib/stdlib/src/sys.erl b/lib/stdlib/src/sys.erl
index e25cc25f57..ec6813a28a 100644
--- a/lib/stdlib/src/sys.erl
+++ b/lib/stdlib/src/sys.erl
@@ -1,7 +1,7 @@
 %%
 %% %CopyrightBegin%
 %% 
-%% Copyright Ericsson AB 1996-2013. All Rights Reserved.
+%% Copyright Ericsson AB 1996-2014. All Rights Reserved.
 %% 
 %% The contents of this file are subject to the Erlang Public License,
 %% Version 1.1, (the "License"); you may not use this file except in
@@ -24,6 +24,7 @@
 	 get_state/1, get_state/2,
 	 replace_state/2, replace_state/3,
 	 change_code/4, change_code/5,
+	 terminate/2, terminate/3,
 	 log/2, log/3, trace/2, trace/3, statistics/2, statistics/3,
 	 log_to_file/2, log_to_file/3, no_debug/1, no_debug/2,
 	 install/2, install/3, remove/2, remove/3]).
@@ -159,6 +160,19 @@ change_code(Name, Mod, Vsn, Extra) ->
 change_code(Name, Mod, Vsn, Extra, Timeout) ->
     send_system_msg(Name, {change_code, Mod, Vsn, Extra}, Timeout).
 
+-spec terminate(Name, Reason) -> 'ok' when
+      Name :: name(),
+      Reason :: term().
+terminate(Name, Reason) ->
+    send_system_msg(Name, {terminate, Reason}).
+
+-spec terminate(Name, Reason, Timeout) -> 'ok' when
+      Name :: name(),
+      Reason :: term(),
+      Timeout :: timeout().
+terminate(Name, Reason, Timeout) ->
+    send_system_msg(Name, {terminate, Reason}, Timeout).
+
 %%-----------------------------------------------------------------
 %% Debug commands
 %%-----------------------------------------------------------------
@@ -294,6 +308,8 @@ mfa(Name, {debug, {Func, Arg2}}) ->
     {sys, Func, [Name, Arg2]};
 mfa(Name, {change_code, Mod, Vsn, Extra}) ->
     {sys, change_code, [Name, Mod, Vsn, Extra]};
+mfa(Name, {terminate, Reason}) ->
+    {sys, terminate, [Name, Reason]};
 mfa(Name, Atom) ->
     {sys, Atom, [Name]}.
 
@@ -309,7 +325,7 @@ mfa(Name, Req, Timeout) ->
 %% Returns: This function *never* returns! It calls the function
 %%          Module:system_continue(Parent, NDebug, Misc)
 %%          there the process continues the execution or
-%%          Module:system_terminate(Raeson, Parent, Debug, Misc) if
+%%          Module:system_terminate(Reason, Parent, Debug, Misc) if
 %%          the process should terminate.
 %%          The Module must export system_continue/3, system_terminate/4
 %%          and format_status/2 for status information.
@@ -335,7 +351,10 @@ handle_system_msg(SysState, Msg, From, Parent, Mod, Debug, Misc, Hib) ->
 	    suspend_loop(suspended, Parent, Mod, NDebug, NMisc, Hib);
 	{running, Reply, NDebug, NMisc} ->
 	    _ = gen:reply(From, Reply),
-            Mod:system_continue(Parent, NDebug, NMisc)
+            Mod:system_continue(Parent, NDebug, NMisc);
+	{{terminating, Reason}, Reply, NDebug, NMisc} ->
+	    _ = gen:reply(From, Reply),
+	    Mod:system_terminate(Reason, Parent, NDebug, NMisc)
     end.
 
 %%-----------------------------------------------------------------
@@ -415,6 +434,8 @@ do_cmd(SysState, get_status, Parent, Mod, Debug, Misc) ->
 do_cmd(SysState, {debug, What}, _Parent, _Mod, Debug, Misc) ->
     {Res, NDebug} = debug_cmd(What, Debug),
     {SysState, Res, NDebug, Misc};
+do_cmd(_, {terminate, Reason}, _Parent, _Mod, Debug, Misc) ->
+    {{terminating, Reason}, ok, Debug, Misc};
 do_cmd(suspended, {change_code, Module, Vsn, Extra}, _Parent,
        Mod, Debug, Misc) ->
     {Res, NMisc} = do_change_code(Mod, Module, Vsn, Extra, Misc),