mirror of
https://github.com/scp-fs2open/fs2open.github.com.git
synced 2026-11-09 13:01:29 -10:00
- Move the overlay option strings to XSTR 1940 and 1941. The touch overlay on master uses 1936 to 1939. - Give FrameProfiler the main thread ID when it is made. Before, it used the thread of the first event, which was a race. - Let mouse motion go to the game while the pointer is over the overlay, so that mouse flight does not stop there. - Find the dynamic bindings of the PerDraw key with dynamic_offset_slot(), as the other call sites do. - Make disable_inside_open_scope count the GPU timestamp queries, so that it fails if end() does not close the GPU event. - Make the copy test copy the category, not bind a reference. Co-Authored-By: Claude Opus 5.5 <[email protected]>
109 lines
3.3 KiB
C++
109 lines
3.3 KiB
C++
#pragma once
|
|
|
|
|
|
#include "globalincs/pstypes.h"
|
|
|
|
#include "tracing.h"
|
|
|
|
#include <mutex>
|
|
|
|
/** @file
|
|
* @ingroup tracing
|
|
*/
|
|
|
|
namespace tracing {
|
|
|
|
/**
|
|
* Computes the self time of each category for one frame of Begin/End events, sorted by event_id.
|
|
*
|
|
* @c self_time_by_id is resized to Category::getCount() and indexed by Category::getId(). Pass the
|
|
* same vector every frame to reuse its allocation.
|
|
*
|
|
* @return the sum of all self times, which is the total traced frame time.
|
|
*/
|
|
uint64_t accumulate_self_times(const SCP_vector<trace_event>& events, SCP_vector<uint64_t>& self_time_by_id);
|
|
|
|
struct profile_sample_history {
|
|
bool valid;
|
|
//char name[256];
|
|
SCP_string name;
|
|
uint64_t avg_micro_sec;
|
|
uint64_t min_micro_sec;
|
|
uint64_t max_micro_sec;
|
|
};
|
|
|
|
struct profile_sample {
|
|
uint profile_instances;
|
|
int open_profiles;
|
|
SCP_string name;
|
|
uint64_t start_time; // in microseconds
|
|
uint64_t accumulator;
|
|
uint64_t children_sample_time;
|
|
uint num_parents;
|
|
uint num_children;
|
|
int parent;
|
|
};
|
|
|
|
class FrameProfiler {
|
|
std::mutex _eventsMutex;
|
|
SCP_vector<trace_event> _bufferedEvents;
|
|
|
|
SCP_vector<profile_sample_history> history;
|
|
|
|
frame_overlay_snapshot overlaySnapshot;
|
|
|
|
// Reused across frames by accumulate_self_times() so the per-frame walk allocates nothing.
|
|
SCP_vector<uint64_t> _selfTimeScratch;
|
|
|
|
// The profiler keeps only events from this thread. Other threads have no deterministic event order.
|
|
std::int64_t _mainThreadID;
|
|
|
|
SCP_string content;
|
|
|
|
/**
|
|
* Stores profile data in in the profile history lookup. This is used internally by the profiling code and should
|
|
* not be called outside of it.
|
|
* @param name The globally unique name for this profile (see profile_begin()/profile_end())
|
|
* @param percent How much time the profiled section took to execute (as a percentage of overall frametime)
|
|
*/
|
|
void store_profile_in_history(SCP_string& name, uint64_t time);
|
|
|
|
/**
|
|
* Gets the min, max and average values for a given profile
|
|
* @param name The globally unique name for this profile (see profile_begin()/profile_end())
|
|
* @param avg Pointer to a float in which the average value will be stored (or 0.0 if no value has been saved)
|
|
* @param min Pointer to a float in which the minimum value will be stored (or 0.0 if no value has been saved)
|
|
* @param max Pointer to a float in which the maximum value will be stored (or 0.0 if no value has been saved)
|
|
*/
|
|
void get_profile_from_history(SCP_string& name,
|
|
uint64_t* avg_micro_sec,
|
|
uint64_t* min_micro_sec,
|
|
uint64_t* max_micro_sec);
|
|
|
|
void dump_output(SCP_stringstream& out,
|
|
uint64_t start_profile_time,
|
|
uint64_t end_profile_time,
|
|
SCP_vector<profile_sample>& samples);
|
|
|
|
/**
|
|
* Builds the structured overlay snapshot (see frame_overlay_snapshot) from this frame's
|
|
* per-category self-time. self_time_by_id is indexed by Category::getId(); total is the sum of
|
|
* all self-times (i.e. total traced frame time). Called once per processFrame().
|
|
*/
|
|
void build_overlay_snapshot(const SCP_vector<uint64_t>& self_time_by_id, uint64_t total);
|
|
|
|
public:
|
|
explicit FrameProfiler(std::int64_t mainThreadID);
|
|
~FrameProfiler();
|
|
|
|
void processEvent(const trace_event* event);
|
|
|
|
void processFrame();
|
|
|
|
SCP_string getContent();
|
|
|
|
const frame_overlay_snapshot& getOverlaySnapshot() const { return overlaySnapshot; }
|
|
};
|
|
|
|
}
|