// SPDX-License-Identifier: MIT // Copyright (c) 2024-2025, Advanced Micro Devices, Inc. All rights reserved. #pragma once #ifndef CK_CODE_GEN_RTC #include #include #include #include #include namespace ck { namespace internal { template struct ParseEnvVal { }; template <> struct ParseEnvVal { static bool parse_env_var_value(const char* vp) { std::string value_env_str{vp}; for(auto& c : value_env_str) { if(std::isalpha(c) != 0) { c = std::tolower(static_cast(c)); } } if(value_env_str == "disable" || value_env_str == "disabled" || value_env_str == "0" || value_env_str == "no" || value_env_str == "off" || value_env_str == "false") { return false; } else if(value_env_str == "enable" || value_env_str == "enabled" || value_env_str == "1" || value_env_str == "yes" || value_env_str == "on" || value_env_str == "true") { return true; } else { throw std::runtime_error("Invalid value for env variable"); } return false; // shouldn't reach here } }; // Supports hexadecimals (with leading "0x"), octals (if prefix is "0") and decimals (default). // Returns 0 if environment variable is in wrong format (strtoull fails to parse the string). template <> struct ParseEnvVal { static uint64_t parse_env_var_value(const char* vp) { return std::strtoull(vp, nullptr, 0); } }; template <> struct ParseEnvVal { static std::string parse_env_var_value(const char* vp) { return std::string{vp}; } }; template struct EnvVar { private: T value{}; bool is_unset = true; public: const T& GetValue() const { return value; } bool IsUnset() const { return is_unset; } void Unset() { is_unset = true; } void UpdateValue(const T& val) { is_unset = false; value = val; } explicit EnvVar(const char* const name, const T& def_val) { // NOLINTNEXTLINE (concurrency-mt-unsafe) const char* vp = std::getenv(name); if(vp != nullptr) // a value was provided { is_unset = false; value = ParseEnvVal::parse_env_var_value(vp); } else // no value provided, use default value { value = def_val; } } }; } // end namespace internal // static inside function hides the variable and provides // thread-safety/locking // Used in global namespace #define CK_DECLARE_ENV_VAR(name, type, default_val) \ namespace ck::env { \ struct name \ { \ static_assert(std::is_same_v, \ "CK_DECLARE_ENV* must be used in the global namespace"); \ using value_type = type; \ static ck::internal::EnvVar& Ref() \ { \ static ck::internal::EnvVar var{#name, default_val}; \ return var; \ } \ }; \ } #define CK_DECLARE_ENV_VAR_BOOL(name) CK_DECLARE_ENV_VAR(name, bool, false) #define CK_DECLARE_ENV_VAR_UINT64(name) CK_DECLARE_ENV_VAR(name, uint64_t, 0) #define CK_DECLARE_ENV_VAR_STR(name) CK_DECLARE_ENV_VAR(name, std::string, "") #define CK_ENV(name) \ ck::env::name {} template inline const std::string& EnvGetString(EnvVar) { static_assert(std::is_same_v); return EnvVar::Ref().GetValue(); } template inline bool EnvIsEnabled(EnvVar) { static_assert(std::is_same_v); return !EnvVar::Ref().IsUnset() && EnvVar::Ref().GetValue(); } template inline bool EnvIsDisabled(EnvVar) { static_assert(std::is_same_v); return !EnvVar::Ref().IsUnset() && !EnvVar::Ref().GetValue(); } template inline uint64_t EnvValue(EnvVar) { static_assert(std::is_same_v); return EnvVar::Ref().GetValue(); } template inline bool EnvIsUnset(EnvVar) { return EnvVar::Ref().IsUnset(); } template void EnvUnset(EnvVar) { EnvVar::Ref().Unset(); } /// updates the cached value of an environment variable template void UpdateEnvVar(EnvVar, const ValueType& val) { static_assert(std::is_same_v); EnvVar::Ref().UpdateValue(val); } template void UpdateEnvVar(EnvVar, const std::string_view& val) { EnvVar::Ref().UpdateValue( ck::internal::ParseEnvVal::parse_env_var_value(val.data())); } } // namespace ck // environment variable to enable logging: // export CK_LOGGING=ON or CK_LOGGING=1 or CK_LOGGING=ENABLED CK_DECLARE_ENV_VAR_BOOL(CK_LOGGING) #endif