pacemaker plugin

Needs test-tools!220 (merged)

It is a basic substitute for not yet implemented mock-peer tool. The plugin can only pull blocks from separate block log and pass them to node as if they arrived from p2p. Works only in testnet and only when there is just one pacemaker and no witness plugin in whole network.

Draft: only very basic tests were run with it, so it should be treated as experiment.

How to use:

• you need separate block_log file and associated block_log.artifacts to act as a source of blocks
• add plugin = pacemaker to config.ini and make sure there is no witness
• add pacemaker-source = <SOURCE_BLOCK_LOG_PATH> pointing to above mentioned block_log
• you can also add pacemaker-min-offset = <OFFSET_FROM_BLOCK_TS> - pacemaker will wait until block.timestamp + min_offset before emitting the block; default value is -300 meaning blocks can be emitted up to -300ms before their timestamp (which is typical value for healthy network) but you can emulate lagging node by setting the value to some big positive number
• you can add pacemaker-max-offset = <OFFSET_FROM_BLOCK_TS> - pacemaker will stop the node in case it didn't manage to emit the block before block.timestamp + max_offset indicating either wrong starting time (when it happens on startup) or too big processing lag (when it happens later); default value is 20000 which is 20 seconds
• you have to run the node with faketime setting time prior to first_block_to_emit.timestamp + max_offset; if time is too early, the node will idly wait until the time is right (see log message: First block to emit is #<BLOCK_NUM> with timestamp <BLOCK_TS>; Current time: <TIME>); for this reason it is better to be a bit late (but not too much or the node will fail on startup), because pacemaker will try to catch up by emitting blocks at max processing speed (emulating "sync mode")

libraries/plugins/pacemaker/include/hive/plugins/pacemaker/pacemaker_plugin.hpp

+#pragma once
+#include <hive/chain/hive_fwd.hpp>
+#include <hive/plugins/chain/chain_plugin.hpp>
+#include <hive/plugins/p2p/p2p_plugin.hpp>
+
+#include <appbase/application.hpp>
+
+#include <hive/protocol/testnet_blockchain_configuration.hpp>
+
+#define HIVE_PACEMAKER_PLUGIN_NAME "pacemaker"
+
+namespace hive { namespace plugins { namespace pacemaker {
+
+namespace detail { class pacemaker_plugin_impl; }
+
+enum class block_emission_condition
+{
+  normal = 0,
+  lag = 1,
+  too_early = 2,
+  too_late = 3,
+  no_more_blocks = 4,
+  exception_emitting_block = 5
+};
+
+class pacemaker_plugin : public appbase::plugin< pacemaker_plugin >
+{
+public:
+  APPBASE_PLUGIN_REQUIRES(
+    (hive::plugins::chain::chain_plugin)
+    (hive::plugins::p2p::p2p_plugin)
+  )
+
+  pacemaker_plugin();
+  virtual ~pacemaker_plugin();
+
+  static const std::string& name() { static std::string name = HIVE_PACEMAKER_PLUGIN_NAME; return name; }
+
+  virtual void set_program_options(
+    boost::program_options::options_description &command_line_options,
+    boost::program_options::options_description &config_file_options
+    ) override;
+
+  virtual void plugin_initialize(const boost::program_options::variables_map& options) override;
+  virtual void plugin_startup() override;
+  virtual void plugin_shutdown() override;
+
+private:
+  std::unique_ptr< detail::pacemaker_plugin_impl > my;
+};
+
+} } } // hive::plugins::pacemaker