Merge pull request #4618 from harmony-one/fix/snapshot

cmd/harmony/config.go

@@ -145,6 +145,35 @@ func getDefaultSyncConfig(nt nodeconfig.NetworkType) harmonyconfig.SyncConfig {
 	}
 }
 
+func getDefaultCacheConfig(nt nodeconfig.NetworkType) harmonyconfig.CacheConfig {
+	cacheConfig := harmonyconfig.CacheConfig{
+		Disabled:        defaultCacheConfig.Disabled,
+		TrieNodeLimit:   defaultCacheConfig.TrieNodeLimit,
+		TriesInMemory:   defaultCacheConfig.TriesInMemory,
+		TrieTimeLimit:   defaultCacheConfig.TrieTimeLimit,
+		SnapshotLimit:   defaultCacheConfig.SnapshotLimit,
+		SnapshotWait:    defaultCacheConfig.SnapshotWait,
+		Preimages:       defaultCacheConfig.Preimages,
+		SnapshotNoBuild: defaultCacheConfig.SnapshotNoBuild,
+	}
+
+	switch nt {
+	case nodeconfig.Mainnet:
+		cacheConfig.Disabled = true
+		cacheConfig.Preimages = true
+	case nodeconfig.Testnet:
+		cacheConfig.Disabled = false
+		cacheConfig.Preimages = true
+	case nodeconfig.Localnet:
+		cacheConfig.Disabled = false
+		cacheConfig.Preimages = false
+	default:
+		cacheConfig.Disabled = false
+		cacheConfig.Preimages = true
+	}
+	return cacheConfig
+}
+
 var configCmd = &cobra.Command{
 	Use:   "config",
 	Short: "dump or update config",

cmd/harmony/config_migrations.go

@@ -334,7 +334,7 @@ func init() {
 
 	migrations["2.5.11"] = func(confTree *toml.Tree) *toml.Tree {
 		if confTree.Get("General.TriesInMemory") == nil {
-			confTree.Set("General.TriesInMemory", defaultConfig.General.TriesInMemory)
+			confTree.Set("General.TriesInMemory", defaultConfig.Cache.TriesInMemory)
 		}
 		confTree.Set("Version", "2.5.12")
 		return confTree
@@ -405,6 +405,17 @@ func init() {
 		return confTree
 	}
 
+	migrations["2.6.0"] = func(confTree *toml.Tree) *toml.Tree {
+		confTree.Delete("General.TriesInMemory")
+
+		if confTree.Get("Cache") == nil {
+			confTree.Set("Cache", defaultConfig.Cache)
+		}
+		// upgrade minor version because of `Cache` section introduction
+		confTree.Set("Version", "2.6.1")
+		return confTree
+	}
+
 	// check that the latest version here is the same as in default.go
 	largestKey := getNextVersion(migrations)
 	if largestKey != tomlConfigVersion {

cmd/harmony/default.go

@@ -1,13 +1,15 @@
 package main
 
 import (
+	"time"
+
 	"github.com/harmony-one/harmony/core"
 	"github.com/harmony-one/harmony/hmy"
 	harmonyconfig "github.com/harmony-one/harmony/internal/configs/harmony"
 	nodeconfig "github.com/harmony-one/harmony/internal/configs/node"
 )
 
-const tomlConfigVersion = "2.6.0"
+const tomlConfigVersion = "2.6.1"
 
 const (
 	defNetworkType = nodeconfig.Mainnet
@@ -24,7 +26,6 @@ var defaultConfig = harmonyconfig.HarmonyConfig{
 		IsOffline:        false,
 		DataDir:          "./",
 		TraceEnable:      false,
-		TriesInMemory:    128,
 	},
 	Network: getDefaultNetworkConfig(defNetworkType),
 	P2P: harmonyconfig.P2pConfig{
@@ -131,6 +132,7 @@ var defaultConfig = harmonyconfig.HarmonyConfig{
 		LowUsageThreshold: hmy.DefaultGPOConfig.LowUsageThreshold,
 		BlockGasLimit:     hmy.DefaultGPOConfig.BlockGasLimit,
 	},
+	Cache: getDefaultCacheConfig(defNetworkType),
 }
 
 var defaultSysConfig = harmonyconfig.SysConfig{
@@ -271,6 +273,17 @@ var (
 	}
 )
 
+var defaultCacheConfig = harmonyconfig.CacheConfig{
+	Disabled:        false,
+	TrieNodeLimit:   256,
+	TriesInMemory:   128,
+	TrieTimeLimit:   2 * time.Minute,
+	SnapshotLimit:   256,
+	SnapshotWait:    true,
+	Preimages:       true,
+	SnapshotNoBuild: false,
+}
+
 const (
 	defaultBroadcastInvalidTx = false
 )
@@ -285,6 +298,7 @@ func getDefaultHmyConfigCopy(nt nodeconfig.NetworkType) harmonyconfig.HarmonyCon
 	}
 	config.Sync = getDefaultSyncConfig(nt)
 	config.DNSSync = getDefaultDNSSyncConfig(nt)
+	config.Cache = getDefaultCacheConfig(nt)
 
 	return config
 }
@@ -324,6 +338,11 @@ func getDefaultPrometheusConfigCopy() harmonyconfig.PrometheusConfig {
 	return config
 }
 
+func getDefaultCacheConfigCopy() harmonyconfig.CacheConfig {
+	config := defaultCacheConfig
+	return config
+}
+
 const (
 	nodeTypeValidator = "validator"
 	nodeTypeExplorer  = "explorer"

cmd/harmony/flags.go

@@ -32,7 +32,6 @@ var (
 		legacyDataDirFlag,
 
 		taraceFlag,
-		triesInMemoryFlag,
 	}
 
 	dnsSyncFlags = []cli.Flag{
@@ -268,6 +267,16 @@ var (
 		gpoBlockGasLimitFlag,
 	}
 
+	cacheConfigFlags = []cli.Flag{
+		cacheDisabled,
+		cacheTrieNodeLimit,
+		cacheTriesInMemory,
+		cachePreimages,
+		cacheSnapshotLimit,
+		cacheSnapshotNoBuild,
+		cacheSnapshotWait,
+	}
+
 	metricsFlags = []cli.Flag{
 		metricsETHFlag,
 		metricsExpensiveETHFlag,
@@ -352,11 +361,6 @@ var (
 		Usage:    "indicates if full transaction tracing should be enabled",
 		DefValue: defaultConfig.General.TraceEnable,
 	}
-	triesInMemoryFlag = cli.IntFlag{
-		Name:     "blockchain.tries_in_memory",
-		Usage:    "number of blocks from header stored in disk before exiting",
-		DefValue: defaultConfig.General.TriesInMemory,
-	}
 )
 
 func getRootFlags() []cli.Flag {
@@ -436,14 +440,6 @@ func applyGeneralFlags(cmd *cobra.Command, config *harmonyconfig.HarmonyConfig)
 	if cli.IsFlagChanged(cmd, isBackupFlag) {
 		config.General.IsBackup = cli.GetBoolFlagValue(cmd, isBackupFlag)
 	}
-
-	if cli.IsFlagChanged(cmd, triesInMemoryFlag) {
-		value := cli.GetIntFlagValue(cmd, triesInMemoryFlag)
-		if value <= 2 {
-			panic("Must provide number greater than 2 for General.TriesInMemory")
-		}
-		config.General.TriesInMemory = value
-	}
 }
 
 // network flags
@@ -2115,3 +2111,70 @@ func applyGPOFlags(cmd *cobra.Command, cfg *harmonyconfig.HarmonyConfig) {
 		cfg.GPO.BlockGasLimit = cli.GetIntFlagValue(cmd, gpoBlockGasLimitFlag)
 	}
 }
+
+// cache config flags
+var (
+	cacheDisabled = cli.BoolFlag{
+		Name:     "cache.disabled",
+		Usage:    "Whether to disable trie write caching (archive node)",
+		DefValue: defaultCacheConfig.Disabled,
+	}
+	cacheTrieNodeLimit = cli.IntFlag{
+		Name:     "cache.trie_node_limit",
+		Usage:    " Memory limit (MB) at which to flush the current in-memory trie to disk",
+		DefValue: defaultCacheConfig.TrieNodeLimit,
+	}
+	cacheTriesInMemory = cli.Uint64Flag{
+		Name:     "cache.tries_in_memory",
+		Usage:    "Block number from the head stored in disk before exiting",
+		DefValue: defaultCacheConfig.TriesInMemory,
+	}
+	cachePreimages = cli.BoolFlag{
+		Name:     "cache.preimages",
+		Usage:    "Whether to store preimage of trie key to the disk",
+		DefValue: defaultCacheConfig.Preimages,
+	}
+	cacheSnapshotLimit = cli.IntFlag{
+		Name:     "cache.snapshot_limit",
+		Usage:    "Memory allowance (MB) to use for caching snapshot entries in memory",
+		DefValue: defaultCacheConfig.SnapshotLimit,
+	}
+	cacheSnapshotNoBuild = cli.BoolFlag{
+		Name:     "cache.snapshot_no_build",
+		Usage:    "Whether the background generation is allowed",
+		DefValue: defaultCacheConfig.SnapshotNoBuild,
+	}
+	cacheSnapshotWait = cli.BoolFlag{
+		Name:     "cache.snapshot_wait",
+		Usage:    "Wait for snapshot construction on startup",
+		DefValue: defaultCacheConfig.SnapshotWait,
+	}
+)
+
+func applyCacheFlags(cmd *cobra.Command, cfg *harmonyconfig.HarmonyConfig) {
+	if cli.IsFlagChanged(cmd, cacheDisabled) {
+		cfg.Cache.Disabled = cli.GetBoolFlagValue(cmd, cacheDisabled)
+	}
+	if cli.IsFlagChanged(cmd, cacheTrieNodeLimit) {
+		cfg.Cache.TrieNodeLimit = cli.GetIntFlagValue(cmd, cacheTrieNodeLimit)
+	}
+	if cli.IsFlagChanged(cmd, cacheTriesInMemory) {
+		value := cli.GetUint64FlagValue(cmd, cacheTriesInMemory)
+		if value <= 2 {
+			panic("Must provide number greater than 2 for Cache.TriesInMemory")
+		}
+		cfg.Cache.TriesInMemory = value
+	}
+	if cli.IsFlagChanged(cmd, cachePreimages) {
+		cfg.Cache.Preimages = cli.GetBoolFlagValue(cmd, cachePreimages)
+	}
+	if cli.IsFlagChanged(cmd, cacheSnapshotLimit) {
+		cfg.Cache.SnapshotLimit = cli.GetIntFlagValue(cmd, cacheSnapshotLimit)
+	}
+	if cli.IsFlagChanged(cmd, cacheSnapshotNoBuild) {
+		cfg.Cache.SnapshotNoBuild = cli.GetBoolFlagValue(cmd, cacheSnapshotNoBuild)
+	}
+	if cli.IsFlagChanged(cmd, cacheSnapshotWait) {
+		cfg.Cache.SnapshotWait = cli.GetBoolFlagValue(cmd, cacheSnapshotWait)
+	}
+}