1 files changed, 257 insertions, 0 deletions
diff --git a/src/inc/clrconfig.h b/src/inc/clrconfig.h
new file mode 100644
index 0000000000..2a6285d449
--- /dev/null
+++ b/src/inc/clrconfig.h
@@ -0,0 +1,257 @@
+//
+// Copyright (c) Microsoft. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+//
+// 
+// --------------------------------------------------------------------------------------------------
+// CLRConfig.h
+// 
+
+//
+// Unified method of accessing configuration values from environment variables, registry and config file(s).
+// This class replaces all GetConfigDWORD and GetConfigString methods in EEConfig and REGUTIL. To define a
+// flag, add an entry in the table in file:CLRConfigValues.h.
+// 
+// 
+// 
+// 
+// --------------------------------------------------------------------------------------------------
+
+
+#include "utilcode.h"
+#include "holder.h"
+#include "quirksapi.h"
+
+#ifndef __CLRConfig_h__
+#define __CLRConfig_h__
+
+class CLRConfig
+{
+public:
+    // 
+    // Types
+    // 
+
+    // Setting each option results in some change to the config value lookup method. Default behavior is (in
+    // the following order):
+    // * Look at environment variables (prepending COMPLUS_ to the name)
+    // * Look at the framework registry keys (HKCU\Software\Microsoft\.NETFramework then
+    //     HKLM\Software\Microsoft\.NETFramework)
+    // * Look at the available config files (system, application, host and user). For details see TODO:
+    //     Link to BOTR documentation
+    enum LookupOptions {
+        // If set, don't look in environment variables.
+        IgnoreEnv = 0x1, 
+        // If set, do not prepend "COMPLUS_" when doing environment variable lookup.
+        DontPrependCOMPLUS_ = 0x2, 
+        // If set, don't look in HKLM in the registry.
+        IgnoreHKLM = 0x4, 
+        // If set, don't look in HKCU in the registry.
+        IgnoreHKCU = 0x8, 
+        // If set, don't look in any config files
+        IgnoreConfigFiles = 0x10, 
+        // If set, look in config file(s) before looking in env/registry.
+        FavorConfigFile = 0x20, 
+        // If set, look only in the system config file, ignoring other config files. 
+        // (This option does not affect environment variable and registry lookups)
+        ConfigFile_SystemOnly = 0x40, 
+        // If set, reverse the order of config file lookups (application config file first). 
+        // (This option does not affect environment variable and registry lookups)
+        ConfigFile_ApplicationFirst = 0x80, 
+        // Remove any whitespace at beginning and end of value.  (Only applicable for
+        // *string* configuration values.)
+        TrimWhiteSpaceFromStringValue = 0x100,
+        // If set, check whether a PerformanceDefault is active for this value before using the built-in default
+        MayHavePerformanceDefault = 0x200,
+
+        // Legacy REGUTIL-style lookup.
+        REGUTIL_default = IgnoreConfigFiles,
+        // Legacy EEConfig-style lookup.
+        EEConfig_default = 0,
+
+        // If set, Ignore windows quirk DB lookup
+        IgnoreWindowsQuirkDB = 0x400,
+    };
+
+    // Function pointer definition used for calling EEConfig::GetConfigValueCallback .
+    typedef HRESULT (* GetConfigValueFunction)
+        (__in_z LPCWSTR /*pKey*/, __deref_out_opt LPCWSTR* /*value*/, BOOL /*systemOnly*/, BOOL /*applicationFirst*/);
+
+    // Function pointer definition used for calling PerformanceDefaults::LookupConfigValue
+    typedef BOOL (* GetPerformanceDefaultValueFunction)
+        (LPCWSTR /*name*/, DWORD* /*pValue*/);
+
+    // Struct used to store information about where/how to find a Config DWORD.
+    // NOTE: Please do NOT create instances of this struct. Use the macros in file:CLRConfigValues.h instead.
+    typedef struct ConfigDWORDInfo 
+    {
+        LPCWSTR name;
+        DWORD defaultValue;
+        LookupOptions options;
+    } ConfigDWORDInfo;
+
+    // Struct used to store information about where/how to find a Config String.
+    // NOTE: Please do NOT create instances of this struct. Use the macros in file:CLRConfigValues.h instead.
+    typedef struct ConfigStringInfo
+    {
+        LPCWSTR name;
+        LookupOptions options;
+    } ConfigStringInfo;
+    
+    // 
+    // Declaring structs using the macro table in CLRConfigValues.h
+    // 
+    
+    // These macros declare ConfigDWORDInfo structs.
+    #define RETAIL_CONFIG_DWORD_INFO(symbol, name, defaultValue, description) \
+        static const ConfigDWORDInfo symbol;
+    #define RETAIL_CONFIG_DWORD_INFO_EX(symbol, name, defaultValue, description, lookupOptions) \
+        static const ConfigDWORDInfo symbol;
+    
+    // These macros declare ConfigStringInfo structs.
+    #define RETAIL_CONFIG_STRING_INFO(symbol, name, description) \
+        static const ConfigStringInfo symbol;
+    #define RETAIL_CONFIG_STRING_INFO_EX(symbol, name, description, lookupOptions) \
+        static const ConfigStringInfo symbol;
+
+    // TEMPORARY macros that declare strings. These are used for config value accesses that haven't been
+    // moved over to CLRConfig yet. Once all accesses have been moved, these macros (and corresponding
+    // instantiations in file:../utilcode/CLRConfig.cpp) should be removed.
+    #define RETAIL_CONFIG_DWORD_INFO_DIRECT_ACCESS(symbol, name, description) \
+        static const LPCWSTR symbol;
+    #define RETAIL_CONFIG_STRING_INFO_DIRECT_ACCESS(symbol, name, description) \
+        static const LPCWSTR symbol;        
+
+    // 
+    // Debug versions of the macros
+    // 
+#ifdef _DEBUG
+    #define CONFIG_DWORD_INFO(symbol, name, defaultValue, description) \
+        static const ConfigDWORDInfo symbol;
+    #define CONFIG_DWORD_INFO_EX(symbol, name, defaultValue, description, lookupOptions) \
+        static const ConfigDWORDInfo symbol;    
+    #define CONFIG_STRING_INFO(symbol, name, description) \
+        static const ConfigStringInfo symbol;
+    #define CONFIG_STRING_INFO_EX(symbol, name, description, lookupOptions) \
+        static const ConfigStringInfo symbol;
+    #define CONFIG_DWORD_INFO_DIRECT_ACCESS(symbol, name, description) \
+        static const LPCWSTR symbol;
+    #define CONFIG_STRING_INFO_DIRECT_ACCESS(symbol, name, description) \
+        static const LPCWSTR symbol;
+#else
+    #define CONFIG_DWORD_INFO(symbol, name, defaultValue, description) 
+    #define CONFIG_DWORD_INFO_EX(symbol, name, defaultValue, description, lookupOptions) 
+    #define CONFIG_STRING_INFO(symbol, name, description) 
+    #define CONFIG_STRING_INFO_EX(symbol, name, description, lookupOptions) 
+    #define CONFIG_DWORD_INFO_DIRECT_ACCESS(symbol, name, description)
+    #define CONFIG_STRING_INFO_DIRECT_ACCESS(symbol, name, description) 
+#endif // _DEBUG
+        // Now that we have defined what what the macros in file:CLRConfigValues.h mean, include it to generate the code.
+        #include "clrconfigvalues.h"
+
+    #undef RETAIL_CONFIG_DWORD_INFO
+    #undef RETAIL_CONFIG_STRING_INFO
+    #undef RETAIL_CONFIG_DWORD_INFO_EX
+    #undef RETAIL_CONFIG_STRING_INFO_EX    
+    #undef RETAIL_CONFIG_DWORD_INFO_DIRECT_ACCESS
+    #undef RETAIL_CONFIG_STRING_INFO_DIRECT_ACCESS
+    #undef CONFIG_DWORD_INFO
+    #undef CONFIG_STRING_INFO
+    #undef CONFIG_DWORD_INFO_EX
+    #undef CONFIG_STRING_INFO_EX    
+    #undef CONFIG_DWORD_INFO_DIRECT_ACCESS
+    #undef CONFIG_STRING_INFO_DIRECT_ACCESS
+
+    // 
+    // Methods to do config value (DWORD and String) lookups.
+    // 
+#ifdef FEATURE_WIN_DB_APPCOMPAT    
+    static HRESULT getQuirkEnabledAndValueFromWinDB(LPCWSTR wszQuirkName, BOOL* isEnabled, CPT_QUIRK_DATA* quirkData);
+#endif
+    static BOOL IsConfigEnabled(const ConfigDWORDInfo & info);
+
+    // Look up a DWORD config value.
+    static DWORD GetConfigValue(const ConfigDWORDInfo & info);
+    
+    // Look up a string config value.
+    // You own the string that's returned.
+    static LPWSTR GetConfigValue(const ConfigStringInfo & info);
+    
+    // Look up a string config value, passing it out through a pointer reference. Reports out of memory
+    // errors (HRESULT E_OUTOFMEMORY). 
+    // You own the string that's returned.
+    static HRESULT GetConfigValue(const ConfigStringInfo & info, __deref_out_z LPWSTR * outVal);
+
+    //
+    // Check whether an option is specified (e.g. explicitly listed) in any of the CLRConfig
+    // locations: environment or registry (with or without COMPLUS_) or any config file.
+    // The result is therefore a conservative approximation (some settings do not actually
+    // take effect everywhere and no setting is valid both with and without COMPLUS_)
+    //
+    static BOOL IsConfigOptionSpecified(LPCWSTR name);
+
+    // Free a string returned by GetConfigValue
+    static void   FreeConfigString(__in __in_z LPWSTR name);
+
+    // Register EEConfig's GetConfigValueCallback function so CLRConfig can look in config files. 
+    static void RegisterGetConfigValueCallback(GetConfigValueFunction func);
+
+    // Register PerformanceDefaults' LookupConfigValue so CLRConfig can support 'MayHavePerformanceDefault' values
+    static void RegisterGetPerformanceDefaultValueCallback(GetPerformanceDefaultValueFunction func);
+
+#ifdef FEATURE_WIN_DB_APPCOMPAT
+    static void RegisterWinDbQuirkApis(PFN_CptQuirkIsEnabled3 func1, PFN_CptQuirkGetData2 func2);
+#endif // FEATURE_WIN_DB_APPCOMPAT
+
+    
+private:
+    // Function pointer to EEConfig's GetConfigValueCallback function (can't static bind from utilcode to VM)
+    static GetConfigValueFunction s_GetConfigValueCallback;
+
+    // Function pointer to PerformanceDefaults' LookupConfigValue function (can't static bind from utilcode to VM)
+    static GetPerformanceDefaultValueFunction s_GetPerformanceDefaultValueCallback;
+
+#ifdef FEATURE_WIN_DB_APPCOMPAT
+    static PFN_CptQuirkIsEnabled3 s_IsQuirkEnabledCallback;
+    static PFN_CptQuirkGetData2 s_GetQuirkValueCallback;
+#endif // FEATURE_WIN_DB_APPCOMPAT
+    
+    // Helper method to translate LookupOptions to REGUTIL::CORConfigLevel
+    static REGUTIL::CORConfigLevel GetConfigLevel(LookupOptions options);
+
+    // 
+    // Helper methods.
+    // 
+    
+    // Helper method to check if a certain option is set in a ConfigDWORDInfo struct.
+    static inline BOOL CheckLookupOption(const ConfigDWORDInfo & info, LookupOptions option)
+    {
+        LIMITED_METHOD_CONTRACT;
+        return ((info.options & option) == option) ? TRUE : FALSE;
+    }
+
+    // Helper method to check if a certain option is set in a ConfigStringInfo struct.
+    static inline BOOL CheckLookupOption(const ConfigStringInfo & info, LookupOptions option)
+    {
+        LIMITED_METHOD_CONTRACT;
+        return ((info.options & option) == option) ? TRUE : FALSE;
+    }
+
+    // Helper method to check if a certain option is set in an options enum.
+    static inline BOOL CheckLookupOption(LookupOptions infoOptions, LookupOptions optionToCheck)
+    {
+        LIMITED_METHOD_CONTRACT;
+        return ((infoOptions & optionToCheck) == optionToCheck) ? TRUE : FALSE;
+    }
+
+    static HRESULT TrimWhiteSpace(LPCWSTR wszOrig, __deref_out_z LPWSTR * pwszTrimmed);
+};
+
+inline CLRConfig::LookupOptions operator|(CLRConfig::LookupOptions lhs, CLRConfig::LookupOptions rhs)
+{
+    return static_cast<CLRConfig::LookupOptions>(static_cast<DWORD>(lhs) | static_cast<DWORD>(rhs));
+}
+
+typedef Wrapper<LPWSTR, DoNothing, CLRConfig::FreeConfigString, NULL> CLRConfigStringHolder;
+
+#endif //__CLRConfig_h__