CCF
Loading...
Searching...
No Matches
kv_types.h
Go to the documentation of this file.
1// Copyright (c) Microsoft Corporation. All rights reserved.
2// Licensed under the Apache 2.0 License.
3#pragma once
4
5#include "ccf/claims_digest.h"
7#include "ccf/crypto/pem.h"
8#include "ccf/ds/nonstd.h"
9#include "ccf/entity_id.h"
10#include "ccf/kv/get_name.h"
11#include "ccf/kv/hooks.h"
12#include "ccf/kv/version.h"
13#include "ccf/tx_id.h"
17#include "serialiser_declare.h"
18
19#include <array>
20#include <chrono>
21#include <functional>
22#include <limits>
23#include <list>
24#include <memory>
25#include <set>
26#include <string>
27#include <unordered_set>
28#include <vector>
29
30namespace ccf
31{
32 struct PrimarySignature;
33}
34
35namespace aft
36{
37 struct Request;
38}
39
40namespace ccf::kv
41{
42 // Term describes an epoch of Versions. It is incremented when global kv's
43 // writer(s) changes. Term and Version combined give a unique identifier for
44 // all accepted kv modifications. Terms are handled by Consensus via the
45 // TermHistory
46 using Term = uint64_t;
48
49 struct TxID
50 {
53
54 TxID() = default;
55 TxID(Term t, Version v) : term(t), version(v) {}
56
57 // Would like to remove these duplicate types, but for now we just do free
58 // conversion
59 TxID(const ccf::TxID& other) : term(other.view), version(other.seqno) {}
60
61 operator ccf::TxID() const
62 {
63 return {term, version};
64 }
65
66 bool operator==(const TxID& other) const
67 {
68 return term == other.term && version == other.version;
69 }
70
71 std::string str() const
72 {
73 return fmt::format("{}.{}", term, version);
74 }
75 };
78
79 using ReconfigurationId = uint64_t;
80
82 {
83 struct NodeInfo
84 {
85 std::string hostname;
86 std::string port;
87
88 NodeInfo() = default;
89
90 NodeInfo(const std::string& hostname_, const std::string& port_) :
91 hostname(hostname_),
92 port(port_)
93 {}
94
95 bool operator==(const NodeInfo& other) const
96 {
97 return hostname == other.hostname && port == other.port;
98 }
99 };
100
101 using Nodes = std::map<NodeId, NodeInfo>;
102
106 };
107
108 inline void to_json(nlohmann::json& j, const Configuration::NodeInfo& ni)
109 {
110 j["address"] = fmt::format("{}:{}", ni.hostname, ni.port);
111 }
112
113 inline void from_json(const nlohmann::json& j, Configuration::NodeInfo& ni)
114 {
115 const std::string addr(j["address"]);
116 const auto& [h, p] = ccf::nonstd::split_1(addr, ":");
117 ni.hostname = h;
118 ni.port = p;
119 }
120
121 inline std::string schema_name(const Configuration::NodeInfo*)
122 {
123 return "Configuration__NodeInfo";
124 }
125
126 inline void fill_json_schema(
127 nlohmann::json& schema, const Configuration::NodeInfo*)
128 {
129 schema["type"] = "object";
130 schema["required"] = nlohmann::json::array();
131 schema["required"].push_back("address");
132 schema["properties"] = nlohmann::json::object();
133 schema["properties"]["address"] = nlohmann::json::object();
134 schema["properties"]["address"]["$ref"] = "#/components/schemas/string";
135 }
136
138 {
139 None,
140 Leader,
141 Follower,
142 Candidate,
143 };
144
147 {{LeadershipState::None, "None"},
148 {LeadershipState::Leader, "Leader"},
149 {LeadershipState::Follower, "Follower"},
150 {LeadershipState::Candidate, "Candidate"}});
151
153 {
154 Active,
155 Retired
156 };
157
160 {{MembershipState::Active, "Active"},
161 {MembershipState::Retired, "Retired"}});
162
164 {
165 Ordered = 1,
166 Signed = 2,
167 Completed = 3,
169 };
170
173 {{RetirementPhase::Ordered, "Ordered"},
174 {RetirementPhase::Signed, "Signed"},
175 {RetirementPhase::Completed, "Completed"},
176 {RetirementPhase::RetiredCommitted, "RetiredCommitted"}});
177
180
182 {
183 struct Ack
184 {
187 };
188
189 std::vector<Configuration> configs = {};
190 std::unordered_map<ccf::NodeId, Ack> acks = {};
192 std::optional<LeadershipState> leadership_state = std::nullopt;
193 std::optional<RetirementPhase> retirement_phase = std::nullopt;
194 std::optional<std::unordered_map<ccf::NodeId, ccf::SeqNo>> learners =
195 std::nullopt;
196 std::optional<ReconfigurationType> reconfiguration_type = std::nullopt;
197 std::optional<ccf::NodeId> primary_id = std::nullopt;
199 bool ticking = false;
200 };
201
204
208 configs,
209 acks,
210 membership_state,
211 primary_id,
212 current_view,
213 ticking);
216 reconfiguration_type,
217 learners,
218 leadership_state,
219 retirement_phase);
220
225
227 {
228 public:
229 virtual void add_configuration(
231 const Configuration::Nodes& conf,
232 const std::unordered_set<NodeId>& learners = {},
233 const std::unordered_set<NodeId>& retired_nodes = {}) = 0;
237 };
238
239 using BatchVector = std::vector<std::tuple<
240 Version,
241 std::shared_ptr<std::vector<uint8_t>>,
242 bool,
243 std::shared_ptr<ConsensusHookPtrs>>>;
244
251
253 {
254 PUBLIC, // Public domain indicates the version and always appears first
257 };
258
265
275
276 static bool has_claims(const EntryType& et)
277 {
278 return et == EntryType::WriteSetWithClaims ||
280 }
281
282 static bool has_commit_evidence(const EntryType& et)
283 {
286 }
287
288 // EntryType must be backwards compatible with the older
289 // bool is_snapshot field
290 static_assert(sizeof(EntryType) == sizeof(bool));
291
292 constexpr auto public_domain_prefix = "public:";
293
294 static inline SecurityDomain get_security_domain(const std::string& name)
295 {
296 if (name.starts_with(public_domain_prefix))
297 {
299 }
300
302 }
303
304 static inline std::pair<SecurityDomain, AccessCategory> parse_map_name(
305 std::string_view name)
306 {
307 constexpr auto internal_category_prefix = "ccf.internal.";
308 constexpr auto governance_category_prefix = "ccf.gov.";
309 constexpr auto reserved_category_prefix = "ccf.";
310
311 auto security_domain = SecurityDomain::PRIVATE;
312 if (name.starts_with(public_domain_prefix))
313 {
314 name.remove_prefix(strlen(public_domain_prefix));
315 security_domain = SecurityDomain::PUBLIC;
316 }
317
318 auto access_category = AccessCategory::APPLICATION;
319 if (name.starts_with(internal_category_prefix))
320 {
321 access_category = AccessCategory::INTERNAL;
322 }
323 else if (name.starts_with(governance_category_prefix))
324 {
325 access_category = AccessCategory::GOVERNANCE;
326 }
327 else if (name.starts_with(reserved_category_prefix))
328 {
329 throw std::logic_error(fmt::format(
330 "Map name '{}' includes disallowed reserved prefix '{}'",
331 name,
332 reserved_category_prefix));
333 }
334
335 return {security_domain, access_category};
336 }
337
350
351 class KvSerialiserException : public std::exception
352 {
353 private:
354 std::string msg;
355
356 public:
357 KvSerialiserException(const std::string& msg_) : msg(msg_) {}
358
359 virtual const char* what() const throw()
360 {
361 return msg.c_str();
362 }
363 };
364
366 {
367 public:
368 using RequestID = std::tuple<
369 size_t /* Client Session ID */,
370 size_t /* Request sequence number */>;
371
373 {
375 std::vector<uint8_t> request;
376 std::vector<uint8_t> caller_cert;
378 };
379
386
388 {
390 std::vector<uint8_t> response;
391 };
392
393 enum class Result
394 {
395 FAIL = 0,
396 OK,
399 };
400
401 virtual ~TxHistory() {}
402 virtual bool verify_root_signatures(bool has_cose) = 0;
403 virtual void try_emit_signature() = 0;
404 virtual void emit_signature() = 0;
406 virtual std::tuple<
407 ccf::kv::TxID /* TxID of last transaction seen by history */,
408 ccf::crypto::Sha256Hash /* root as of TxID */,
409 ccf::kv::Term /* term_of_next_version */>
411 virtual std::vector<uint8_t> get_proof(Version v) = 0;
412 virtual bool verify_proof(const std::vector<uint8_t>& proof) = 0;
413 virtual bool init_from_snapshot(
414 const std::vector<uint8_t>& hash_at_snapshot) = 0;
415 virtual std::vector<uint8_t> get_raw_leaf(uint64_t index) = 0;
416 virtual void append(const std::vector<uint8_t>& data) = 0;
417 virtual void append_entry(
418 const ccf::crypto::Sha256Hash& digest,
419 std::optional<ccf::kv::Term> expected_term = std::nullopt) = 0;
420 virtual void rollback(
421 const ccf::kv::TxID& tx_id, ccf::kv::Term term_of_next_version_) = 0;
422 virtual void compact(Version v) = 0;
423 virtual void set_term(ccf::kv::Term) = 0;
424 virtual std::vector<uint8_t> serialise_tree(size_t to) = 0;
425 virtual void set_endorsed_certificate(const ccf::crypto::Pem& cert) = 0;
426 virtual void start_signature_emit_timer() = 0;
427 };
428
430 {
431 public:
432 virtual ~Consensus() {}
433
434 virtual NodeId id() = 0;
435 virtual bool is_primary() = 0;
436 virtual bool is_backup() = 0;
437 virtual bool is_candidate() = 0;
438 virtual bool can_replicate() = 0;
439 virtual bool is_at_max_capacity() = 0;
440
442 {
444 CAN_SIGN,
446 };
448
449 virtual void force_become_primary() = 0;
451 ccf::SeqNo, ccf::View, const std::vector<ccf::SeqNo>&, ccf::SeqNo) = 0;
452 virtual void init_as_backup(
453 ccf::SeqNo, ccf::View, const std::vector<ccf::SeqNo>&, ccf::SeqNo) = 0;
454
455 virtual bool replicate(const BatchVector& entries, ccf::View view) = 0;
456 virtual std::pair<ccf::View, ccf::SeqNo> get_committed_txid() = 0;
457
459 virtual ccf::View get_view() = 0;
460 virtual std::vector<ccf::SeqNo> get_view_history(
461 ccf::SeqNo seqno = std::numeric_limits<ccf::SeqNo>::max()) = 0;
462 virtual std::vector<ccf::SeqNo> get_view_history_since(
463 ccf::SeqNo seqno) = 0;
465 virtual std::optional<NodeId> primary() = 0;
466
467 virtual void recv_message(
468 const NodeId& from, const uint8_t* data, size_t size) = 0;
469
470 virtual void periodic(std::chrono::milliseconds) {}
471 virtual void periodic_end() {}
472
473 virtual void enable_all_domains() {}
474
476 ccf::SeqNo, const std::vector<NodeId>& node_ids)
477 {}
478 };
479
481 {
483 std::vector<uint8_t> data;
486 std::vector<ConsensusHookPtr> hooks;
487
489 CommitResult success_,
490 std::vector<uint8_t>&& data_,
491 ccf::ClaimsDigest&& claims_digest_,
492 ccf::crypto::Sha256Hash&& commit_evidence_digest_,
493 std::vector<ConsensusHookPtr>&& hooks_) :
494 success(success_),
495 data(std::move(data_)),
496 claims_digest(claims_digest_),
497 commit_evidence_digest(commit_evidence_digest_),
498 hooks(std::move(hooks_))
499 {}
500 };
501
503 {
504 public:
505 virtual PendingTxInfo call() = 0;
506 virtual ~PendingTx() = default;
507 };
508
510 {
511 private:
512 std::vector<uint8_t> data;
513 ccf::ClaimsDigest claims_digest;
514 ccf::crypto::Sha256Hash commit_evidence_digest;
515 ConsensusHookPtrs hooks;
516
517 public:
519 std::vector<uint8_t>&& data_,
520 ccf::ClaimsDigest&& claims_digest_,
521 ccf::crypto::Sha256Hash&& commit_evidence_digest_,
522 ConsensusHookPtrs&& hooks_) :
523 data(std::move(data_)),
524 claims_digest(std::move(claims_digest_)),
525 commit_evidence_digest(std::move(commit_evidence_digest_)),
526 hooks(std::move(hooks_))
527 {}
528
530 {
531 return PendingTxInfo(
533 std::move(data),
534 std::move(claims_digest),
535 std::move(commit_evidence_digest),
536 std::move(hooks));
537 }
538 };
539
541 {
542 public:
544
545 virtual bool encrypt(
546 const std::vector<uint8_t>& plain,
547 const std::vector<uint8_t>& additional_data,
548 std::vector<uint8_t>& serialised_header,
549 std::vector<uint8_t>& cipher,
550 const TxID& tx_id,
551 EntryType entry_type = EntryType::WriteSet,
552 bool historical_hint = false) = 0;
553 virtual bool decrypt(
554 const std::vector<uint8_t>& cipher,
555 const std::vector<uint8_t>& additional_data,
556 const std::vector<uint8_t>& serialised_header,
557 std::vector<uint8_t>& plain,
558 Version version,
559 Term& term,
560 bool historical_hint = false) = 0;
561
562 virtual void rollback(Version version) = 0;
563
564 virtual size_t get_header_length() = 0;
565 virtual uint64_t get_term(const uint8_t* data, size_t size) = 0;
566
568 const TxID& tx_id, bool historical_hint = false) = 0;
569 };
570 using EncryptorPtr = std::shared_ptr<AbstractTxEncryptor>;
571
573 {
574 public:
576
578 virtual void commit(ccf::kv::Version v, bool generate_snapshot) = 0;
579 virtual void rollback(ccf::kv::Version v) = 0;
580 };
581 using SnapshotterPtr = std::shared_ptr<AbstractSnapshotter>;
582
584 {
585 public:
586 virtual ~AbstractChangeSet() = default;
587
588 virtual bool has_writes() const = 0;
589 };
590
592 {
593 public:
594 virtual ~AbstractCommitter() = default;
595
596 virtual bool has_writes() = 0;
597 virtual bool prepare(bool track_commits) = 0;
598 virtual void commit(
599 Version v,
600 bool track_read_versions,
601 bool track_deletes_on_missing_keys) = 0;
603 };
604
605 class AbstractStore;
606 class AbstractMap : public std::enable_shared_from_this<AbstractMap>,
607 public GetName
608 {
609 public:
611 {
612 public:
613 virtual ~Snapshot() = default;
614 virtual void serialise(KvStoreSerialiser& s) = 0;
616 };
617
618 using GetName::GetName;
619 virtual ~AbstractMap() {}
620
621 virtual std::unique_ptr<AbstractCommitter> create_committer(
622 AbstractChangeSet* changes) = 0;
623
624 virtual AbstractStore* get_store() = 0;
625 virtual void serialise_changes(
626 const AbstractChangeSet* changes,
628 bool include_reads) = 0;
629 virtual void compact(Version v) = 0;
630 virtual std::unique_ptr<Snapshot> snapshot(Version v) = 0;
631 virtual void post_compact() = 0;
632 virtual void rollback(Version v) = 0;
633 virtual void lock() = 0;
634 virtual void unlock() = 0;
636 virtual void clear() = 0;
637
638 virtual AbstractMap* clone(AbstractStore* store) = 0;
639 virtual void swap(AbstractMap* map) = 0;
640 };
641
642 class Tx;
643
645 {
646 public:
647 virtual ~AbstractExecutionWrapper() = default;
649 bool track_deletes_on_missing_keys = false) = 0;
651 virtual const std::vector<uint8_t>& get_entry() = 0;
652 virtual ccf::kv::Term get_term() = 0;
654 virtual bool support_async_execution() = 0;
655 virtual bool is_public_only() = 0;
657 virtual std::optional<ccf::crypto::Sha256Hash>&&
659
660 // Setting a short rollback is a work around that should be fixed
661 // shortly. In BFT mode when we deserialize and realize we need to
662 // create a new map we remember this. If we need to create the same
663 // map multiple times (for tx in the same group of append entries) the
664 // first create successes but the second fails because the map is
665 // already there. This works around the problem by stopping just
666 // before the 2nd create (which failed at this point) and when the
667 // primary resends the append entries we will succeed as the map is
668 // already there. This will only occur on BFT startup so not a perf
669 // problem but still need to be resolved.
670 //
671 // Thus, a large rollback is one which did not result from the map creating
672 // issue. https://github.com/microsoft/CCF/issues/2799
674 };
675
677 {
678 public:
680 {
681 public:
682 virtual ~AbstractSnapshot() = default;
683 virtual Version get_version() const = 0;
684 virtual std::vector<uint8_t> serialise(
685 const std::shared_ptr<AbstractTxEncryptor>& encryptor) = 0;
686 };
687
688 virtual ~AbstractStore() {}
689
690 virtual void lock_map_set() = 0;
691 virtual void unlock_map_set() = 0;
692
693 virtual Version next_version() = 0;
694 virtual std::tuple<Version, Version> next_version(bool commit_new_map) = 0;
695 virtual TxID next_txid() = 0;
696
698 virtual TxID current_txid() = 0;
699 virtual std::pair<TxID, Term> current_txid_and_commit_term() = 0;
700
702 virtual Term commit_view() = 0;
703
704 virtual std::shared_ptr<AbstractMap> get_map(
705 Version v, const std::string& map_name) = 0;
706 virtual std::shared_ptr<AbstractMap> get_map_unsafe(
707 Version v, const std::string& map_name) = 0;
708 virtual void add_dynamic_map(
709 Version v, const std::shared_ptr<AbstractMap>& map) = 0;
710
711 virtual std::shared_ptr<Consensus> get_consensus() = 0;
712 virtual std::shared_ptr<TxHistory> get_history() = 0;
714 virtual std::unique_ptr<AbstractExecutionWrapper> deserialize(
715 const std::vector<uint8_t>& data,
716 bool public_only = false,
717 const std::optional<TxID>& expected_txid = std::nullopt) = 0;
718 virtual void compact(Version v) = 0;
719 virtual void rollback(const TxID& tx_id, Term write_term_) = 0;
720 virtual void initialise_term(Term t) = 0;
722 const TxID& txid,
723 std::unique_ptr<PendingTx> pending_tx,
724 bool globally_committable) = 0;
725 virtual bool check_rollback_count(Version count) = 0;
726
727 virtual std::unique_ptr<AbstractSnapshot> snapshot_unsafe_maps(
728 Version v) = 0;
729 virtual void lock_maps() = 0;
730 virtual void unlock_maps() = 0;
731 virtual std::vector<uint8_t> serialise_snapshot(
732 std::unique_ptr<AbstractSnapshot> snapshot) = 0;
734 const uint8_t* data,
735 size_t size,
736 ConsensusHookPtrs& hooks,
737 std::vector<Version>* view_history = nullptr,
738 bool public_only = false) = 0;
739 virtual bool must_force_ledger_chunk(Version version) = 0;
740 virtual bool must_force_ledger_chunk_unsafe(Version version) = 0;
741
742 virtual size_t committable_gap() = 0;
743
744 enum class Flag : uint8_t
745 {
748 };
749
750 virtual void set_flag(Flag f) = 0;
751 virtual void unset_flag(Flag f) = 0;
752 virtual bool flag_enabled(Flag f) = 0;
753 virtual void set_flag_unsafe(Flag f) = 0;
754 virtual void unset_flag_unsafe(Flag f) = 0;
755 virtual bool flag_enabled_unsafe(Flag f) const = 0;
756 };
757
758 template <class StorePointer>
760 {
761 public:
763 ScopedStoreMapsLock(StorePointer _store) : store(_store)
764 {
765 store->lock_maps();
766 }
768 {
769 store->unlock_maps();
770 }
771
772 private:
773 StorePointer store;
774 };
775
776}
777
778FMT_BEGIN_NAMESPACE
779
780template <>
781struct formatter<ccf::kv::Configuration::Nodes>
782{
783 template <typename ParseContext>
784 constexpr auto parse(ParseContext& ctx)
785 {
786 return ctx.begin();
787 }
788
789 template <typename FormatContext>
790 auto format(const ccf::kv::Configuration::Nodes& nodes, FormatContext& ctx)
791 const -> decltype(ctx.out())
792 {
793 std::set<ccf::NodeId> node_ids;
794 for (auto& [nid, _] : nodes)
795 {
796 node_ids.insert(nid);
797 }
798 return format_to(ctx.out(), "{{{}}}", fmt::join(node_ids, " "));
799 }
800};
801
802template <>
803struct formatter<ccf::kv::MembershipState>
804{
805 template <typename ParseContext>
806 constexpr auto parse(ParseContext& ctx)
807 {
808 return ctx.begin();
809 }
810
811 template <typename FormatContext>
812 auto format(const ccf::kv::MembershipState& state, FormatContext& ctx) const
813 -> decltype(ctx.out())
814 {
815 const auto s = nlohmann::json(state).get<std::string>();
816 return format_to(ctx.out(), "{}", s);
817 }
818};
819
820template <>
821struct formatter<ccf::kv::LeadershipState>
822{
823 template <typename ParseContext>
824 constexpr auto parse(ParseContext& ctx)
825 {
826 return ctx.begin();
827 }
828
829 template <typename FormatContext>
830 auto format(const ccf::kv::LeadershipState& state, FormatContext& ctx) const
831 -> decltype(ctx.out())
832 {
833 const auto s = nlohmann::json(state).get<std::string>();
834 return format_to(ctx.out(), "{}", s);
835 }
836};
837
838FMT_END_NAMESPACE
Definition claims_digest.h:10
Definition pem.h:18
Definition sha256_hash.h:16
Definition kv_types.h:584
virtual bool has_writes() const =0
virtual ~AbstractChangeSet()=default
Definition kv_types.h:592
virtual void commit(Version v, bool track_read_versions, bool track_deletes_on_missing_keys)=0
virtual bool prepare(bool track_commits)=0
virtual ConsensusHookPtr post_commit()=0
virtual ~AbstractCommitter()=default
virtual bool has_writes()=0
Definition kv_types.h:645
virtual ccf::kv::ConsensusHookPtrs & get_hooks()=0
virtual ccf::kv::ApplyResult apply(bool track_deletes_on_missing_keys=false)=0
virtual ~AbstractExecutionWrapper()=default
virtual bool should_rollback_to_last_committed()=0
virtual std::optional< ccf::crypto::Sha256Hash > && consume_commit_evidence_digest()=0
virtual const std::vector< uint8_t > & get_entry()=0
virtual ccf::kv::Term get_term()=0
virtual bool support_async_execution()=0
virtual ccf::ClaimsDigest && consume_claims_digest()=0
virtual ccf::kv::Version get_index()=0
Definition kv_types.h:611
virtual void serialise(KvStoreSerialiser &s)=0
virtual SecurityDomain get_security_domain() const =0
Definition kv_types.h:608
virtual void clear()=0
virtual std::unique_ptr< Snapshot > snapshot(Version v)=0
virtual SecurityDomain get_security_domain()=0
virtual AbstractStore * get_store()=0
virtual std::unique_ptr< AbstractCommitter > create_committer(AbstractChangeSet *changes)=0
virtual AbstractMap * clone(AbstractStore *store)=0
virtual void post_compact()=0
virtual void lock()=0
virtual void serialise_changes(const AbstractChangeSet *changes, KvStoreSerialiser &s, bool include_reads)=0
virtual void compact(Version v)=0
virtual void rollback(Version v)=0
virtual void swap(AbstractMap *map)=0
virtual void unlock()=0
virtual ~AbstractMap()
Definition kv_types.h:619
Definition kv_types.h:573
virtual void rollback(ccf::kv::Version v)=0
virtual bool record_committable(ccf::kv::Version v)=0
virtual void commit(ccf::kv::Version v, bool generate_snapshot)=0
virtual ~AbstractSnapshotter()
Definition kv_types.h:575
virtual std::vector< uint8_t > serialise(const std::shared_ptr< AbstractTxEncryptor > &encryptor)=0
virtual Version get_version() const =0
Definition kv_types.h:677
virtual void unset_flag(Flag f)=0
virtual std::unique_ptr< AbstractSnapshot > snapshot_unsafe_maps(Version v)=0
virtual std::shared_ptr< TxHistory > get_history()=0
virtual ~AbstractStore()
Definition kv_types.h:688
virtual std::shared_ptr< AbstractMap > get_map(Version v, const std::string &map_name)=0
virtual EncryptorPtr get_encryptor()=0
virtual void add_dynamic_map(Version v, const std::shared_ptr< AbstractMap > &map)=0
virtual void rollback(const TxID &tx_id, Term write_term_)=0
virtual void compact(Version v)=0
virtual std::shared_ptr< Consensus > get_consensus()=0
virtual void lock_map_set()=0
virtual std::pair< TxID, Term > current_txid_and_commit_term()=0
virtual std::shared_ptr< AbstractMap > get_map_unsafe(Version v, const std::string &map_name)=0
virtual void unset_flag_unsafe(Flag f)=0
virtual CommitResult commit(const TxID &txid, std::unique_ptr< PendingTx > pending_tx, bool globally_committable)=0
virtual void unlock_map_set()=0
virtual size_t committable_gap()=0
virtual TxID next_txid()=0
virtual void lock_maps()=0
virtual Version current_version()=0
virtual bool must_force_ledger_chunk_unsafe(Version version)=0
Flag
Definition kv_types.h:745
virtual Term commit_view()=0
virtual Version next_version()=0
virtual void set_flag(Flag f)=0
virtual bool check_rollback_count(Version count)=0
virtual bool flag_enabled(Flag f)=0
virtual std::vector< uint8_t > serialise_snapshot(std::unique_ptr< AbstractSnapshot > snapshot)=0
virtual bool flag_enabled_unsafe(Flag f) const =0
virtual Version compacted_version()=0
virtual bool must_force_ledger_chunk(Version version)=0
virtual void unlock_maps()=0
virtual void set_flag_unsafe(Flag f)=0
virtual ApplyResult deserialise_snapshot(const uint8_t *data, size_t size, ConsensusHookPtrs &hooks, std::vector< Version > *view_history=nullptr, bool public_only=false)=0
virtual void initialise_term(Term t)=0
virtual TxID current_txid()=0
virtual std::unique_ptr< AbstractExecutionWrapper > deserialize(const std::vector< uint8_t > &data, bool public_only=false, const std::optional< TxID > &expected_txid=std::nullopt)=0
virtual std::tuple< Version, Version > next_version(bool commit_new_map)=0
Definition kv_types.h:541
virtual bool encrypt(const std::vector< uint8_t > &plain, const std::vector< uint8_t > &additional_data, std::vector< uint8_t > &serialised_header, std::vector< uint8_t > &cipher, const TxID &tx_id, EntryType entry_type=EntryType::WriteSet, bool historical_hint=false)=0
virtual bool decrypt(const std::vector< uint8_t > &cipher, const std::vector< uint8_t > &additional_data, const std::vector< uint8_t > &serialised_header, std::vector< uint8_t > &plain, Version version, Term &term, bool historical_hint=false)=0
virtual size_t get_header_length()=0
virtual void rollback(Version version)=0
virtual uint64_t get_term(const uint8_t *data, size_t size)=0
virtual ~AbstractTxEncryptor()
Definition kv_types.h:543
virtual ccf::crypto::HashBytes get_commit_nonce(const TxID &tx_id, bool historical_hint=false)=0
Definition kv_types.h:227
virtual void add_configuration(ccf::SeqNo seqno, const Configuration::Nodes &conf, const std::unordered_set< NodeId > &learners={}, const std::unordered_set< NodeId > &retired_nodes={})=0
virtual ConsensusDetails get_details()=0
virtual Configuration::Nodes get_latest_configuration()=0
virtual Configuration::Nodes get_latest_configuration_unsafe() const =0
Definition kv_types.h:430
virtual void enable_all_domains()
Definition kv_types.h:473
virtual std::pair< ccf::View, ccf::SeqNo > get_committed_txid()=0
virtual bool is_candidate()=0
virtual ccf::SeqNo get_committed_seqno()=0
virtual bool can_replicate()=0
virtual void periodic_end()
Definition kv_types.h:471
SignatureDisposition
Definition kv_types.h:442
virtual void init_as_backup(ccf::SeqNo, ccf::View, const std::vector< ccf::SeqNo > &, ccf::SeqNo)=0
virtual std::vector< ccf::SeqNo > get_view_history(ccf::SeqNo seqno=std::numeric_limits< ccf::SeqNo >::max())=0
virtual void recv_message(const NodeId &from, const uint8_t *data, size_t size)=0
virtual bool is_primary()=0
virtual NodeId id()=0
virtual std::optional< NodeId > primary()=0
virtual void force_become_primary(ccf::SeqNo, ccf::View, const std::vector< ccf::SeqNo > &, ccf::SeqNo)=0
virtual bool replicate(const BatchVector &entries, ccf::View view)=0
virtual void set_retired_committed(ccf::SeqNo, const std::vector< NodeId > &node_ids)
Definition kv_types.h:475
virtual void force_become_primary()=0
virtual bool is_at_max_capacity()=0
virtual SignatureDisposition get_signature_disposition()=0
virtual void periodic(std::chrono::milliseconds)
Definition kv_types.h:470
virtual ccf::View get_view(ccf::SeqNo seqno)=0
virtual ~Consensus()
Definition kv_types.h:432
virtual std::vector< ccf::SeqNo > get_view_history_since(ccf::SeqNo seqno)=0
virtual ccf::View get_view()=0
virtual bool is_backup()=0
Definition generic_serialise_wrapper.h:20
Definition kv_types.h:352
virtual const char * what() const
Definition kv_types.h:359
KvSerialiserException(const std::string &msg_)
Definition kv_types.h:357
Definition kv_types.h:510
MovePendingTx(std::vector< uint8_t > &&data_, ccf::ClaimsDigest &&claims_digest_, ccf::crypto::Sha256Hash &&commit_evidence_digest_, ConsensusHookPtrs &&hooks_)
Definition kv_types.h:518
PendingTxInfo call() override
Definition kv_types.h:529
Definition kv_types.h:503
virtual ~PendingTx()=default
virtual PendingTxInfo call()=0
Definition kv_types.h:760
ScopedStoreMapsLock(StorePointer _store)
Definition kv_types.h:763
~ScopedStoreMapsLock()
Definition kv_types.h:767
Definition kv_types.h:366
virtual void compact(Version v)=0
virtual void set_term(ccf::kv::Term)=0
virtual std::vector< uint8_t > get_proof(Version v)=0
virtual void emit_signature()=0
std::tuple< size_t, size_t > RequestID
Definition kv_types.h:370
virtual bool init_from_snapshot(const std::vector< uint8_t > &hash_at_snapshot)=0
virtual std::vector< uint8_t > serialise_tree(size_t to)=0
virtual bool verify_root_signatures(bool has_cose)=0
virtual std::vector< uint8_t > get_raw_leaf(uint64_t index)=0
virtual void try_emit_signature()=0
virtual void rollback(const ccf::kv::TxID &tx_id, ccf::kv::Term term_of_next_version_)=0
Result
Definition kv_types.h:394
virtual ccf::crypto::Sha256Hash get_replicated_state_root()=0
virtual void append_entry(const ccf::crypto::Sha256Hash &digest, std::optional< ccf::kv::Term > expected_term=std::nullopt)=0
virtual void append(const std::vector< uint8_t > &data)=0
virtual void start_signature_emit_timer()=0
virtual ~TxHistory()
Definition kv_types.h:401
virtual bool verify_proof(const std::vector< uint8_t > &proof)=0
virtual void set_endorsed_certificate(const ccf::crypto::Pem &cert)=0
virtual std::tuple< ccf::kv::TxID, ccf::crypto::Sha256Hash, ccf::kv::Term > get_replicated_state_txid_and_root()=0
Definition tx.h:202
ReconfigurationType
Definition reconfiguration_type.h:6
#define DECLARE_JSON_REQUIRED_FIELDS(TYPE,...)
Definition json.h:712
#define DECLARE_JSON_TYPE(TYPE)
Definition json.h:661
#define DECLARE_JSON_TYPE_WITH_OPTIONAL_FIELDS(TYPE)
Definition json.h:688
#define DECLARE_JSON_OPTIONAL_FIELDS(TYPE,...)
Definition json.h:784
#define DECLARE_JSON_ENUM(TYPE,...)
Definition json.h:835
Definition state.h:18
std::vector< uint8_t > HashBytes
Definition hash_bytes.h:10
Definition app_interface.h:20
std::shared_ptr< AbstractTxEncryptor > EncryptorPtr
Definition kv_types.h:570
RetirementPhase
Definition kv_types.h:164
std::string schema_name(const Configuration::NodeInfo *)
Definition kv_types.h:121
uint64_t Term
Definition kv_types.h:46
SecurityDomain
Definition kv_types.h:253
@ SECURITY_DOMAIN_MAX
Definition kv_types.h:256
@ PRIVATE
Definition kv_types.h:255
@ PUBLIC
Definition kv_types.h:254
std::unique_ptr< ConsensusHook > ConsensusHookPtr
Definition hooks.h:21
EntryType
Definition kv_types.h:267
@ WriteSetWithCommitEvidenceAndClaims
std::vector< std::tuple< Version, std::shared_ptr< std::vector< uint8_t > >, bool, std::shared_ptr< ConsensusHookPtrs > > > BatchVector
Definition kv_types.h:243
uint64_t Version
Definition version.h:8
LeadershipState
Definition kv_types.h:138
CommitResult
Definition kv_types.h:246
@ FAIL_NO_REPLICATE
Definition kv_types.h:249
@ SUCCESS
Definition kv_types.h:247
@ FAIL_CONFLICT
Definition kv_types.h:248
std::shared_ptr< AbstractSnapshotter > SnapshotterPtr
Definition kv_types.h:581
void fill_json_schema(nlohmann::json &schema, const Configuration::NodeInfo *)
Definition kv_types.h:126
uint64_t ReconfigurationId
Definition kv_types.h:79
constexpr auto public_domain_prefix
Definition kv_types.h:292
ApplyResult
Definition kv_types.h:339
@ PASS_NONCES
Definition kv_types.h:344
@ PASS_SIGNATURE
Definition kv_types.h:341
@ PASS_BACKUP_SIGNATURE
Definition kv_types.h:342
@ PASS_BACKUP_SIGNATURE_SEND_ACK
Definition kv_types.h:343
@ FAIL
Definition kv_types.h:348
@ PASS
Definition kv_types.h:340
@ PASS_APPLY
Definition kv_types.h:347
@ PASS_ENCRYPTED_PAST_LEDGER_SECRET
Definition kv_types.h:346
@ PASS_NEW_VIEW
Definition kv_types.h:345
AccessCategory
Definition kv_types.h:260
@ INTERNAL
Definition kv_types.h:261
@ APPLICATION
Definition kv_types.h:263
@ GOVERNANCE
Definition kv_types.h:262
MembershipState
Definition kv_types.h:153
void to_json(nlohmann::json &j, const Configuration::NodeInfo &ni)
Definition kv_types.h:108
std::vector< ConsensusHookPtr > ConsensusHookPtrs
Definition hooks.h:22
void from_json(const nlohmann::json &j, Configuration::NodeInfo &ni)
Definition kv_types.h:113
Definition app_interface.h:15
EntityId< NodeIdFormatter > NodeId
Definition entity_id.h:155
view
Definition signatures.h:54
seqno
Definition signatures.h:54
uint64_t View
Definition tx_id.h:23
uint64_t SeqNo
Definition tx_id.h:36
Definition map_serializers.h:11
STL namespace.
Definition tx_id.h:44
Definition kv_types.h:84
std::string hostname
Definition kv_types.h:85
bool operator==(const NodeInfo &other) const
Definition kv_types.h:95
NodeInfo(const std::string &hostname_, const std::string &port_)
Definition kv_types.h:90
std::string port
Definition kv_types.h:86
Definition kv_types.h:82
ccf::SeqNo idx
Definition kv_types.h:103
std::map< NodeId, NodeInfo > Nodes
Definition kv_types.h:101
ReconfigurationId rid
Definition kv_types.h:105
Nodes nodes
Definition kv_types.h:104
Definition kv_types.h:184
size_t last_received_ms
Definition kv_types.h:186
ccf::SeqNo seqno
Definition kv_types.h:185
Definition kv_types.h:182
bool ticking
Definition kv_types.h:199
std::optional< std::unordered_map< ccf::NodeId, ccf::SeqNo > > learners
Definition kv_types.h:194
std::optional< RetirementPhase > retirement_phase
Definition kv_types.h:193
ccf::View current_view
Definition kv_types.h:198
std::optional< LeadershipState > leadership_state
Definition kv_types.h:192
MembershipState membership_state
Definition kv_types.h:191
std::optional< ReconfigurationType > reconfiguration_type
Definition kv_types.h:196
std::unordered_map< ccf::NodeId, Ack > acks
Definition kv_types.h:190
std::optional< ccf::NodeId > primary_id
Definition kv_types.h:197
std::vector< Configuration > configs
Definition kv_types.h:189
Definition kv_types.h:222
ReconfigurationType reconfiguration_type
Definition kv_types.h:223
Definition get_name.h:10
GetName(const std::string &s)
Definition get_name.h:15
Definition kv_types.h:481
ccf::crypto::Sha256Hash commit_evidence_digest
Definition kv_types.h:485
PendingTxInfo(CommitResult success_, std::vector< uint8_t > &&data_, ccf::ClaimsDigest &&claims_digest_, ccf::crypto::Sha256Hash &&commit_evidence_digest_, std::vector< ConsensusHookPtr > &&hooks_)
Definition kv_types.h:488
std::vector< ConsensusHookPtr > hooks
Definition kv_types.h:486
ccf::ClaimsDigest claims_digest
Definition kv_types.h:484
std::vector< uint8_t > data
Definition kv_types.h:483
CommitResult success
Definition kv_types.h:482
uint8_t frame_format
Definition kv_types.h:377
std::vector< uint8_t > caller_cert
Definition kv_types.h:376
RequestID rid
Definition kv_types.h:374
std::vector< uint8_t > request
Definition kv_types.h:375
RequestID rid
Definition kv_types.h:389
std::vector< uint8_t > response
Definition kv_types.h:390
Version version
Definition kv_types.h:383
RequestID rid
Definition kv_types.h:382
ccf::crypto::Sha256Hash replicated_state_merkle_root
Definition kv_types.h:384
Definition kv_types.h:50
bool operator==(const TxID &other) const
Definition kv_types.h:66
TxID(const ccf::TxID &other)
Definition kv_types.h:59
TxID()=default
std::string str() const
Definition kv_types.h:71
Version version
Definition kv_types.h:52
TxID(Term t, Version v)
Definition kv_types.h:55
Term term
Definition kv_types.h:51
constexpr auto parse(ParseContext &ctx)
Definition kv_types.h:784
auto format(const ccf::kv::Configuration::Nodes &nodes, FormatContext &ctx) const -> decltype(ctx.out())
Definition kv_types.h:790
constexpr auto parse(ParseContext &ctx)
Definition kv_types.h:824
auto format(const ccf::kv::LeadershipState &state, FormatContext &ctx) const -> decltype(ctx.out())
Definition kv_types.h:830
auto format(const ccf::kv::MembershipState &state, FormatContext &ctx) const -> decltype(ctx.out())
Definition kv_types.h:812
constexpr auto parse(ParseContext &ctx)
Definition kv_types.h:806