Dynamic Config (#664)

* dyncfg 90% done

* tests, docs, and clean-up

* updates

* checkers

* allow cmp.Equal

* fixed dynamic

* avoid unsettable

* change-notification

* go mod tidy

* dbg basetext

* fix bad import

* test logger

* dbgFail: is it in baseTest

* found 1 blocker for test failure: base was not included right

* rm dbg

* lint

* no pq, fix unmarshal

* complex equal

* mod tidy & naming

* fix Fil cmp panic

Author: snadrus

cmd/curio/guidedsetup/guidedsetup.go

@@ -202,7 +202,7 @@ type MigrationData struct {
 	selectTemplates *promptui.SelectTemplates
 	MinerConfigPath string
 	DB              *harmonydb.DB
-	HarmonyCfg      config.HarmonyDB
+	HarmonyCfg      harmonydb.Config
 	MinerID         address.Address
 	full            api.Chain
 	cctx            *cli.Context

deps/config/cfgdocgen/gen.go

@@ -25,9 +25,10 @@ func run() error {
 	state := stGlobal
 
 	type field struct {
-		Name    string
-		Type    string
-		Comment string
+		Name      string
+		Type      string
+		Comment   string
+		IsDynamic bool
 	}
 
 	var currentType string
@@ -73,16 +74,24 @@ func run() error {
 
 			name := f[0]
 			typ := f[1]
+			isDynamic := false
+			if strings.HasPrefix(typ, "*Dynamic[") {
+				isDynamic = true
+				typ = strings.TrimPrefix(typ, "*Dynamic[")
+				typ = strings.TrimSuffix(typ, "]")
+				comment = append(comment, "Updates will affect running instances.")
+			}
 
 			if len(comment) > 0 && strings.HasPrefix(comment[0], fmt.Sprintf("%s is DEPRECATED", name)) {
 				// don't document deprecated fields
 				continue
 			}
 
 			out[currentType] = append(out[currentType], field{
-				Name:    name,
-				Type:    typ,
-				Comment: strings.Join(comment, "\n"),
+				Name:      name,
+				Type:      typ,
+				Comment:   strings.Join(comment, "\n"),
+				IsDynamic: isDynamic,
 			})
 		}
 	}

deps/config/doc_gen.go

@@ -0,0 +1,263 @@
+package config
+
+import (
+	"context"
+	"fmt"
+	"math/big"
+	"reflect"
+	"strings"
+	"sync"
+	"time"
+
+	"github.com/BurntSushi/toml"
+	"github.com/google/go-cmp/cmp"
+	logging "github.com/ipfs/go-log/v2"
+
+	"github.com/filecoin-project/curio/harmony/harmonydb"
+)
+
+var logger = logging.Logger("config-dynamic")
+
+// bigIntComparer is used to compare big.Int values properly
+var bigIntComparer = cmp.Comparer(func(x, y big.Int) bool {
+	return x.Cmp(&y) == 0
+})
+
+type Dynamic[T any] struct {
+	value T
+}
+
+func NewDynamic[T any](value T) *Dynamic[T] {
+	d := &Dynamic[T]{value: value}
+	dynamicLocker.notifier[reflect.ValueOf(d).Pointer()] = nil
+	return d
+}
+
+// OnChange registers a function to be called in a goroutine when the dynamic value changes to a new final-layered value.
+// The function is called in a goroutine to avoid blocking the main thread; it should not panic.
+func (d *Dynamic[T]) OnChange(fn func()) {
+	p := reflect.ValueOf(d).Pointer()
+	prev := dynamicLocker.notifier[p]
+	if prev == nil {
+		dynamicLocker.notifier[p] = fn
+		return
+	}
+	dynamicLocker.notifier[p] = func() {
+		prev()
+		fn()
+	}
+}
+
+func (d *Dynamic[T]) Set(value T) {
+	dynamicLocker.Lock()
+	defer dynamicLocker.Unlock()
+	dynamicLocker.inform(reflect.ValueOf(d).Pointer(), d.value, value)
+	d.value = value
+}
+
+func (d *Dynamic[T]) Get() T {
+	dynamicLocker.RLock()
+	defer dynamicLocker.RUnlock()
+	return d.value
+}
+
+// UnmarshalText unmarshals the text into the dynamic value.
+// After initial setting, future updates require a lock on the DynamicMx mutex before calling toml.Decode.
+func (d *Dynamic[T]) UnmarshalText(text []byte) error {
+	return toml.Unmarshal(text, &d.value)
+}
+
+// MarshalTOML marshals the dynamic value to TOML format.
+// If used from deps, requires a lock.
+func (d *Dynamic[T]) MarshalTOML() ([]byte, error) {
+	return toml.Marshal(d.value)
+}
+
+// Equal is used by cmp.Equal for custom comparison.
+// If used from deps, requires a lock.
+func (d *Dynamic[T]) Equal(other *Dynamic[T]) bool {
+	return cmp.Equal(d.value, other.value, bigIntComparer)
+}
+
+type cfgRoot[T any] struct {
+	db       *harmonydb.DB
+	layers   []string
+	treeCopy T
+	fixupFn  func(string, T) error
+}
+
+func EnableChangeDetection[T any](db *harmonydb.DB, obj T, layers []string, fixupFn func(string, T) error) error {
+	var err error
+	r := &cfgRoot[T]{db: db, treeCopy: obj, layers: layers, fixupFn: fixupFn}
+	r.treeCopy, err = CopyWithOriginalDynamics(obj)
+	if err != nil {
+		return err
+	}
+	go r.changeMonitor()
+	return nil
+}
+
+// copyWithOriginalDynamics copies the original dynamics from the original object to the new object.
+func CopyWithOriginalDynamics[T any](orig T) (T, error) {
+	typ := reflect.TypeOf(orig)
+	val := reflect.ValueOf(orig)
+
+	// Handle pointer to struct
+	if typ.Kind() == reflect.Ptr {
+		if typ.Elem().Kind() != reflect.Struct {
+			var zero T
+			return zero, fmt.Errorf("expected pointer to struct, got pointer to %s", typ.Elem().Kind())
+		}
+		// Create a new instance of the struct
+		result := reflect.New(typ.Elem())
+		walker(val.Elem(), result.Elem())
+		return result.Interface().(T), nil
+	}
+
+	// Handle direct struct
+	if typ.Kind() != reflect.Struct {
+		var zero T
+		return zero, fmt.Errorf("expected struct or pointer to struct, got %s", typ.Kind())
+	}
+
+	result := reflect.New(typ).Elem()
+	walker(val, result)
+	return result.Interface().(T), nil
+}
+
+// walker recursively walks the struct tree, copying fields and preserving Dynamic pointers
+func walker(orig, result reflect.Value) {
+	for i := 0; i < orig.NumField(); i++ {
+		field := orig.Field(i)
+		resultField := result.Field(i)
+
+		// Skip unexported fields - they can't be set via reflection
+		if !resultField.CanSet() {
+			continue
+		}
+
+		switch field.Kind() {
+		case reflect.Struct:
+			// Check if this struct is a Dynamic[T] - if so, copy by value
+			if isDynamicType(field.Type()) {
+				resultField.Set(field)
+			} else {
+				walker(field, resultField)
+			}
+		case reflect.Ptr:
+			if !field.IsNil() {
+				// Check if the pointed-to type is Dynamic[T]
+				elemType := field.Type().Elem()
+				if isDynamicType(elemType) {
+					// This is *Dynamic[T] - copy the pointer to preserve sharing
+					resultField.Set(field)
+				} else if elemType.Kind() == reflect.Struct {
+					// Regular struct pointer - recursively copy
+					newPtr := reflect.New(elemType)
+					walker(field.Elem(), newPtr.Elem())
+					resultField.Set(newPtr)
+				} else {
+					// Other pointer types - shallow copy
+					resultField.Set(field)
+				}
+			}
+		default:
+			resultField.Set(field)
+		}
+	}
+}
+
+// isDynamicType checks if a type is Dynamic[T] by checking if the name starts with "Dynamic"
+func isDynamicType(t reflect.Type) bool {
+	name := t.Name()
+	return strings.HasPrefix(name, "Dynamic[")
+}
+
+func (r *cfgRoot[T]) changeMonitor() {
+	lastTimestamp := time.Time{} // lets do a read at startup
+
+	for {
+		configCount := 0
+		err := r.db.QueryRow(context.Background(), `SELECT COUNT(*) FROM harmony_config WHERE timestamp > $1 AND title IN ($2)`, lastTimestamp, strings.Join(r.layers, ",")).Scan(&configCount)
+		if err != nil {
+			logger.Errorf("error selecting configs: %s", err)
+			continue
+		}
+		if configCount == 0 {
+			continue
+		}
+		lastTimestamp = time.Now()
+
+		// 1. get all configs
+		configs, err := GetConfigs(context.Background(), r.db, r.layers)
+		if err != nil {
+			logger.Errorf("error getting configs: %s", err)
+			continue
+		}
+
+		// 2. lock "dynamic" mutex
+		func() {
+			dynamicLocker.Lock()
+			defer dynamicLocker.Unlock()
+			err := ApplyLayers(context.Background(), r.treeCopy, configs, r.fixupFn)
+			if err != nil {
+				logger.Errorf("dynamic config failed to ApplyLayers: %s", err)
+				return
+			}
+		}()
+		time.Sleep(30 * time.Second)
+	}
+}
+
+var dynamicLocker = changeNotifier{diff: diff{
+	originally: make(map[uintptr]any),
+	latest:     make(map[uintptr]any),
+},
+	notifier: make(map[uintptr]func()),
+}
+
+type changeNotifier struct {
+	sync.RWMutex      // this protects the dynamic[T] reads from getting a race with the updating
+	updating     bool // determines which mode we are in: updating or querying
+
+	diff
+
+	notifier map[uintptr]func()
+}
+type diff struct {
+	cdmx       sync.Mutex //
+	originally map[uintptr]any
+	latest     map[uintptr]any
+}
+
+func (c *changeNotifier) Lock() {
+	c.RWMutex.Lock()
+	c.updating = true
+}
+func (c *changeNotifier) Unlock() {
+	c.cdmx.Lock()
+	c.RWMutex.Unlock()
+	defer c.cdmx.Unlock()
+
+	c.updating = false
+	for k, v := range c.latest {
+		if !cmp.Equal(v, c.originally[k], bigIntComparer) {
+			if notifier := c.notifier[k]; notifier != nil {
+				go notifier()
+			}
+		}
+	}
+	c.originally = make(map[uintptr]any)
+	c.latest = make(map[uintptr]any)
+}
+func (c *changeNotifier) inform(ptr uintptr, oldValue any, newValue any) {
+	if !c.updating {
+		return
+	}
+	c.cdmx.Lock()
+	defer c.cdmx.Unlock()
+	if _, ok := c.originally[ptr]; !ok {
+		c.originally[ptr] = oldValue
+	}
+	c.latest[ptr] = newValue
+}