profiler.hh

Go to the documentation of this file.

/*
 
MIT License
 
Copyright (c) 2026 PCSX-Redux authors
 
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 <stdint.h>
 
#include "common/hardware/pcsxprof.h"
#include "psyqo/shadow-stack.hh"
 
extern "C" uint32_t psyqoFrameCounter;
 
namespace psyqo {
 
class Profiler {
  public:
    struct Zone {
        const char* name;
        const char* file;
        uint32_t line;
    };
 
    template <unsigned Capacity>
    struct Buffer {
        static_assert(Capacity && !(Capacity & (Capacity - 1)), "Capacity must be a power of two");
        pcsx_ProfHeader header;
        pcsx_ProfEntry entries[Capacity];
    };
 
    template <unsigned Capacity>
    static void install(Buffer<Capacity>& buffer) {
        install(&buffer.header, buffer.entries, Capacity);
    }
 
    static void uninstall();
 
    static bool installed() { return s_header != nullptr; }
 
    [[gnu::always_inline, gnu::no_instrument_function]] static inline uint32_t now() {
        volatile uint16_t* const counter1 = reinterpret_cast<volatile uint16_t*>(0xbf801110);
        volatile uint16_t* const counter2 = reinterpret_cast<volatile uint16_t*>(0xbf801120);
        uint32_t lines, cycles;
        do {
            lines = *counter1;
            cycles = *counter2;
        } while (lines != *counter1);
        return (lines << 16) | cycles;
    }
 
    static uint32_t elapsed(uint32_t start, uint32_t end) { return pcsx_profElapsed(start, end, s_cyclesPer16Lines); }
 
    class Scope {
      public:
        [[gnu::always_inline]] explicit Scope(const Zone& zone) : m_zone(&zone) {
            if (s_header) begin();
        }
        [[gnu::always_inline]] ~Scope() {
            if (m_header) end();
        }
        Scope(const Scope&) = delete;
        Scope& operator=(const Scope&) = delete;
 
      private:
        void begin();
        void end();
        const Zone* m_zone;
        pcsx_ProfHeader* m_header = nullptr;
        uint32_t m_start;
        uint16_t m_vsync;
        uint8_t m_depth;
        uint8_t m_stackDepth;
        uint32_t m_generation;
    };
 
    struct BenchResult {
        uint32_t count = 0;
        uint32_t min = 0;
        uint32_t max = 0;
        uint32_t total = 0;
        uint32_t mean() const { return count ? total / count : 0; }
    };
 
    template <typename F>
    static BenchResult bench(const Zone& zone, unsigned count, F&& function) {
        BenchResult result;
        if (!s_header || !count) return result;
        uint32_t generation = s_generation;
        uint8_t depth = s_depth;
        unsigned stackDepth = ShadowStack::depth();
        if (stackDepth > 255) stackDepth = 255;
        result.min = 0xffffffff;
        for (unsigned i = 0; i < count; i++) {
            uint16_t vsync = *const_cast<const volatile uint32_t*>(&psyqoFrameCounter);
            s_depth = depth + 1;
            uint32_t start = now();
            function();
            uint32_t end = now();
            s_depth = depth;
            // Reinstalled from inside the run: the counters were reset under it.
            if (s_generation != generation) break;
            record(&zone, start, end, vsync, depth, stackDepth);
            uint32_t cycles = elapsed(start, end);
            cycles = cycles > s_nowCost ? cycles - s_nowCost : 0;
            if (cycles < result.min) result.min = cycles;
            if (cycles > result.max) result.max = cycles;
            result.total += cycles;
            result.count++;
        }
        if (!result.count) result.min = 0;
        return result;
    }
 
    template <typename F>
    static void forEach(F&& function) {
        pcsx_ProfHeader* header = s_header;
        if (!header) return;
        uint32_t written = header->written;
        uint32_t mask = header->capacity - 1;
        uint32_t count = s_full ? header->capacity : written;
        auto entries = reinterpret_cast<const pcsx_ProfEntry*>(header->entries);
        for (uint32_t i = written - count; i != written; i++) {
            const pcsx_ProfEntry& entry = entries[i & mask];
            function(*reinterpret_cast<const Zone*>(entry.zone), entry.start, elapsed(entry.start, entry.end),
                     entry.vsync, entry.depth, entry.stackDepth);
        }
    }
 
    static bool dumpPCDRV(const char* path);
 
  private:
    static void install(pcsx_ProfHeader* header, pcsx_ProfEntry* entries, unsigned capacity);
    static void record(const Zone* zone, uint32_t start, uint32_t end, uint16_t vsync, uint8_t depth,
                       uint8_t stackDepth);
    static pcsx_ProfHeader* s_header;
    static uint32_t s_cyclesPer16Lines;
    static uint32_t s_nowCost;
    static uint8_t s_depth;
    // Bumped by every install and uninstall, so scopes and benchmark runs
    // straddling one are dropped rather than timed across a counter reset.
    static uint32_t s_generation;
    // The buffer has wrapped at least once since install.
    static bool s_full;
    friend class Scope;
};
 
}  // namespace psyqo
 
#define PSYQO_PROFILE_CONCAT_(a, b) a##b
#define PSYQO_PROFILE_CONCAT(a, b) PSYQO_PROFILE_CONCAT_(a, b)
 
#define PSYQO_PROFILE_SCOPE(name)                                                                               \
    static constexpr psyqo::Profiler::Zone PSYQO_PROFILE_CONCAT(psyqoProfileZone_, __LINE__) = {name, __FILE__, \
                                                                                                __LINE__};      \
    psyqo::Profiler::Scope PSYQO_PROFILE_CONCAT(psyqoProfileScope_, __LINE__) {                                 \
        PSYQO_PROFILE_CONCAT(psyqoProfileZone_, __LINE__)                                                       \
    }