// 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. #include "rocprof-sys-run.hpp" #include "common/defines.h" #include "common/environment.hpp" #include "common/path.hpp" #include "core/argparse.hpp" #include "core/timemory.hpp" #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include namespace color = ::tim::log::color; namespace filepath = ::tim::filepath; // NOLINT namespace console = ::tim::utility::console; namespace argparse = ::tim::argparse; namespace signals = ::tim::signals; namespace path = rocprofsys::common::path; using settings = ::rocprofsys::settings; using namespace ::timemory::join; using ::tim::get_env; using ::tim::log::stream; namespace std { std::string to_string(bool _v) { return (_v) ? "true" : "false"; } } // namespace std namespace { using rocprofsys::common::update_mode; auto original_envs = std::unordered_set{}; int get_verbose(parser_data_t& _data) { auto& verbose = _data.verbose; verbose = get_env("ROCPROFSYS_CAUSAL_VERBOSE", get_env("ROCPROFSYS_VERBOSE", verbose, false)); auto _debug = get_env("ROCPROFSYS_CAUSAL_DEBUG", get_env("ROCPROFSYS_DEBUG", false, false)); if(_debug) verbose += 8; return verbose; } parser_data_t& get_initial_environment(parser_data_t& _data) { if(environ != nullptr) { int idx = 0; while(environ[idx] != nullptr) { auto* _v = environ[idx++]; _data.initial.emplace(_v); _data.current.emplace_back(strdup(_v)); original_envs.emplace(_v); } } auto _libexecpath = path::realpath(path::get_internal_script_path()); if(!_libexecpath.empty()) { rocprofsys::common::update_env(_data.current, "ROCPROFSYS_SCRIPT_PATH", _libexecpath, update_mode::REPLACE, ":", _data.updated, original_envs); } const bool verbose = (get_verbose(_data) > 0); if(auto llvm_dir = rocprofsys::common::discover_llvm_libdir_for_ompt(verbose); !llvm_dir.empty()) { rocprofsys::common::update_env(_data.current, "LD_LIBRARY_PATH", llvm_dir, update_mode::APPEND, ":", _data.updated, original_envs); auto current_ld = getenv("LD_LIBRARY_PATH"); std::string new_ld = current_ld ? (llvm_dir + ":" + current_ld) : llvm_dir; setenv("LD_LIBRARY_PATH", new_ld.c_str(), 1); } return _data; } auto toggle_suppression(std::tuple _inp) { auto _out = std::make_tuple(settings::suppress_config(), settings::suppress_parsing()); std::tie(settings::suppress_config(), settings::suppress_parsing()) = _inp; return _out; } // disable suppression when exe loads but store original values for restoration later auto initial_suppression = toggle_suppression({ true, true }); } // namespace void print_command(const parser_data_t& _data, std::string_view _prefix) { auto verbose = _data.verbose; const auto& _argv = _data.command; if(verbose >= 1) stream(std::cout, color::info()) << _prefix << "Executing '" << join(array_config{ " " }, _argv) << "'...\n"; std::cerr << color::end() << std::flush; } void prepare_command_for_run(char* _exe, parser_data_t& _data) { if(!_data.launcher.empty()) { bool _injected = false; auto _new_argv = std::vector{}; for(auto* itr : _data.command) { if(!_injected && std::regex_search(itr, std::regex{ _data.launcher })) { _new_argv.emplace_back(_exe); _new_argv.emplace_back(strdup("--")); _injected = true; } _new_argv.emplace_back(itr); } if(!_injected) { throw std::runtime_error( join("", "rocprof-sys-run was unable to match \"", _data.launcher, "\" to any arguments on the command line: \"", join(array_config{ " ", "", "" }, _data.command), "\"")); } std::swap(_data.command, _new_argv); } } void prepare_environment_for_run(parser_data_t& _data) { if(_data.launcher.empty()) { rocprofsys::argparse::add_ld_preload(_data); rocprofsys::argparse::add_ld_library_path(_data); } rocprofsys::argparse::add_torch_library_path(_data, _data.verbose > 0); rocprofsys::common::consolidate_env_entries(_data.current); } void print_updated_environment(parser_data_t& _data, std::string_view _prefix) { auto _verbose = get_verbose(_data); if(_verbose < 0) return; auto _env = _data.current; const auto& _updated_envs = _data.updated; std::sort(_env.begin(), _env.end(), [](auto* _lhs, auto* _rhs) { if(!_lhs) return false; if(!_rhs) return true; return std::string_view{ _lhs } < std::string_view{ _rhs }; }); std::vector _updates = {}; std::vector _general = {}; for(auto* itr : _env) { if(itr == nullptr) continue; auto _is_omni = (std::string_view{ itr }.find("ROCPROFSYS") == 0); auto _updated = false; for(const auto& vitr : _updated_envs) { if(std::string_view{ itr }.find(vitr) == 0) { _updated = true; break; } } if(_updated) _updates.emplace_back(itr); else if(_verbose >= 1 && _is_omni) _general.emplace_back(itr); } if(_general.size() + _updates.size() == 0 || _verbose < 0) return; std::cerr << std::endl; for(auto& itr : _general) stream(std::cerr, color::source()) << _prefix << itr << "\n"; for(auto& itr : _updates) stream(std::cerr, color::source()) << _prefix << itr << "\n"; std::cerr << color::end() << std::flush; } parser_data_t& parse_args(int argc, char** argv, parser_data_t& _parser_data, bool& _fork_exec) { using parser_t = argparse::argument_parser; using parser_err_t = typename parser_t::result_type; auto help_check = [](parser_t& p, int _argc, char** _argv) { std::unordered_set help_args = { "-h", "--help", "-?" }; return (p.exists("help") || _argc == 1 || (_argc > 1 && help_args.find(_argv[1]) != help_args.end())); }; auto _pec = EXIT_SUCCESS; auto help_action = [&_pec, argc, argv](parser_t& p) { if(_pec != EXIT_SUCCESS) { std::stringstream msg; msg << "Error in command:"; for(int i = 0; i < argc; ++i) msg << " " << argv[i]; msg << "\n\n"; stream(std::cerr, color::fatal()) << msg.str(); std::cerr << std::flush; } p.print_help(); exit(_pec); }; get_initial_environment(_parser_data); bool _do_parse_args = false; for(int i = 1; i < argc; ++i) { auto _arg = std::string_view{ argv[i] }; if(_arg == "--" || _arg == "-?" || _arg == "-h" || _arg == "--help" || _arg == "--version") _do_parse_args = true; } if(!_do_parse_args && argc > 1 && std::string_view{ argv[1] }.find('-') == 0) _do_parse_args = true; if(!_do_parse_args) return parse_command(argc, argv, _parser_data); toggle_suppression(initial_suppression); rocprofsys::argparse::init_parser(_parser_data); // no need for backtraces signals::disable_signal_detection(signals::signal_settings::get_enabled()); const auto* _desc = R"desc( Command line interface to rocprof-sys configuration. )desc"; auto parser = parser_t{ basename(argv[0]), _desc }; parser.on_error([](parser_t&, const parser_err_t& _err) { stream(std::cerr, color::fatal()) << _err << "\n"; exit(EXIT_FAILURE); }); parser.enable_help(); parser.enable_version("rocprof-sys-run", ROCPROFSYS_ARGPARSE_VERSION_INFO); auto _cols = std::get<0>(console::get_columns()); if(_cols > parser.get_help_width() + 8) parser.set_description_width( std::min(_cols - parser.get_help_width() - 8, 120)); // disable options related to causal profiling _parser_data.processed_groups.emplace("causal"); rocprofsys::argparse::add_core_arguments(parser, _parser_data); rocprofsys::argparse::add_extended_arguments(parser, _parser_data); parser.start_group("EXECUTION OPTIONS", ""); parser.add_argument({ "--fork" }, "Execute via fork + execvpe instead of execvpe") .min_count(0) .max_count(1) .dtype("boolean") .action([&](parser_t& p) { _fork_exec = p.get("fork"); }); auto _inpv = std::vector{}; auto& _outv = _parser_data.command; bool _hash = false; for(int i = 0; i < argc; ++i) { if(argv[i] == nullptr) { continue; } else if(_hash) { _outv.emplace_back(strdup(argv[i])); } else if(std::string_view{ argv[i] } == "--") { _hash = true; } else { _inpv.emplace_back(strdup(argv[i])); } } auto _cerr = parser.parse_args(_inpv.size(), _inpv.data()); if(help_check(parser, argc, argv)) help_action(parser); else if(_cerr) throw std::runtime_error(_cerr.what()); tim::log::monochrome() = _parser_data.monochrome; return _parser_data; } parser_data_t& parse_command(int argc, char** argv, parser_data_t& _parser_data) { toggle_suppression(initial_suppression); rocprofsys::argparse::init_parser(_parser_data); // no need for backtraces signals::disable_signal_detection(signals::signal_settings::get_enabled()); auto& _outv = _parser_data.command; bool _hash = false; for(int i = 1; i < argc; ++i) { _outv.emplace_back(strdup(argv[i])); } return _parser_data; }