Report no_solution for all relevant nonces with repeats

Reviewed-on: #13
Reviewed-by: Jarvis Carroll <jarviscarrol@qpq.swiss>
Reviewed-by: Craig Everett <craigeverett@qpq.swiss>

ebin/gmhive_client.app

@@ -1,6 +1,6 @@
 {application,gmhive_client,
              [{description,"Gajumaru Hive Client"},
-              {vsn,"0.4.4"},
+              {vsn,"0.6.1"},
               {registered,[]},
               {applications,[kernel,stdlib,sasl,gproc,inets,ssl,enoise,
                              gmconfig,gmhive_protocol,gmhive_worker]},

rebar.config

@@ -10,7 +10,7 @@
         {gmhive_protocol,
          {git, "https://git.qpq.swiss/QPQ-AG/gmhive_protocol.git",
           {ref, "818ce33"}}},
-        {gmhive_worker, {git, "https://git.qpq.swiss/QPQ-AG/gmhive_worker", {ref, "255ef59"}}},
+        {gmhive_worker, {git, "https://git.qpq.swiss/QPQ-AG/gmhive_worker", {ref, "cabd104114"}}},
         {gmconfig, {git, "https://git.qpq.swiss/QPQ-AG/gmconfig.git",
                     {ref, "38620ff9e2"}}},
         {gproc, "1.0.0"},

rebar.lock

@@ -21,7 +21,7 @@
   0},
  {<<"gmcuckoo">>,
   {git,"https://git.qpq.swiss/QPQ-AG/gmcuckoo.git",
-       {ref,"106e1cd2e4ff81286f6bc7d7c85f83bc20e14b82"}},
+       {ref,"256e14e7c88043132245be902ff9756070d285b4"}},
   1},
  {<<"gmhive_protocol">>,
   {git,"https://git.qpq.swiss/QPQ-AG/gmhive_protocol.git",
@@ -29,7 +29,7 @@
   0},
  {<<"gmhive_worker">>,
   {git,"https://git.qpq.swiss/QPQ-AG/gmhive_worker",
-       {ref,"255ef59ccd7f795d2d25f2d0ebcf24e3251b6f36"}},
+       {ref,"cabd104114691edb925aacd7e04d431d47bac420"}},
   0},
  {<<"gmserialization">>,
   {git,"https://git.qpq.swiss/QPQ-AG/gmserialization.git",

src/gmhc_app.erl

@@ -1,5 +1,6 @@
 %% -*- mode: erlang; erlang-indent-level: 4; indent-tabs-mode: nil -*-
 -module(gmhc_app).
+-vsn("0.6.1").
 
 -behaviour(application).
 
@@ -48,4 +49,13 @@ set_things_up() ->
     gmhc_config:load_config(),
     logger:set_module_level([gmhw_pow_cuckoo], notice),
     ?LOG_DEBUG("Config: ~p", [gmconfig:user_config()]),
+    case gmhc_config:get_config([<<"report">>]) of
+        <<"debug">> ->
+            ?LOG_NOTICE("Starting debug reporter", []),
+            gmhc_events:debug();
+        <<"progress">> ->
+            ?LOG_NOTICE("Starting progress reporter", []),
+            gmhc_events:progress();
+        _ -> ok
+    end,
     ok.

src/gmhc_config.erl

@@ -1,4 +1,5 @@
 -module(gmhc_config).
+-vsn("0.6.1").
 
 -export([ load_config/0
         , get_config/1

src/gmhc_config_schema.erl

@@ -1,4 +1,5 @@
 -module(gmhc_config_schema).
+-vsn("0.6.1").
 
 -export([ schema/0
         , to_json/0 ]).
@@ -38,6 +39,9 @@ schema() ->
          , pool => pool()
          , pool_admin => pool_admin()
          , workers => workers()
+         , report => str(#{ enum  => [<<"debug">>, <<"progress">>, <<"silent">>]
+                          , default => <<"silent">>
+                          , description => <<"Progress reporting">> })
          }).
 
 pool() ->

src/gmhc_connector.erl

@@ -1,4 +1,5 @@
 -module(gmhc_connector).
+-vsn("0.6.1").
 
 -behaviour(gen_server).
 

src/gmhc_connectors_sup.erl

@@ -1,4 +1,5 @@
 -module(gmhc_connectors_sup).
+-vsn("0.6.1").
 -behavior(supervisor).
 
 -export([ start_link/0

src/gmhc_counters.erl

@@ -1,4 +1,5 @@
 -module(gmhc_counters).
+-vsn("0.6.1").
 
 -export([ initialize/0 ]).
 

src/gmhc_eureka.erl

@@ -1,4 +1,5 @@
 -module(gmhc_eureka).
+-vsn("0.6.1").
 
 -export([get_pool_address/0]).
 

src/gmhc_events.erl

@@ -1,4 +1,5 @@
 -module(gmhc_events).
+-vsn("0.6.1").
 
 -export([subscribe/1,
          ensure_subscribed/1,
@@ -6,7 +7,17 @@
          ensure_unsubscribed/1,
          publish/2]).
 
--export([debug/0]).
+-export([debug/0,
+         progress/0,
+         stop/0]).
+
+-export([rpt_debug/2,
+         rpt_progress/2]).
+
+%% internal
+-export([init_reporter/2]).
+
+-include_lib("kernel/include/logger.hrl").
 
 -export_type([event/0]).
 
@@ -59,22 +70,100 @@ ensure_unsubscribed(Event) ->
 
 debug() ->
     ok = application:ensure_started(gproc),
-    spawn(fun() ->
-                  subscribe(pool_notification),
-                  subscribe({pool_notification, new_generation}),
-                  subscribe(connected),
-                  subscribe(puzzle),
-                  subscribe(result),
-                  subscribe(error),
-                  subscribe(disconnected),
-                  loop()
-          end).
+    spawn_reporter(fun() ->
+                           sub(),
+                           gmhive_worker:subscribe_returns(),
+                           loop(fun rpt_debug/2, false)
+                   end).
 
-loop() ->
+progress() ->
+    ok = application:ensure_started(gproc),
+    spawn_reporter(fun() ->
+                           sub(),
+                           loop(fun rpt_progress/2, true)
+                   end).
+
+spawn_reporter(F) ->
+    Parent = self(),
+    proc_lib:start_link(?MODULE, init_reporter, [F, Parent]).
+
+init_reporter(F, Parent) ->
+    try_register_reporter(),
+    proc_lib:init_ack(Parent, self()),
+    F().
+
+stop() ->
+    case whereis(gmhc_reporter) of
+        undefined ->
+            not_running;
+        Pid ->
+            exit(Pid, kill)
+    end.
+
+sub() ->
+    subscribe(pool_notification),
+    subscribe({pool_notification, new_generation}),
+    subscribe(connected),
+    subscribe(puzzle),
+    subscribe(result),
+    subscribe(error),
+    subscribe(disconnected).
+
+loop(F, Ts) ->
     receive
         stop -> ok;
         {gproc_ps_event, E, Data} ->
-            io:fwrite("EVENT ~p: ~p~n", [E, Data]),
-            loop()
+            maybe_print(F(E, Data), Ts),
+            loop(F, Ts)
     end.
-             
+
+try_register_reporter() ->
+    try register(gmhc_reporter, self())
+    catch
+        error:_ ->
+            ?LOG_ERROR("Reporter already running. Try gmhc_events:stop().", []),
+            error(already_running)
+    end.
+
+maybe_print([], _) ->
+    ok;
+maybe_print(String, Ts) when is_boolean(Ts) ->
+    TSstr = [[ts(), " "] || Ts],
+    io:put_chars([TSstr, String, "\n"]).
+
+ts() ->
+    calendar:system_time_to_rfc3339(erlang:system_time(millisecond),
+                                    [{unit, millisecond}, {offset, "Z"}]).
+
+rpt_debug(E, Data) ->
+    io_lib:fwrite("EVENT ~p: ~p", [E, Data]).
+
+rpt_progress(puzzle, #{info := {_Data, _Target, Nonce, _Config}}) ->
+    w("Trying nonce: ~p", [Nonce]);
+rpt_progress(result, #{info := Info}) ->
+    case Info of
+        {error, no_solution} ->
+            [];
+        {ok, Cycles} ->
+            w("Found! Reporting ~w cycles to leader.", [length(Cycles)]);
+        Other ->
+            w("Unexpected 'result': ~tp", [Other])
+    end;
+rpt_progress(pool_notification, #{info := #{msg := Msg}}) ->
+    case Msg of
+        #{solution_accepted := #{seq := Seq}} ->
+            w("The hive has produced a solution! Sequence: ~w", [Seq]);
+        #{new_generation := _} -> [];
+        #{candidate := _}      -> [];
+        Other ->
+            w("Unexpected 'pool_notification': ~tp", [Other])
+    end;
+rpt_progress(connected, _) ->
+    w("Connected!", []);
+rpt_progress(disconnected, _) ->
+    w("Disconnected!", []);
+rpt_progress(_, _) ->
+    [].
+
+w(Fmt, Args) ->
+    io_lib:fwrite(Fmt, Args).

src/gmhc_handler.erl

@@ -1,4 +1,5 @@
 -module(gmhc_handler).
+-vsn("0.6.1").
 -behavior(gen_server).
 
 -export([ start_link/0
@@ -11,6 +12,7 @@
         ]).
 
 -export([ call/1
+        , async_call/1
         , notify/1
         , pool_connected/2
         , from_pool/1 ]).
@@ -37,6 +39,13 @@ call(Req) ->
             {error, Reason}
     end.
 
+async_call(Req) ->
+    try gen_server:call(?MODULE, {async_call, Req}, ?CALL_TIMEOUT)
+    catch
+        exit:Reason ->
+            {error, Reason}
+    end.
+
 notify(Msg) ->
     gen_server:cast(?MODULE, {notify, Msg}).
 
@@ -55,6 +64,8 @@ init([]) ->
 
 handle_call({call, Req}, _From, #st{} = S) ->
     {reply, call_connector(Req), S};
+handle_call({async_call, Req}, _From, #st{} = S) ->
+    {reply, call_connector(Req, false), S};
 handle_call(_Req, _From, S) ->
     {reply, {error, unknown_method}, S}.
 
@@ -118,24 +129,39 @@ maybe_publish(_) ->
 maybe_via(#{via := Via}, Info) ->
     Info#{via => Via}.
 
-call_connector(Req0) ->
+call_connector(Req) ->
+    call_connector(Req, true).
+
+call_connector(Req0, Wait) ->
     {ViaId, Req} = maps:take(via, Req0),
     case gmhc_connector:whereis_id(ViaId) of
         undefined ->
             {error, no_connection};
         Pid when is_pid(Pid) ->
             Id = erlang:unique_integer(),
-            MRef = erlang:monitor(process, Pid),
+            MRef = case Wait of
+                       true  -> erlang:monitor(process, Pid);
+                       false -> none
+                   end,
             gmhc_connector:send(ViaId, #{call => Req#{ id => Id }}),
-            receive
-                {from_pool, #{reply := #{ id := Id, result := Result }}} ->
-                    Result;
-                {from_pool, #{error := #{ id := Id } = Error}} ->
-                    {error, maps:remove(id, Error)};
-                {'DOWN', MRef, _, _, _} ->
-                    {error, no_connection}
-            after 5000 ->
-                    {error, {timeout, process_info(self(), messages)}}
+            case Wait of
+                true ->
+                    receive
+                        {from_pool, #{reply := #{ id := Id
+                                                , result := Result }}} ->
+                            erlang:demonitor(MRef),
+                            Result;
+                        {from_pool, #{error := #{ id := Id } = Error}} ->
+                            erlang:demonitor(MRef),
+                            {error, maps:remove(id, Error)};
+                        {'DOWN', MRef, _, _, _} ->
+                            {error, no_connection}
+                    after 5000 ->
+                            erlang:demonitor(MRef),
+                            {error, {timeout, process_info(self(), messages)}}
+                    end;
+                false ->
+                    ok
             end
     end.
 

src/gmhc_server.erl

@@ -1,4 +1,5 @@
 -module(gmhc_server).
+-vsn("0.6.1").
 
 -behaviour(gen_server).
 
@@ -44,7 +45,7 @@
 
 -define(CONNECTED(S), map_size(S#st.connected) > 0).
 
--define(MAX_ERRORS, 5).
+-define(MAX_ERRORS, 50).
 
 connected(Id, Type) ->
     gen_server:call(?MODULE, {connected, Id, Type}).
@@ -107,17 +108,20 @@ handle_cast({from_pool, #{via := Connector,
     %% We could check whether we have already received the candidate ...
     %% For now, stop all workers, restart with new candidate
     try
-        % Most of the time we don't want to stop the worker. If we do, though, then
-        % we need to do it more carefully than this, or memory usage will triple.
-        % Workers1 = stop_workers(Workers),
-        {Workers2, Cand1} = assign_nonces(Workers, Cand),
-        #st{candidate = Cand2} = S1 = maybe_request_nonces(S#st{candidate = Cand1}),
-        NewWorkers = [spawn_worker(W, Cand2) || W <- Workers2],
-        {noreply, S1#st{workers = NewWorkers}}
+        %% Most of the time we don't want to stop the worker. If we do, though, then
+        %% we need to do it more carefully than this, or memory usage will triple.
+        %% Workers1 = stop_workers(Workers),
+        %%
+        %% Nonces may be [], in which case we need to request new nonces first.
+        #st{candidate = Cand1} = S1 = maybe_request_nonces(S#st{candidate = Cand}),
+        {Workers2, Cand2} = assign_nonces(Workers, Cand1),
+        #st{candidate = Cand3} = S2 = maybe_request_nonces(S1#st{candidate = Cand2}),
+        NewWorkers = [spawn_worker(W, Cand3) || W <- Workers2],
+        {noreply, S2#st{workers = NewWorkers}}
     catch
        Cat:Err:St ->
            ?LOG_ERROR("CAUGHT ~p:~p / ~p", [Cat, Err, St]),
-	   {noreply, S}
+           {noreply, S}
     end;
 handle_cast({disconnected, Id}, #st{connected = Conn} = S) ->
     ?LOG_DEBUG("disconnected: ~p", [Id]),
@@ -151,11 +155,23 @@ handle_info({'EXIT', Pid, Reason}, #st{ workers = Workers
             gmhc_events:publish(error, ?ERR_EVT(#{error => worker_error,
                                                    data  => Reason})),
             Ws1 = incr_worker_error(W, Workers),
+            erlang:start_timer(100, self(), check_workers),
             {noreply, S#st{workers = Ws1}};
         false ->
             %% ?LOG_DEBUG("EXIT apparently not from worker?? (~p)", [Pid]),
             {noreply, S}
     end;
+handle_info({timeout, _, check_workers}, #st{workers = Workers} = S) ->
+    case [W || #worker{cand = undefined} = W <- Workers] of
+        [] ->
+            {noreply, S};
+        Idle ->
+            S1 = maybe_request_nonces(S),
+            S2 = lists:foldl(fun(W, Sx) ->
+                                 maybe_restart_worker(W, Sx)
+                             end, S1, Idle),
+            {noreply, S2}
+    end;
 handle_info(Msg, St) ->
     ?LOG_DEBUG("Unknown msg: ~p", [Msg]),
     {noreply, St}.
@@ -168,6 +184,9 @@ code_change(_FromVsn, S, _Extra) ->
 
 report_solutions(Solutions, W, #st{} = S) when ?CONNECTED(S) ->
     #{via := Via, seq := Seq} = W#worker.cand,
+    Nonces = all_nonces(W),
+    [report_no_solution_(Via, Seq, N)
+     || N <- Nonces, not lists:keymember(N, 1, Solutions)],
     gmhc_handler:call(
       #{via => Via,
         solutions => #{ seq => Seq
@@ -175,18 +194,23 @@ report_solutions(Solutions, W, #st{} = S) when ?CONNECTED(S) ->
                                    , evidence => Evd }
                                   || {Nonce, Evd} <- Solutions] }}).
 
-%% report_solution(Nonce, Solution, W, #st{connected = true}) ->
-%%     #{seq := Seq} = W#worker.cand,
-%%     gmhc_handler:call(#{solution => #{ seq => Seq
-%%                                       , nonce => Nonce
-%%                                       , evidence => Solution }}).
-
-report_no_solution(Nonce, W, #st{} = S) when ?CONNECTED(S) ->
+report_no_solution(_Nonce, W, #st{} = S) when ?CONNECTED(S) ->
     #{via := Via, seq := Seq} = W#worker.cand,
+    Nonces = all_nonces(W),
     %% ?LOG_DEBUG("report no_solution Seq = ~p, Nonce = ~p", [Seq, Nonce]),
-    gmhc_handler:call(#{via => Via,
-                         no_solution => #{ seq => Seq
-                                         , nonce => Nonce}}).
+    [report_no_solution_(Via, Seq, Nonce1) || Nonce1 <- Nonces],
+    ok.
+
+report_no_solution_(Via, Seq, Nonce) ->
+    gmhc_handler:async_call(#{via => Via,
+                              no_solution => #{ seq => Seq
+                                              , nonce => Nonce}}).
+
+all_nonces(#worker{nonce = Nonce, config = Config}) ->
+    case gmhw_pow_cuckoo:repeats(Config) of
+        1  -> [Nonce];
+        Rs -> lists:seq(Nonce, Nonce + Rs - 1)
+    end.
 
 maybe_request_nonces(#st{ candidate = #{via := Via, seq := Seq, nonces := Nonces}
                         , nonces = N} = S) when ?CONNECTED(S) ->
@@ -223,14 +247,14 @@ handle_worker_result({worker_result, Result}, W, S) ->
     case Result of
         {solutions, Solutions} ->
             {Cont, S1} = report_solutions_(Solutions, W, S),
-            maybe_continue(Cont, W, S1);
+            maybe_continue(Cont, reset_errors(W), S1);
         {solution, Nonce, Solution} ->
             %% report_solution(Nonce, Solution, W, S),
             {Cont, S1} = report_solutions_([{Nonce, Solution}], W, S),
-            maybe_continue(Cont, W, S1);
+            maybe_continue(Cont, reset_errors(W), S1);
         {no_solution, Nonce} ->
             report_no_solution(Nonce, W, S),
-            maybe_restart_worker(W, S);
+            maybe_restart_worker(reset_errors(W), S);
         {error, S} ->
             ?LOG_DEBUG("Worker ~p reported error as normal", [W#worker.index]),
             gmhc_events:publish(error, ?ERR_EVT(#{error => worker_error,
@@ -258,6 +282,9 @@ report_solutions_(Solutions, W, S) ->
             {error, S}
     end.
 
+reset_errors(#worker{} = W) ->
+    W#worker{errors = 0}.
+
 reset_worker(#worker{index = I} = W, Ws) ->
     W1 = reset_worker_(W),
     lists:keyreplace(I, #worker.index, Ws, W1).

src/gmhc_sup.erl

@@ -1,5 +1,6 @@
 %% -*- mode: erlang; erlang-indent-level: 4; indent-tabs-mode: nil -*-
 -module(gmhc_sup).
+-vsn("0.6.1").
 
 -behaviour(supervisor).
 

src/gmhc_workers.erl

@@ -8,6 +8,7 @@
 %%%-------------------------------------------------------------------
 
 -module(gmhc_workers).
+-vsn("0.6.1").
 
 -export([
           get_worker_configs/0

src/gmhive_client.app.src

@@ -1,7 +1,7 @@
 %% -*- mode: erlang; erlang-indent-level: 4; indent-tabs-mode: nil -*-
 {application, gmhive_client,
  [{description, "Gajumaru Hive Client"},
-  {vsn, "0.1.0"},
+  {vsn, "zomp"},
   {registered, []},
   {applications,
    [

src/gmhive_client.app.src.script

@@ -0,0 +1,14 @@
+%% -*- erlang-mode; erlang-indent-level: 4; indent-tabs-mode: nil -*-
+
+[{application, Name, Opts}] = CONFIG.
+case lists:keyfind(vsn, 1, Opts) of
+    {vsn, "zomp"} ->
+        ZompMetaF = filename:join(filename:dirname(filename:dirname(SCRIPT)), "zomp.meta"),
+        {ok, ZMeta} = file:consult(ZompMetaF),
+        {_, {_, _, {Vmaj,Vmin,Vpatch}}} = lists:keyfind(package_id, 1, ZMeta),
+        VsnStr = unicode:characters_to_list(io_lib:fwrite("~w.~w.~w", [Vmaj, Vmin, Vpatch])),
+        Opts1 = lists:keyreplace(vsn, 1, Opts, {vsn, VsnStr}),
+        [{application, Name, Opts1}];
+    _ ->
+        CONFIG
+end.

src/gmhive_client.erl

@@ -1,4 +1,5 @@
 -module(gmhive_client).
+-vsn("0.6.1").
 
 -export([ connect/1
         , disconnect/1

zomp.meta

@@ -2,11 +2,11 @@
 {type,app}.
 {modules,[]}.
 {prefix,"gmhc"}.
-{desc,"Gajumaru Hive Client"}.
 {author,"Ulf Wiger, QPQ AG"}.
-{package_id,{"uwiger","gmhive_client",{0,4,4}}}.
-{deps,[{"uwiger","gmcuckoo",{1,2,3}},
-       {"uwiger","gmhive_worker",{0,3,0}},
+{desc,"Gajumaru Hive Client"}.
+{package_id,{"uwiger","gmhive_client",{0,6,1}}}.
+{deps,[{"uwiger","gmhive_worker",{0,5,1}},
+       {"uwiger","gmcuckoo",{1,2,4}},
        {"otpr","eblake2",{1,0,1}},
        {"otpr","base58",{0,1,1}},
        {"otpr","gmserialization",{0,1,3}},