#include "glproc.hpp"
#include "glstate.hpp"
#include "glretrace.hpp"
+#include "os_time.hpp"
+/* Synchronous debug output may reduce performance however,
+ * without it the callNo in the callback may be inaccurate
+ * as the callback may be called at any time.
+ */
+#define DEBUG_OUTPUT_SYNCHRONOUS 0
namespace glretrace {
bool insideList = false;
bool insideGlBeginEnd = false;
+struct CallQuery
+{
+ GLuint ids[3];
+ unsigned call;
+ bool isDraw;
+ GLuint program;
+ const trace::FunctionSig *sig;
+ int64_t cpuStart;
+ int64_t cpuEnd;
+};
+
+static bool supportsElapsed = true;
+static bool supportsTimestamp = true;
+static bool supportsOcclusion = true;
+static bool supportsDebugOutput = true;
+
+static std::list<CallQuery> callQueries;
+
+static void APIENTRY
+debugOutputCallback(GLenum source, GLenum type, GLuint id, GLenum severity, GLsizei length, const GLchar* message, GLvoid* userParam);
void
checkGlError(trace::Call &call) {
os << "\n";
}
-struct CallQuery
-{
- GLuint ids[2];
- unsigned call;
- const trace::FunctionSig *sig;
-};
+static void
+getCurrentTimes(int64_t& cpuTime, int64_t& gpuTime) {
+ GLuint query;
-static std::vector<CallQuery> callQueries;
-static GLuint frameQueries[2] = { 0, 0 };
+ if (retrace::profilingGpuTimes && supportsTimestamp) {
+ glGenQueries(1, &query);
+ glQueryCounter(query, GL_TIMESTAMP);
+ glGetQueryObjecti64vEXT(query, GL_QUERY_RESULT, &gpuTime);
+ } else {
+ gpuTime = 0;
+ }
-void frame_start() {
- if (retrace::profileGPU) {
- glGenQueries(2, frameQueries);
+ if (retrace::profilingCpuTimes) {
+ cpuTime = os::getTime();
+ } else {
+ cpuTime = 0;
+ }
- /* Query frame start time */
- glQueryCounter(frameQueries[0], GL_TIMESTAMP);
- }
+ if (retrace::profilingGpuTimes && supportsTimestamp) {
+ glDeleteQueries(1, &query);
+ }
}
-void frame_complete(trace::Call &call) {
- if (retrace::profileGPU) {
- /* Query frame end time */
- glQueryCounter(frameQueries[1], GL_TIMESTAMP);
+static void
+completeCallQuery(CallQuery& query) {
+ /* Get call start and duration */
+ int64_t gpuStart = 0, gpuDuration = 0, cpuDuration = 0, pixels = 0;
- completeQueries();
- }
+ if (query.isDraw) {
+ if (retrace::profilingGpuTimes) {
+ if (supportsTimestamp) {
+ glGetQueryObjecti64vEXT(query.ids[0], GL_QUERY_RESULT, &gpuStart);
+ }
- retrace::frameComplete(call);
+ glGetQueryObjecti64vEXT(query.ids[1], GL_QUERY_RESULT, &gpuDuration);
+ }
- /* Indicate start of next frame */
- frame_start();
+ if (retrace::profilingPixelsDrawn) {
+ glGetQueryObjecti64vEXT(query.ids[2], GL_QUERY_RESULT, &pixels);
+ }
- if (!currentDrawable) {
- return;
+ glDeleteQueries(3, query.ids);
+ } else {
+ pixels = -1;
}
- if (retrace::debug && !currentDrawable->visible) {
- retrace::warning(call) << "could not infer drawable size (glViewport never called)\n";
+ if (retrace::profilingCpuTimes) {
+ cpuDuration = query.cpuEnd - query.cpuStart;
}
+
+ /* Add call to profile */
+ retrace::profiler.addCall(query.call, query.sig->name, query.program, pixels, gpuStart, gpuDuration, query.cpuStart, cpuDuration);
}
void
-completeQueries()
-{
- if (callQueries.size() == 0)
- return;
+flushQueries() {
+ for (std::list<CallQuery>::iterator itr = callQueries.begin(); itr != callQueries.end(); ++itr) {
+ completeCallQuery(*itr);
+ }
- GLint available;
- GLuint64 frameBegin, frameEnd;
+ callQueries.clear();
+}
- /* Wait for frame to finish */
- do {
- glGetQueryObjectiv(frameQueries[1], GL_QUERY_RESULT_AVAILABLE, &available);
- } while(!available);
+void
+beginProfile(trace::Call &call, bool isDraw) {
+ /* Create call query */
+ CallQuery query;
+ query.isDraw = isDraw;
+ query.call = call.no;
+ query.sig = call.sig;
+ query.program = glretrace::currentContext ? glretrace::currentContext->activeProgram : 0;
+
+ /* GPU profiling only for draw calls */
+ if (isDraw) {
+ glGenQueries(3, query.ids);
+
+ if (retrace::profilingGpuTimes) {
+ if (supportsTimestamp) {
+ glQueryCounter(query.ids[0], GL_TIMESTAMP);
+ }
+
+ glBeginQuery(GL_TIME_ELAPSED, query.ids[1]);
+ }
+
+ if (retrace::profilingPixelsDrawn) {
+ glBeginQuery(GL_SAMPLES_PASSED, query.ids[2]);
+ }
+ }
- /* Get frame start and end */
- glGetQueryObjectui64vEXT(frameQueries[0], GL_QUERY_RESULT, &frameBegin);
- glGetQueryObjectui64vEXT(frameQueries[1], GL_QUERY_RESULT, &frameEnd);
- glDeleteQueries(2, frameQueries);
+ callQueries.push_back(query);
- /* Add frame to profile */
- retrace::profiler.addFrame(trace::Profiler::Frame(retrace::frameNo, frameBegin, frameEnd - frameBegin));
+ /* CPU profiling for all calls */
+ if (retrace::profilingCpuTimes) {
+ callQueries.back().cpuStart = os::getTime();
+ }
+}
- /* Loop through all active call queries */
- for (std::vector<CallQuery>::iterator itr = callQueries.begin(); itr != callQueries.end(); ++itr) {
- CallQuery& query = *itr;
- GLuint64 timestamp, duration;
+void
+endProfile(trace::Call &call, bool isDraw) {
+ GLint64 time = os::getTime();
- /* Get queue start and duration */
- glGetQueryObjectui64vEXT(query.ids[0], GL_QUERY_RESULT, ×tamp);
- glGetQueryObjectui64vEXT(query.ids[1], GL_QUERY_RESULT, &duration);
- glDeleteQueries(2, query.ids);
+ /* CPU profiling for all calls */
+ if (retrace::profilingCpuTimes) {
+ CallQuery& query = callQueries.back();
+ query.cpuEnd = time;
+ }
- /* Add call to profile */
- retrace::profiler.addCall(trace::Profiler::Call(query.call, query.sig->name, timestamp, duration));
- }
+ /* GPU profiling only for draw calls */
+ if (isDraw) {
+ if (retrace::profilingGpuTimes) {
+ glEndQuery(GL_TIME_ELAPSED);
+ }
- callQueries.clear();
+ if (retrace::profilingPixelsDrawn) {
+ glEndQuery(GL_SAMPLES_PASSED);
+ }
+ }
}
void
-beginProfileGPU(trace::Call &call) {
- if (frameQueries[0] == 0) {
- frame_start();
- }
+initContext() {
+ const char* extensions = (const char*)glGetString(GL_EXTENSIONS);
+
+ /* Ensure we have adequate extension support */
+ supportsTimestamp = glws::checkExtension("GL_ARB_timer_query", extensions);
+ supportsElapsed = glws::checkExtension("GL_EXT_timer_query", extensions) || supportsTimestamp;
+ supportsOcclusion = glws::checkExtension("GL_ARB_occlusion_query", extensions);
+ supportsDebugOutput = glws::checkExtension("GL_ARB_debug_output", extensions);
+
+ /* Check for timer query support */
+ if (retrace::profilingGpuTimes) {
+ if (!supportsTimestamp && !supportsElapsed) {
+ std::cout << "Error: Cannot run profile, GL_EXT_timer_query extension is not supported." << std::endl;
+ exit(-1);
+ }
+
+ GLint bits = 0;
+ glGetQueryiv(GL_TIME_ELAPSED, GL_QUERY_COUNTER_BITS, &bits);
+
+ if (!bits) {
+ std::cout << "Error: Cannot run profile, GL_QUERY_COUNTER_BITS == 0." << std::endl;
+ exit(-1);
+ }
+ }
- CallQuery query;
- query.call = call.no;
- query.sig = call.sig;
+ /* Check for occlusion query support */
+ if (retrace::profilingPixelsDrawn && !supportsOcclusion) {
+ std::cout << "Error: Cannot run profile, GL_ARB_occlusion_query extension is not supported." << std::endl;
+ exit(-1);
+ }
+
+ /* Setup debug message call back */
+ if (retrace::debug && supportsDebugOutput) {
+ glDebugMessageCallbackARB(&debugOutputCallback, currentContext);
+
+ if (DEBUG_OUTPUT_SYNCHRONOUS) {
+ glEnable(GL_DEBUG_OUTPUT_SYNCHRONOUS_ARB);
+ }
+ }
- /* Create start and duration queries */
- glGenQueries(2, query.ids);
- glQueryCounter(query.ids[0], GL_TIMESTAMP);
- glBeginQuery(GL_TIME_ELAPSED, query.ids[1]);
+ /* Sync the gpu and cpu start times */
+ if (retrace::profilingCpuTimes || retrace::profilingGpuTimes) {
+ if (!retrace::profiler.hasBaseTimes()) {
+ GLint64 gpuTime, cpuTime;
- callQueries.push_back(query);
+ getCurrentTimes(cpuTime, gpuTime);
+ retrace::profiler.setBaseCpuTime(cpuTime);
+ retrace::profiler.setBaseGpuTime(gpuTime);
+ }
+ }
}
void
-endProfileGPU(trace::Call &call) {
- glEndQuery(GL_TIME_ELAPSED);
+frame_complete(trace::Call &call) {
+ if (retrace::profiling) {
+ /* Complete any remaining queries */
+ flushQueries();
+
+ /* GPU time drifts due to being relative times, not absolute and can be
+ * affected by the gpu switch between processes.
+ *
+ * To attempt to compensate we resynchronise on frame end however there is
+ * still noticeable drift within a single frame which we do not account for.
+ */
+ if (retrace::profilingCpuTimes || retrace::profilingGpuTimes) {
+ int64_t cpuTime, gpuTime, error;
+
+ getCurrentTimes(cpuTime, gpuTime);
+ cpuTime = cpuTime - retrace::profiler.getBaseCpuTime();
+ gpuTime = gpuTime - retrace::profiler.getBaseGpuTime();
+ error = gpuTime - cpuTime * (1.0E9 / os::timeFrequency);
+
+ retrace::profiler.setBaseGpuTime(retrace::profiler.getBaseGpuTime() + error);
+ }
+
+ /* Indicate end of current frame */
+ retrace::profiler.addFrameEnd();
+ }
+
+ retrace::frameComplete(call);
+
+ if (!currentDrawable) {
+ return;
+ }
+
+ if (retrace::debug && !currentDrawable->visible) {
+ retrace::warning(call) << "could not infer drawable size (glViewport never called)\n";
+ }
+}
+
+static const char*
+getDebugOutputSource(GLenum source) {
+ switch(source) {
+ case GL_DEBUG_SOURCE_API_ARB:
+ return "API";
+ case GL_DEBUG_SOURCE_WINDOW_SYSTEM_ARB:
+ return "Window System";
+ case GL_DEBUG_SOURCE_SHADER_COMPILER_ARB:
+ return "Shader Compiler";
+ case GL_DEBUG_SOURCE_THIRD_PARTY_ARB:
+ return "Third Party";
+ case GL_DEBUG_SOURCE_APPLICATION_ARB:
+ return "Application";
+ case GL_DEBUG_SOURCE_OTHER_ARB:
+ default:
+ return "";
+ }
+}
+
+static const char*
+getDebugOutputType(GLenum type) {
+ switch(type) {
+ case GL_DEBUG_TYPE_ERROR_ARB:
+ return "error";
+ case GL_DEBUG_TYPE_DEPRECATED_BEHAVIOR_ARB:
+ return "deprecated behaviour";
+ case GL_DEBUG_TYPE_UNDEFINED_BEHAVIOR_ARB:
+ return "undefined behaviour";
+ case GL_DEBUG_TYPE_PORTABILITY_ARB:
+ return "portability issue";
+ case GL_DEBUG_TYPE_PERFORMANCE_ARB:
+ return "performance issue";
+ case GL_DEBUG_TYPE_OTHER_ARB:
+ default:
+ return "unknown issue";
+ }
+}
+
+static const char*
+getDebugOutputSeverity(GLenum severity) {
+ switch(severity) {
+ case GL_DEBUG_SEVERITY_HIGH_ARB:
+ return "High";
+ case GL_DEBUG_SEVERITY_MEDIUM_ARB:
+ return "Medium";
+ case GL_DEBUG_SEVERITY_LOW_ARB:
+ return "Low";
+ default:
+ return "usnknown";
+ }
+}
+
+static void APIENTRY
+debugOutputCallback(GLenum source, GLenum type, GLuint id, GLenum severity, GLsizei length, const GLchar* message, GLvoid* userParam) {
+ std::cerr << retrace::callNo << ": ";
+ std::cerr << "glDebugOutputCallback: ";
+ std::cerr << getDebugOutputSeverity(severity) << " severity ";
+ std::cerr << getDebugOutputSource(source) << " " << getDebugOutputType(type);
+ std::cerr << " " << id;
+ std::cerr << ", " << message;
+ std::cerr << std::endl;
}
} /* namespace glretrace */
void
retrace::flushRendering(void) {
+ glretrace::flushQueries();
glFlush();
}
void
retrace::waitForInput(void) {
while (glws::processEvents()) {
+ os::sleep(100*1000);
}
}
projects / apitrace / blobdiff