]> git.cworth.org Git - apitrace/blobdiff - retrace/glretrace_main.cpp
glretrace: Use GL_TIMESTAMP (if available) for CPU profiling.
[apitrace] / retrace / glretrace_main.cpp
index c01b67d2a17ad0f844a2817eb6d703f7fb5f5099..b8ef2623a87931dba4c7cb4225b6cfa3a43ca774 100755 (executable)
@@ -43,10 +43,18 @@ namespace glretrace {
 bool insideList = false;
 bool insideGlBeginEnd = false;
 
+enum {
+    GPU_START = 0,
+    GPU_DURATION,
+    OCCLUSION,
+    NUM_QUERIES,
+};
+
 struct CallQuery
 {
-    GLuint ids[3];
+    GLuint ids[NUM_QUERIES];
     unsigned call;
+    bool isDraw;
     GLuint program;
     const trace::FunctionSig *sig;
     int64_t cpuStart;
@@ -58,7 +66,6 @@ static bool supportsTimestamp = true;
 static bool supportsOcclusion = true;
 static bool supportsDebugOutput = true;
 
-static bool firstFrame = true;
 static std::list<CallQuery> callQueries;
 
 static void APIENTRY
@@ -67,97 +74,124 @@ debugOutputCallback(GLenum source, GLenum type, GLuint id, GLenum severity, GLsi
 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, &timestamp);
+        return timestamp;
+    } else {
+        return os::getTime();
     }
-    os << "\n";
 }
 
-static inline GLint64
-getGpuTimestamp() {
+static inline int64_t
+getTimeFrequency(void) {
+    if (retrace::profilingGpuTimes && supportsTimestamp) {
+        return 1000000000;
+    } else {
+        return os::timeFrequency;
+    }
+}
+
+static void
+getCurrentTimes(int64_t& cpuTime, int64_t& gpuTime) {
     GLuint query = 0;
-    GLint64 timestamp = 0;
 
     if (retrace::profilingGpuTimes && supportsTimestamp) {
         glGenQueries(1, &query);
         glQueryCounter(query, GL_TIMESTAMP);
+        GLint64 timestamp = 0;
         glGetQueryObjecti64vEXT(query, GL_QUERY_RESULT, &timestamp);
-        glDeleteQueries(1, &query);
+        gpuTime = timestamp;
+    } else {
+        gpuTime = 0;
     }
 
-    return timestamp;
-}
-
-static inline GLint64
-getCpuTimestamp() {
     if (retrace::profilingCpuTimes) {
-        return os::getTime();
+        cpuTime = getCurrentTime();
     } else {
-        return 0;
+        cpuTime = 0;
+    }
+
+    if (retrace::profilingGpuTimes && supportsTimestamp) {
+        glDeleteQueries(1, &query);
     }
 }
 
 static void
 completeCallQuery(CallQuery& query) {
     /* Get call start and duration */
-    GLint64 gpuStart = 0, gpuDuration = 0, cpuDuration = 0, samples = 0;
+    int64_t gpuStart = 0, gpuDuration = 0, cpuDuration = 0, pixels = 0;
 
-    if (retrace::profilingGpuTimes) {
-        if (supportsTimestamp) {
-            glGetQueryObjecti64vEXT(query.ids[0], GL_QUERY_RESULT, &gpuStart);
+    if (query.isDraw) {
+        if (retrace::profilingGpuTimes) {
+            if (supportsTimestamp) {
+                glGetQueryObjecti64vEXT(query.ids[GPU_START], GL_QUERY_RESULT, &gpuStart);
+            }
+
+            glGetQueryObjecti64vEXT(query.ids[GPU_DURATION], GL_QUERY_RESULT, &gpuDuration);
+        }
+
+        if (retrace::profilingPixelsDrawn) {
+            glGetQueryObjecti64vEXT(query.ids[OCCLUSION], GL_QUERY_RESULT, &pixels);
         }
 
-        glGetQueryObjecti64vEXT(query.ids[1], GL_QUERY_RESULT, &gpuDuration);
+    } else {
+        pixels = -1;
     }
 
     if (retrace::profilingCpuTimes) {
         cpuDuration = query.cpuEnd - query.cpuStart;
     }
 
-    if (retrace::profilingPixelsDrawn) {
-        glGetQueryObjecti64vEXT(query.ids[2], GL_QUERY_RESULT, &samples);
-    }
-
-    glDeleteQueries(3, query.ids);
+    glDeleteQueries(NUM_QUERIES, query.ids);
 
     /* Add call to profile */
-    retrace::profiler.addCall(query.call, query.sig->name, query.program, samples, gpuStart, gpuDuration, query.cpuStart, cpuDuration);
+    retrace::profiler.addCall(query.call, query.sig->name, query.program, pixels, gpuStart, gpuDuration, query.cpuStart, cpuDuration);
 }
 
 void
@@ -171,51 +205,51 @@ flushQueries() {
 
 void
 beginProfile(trace::Call &call, bool isDraw) {
-    if (firstFrame) {
-        frame_start();
-    }
+    glretrace::Context *currentContext = glretrace::getCurrentContext();
 
     /* Create call query */
     CallQuery query;
+    query.isDraw = isDraw;
     query.call = call.no;
     query.sig = call.sig;
-    query.program = glretrace::currentContext ? glretrace::currentContext->activeProgram : 0;
+    query.program = currentContext ? currentContext->activeProgram : 0;
 
-    if (isDraw) {
-        glGenQueries(3, query.ids);
+    glGenQueries(NUM_QUERIES, query.ids);
 
+    /* GPU profiling only for draw calls */
+    if (isDraw) {
         if (retrace::profilingGpuTimes) {
             if (supportsTimestamp) {
-                glQueryCounter(query.ids[0], GL_TIMESTAMP);
+                glQueryCounter(query.ids[GPU_START], GL_TIMESTAMP);
             }
 
-            glBeginQuery(GL_TIME_ELAPSED, query.ids[1]);
+            glBeginQuery(GL_TIME_ELAPSED, query.ids[GPU_DURATION]);
         }
 
         if (retrace::profilingPixelsDrawn) {
-            glBeginQuery(GL_SAMPLES_PASSED, query.ids[2]);
+            glBeginQuery(GL_SAMPLES_PASSED, query.ids[OCCLUSION]);
         }
     }
 
+    callQueries.push_back(query);
+
+    /* CPU profiling for all calls */
     if (retrace::profilingCpuTimes) {
-        query.cpuStart = getCpuTimestamp();
+        CallQuery& query = callQueries.back();
+        query.cpuStart = getCurrentTime();
     }
-
-    callQueries.push_back(query);
 }
 
 void
 endProfile(trace::Call &call, bool isDraw) {
+
+    /* CPU profiling for all calls */
     if (retrace::profilingCpuTimes) {
         CallQuery& query = callQueries.back();
-        query.cpuEnd = getCpuTimestamp();
-
-        if (!isDraw) {
-            retrace::profiler.addCall(query.call, query.sig->name, query.program, -1, 0, 0, query.cpuStart, query.cpuEnd - query.cpuStart);
-            callQueries.pop_back();
-        }
+        query.cpuEnd = getCurrentTime();
     }
 
+    /* GPU profiling only for draw calls */
     if (isDraw) {
         if (retrace::profilingGpuTimes) {
             glEndQuery(GL_TIME_ELAPSED);
@@ -229,17 +263,16 @@ endProfile(trace::Call &call, bool isDraw) {
 
 void
 initContext() {
-    GLint64 gpuTime = 0, cpuTime = 0;
-    const char* extensions;
-
-    extensions = (const char*)glGetString(GL_EXTENSIONS);
+    glretrace::Context *currentContext = glretrace::getCurrentContext();
 
     /* 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);
+    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");
 
+    /* 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;
@@ -255,12 +288,15 @@ initContext() {
         }
     }
 
+    /* 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);
 
         if (DEBUG_OUTPUT_SYNCHRONOUS) {
@@ -269,27 +305,14 @@ initContext() {
     }
 
     /* Sync the gpu and cpu start times */
-    if (!retrace::profiler.hasBaseTimes()) {
-        if (retrace::profilingGpuTimes) {
-            gpuTime = getGpuTimestamp();
-        }
+    if (retrace::profilingCpuTimes || retrace::profilingGpuTimes) {
+        if (!retrace::profiler.hasBaseTimes()) {
+            GLint64 gpuTime, cpuTime;
 
-        if (retrace::profilingCpuTimes) {
-            cpuTime = getCpuTimestamp();
+            getCurrentTimes(cpuTime, gpuTime);
+            retrace::profiler.setBaseCpuTime(cpuTime);
+            retrace::profiler.setBaseGpuTime(gpuTime);
         }
-
-        retrace::profiler.setBaseTimes(gpuTime, cpuTime);
-    }
-}
-
-void
-frame_start() {
-    firstFrame = false;
-
-    if (retrace::profiling) {
-        int64_t gpuStart = getGpuTimestamp();
-        int64_t cpuStart = getCpuTimestamp();
-        retrace::profiler.addFrameStart(retrace::frameNo, gpuStart, cpuStart);
     }
 }
 
@@ -299,22 +322,39 @@ frame_complete(trace::Call &call) {
         /* 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 / getTimeFrequency());
+            std::cerr << "error = " << error << "\n";
+
+            if (0) {
+                retrace::profiler.setBaseGpuTime(retrace::profiler.getBaseGpuTime() + error);
+            }
+        }
+
         /* Indicate end of current frame */
-        int64_t gpuEnd = getGpuTimestamp();
-        int64_t cpuEnd = getCpuTimestamp();
-        retrace::profiler.addFrameEnd(gpuEnd, cpuEnd);
+        retrace::profiler.addFrameEnd();
     }
 
     retrace::frameComplete(call);
 
-    /* Indicate start of next frame */
-    frame_start();
-
-    if (!currentDrawable) {
+    glretrace::Context *currentContext = glretrace::getCurrentContext();
+    if (!currentContext) {
         return;
     }
 
-    if (retrace::debug && !currentDrawable->visible) {
+    assert(currentContext->drawable);
+    if (retrace::debug && !currentContext->drawable->visible) {
         retrace::warning(call) << "could not infer drawable size (glViewport never called)\n";
     }
 }
@@ -385,9 +425,35 @@ debugOutputCallback(GLenum source, GLenum type, GLuint id, GLenum severity, GLsi
 } /* 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;
 }
 
 
@@ -402,39 +468,19 @@ retrace::addCallbacks(retrace::Retracer &retracer)
 }
 
 
-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) {
-    glretrace::flushQueries();
-    glFlush();
+    glretrace::Context *currentContext = glretrace::getCurrentContext();
+    if (currentContext) {
+        glretrace::flushQueries();
+        glFlush();
+    }
 }
 
 void
 retrace::waitForInput(void) {
     while (glws::processEvents()) {
+        os::sleep(100*1000);
     }
 }