// MIT License // // Copyright (c) 2023-2025 Advanced Micro Devices, Inc. // // 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. // #include "output_key.hpp" #include "format_path.hpp" #include "lib/common/environment.hpp" #include "lib/common/filesystem.hpp" #include "lib/common/utility.hpp" #include #include #include #include namespace rocprofiler { namespace tool { namespace { namespace fs = common::filesystem; template auto as_pointer(Tp&& _val) { return new Tp{_val}; } std::string* get_local_datetime(const std::string& dt_format, std::time_t*& dt_curr); std::time_t* launch_time = nullptr; const auto* launch_clock = as_pointer(std::chrono::system_clock::now()); const auto* launch_datetime = get_local_datetime(common::get_env("ROCPROF_TIME_FORMAT", "%F_%H.%M"), launch_time); const auto* launch_date = get_local_datetime(common::get_env("ROCPROF_DATE_FORMAT", "%F"), launch_time); std::string* get_local_datetime(const std::string& dt_format, std::time_t*& _dt_curr) { constexpr auto strsize = 512; if(!_dt_curr) _dt_curr = new std::time_t{std::time_t{std::time(nullptr)}}; char mbstr[strsize] = {}; memset(mbstr, '\0', sizeof(mbstr) * sizeof(char)); struct tm tm_struct; if(std::strftime( mbstr, sizeof(mbstr) - 1, dt_format.c_str(), localtime_r(_dt_curr, &tm_struct)) != 0) return new std::string{mbstr}; return nullptr; } bool not_is_space(int ch) { return std::isspace(ch) == 0; } std::string ltrim(std::string s, bool (*f)(int) = not_is_space) { s.erase(s.begin(), std::find_if(s.begin(), s.end(), f)); return s; } std::string rtrim(std::string s, bool (*f)(int) = not_is_space) { s.erase(std::find_if(s.rbegin(), s.rend(), f).base(), s.end()); return s; } std::string trim(std::string s, bool (*f)(int) = not_is_space) { ltrim(s, f); rtrim(s, f); return s; } std::string get_hostname() { auto _hostname_buff = std::array{}; _hostname_buff.fill('\0'); if(gethostname(_hostname_buff.data(), _hostname_buff.size() - 1) != 0) { auto _err = errno; ROCP_WARNING << "Hostname unknown. gethostname failed with error code " << _err << ": " << strerror(_err); return std::string{"UNKNOWN_HOSTNAME"}; } return std::string{_hostname_buff.data()}; } std::vector get_siblings(pid_t _id = getppid()) { auto _data = std::vector{}; auto _ifs = std::ifstream{"/proc/" + std::to_string(_id) + "/task/" + std::to_string(_id) + "/children"}; while(_ifs) { pid_t _n = 0; _ifs >> _n; if(!_ifs || _n <= 0) break; _data.emplace_back(_n); } return _data; } auto get_num_siblings(pid_t _id = getppid()) { return get_siblings(_id).size(); } } // namespace output_key::output_key(std::string _key, std::string _val, std::string _desc) : key{std::move(_key)} , value{std::move(_val)} , description{std::move(_desc)} {} std::vector output_keys(std::string _tag) { using strpair_t = std::pair; auto _cmdline = common::read_command_line(getpid()); if(_tag.empty() && !_cmdline.empty()) _tag = ::basename(_cmdline.front().c_str()); std::string _argv_string = {}; // entire argv cmd std::string _args_string = {}; // cmdline args std::string _argt_string = _tag; // prefix + cmdline args const std::string& _tag0_string = _tag; // only the basic prefix auto _options = std::vector{}; auto _replace = [](auto& _v, const strpair_t& pitr) { auto pos = std::string::npos; while((pos = _v.find(pitr.first)) != std::string::npos) _v.replace(pos, pitr.first.length(), pitr.second); }; if(_cmdline.size() > 1 && _cmdline.at(1) == "--") _cmdline.erase(_cmdline.begin() + 1); for(auto& itr : _cmdline) { itr = trim(itr); _replace(itr, {"/", "_"}); while(!itr.empty() && itr.at(0) == '.') itr = itr.substr(1); while(!itr.empty() && itr.at(0) == '_') itr = itr.substr(1); } if(!_cmdline.empty()) { for(size_t i = 0; i < _cmdline.size(); ++i) { const auto _l = std::string{(i == 0) ? "" : "_"}; auto _v = _cmdline.at(i); _argv_string += _l + _v; if(i > 0) { _argt_string += (i > 1) ? (_l + _v) : _v; _args_string += (i > 1) ? (_l + _v) : _v; } } } auto _mpi_size = get_mpi_size(); auto _mpi_rank = get_mpi_rank(); auto _dmp_size = fmt::format("{}", (_mpi_size) > 0 ? _mpi_size : 1); auto _dmp_rank = fmt::format("{}", (_mpi_rank) > 0 ? _mpi_rank : 0); auto _proc_id = fmt::format("{}", getpid()); auto _parent_id = fmt::format("{}", getppid()); auto _pgroup_id = fmt::format("{}", getpgid(getpid())); auto _session_id = fmt::format("{}", getsid(getpid())); auto _proc_size = fmt::format("{}", get_num_siblings()); auto _pwd_string = common::get_env("PWD", "."); auto _slurm_job_id = common::get_env("SLURM_JOB_ID", "0"); auto _slurm_proc_id = common::get_env("SLURM_PROCID", _dmp_rank); auto _uniq_id = _proc_id; if(common::get_env("SLURM_PROCID", -1) >= 0) { _uniq_id = _slurm_proc_id; } else if(_mpi_size > 0 || _mpi_rank >= 0) { _uniq_id = _dmp_rank; } for(auto&& itr : std::initializer_list{ {"argv", _argv_string, "Entire command-line condensed into a single string"}, {"argt", _argt_string, "Similar to `%argv%` except basename of first command line argument"}, {"args", _args_string, "All command line arguments condensed into a single string"}, {"tag", _tag0_string, "Basename of first command line argument"}}) { _options.emplace_back(fmt::format("%{}%", itr.key), itr.value, itr.description); _options.emplace_back(fmt::format("{}{}{}", '{', itr.key, '}'), itr.value, itr.description); } if(!_cmdline.empty()) { for(size_t i = 0; i < _cmdline.size(); ++i) { auto _v = _cmdline.at(i); auto itr = output_key{fmt::format("arg{}", i), _v, fmt::format("Argument #{}", i)}; _options.emplace_back(fmt::format("%{}%", itr.key), itr.value, itr.description); _options.emplace_back( fmt::format("{}{}{}", '{', itr.key, '}'), itr.value, itr.description); } } auto _launch_time = (launch_datetime) ? *launch_datetime : std::string{".UNKNOWN_LAUNCH_TIME."}; auto _launch_date = (launch_date) ? *launch_date : std::string{".UNKNOWN_LAUNCH_DATE."}; auto _hostname = get_hostname(); for(auto&& itr : std::initializer_list{ {"hostname", _hostname, "Network hostname"}, {"pid", _proc_id, "Process identifier"}, {"ppid", _parent_id, "Parent process identifier"}, {"pgid", _pgroup_id, "Process group identifier"}, {"psid", _session_id, "Process session identifier"}, {"psize", _proc_size, "Number of sibling process"}, {"job", _slurm_job_id, "SLURM_JOB_ID env variable"}, {"rank", _slurm_proc_id, "MPI/UPC++ rank"}, {"size", _dmp_size, "MPI/UPC++ size"}, {"nid", _uniq_id, "%rank% if possible, otherwise %pid%"}, {"cwd", fs::current_path().string(), "Current working path"}, {"launch_date", _launch_date, "Date according to date format ROCPROF_DATE_FORMAT"}, {"launch_time", _launch_time, "Date and/or time according to ROCPROF_TIME_FORMAT"}, }) { _options.emplace_back(fmt::format("%{}%", itr.key), itr.value, itr.description); _options.emplace_back(fmt::format("{}{}{}", '{', itr.key, '}'), itr.value, itr.description); } for(auto&& itr : std::initializer_list{ {"%h", _hostname, "Shorthand for %hostname%"}, {"%p", _proc_id, "Shorthand for %pid%"}, {"%j", _slurm_job_id, "Shorthand for %job%"}, {"%r", _slurm_proc_id, "Shorthand for %rank%"}, {"%s", _dmp_size, "Shorthand for %size"}, }) { _options.emplace_back(itr); } return _options; } } // namespace tool } // namespace rocprofiler