rocm-systems/source/lib/rocprofiler-sdk-tool/config.hpp

// MIT License
//
// Copyright (c) 2023 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.
//

#pragma once

#include "lib/common/environment.hpp"
#include "lib/common/filesystem.hpp"

#include <set>
#include <string>
#include <unordered_set>
#include <vector>

namespace rocprofiler
{
namespace tool
{
namespace fs = common::filesystem;
using common::get_env;

enum class config_context
{
    global = 0,
    att_plugin,
    cli_plugin,
    ctf_plugin,
    file_plugin,
    perfetto_plugin,
};

int
get_mpi_size();

int
get_mpi_rank();

struct config
{
    config();

    bool        demangle                    = get_env("ROCPROF_DEMANGLE_KERNELS", true);
    bool        truncate                    = get_env("ROCPROF_TRUNCATE_KERNELS", false);
    bool        kernel_trace                = get_env("ROCPROF_KERNEL_TRACE", false);
    bool        hsa_core_api_trace          = get_env("ROCPROF_HSA_CORE_API_TRACE", false);
    bool        hsa_amd_ext_api_trace       = get_env("ROCPROF_HSA_AMD_EXT_API_TRACE", false);
    bool        hsa_image_ext_api_trace     = get_env("ROCPROF_HSA_IMAGE_EXT_API_TRACE", false);
    bool        hsa_finalizer_ext_api_trace = get_env("ROCPROF_HSA_FINALIZER_EXT_API_TRACE", false);
    bool        marker_api_trace            = get_env("ROCPROF_MARKER_API_TRACE", false);
    bool        memory_copy_trace           = get_env("ROCPROF_MEMORY_COPY_TRACE", false);
    bool        scratch_memory              = get_env("ROCPROF_SCRATCH_MEMORY_TRACE", false);
    bool        counter_collection          = get_env("ROCPROF_COUNTER_COLLECTION", false);
    bool        hip_runtime_api_trace       = get_env("ROCPROF_HIP_RUNTIME_API_TRACE", false);
    bool        hip_compiler_api_trace      = get_env("ROCPROF_HIP_COMPILER_API_TRACE", false);
    bool        list_metrics                = get_env("ROCPROF_LIST_METRICS", false);
    bool        list_metrics_output_file    = get_env("ROCPROF_OUTPUT_LIST_METRICS_FILE", false);
    bool        stats                       = get_env("ROCPROF_STATS", false);
    bool        csv_output                  = false;
    bool        json_output                 = false;
    bool        pftrace_output              = false;
    int         mpi_size                    = get_mpi_size();
    int         mpi_rank                    = get_mpi_rank();
    std::string output_path   = get_env("ROCPROF_OUTPUT_PATH", fs::current_path().string());
    std::string output_file   = get_env("ROCPROF_OUTPUT_FILE_NAME", std::to_string(getpid()));
    std::string tmp_directory = get_env("ROCPROF_TMPDIR", output_path);

    std::string kernel_filter_include =
        get_env("ROCPROF_KERNEL_FILTER_INCLUDE_REGEX", std::string{".*"});
    std::string kernel_filter_exclude =
        get_env("ROCPROF_KERNEL_FILTER_EXCLUDE_REGEX", std::string{});
    std::unordered_set<uint32_t> kernel_filter_range = {};
    std::set<std::string>        counters            = {};
};

template <config_context ContextT = config_context::global>
config&
get_config()
{
    if constexpr(ContextT == config_context::global)
    {
        static auto* _v = new config{};
        return *_v;
    }
    else
    {
        // context specific config copied from global config
        static auto* _v = new config{get_config<config_context::global>()};
        return *_v;
    }
}

struct output_key
{
    output_key(std::string _key, std::string _val, std::string _desc = {});

    operator std::pair<std::string, std::string>() const;

    std::string key         = {};
    std::string value       = {};
    std::string description = {};
};

std::vector<output_key>
output_keys(std::string _tag = {});

std::string
format(std::string _fpath, const std::string& _tag = {});

std::string
format_name(std::string_view _name, const config& = get_config<>());

void
initialize();
}  // namespace tool
}  // namespace rocprofiler