Skip to content

Commit 0a5ade1

Browse files
jasagredojasagredo
committed
Rename Non-native to Canonical
1 parent d6e0b35 commit 0a5ade1

File tree

14 files changed

+64
-64
lines changed

14 files changed

+64
-64
lines changed

‎ouroboros-consensus-cardano/src/unstable-cardano-tools/Cardano/Tools/DBAnalyser/Run.hs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -100,9 +100,9 @@ openLedgerDB args = do
100100
(LedgerDBSnapshotEvent >$< LedgerDB.lgrTracer args)
101101
(LedgerDB.lgrHasFS args)
102102
( flip
103-
LedgerDB.V2.NonNativeSnapshotsFS
103+
LedgerDB.V2.CanonicalSnapshotsFS
104104
(LedgerDB.lgrHasFS args)
105-
<$> LedgerDB.lgrNonNativeSnapshotsFS args
105+
<$> LedgerDB.lgrCanonicalSnapshotsFS args
106106
)
107107
let initDb =
108108
LedgerDB.V2.mkInitDb

‎ouroboros-consensus-diffusion/src/ouroboros-consensus-diffusion/Ouroboros/Consensus/Node.hs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -359,7 +359,7 @@ data
359359
, srnChainDbValidateOverride :: Bool
360360
-- ^ If @True@, validate the ChainDB on init no matter what
361361
, srnDatabasePath :: NodeDatabasePaths
362-
, srnNonNativeSnapshotsPath :: Maybe FilePath
362+
, srnCanonicalSnapshotsPath :: Maybe FilePath
363363
-- ^ Location of the DBs
364364
, srnDiffusionArguments :: Cardano.Diffusion.CardanoNodeArguments m
365365
, srnDiffusionConfiguration :: Cardano.Diffusion.CardanoConfiguration m
@@ -1065,8 +1065,8 @@ stdLowLevelRunNodeArgsIO
10651065
. ChainDB.updateTracer srnTraceChainDB
10661066
. maybe
10671067
id
1068-
(\fp -> ChainDB.enableNonNativeSnapshots (SomeHasFS $ ioHasFS $ MountPoint fp))
1069-
srnNonNativeSnapshotsPath
1068+
(\fp -> ChainDB.enableCanonicalSnapshots (SomeHasFS $ ioHasFS $ MountPoint fp))
1069+
srnCanonicalSnapshotsPath
10701070
. ( if not srnChainDbValidateOverride
10711071
then id
10721072
else ChainDB.ensureValidateAll

‎ouroboros-consensus/src/ouroboros-consensus-lsm/Ouroboros/Consensus/Storage/LedgerDB/V2/LSM.hs‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -200,13 +200,13 @@ snapshotManager ::
200200
CodecConfig blk ->
201201
Tracer m (TraceSnapshotEvent blk) ->
202202
SomeHasFS m ->
203-
Maybe (NonNativeSnapshotsFS m) ->
203+
Maybe (CanonicalSnapshotsFS m) ->
204204
SnapshotManager m m blk (StateRef m (ExtLedgerState blk))
205-
snapshotManager session ccfg tracer fs mNonNative =
205+
snapshotManager session ccfg tracer fs mCanonical =
206206
SnapshotManager
207207
{ listSnapshots = defaultListSnapshots fs
208208
, deleteSnapshot = implDeleteSnapshot session fs tracer
209-
, takeSnapshot = implTakeSnapshot ccfg tracer fs mNonNative
209+
, takeSnapshot = implTakeSnapshot ccfg tracer fs mCanonical
210210
}
211211

212212
newLSMLedgerTablesHandle ::
@@ -332,11 +332,11 @@ implTakeSnapshot ::
332332
CodecConfig blk ->
333333
Tracer m (TraceSnapshotEvent blk) ->
334334
SomeHasFS m ->
335-
Maybe (NonNativeSnapshotsFS m) ->
335+
Maybe (CanonicalSnapshotsFS m) ->
336336
Maybe String ->
337337
StateRef m (ExtLedgerState blk) ->
338338
m (Maybe (DiskSnapshot, RealPoint blk))
339-
implTakeSnapshot ccfg tracer shfs mNonNativeFS suffix st =
339+
implTakeSnapshot ccfg tracer shfs mCanonicalFS suffix st =
340340
case pointToWithOriginRealPoint (castPoint (getTip $ state st)) of
341341
Origin -> return Nothing
342342
NotOrigin t -> do
@@ -350,15 +350,15 @@ implTakeSnapshot ccfg tracer shfs mNonNativeFS suffix st =
350350
stateCRC <-
351351
encloseTimedWith (TookSnapshot snapshot t >$< tracer) $
352352
writeSnapshot shfs (encodeDiskExtLedgerState ccfg) snapshot st
353-
takeNonNativeSnapshot
353+
takeCanonicalSnapshot
354354
(($ t) >$< tracer)
355355
snapshot
356356
(duplicate (tables st))
357357
close
358358
(\hdl -> yield (Proxy @LSM) (YieldLSM 1000 hdl) (state st))
359359
(state st)
360360
stateCRC
361-
mNonNativeFS
361+
mCanonicalFS
362362

363363
return $ Just (snapshot, t)
364364

‎ouroboros-consensus/src/ouroboros-consensus/Ouroboros/Consensus/Storage/ChainDB/Impl/Args.hs‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ module Ouroboros.Consensus.Storage.ChainDB.Impl.Args
1313
, completeChainDbArgs
1414
, defaultArgs
1515
, enableLedgerEvents
16-
, enableNonNativeSnapshots
16+
, enableCanonicalSnapshots
1717
, ensureValidateAll
1818
, updateQueryBatchSize
1919
, updateSnapshotPolicyArgs
@@ -264,9 +264,9 @@ enableLedgerEvents args =
264264
}
265265
}
266266

267-
enableNonNativeSnapshots :: SomeHasFS m -> ChainDbArgs f m blk -> ChainDbArgs f m blk
268-
enableNonNativeSnapshots shfs args =
269-
args{cdbLgrDbArgs = (cdbLgrDbArgs args){LedgerDB.lgrNonNativeSnapshotsFS = Just shfs}}
267+
enableCanonicalSnapshots :: SomeHasFS m -> ChainDbArgs f m blk -> ChainDbArgs f m blk
268+
enableCanonicalSnapshots shfs args =
269+
args{cdbLgrDbArgs = (cdbLgrDbArgs args){LedgerDB.lgrCanonicalSnapshotsFS = Just shfs}}
270270

271271
{-------------------------------------------------------------------------------
272272
Relative mount points

‎ouroboros-consensus/src/ouroboros-consensus/Ouroboros/Consensus/Storage/LedgerDB.hs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ openDB
9797
(configCodec . getExtLedgerCfg . ledgerDbCfg $ lgrConfig args)
9898
(LedgerDBSnapshotEvent >$< lgrTracer args)
9999
(lgrHasFS args)
100-
(flip NonNativeSnapshotsFS (lgrHasFS args) <$> lgrNonNativeSnapshotsFS args)
100+
(flip CanonicalSnapshotsFS (lgrHasFS args) <$> lgrCanonicalSnapshotsFS args)
101101
let initDb = V2.mkInitDb args getBlock snapManager getVolatileSuffix res
102102
doOpenDB args initDb snapManager stream replayGoal
103103

‎ouroboros-consensus/src/ouroboros-consensus/Ouroboros/Consensus/Storage/LedgerDB/Args.hs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -60,8 +60,8 @@ data LedgerDbArgs f m blk = LedgerDbArgs
6060
, lgrTracer :: Tracer m (TraceEvent blk)
6161
, lgrBackendArgs :: LedgerDbBackendArgs m blk
6262
, lgrRegistry :: HKD f (ResourceRegistry m)
63-
, lgrNonNativeSnapshotsFS :: Maybe (SomeHasFS m)
64-
-- ^ If Just, enable non-native snapshots.
63+
, lgrCanonicalSnapshotsFS :: Maybe (SomeHasFS m)
64+
-- ^ If Just, enable canonical snapshots.
6565
, lgrQueryBatchSize :: QueryBatchSize
6666
, lgrStartSnapshot :: Maybe DiskSnapshot
6767
-- ^ If provided, the ledgerdb will start using said snapshot and fallback
@@ -87,7 +87,7 @@ defaultArgs backendArgs =
8787
lgrBackendArgs = LedgerDbBackendArgsV2 backendArgs
8888
, lgrRegistry = NoDefault
8989
, lgrStartSnapshot = Nothing
90-
, lgrNonNativeSnapshotsFS = Nothing
90+
, lgrCanonicalSnapshotsFS = Nothing
9191
}
9292

9393
data LedgerDbBackendArgs m blk

‎ouroboros-consensus/src/ouroboros-consensus/Ouroboros/Consensus/Storage/LedgerDB/Snapshots.hs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -613,8 +613,8 @@ data TraceSnapshotEvent blk
613613
InvalidSnapshot DiskSnapshot (SnapshotFailure blk)
614614
| -- | A snapshot was written to disk.
615615
TookSnapshot DiskSnapshot (RealPoint blk) EnclosingTimed
616-
| -- | A non-native snapshot was written to disk.
617-
TookNonNativeSnapshot DiskSnapshot (RealPoint blk) EnclosingTimed
616+
| -- | A canonical snapshot was written to disk.
617+
TookCanonicalSnapshot DiskSnapshot (RealPoint blk) EnclosingTimed
618618
| -- | An old or invalid on-disk snapshot was deleted
619619
DeletedSnapshot DiskSnapshot
620620
deriving (Generic, Eq, Show)

‎ouroboros-consensus/src/ouroboros-consensus/Ouroboros/Consensus/Storage/LedgerDB/V1/BackingStore/Impl/InMemory.hs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -379,4 +379,4 @@ instance StreamingBackend m Mem l where
379379
sink _ (SinkArgs x) = absurd x
380380

381381
instance StreamingBackendV1 m Mem l where
382-
yieldV1 _ _ = error "We do not support streaming non-native snapshots from a V1 InMemory backend"
382+
yieldV1 _ _ = error "We do not support streaming canonical snapshots from a V1 InMemory backend"

‎ouroboros-consensus/src/ouroboros-consensus/Ouroboros/Consensus/Storage/LedgerDB/V1/Snapshots.hs‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,7 @@ import Ouroboros.Consensus.Storage.LedgerDB.V1.BackingStore
160160
import qualified Ouroboros.Consensus.Storage.LedgerDB.V1.BackingStore as V1
161161
import Ouroboros.Consensus.Storage.LedgerDB.V1.DbChangelog
162162
import Ouroboros.Consensus.Storage.LedgerDB.V1.Lock
163-
import Ouroboros.Consensus.Storage.LedgerDB.V2.Backend (NonNativeSnapshotsFS (..))
163+
import Ouroboros.Consensus.Storage.LedgerDB.V2.Backend (CanonicalSnapshotsFS (..))
164164
import Ouroboros.Consensus.Storage.LedgerDB.V2.InMemory hiding (Args, snapshotManager)
165165
import Ouroboros.Consensus.Util.Args (Complete)
166166
import Ouroboros.Consensus.Util.Enclose
@@ -182,7 +182,7 @@ snapshotManager args p =
182182
(configCodec . getExtLedgerCfg . ledgerDbCfg $ lgrConfig args)
183183
(LedgerDBSnapshotEvent >$< lgrTracer args)
184184
(SnapshotsFS (lgrHasFS args))
185-
(flip NonNativeSnapshotsFS (lgrHasFS args) <$> lgrNonNativeSnapshotsFS args)
185+
(flip CanonicalSnapshotsFS (lgrHasFS args) <$> lgrCanonicalSnapshotsFS args)
186186

187187
snapshotManager' ::
188188
( IOLike m
@@ -193,7 +193,7 @@ snapshotManager' ::
193193
CodecConfig blk ->
194194
Tracer m (TraceSnapshotEvent blk) ->
195195
SnapshotsFS m ->
196-
Maybe (NonNativeSnapshotsFS m) ->
196+
Maybe (CanonicalSnapshotsFS m) ->
197197
SnapshotManager m (ReadLocked m) blk (StrictTVar m (DbChangelog' blk), BackingStore' m blk)
198198
snapshotManager' p ccfg tracer sfs@(SnapshotsFS fs) mNNFS =
199199
SnapshotManager
@@ -232,12 +232,12 @@ implTakeSnapshot ::
232232
CodecConfig blk ->
233233
Tracer m (TraceSnapshotEvent blk) ->
234234
SnapshotsFS m ->
235-
Maybe (NonNativeSnapshotsFS m) ->
235+
Maybe (CanonicalSnapshotsFS m) ->
236236
BackingStore' m blk ->
237237
-- | Override for snapshot numbering
238238
Maybe String ->
239239
ReadLocked m (Maybe (DiskSnapshot, RealPoint blk))
240-
implTakeSnapshot (V1.V1Args _ (V1.SomeBackendArgs (_ :: V1.Args m backend))) ldbvar ccfg tracer (SnapshotsFS hasFS) mNonNativeFS backingStore suffix = readLocked $ do
240+
implTakeSnapshot (V1.V1Args _ (V1.SomeBackendArgs (_ :: V1.Args m backend))) ldbvar ccfg tracer (SnapshotsFS hasFS) mCanonicalFS backingStore suffix = readLocked $ do
241241
state <- changelogLastFlushedState <$> readTVarIO ldbvar
242242
case pointToWithOriginRealPoint (castPoint (getTip state)) of
243243
Origin ->
@@ -253,15 +253,15 @@ implTakeSnapshot (V1.V1Args _ (V1.SomeBackendArgs (_ :: V1.Args m backend))) ldb
253253
stateCRC <-
254254
encloseTimedWith (TookSnapshot snapshot t >$< tracer) $
255255
writeSnapshot hasFS backingStore (encodeDiskExtLedgerState ccfg) snapshot state
256-
takeNonNativeSnapshot
256+
takeCanonicalSnapshot
257257
(($ t) >$< tracer)
258258
snapshot
259259
(bsValueHandle backingStore)
260260
bsvhClose
261261
(\vh -> yieldV1 (Proxy @backend) vh state)
262262
state
263263
stateCRC
264-
mNonNativeFS
264+
mCanonicalFS
265265
return $ Just (snapshot, t)
266266

267267
-- | Write snapshot to disk

‎ouroboros-consensus/src/ouroboros-consensus/Ouroboros/Consensus/Storage/LedgerDB/V2/Backend.hs‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
module Ouroboros.Consensus.Storage.LedgerDB.V2.Backend
1010
( -- * Backend API
1111
Backend (..)
12-
, NonNativeSnapshotsFS (..)
12+
, CanonicalSnapshotsFS (..)
1313

1414
-- * Existentials
1515
, SomeBackendTrace (..)
@@ -83,13 +83,13 @@ class NoThunks (Resources m backend) => Backend m backend blk where
8383
CodecConfig blk ->
8484
Tracer m (TraceSnapshotEvent blk) ->
8585
SomeHasFS m ->
86-
Maybe (NonNativeSnapshotsFS m) ->
86+
Maybe (CanonicalSnapshotsFS m) ->
8787
SnapshotManager m m blk (StateRef m (ExtLedgerState blk))
8888

89-
-- | Arguments required if non-native snapshots are enabled.
90-
data NonNativeSnapshotsFS m = NonNativeSnapshotsFS
91-
{ nnNonNativeHasFS :: SomeHasFS m
92-
-- ^ The FS on which non-native snapshots are stored
89+
-- | Arguments required if canonical snapshots are enabled.
90+
data CanonicalSnapshotsFS m = CanonicalSnapshotsFS
91+
{ nnCanonicalHasFS :: SomeHasFS m
92+
-- ^ The FS on which canonical snapshots are stored
9393
, nnNativeHasFS :: SomeHasFS m
9494
-- ^ The FS on which native snapshots are stored
9595
}

0 commit comments

Comments
 (0)