This repository has been archived by the owner on Aug 2, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
/
producer_plugin.cpp
1601 lines (1356 loc) · 73.3 KB
/
producer_plugin.cpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/**
* @file
* @copyright defined in eos/LICENSE
*/
#include <eosio/producer_plugin/producer_plugin.hpp>
#include <eosio/chain/producer_object.hpp>
#include <eosio/chain/plugin_interface.hpp>
#include <eosio/chain/global_property_object.hpp>
#include <eosio/chain/generated_transaction_object.hpp>
#include <eosio/chain/transaction_object.hpp>
#include <eosio/chain/snapshot.hpp>
#include <fc/io/json.hpp>
#include <fc/smart_ref_impl.hpp>
#include <fc/scoped_exit.hpp>
#include <boost/asio.hpp>
#include <boost/date_time/posix_time/posix_time.hpp>
#include <iostream>
#include <algorithm>
#include <boost/algorithm/string.hpp>
#include <boost/range/adaptor/map.hpp>
#include <boost/function_output_iterator.hpp>
#include <boost/multi_index_container.hpp>
#include <boost/multi_index/member.hpp>
#include <boost/multi_index/hashed_index.hpp>
#include <boost/multi_index/ordered_index.hpp>
#include <boost/signals2/connection.hpp>
namespace bmi = boost::multi_index;
using bmi::indexed_by;
using bmi::ordered_non_unique;
using bmi::member;
using bmi::tag;
using bmi::hashed_unique;
using boost::multi_index_container;
using std::string;
using std::vector;
using std::deque;
using boost::signals2::scoped_connection;
// HACK TO EXPOSE LOGGER MAP
namespace fc {
extern std::unordered_map<std::string,logger>& get_logger_map();
}
const fc::string logger_name("producer_plugin");
fc::logger _log;
const fc::string trx_trace_logger_name("transaction_tracing");
fc::logger _trx_trace_log;
namespace eosio {
static appbase::abstract_plugin& _producer_plugin = app().register_plugin<producer_plugin>();
using namespace eosio::chain;
using namespace eosio::chain::plugin_interface;
namespace {
bool failure_is_subjective(const fc::exception& e, bool deadline_is_subjective) {
auto code = e.code();
return (code == block_cpu_usage_exceeded::code_value) ||
(code == block_net_usage_exceeded::code_value) ||
(code == deadline_exception::code_value && deadline_is_subjective);
}
}
struct transaction_id_with_expiry {
transaction_id_type trx_id;
fc::time_point expiry;
};
struct by_id;
struct by_expiry;
using transaction_id_with_expiry_index = multi_index_container<
transaction_id_with_expiry,
indexed_by<
hashed_unique<tag<by_id>, BOOST_MULTI_INDEX_MEMBER(transaction_id_with_expiry, transaction_id_type, trx_id)>,
ordered_non_unique<tag<by_expiry>, BOOST_MULTI_INDEX_MEMBER(transaction_id_with_expiry, fc::time_point, expiry)>
>
>;
enum class pending_block_mode {
producing,
speculating
};
#define CATCH_AND_CALL(NEXT)\
catch ( const fc::exception& err ) {\
NEXT(err.dynamic_copy_exception());\
} catch ( const std::exception& e ) {\
fc::exception fce( \
FC_LOG_MESSAGE( warn, "rethrow ${what}: ", ("what",e.what())),\
fc::std_exception_code,\
BOOST_CORE_TYPEID(e).name(),\
e.what() ) ;\
NEXT(fce.dynamic_copy_exception());\
} catch( ... ) {\
fc::unhandled_exception e(\
FC_LOG_MESSAGE(warn, "rethrow"),\
std::current_exception());\
NEXT(e.dynamic_copy_exception());\
}
class producer_plugin_impl : public std::enable_shared_from_this<producer_plugin_impl> {
public:
producer_plugin_impl(boost::asio::io_service& io)
:_timer(io)
,_transaction_ack_channel(app().get_channel<compat::channels::transaction_ack>())
{
}
optional<fc::time_point> calculate_next_block_time(const account_name& producer_name, const block_timestamp_type& current_block_time) const;
void schedule_production_loop();
void produce_block();
bool maybe_produce_block();
boost::program_options::variables_map _options;
bool _production_enabled = false;
bool _pause_production = false;
uint32_t _production_skip_flags = 0; //eosio::chain::skip_nothing;
using signature_provider_type = std::function<chain::signature_type(chain::digest_type)>;
std::map<chain::public_key_type, signature_provider_type> _signature_providers;
std::set<chain::account_name> _producers;
boost::asio::deadline_timer _timer;
std::map<chain::account_name, uint32_t> _producer_watermarks;
pending_block_mode _pending_block_mode;
transaction_id_with_expiry_index _persistent_transactions;
fc::optional<boost::asio::thread_pool> _thread_pool;
int32_t _max_transaction_time_ms;
fc::microseconds _max_irreversible_block_age_us;
int32_t _produce_time_offset_us = 0;
int32_t _last_block_time_offset_us = 0;
int32_t _max_scheduled_transaction_time_per_block_ms;
fc::time_point _irreversible_block_time;
fc::microseconds _keosd_provider_timeout_us;
time_point _last_signed_block_time;
time_point _start_time = fc::time_point::now();
uint32_t _last_signed_block_num = 0;
producer_plugin* _self = nullptr;
chain_plugin* chain_plug = nullptr;
incoming::channels::block::channel_type::handle _incoming_block_subscription;
incoming::channels::transaction::channel_type::handle _incoming_transaction_subscription;
compat::channels::transaction_ack::channel_type& _transaction_ack_channel;
incoming::methods::block_sync::method_type::handle _incoming_block_sync_provider;
incoming::methods::transaction_async::method_type::handle _incoming_transaction_async_provider;
transaction_id_with_expiry_index _blacklisted_transactions;
fc::optional<scoped_connection> _accepted_block_connection;
fc::optional<scoped_connection> _irreversible_block_connection;
/*
* HACK ALERT
* Boost timers can be in a state where a handler has not yet executed but is not abortable.
* As this method needs to mutate state handlers depend on for proper functioning to maintain
* invariants for other code (namely accepting incoming transactions in a nearly full block)
* the handlers capture a corelation ID at the time they are set. When they are executed
* they must check that correlation_id against the global ordinal. If it does not match that
* implies that this method has been called with the handler in the state where it should be
* cancelled but wasn't able to be.
*/
uint32_t _timer_corelation_id = 0;
// keep a expected ratio between defer txn and incoming txn
double _incoming_trx_weight = 0.0;
double _incoming_defer_ratio = 1.0; // 1:1
// path to write the snapshots to
bfs::path _snapshots_dir;
void on_block( const block_state_ptr& bsp ) {
if( bsp->header.timestamp <= _last_signed_block_time ) return;
if( bsp->header.timestamp <= _start_time ) return;
if( bsp->block_num <= _last_signed_block_num ) return;
const auto& active_producer_to_signing_key = bsp->active_schedule.producers;
flat_set<account_name> active_producers;
active_producers.reserve(bsp->active_schedule.producers.size());
for (const auto& p: bsp->active_schedule.producers) {
active_producers.insert(p.producer_name);
}
std::set_intersection( _producers.begin(), _producers.end(),
active_producers.begin(), active_producers.end(),
boost::make_function_output_iterator( [&]( const chain::account_name& producer )
{
if( producer != bsp->header.producer ) {
auto itr = std::find_if( active_producer_to_signing_key.begin(), active_producer_to_signing_key.end(),
[&](const producer_key& k){ return k.producer_name == producer; } );
if( itr != active_producer_to_signing_key.end() ) {
auto private_key_itr = _signature_providers.find( itr->block_signing_key );
if( private_key_itr != _signature_providers.end() ) {
auto d = bsp->sig_digest();
auto sig = private_key_itr->second( d );
_last_signed_block_time = bsp->header.timestamp;
_last_signed_block_num = bsp->block_num;
// ilog( "${n} confirmed", ("n",name(producer)) );
_self->confirmed_block( { bsp->id, d, producer, sig } );
}
}
}
} ) );
// since the watermark has to be set before a block is created, we are looking into the future to
// determine the new schedule to identify producers that have become active
chain::controller& chain = chain_plug->chain();
const auto hbn = bsp->block_num;
auto new_block_header = bsp->header;
new_block_header.timestamp = new_block_header.timestamp.next();
new_block_header.previous = bsp->id;
auto new_bs = bsp->generate_next(new_block_header.timestamp);
// for newly installed producers we can set their watermarks to the block they became active
if (new_bs.maybe_promote_pending() && bsp->active_schedule.version != new_bs.active_schedule.version) {
flat_set<account_name> new_producers;
new_producers.reserve(new_bs.active_schedule.producers.size());
for( const auto& p: new_bs.active_schedule.producers) {
if (_producers.count(p.producer_name) > 0)
new_producers.insert(p.producer_name);
}
for( const auto& p: bsp->active_schedule.producers) {
new_producers.erase(p.producer_name);
}
for (const auto& new_producer: new_producers) {
_producer_watermarks[new_producer] = hbn;
}
}
}
void on_irreversible_block( const signed_block_ptr& lib ) {
_irreversible_block_time = lib->timestamp.to_time_point();
}
template<typename Type, typename Channel, typename F>
auto publish_results_of(const Type &data, Channel& channel, F f) {
auto publish_success = fc::make_scoped_exit([&, this](){
channel.publish(std::pair<fc::exception_ptr, Type>(nullptr, data));
});
try {
auto trace = f();
if (trace->except) {
publish_success.cancel();
channel.publish(std::pair<fc::exception_ptr, Type>(trace->except->dynamic_copy_exception(), data));
}
return trace;
} catch (const fc::exception& e) {
publish_success.cancel();
channel.publish(std::pair<fc::exception_ptr, Type>(e.dynamic_copy_exception(), data));
throw e;
} catch( const std::exception& e ) {
publish_success.cancel();
auto fce = fc::exception(
FC_LOG_MESSAGE( info, "Caught std::exception: ${what}", ("what",e.what())),
fc::std_exception_code,
BOOST_CORE_TYPEID(e).name(),
e.what()
);
channel.publish(std::pair<fc::exception_ptr, Type>(fce.dynamic_copy_exception(),data));
throw fce;
} catch( ... ) {
publish_success.cancel();
auto fce = fc::unhandled_exception(
FC_LOG_MESSAGE( info, "Caught unknown exception"),
std::current_exception()
);
channel.publish(std::pair<fc::exception_ptr, Type>(fce.dynamic_copy_exception(), data));
throw fce;
}
};
void on_incoming_block(const signed_block_ptr& block) {
auto id = block->id();
fc_dlog(_log, "received incoming block ${id}", ("id", id));
EOS_ASSERT( block->timestamp < (fc::time_point::now() + fc::seconds( 7 )), block_from_the_future,
"received a block from the future, ignoring it: ${id}", ("id", id) );
chain::controller& chain = chain_plug->chain();
/* de-dupe here... no point in aborting block if we already know the block */
auto existing = chain.fetch_block_by_id( id );
if( existing ) { return; }
// start processing of block
auto bsf = chain.create_block_state_future( block );
// abort the pending block
chain.abort_block();
// exceptions throw out, make sure we restart our loop
auto ensure = fc::make_scoped_exit([this](){
schedule_production_loop();
});
// push the new block
bool except = false;
try {
chain.push_block( bsf );
} catch ( const guard_exception& e ) {
chain_plug->handle_guard_exception(e);
return;
} catch( const fc::exception& e ) {
elog((e.to_detail_string()));
except = true;
} catch ( boost::interprocess::bad_alloc& ) {
chain_plugin::handle_db_exhaustion();
return;
}
if( except ) {
app().get_channel<channels::rejected_block>().publish( priority::medium, block );
return;
}
if( chain.head_block_state()->header.timestamp.next().to_time_point() >= fc::time_point::now() ) {
_production_enabled = true;
}
if( fc::time_point::now() - block->timestamp < fc::minutes(5) || (block->block_num() % 1000 == 0) ) {
ilog("Received block ${id}... #${n} @ ${t} signed by ${p} [trxs: ${count}, lib: ${lib}, conf: ${confs}, latency: ${latency} ms]",
("p",block->producer)("id",fc::variant(block->id()).as_string().substr(8,16))
("n",block_header::num_from_id(block->id()))("t",block->timestamp)
("count",block->transactions.size())("lib",chain.last_irreversible_block_num())("confs", block->confirmed)("latency", (fc::time_point::now() - block->timestamp).count()/1000 ) );
}
}
std::deque<std::tuple<transaction_metadata_ptr, bool, next_function<transaction_trace_ptr>>> _pending_incoming_transactions;
void on_incoming_transaction_async(const transaction_metadata_ptr& trx, bool persist_until_expired, next_function<transaction_trace_ptr> next) {
chain::controller& chain = chain_plug->chain();
const auto& cfg = chain.get_global_properties().configuration;
signing_keys_future_type future = transaction_metadata::start_recover_keys( trx, *_thread_pool,
chain.get_chain_id(), fc::microseconds( cfg.max_transaction_cpu_usage ) );
boost::asio::post( *_thread_pool, [self = this, future, trx, persist_until_expired, next]() {
if( future.valid() )
future.wait();
app().post(priority::low, [self, trx, persist_until_expired, next]() {
self->process_incoming_transaction_async( trx, persist_until_expired, next );
});
});
}
void process_incoming_transaction_async(const transaction_metadata_ptr& trx, bool persist_until_expired, next_function<transaction_trace_ptr> next) {
chain::controller& chain = chain_plug->chain();
if (!chain.pending_block_state()) {
_pending_incoming_transactions.emplace_back(trx, persist_until_expired, next);
return;
}
auto block_time = chain.pending_block_state()->header.timestamp.to_time_point();
auto send_response = [this, &trx, &chain, &next](const fc::static_variant<fc::exception_ptr, transaction_trace_ptr>& response) {
next(response);
if (response.contains<fc::exception_ptr>()) {
_transaction_ack_channel.publish(priority::low, std::pair<fc::exception_ptr, transaction_metadata_ptr>(response.get<fc::exception_ptr>(), trx));
if (_pending_block_mode == pending_block_mode::producing) {
fc_dlog(_trx_trace_log, "[TRX_TRACE] Block ${block_num} for producer ${prod} is REJECTING tx: ${txid} : ${why} ",
("block_num", chain.head_block_num() + 1)
("prod", chain.pending_block_state()->header.producer)
("txid", trx->id)
("why",response.get<fc::exception_ptr>()->what()));
} else {
fc_dlog(_trx_trace_log, "[TRX_TRACE] Speculative execution is REJECTING tx: ${txid} : ${why} ",
("txid", trx->id)
("why",response.get<fc::exception_ptr>()->what()));
}
} else {
_transaction_ack_channel.publish(priority::low, std::pair<fc::exception_ptr, transaction_metadata_ptr>(nullptr, trx));
if (_pending_block_mode == pending_block_mode::producing) {
fc_dlog(_trx_trace_log, "[TRX_TRACE] Block ${block_num} for producer ${prod} is ACCEPTING tx: ${txid}",
("block_num", chain.head_block_num() + 1)
("prod", chain.pending_block_state()->header.producer)
("txid", trx->id));
} else {
fc_dlog(_trx_trace_log, "[TRX_TRACE] Speculative execution is ACCEPTING tx: ${txid}",
("txid", trx->id));
}
}
};
const auto& id = trx->id;
if( fc::time_point(trx->packed_trx->expiration()) < block_time ) {
send_response(std::static_pointer_cast<fc::exception>(std::make_shared<expired_tx_exception>(FC_LOG_MESSAGE(error, "expired transaction ${id}", ("id", id)) )));
return;
}
if( chain.is_known_unexpired_transaction(id) ) {
send_response(std::static_pointer_cast<fc::exception>(std::make_shared<tx_duplicate>(FC_LOG_MESSAGE(error, "duplicate transaction ${id}", ("id", id)) )));
return;
}
auto deadline = fc::time_point::now() + fc::milliseconds(_max_transaction_time_ms);
bool deadline_is_subjective = false;
const auto block_deadline = calculate_block_deadline(block_time);
if (_max_transaction_time_ms < 0 || (_pending_block_mode == pending_block_mode::producing && block_deadline < deadline) ) {
deadline_is_subjective = true;
deadline = block_deadline;
}
try {
auto trace = chain.push_transaction(trx, deadline);
if (trace->except) {
if (failure_is_subjective(*trace->except, deadline_is_subjective)) {
_pending_incoming_transactions.emplace_back(trx, persist_until_expired, next);
if (_pending_block_mode == pending_block_mode::producing) {
fc_dlog(_trx_trace_log, "[TRX_TRACE] Block ${block_num} for producer ${prod} COULD NOT FIT, tx: ${txid} RETRYING ",
("block_num", chain.head_block_num() + 1)
("prod", chain.pending_block_state()->header.producer)
("txid", trx->id));
} else {
fc_dlog(_trx_trace_log, "[TRX_TRACE] Speculative execution COULD NOT FIT tx: ${txid} RETRYING",
("txid", trx->id));
}
} else {
auto e_ptr = trace->except->dynamic_copy_exception();
send_response(e_ptr);
}
} else {
if (persist_until_expired) {
// if this trx didnt fail/soft-fail and the persist flag is set, store its ID so that we can
// ensure its applied to all future speculative blocks as well.
_persistent_transactions.insert(transaction_id_with_expiry{trx->id, trx->packed_trx->expiration()});
}
send_response(trace);
}
} catch ( const guard_exception& e ) {
chain_plug->handle_guard_exception(e);
} catch ( boost::interprocess::bad_alloc& ) {
chain_plugin::handle_db_exhaustion();
} CATCH_AND_CALL(send_response);
}
fc::microseconds get_irreversible_block_age() {
auto now = fc::time_point::now();
if (now < _irreversible_block_time) {
return fc::microseconds(0);
} else {
return now - _irreversible_block_time;
}
}
bool production_disabled_by_policy() {
return !_production_enabled || _pause_production || (_max_irreversible_block_age_us.count() >= 0 && get_irreversible_block_age() >= _max_irreversible_block_age_us);
}
enum class start_block_result {
succeeded,
failed,
waiting,
exhausted
};
start_block_result start_block();
fc::time_point calculate_pending_block_time() const;
fc::time_point calculate_block_deadline( const fc::time_point& ) const;
void schedule_delayed_production_loop(const std::weak_ptr<producer_plugin_impl>& weak_this, const block_timestamp_type& current_block_time);
};
void new_chain_banner(const eosio::chain::controller& db)
{
std::cerr << "\n"
"*******************************\n"
"* *\n"
"* ------ NEW CHAIN ------ *\n"
"* - Welcome to EOSIO! - *\n"
"* ----------------------- *\n"
"* *\n"
"*******************************\n"
"\n";
if( db.head_block_state()->header.timestamp.to_time_point() < (fc::time_point::now() - fc::milliseconds(200 * config::block_interval_ms)))
{
std::cerr << "Your genesis seems to have an old timestamp\n"
"Please consider using the --genesis-timestamp option to give your genesis a recent timestamp\n"
"\n"
;
}
return;
}
producer_plugin::producer_plugin()
: my(new producer_plugin_impl(app().get_io_service())){
my->_self = this;
}
producer_plugin::~producer_plugin() {}
void producer_plugin::set_program_options(
boost::program_options::options_description& command_line_options,
boost::program_options::options_description& config_file_options)
{
auto default_priv_key = private_key_type::regenerate<fc::ecc::private_key_shim>(fc::sha256::hash(std::string("nathan")));
auto private_key_default = std::make_pair(default_priv_key.get_public_key(), default_priv_key );
boost::program_options::options_description producer_options;
producer_options.add_options()
("enable-stale-production,e", boost::program_options::bool_switch()->notifier([this](bool e){my->_production_enabled = e;}), "Enable block production, even if the chain is stale.")
("pause-on-startup,x", boost::program_options::bool_switch()->notifier([this](bool p){my->_pause_production = p;}), "Start this node in a state where production is paused")
("max-transaction-time", bpo::value<int32_t>()->default_value(30),
"Limits the maximum time (in milliseconds) that is allowed a pushed transaction's code to execute before being considered invalid")
("max-irreversible-block-age", bpo::value<int32_t>()->default_value( -1 ),
"Limits the maximum age (in seconds) of the DPOS Irreversible Block for a chain this node will produce blocks on (use negative value to indicate unlimited)")
("producer-name,p", boost::program_options::value<vector<string>>()->composing()->multitoken(),
"ID of producer controlled by this node (e.g. inita; may specify multiple times)")
("private-key", boost::program_options::value<vector<string>>()->composing()->multitoken(),
"(DEPRECATED - Use signature-provider instead) Tuple of [public key, WIF private key] (may specify multiple times)")
("signature-provider", boost::program_options::value<vector<string>>()->composing()->multitoken()->default_value({std::string(default_priv_key.get_public_key()) + "=KEY:" + std::string(default_priv_key)}, std::string(default_priv_key.get_public_key()) + "=KEY:" + std::string(default_priv_key)),
"Key=Value pairs in the form <public-key>=<provider-spec>\n"
"Where:\n"
" <public-key> \tis a string form of a vaild EOSIO public key\n\n"
" <provider-spec> \tis a string in the form <provider-type>:<data>\n\n"
" <provider-type> \tis KEY, or KEOSD\n\n"
" KEY:<data> \tis a string form of a valid EOSIO private key which maps to the provided public key\n\n"
" KEOSD:<data> \tis the URL where keosd is available and the approptiate wallet(s) are unlocked")
("keosd-provider-timeout", boost::program_options::value<int32_t>()->default_value(5),
"Limits the maximum time (in milliseconds) that is allowed for sending blocks to a keosd provider for signing")
("greylist-account", boost::program_options::value<vector<string>>()->composing()->multitoken(),
"account that can not access to extended CPU/NET virtual resources")
("produce-time-offset-us", boost::program_options::value<int32_t>()->default_value(0),
"offset of non last block producing time in microseconds. Negative number results in blocks to go out sooner, and positive number results in blocks to go out later")
("last-block-time-offset-us", boost::program_options::value<int32_t>()->default_value(0),
"offset of last block producing time in microseconds. Negative number results in blocks to go out sooner, and positive number results in blocks to go out later")
("max-scheduled-transaction-time-per-block-ms", boost::program_options::value<int32_t>()->default_value(100),
"Maximum wall-clock time, in milliseconds, spent retiring scheduled transactions in any block before returning to normal transaction processing.")
("incoming-defer-ratio", bpo::value<double>()->default_value(1.0),
"ratio between incoming transations and deferred transactions when both are exhausted")
("producer-threads", bpo::value<uint16_t>()->default_value(config::default_controller_thread_pool_size),
"Number of worker threads in producer thread pool")
("snapshots-dir", bpo::value<bfs::path>()->default_value("snapshots"),
"the location of the snapshots directory (absolute path or relative to application data dir)")
;
config_file_options.add(producer_options);
}
bool producer_plugin::is_producer_key(const chain::public_key_type& key) const
{
auto private_key_itr = my->_signature_providers.find(key);
if(private_key_itr != my->_signature_providers.end())
return true;
return false;
}
chain::signature_type producer_plugin::sign_compact(const chain::public_key_type& key, const fc::sha256& digest) const
{
if(key != chain::public_key_type()) {
auto private_key_itr = my->_signature_providers.find(key);
EOS_ASSERT(private_key_itr != my->_signature_providers.end(), producer_priv_key_not_found, "Local producer has no private key in config.ini corresponding to public key ${key}", ("key", key));
return private_key_itr->second(digest);
}
else {
return chain::signature_type();
}
}
template<typename T>
T dejsonify(const string& s) {
return fc::json::from_string(s).as<T>();
}
#define LOAD_VALUE_SET(options, name, container, type) \
if( options.count(name) ) { \
const std::vector<std::string>& ops = options[name].as<std::vector<std::string>>(); \
std::copy(ops.begin(), ops.end(), std::inserter(container, container.end())); \
}
static producer_plugin_impl::signature_provider_type
make_key_signature_provider(const private_key_type& key) {
return [key]( const chain::digest_type& digest ) {
return key.sign(digest);
};
}
static producer_plugin_impl::signature_provider_type
make_keosd_signature_provider(const std::shared_ptr<producer_plugin_impl>& impl, const string& url_str, const public_key_type pubkey) {
fc::url keosd_url;
if(boost::algorithm::starts_with(url_str, "unix://"))
//send the entire string after unix:// to http_plugin. It'll auto-detect which part
// is the unix socket path, and which part is the url to hit on the server
keosd_url = fc::url("unix", url_str.substr(7), ostring(), ostring(), ostring(), ostring(), ovariant_object(), fc::optional<uint16_t>());
else
keosd_url = fc::url(url_str);
std::weak_ptr<producer_plugin_impl> weak_impl = impl;
return [weak_impl, keosd_url, pubkey]( const chain::digest_type& digest ) {
auto impl = weak_impl.lock();
if (impl) {
fc::variant params;
fc::to_variant(std::make_pair(digest, pubkey), params);
auto deadline = impl->_keosd_provider_timeout_us.count() >= 0 ? fc::time_point::now() + impl->_keosd_provider_timeout_us : fc::time_point::maximum();
return app().get_plugin<http_client_plugin>().get_client().post_sync(keosd_url, params, deadline).as<chain::signature_type>();
} else {
return signature_type();
}
};
}
void producer_plugin::plugin_initialize(const boost::program_options::variables_map& options)
{ try {
my->chain_plug = app().find_plugin<chain_plugin>();
EOS_ASSERT( my->chain_plug, plugin_config_exception, "chain_plugin not found" );
my->_options = &options;
LOAD_VALUE_SET(options, "producer-name", my->_producers, types::account_name)
if( options.count("private-key") )
{
const std::vector<std::string> key_id_to_wif_pair_strings = options["private-key"].as<std::vector<std::string>>();
for (const std::string& key_id_to_wif_pair_string : key_id_to_wif_pair_strings)
{
try {
auto key_id_to_wif_pair = dejsonify<std::pair<public_key_type, private_key_type>>(key_id_to_wif_pair_string);
my->_signature_providers[key_id_to_wif_pair.first] = make_key_signature_provider(key_id_to_wif_pair.second);
auto blanked_privkey = std::string(std::string(key_id_to_wif_pair.second).size(), '*' );
wlog("\"private-key\" is DEPRECATED, use \"signature-provider=${pub}=KEY:${priv}\"", ("pub",key_id_to_wif_pair.first)("priv", blanked_privkey));
} catch ( fc::exception& e ) {
elog("Malformed private key pair");
}
}
}
if( options.count("signature-provider") ) {
const std::vector<std::string> key_spec_pairs = options["signature-provider"].as<std::vector<std::string>>();
for (const auto& key_spec_pair : key_spec_pairs) {
try {
auto delim = key_spec_pair.find("=");
EOS_ASSERT(delim != std::string::npos, plugin_config_exception, "Missing \"=\" in the key spec pair");
auto pub_key_str = key_spec_pair.substr(0, delim);
auto spec_str = key_spec_pair.substr(delim + 1);
auto spec_delim = spec_str.find(":");
EOS_ASSERT(spec_delim != std::string::npos, plugin_config_exception, "Missing \":\" in the key spec pair");
auto spec_type_str = spec_str.substr(0, spec_delim);
auto spec_data = spec_str.substr(spec_delim + 1);
auto pubkey = public_key_type(pub_key_str);
if (spec_type_str == "KEY") {
my->_signature_providers[pubkey] = make_key_signature_provider(private_key_type(spec_data));
} else if (spec_type_str == "KEOSD") {
my->_signature_providers[pubkey] = make_keosd_signature_provider(my, spec_data, pubkey);
}
} catch (...) {
elog("Malformed signature provider: \"${val}\", ignoring!", ("val", key_spec_pair));
}
}
}
my->_keosd_provider_timeout_us = fc::milliseconds(options.at("keosd-provider-timeout").as<int32_t>());
my->_produce_time_offset_us = options.at("produce-time-offset-us").as<int32_t>();
my->_last_block_time_offset_us = options.at("last-block-time-offset-us").as<int32_t>();
my->_max_scheduled_transaction_time_per_block_ms = options.at("max-scheduled-transaction-time-per-block-ms").as<int32_t>();
my->_max_transaction_time_ms = options.at("max-transaction-time").as<int32_t>();
my->_max_irreversible_block_age_us = fc::seconds(options.at("max-irreversible-block-age").as<int32_t>());
my->_incoming_defer_ratio = options.at("incoming-defer-ratio").as<double>();
auto thread_pool_size = options.at( "producer-threads" ).as<uint16_t>();
EOS_ASSERT( thread_pool_size > 0, plugin_config_exception,
"producer-threads ${num} must be greater than 0", ("num", thread_pool_size));
my->_thread_pool.emplace( thread_pool_size );
if( options.count( "snapshots-dir" )) {
auto sd = options.at( "snapshots-dir" ).as<bfs::path>();
if( sd.is_relative()) {
my->_snapshots_dir = app().data_dir() / sd;
if (!fc::exists(my->_snapshots_dir)) {
fc::create_directories(my->_snapshots_dir);
}
} else {
my->_snapshots_dir = sd;
}
EOS_ASSERT( fc::is_directory(my->_snapshots_dir), snapshot_directory_not_found_exception,
"No such directory '${dir}'", ("dir", my->_snapshots_dir.generic_string()) );
}
my->_incoming_block_subscription = app().get_channel<incoming::channels::block>().subscribe([this](const signed_block_ptr& block){
try {
my->on_incoming_block(block);
} FC_LOG_AND_DROP();
});
my->_incoming_transaction_subscription = app().get_channel<incoming::channels::transaction>().subscribe([this](const transaction_metadata_ptr& trx){
try {
my->on_incoming_transaction_async(trx, false, [](const auto&){});
} FC_LOG_AND_DROP();
});
my->_incoming_block_sync_provider = app().get_method<incoming::methods::block_sync>().register_provider([this](const signed_block_ptr& block){
my->on_incoming_block(block);
});
my->_incoming_transaction_async_provider = app().get_method<incoming::methods::transaction_async>().register_provider([this](const transaction_metadata_ptr& trx, bool persist_until_expired, next_function<transaction_trace_ptr> next) -> void {
return my->on_incoming_transaction_async(trx, persist_until_expired, next );
});
if (options.count("greylist-account")) {
std::vector<std::string> greylist = options["greylist-account"].as<std::vector<std::string>>();
greylist_params param;
for (auto &a : greylist) {
param.accounts.push_back(account_name(a));
}
add_greylist_accounts(param);
}
} FC_LOG_AND_RETHROW() }
void producer_plugin::plugin_startup()
{ try {
handle_sighup(); // Sets loggers
ilog("producer plugin: plugin_startup() begin");
chain::controller& chain = my->chain_plug->chain();
EOS_ASSERT( my->_producers.empty() || chain.get_read_mode() == chain::db_read_mode::SPECULATIVE, plugin_config_exception,
"node cannot have any producer-name configured because block production is impossible when read_mode is not \"speculative\"" );
EOS_ASSERT( my->_producers.empty() || chain.get_validation_mode() == chain::validation_mode::FULL, plugin_config_exception,
"node cannot have any producer-name configured because block production is not safe when validation_mode is not \"full\"" );
my->_accepted_block_connection.emplace(chain.accepted_block.connect( [this]( const auto& bsp ){ my->on_block( bsp ); } ));
my->_irreversible_block_connection.emplace(chain.irreversible_block.connect( [this]( const auto& bsp ){ my->on_irreversible_block( bsp->block ); } ));
const auto lib_num = chain.last_irreversible_block_num();
const auto lib = chain.fetch_block_by_number(lib_num);
if (lib) {
my->on_irreversible_block(lib);
} else {
my->_irreversible_block_time = fc::time_point::maximum();
}
if (!my->_producers.empty()) {
ilog("Launching block production for ${n} producers at ${time}.", ("n", my->_producers.size())("time",fc::time_point::now()));
if (my->_production_enabled) {
if (chain.head_block_num() == 0) {
new_chain_banner(chain);
}
//_production_skip_flags |= eosio::chain::skip_undo_history_check;
}
}
my->schedule_production_loop();
ilog("producer plugin: plugin_startup() end");
} FC_CAPTURE_AND_RETHROW() }
void producer_plugin::plugin_shutdown() {
try {
my->_timer.cancel();
} catch(fc::exception& e) {
edump((e.to_detail_string()));
}
if( my->_thread_pool ) {
my->_thread_pool->join();
my->_thread_pool->stop();
}
my->_accepted_block_connection.reset();
my->_irreversible_block_connection.reset();
}
void producer_plugin::handle_sighup() {
auto& logger_map = fc::get_logger_map();
if(logger_map.find(logger_name) != logger_map.end()) {
_log = logger_map[logger_name];
}
if( logger_map.find(trx_trace_logger_name) != logger_map.end()) {
_trx_trace_log = logger_map[trx_trace_logger_name];
}
}
void producer_plugin::pause() {
my->_pause_production = true;
}
void producer_plugin::resume() {
my->_pause_production = false;
// it is possible that we are only speculating because of this policy which we have now changed
// re-evaluate that now
//
if (my->_pending_block_mode == pending_block_mode::speculating) {
chain::controller& chain = my->chain_plug->chain();
chain.abort_block();
my->schedule_production_loop();
}
}
bool producer_plugin::paused() const {
return my->_pause_production;
}
void producer_plugin::update_runtime_options(const runtime_options& options) {
bool check_speculating = false;
if (options.max_transaction_time) {
my->_max_transaction_time_ms = *options.max_transaction_time;
}
if (options.max_irreversible_block_age) {
my->_max_irreversible_block_age_us = fc::seconds(*options.max_irreversible_block_age);
check_speculating = true;
}
if (options.produce_time_offset_us) {
my->_produce_time_offset_us = *options.produce_time_offset_us;
}
if (options.last_block_time_offset_us) {
my->_last_block_time_offset_us = *options.last_block_time_offset_us;
}
if (options.max_scheduled_transaction_time_per_block_ms) {
my->_max_scheduled_transaction_time_per_block_ms = *options.max_scheduled_transaction_time_per_block_ms;
}
if (options.incoming_defer_ratio) {
my->_incoming_defer_ratio = *options.incoming_defer_ratio;
}
if (check_speculating && my->_pending_block_mode == pending_block_mode::speculating) {
chain::controller& chain = my->chain_plug->chain();
chain.abort_block();
my->schedule_production_loop();
}
if (options.subjective_cpu_leeway_us) {
chain::controller& chain = my->chain_plug->chain();
chain.set_subjective_cpu_leeway(fc::microseconds(*options.subjective_cpu_leeway_us));
}
}
producer_plugin::runtime_options producer_plugin::get_runtime_options() const {
return {
my->_max_transaction_time_ms,
my->_max_irreversible_block_age_us.count() < 0 ? -1 : my->_max_irreversible_block_age_us.count() / 1'000'000,
my->_produce_time_offset_us,
my->_last_block_time_offset_us,
my->_max_scheduled_transaction_time_per_block_ms
};
}
void producer_plugin::add_greylist_accounts(const greylist_params& params) {
chain::controller& chain = my->chain_plug->chain();
for (auto &acc : params.accounts) {
chain.add_resource_greylist(acc);
}
}
void producer_plugin::remove_greylist_accounts(const greylist_params& params) {
chain::controller& chain = my->chain_plug->chain();
for (auto &acc : params.accounts) {
chain.remove_resource_greylist(acc);
}
}
producer_plugin::greylist_params producer_plugin::get_greylist() const {
chain::controller& chain = my->chain_plug->chain();
greylist_params result;
const auto& list = chain.get_resource_greylist();
result.accounts.reserve(list.size());
for (auto &acc: list) {
result.accounts.push_back(acc);
}
return result;
}
producer_plugin::whitelist_blacklist producer_plugin::get_whitelist_blacklist() const {
chain::controller& chain = my->chain_plug->chain();
return {
chain.get_actor_whitelist(),
chain.get_actor_blacklist(),
chain.get_contract_whitelist(),
chain.get_contract_blacklist(),
chain.get_action_blacklist(),
chain.get_key_blacklist()
};
}
void producer_plugin::set_whitelist_blacklist(const producer_plugin::whitelist_blacklist& params) {
chain::controller& chain = my->chain_plug->chain();
if(params.actor_whitelist.valid()) chain.set_actor_whitelist(*params.actor_whitelist);
if(params.actor_blacklist.valid()) chain.set_actor_blacklist(*params.actor_blacklist);
if(params.contract_whitelist.valid()) chain.set_contract_whitelist(*params.contract_whitelist);
if(params.contract_blacklist.valid()) chain.set_contract_blacklist(*params.contract_blacklist);
if(params.action_blacklist.valid()) chain.set_action_blacklist(*params.action_blacklist);
if(params.key_blacklist.valid()) chain.set_key_blacklist(*params.key_blacklist);
}
producer_plugin::integrity_hash_information producer_plugin::get_integrity_hash() const {
chain::controller& chain = my->chain_plug->chain();
auto reschedule = fc::make_scoped_exit([this](){
my->schedule_production_loop();
});
if (chain.pending_block_state()) {
// abort the pending block
chain.abort_block();
} else {
reschedule.cancel();
}
return {chain.head_block_id(), chain.calculate_integrity_hash()};
}
producer_plugin::snapshot_information producer_plugin::create_snapshot() const {
chain::controller& chain = my->chain_plug->chain();
auto reschedule = fc::make_scoped_exit([this](){
my->schedule_production_loop();
});
if (chain.pending_block_state()) {
// abort the pending block
chain.abort_block();
} else {
reschedule.cancel();
}
auto head_id = chain.head_block_id();
std::string snapshot_path = (my->_snapshots_dir / fc::format_string("snapshot-${id}.bin", fc::mutable_variant_object()("id", head_id))).generic_string();
EOS_ASSERT( !fc::is_regular_file(snapshot_path), snapshot_exists_exception,
"snapshot named ${name} already exists", ("name", snapshot_path));
auto snap_out = std::ofstream(snapshot_path, (std::ios::out | std::ios::binary));
auto writer = std::make_shared<ostream_snapshot_writer>(snap_out);
chain.write_snapshot(writer);
writer->finalize();
snap_out.flush();
snap_out.close();
return {head_id, snapshot_path};
}
optional<fc::time_point> producer_plugin_impl::calculate_next_block_time(const account_name& producer_name, const block_timestamp_type& current_block_time) const {
chain::controller& chain = chain_plug->chain();
const auto& hbs = chain.head_block_state();
const auto& active_schedule = hbs->active_schedule.producers;
// determine if this producer is in the active schedule and if so, where
auto itr = std::find_if(active_schedule.begin(), active_schedule.end(), [&](const auto& asp){ return asp.producer_name == producer_name; });
if (itr == active_schedule.end()) {
// this producer is not in the active producer set
return optional<fc::time_point>();
}
size_t producer_index = itr - active_schedule.begin();
uint32_t minimum_offset = 1; // must at least be the "next" block
// account for a watermark in the future which is disqualifying this producer for now
// this is conservative assuming no blocks are dropped. If blocks are dropped the watermark will
// disqualify this producer for longer but it is assumed they will wake up, determine that they
// are disqualified for longer due to skipped blocks and re-caculate their next block with better
// information then
auto current_watermark_itr = _producer_watermarks.find(producer_name);
if (current_watermark_itr != _producer_watermarks.end()) {
auto watermark = current_watermark_itr->second;
auto block_num = chain.head_block_state()->block_num;
if (chain.pending_block_state()) {
++block_num;
}
if (watermark > block_num) {
// if I have a watermark then I need to wait until after that watermark
minimum_offset = watermark - block_num + 1;