200 lines
6.7 KiB
C++
200 lines
6.7 KiB
C++
/**
|
|
******************************************************************************
|
|
* Xenia : Xbox 360 Emulator Research Project *
|
|
******************************************************************************
|
|
* Copyright 2014 Ben Vanik. All rights reserved. *
|
|
* Released under the BSD license - see LICENSE in the root for more details. *
|
|
******************************************************************************
|
|
*/
|
|
|
|
#ifndef XENIA_BASE_PROFILING_H_
|
|
#define XENIA_BASE_PROFILING_H_
|
|
|
|
#include <memory>
|
|
|
|
#include "xenia/base/string.h"
|
|
|
|
#if XE_PLATFORM_WIN32
|
|
#define XE_OPTION_PROFILING 1
|
|
#define XE_OPTION_PROFILING_UI 1
|
|
#else
|
|
#define XE_OPTION_PROFILING 0
|
|
#endif // XE_PLATFORM_WIN32
|
|
|
|
#if XE_OPTION_PROFILING
|
|
// Pollutes the global namespace. Yuck.
|
|
#define MICROPROFILE_MAX_THREADS 128
|
|
#include <microprofile/microprofile.h>
|
|
#endif // XE_OPTION_PROFILING
|
|
|
|
namespace xe {
|
|
namespace ui {
|
|
class MicroprofileDrawer;
|
|
class Window;
|
|
} // namespace ui
|
|
} // namespace xe
|
|
|
|
namespace xe {
|
|
|
|
#if XE_OPTION_PROFILING
|
|
|
|
// Defines a profiling scope for CPU tasks.
|
|
// Use `SCOPE_profile_cpu(name)` to activate the scope.
|
|
#define DEFINE_profile_cpu(name, group_name, scope_name) \
|
|
MICROPROFILE_DEFINE(name, group_name, scope_name, \
|
|
xe::Profiler::GetColor(scope_name))
|
|
|
|
// Declares a previously defined profile scope. Use in a translation unit.
|
|
#define DECLARE_profile_cpu(name) MICROPROFILE_DECLARE(name)
|
|
|
|
// Defines a profiling scope for GPU tasks.
|
|
// Use `COUNT_profile_gpu(name)` to activate the scope.
|
|
#define DEFINE_profile_gpu(name, group_name, scope_name) \
|
|
MICROPROFILE_DEFINE_GPU(name, group_name, scope_name, \
|
|
xe::Profiler::GetColor(scope_name))
|
|
|
|
// Declares a previously defined profile scope. Use in a translation unit.
|
|
#define DECLARE_profile_gpu(name) MICROPROFILE_DECLARE_GPU(name)
|
|
|
|
// Enters a previously defined CPU profiling scope, active for the duration
|
|
// of the containing block.
|
|
#define SCOPE_profile_cpu(name) MICROPROFILE_SCOPE(name)
|
|
|
|
// Enters a CPU profiling scope, active for the duration of the containing
|
|
// block. No previous definition required.
|
|
#define SCOPE_profile_cpu_i(group_name, scope_name) \
|
|
MICROPROFILE_SCOPEI(group_name, scope_name, \
|
|
xe::Profiler::GetColor(scope_name))
|
|
|
|
// Enters a CPU profiling scope by function name, active for the duration of
|
|
// the containing block. No previous definition required.
|
|
#define SCOPE_profile_cpu_f(group_name) \
|
|
MICROPROFILE_SCOPEI(group_name, __FUNCTION__, \
|
|
xe::Profiler::GetColor(__FUNCTION__))
|
|
|
|
// Enters a previously defined GPU profiling scope, active for the duration
|
|
// of the containing block.
|
|
#define SCOPE_profile_gpu(name) MICROPROFILE_SCOPEGPU(name)
|
|
|
|
// Enters a GPU profiling scope, active for the duration of the containing
|
|
// block. No previous definition required.
|
|
#define SCOPE_profile_gpu_i(group_name, scope_name) \
|
|
MICROPROFILE_SCOPEGPUI(group_name, scope_name, \
|
|
xe::Profiler::GetColor(scope_name))
|
|
|
|
// Enters a GPU profiling scope by function name, active for the duration of
|
|
// the containing block. No previous definition required.
|
|
#define SCOPE_profile_gpu_f(group_name) \
|
|
MICROPROFILE_SCOPEGPUI(group_name, __FUNCTION__, \
|
|
xe::Profiler::GetColor(__FUNCTION__))
|
|
|
|
// Adds a number to a counter
|
|
#define COUNT_profile_add(name, count) MICROPROFILE_COUNTER_ADD(name, count)
|
|
|
|
// Subtracts a number to a counter
|
|
#define COUNT_profile_sub(name, count) MICROPROFILE_COUNTER_SUB(name, count)
|
|
|
|
// Sets a counter's value
|
|
#define COUNT_profile_set(name, count) MICROPROFILE_COUNTER_SET(name, count)
|
|
|
|
// Tracks a CPU value counter.
|
|
#define COUNT_profile_cpu(name, count) MICROPROFILE_META_CPU(name, count)
|
|
|
|
// Tracks a GPU value counter.
|
|
#define COUNT_profile_gpu(name, count) MICROPROFILE_META_GPU(name, count)
|
|
|
|
#else
|
|
|
|
#define DEFINE_profile_cpu(name, group_name, scope_name)
|
|
#define DEFINE_profile_gpu(name, group_name, scope_name)
|
|
#define DECLARE_profile_cpu(name)
|
|
#define DECLARE_profile_gpu(name)
|
|
#define SCOPE_profile_cpu(name) \
|
|
do { \
|
|
} while (false)
|
|
#define SCOPE_profile_cpu_f(name) \
|
|
do { \
|
|
} while (false)
|
|
#define SCOPE_profile_cpu_i(group_name, scope_name) \
|
|
do { \
|
|
} while (false)
|
|
#define SCOPE_profile_gpu(name) \
|
|
do { \
|
|
} while (false)
|
|
#define SCOPE_profile_gpu_f(name) \
|
|
do { \
|
|
} while (false)
|
|
#define SCOPE_profile_gpu_i(group_name, scope_name) \
|
|
do { \
|
|
} while (false)
|
|
#define COUNT_profile_add(name, count) \
|
|
do { \
|
|
} while (false)
|
|
#define COUNT_profile_sub(name, count) \
|
|
do { \
|
|
} while (false)
|
|
#define COUNT_profile_set(name, count) \
|
|
do { \
|
|
} while (false)
|
|
#define COUNT_profile_cpu(name, count) \
|
|
do { \
|
|
} while (false)
|
|
#define COUNT_profile_gpu(name, count) \
|
|
do { \
|
|
} while (false)
|
|
|
|
#ifndef MICROPROFILE_TEXT_WIDTH
|
|
#define MICROPROFILE_TEXT_WIDTH 1
|
|
#define MICROPROFILE_TEXT_HEIGHT 1
|
|
#endif // !MICROPROFILE_TEXT_WIDTH
|
|
|
|
#endif // XE_OPTION_PROFILING
|
|
|
|
class Profiler {
|
|
public:
|
|
static bool is_enabled();
|
|
static bool is_visible();
|
|
|
|
// Initializes the profiler. Call at startup.
|
|
static void Initialize();
|
|
// Dumps data to stdout.
|
|
static void Dump();
|
|
// Cleans up profiling, releasing all memory.
|
|
static void Shutdown();
|
|
|
|
// Computes a color from the given string.
|
|
static uint32_t GetColor(const char* str);
|
|
|
|
// Activates the calling thread for profiling.
|
|
// This must be called immediately after launching a thread.
|
|
static void ThreadEnter(const char* name = nullptr);
|
|
// Deactivates the calling thread for profiling.
|
|
static void ThreadExit();
|
|
|
|
static bool OnKeyDown(int key_code);
|
|
static bool OnKeyUp(int key_code);
|
|
static void OnMouseDown(bool left_button, bool right_button);
|
|
static void OnMouseUp();
|
|
static void OnMouseMove(int x, int y);
|
|
static void OnMouseWheel(int x, int y, int dy);
|
|
static void ToggleDisplay();
|
|
static void TogglePause();
|
|
|
|
// Initializes input and drawing with the given display.
|
|
static void set_window(ui::Window* window);
|
|
// Gets the current display, if any.
|
|
static ui::MicroprofileDrawer* drawer() { return drawer_.get(); }
|
|
// Presents the profiler to the bound display, if any.
|
|
static void Present();
|
|
// Starts a new frame on the profiler
|
|
static void Flip();
|
|
|
|
private:
|
|
static ui::Window* window_;
|
|
static std::unique_ptr<ui::MicroprofileDrawer> drawer_;
|
|
};
|
|
|
|
} // namespace xe
|
|
|
|
#endif // XENIA_BASE_PROFILING_H_
|