/
BlockMetadataStore.scala
223 lines (192 loc) · 8.03 KB
/
BlockMetadataStore.scala
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
package coop.rchain.blockstorage.dag
import cats.{Monad, Show}
import cats.effect.Sync
import cats.mtl.MonadState
import cats.syntax.all._
import coop.rchain.casper.PrettyPrinter
import coop.rchain.models.BlockHash.BlockHash
import coop.rchain.models.BlockMetadata
import coop.rchain.shared.syntax._
import coop.rchain.shared.{AtomicMonadState, Log}
import coop.rchain.store.KeyValueTypedStore
import monix.execution.atomic.AtomicAny
import scala.collection.immutable.SortedMap
object BlockMetadataStore {
def apply[F[_]: Sync: Log](
blockMetadataStore: KeyValueTypedStore[F, BlockHash, BlockMetadata]
): F[BlockMetadataStore[F]] =
for {
_ <- Log[F].info("Building in-memory blockMetadataStore.")
// Iterate over block metadata store and collect info for in-memory cache
blockInfoMap <- blockMetadataStore.collect {
case (hash, metaData) =>
(hash, blockMetadataToInfo(metaData()))
}
_ <- Log[F].info("Reading data from blockMetadataStore done.")
dagState = recreateInMemoryState(blockInfoMap.toMap)
_ <- Log[F].info("Successfully built in-memory blockMetadataStore.")
} yield new BlockMetadataStore[F](
blockMetadataStore,
new AtomicMonadState(AtomicAny(dagState))
)
final case class BlockMetadataStoreInconsistencyError(message: String) extends Exception(message)
private final case class DagState(
dagSet: Set[BlockHash],
childMap: Map[BlockHash, Set[BlockHash]],
heightMap: SortedMap[Long, Set[BlockHash]],
// In general - at least genesis should be LFB.
// But dagstate can be empty, as it is initialized before genesis is inserted.
// Also lots of tests do not have genesis properly initialised, so fixing all this is pain.
// So this is Option.
lastFinalizedBlock: Option[(BlockHash, Long)],
finalizedBlockSet: Set[BlockHash]
)
def blockMetadataToInfo(blockMeta: BlockMetadata): BlockInfo =
BlockInfo(
blockMeta.blockHash,
blockMeta.parents.toSet,
blockMeta.blockNum,
blockMeta.invalid,
blockMeta.directlyFinalized,
blockMeta.finalized
)
class BlockMetadataStore[F[_]: Monad](
private val store: KeyValueTypedStore[F, BlockHash, BlockMetadata],
private val dagState: MonadState[F, DagState]
) {
def add(block: BlockMetadata): F[Unit] =
for {
// Update DAG state with new block
_ <- dagState.modify { st =>
val blockInfo = blockMetadataToInfo(block)
val newDagState = addBlockToDagState(blockInfo)(st)
validateDagState(newDagState)
}
// Update persistent block metadata store
_ <- store.put(block.blockHash, block)
} yield ()
/** Record new last finalized lock. Directly finalized is the output of finalizer,
* indirectly finalized are new LFB ancestors. */
def recordFinalized(directly: BlockHash, indirectly: Set[BlockHash])(
implicit sync: Sync[F]
): F[Unit] = {
implicit val s = new Show[BlockHash] {
override def show(t: BlockHash): String = PrettyPrinter.buildString(t)
}
for {
// read current values
curMetaForDF <- store.getUnsafe(directly)
curMetasForIF <- store.getUnsafeBatch(indirectly.toList)
// new values to persist
newMetaForDF = (directly, curMetaForDF.copy(finalized = true, directlyFinalized = true))
newMetasForIF = curMetasForIF.map(v => (v.blockHash, v.copy(finalized = true)))
// update in memory state
_ <- dagState.modify(
st => {
val newFinalizedSet = st.finalizedBlockSet ++ indirectly + directly
// update lastFinalizedBlock only when current one is lower
if (st.lastFinalizedBlock.exists { case (_, h) => h > curMetaForDF.blockNum })
st.copy(finalizedBlockSet = newFinalizedSet)
else
st.copy(
finalizedBlockSet = newFinalizedSet,
lastFinalizedBlock = (directly, curMetaForDF.blockNum).some
)
}
)
// persist new values all at once
_ <- store.put(newMetaForDF +: newMetasForIF)
} yield ()
}
def get(hash: BlockHash): F[Option[BlockMetadata]] = store.get(hash)
def getUnsafe(hash: BlockHash)(
implicit f: Sync[F],
line: sourcecode.Line,
file: sourcecode.File,
enclosing: sourcecode.Enclosing
): F[BlockMetadata] = {
def source = s"${file.value}:${line.value} ${enclosing.value}"
def errMsg =
s"BlockMetadataStore is missing key ${PrettyPrinter.buildString(hash)}\n $source"
get(hash) >>= (_.liftTo(BlockMetadataStoreInconsistencyError(errMsg)))
}
// DAG state operations
def dagSet: F[Set[BlockHash]] = dagState.get.map(_.dagSet)
def contains(hash: BlockHash): F[Boolean] = dagState.get.map(_.dagSet.contains(hash))
def childMapData: F[Map[BlockHash, Set[BlockHash]]] =
dagState.get.map(_.childMap)
def heightMap: F[SortedMap[Long, Set[BlockHash]]] =
dagState.get.map(_.heightMap)
def lastFinalizedBlock(implicit sync: Sync[F]): F[BlockHash] = {
val errMsg =
"DagState does not contain lastFinalizedBlock. Are you calling this on empty BlockDagStorage? Otherwise there is a bug."
dagState.get.flatMap(_.lastFinalizedBlock.liftTo[F](new Exception(errMsg)).map {
case (hash, _) => hash
})
}
def finalizedBlockSet: F[Set[BlockHash]] = dagState.get.map(_.finalizedBlockSet)
}
private def addBlockToDagState(block: BlockInfo)(state: DagState): DagState = {
// Update dag set / all blocks in the DAG
val newDagSet = state.dagSet + block.hash
// Update children relation map
val blockChilds = block.parents.map((_, Set(block.hash))) + ((block.hash, Set()))
val newChildMap = blockChilds.foldLeft(state.childMap) {
case (acc, (key, newChildren)) =>
val currChildren = acc.getOrElse(key, Set.empty[BlockHash])
acc.updated(key, currChildren ++ newChildren)
}
// Update block height map
val newHeightMap = if (!block.isInvalid) {
val currSet = state.heightMap.getOrElse(block.blockNum, Set())
state.heightMap.updated(block.blockNum, currSet + block.hash)
} else state.heightMap
val newLastFinalizedBlock =
if (block.isDirectlyFinalized &&
!state.lastFinalizedBlock.exists { case (_, height) => height > block.blockNum })
(block.hash, block.blockNum).some
else state.lastFinalizedBlock
val newFinalisedBlockSet =
if (block.isFinalized) state.finalizedBlockSet + block.hash else state.finalizedBlockSet
state.copy(
dagSet = newDagSet,
childMap = newChildMap,
heightMap = newHeightMap,
lastFinalizedBlock = newLastFinalizedBlock,
finalizedBlockSet = newFinalisedBlockSet
)
}
private def validateDagState(state: DagState): DagState = {
// Validate height map index (block numbers) are in sequence without holes
val m = state.heightMap
val (min, max) = if (m.nonEmpty) (m.firstKey, m.lastKey + 1) else (0L, 0L)
assert(max - min == m.size.toLong, "DAG store height map has numbers not in sequence.")
state
}
// Used to project part of the block metadata for in-memory initialization
final case class BlockInfo(
hash: BlockHash,
parents: Set[BlockHash],
blockNum: Long,
isInvalid: Boolean,
isDirectlyFinalized: Boolean,
isFinalized: Boolean
)
private def recreateInMemoryState(
blocksInfoMap: Map[BlockHash, BlockInfo]
): DagState = {
val emptyState: DagState =
DagState(
dagSet = Set(),
childMap = Map(),
heightMap = SortedMap(),
lastFinalizedBlock = none[(BlockHash, Long)],
finalizedBlockSet = Set()
)
// Add blocks to DAG state
val dagState = blocksInfoMap.foldLeft(emptyState) {
case (state, (_, block)) => addBlockToDagState(block)(state)
}
validateDagState(dagState)
}
}