Move GlobalConfig.actor.h into GlobalConfig.h

documentation/sphinx/source/global-configuration.rst

@@ -79,7 +79,7 @@ Values must always be encoded according to the :ref:`api-python-tuple-layer`.
 
 .. code-block:: cpp
 
-   // In GlobalConfig.actor.h
+   // In GlobalConfig.h
    extern const KeyRef myGlobalConfigKey;
    // In GlobalConfig.cpp
    const KeyRef myGlobalConfigKey = "config/key"_sr;

fdbcli/ProfileCommand.cpp

@@ -22,7 +22,7 @@
 
 #include "fdbcli/fdbcli.h"
 
-#include "fdbclient/GlobalConfig.actor.h"
+#include "fdbclient/GlobalConfig.h"
 #include "fdbclient/FDBOptions.g.h"
 #include "fdbclient/IClientApi.h"
 #include "fdbclient/Knobs.h"

fdbcli/fdbcli.cpp

@@ -30,7 +30,7 @@
 #include "fdbclient/StatusClient.h"
 #include "fdbclient/StorageServerInterface.h"
 #include "fdbclient/DatabaseContext.h"
-#include "fdbclient/GlobalConfig.actor.h"
+#include "fdbclient/GlobalConfig.h"
 #include "fdbclient/IKnobCollection.h"
 #include "fdbclient/NativeAPI.actor.h"
 #include "fdbclient/ClusterInterface.h"

fdbclient/DatabaseContext.actor.cpp

@@ -53,7 +53,7 @@
 #include "fdbclient/CoordinationInterface.h"
 #include "fdbclient/CommitTransaction.h"
 #include "fdbclient/DatabaseContext.h"
-#include "fdbclient/GlobalConfig.actor.h"
+#include "fdbclient/GlobalConfig.h"
 #include "fdbclient/IKnobCollection.h"
 #include "fdbclient/JsonBuilder.h"
 #include "fdbclient/KeyBackedTypes.actor.h"

fdbclient/GlobalConfig.cpp

@@ -19,7 +19,7 @@
  */
 
 #include "fdbclient/DatabaseContext.h"
-#include "fdbclient/GlobalConfig.actor.h"
+#include "fdbclient/GlobalConfig.h"
 #include "fdbclient/SpecialKeySpace.actor.h"
 #include "fdbclient/SystemData.h"
 #include "fdbclient/Tuple.h"

fdbclient/NativeAPI.actor.cpp

@@ -52,7 +52,7 @@
 #include "fdbclient/CoordinationInterface.h"
 #include "fdbclient/CommitTransaction.h"
 #include "fdbclient/DatabaseContext.h"
-#include "fdbclient/GlobalConfig.actor.h"
+#include "fdbclient/GlobalConfig.h"
 #include "fdbclient/IKnobCollection.h"
 #include "fdbclient/JsonBuilder.h"
 #include "fdbclient/KeyBackedTypes.actor.h"

fdbclient/SpecialKeySpace.actor.cpp

@@ -33,7 +33,7 @@
 #include "fdbclient/FDBOptions.g.h"
 #include "fdbclient/Knobs.h"
 #include "fdbclient/ProcessInterface.h"
-#include "fdbclient/GlobalConfig.actor.h"
+#include "fdbclient/GlobalConfig.h"
 #include "fdbclient/SpecialKeySpace.actor.h"
 #include "flow/Arena.h"
 #include "flow/UnitTest.h"

fdbclient/SystemData.cpp

@@ -1293,7 +1293,7 @@ const KeyRef tagThrottleCountKey = "\xff\x02/throttledTags/manualThrottleCount"_
 
 // Client status info prefix
 const KeyRangeRef fdbClientInfoPrefixRange("\xff\x02/fdbClientInfo/"_sr, "\xff\x02/fdbClientInfo0"_sr);
-// See remaining fields in GlobalConfig.actor.h
+// See remaining fields in GlobalConfig.h
 
 // ConsistencyCheck settings
 const KeyRef fdbShouldConsistencyCheckBeSuspended = "\xff\x02/ConsistencyCheck/Suspend"_sr;

fdbclient/include/fdbclient/DatabaseContext.h

@@ -24,7 +24,7 @@
 #include "flow/ApiVersion.h"
 #include "flow/FastAlloc.h"
 #include "flow/FastRef.h"
-#include "fdbclient/GlobalConfig.actor.h"
+#include "fdbclient/GlobalConfig.h"
 #include "fdbclient/StorageServerInterface.h"
 #include "flow/IRandom.h"
 #include "flow/genericactors.actor.h"

fdbclient/include/fdbclient/GlobalConfig.actor.h

@@ -1,186 +0,0 @@
-/*
- * GlobalConfig.actor.h
- *
- * This source file is part of the FoundationDB open source project
- *
- * Copyright 2013-2026 Apple Inc. and the FoundationDB project authors
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-#pragma once
-
-#if defined(NO_INTELLISENSE) && !defined(FDBCLIENT_GLOBALCONFIG_ACTOR_G_H)
-#define FDBCLIENT_GLOBALCONFIG_ACTOR_G_H
-#include "fdbclient/GlobalConfig.actor.g.h"
-#elif !defined(FDBCLIENT_GLOBALCONFIG_ACTOR_H)
-#define FDBCLIENT_GLOBALCONFIG_ACTOR_H
-
-#include <any>
-#include <map>
-#include <optional>
-#include <type_traits>
-#include <unordered_map>
-
-#include "fdbclient/CommitProxyInterface.h"
-#include "fdbclient/GlobalConfig.h"
-#include "fdbclient/ReadYourWrites.h"
-
-#include "flow/actorcompiler.h" // has to be last include
-
-// The global configuration is a series of typed key-value pairs synced to all
-// nodes (server and client) in an FDB cluster in an eventually consistent
-// manner. Only small key-value pairs should be stored in global configuration;
-// an excessive amount of data can cause synchronization slowness.
-
-// Keys
-extern const KeyRef fdbClientInfoTxnSampleRate;
-extern const KeyRef fdbClientInfoTxnSizeLimit;
-
-extern const KeyRef transactionTagSampleRate;
-extern const KeyRef transactionTagSampleCost;
-
-extern const KeyRef samplingFrequency;
-extern const KeyRef samplingWindow;
-
-// Structure used to hold the values stored by global configuration. The arena
-// is used as memory to store both the key and the value (the value is only
-// stored in the arena if it is an object; primitives are just copied).
-struct ConfigValue : ReferenceCounted<ConfigValue> {
-	Arena arena;
-	std::any value;
-
-	ConfigValue() {}
-	ConfigValue(Arena&& a, std::any&& v) : arena(a), value(v) {}
-};
-
-class GlobalConfig : NonCopyable {
-public:
-	// Requires a database pointer to allow global configuration to run
-	// transactions on the database.
-	explicit GlobalConfig(DatabaseContext* cx);
-
-	// Requires an AsyncVar object to watch for changes on. The ClientDBInfo pointer
-	// should point to a ClientDBInfo object which will contain the updated
-	// global configuration history when the given AsyncVar changes. This
-	// function should be called whenever the database object changes, in order
-	// to allow global configuration to run transactions on the latest
-	// database.
-	template <class T>
-	void init(Reference<AsyncVar<T> const> db, const ClientDBInfo* dbInfo) {
-		_updater = updater(dbInfo);
-		// Bind changes in `db` to the `dbInfoChanged` AsyncTrigger.
-		// TODO: Change AsyncTrigger to a Reference
-		_forward = forward(db, std::addressof(dbInfoChanged));
-	}
-
-	// Given a list of insertions and clears, applies the necessary changes to
-	// the given transaction to update the global configuration keyspace. Keys
-	// in the list of mutations should not include the global configuration
-	// prefix (`\xff\xff/global_config/`). The caller must still commit the
-	// given transaction in order to persist the changes.
-	static void applyChanges(Transaction& tr,
-	                         const VectorRef<KeyValueRef>& insertions,
-	                         const VectorRef<KeyRangeRef>& clears);
-
-	// Use this function to turn a global configuration key defined above into
-	// the full path needed to set the value in the database.
-	//
-	// For example, given "config/a", returns "\xff\xff/global_config/config/a".
-	static Key prefixedKey(KeyRef key);
-
-	// Get a value from the framework. Values are returned as a ConfigValue
-	// reference which also contains the arena holding the object. As long as
-	// the caller keeps the ConfigValue reference, the value is guaranteed to
-	// be readable. An empty reference is returned if the value does not exist.
-	const Reference<ConfigValue> get(KeyRef name);
-	const std::map<KeyRef, Reference<ConfigValue>> get(KeyRangeRef range);
-
-	// For arithmetic value types, returns a copy of the value for the given
-	// key, or the supplied default value if the framework does not know about
-	// the key.
-	template <typename T, typename std::enable_if<std::is_arithmetic<T>{}, bool>::type = true>
-	const T get(KeyRef name, T defaultVal) {
-		try {
-			auto configValue = get(name);
-			if (configValue.isValid()) {
-				if (configValue->value.has_value()) {
-					return std::any_cast<T>(configValue->value);
-				}
-			}
-
-			return defaultVal;
-		} catch (Error& e) {
-			throw;
-		}
-	}
-
-	// Trying to write into the global configuration keyspace? To write data,
-	// submit a transaction to \xff\xff/global_config/<your-key> with
-	// <your-value> encoded using the FDB tuple typecodes. Use the helper
-	// function `prefixedKey` to correctly prefix your global configuration
-	// key.
-
-	// Triggers the returned future when the global configuration singleton has
-	// been created and is ready.
-	Future<Void> onInitialized();
-
-	// Triggers the returned future when any key-value pair in the global
-	// configuration changes.
-	Future<Void> onChange();
-
-	// Calls \ref fn when the value associated with \ref key is changed. \ref
-	// key should be one of the string literals defined at the top of
-	// GlobalConfig.cpp, to ensure memory validity. \ref fn is passed the
-	// updated value for the key, or an empty optional if the key has been
-	// cleared. If the value is an allocated object, its memory remains in the
-	// control of global configuration.
-	void trigger(KeyRef key, std::function<void(std::optional<std::any>)> fn);
-
-private:
-	// The functions below only affect the local copy of the global
-	// configuration keyspace! To insert or remove values across all nodes you
-	// must use a transaction (see the note above).
-
-	// Inserts the given key-value pair into the local copy of the global
-	// configuration keyspace, overwriting the old key-value pair if it exists.
-	// `value` must be encoded using the FDB tuple typecodes.
-	void insert(KeyRef key, ValueRef value);
-	// Removes the given key (and associated value) from the local copy of the
-	// global configuration keyspace.
-	void erase(Key key);
-	// Removes the given key range (and associated values) from the local copy
-	// of the global configuration keyspace.
-	void erase(KeyRangeRef range);
-
-	// Updates local copy of global configuration by reading the entire key-range
-	// from storage (proxied through the GrvProxies). Returns the version of the
-	// refreshed data.
-	Future<Version> refresh(Version lastKnown, Version largestSeen);
-	Future<Void> updater(const ClientDBInfo* dbInfo);
-
-	DatabaseContext* cx;
-	AsyncTrigger dbInfoChanged;
-	Future<Void> _forward;
-	Future<Void> _updater;
-	Promise<Void> initialized;
-	AsyncTrigger configChanged;
-	std::unordered_map<StringRef, Reference<ConfigValue>> data;
-	Version lastUpdate;
-	// The key should be a global config string literal key (see the top of this class).
-	std::unordered_map<KeyRef, std::function<void(std::optional<std::any>)>> callbacks;
-};
-
-#include "flow/unactorcompiler.h"
-
-#endif

fdbclient/include/fdbclient/GlobalConfig.h

@@ -20,8 +20,21 @@
 
 #pragma once
 
+#include <any>
+#include <functional>
+#include <map>
+#include <memory>
+#include <optional>
+#include <type_traits>
+#include <unordered_map>
+
 #include "fdbclient/CommitTransaction.h"
 #include "fdbclient/FDBTypes.h"
+#include "flow/genericactors.actor.h"
+
+class DatabaseContext;
+struct ClientDBInfo;
+class Transaction;
 
 // Used to store a list of mutations made to the global configuration at a
 // specific version.
@@ -43,3 +56,146 @@ struct VersionHistory {
 		serializer(ar, mutations, version);
 	}
 };
+
+// The global configuration is a series of typed key-value pairs synced to all
+// nodes (server and client) in an FDB cluster in an eventually consistent
+// manner. Only small key-value pairs should be stored in global configuration;
+// an excessive amount of data can cause synchronization slowness.
+
+// Keys
+extern const KeyRef fdbClientInfoTxnSampleRate;
+extern const KeyRef fdbClientInfoTxnSizeLimit;
+
+extern const KeyRef transactionTagSampleRate;
+extern const KeyRef transactionTagSampleCost;
+
+extern const KeyRef samplingFrequency;
+extern const KeyRef samplingWindow;
+
+// Structure used to hold the values stored by global configuration. The arena
+// is used as memory to store both the key and the value (the value is only
+// stored in the arena if it is an object; primitives are just copied).
+struct ConfigValue : ReferenceCounted<ConfigValue> {
+	Arena arena;
+	std::any value;
+
+	ConfigValue() {}
+	ConfigValue(Arena&& a, std::any&& v) : arena(a), value(v) {}
+};
+
+class GlobalConfig : NonCopyable {
+public:
+	// Requires a database pointer to allow global configuration to run
+	// transactions on the database.
+	explicit GlobalConfig(DatabaseContext* cx);
+
+	// Requires an AsyncVar object to watch for changes on. The ClientDBInfo pointer
+	// should point to a ClientDBInfo object which will contain the updated
+	// global configuration history when the given AsyncVar changes. This
+	// function should be called whenever the database object changes, in order
+	// to allow global configuration to run transactions on the latest
+	// database.
+	template <class T>
+	void init(Reference<AsyncVar<T> const> db, const ClientDBInfo* dbInfo) {
+		_updater = updater(dbInfo);
+		// Bind changes in `db` to the `dbInfoChanged` AsyncTrigger.
+		// TODO: Change AsyncTrigger to a Reference
+		_forward = forward(db, std::addressof(dbInfoChanged));
+	}
+
+	// Given a list of insertions and clears, applies the necessary changes to
+	// the given transaction to update the global configuration keyspace. Keys
+	// in the list of mutations should not include the global configuration
+	// prefix (`\xff\xff/global_config/`). The caller must still commit the
+	// given transaction in order to persist the changes.
+	static void applyChanges(Transaction& tr,
+	                         const VectorRef<KeyValueRef>& insertions,
+	                         const VectorRef<KeyRangeRef>& clears);
+
+	// Use this function to turn a global configuration key defined above into
+	// the full path needed to set the value in the database.
+	//
+	// For example, given "config/a", returns "\xff\xff/global_config/config/a".
+	static Key prefixedKey(KeyRef key);
+
+	// Get a value from the framework. Values are returned as a ConfigValue
+	// reference which also contains the arena holding the object. As long as
+	// the caller keeps the ConfigValue reference, the value is guaranteed to
+	// be readable. An empty reference is returned if the value does not exist.
+	const Reference<ConfigValue> get(KeyRef name);
+	const std::map<KeyRef, Reference<ConfigValue>> get(KeyRangeRef range);
+
+	// For arithmetic value types, returns a copy of the value for the given
+	// key, or the supplied default value if the framework does not know about
+	// the key.
+	template <typename T, typename std::enable_if<std::is_arithmetic<T>{}, bool>::type = true>
+	const T get(KeyRef name, T defaultVal) {
+		try {
+			auto configValue = get(name);
+			if (configValue.isValid()) {
+				if (configValue->value.has_value()) {
+					return std::any_cast<T>(configValue->value);
+				}
+			}
+
+			return defaultVal;
+		} catch (Error& e) {
+			throw;
+		}
+	}
+
+	// Trying to write into the global configuration keyspace? To write data,
+	// submit a transaction to \xff\xff/global_config/<your-key> with
+	// <your-value> encoded using the FDB tuple typecodes. Use the helper
+	// function `prefixedKey` to correctly prefix your global configuration
+	// key.
+
+	// Triggers the returned future when the global configuration singleton has
+	// been created and is ready.
+	Future<Void> onInitialized();
+
+	// Triggers the returned future when any key-value pair in the global
+	// configuration changes.
+	Future<Void> onChange();
+
+	// Calls \ref fn when the value associated with \ref key is changed. \ref
+	// key should be one of the string literals defined at the top of
+	// GlobalConfig.cpp, to ensure memory validity. \ref fn is passed the
+	// updated value for the key, or an empty optional if the key has been
+	// cleared. If the value is an allocated object, its memory remains in the
+	// control of global configuration.
+	void trigger(KeyRef key, std::function<void(std::optional<std::any>)> fn);
+
+private:
+	// The functions below only affect the local copy of the global
+	// configuration keyspace. To insert or remove values across all nodes you
+	// must use a transaction (see the note above).
+
+	// Inserts the given key-value pair into the local copy of the global
+	// configuration keyspace, overwriting the old key-value pair if it exists.
+	// `value` must be encoded using the FDB tuple typecodes.
+	void insert(KeyRef key, ValueRef value);
+	// Removes the given key (and associated value) from the local copy of the
+	// global configuration keyspace.
+	void erase(Key key);
+	// Removes the given key range (and associated values) from the local copy
+	// of the global configuration keyspace.
+	void erase(KeyRangeRef range);
+
+	// Updates local copy of global configuration by reading the entire key-range
+	// from storage (proxied through the GrvProxies). Returns the version of the
+	// refreshed data.
+	Future<Version> refresh(Version lastKnown, Version largestSeen);
+	Future<Void> updater(const ClientDBInfo* dbInfo);
+
+	DatabaseContext* cx;
+	AsyncTrigger dbInfoChanged;
+	Future<Void> _forward;
+	Future<Void> _updater;
+	Promise<Void> initialized;
+	AsyncTrigger configChanged;
+	std::unordered_map<StringRef, Reference<ConfigValue>> data;
+	Version lastUpdate;
+	// The key should be a global config string literal key (see the top of this file).
+	std::unordered_map<KeyRef, std::function<void(std::optional<std::any>)>> callbacks;
+};

fdbserver/clustercontroller/ClusterController.actor.cpp

@@ -54,7 +54,7 @@
 #include "SingletonRoles.h"
 #include "Status.h"
 #include "fdbserver/core/LatencyBandConfig.h"
-#include "fdbclient/GlobalConfig.actor.h"
+#include "fdbclient/GlobalConfig.h"
 #include "fdbserver/core/RecoveryState.h"
 #include "fdbclient/ReadYourWrites.h"
 #include "fdbrpc/Replication.h"

fdbserver/core/OpenDatabase.cpp

@@ -20,7 +20,7 @@
 
 #include "fdbclient/ActorLineageProfiler.h"
 #include "fdbclient/DatabaseContext.h"
-#include "fdbclient/GlobalConfig.actor.h"
+#include "fdbclient/GlobalConfig.h"
 #include "fdbclient/MonitorLeader.h"
 #include "fdbserver/core/WorkerInterface.actor.h"
 

fdbserver/worker.actor.cpp

@@ -29,7 +29,7 @@
 #include "flow/CodeProbe.h"
 #include "flow/IAsyncFile.h"
 #include "fdbrpc/Locality.h"
-#include "fdbclient/GlobalConfig.actor.h"
+#include "fdbclient/GlobalConfig.h"
 #include "fdbclient/ProcessInterface.h"
 #include "fdbclient/StorageServerInterface.h"
 #include "fdbclient/versions.h"

fdbserver/workloads/ClientMetric.cpp

@@ -20,7 +20,7 @@
 
 #include "fdbserver/core/workloads.actor.h"
 #include "fdbserver/core/ServerDBInfo.h"
-#include "fdbclient/GlobalConfig.actor.h"
+#include "fdbclient/GlobalConfig.h"
 #include "fdbclient/ManagementAPI.actor.h"
 #include "fdbclient/RunTransaction.actor.h"
 #include "fdbclient/Tuple.h"

fdbserver/workloads/ClientTransactionProfileCorrectness.cpp

@@ -20,7 +20,7 @@
 
 #include "fdbserver/core/workloads.actor.h"
 #include "fdbserver/core/ServerDBInfo.h"
-#include "fdbclient/GlobalConfig.actor.h"
+#include "fdbclient/GlobalConfig.h"
 #include "fdbclient/ManagementAPI.actor.h"
 #include "fdbclient/RunRYWTransaction.actor.h"
 #include "fdbclient/Tuple.h"

fdbserver/workloads/SpecialKeySpaceCorrectness.cpp

@@ -21,7 +21,7 @@
 #include "boost/lexical_cast.hpp"
 #include "boost/algorithm/string.hpp"
 
-#include "fdbclient/GlobalConfig.actor.h"
+#include "fdbclient/GlobalConfig.h"
 #include "fdbclient/ManagementAPI.actor.h"
 #include "fdbclient/NativeAPI.actor.h"
 #include "fdbclient/ReadYourWrites.h"