Profiling.hpp

Go to the documentation of this file.

#pragma once
 
#include <chrono>
#include <concurrentqueue.h>
#include <string_view>
 
using moodycamel::ConcurrentQueue;
 
using profile_clock = std::chrono::high_resolution_clock;
 
class ProfilingFrame;

struct ProfileScope {
    explicit ProfileScope(std::string_view name, ProfilingFrame& frame);
    ~ProfileScope() noexcept;
 
    ProfileScope(const ProfileScope&) = delete;
    ProfileScope(ProfileScope&&) = delete;
    void operator=(const ProfileScope&) = delete;
    void operator=(ProfileScope&&) = delete;
 
  private:
    std::string_view name;
    int scope_depth = 0;
    ProfilingFrame& frame;
    profile_clock::time_point start;
};

struct ProfileScopeRecord {
    std::string_view name;
    int scope_depth = 0;
    profile_clock::time_point start;
    profile_clock::duration duration = profile_clock::duration::zero();
 
    explicit ProfileScopeRecord() = default;
    explicit ProfileScopeRecord(
        std::string_view name,
        int scope_depth,
        profile_clock::time_point start,
        profile_clock::duration duration
    )
        : name(name), scope_depth(scope_depth), start(start),
          duration(duration) {}
 
    [[nodiscard]] std::string formatted() const;
};

class ProfilingFrame {
  public:
    explicit ProfilingFrame(std::string_view name) noexcept : name(name) {}

    int start_scope() noexcept;
 
    void end_scope(const ProfileScopeRecord& scope) noexcept;

    std::string finish();
 
  private:
    std::string_view name;
    profile_clock::time_point start = profile_clock::now();
    ConcurrentQueue<ProfileScopeRecord> profile_scopes;
    std::atomic_int current_frame_scope_depth = 0;
};

 
ProfilingFrame& get_depth_profiling_frame();
void set_last_depth_profiling_frame_formatted(std::string&& formatted);
std::string get_last_depth_profiling_frame_formatted();
ProfilingFrame& get_camera_profiling_frame();
void set_last_camera_profiling_frame_formatted(std::string&& formatted);
std::string get_last_camera_profiling_frame_formatted();
ProfilingFrame& get_object_profiling_frame();
void set_last_object_profiling_frame_formatted(std::string&& formatted);
std::string get_last_object_profiling_frame_formatted();
ProfilingFrame& get_audio_profiling_frame();
void set_last_audio_profiling_frame_formatted(std::string&& formatted);
std::string get_last_audio_profiling_frame_formatted();
 
#define FUNCTION_NAME() (static_cast<const char*>(__func__))
 
#define COMBINE(x, y) x##y
#define COMBINE2(x, y) COMBINE(x, y)
 
#if EYE_AI_CORE_ENABLE_TRACY_PROFILER
 
#include <tracy/Tracy.hpp>
 
#define PROFILE_SCOPE(name, profiling_frame)                                   \
    ZoneScopedN(name);                                                         \
    const ProfileScope COMBINE2(__profile_scope_, __LINE__)(                   \
        name, profiling_frame                                                  \
    );
 
#define PROFILE_DEPTH_SCOPE(name)                                              \
    PROFILE_SCOPE(name, get_depth_profiling_frame())
 
#define PROFILE_CAMERA_SCOPE(name)                                             \
    PROFILE_SCOPE(name, get_camera_profiling_frame())
 
#define PROFILE_OBJECT_SCOPE(name)                                             \
    PROFILE_SCOPE(name, get_object_profiling_frame())
 
#define PROFILE_AUDIO_SCOPE(name)                                             \
    PROFILE_SCOPE(name, get_audio_profiling_frame())
 
#define PROFILE_FUNCTION(profiling_frame)                                      \
    ZoneScopedN(FUNCTION_NAME());                                              \
    const ProfileScope COMBINE2(__profile_scope_, __LINE__)(                   \
        FUNCTION_NAME(), profiling_frame                                       \
    );
 
#define PROFILE_DEPTH_FUNCTION() PROFILE_FUNCTION(get_depth_profiling_frame())
 
#define PROFILE_CAMERA_FUNCTION() PROFILE_FUNCTION(get_camera_profiling_frame())
 
#define PROFILE_OBJECT_FUNCTION() PROFILE_FUNCTION(get_object_profiling_frame())
 
#define PROFILE_AUDIO_FUNCTION() PROFILE_FUNCTION(get_audio_profiling_frame())
 
#else
 
#define PROFILE_SCOPE(name, profiling_frame)                                   \
    const ProfileScope COMBINE2(__profile_scope_, __LINE__)(                   \
        name, profiling_frame                                                  \
    );
 
#define PROFILE_DEPTH_SCOPE(name)                                              \
    PROFILE_SCOPE(name, get_depth_profiling_frame())
 
#define PROFILE_CAMERA_SCOPE(name)                                             \
    PROFILE_SCOPE(name, get_camera_profiling_frame())
 
#define PROFILE_OBJECT_SCOPE(name)                                             \
    PROFILE_SCOPE(name, get_object_profiling_frame())
 
#define PROFILE_AUDIO_SCOPE(name)                                             \
    PROFILE_SCOPE(name, get_audio_profiling_frame())
 
#define PROFILE_FUNCTION(profiling_frame)                                      \
    const ProfileScope COMBINE2(__profile_scope_, __LINE__)(                   \
        FUNCTION_NAME(), profiling_frame                                       \
    );
 
#define PROFILE_DEPTH_FUNCTION() PROFILE_FUNCTION(get_depth_profiling_frame())
 
#define PROFILE_CAMERA_FUNCTION() PROFILE_FUNCTION(get_camera_profiling_frame())
 
#define PROFILE_OBJECT_FUNCTION() PROFILE_FUNCTION(get_object_profiling_frame())
 
#define PROFILE_AUDIO_FUNCTION() PROFILE_FUNCTION(get_audio_profiling_frame())
 
#endif