Fix multiple race conditions in config package

config/database.go

@@ -24,11 +24,8 @@ type StorageInterface struct {
 
 // Get returns a database record.
 func (s *StorageInterface) Get(key string) (record.Record, error) {
-	optionsLock.Lock()
-	defer optionsLock.Unlock()
-
-	opt, ok := options[key]
-	if !ok {
+	opt, err := GetOption(key)
+	if err != nil {
 		return nil, storage.ErrNotFound
 	}
 
@@ -55,11 +52,9 @@ func (s *StorageInterface) Put(r record.Record) (record.Record, error) {
 		return s.Get(r.DatabaseKey())
 	}
 
-	optionsLock.RLock()
-	option, ok := options[r.DatabaseKey()]
-	optionsLock.RUnlock()
-	if !ok {
-		return nil, errors.New("config option does not exist")
+	option, err := GetOption(r.DatabaseKey())
+	if err != nil {
+		return nil, err
 	}
 
 	var value interface{}
@@ -77,8 +72,7 @@ func (s *StorageInterface) Put(r record.Record) (record.Record, error) {
 		return nil, errors.New("received invalid value in \"Value\"")
 	}
 
-	err := setConfigOption(r.DatabaseKey(), value, false)
-	if err != nil {
+	if err := setConfigOption(r.DatabaseKey(), value, false); err != nil {
 		return nil, err
 	}
 	return option.Export()
@@ -91,9 +85,8 @@ func (s *StorageInterface) Delete(key string) error {
 
 // Query returns a an iterator for the supplied query.
 func (s *StorageInterface) Query(q *query.Query, local, internal bool) (*iterator.Iterator, error) {
-
-	optionsLock.Lock()
-	defer optionsLock.Unlock()
+	optionsLock.RLock()
+	defer optionsLock.RUnlock()
 
 	it := iterator.New()
 	var opts []*Option
@@ -109,7 +102,6 @@ func (s *StorageInterface) Query(q *query.Query, local, internal bool) (*iterato
 }
 
 func (s *StorageInterface) processQuery(it *iterator.Iterator, opts []*Option) {
-
 	sort.Sort(sortByKey(opts))
 
 	for _, opt := range opts {
@@ -148,17 +140,27 @@ func registerAsDatabase() error {
 	return nil
 }
 
-func pushFullUpdate() {
-	optionsLock.RLock()
-	defer optionsLock.RUnlock()
+// handleOptionUpdate updates the expertise and release level options,
+// if required, and eventually pushes a update for the option.
+// The caller must hold the option lock.
+func handleOptionUpdate(option *Option, push bool) {
+	if expertiseLevelOptionFlag.IsSet() && option == expertiseLevelOption {
+		updateExpertiseLevel()
+	}
 
-	for _, option := range options {
+	if releaseLevelOptionFlag.IsSet() && option == releaseLevelOption {
+		updateReleaseLevel()
+	}
+
+	if push {
 		pushUpdate(option)
 	}
 }
 
+// pushUpdate pushes an database update notification for option.
+// The caller must hold the option lock.
 func pushUpdate(option *Option) {
-	r, err := option.Export()
+	r, err := option.export()
 	if err != nil {
 		log.Errorf("failed to export option to push update: %s", err)
 	} else {

config/expertise.go

@@ -78,10 +78,6 @@ func registerExpertiseLevelOption() {
 }
 
 func updateExpertiseLevel() {
-	// check if already registered
-	if !expertiseLevelOptionFlag.IsSet() {
-		return
-	}
 	// get value
 	value := expertiseLevelOption.activeFallbackValue
 	if expertiseLevelOption.activeValue != nil {

config/get.go

@@ -18,23 +18,21 @@ type (
 func getValueCache(name string, option *Option, requestedType OptionType) (*Option, *valueCache) {
 	// get option
 	if option == nil {
-		var ok bool
-		optionsLock.RLock()
-		option, ok = options[name]
-		optionsLock.RUnlock()
-		if !ok {
+		var err error
+		option, err = GetOption(name)
+		if err != nil {
 			log.Errorf("config: request for unregistered option: %s", name)
 			return nil, nil
 		}
 	}
 
-	// check type
+	// Check the option type, no locking required as
+	// OptType is immutable once it is set
 	if requestedType != option.OptType {
 		log.Errorf("config: bad type: requested %s as %s, but is %s", name, getTypeName(requestedType), getTypeName(option.OptType))
 		return option, nil
 	}
 
-	// lock option
 	option.Lock()
 	defer option.Unlock()
 

config/get_test.go

@@ -7,22 +7,22 @@ import (
 	"github.com/safing/portbase/log"
 )
 
-func parseAndSetConfig(jsonData string) error {
+func parseAndReplaceConfig(jsonData string) error {
 	m, err := JSONToMap([]byte(jsonData))
 	if err != nil {
 		return err
 	}
 
-	return setConfig(m)
+	return replaceConfig(m)
 }
 
-func parseAndSetDefaultConfig(jsonData string) error {
+func parseAndReplaceDefaultConfig(jsonData string) error {
 	m, err := JSONToMap([]byte(jsonData))
 	if err != nil {
 		return err
 	}
 
-	return SetDefaultConfig(m)
+	return replaceDefaultConfig(m)
 }
 
 func quickRegister(t *testing.T, key string, optType OptionType, defaultValue interface{}) {
@@ -55,7 +55,7 @@ func TestGet(t *testing.T) { //nolint:gocognit
 	quickRegister(t, "hot", OptTypeBool, false)
 	quickRegister(t, "cold", OptTypeBool, true)
 
-	err = parseAndSetConfig(`
+	err = parseAndReplaceConfig(`
 	{
 		"monkey": "a",
 		"zebras": {
@@ -70,7 +70,7 @@ func TestGet(t *testing.T) { //nolint:gocognit
 		t.Fatal(err)
 	}
 
-	err = parseAndSetDefaultConfig(`
+	err = parseAndReplaceDefaultConfig(`
 	{
 		"monkey": "b",
 		"snake": "0",
@@ -106,7 +106,7 @@ func TestGet(t *testing.T) { //nolint:gocognit
 		t.Errorf("cold should be false, is %v", cold())
 	}
 
-	err = parseAndSetConfig(`
+	err = parseAndReplaceConfig(`
 	{
 		"monkey": "3"
 	}
@@ -284,7 +284,7 @@ func BenchmarkGetAsStringCached(b *testing.B) {
 	options = make(map[string]*Option)
 
 	// Setup
-	err := parseAndSetConfig(`{
+	err := parseAndReplaceConfig(`{
 		"monkey": "banana"
 	}`)
 	if err != nil {
@@ -303,7 +303,7 @@ func BenchmarkGetAsStringCached(b *testing.B) {
 
 func BenchmarkGetAsStringRefetch(b *testing.B) {
 	// Setup
-	err := parseAndSetConfig(`{
+	err := parseAndReplaceConfig(`{
 		"monkey": "banana"
 	}`)
 	if err != nil {
@@ -321,7 +321,7 @@ func BenchmarkGetAsStringRefetch(b *testing.B) {
 
 func BenchmarkGetAsIntCached(b *testing.B) {
 	// Setup
-	err := parseAndSetConfig(`{
+	err := parseAndReplaceConfig(`{
 		"elephant": 1
 	}`)
 	if err != nil {
@@ -340,7 +340,7 @@ func BenchmarkGetAsIntCached(b *testing.B) {
 
 func BenchmarkGetAsIntRefetch(b *testing.B) {
 	// Setup
-	err := parseAndSetConfig(`{
+	err := parseAndReplaceConfig(`{
 		"elephant": 1
 	}`)
 	if err != nil {

config/option.go

@@ -222,6 +222,10 @@ func (option *Option) Export() (record.Record, error) {
 	option.Lock()
 	defer option.Unlock()
 
+	return option.export()
+}
+
+func (option *Option) export() (record.Record, error) {
 	data, err := json.Marshal(option)
 	if err != nil {
 		return nil, err

config/persistence.go

@@ -31,11 +31,16 @@ func loadConfig() error {
 		return err
 	}
 
-	// apply
-	return setConfig(newValues)
+	return replaceConfig(newValues)
 }
 
+// saveConfig saves the current configuration to file.
+// It will acquire a read-lock on the global options registry
+// lock and must lock each option!
 func saveConfig() error {
+	optionsLock.RLock()
+	defer optionsLock.RUnlock()
+
 	// check if persistence is configured
 	if configFilePath == "" {
 		return nil
@@ -43,15 +48,18 @@ func saveConfig() error {
 
 	// extract values
 	activeValues := make(map[string]interface{})
-	optionsLock.RLock()
 	for key, option := range options {
+		// we cannot immedately unlock the option afger
+		// getData() because someone could lock and change it
+		// while we are marshaling the value (i.e. for string slices).
+		// We NEED to keep the option locks until we finsihed.
 		option.Lock()
+		defer option.Unlock()
+
 		if option.activeValue != nil {
 			activeValues[key] = option.activeValue.getData(option)
 		}
-		option.Unlock()
 	}
-	optionsLock.RUnlock()
 
 	// convert to JSON
 	data, err := MapToJSON(activeValues)

config/perspective.go

@@ -27,7 +27,7 @@ func NewPerspective(config map[string]interface{}) (*Perspective, error) {
 	var firstErr error
 	var errCnt int
 
-	optionsLock.Lock()
+	optionsLock.RLock()
 optionsLoop:
 	for key, option := range options {
 		// get option key from config
@@ -51,7 +51,7 @@ optionsLoop:
 			valueCache: valueCache,
 		}
 	}
-	optionsLock.Unlock()
+	optionsLock.RUnlock()
 
 	if firstErr != nil {
 		if errCnt > 0 {
@@ -68,10 +68,7 @@ func (p *Perspective) getPerspectiveValueCache(name string, requestedType Option
 	pOption, ok := p.config[name]
 	if !ok {
 		// check if option exists at all
-		optionsLock.RLock()
-		_, ok = options[name]
-		optionsLock.RUnlock()
-		if !ok {
+		if _, err := GetOption(name); err != nil {
 			log.Errorf("config: request for unregistered option: %s", name)
 		}
 		return nil

config/registry.go

@@ -18,8 +18,8 @@ var (
 // iteration between multiple calles. ForEachOption does NOT lock
 // opt when calling fn.
 func ForEachOption(fn func(opt *Option) error) error {
-	optionsLock.Lock()
-	defer optionsLock.Unlock()
+	optionsLock.RLock()
+	defer optionsLock.RUnlock()
 
 	for _, opt := range options {
 		if err := fn(opt); err != nil {
@@ -29,6 +29,20 @@ func ForEachOption(fn func(opt *Option) error) error {
 	return nil
 }
 
+// GetOption returns the option with name or an error
+// if the option does not exist. The caller should lock
+// the returned option itself for further processing.
+func GetOption(name string) (*Option, error) {
+	optionsLock.RLock()
+	defer optionsLock.RUnlock()
+
+	opt, ok := options[name]
+	if !ok {
+		return nil, fmt.Errorf("option %q does not exist", name)
+	}
+	return opt, nil
+}
+
 // Register registers a new configuration option.
 func Register(option *Option) error {
 	if option.Name == "" {

config/release.go

@@ -76,10 +76,6 @@ func registerReleaseLevelOption() {
 }
 
 func updateReleaseLevel() {
-	// check if already registered
-	if !releaseLevelOptionFlag.IsSet() {
-		return
-	}
 	// get value
 	value := releaseLevelOption.activeFallbackValue
 	if releaseLevelOption.activeValue != nil {

config/set.go

@@ -26,11 +26,9 @@ func getValidityFlag() *abool.AtomicBool {
 	return validityFlag
 }
 
+// signalChanges marks the configs validtityFlag as dirty and eventually
+// triggers a config change event.
 func signalChanges() {
-	// refetch and save release level and expertise level
-	updateReleaseLevel()
-	updateExpertiseLevel()
-
 	// reset validity flag
 	validityFlagLock.Lock()
 	validityFlag.SetTo(false)
@@ -40,14 +38,20 @@ func signalChanges() {
 	module.TriggerEvent(configChangeEvent, nil)
 }
 
-// setConfig sets the (prioritized) user defined config.
-func setConfig(newValues map[string]interface{}) error {
+// replaceConfig sets the (prioritized) user defined config.
+func replaceConfig(newValues map[string]interface{}) error {
 	var firstErr error
 	var errCnt int
 
-	optionsLock.Lock()
+	// RLock the options because we are not adding or removing
+	// options from the registration but rather only update the
+	// options value which is guarded by the option's lock itself
+	optionsLock.RLock()
+	defer optionsLock.RUnlock()
+
 	for key, option := range options {
 		newValue, ok := newValues[key]
+
 		option.Lock()
 		option.activeValue = nil
 		if ok {
@@ -61,12 +65,12 @@ func setConfig(newValues map[string]interface{}) error {
 				}
 			}
 		}
+
+		handleOptionUpdate(option, true)
 		option.Unlock()
 	}
-	optionsLock.Unlock()
 
 	signalChanges()
-	go pushFullUpdate()
 
 	if firstErr != nil {
 		if errCnt > 0 {
@@ -78,14 +82,20 @@ func setConfig(newValues map[string]interface{}) error {
 	return nil
 }
 
-// SetDefaultConfig sets the (fallback) default config.
-func SetDefaultConfig(newValues map[string]interface{}) error {
+// replaceDefaultConfig sets the (fallback) default config.
+func replaceDefaultConfig(newValues map[string]interface{}) error {
 	var firstErr error
 	var errCnt int
 
-	optionsLock.Lock()
+	// RLock the options because we are not adding or removing
+	// options from the registration but rather only update the
+	// options value which is guarded by the option's lock itself
+	optionsLock.RLock()
+	defer optionsLock.RUnlock()
+
 	for key, option := range options {
 		newValue, ok := newValues[key]
+
 		option.Lock()
 		option.activeDefaultValue = nil
 		if ok {
@@ -99,12 +109,11 @@ func SetDefaultConfig(newValues map[string]interface{}) error {
 				}
 			}
 		}
+		handleOptionUpdate(option, true)
 		option.Unlock()
 	}
-	optionsLock.Unlock()
 
 	signalChanges()
-	go pushFullUpdate()
 
 	if firstErr != nil {
 		if errCnt > 0 {
@@ -122,11 +131,9 @@ func SetConfigOption(key string, value interface{}) error {
 }
 
 func setConfigOption(key string, value interface{}, push bool) (err error) {
-	optionsLock.Lock()
-	option, ok := options[key]
-	optionsLock.Unlock()
-	if !ok {
-		return fmt.Errorf("config option %s does not exist", key)
+	option, err := GetOption(key)
+	if err != nil {
+		return err
 	}
 
 	option.Lock()
@@ -139,16 +146,17 @@ func setConfigOption(key string, value interface{}, push bool) (err error) {
 			option.activeValue = valueCache
 		}
 	}
+
+	handleOptionUpdate(option, push)
 	option.Unlock()
+
 	if err != nil {
 		return err
 	}
 
 	// finalize change, activate triggers
 	signalChanges()
-	if push {
-		go pushUpdate(option)
-	}
+
 	return saveConfig()
 }
 
@@ -158,11 +166,9 @@ func SetDefaultConfigOption(key string, value interface{}) error {
 }
 
 func setDefaultConfigOption(key string, value interface{}, push bool) (err error) {
-	optionsLock.Lock()
-	option, ok := options[key]
-	optionsLock.Unlock()
-	if !ok {
-		return fmt.Errorf("config option %s does not exist", key)
+	option, err := GetOption(key)
+	if err != nil {
+		return err
 	}
 
 	option.Lock()
@@ -175,15 +181,16 @@ func setDefaultConfigOption(key string, value interface{}, push bool) (err error
 			option.activeDefaultValue = valueCache
 		}
 	}
+
+	handleOptionUpdate(option, push)
 	option.Unlock()
+
 	if err != nil {
 		return err
 	}
 
 	// finalize change, activate triggers
 	signalChanges()
-	if push {
-		go pushUpdate(option)
-	}
+
 	return saveConfig()
 }

config/set_test.go

@@ -24,7 +24,7 @@ func TestLayersGetters(t *testing.T) {
 		t.Fatal(err)
 	}
 
-	err = setConfig(mapData)
+	err = replaceConfig(mapData)
 	if err != nil {
 		t.Fatal(err)
 	}

config/validate.go

@@ -62,6 +62,8 @@ func isAllowedPossibleValue(opt *Option, value interface{}) error {
 	return fmt.Errorf("value is not allowed")
 }
 
+// validateValue ensures that value matches the expected type of option.
+// It does not create a copy of the value!
 func validateValue(option *Option, value interface{}) (*valueCache, error) { //nolint:gocyclo
 	if option.OptType != OptTypeStringArray {
 		if err := isAllowedPossibleValue(option, value); err != nil {