/**************************************************************************
*
* Copyright 2011 Jose Fonseca
+ * Copyright (C) 2013 Intel Corporation. All rights reversed.
+ * Author: Shuang He <shuang.he@intel.com>
* All Rights Reserved.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
#include "glproc.hpp"
#include "glstate.hpp"
#include "glretrace.hpp"
+#include "os_time.hpp"
+#include "os_memory.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;
+bool supportsARBShaderObjects = false;
+enum {
+ GPU_START = 0,
+ GPU_DURATION,
+ OCCLUSION,
+ NUM_QUERIES,
+};
+
+struct CallQuery
+{
+ GLuint ids[NUM_QUERIES];
+ unsigned call;
+ bool isDraw;
+ GLuint program;
+ const trace::FunctionSig *sig;
+ int64_t cpuStart;
+ int64_t cpuEnd;
+ int64_t vsizeStart;
+ int64_t vsizeEnd;
+ int64_t rssStart;
+ int64_t rssEnd;
+};
+
+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) {
GLenum error = glGetError();
- if (error == GL_NO_ERROR) {
- return;
+ while (error != GL_NO_ERROR) {
+ std::ostream & os = retrace::warning(call);
+
+ os << "glGetError(";
+ os << call.name();
+ os << ") = ";
+
+ switch (error) {
+ case GL_INVALID_ENUM:
+ os << "GL_INVALID_ENUM";
+ break;
+ case GL_INVALID_VALUE:
+ os << "GL_INVALID_VALUE";
+ break;
+ case GL_INVALID_OPERATION:
+ os << "GL_INVALID_OPERATION";
+ break;
+ case GL_STACK_OVERFLOW:
+ os << "GL_STACK_OVERFLOW";
+ break;
+ case GL_STACK_UNDERFLOW:
+ os << "GL_STACK_UNDERFLOW";
+ break;
+ case GL_OUT_OF_MEMORY:
+ os << "GL_OUT_OF_MEMORY";
+ break;
+ case GL_INVALID_FRAMEBUFFER_OPERATION:
+ os << "GL_INVALID_FRAMEBUFFER_OPERATION";
+ break;
+ case GL_TABLE_TOO_LARGE:
+ os << "GL_TABLE_TOO_LARGE";
+ break;
+ default:
+ os << error;
+ break;
+ }
+ os << "\n";
+
+ error = glGetError();
}
+}
- std::ostream & os = retrace::warning(call);
-
- os << "glGetError(";
- os << call.name();
- os << ") = ";
-
- switch (error) {
- case GL_INVALID_ENUM:
- os << "GL_INVALID_ENUM";
- break;
- case GL_INVALID_VALUE:
- os << "GL_INVALID_VALUE";
- break;
- case GL_INVALID_OPERATION:
- os << "GL_INVALID_OPERATION";
- break;
- case GL_STACK_OVERFLOW:
- os << "GL_STACK_OVERFLOW";
- break;
- case GL_STACK_UNDERFLOW:
- os << "GL_STACK_UNDERFLOW";
- break;
- case GL_OUT_OF_MEMORY:
- os << "GL_OUT_OF_MEMORY";
- break;
- case GL_INVALID_FRAMEBUFFER_OPERATION:
- os << "GL_INVALID_FRAMEBUFFER_OPERATION";
- break;
- case GL_TABLE_TOO_LARGE:
- os << "GL_TABLE_TOO_LARGE";
- break;
- default:
- os << error;
- break;
+static inline int64_t
+getCurrentTime(void) {
+ if (retrace::profilingGpuTimes && supportsTimestamp) {
+ /* Get the current GL time without stalling */
+ GLint64 timestamp = 0;
+ glGetInteger64v(GL_TIMESTAMP, ×tamp);
+ return timestamp;
+ } else {
+ return os::getTime();
}
- os << "\n";
}
-struct CallQuery
-{
- GLuint ids[2];
- unsigned call;
- const trace::FunctionSig *sig;
-};
-
-static std::vector<CallQuery> callQueries;
-static GLuint frameQueries[2] = { 0, 0 };
+static inline int64_t
+getTimeFrequency(void) {
+ if (retrace::profilingGpuTimes && supportsTimestamp) {
+ return 1000000000;
+ } else {
+ return os::timeFrequency;
+ }
+}
-void frame_start() {
- if (retrace::profileGPU) {
- glGenQueries(2, frameQueries);
+static inline void
+getCurrentVsize(int64_t& vsize) {
+ vsize = os::getVsize();
+}
- /* Query frame start time */
- glQueryCounter(frameQueries[0], GL_TIMESTAMP);
- }
+static inline void
+getCurrentRss(int64_t& rss) {
+ rss = os::getRss();
}
-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, vsizeDuration = 0, rssDuration = 0;
- completeQueries();
- }
+ if (query.isDraw) {
+ if (retrace::profilingGpuTimes) {
+ if (supportsTimestamp) {
+ glGetQueryObjecti64vEXT(query.ids[GPU_START], GL_QUERY_RESULT, &gpuStart);
+ }
- retrace::frameComplete(call);
+ glGetQueryObjecti64vEXT(query.ids[GPU_DURATION], GL_QUERY_RESULT, &gpuDuration);
+ }
- /* Indicate start of next frame */
- frame_start();
+ if (retrace::profilingPixelsDrawn) {
+ glGetQueryObjecti64vEXT(query.ids[OCCLUSION], GL_QUERY_RESULT, &pixels);
+ }
- if (!currentDrawable) {
- return;
+ } else {
+ pixels = -1;
}
- if (retrace::debug && !currentDrawable->visible) {
- retrace::warning(call) << "could not infer drawable size (glViewport never called)\n";
+ if (retrace::profilingCpuTimes) {
+ double cpuTimeScale = 1.0E9 / getTimeFrequency();
+ cpuDuration = (query.cpuEnd - query.cpuStart) * cpuTimeScale;
+ query.cpuStart *= cpuTimeScale;
+ }
+
+ if (retrace::profilingMemoryUsage) {
+ vsizeDuration = query.vsizeEnd - query.vsizeStart;
+ rssDuration = query.rssEnd - query.rssStart;
}
+
+ glDeleteQueries(NUM_QUERIES, query.ids);
+
+ /* Add call to profile */
+ retrace::profiler.addCall(query.call, query.sig->name, query.program, pixels, gpuStart, gpuDuration, query.cpuStart, cpuDuration, query.vsizeStart, vsizeDuration, query.rssStart, rssDuration);
}
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) {
+ glretrace::Context *currentContext = glretrace::getCurrentContext();
+
+ /* Create call query */
+ CallQuery query;
+ query.isDraw = isDraw;
+ query.call = call.no;
+ query.sig = call.sig;
+ query.program = currentContext ? currentContext->activeProgram : 0;
+
+ glGenQueries(NUM_QUERIES, query.ids);
+
+ /* GPU profiling only for draw calls */
+ if (isDraw) {
+ if (retrace::profilingGpuTimes) {
+ if (supportsTimestamp) {
+ glQueryCounter(query.ids[GPU_START], GL_TIMESTAMP);
+ }
+
+ glBeginQuery(GL_TIME_ELAPSED, query.ids[GPU_DURATION]);
+ }
+
+ if (retrace::profilingPixelsDrawn) {
+ glBeginQuery(GL_SAMPLES_PASSED, query.ids[OCCLUSION]);
+ }
+ }
- /* 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) {
+ CallQuery& query = callQueries.back();
+ query.cpuStart = getCurrentTime();
+ }
- /* Loop through all active call queries */
- for (std::vector<CallQuery>::iterator itr = callQueries.begin(); itr != callQueries.end(); ++itr) {
- CallQuery& query = *itr;
- GLuint64 timestamp, duration;
+ if (retrace::profilingMemoryUsage) {
+ CallQuery& query = callQueries.back();
+ query.vsizeStart = os::getVsize();
+ query.rssStart = os::getRss();
+ }
+}
- /* 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);
+void
+endProfile(trace::Call &call, bool isDraw) {
- /* Add call to profile */
- retrace::profiler.addCall(trace::Profiler::Call(query.call, query.sig->name, timestamp, duration));
- }
+ /* CPU profiling for all calls */
+ if (retrace::profilingCpuTimes) {
+ CallQuery& query = callQueries.back();
+ query.cpuEnd = getCurrentTime();
+ }
+
+ /* GPU profiling only for draw calls */
+ if (isDraw) {
+ if (retrace::profilingGpuTimes) {
+ glEndQuery(GL_TIME_ELAPSED);
+ }
+
+ if (retrace::profilingPixelsDrawn) {
+ glEndQuery(GL_SAMPLES_PASSED);
+ }
+ }
- callQueries.clear();
+ if (retrace::profilingMemoryUsage) {
+ CallQuery& query = callQueries.back();
+ query.vsizeEnd = os::getVsize();
+ query.rssEnd = os::getRss();
+ }
}
void
-beginProfileGPU(trace::Call &call) {
- if (frameQueries[0] == 0) {
- frame_start();
- }
+initContext() {
+ glretrace::Context *currentContext = glretrace::getCurrentContext();
+
+ /* Ensure we have adequate extension support */
+ assert(currentContext);
+ supportsTimestamp = currentContext->hasExtension("GL_ARB_timer_query");
+ supportsElapsed = currentContext->hasExtension("GL_EXT_timer_query") || supportsTimestamp;
+ supportsOcclusion = currentContext->hasExtension("GL_ARB_occlusion_query");
+ supportsDebugOutput = currentContext->hasExtension("GL_ARB_debug_output");
+ supportsARBShaderObjects = currentContext->hasExtension("GL_ARB_shader_objects");
+
+ /* 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) {
+ glretrace::Context *currentContext = glretrace::getCurrentContext();
+ glDebugMessageCallbackARB(&debugOutputCallback, currentContext);
- /* Create start and duration queries */
- glGenQueries(2, query.ids);
- glQueryCounter(query.ids[0], GL_TIMESTAMP);
- glBeginQuery(GL_TIME_ELAPSED, query.ids[1]);
+ if (DEBUG_OUTPUT_SYNCHRONOUS) {
+ glEnable(GL_DEBUG_OUTPUT_SYNCHRONOUS_ARB);
+ }
+ }
+
+ /* Sync the gpu and cpu start times */
+ if (retrace::profilingCpuTimes || retrace::profilingGpuTimes) {
+ if (!retrace::profiler.hasBaseTimes()) {
+ double cpuTimeScale = 1.0E9 / getTimeFrequency();
+ GLint64 currentTime = getCurrentTime() * cpuTimeScale;
+ retrace::profiler.setBaseCpuTime(currentTime);
+ retrace::profiler.setBaseGpuTime(currentTime);
+ }
+ }
- callQueries.push_back(query);
+ if (retrace::profilingMemoryUsage) {
+ GLint64 currentVsize, currentRss;
+ getCurrentVsize(currentVsize);
+ retrace::profiler.setBaseVsizeUsage(currentVsize);
+ getCurrentRss(currentRss);
+ retrace::profiler.setBaseRssUsage(currentRss);
+ }
}
void
-endProfileGPU(trace::Call &call) {
- glEndQuery(GL_TIME_ELAPSED);
+frame_complete(trace::Call &call) {
+ if (retrace::profiling) {
+ /* Complete any remaining queries */
+ flushQueries();
+
+ /* Indicate end of current frame */
+ retrace::profiler.addFrameEnd();
+ }
+
+ retrace::frameComplete(call);
+
+ glretrace::Context *currentContext = glretrace::getCurrentContext();
+ if (!currentContext) {
+ return;
+ }
+
+ assert(currentContext->drawable);
+ if (retrace::debug && !currentContext->drawable->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 */
+class GLDumper : public retrace::Dumper {
+public:
+ image::Image *
+ getSnapshot(void) {
+ if (!glretrace::getCurrentContext()) {
+ return NULL;
+ }
+ return glstate::getDrawBufferImage();
+ }
+
+ bool
+ dumpState(std::ostream &os) {
+ glretrace::Context *currentContext = glretrace::getCurrentContext();
+ if (glretrace::insideGlBeginEnd ||
+ !currentContext) {
+ return false;
+ }
+ glstate::dumpCurrentContext(os);
+ return true;
+ }
+};
+
+static GLDumper glDumper;
+
+
void
retrace::setUp(void) {
glws::init();
+ dumper = &glDumper;
}
}
-image::Image *
-retrace::getSnapshot(void) {
- if (!glretrace::currentDrawable) {
- return NULL;
- }
-
- return glstate::getDrawBufferImage();
-}
-
-
-bool
-retrace::dumpState(std::ostream &os)
-{
- if (glretrace::insideGlBeginEnd ||
- !glretrace::currentDrawable ||
- !glretrace::currentContext) {
- return false;
- }
-
- glstate::dumpCurrentContext(os);
-
- return true;
-}
-
void
retrace::flushRendering(void) {
- glFlush();
+ glretrace::Context *currentContext = glretrace::getCurrentContext();
+ if (currentContext) {
+ glretrace::flushQueries();
+ glFlush();
+ }
}
void
retrace::waitForInput(void) {
+ glretrace::Context *currentContext = glretrace::getCurrentContext();
+ if (currentContext) {
+ glretrace::flushQueries();
+ glFlush();
+ }
while (glws::processEvents()) {
+ os::sleep(100*1000);
}
}
projects / apitrace / blobdiff