git.cworth.org Git - apitrace/blob - retrace/retrace_main.cpp

   1 /**************************************************************************
   2  *
   3  * Copyright 2011 Jose Fonseca
   4  * All Rights Reserved.
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a copy
   7  * of this software and associated documentation files (the "Software"), to deal
   8  * in the Software without restriction, including without limitation the rights
   9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  10  * copies of the Software, and to permit persons to whom the Software is
  11  * furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included in
  14  * all copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  22  * THE SOFTWARE.
  23  *
  24  **************************************************************************/
  25
  26
  27 #include <string.h>
  28 #include <iostream>
  29
  30 #include "os_binary.hpp"
  31 #include "os_time.hpp"
  32 #include "image.hpp"
  33 #include "trace_callset.hpp"
  34 #include "trace_dump.hpp"
  35 #include "retrace.hpp"
  36
  37
  38 static bool waitOnFinish = false;
  39
  40 static const char *comparePrefix = NULL;
  41 static const char *snapshotPrefix = NULL;
  42 static trace::CallSet snapshotFrequency;
  43 static trace::CallSet compareFrequency;
  44
  45 static unsigned dumpStateCallNo = ~0;
  46
  47
  48 namespace retrace {
  49
  50
  51 trace::Parser parser;
  52
  53
  54 int verbosity = 0;
  55 bool debug = true;
  56 bool profiling = false;
  57
  58
  59 bool doubleBuffer = true;
  60 bool coreProfile = false;
  61
  62
  63 static unsigned frameNo = 0;
  64
  65
  66 void
  67 frameComplete(trace::Call &call) {
  68     ++frameNo;
  69 }
  70
  71
  72 static void
  73 takeSnapshot(unsigned call_no) {
  74     assert(snapshotPrefix || comparePrefix);
  75
  76     image::Image *ref = NULL;
  77
  78     if (comparePrefix) {
  79         os::String filename = os::String::format("%s%010u.png", comparePrefix, call_no);
  80         ref = image::readPNG(filename);
  81         if (!ref) {
  82             return;
  83         }
  84         if (retrace::verbosity >= 0) {
  85             std::cout << "Read " << filename << "\n";
  86         }
  87     }
  88
  89     image::Image *src = getSnapshot();
  90     if (!src) {
  91         return;
  92     }
  93
  94     if (snapshotPrefix) {
  95         if (snapshotPrefix[0] == '-' && snapshotPrefix[1] == 0) {
  96             char comment[21];
  97             snprintf(comment, sizeof comment, "%u", call_no);
  98             src->writePNM(std::cout, comment);
  99         } else {
 100             os::String filename = os::String::format("%s%010u.png", snapshotPrefix, call_no);
 101             if (src->writePNG(filename) && retrace::verbosity >= 0) {
 102                 std::cout << "Wrote " << filename << "\n";
 103             }
 104         }
 105     }
 106
 107     if (ref) {
 108         std::cout << "Snapshot " << call_no << " average precision of " << src->compare(*ref) << " bits\n";
 109         delete ref;
 110     }
 111
 112     delete src;
 113
 114     return;
 115 }
 116
 117
 118 static void
 119 mainLoop() {
 120     retrace::Retracer retracer;
 121
 122     addCallbacks(retracer);
 123
 124     long long startTime = 0;
 125
 126     startTime = os::getTime();
 127     trace::Call *call;
 128
 129     while ((call = retrace::parser.parse_call())) {
 130         bool swapRenderTarget = call->flags & trace::CALL_FLAG_SWAP_RENDERTARGET;
 131         bool doSnapshot =
 132             snapshotFrequency.contains(*call) ||
 133             compareFrequency.contains(*call)
 134         ;
 135
 136         // For calls which cause rendertargets to be swaped, we take the
 137         // snapshot _before_ swapping the rendertargets.
 138         if (doSnapshot && swapRenderTarget) {
 139             if (call->flags & trace::CALL_FLAG_END_FRAME) {
 140                 // For swapbuffers/presents we still use this call number,
 141                 // spite not have been executed yet.
 142                 takeSnapshot(call->no);
 143             } else {
 144                 // Whereas for ordinate fbo/rendertarget changes we use the
 145                 // previous call's number.
 146                 takeSnapshot(call->no - 1);
 147             }
 148         }
 149
 150         retracer.retrace(*call);
 151
 152         if (doSnapshot && !swapRenderTarget) {
 153             takeSnapshot(call->no);
 154         }
 155
 156         if (call->no >= dumpStateCallNo &&
 157             dumpState(std::cout)) {
 158             exit(0);
 159         }
 160
 161         delete call;
 162     }
 163
 164     // Reached the end of trace
 165     flushRendering();
 166
 167     long long endTime = os::getTime();
 168     float timeInterval = (endTime - startTime) * (1.0 / os::timeFrequency);
 169
 170     if ((retrace::verbosity >= -1) || (retrace::profiling)) {
 171         std::cout <<
 172             "Rendered " << frameNo << " frames"
 173             " in " <<  timeInterval << " secs,"
 174             " average of " << (frameNo/timeInterval) << " fps\n";
 175     }
 176
 177     if (waitOnFinish) {
 178         waitForInput();
 179     } else {
 180         exit(0);
 181     }
 182 }
 183
 184
 185 } /* namespace retrace */
 186
 187
 188 static void
 189 usage(const char *argv0) {
 190     std::cout <<
 191         "Usage: " << argv0 << " [OPTION] TRACE\n"
 192         "Replay TRACE.\n"
 193         "\n"
 194         "  -b           benchmark mode (no error checking or warning messages)\n"
 195         "  -p           profiling mode (run whole trace, dump profiling info)\n"
 196         "  -c PREFIX    compare against snapshots\n"
 197         "  -C CALLSET   calls to compare (default is every frame)\n"
 198         "  -core        use core profile\n"
 199         "  -db          use a double buffer visual (default)\n"
 200         "  -sb          use a single buffer visual\n"
 201         "  -s PREFIX    take snapshots; `-` for PNM stdout output\n"
 202         "  -S CALLSET   calls to snapshot (default is every frame)\n"
 203         "  -v           increase output verbosity\n"
 204         "  -D CALLNO    dump state at specific call no\n"
 205         "  -w           waitOnFinish on final frame\n";
 206 }
 207
 208
 209 extern "C"
 210 int main(int argc, char **argv)
 211 {
 212     assert(compareFrequency.empty());
 213     assert(snapshotFrequency.empty());
 214
 215     int i;
 216     for (i = 1; i < argc; ++i) {
 217         const char *arg = argv[i];
 218
 219         if (arg[0] != '-') {
 220             break;
 221         }
 222
 223         if (!strcmp(arg, "--")) {
 224             break;
 225         } else if (!strcmp(arg, "-b")) {
 226             retrace::debug = false;
 227             retrace::verbosity = -1;
 228         } else if (!strcmp(arg, "-p")) {
 229             retrace::debug = false;
 230             retrace::profiling = true;
 231             retrace::verbosity = -1;
 232         } else if (!strcmp(arg, "-c")) {
 233             comparePrefix = argv[++i];
 234             if (compareFrequency.empty()) {
 235                 compareFrequency = trace::CallSet(trace::FREQUENCY_FRAME);
 236             }
 237         } else if (!strcmp(arg, "-C")) {
 238             compareFrequency = trace::CallSet(argv[++i]);
 239             if (comparePrefix == NULL) {
 240                 comparePrefix = "";
 241             }
 242         } else if (!strcmp(arg, "-D")) {
 243             dumpStateCallNo = atoi(argv[++i]);
 244             retrace::verbosity = -2;
 245         } else if (!strcmp(arg, "-core")) {
 246             retrace::coreProfile = true;
 247         } else if (!strcmp(arg, "-db")) {
 248             retrace::doubleBuffer = true;
 249         } else if (!strcmp(arg, "-sb")) {
 250             retrace::doubleBuffer = false;
 251         } else if (!strcmp(arg, "--help")) {
 252             usage(argv[0]);
 253             return 0;
 254         } else if (!strcmp(arg, "-s")) {
 255             snapshotPrefix = argv[++i];
 256             if (snapshotFrequency.empty()) {
 257                 snapshotFrequency = trace::CallSet(trace::FREQUENCY_FRAME);
 258             }
 259             if (snapshotPrefix[0] == '-' && snapshotPrefix[1] == 0) {
 260                 os::setBinaryMode(stdout);
 261                 retrace::verbosity = -2;
 262             }
 263         } else if (!strcmp(arg, "-S")) {
 264             snapshotFrequency = trace::CallSet(argv[++i]);
 265             if (snapshotPrefix == NULL) {
 266                 snapshotPrefix = "";
 267             }
 268         } else if (!strcmp(arg, "-v")) {
 269             ++retrace::verbosity;
 270         } else if (!strcmp(arg, "-w")) {
 271             waitOnFinish = true;
 272         } else {
 273             std::cerr << "error: unknown option " << arg << "\n";
 274             usage(argv[0]);
 275             return 1;
 276         }
 277     }
 278
 279     retrace::setUp();
 280
 281     for ( ; i < argc; ++i) {
 282         if (!retrace::parser.open(argv[i])) {
 283             std::cerr << "error: failed to open " << argv[i] << "\n";
 284             return 1;
 285         }
 286
 287         retrace::mainLoop();
 288
 289         retrace::parser.close();
 290     }
 291
 292     retrace::cleanUp();
 293
 294     return 0;
 295 }
 296