AI/rocm-systems
2
0
انشعاب 0
کد مسائل تقاضاهای واکشی Actions Packages پروژه‌ها انتشارها دانشنامه فعالیت
Files
b4e04b07ed0384d620735dbedf2596f526586e94
rocm-systems/projects/rocprofiler-systems/source/lib/common/environment.hpp
T
habajpai-amd b4e04b07ed test: add unit tests for common utilities from PR #1249 (#2237) 
* test: add unit tests for common utilities from PR #1249

* incorporate review comments specific to tests formatting

* use filesystem API instead of std::system for safer cleanup

* Add ghc/filesystem submodule v1.5.14 for portable C++17 filesystem support

* fix: add cmake/GhcFilesystem.cmake for CI submodule auto-checkout

* incorporate review comment

* incorporate review comment
2025-12-18 11:03:14 +05:30

348 خطوط
11 KiB
C++
خام سرزنش تاریخچه

// MIT License
//
// Copyright (c) 2022-2025 Advanced Micro Devices, Inc. All Rights Reserved.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
#pragma once
#include "common/defines.h"
#include "common/join.hpp"
#include <algorithm>
#include <cstdio>
#include <cstdlib>
#include <cstring>
#include <stdexcept>
#include <string>
#include <string_view>
#include <timemory/utility/filepath.hpp>
#include <type_traits>
#include <unistd.h>
#include <unordered_set>
#if !defined(ROCPROFSYS_ENVIRON_LOG_NAME)
# if defined(ROCPROFSYS_COMMON_LIBRARY_NAME)
# define ROCPROFSYS_ENVIRON_LOG_NAME "[" ROCPROFSYS_COMMON_LIBRARY_NAME "]"
# else
# define ROCPROFSYS_ENVIRON_LOG_NAME
# endif
#endif
#if !defined(ROCPROFSYS_ENVIRON_LOG_START)
# if defined(ROCPROFSYS_COMMON_LIBRARY_LOG_START)
# define ROCPROFSYS_ENVIRON_LOG_START ROCPROFSYS_COMMON_LIBRARY_LOG_START
# elif defined(TIMEMORY_LOG_COLORS_AVAILABLE)
# define ROCPROFSYS_ENVIRON_LOG_START \
fprintf(stderr, "%s", ::tim::log::color::info());
# else
# define ROCPROFSYS_ENVIRON_LOG_START
# endif
#endif
#if !defined(ROCPROFSYS_ENVIRON_LOG_END)
# if defined(ROCPROFSYS_COMMON_LIBRARY_LOG_END)
# define ROCPROFSYS_ENVIRON_LOG_END ROCPROFSYS_COMMON_LIBRARY_LOG_END
# elif defined(TIMEMORY_LOG_COLORS_AVAILABLE)
# define ROCPROFSYS_ENVIRON_LOG_END \
fprintf(stderr, "%s", ::tim::log::color::end());
# else
# define ROCPROFSYS_ENVIRON_LOG_END
# endif
#endif
#define ROCPROFSYS_ENVIRON_LOG(CONDITION, ...) \
if(CONDITION) \
{ \
fflush(stderr); \
ROCPROFSYS_ENVIRON_LOG_START \
fprintf(stderr, "[rocprof-sys]" ROCPROFSYS_ENVIRON_LOG_NAME "[%i] ", getpid()); \
fprintf(stderr, __VA_ARGS__); \
ROCPROFSYS_ENVIRON_LOG_END \
fflush(stderr); \
}
namespace rocprofsys
{
inline namespace common
{
namespace
{
inline std::string
get_env_impl(std::string_view env_id, std::string_view _default)
{
if(env_id.empty()) return std::string{ _default };
char* env_var = ::std::getenv(env_id.data());
if(env_var) return std::string{ env_var };
return std::string{ _default };
}
inline std::string
get_env_impl(std::string_view env_id, const char* _default)
{
return get_env_impl(env_id, std::string_view{ _default });
}
inline int
get_env_impl(std::string_view env_id, int _default)
{
if(env_id.empty()) return _default;
char* env_var = ::std::getenv(env_id.data());
if(env_var)
{
try
{
return std::stoi(env_var);
} catch(std::exception& _e)
{
fprintf(stderr,
"[rocprof-sys][get_env] Exception thrown converting getenv(\"%s\") = "
"%s to integer :: %s. Using default value of %i\n",
env_id.data(), env_var, _e.what(), _default);
}
return _default;
}
return _default;
}
inline bool
get_env_impl(std::string_view env_id, bool _default)
{
if(env_id.empty()) return _default;
char* env_var = ::std::getenv(env_id.data());
if(env_var)
{
if(std::string_view{ env_var }.empty())
throw std::runtime_error(std::string{ "No boolean value provided for " } +
std::string{ env_id });
if(std::string_view{ env_var }.find_first_not_of("0123456789") ==
std::string_view::npos)
{
return static_cast<bool>(std::stoi(env_var));
}
else
{
for(size_t i = 0; i < strlen(env_var); ++i)
env_var[i] = tolower(env_var[i]);
for(const auto& itr : { "off", "false", "no", "n", "f", "0" })
if(strcmp(env_var, itr) == 0) return false;
}
return true;
}
return _default;
}
} // namespace
template <typename Tp>
inline auto
get_env(std::string_view env_id, Tp&& _default)
{
if constexpr(std::is_enum<Tp>::value)
{
using Up = std::underlying_type_t<Tp>;
// cast to underlying type -> get_env -> cast to enum type
return static_cast<Tp>(get_env_impl(env_id, static_cast<Up>(_default)));
}
else
{
return get_env_impl(env_id, std::forward<Tp>(_default));
}
}
struct ROCPROFSYS_INTERNAL_API env_config
{
std::string env_name = {};
std::string env_value = {};
int override = 0;
auto operator()(bool _verbose = false) const
{
if(env_name.empty()) return -1;
ROCPROFSYS_ENVIRON_LOG(_verbose, "setenv(\"%s\", \"%s\", %i)\n", env_name.c_str(),
env_value.c_str(), override);
return setenv(env_name.c_str(), env_value.c_str(), override);
}
};
inline void
remove_env(std::vector<char*>& _environ, std::string_view _env_var,
const std::unordered_set<std::string>& _original_envs)
{
auto key = join("", _env_var, "=");
auto match = [&key](auto itr) -> bool {
return itr && std::string_view{ itr }.find(key) == 0;
};
// Free memory for matching entries
for(auto& itr : _environ)
{
if(match(itr))
{
free(itr);
itr = nullptr;
}
}
// Remove null entries
_environ.erase(std::remove_if(_environ.begin(), _environ.end(),
[](const char* ptr) { return ptr == nullptr; }),
_environ.end());
// Restore from original_envs if previously existed
for(const auto& orig : _original_envs)
{
if(std::string_view{ orig.data(), orig.size() }.find(key) == 0)
{
_environ.emplace_back(strdup(orig.c_str()));
}
}
}
inline std::string
discover_llvm_libdir_for_ompt(bool verbose = false)
{
auto strip = [](std::string s) {
if(!s.empty() && s.back() == '/') s.pop_back();
return s;
};
// Common ROCm envs
const auto rocm_dir = strip(get_env<std::string>("ROCM_PATH", "/opt/rocm"));
const auto rocmv_dir = strip(get_env<std::string>("ROCmVersion_DIR", ""));
std::vector<std::string> candidates;
candidates.reserve(6);
auto push_unique = [&](const std::string& p) {
if(p.empty()) return;
if(std::find(candidates.begin(), candidates.end(), p) == candidates.end())
candidates.emplace_back(p);
};
if(!rocmv_dir.empty())
{
push_unique(rocmv_dir + "/llvm/lib");
push_unique(rocmv_dir + "/lib");
}
push_unique(rocm_dir + "/llvm/lib");
push_unique(rocm_dir + "/lib/llvm/lib");
push_unique("/opt/rocm/llvm/lib");
push_unique("/opt/rocm/lib/llvm/lib");
auto has_libomptarget = [](const std::string& dir) {
const std::string so = dir + "/libomptarget.so";
return ::tim::filepath::exists(so);
};
// Pick the first candidate that contains libomptarget.so
auto it = std::find_if(candidates.begin(), candidates.end(), has_libomptarget);
if(it != candidates.end())
{
ROCPROFSYS_ENVIRON_LOG(verbose, "Using LLVM libdir: %s\n", it->c_str());
return *it;
}
ROCPROFSYS_ENVIRON_LOG(verbose,
"libomptarget.so not found in candidate LLVM libdirs\n");
return {};
}
enum class update_mode : uint8_t
{
REPLACE = 0,
PREPEND,
APPEND,
WEAK,
};
template <typename Tp>
inline std::string
to_env_string(Tp&& val)
{
using T = std::decay_t<Tp>;
static_assert(std::is_same_v<T, std::string> || std::is_same_v<T, const char*> ||
std::is_same_v<T, bool> || std::is_arithmetic_v<T>,
"to_env_string: unsupported type. Use string, bool, or numeric types.");
if constexpr(std::is_same_v<T, std::string> || std::is_same_v<T, const char*>)
return std::string{ val };
else if constexpr(std::is_same_v<T, bool>)
return val ? "true" : "false";
else
return std::to_string(val);
}
template <typename Tp>
inline void
update_env(std::vector<char*>& _environ, std::string_view _env_var, Tp&& _env_val,
update_mode _mode, std::string_view _join_delim,
std::unordered_set<std::string_view>& _updated_envs,
const std::unordered_set<std::string>& _original_envs)
{
_updated_envs.emplace(_env_var);
const bool _prepend = (_mode == update_mode::PREPEND);
const bool _append = (_mode == update_mode::APPEND);
const bool _weak_upd = (_mode == update_mode::WEAK);
auto _env_val_str = to_env_string(std::forward<Tp>(_env_val));
auto _key = join("", _env_var, "=");
for(auto& itr : _environ)
{
if(!itr) continue;
if(std::string_view{ itr }.find(_key) != 0) continue;
if(_weak_upd)
{
if(_original_envs.find(std::string{ itr }) == _original_envs.end()) return;
}
if(_prepend || _append)
{
if(std::string_view{ itr }.find(_env_val_str) == std::string_view::npos)
{
auto _val = std::string{ itr }.substr(_key.length());
free(itr);
if(_prepend)
itr =
strdup(join('=', _env_var, join(_join_delim, _env_val_str, _val))
.c_str());
else
itr =
strdup(join('=', _env_var, join(_join_delim, _val, _env_val_str))
.c_str());
}
}
else
{
free(itr);
itr = strdup(join('=', _env_var, _env_val_str).c_str());
}
return;
}
_environ.emplace_back(strdup(join('=', _env_var, _env_val_str).c_str()));
}
} // namespace common
} // namespace rocprofsys
مرجع در شماره جدید View Git Blame پرمالینک را کپی کنید