TheRock/rocm-systems/projects/rocprofiler-systems/source/lib/backends/procfs/backend.hpp

// Copyright (c) Advanced Micro Devices, Inc.
// SPDX-License-Identifier:  MIT

#pragma once

#include "logger/debug.hpp"

#include <spdlog/fmt/fmt.h>

#include <algorithm>
#include <charconv>
#include <cstdint>
#include <cstdio>
#include <map>
#include <memory>
#include <optional>
#include <set>
#include <string>
#include <string_view>
#include <sys/resource.h>
#include <unistd.h>
#include <utility>
#include <vector>

namespace rocprofsys::backends::procfs
{
// /proc/stat: ~120 bytes per CPU line. Default 16 KB covers ~128 CPUs.
static constexpr size_t DEFAULT_STAT_BUFFER_SIZE = 16384;
// /proc/self/statm: 7 space-separated numbers, always < 256 bytes.
static constexpr size_t STATM_BUFFER_SIZE = 256;
// Approximate bytes per /proc/stat CPU line (for dynamic sizing).
static constexpr size_t BYTES_PER_STAT_LINE = 120;
// sysfs frequency file: value in kHz, always < 32 bytes.
static constexpr std::uint8_t SYSFS_FREQ_BUFFER_SIZE = 32;
// ru_maxrss is in KB on Linux.
static constexpr std::int64_t KB_TO_BYTES = 1024;
// Microseconds per second (for timeval conversion).
static constexpr std::int64_t US_PER_SECOND = 1'000'000;
// kHz to MHz conversion for sysfs scaling_cur_freq.
static constexpr float KHZ_TO_MHZ = 0.001f;
// /proc/stat per-CPU line prefix.
static constexpr std::string_view PROC_STAT_CPU_PREFIX = "cpu";
// Number of jiffies fields per CPU line in /proc/stat.
static constexpr std::uint8_t JIFFIES_FIELD_COUNT = 7;

struct file_closer
{
    void operator()(FILE* fd) const noexcept
    {
        if(fd) std::fclose(fd);
    }
};
using unique_file = std::unique_ptr<FILE, file_closer>;

constexpr bool
starts_with(std::string_view str, std::string_view prefix) noexcept
{
    if(str.size() < prefix.size()) return false;
    return prefix == std::string_view{ str.data(), prefix.size() };
}

inline std::string_view
ltrim(std::string_view str) noexcept
{
    const auto pos = str.find_first_not_of(" \t");
    return pos == std::string_view::npos ? std::string_view{} : str.substr(pos);
}

inline std::vector<std::string_view>
split_lines(std::string_view content)
{
    std::vector<std::string_view> lines;
    const auto*                   line_begin = content.begin();
    while(line_begin < content.end())
    {
        const auto* line_end = std::find(line_begin, content.end(), '\n');
        lines.emplace_back(line_begin, static_cast<size_t>(line_end - line_begin));
        line_begin = line_end + 1;
    }
    return lines;
}

struct cpu_jiffies
{
    std::uint64_t user    = 0;
    std::uint64_t nice    = 0;
    std::uint64_t system  = 0;
    std::uint64_t idle    = 0;
    std::uint64_t iowait  = 0;
    std::uint64_t irq     = 0;
    std::uint64_t softirq = 0;

    [[nodiscard]] constexpr std::uint64_t total() const noexcept
    {
        return user + nice + system + idle + iowait + irq + softirq;
    }

    [[nodiscard]] constexpr std::uint64_t active() const noexcept
    {
        return user + nice + system + irq + softirq;
    }
};

struct rusage_snapshot
{
    std::int64_t page_rss         = 0;
    std::int64_t virt_mem         = 0;
    std::int64_t peak_rss         = 0;
    std::int64_t context_switches = 0;
    std::int64_t page_faults      = 0;
    std::int64_t user_mode_time   = 0;
    std::int64_t kernel_mode_time = 0;
};

struct statm_data
{
    std::int64_t virt_mem = 0;
    std::int64_t page_rss = 0;
};

// Maps socket (physical package) ID to the set of logical CPU IDs on that socket.
using socket_topology_t = std::map<size_t, std::set<size_t>>;

// sysfs topology file: value is a small integer, always < 16 bytes.
static constexpr std::uint8_t SYSFS_TOPOLOGY_BUFFER_SIZE = 16;

/**
 * @brief Discover CPU socket topology from sysfs.
 *
 * Reads /sys/devices/system/cpu/cpuN/topology/physical_package_id for each
 * online CPU and groups them by socket ID. Falls back to a single socket 0
 * if sysfs topology is unavailable.
 *
 * @param cpu_count Number of online logical CPUs.
 * @return Map of socket_id to set of cpu_ids belonging to that socket.
 */
inline socket_topology_t
read_socket_topology(size_t cpu_count)
{
    socket_topology_t topology;
    char              buf[SYSFS_TOPOLOGY_BUFFER_SIZE];

    for(size_t cpu = 0; cpu < cpu_count; ++cpu)
    {
        const auto path = fmt::format(
            "/sys/devices/system/cpu/cpu{}/topology/physical_package_id", cpu);
        unique_file fd{ std::fopen(path.c_str(), "r") };
        if(!fd)
        {
            LOG_DEBUG("Could not read CPU {} topology, defaulting to socket 0", cpu);
            topology[0].insert(cpu);
            continue;
        }

        const auto bytes = std::fread(buf, 1, sizeof(buf) - 1, fd.get());
        if(bytes == 0)
        {
            topology[0].insert(cpu);
            continue;
        }

        size_t socket_id = 0;
        std::from_chars(buf, buf + bytes, socket_id);

        topology[socket_id].insert(cpu);
    }

    if(topology.empty() && cpu_count > 0) topology[0] = {};

    return topology;
}

[[nodiscard]] inline std::map<size_t, cpu_jiffies>
parse_proc_stat(std::string_view content)
{
    std::map<size_t, cpu_jiffies> result;
    const auto                    lines = split_lines(content);

    const auto parse_cpu_line = [&](std::string_view line) {
        if(!starts_with(line, PROC_STAT_CPU_PREFIX) ||
           line.size() <= PROC_STAT_CPU_PREFIX.size() ||
           !std::isdigit(static_cast<unsigned char>(line[PROC_STAT_CPU_PREFIX.size()])))
            return;

        const auto space = line.find(' ');
        if(space == std::string_view::npos) return;

        size_t cpu_id        = 0;
        const auto [ptr, ec] = std::from_chars(line.data() + PROC_STAT_CPU_PREFIX.size(),
                                               line.data() + space, cpu_id);
        if(ec != std::errc()) return;

        cpu_jiffies    jiffies;
        std::uint64_t* fields[]  = { &jiffies.user,   &jiffies.nice,   &jiffies.system,
                                     &jiffies.idle,   &jiffies.iowait, &jiffies.irq,
                                     &jiffies.softirq };
        auto           remaining = ltrim(line.substr(space));

        for(size_t i = 0; i < JIFFIES_FIELD_COUNT && !remaining.empty(); ++i)
        {
            const auto [p, e] = std::from_chars(
                remaining.data(), remaining.data() + remaining.size(), *fields[i]);
            if(e != std::errc()) break;
            remaining = ltrim(
                { p, static_cast<size_t>(remaining.data() + remaining.size() - p) });
        }
        result[cpu_id] = jiffies;
    };

    std::for_each(lines.begin(), lines.end(), parse_cpu_line);

    return result;
}

[[nodiscard]] inline std::optional<statm_data>
parse_statm(std::string_view content)
{
    static const long page_size = sysconf(_SC_PAGESIZE);

    auto remaining = ltrim(content);

    size_t virt_pages   = 0;
    const auto [p1, e1] = std::from_chars(
        remaining.data(), remaining.data() + remaining.size(), virt_pages);
    if(e1 != std::errc()) return std::nullopt;

    remaining =
        ltrim({ p1, static_cast<size_t>(remaining.data() + remaining.size() - p1) });

    size_t rss_pages = 0;
    const auto [p2, e2] =
        std::from_chars(remaining.data(), remaining.data() + remaining.size(), rss_pages);
    if(e2 != std::errc()) return std::nullopt;

    return statm_data{ static_cast<std::int64_t>(virt_pages) * page_size,
                       static_cast<std::int64_t>(rss_pages) * page_size };
}

/**
 * @brief backend wrapping Linux procfs/sysfs and getrusage for CPU metrics.
 *
 * Persistent file handles via unique_file (std::unique_ptr<FILE, file_closer>),
 * rewind+fread, pre-allocated buffers, zero-copy string_view parsing.
 * CPU frequency read from sysfs scaling_cur_freq (per-CPU file handles).
 */
class backend
{
public:
    /**
     * @param cpu_count Number of online CPUs. Sizes buffers and opens
     *        per-CPU sysfs file handles for frequency reading.
     */
    explicit backend(size_t cpu_count)
    : m_stat_buffer(
          std::max(DEFAULT_STAT_BUFFER_SIZE, (cpu_count * BYTES_PER_STAT_LINE) + 256))
    , m_statm_buffer(STATM_BUFFER_SIZE)
    , m_freq_buffer(SYSFS_FREQ_BUFFER_SIZE)
    {
        for(size_t i = 0; i < cpu_count; ++i)
        {
            const auto path =
                fmt::format("/sys/devices/system/cpu/cpu{}/cpufreq/scaling_cur_freq", i);
            unique_file fd{ std::fopen(path.c_str(), "r") };
            if(fd) m_sysfs_freq_fds.emplace(i, std::move(fd));
        }
        m_use_sysfs_freq  = !m_sysfs_freq_fds.empty();
        m_socket_topology = read_socket_topology(cpu_count);
    }

    [[nodiscard]] const socket_topology_t& get_socket_topology() const noexcept
    {
        return m_socket_topology;
    }

    [[nodiscard]] size_t get_socket_count() const noexcept
    {
        return m_socket_topology.size();
    }

    [[nodiscard]] std::map<size_t, cpu_jiffies> read_proc_stat()
    {
        const auto content = read_file(m_proc_stat_fd, "/proc/stat", m_stat_buffer);
        if(content.empty()) return {};
        return parse_proc_stat(content);
    }

    [[nodiscard]] std::map<size_t, float> read_cpu_frequencies()
    {
        if(m_use_sysfs_freq) return read_sysfs_frequencies();
        return {};
    }

    [[nodiscard]] rusage_snapshot read_rusage()
    {
        rusage_snapshot snap;

        struct rusage usage = {};
        if(getrusage(RUSAGE_SELF, &usage) == 0)
        {
            snap.peak_rss = static_cast<std::int64_t>(usage.ru_maxrss) * KB_TO_BYTES;
            snap.context_switches =
                static_cast<std::int64_t>(usage.ru_nvcsw + usage.ru_nivcsw);
            snap.page_faults =
                static_cast<std::int64_t>(usage.ru_majflt + usage.ru_minflt);
            snap.user_mode_time =
                static_cast<std::int64_t>(usage.ru_utime.tv_sec) * US_PER_SECOND +
                static_cast<std::int64_t>(usage.ru_utime.tv_usec);
            snap.kernel_mode_time =
                static_cast<std::int64_t>(usage.ru_stime.tv_sec) * US_PER_SECOND +
                static_cast<std::int64_t>(usage.ru_stime.tv_usec);
        }

        const auto content =
            read_file(m_proc_statm_fd, "/proc/self/statm", m_statm_buffer);
        if(!content.empty())
        {
            if(const auto data = parse_statm(content))
            {
                snap.virt_mem = data->virt_mem;
                snap.page_rss = data->page_rss;
            }
        }

        return snap;
    }

private:
    [[nodiscard]] static std::string_view read_file(unique_file& fd, const char* path,
                                                    std::vector<char>& buffer)
    {
        if(!fd)
        {
            fd.reset(std::fopen(path, "r"));
            if(!fd)
            {
                LOG_DEBUG("Failed to open {}", path);
                return {};
            }
        }
        std::rewind(fd.get());

        const auto bytes = std::fread(buffer.data(), 1, buffer.size(), fd.get());
        if(bytes == 0) return {};

        return { buffer.data(), bytes };
    }

    [[nodiscard]] std::map<size_t, float> read_sysfs_frequencies()
    {
        std::map<size_t, float> result;
        for(auto& [cpu_id, fd] : m_sysfs_freq_fds)
        {
            std::rewind(fd.get());
            const auto bytes =
                std::fread(m_freq_buffer.data(), 1, m_freq_buffer.size(), fd.get());
            if(bytes == 0) continue;

            unsigned long khz = 0;
            const auto [p, e] =
                std::from_chars(m_freq_buffer.data(), m_freq_buffer.data() + bytes, khz);
            if(e == std::errc()) result[cpu_id] = static_cast<float>(khz) * KHZ_TO_MHZ;
        }
        return result;
    }

    unique_file                   m_proc_stat_fd;
    unique_file                   m_proc_statm_fd;
    std::map<size_t, unique_file> m_sysfs_freq_fds;
    bool                          m_use_sysfs_freq = false;
    socket_topology_t             m_socket_topology;
    std::vector<char>             m_stat_buffer;
    std::vector<char>             m_statm_buffer;
    std::vector<char>             m_freq_buffer;
};

/**
 * @brief Factory for creating procfs backend instances.
 */
struct backend_factory
{
    using backend_t = backend;

    static std::shared_ptr<backend_t> create_backend(size_t cpu_count)
    {
        return std::make_shared<backend_t>(cpu_count);
    }
};

}  // namespace rocprofsys::backends::procfs