#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 {
{
GLuint ids[3];
unsigned call;
+ bool isDraw;
GLuint program;
const trace::FunctionSig *sig;
- uint64_t start;
- uint64_t duration;
+ int64_t cpuStart;
+ int64_t cpuEnd;
};
static bool supportsElapsed = true;
static bool supportsTimestamp = true;
static bool supportsOcclusion = true;
+static bool supportsDebugOutput = true;
-static bool firstFrame = true;
static std::list<CallQuery> callQueries;
-static std::map<glws::Context*, GLuint> activePrograms;
+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";
}
-static GLuint64
-getGpuTimestamp() {
- GLuint query = 0;
- GLuint64 timestamp = 0;
+static void
+getCurrentTimes(int64_t& cpuTime, int64_t& gpuTime) {
+ GLuint query;
if (retrace::profilingGpuTimes && supportsTimestamp) {
glGenQueries(1, &query);
glQueryCounter(query, GL_TIMESTAMP);
- glGetQueryObjectui64vEXT(query, GL_QUERY_RESULT, ×tamp);
- glDeleteQueries(1, &query);
+ glGetQueryObjecti64vEXT(query, GL_QUERY_RESULT, &gpuTime);
+ } else {
+ gpuTime = 0;
}
- return timestamp;
-}
-
-static GLuint64
-getCpuTimestamp() {
if (retrace::profilingCpuTimes) {
- return os::getTime();
+ cpuTime = os::getTime();
} else {
- return 0;
+ cpuTime = 0;
+ }
+
+ if (retrace::profilingGpuTimes && supportsTimestamp) {
+ glDeleteQueries(1, &query);
}
}
static void
completeCallQuery(CallQuery& query) {
/* Get call start and duration */
- GLuint64 timestamp = 0, duration = 0, samples = 0;
+ int64_t gpuStart = 0, gpuDuration = 0, cpuDuration = 0, pixels = 0;
- if (retrace::profilingGpuTimes) {
- if (supportsTimestamp) {
- glGetQueryObjectui64vEXT(query.ids[0], GL_QUERY_RESULT, ×tamp);
+ if (query.isDraw) {
+ if (retrace::profilingGpuTimes) {
+ if (supportsTimestamp) {
+ glGetQueryObjecti64vEXT(query.ids[0], GL_QUERY_RESULT, &gpuStart);
+ }
+
+ glGetQueryObjecti64vEXT(query.ids[1], GL_QUERY_RESULT, &gpuDuration);
}
- if (supportsElapsed) {
- glGetQueryObjectui64vEXT(query.ids[1], GL_QUERY_RESULT, &duration);
+ if (retrace::profilingPixelsDrawn) {
+ glGetQueryObjecti64vEXT(query.ids[2], GL_QUERY_RESULT, &pixels);
}
- }
- if (retrace::profilingPixelsDrawn && supportsOcclusion) {
- glGetQueryObjectui64vEXT(query.ids[2], GL_QUERY_RESULT, &samples);
+ glDeleteQueries(3, query.ids);
+ } else {
+ pixels = -1;
}
- glDeleteQueries(3, query.ids);
+ if (retrace::profilingCpuTimes) {
+ cpuDuration = query.cpuEnd - query.cpuStart;
+ }
/* Add call to profile */
- retrace::profiler.addCall(query.call, query.sig->name, query.program, samples, timestamp, duration, query.start, query.duration);
+ retrace::profiler.addCall(query.call, query.sig->name, query.program, pixels, gpuStart, gpuDuration, query.cpuStart, cpuDuration);
}
void
callQueries.clear();
}
-void setActiveProgram(GLuint program)
-{
- activePrograms[glretrace::currentContext] = program;
-}
-
-static GLuint
-getActiveProgram()
-{
- std::map<glws::Context*, GLuint>::iterator it;
- it = activePrograms.find(glretrace::currentContext);
- if (it == activePrograms.end())
- return 0;
-
- return it->second;
-}
-
void
-beginProfile(trace::Call &call) {
- if (firstFrame) {
- /* Check for extension support */
- const char* extensions = (const char*)glGetString(GL_EXTENSIONS);
- GLint bits;
+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;
- 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);
+ /* GPU profiling only for draw calls */
+ if (isDraw) {
+ glGenQueries(3, query.ids);
if (retrace::profilingGpuTimes) {
- if (!supportsTimestamp && !supportsElapsed) {
- std::cout << "Error: Cannot run profile, GL_EXT_timer_query extension is not supported." << std::endl;
- exit(-1);
+ if (supportsTimestamp) {
+ glQueryCounter(query.ids[0], GL_TIMESTAMP);
}
- 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);
- }
+ glBeginQuery(GL_TIME_ELAPSED, query.ids[1]);
}
- if (retrace::profilingPixelsDrawn && !supportsOcclusion) {
- std::cout << "Error: Cannot run profile, GL_ARB_occlusion_query extension is not supported." << std::endl;
- exit(-1);
+ if (retrace::profilingPixelsDrawn) {
+ glBeginQuery(GL_SAMPLES_PASSED, query.ids[2]);
}
+ }
- frame_start();
+ callQueries.push_back(query);
+
+ /* CPU profiling for all calls */
+ if (retrace::profilingCpuTimes) {
+ callQueries.back().cpuStart = os::getTime();
}
+}
- /* Create call query */
- CallQuery query;
- query.call = call.no;
- query.sig = call.sig;
- query.program = getActiveProgram();
+void
+endProfile(trace::Call &call, bool isDraw) {
+ GLint64 time = os::getTime();
- glGenQueries(3, query.ids);
+ /* CPU profiling for all calls */
+ if (retrace::profilingCpuTimes) {
+ CallQuery& query = callQueries.back();
+ query.cpuEnd = time;
+ }
- if (retrace::profilingGpuTimes) {
- if (supportsTimestamp) {
- glQueryCounter(query.ids[0], GL_TIMESTAMP);
+ /* GPU profiling only for draw calls */
+ if (isDraw) {
+ if (retrace::profilingGpuTimes) {
+ glEndQuery(GL_TIME_ELAPSED);
}
- if (supportsElapsed) {
- glBeginQuery(GL_TIME_ELAPSED, query.ids[1]);
+ if (retrace::profilingPixelsDrawn) {
+ glEndQuery(GL_SAMPLES_PASSED);
}
}
+}
- if (retrace::profilingPixelsDrawn && supportsOcclusion) {
- glBeginQuery(GL_SAMPLES_PASSED, query.ids[2]);
- }
+void
+initContext() {
+ const char* extensions = (const char*)glGetString(GL_EXTENSIONS);
- if (retrace::profilingCpuTimes) {
- query.start = os::getTime();
- }
+ /* 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);
- callQueries.push_back(query);
-}
+ /* 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);
+ }
-void
-endProfile(trace::Call &call) {
- if (retrace::profilingCpuTimes) {
- CallQuery& query = callQueries.back();
- query.duration = os::getTime() - query.start;
+ 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);
+ }
}
- if (retrace::profilingGpuTimes && supportsElapsed) {
- glEndQuery(GL_TIME_ELAPSED);
+ /* 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);
}
- if (retrace::profilingPixelsDrawn && supportsOcclusion) {
- glEndQuery(GL_SAMPLES_PASSED);
+ /* Setup debug message call back */
+ if (retrace::debug && supportsDebugOutput) {
+ glDebugMessageCallbackARB(&debugOutputCallback, currentContext);
+
+ if (DEBUG_OUTPUT_SYNCHRONOUS) {
+ glEnable(GL_DEBUG_OUTPUT_SYNCHRONOUS_ARB);
+ }
}
-}
-void
-frame_start() {
- firstFrame = false;
+ /* Sync the gpu and cpu start times */
+ if (retrace::profilingCpuTimes || retrace::profilingGpuTimes) {
+ if (!retrace::profiler.hasBaseTimes()) {
+ GLint64 gpuTime, cpuTime;
- if (retrace::profiling) {
- retrace::profiler.addFrameStart(retrace::frameNo, getGpuTimestamp(), getCpuTimestamp());
+ getCurrentTimes(cpuTime, gpuTime);
+ retrace::profiler.setBaseCpuTime(cpuTime);
+ retrace::profiler.setBaseGpuTime(gpuTime);
+ }
}
}
/* 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;
+
+ retrace::profiler.setBaseGpuTime(retrace::profiler.getBaseGpuTime() + error);
+ }
+
/* Indicate end of current frame */
- retrace::profiler.addFrameEnd(getGpuTimestamp(), getCpuTimestamp());
+ retrace::profiler.addFrameEnd();
}
retrace::frameComplete(call);
- /* Indicate start of next frame */
- frame_start();
-
if (!currentDrawable) {
return;
}
}
}
+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 */
projects / apitrace / blobdiff