stdlib: Introduce gen_server benchmark

9 files changed, 420 insertions, 4 deletions

diff --git a/lib/stdlib/test/stdlib.spec b/lib/stdlib/test/stdlib.spec
index 91712b8963..1adec67ac9 100644
--- a/lib/stdlib/test/stdlib.spec
+++ b/lib/stdlib/test/stdlib.spec
@@ -1,2 +1,3 @@
 {suites,"../stdlib_test",all}.
-{skip_suites,"../stdlib_test",stdlib_bench_SUITE, "bench only"}.
+{skip_groups,"../stdlib_test",stdlib_bench_SUITE,[base64,gen_server,unicode],
+             "Benchmark only"}.
diff --git a/lib/stdlib/test/stdlib_bench.spec b/lib/stdlib/test/stdlib_bench.spec
index a5d1e1db80..f82f1ab9b3 100644
--- a/lib/stdlib/test/stdlib_bench.spec
+++ b/lib/stdlib/test/stdlib_bench.spec
@@ -5,3 +5,5 @@
 {skip_suites,"../stdlib_test",string_SUITE, "bench only"}.
 
 {suites,"../stdlib_test",[stdlib_bench_SUITE]}.
+{skip_groups,"../stdlib_test",stdlib_bench_SUITE,[gen_server_comparison],
+             "Not a benchmark"}.
diff --git a/lib/stdlib/test/stdlib_bench_SUITE.erl b/lib/stdlib/test/stdlib_bench_SUITE.erl
index 2a9981bb9e..cc7e070dbd 100644
--- a/lib/stdlib/test/stdlib_bench_SUITE.erl
+++ b/lib/stdlib/test/stdlib_bench_SUITE.erl
@@ -21,6 +21,7 @@
 %%
 -module(stdlib_bench_SUITE).
 -compile([export_all, nowarn_export_all]).
+-include_lib("common_test/include/ct.hrl").
 -include_lib("common_test/include/ct_event.hrl").
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -28,7 +29,8 @@ suite() -> [{ct_hooks,[{ts_install_cth,[{nodenames,2}]}]}].
 
 
 all() ->
-    [{group,unicode}, {group,base64}].
+    [{group,unicode},{group,base64},
+     {group,gen_server},{group,gen_server_comparison}].
 
 groups() ->
     [{unicode,[{repeat,5}],
@@ -41,8 +43,21 @@ groups() ->
        encode_binary, encode_binary_to_string,
        encode_list, encode_list_to_string,
        mime_binary_decode, mime_binary_decode_to_string,
-       mime_list_decode, mime_list_decode_to_string]}].
-
+       mime_list_decode, mime_list_decode_to_string]},
+     {gen_server, [{repeat,5}],
+      [simple, simple_timer, simple_mon, simple_timer_mon,
+       generic, generic_timer]},
+     {gen_server_comparison, [],
+      [single_small, single_medium, single_big,
+       sched_small, sched_medium, sched_big,
+       multi_small, multi_medium, multi_big]}].
+
+init_per_group(GroupName, Config) when GroupName =:= gen_server;
+                                       GroupName =:= gen_server_comparison ->
+    DataDir = ?config(data_dir, Config),
+    Files = filelib:wildcard(filename:join(DataDir, "{simple,generic}*.erl")),
+    _ = [{ok, _} = compile:file(File) || File <- Files],
+    Config;
 init_per_group(_GroupName, Config) ->
     Config.
 
@@ -206,3 +221,207 @@ mbb(N, Acc) when N > 256 ->
 mbb(N, Acc) ->
     B = list_to_binary(lists:seq(0, N-1)),
     lists:reverse(Acc, B).
+
+simple(Config) when is_list(Config) ->
+    do_tests(simple, single_small).
+
+simple_timer(Config) when is_list(Config) ->
+    do_tests(simple_timer, single_small).
+
+simple_mon(Config) when is_list(Config) ->
+    do_tests(simple_mon, single_small).
+
+simple_timer_mon(Config) when is_list(Config) ->
+    do_tests(simple_timer_mon, single_small).
+
+generic(Config) when is_list(Config) ->
+    do_tests(generic, single_small).
+
+generic_timer(Config) when is_list(Config) ->
+    do_tests(generic_timer, single_small).
+
+single_small(Config) when is_list(Config) ->
+    comparison(single_small).
+
+single_medium(Config) when is_list(Config) ->
+    comparison(single_medium).
+
+single_big(Config) when is_list(Config) ->
+    comparison(single_big).
+
+sched_small(Config) when is_list(Config) ->
+    comparison(sched_small).
+
+sched_medium(Config) when is_list(Config) ->
+    comparison(sched_medium).
+
+sched_big(Config) when is_list(Config) ->
+    comparison(sched_big).
+
+multi_small(Config) when is_list(Config) ->
+    comparison(multi_small).
+
+multi_medium(Config) when is_list(Config) ->
+    comparison(multi_medium).
+
+multi_big(Config) when is_list(Config) ->
+    comparison(multi_big).
+
+comparison(Kind) ->
+    Simple0 = do_tests(simple, Kind),
+    SimpleTimer0 = do_tests(simple_timer, Kind),
+    SimpleMon0 = do_tests(simple_mon, Kind),
+    SimpleTimerMon0 = do_tests(simple_timer_mon, Kind),
+    Generic0 = do_tests(generic, Kind),
+    GenericTimer0 = do_tests(generic_timer, Kind),
+    %% Normalize
+    Simple = norm(Simple0, Simple0),
+    SimpleTimer = norm(SimpleTimer0, Simple0),
+    SimpleMon = norm(SimpleMon0, Simple0),
+    SimpleTimerMon = norm(SimpleTimerMon0, Simple0),
+    Generic = norm(Generic0, Simple0),
+    GenericTimer = norm(GenericTimer0, Simple0),
+    {Parallelism, _N, Message} = bench_params(Kind),
+    Wordsize = erlang:system_info(wordsize),
+    MSize = Wordsize * erts_debug:flat_size(Message),
+    What = io_lib:format("#parallel gen_server instances: ~.4w, "
+                         "message flat size: ~.5w bytes",
+                         [Parallelism, MSize]),
+    C = io_lib:format("~s: "
+                      "Simple: ~s Simple+Timer: ~s "
+                      "Simple+Monitor: ~s Simple+Timer+Monitor: ~s "
+                      "Generic: ~s Generic+Timer: ~s",
+                     [What, Simple, SimpleTimer, SimpleMon, SimpleTimerMon,
+                     Generic, GenericTimer]),
+    {comment, C}.
+
+norm(T, Ref) ->
+    io_lib:format("~.2f", [T/Ref]).
+
+do_tests(Test, ParamSet) ->
+    {Client, ServerMod} = bench(Test),
+    {Parallelism, N, Message} = bench_params(ParamSet),
+    Fun = create_clients(N, Message, ServerMod, Client, Parallelism),
+    Time = run_test(Fun),
+    TimesPerTest = 5,
+    PerSecond = Parallelism * TimesPerTest * round((1000 * N) / Time),
+    ct_event:notify(#event{name = benchmark_data,
+                           data = [{suite,"stdlib_gen_server"},
+                                   {value,PerSecond}]}),
+    Time.
+
+simple_client(0, _, _P) ->
+    ok;
+simple_client(N, M, P) ->
+    _ = simple_server:reply(P, M),
+    _ = simple_server:reply(P, M),
+    _ = simple_server:reply(P, M),
+    _ = simple_server:reply(P, M),
+    _ = simple_server:reply(P, M),
+    simple_client(N-1, M, P).
+
+simple_client_timer(0, _, _P) ->
+    ok;
+simple_client_timer(N, M, P) ->
+    _ = simple_server_timer:reply(P, M),
+    _ = simple_server_timer:reply(P, M),
+    _ = simple_server_timer:reply(P, M),
+    _ = simple_server_timer:reply(P, M),
+    _ = simple_server_timer:reply(P, M),
+    simple_client_timer(N-1, M, P).
+
+simple_client_mon(0, _, _P) ->
+    ok;
+simple_client_mon(N, M, P) ->
+    _ = simple_server_mon:reply(P, M),
+    _ = simple_server_mon:reply(P, M),
+    _ = simple_server_mon:reply(P, M),
+    _ = simple_server_mon:reply(P, M),
+    _ = simple_server_mon:reply(P, M),
+    simple_client_mon(N-1, M, P).
+
+simple_client_timer_mon(0, _, _P) ->
+    ok;
+simple_client_timer_mon(N, M, P) ->
+    _ = simple_server_timer_mon:reply(P, M),
+    _ = simple_server_timer_mon:reply(P, M),
+    _ = simple_server_timer_mon:reply(P, M),
+    _ = simple_server_timer_mon:reply(P, M),
+    _ = simple_server_timer_mon:reply(P, M),
+    simple_client_timer_mon(N-1, M, P).
+
+generic_client(0, _, _P) ->
+    ok;
+generic_client(N, M, P) ->
+    _ = generic_server:reply(P, M),
+    _ = generic_server:reply(P, M),
+    _ = generic_server:reply(P, M),
+    _ = generic_server:reply(P, M),
+    _ = generic_server:reply(P, M),
+    generic_client(N-1, M, P).
+
+generic_timer_client(0, _, _P) ->
+    ok;
+generic_timer_client(N, M, P) ->
+    _ = generic_server_timer:reply(P, M),
+    _ = generic_server_timer:reply(P, M),
+    _ = generic_server_timer:reply(P, M),
+    _ = generic_server_timer:reply(P, M),
+    _ = generic_server_timer:reply(P, M),
+    generic_timer_client(N-1, M, P).
+
+bench(simple) ->
+    {fun simple_client/3, simple_server};
+bench(simple_timer) ->
+    {fun simple_client_timer/3, simple_server_timer};
+bench(simple_mon) ->
+    {fun simple_client_mon/3, simple_server_mon};
+bench(simple_timer_mon) ->
+    {fun simple_client_timer_mon/3, simple_server_timer_mon};
+bench(generic) ->
+    {fun generic_client/3, generic_server};
+bench(generic_timer) ->
+    {fun generic_timer_client/3, generic_server_timer}.
+
+%% -> {Parallelism, NumberOfMessages, MessageTerm}
+bench_params(single_small) -> {1, 700000, small()};
+bench_params(single_medium) -> {1, 350000, medium()};
+bench_params(single_big) -> {1, 70000, big()};
+bench_params(sched_small)  -> {parallelism(), 200000, small()};
+bench_params(sched_medium)  -> {parallelism(), 100000, medium()};
+bench_params(sched_big)  -> {parallelism(), 20000, big()};
+bench_params(multi_small)  -> {400, 2000, small()};
+bench_params(multi_medium)  -> {400, 1000, medium()};
+bench_params(multi_big)  -> {400, 200, big()}.
+
+small() ->
+    small.
+
+medium() ->
+    lists:seq(1, 50).
+
+big() ->
+    lists:seq(1, 1000).
+
+parallelism() ->
+    case erlang:system_info(multi_scheduling) of
+        enabled -> erlang:system_info(schedulers_online);
+        _ -> 1
+    end.
+
+create_clients(N, M, ServerMod, Client, Parallel) ->
+    fun() ->
+            State = term,
+            ServerPid = ServerMod:start(State),
+            PidRefs = [spawn_monitor(fun() -> Client(N, M, ServerPid) end) ||
+                          _ <- lists:seq(1, Parallel)],
+            _ = [receive {'DOWN', Ref, _, _, _} -> ok end ||
+                    {_Pid, Ref} <- PidRefs],
+            ok = ServerMod:stop(ServerPid)
+    end.
+
+run_test(Test) ->
+    {T1, _} = statistics(runtime),
+    Test(),
+    {T2, _} = statistics(runtime),
+    T2 - T1.
diff --git a/lib/stdlib/test/stdlib_bench_SUITE_data/generic_server.erl b/lib/stdlib/test/stdlib_bench_SUITE_data/generic_server.erl
new file mode 100644
index 0000000000..abd61dcdef
--- /dev/null
+++ b/lib/stdlib/test/stdlib_bench_SUITE_data/generic_server.erl
@@ -0,0 +1,31 @@
+-module(generic_server).
+
+-export([start/1, reply/2, stop/1]).
+
+-export([handle_call/3, handle_cast/2, init/1, terminate/2]).
+
+-behaviour(gen_server).
+
+-define(GEN_SERVER, gen_server).
+
+start(State) ->
+    {ok, Pid} = ?GEN_SERVER:start(?MODULE, State, []),
+    Pid.
+
+init(State) ->
+    {ok, State}.
+
+stop(P) ->
+    ok = ?GEN_SERVER:stop(P).
+
+reply(S, M) ->
+    _M = ?GEN_SERVER:call(S, {reply, M}, infinity).
+
+handle_call({reply, M}, _From, State) ->
+    {reply, M, State}.
+
+handle_cast(_Msg, State) ->
+    {noreply, State}.
+
+terminate(_Reason, _State) ->
+    ok.
diff --git a/lib/stdlib/test/stdlib_bench_SUITE_data/generic_server_timer.erl b/lib/stdlib/test/stdlib_bench_SUITE_data/generic_server_timer.erl
new file mode 100644
index 0000000000..0faa30207d
--- /dev/null
+++ b/lib/stdlib/test/stdlib_bench_SUITE_data/generic_server_timer.erl
@@ -0,0 +1,31 @@
+-module(generic_server_timer).
+
+-export([start/1, reply/2, stop/1]).
+
+-export([handle_call/3, handle_cast/2, init/1, terminate/2]).
+
+-behaviour(gen_server).
+
+-define(GEN_SERVER, gen_server).
+
+start(State) ->
+    {ok, Pid} = ?GEN_SERVER:start(?MODULE, State, []),
+    Pid.
+
+init(State) ->
+    {ok, State}.
+
+stop(P) ->
+    ok = ?GEN_SERVER:stop(P).
+
+reply(S, M) ->
+    ?GEN_SERVER:call(S, {reply, M}).
+
+handle_call({reply, M}, _From, State) ->
+    {reply, M, State}.
+
+handle_cast(_Msg, State) ->
+    {noreply, State}.
+
+terminate(_Reason, _State) ->
+    ok.
diff --git a/lib/stdlib/test/stdlib_bench_SUITE_data/simple_server.erl b/lib/stdlib/test/stdlib_bench_SUITE_data/simple_server.erl
new file mode 100644
index 0000000000..bd43f686e8
--- /dev/null
+++ b/lib/stdlib/test/stdlib_bench_SUITE_data/simple_server.erl
@@ -0,0 +1,31 @@
+-module(simple_server).
+
+%% Local process. No timer. No monitor.
+
+-export([start/1, reply/2, stop/1]).
+
+start(State) ->
+    spawn(fun() -> loop(State) end).
+
+stop(P) ->
+    P ! {stop, self()},
+    receive
+        ok ->
+            ok
+    end.
+
+loop(S) ->
+    receive
+        {reply, P, M} ->
+            P ! M,
+            loop(S);
+        {stop, P} ->
+            P ! ok
+    end.
+
+reply(P, M) ->
+    P ! {reply, self(), M},
+    receive
+        M ->
+            M
+    end.
diff --git a/lib/stdlib/test/stdlib_bench_SUITE_data/simple_server_mon.erl b/lib/stdlib/test/stdlib_bench_SUITE_data/simple_server_mon.erl
new file mode 100644
index 0000000000..9b5ace5586
--- /dev/null
+++ b/lib/stdlib/test/stdlib_bench_SUITE_data/simple_server_mon.erl
@@ -0,0 +1,33 @@
+-module(simple_server_mon).
+
+%% Local process. No timer. Monitor.
+
+-export([start/1, reply/2, stop/1]).
+
+start(State) ->
+    spawn(fun() -> loop(State) end).
+
+stop(P) ->
+    P ! {stop, self()},
+    receive
+        ok ->
+            ok
+    end.
+
+loop(S) ->
+    receive
+        {reply, P, Mref, M} ->
+            P ! {ok, Mref, M},
+            loop(S);
+        {stop, P} ->
+            P ! ok
+    end.
+
+reply(P, M) ->
+    Mref = erlang:monitor(process, P),
+    P ! {reply, self(), Mref, M},
+    receive
+        {ok, Mref, M} ->
+            erlang:demonitor(Mref, [flush]),
+            ok
+    end.
diff --git a/lib/stdlib/test/stdlib_bench_SUITE_data/simple_server_timer.erl b/lib/stdlib/test/stdlib_bench_SUITE_data/simple_server_timer.erl
new file mode 100644
index 0000000000..82381e1fdf
--- /dev/null
+++ b/lib/stdlib/test/stdlib_bench_SUITE_data/simple_server_timer.erl
@@ -0,0 +1,33 @@
+-module(simple_server_timer).
+
+%% Local process. Timer. No monitor.
+
+-export([start/1, reply/2, stop/1]).
+
+start(State) ->
+    spawn(fun() -> loop(State) end).
+
+stop(P) ->
+    P ! {stop, self()},
+    receive
+        ok ->
+            ok
+    end.
+
+loop(S) ->
+    receive
+        {reply, P, M} ->
+            P ! M,
+            loop(S);
+        {stop, P} ->
+            P ! ok
+    end.
+
+reply(P, M) ->
+    P ! {reply, self(), M},
+    receive
+        M ->
+            M
+    after 100 ->
+            exit(fel)
+    end.
diff --git a/lib/stdlib/test/stdlib_bench_SUITE_data/simple_server_timer_mon.erl b/lib/stdlib/test/stdlib_bench_SUITE_data/simple_server_timer_mon.erl
new file mode 100644
index 0000000000..6124ca29c2
--- /dev/null
+++ b/lib/stdlib/test/stdlib_bench_SUITE_data/simple_server_timer_mon.erl
@@ -0,0 +1,35 @@
+-module(simple_server_timer_mon).
+
+%% Local process. Timer. Monitor.
+
+-export([start/1, reply/2, stop/1]).
+
+start(State) ->
+    spawn(fun() -> loop(State) end).
+
+stop(P) ->
+    P ! {stop, self()},
+    receive
+        ok ->
+            ok
+    end.
+
+loop(S) ->
+    receive
+        {reply, P, Mref, M} ->
+            P ! {ok, Mref, M},
+            loop(S);
+        {stop, P} ->
+            P ! ok
+    end.
+
+reply(P, M) ->
+    Mref = erlang:monitor(process, P),
+    P ! {reply, self(), Mref, M},
+    receive
+        {ok, Mref,  M} ->
+            erlang:demonitor(Mref, [flush]),
+            ok
+    after 100 ->
+            exit(fel)
+    end.