forked from apitrace/apitrace
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathretrace_main.cpp
1383 lines (1187 loc) · 40.1 KB
/
retrace_main.cpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/**************************************************************************
*
* Copyright 2011 Jose Fonseca
* Copyright (C) 2013 Intel Corporation. All rights reversed.
* Author: Shuang He <[email protected]>
* All Rights Reserved.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*
**************************************************************************/
#include <string.h>
#include <limits.h> // for CHAR_MAX
#include <memory> // for unique_ptr
#include <iostream>
#include <regex>
#include <getopt.h>
#ifndef _WIN32
#include <unistd.h> // for isatty()
#endif
#ifdef _WIN32
#include <malloc.h> // _get_heap_handle
#include <new.h>
#include <windows.h>
#include <psapi.h>
#endif
#include "os_binary.hpp"
#include "os_crtdbg.hpp"
#include "os_time.hpp"
#include "os_thread.hpp"
#include "image.hpp"
#include "threaded_snapshot.hpp"
#include "trace_callset.hpp"
#include "trace_dump.hpp"
#include "trace_option.hpp"
#include "retrace.hpp"
#include "state_writer.hpp"
#include "ws.hpp"
#include "process_name.hpp"
static bool waitOnFinish = false;
static const char *snapshotPrefix = "";
static enum {
PNM_FMT,
RAW_RGB,
RAW_MD5
} snapshotFormat = PNM_FMT;
static trace::CallSet snapshotFrequency;
static unsigned snapshotInterval = 0;
static unsigned dumpStateCallNo = ~0;
retrace::Retracer retracer;
namespace retrace {
trace::AbstractParser *parser;
trace::Profiler profiler;
int verbosity = 0;
int debug = 1;
bool markers = false;
bool snapshotMRT = false;
bool snapshotAlpha = false;
bool forceWindowed = true;
bool dumpingState = false;
bool dumpingSnapshots = false;
bool ignoreCalls = false;
trace::CallSet callsToIgnore;
bool resolveMSAA = true;
Driver driver = DRIVER_DEFAULT;
const char *driverModule = NULL;
bool doubleBuffer = true;
unsigned samples = 1;
unsigned curPass = 0;
unsigned numPasses = 1;
bool profilingWithBackends = false;
char* profilingCallsMetricsString;
char* profilingFramesMetricsString;
char* profilingDrawCallsMetricsString;
bool profilingListMetrics = false;
bool profilingNumPasses = false;
bool profiling = false;
bool profilingFrameTimes = false;
bool profilingGpuTimes = false;
bool profilingCpuTimes = false;
bool profilingPixelsDrawn = false;
bool profilingMemoryUsage = false;
bool useCallNos = true;
bool singleThread = false;
bool ignoreRetvals = false;
bool contextCheck = true;
bool snapshotForceBackbuffer = false;
int64_t minCpuTime = 1000;
retrace::EQueryHandling queryResultHandling = retrace::QUERY_SKIP;
unsigned frameNo = 0;
unsigned callNo = 0;
long long lastFrameTime = 0;
long long perFrameDelayUsec = 0;
long long minFrameDurationUsec = 0;
static void
takeSnapshot(unsigned call_no, bool backBuffer);
/**
* Called when we are about to present.
*
* This is necessary presentation modes discard the presented contents, so we
* must take the snapshot before the actual present call.
*/
void
frameComplete(trace::Call &call)
{
++frameNo;
bool bNeedFrameDelay = perFrameDelayUsec || minFrameDurationUsec;
if (bNeedFrameDelay) {
long long startTime = os::getTime();
long long delayUsec = perFrameDelayUsec;
if (lastFrameTime > 0) {
long long actualFrameTime = startTime - lastFrameTime;
if (actualFrameTime < 0) {
actualFrameTime = 0;
std::cerr << "warning: os::getTime() returned a negative interval.\n";
}
long long actualFrameTimeUsec = actualFrameTime *
1000 * 1000 / os::timeFrequency;
if (actualFrameTimeUsec < minFrameDurationUsec) {
delayUsec += minFrameDurationUsec - actualFrameTimeUsec;
}
}
if (delayUsec > 0) {
os::sleep(delayUsec);
}
}
if (snapshotFrequency.contains(call)) {
takeSnapshot(call.no, snapshotForceBackbuffer);
if (call.no >= snapshotFrequency.getLast()) {
exit(0);
}
}
if (bNeedFrameDelay) {
lastFrameTime = os::getTime();
}
}
class DefaultDumper: public Dumper
{
public:
int
getSnapshotCount(void) override {
return 0;
}
image::Image *
getSnapshot(int n, bool backBuffer) override {
return NULL;
}
bool
canDump(void) override {
return false;
}
void
dumpState(StateWriter &writer) override {
assert(0);
}
};
static DefaultDumper defaultDumper;
Dumper *dumper = &defaultDumper;
typedef StateWriter *(*StateWriterFactory)(std::ostream &);
static StateWriterFactory stateWriterFactory = createJSONStateWriter;
static Snapshotter *snapshotter;
/**
* Take snapshots.
*/
static void
takeSnapshot(unsigned call_no, int mrt, unsigned snapshot_no, bool backBuffer) {
assert(dumpingSnapshots);
assert(snapshotPrefix);
std::unique_ptr<image::Image> src(dumper->getSnapshot(mrt, backBuffer));
if (!src) {
/* TODO for mrt>0 we probably don't want to treat this as an error: */
if (mrt == 0)
std::cerr << call_no << ": warning: failed to get snapshot\n";
return;
}
if ((snapshotInterval == 0 ||
(snapshot_no % snapshotInterval) == 0)) {
if (snapshotPrefix[0] == '-' && snapshotPrefix[1] == 0) {
char comment[21];
snprintf(comment, sizeof comment, "%u",
useCallNos ? call_no : snapshot_no);
switch (snapshotFormat) {
case PNM_FMT:
src->writePNM(std::cout, comment);
break;
case RAW_RGB:
src->writeRAW(std::cout);
break;
case RAW_MD5:
src->writeMD5(std::cout);
break;
default:
assert(0);
break;
}
} else {
os::String filename;
unsigned no = useCallNos ? call_no : snapshot_no;
if (!retrace::snapshotMRT) {
assert(mrt == 0);
filename = os::String::format("%s%010u.png", snapshotPrefix, no);
} else if (mrt == -2) {
/* stencil */
filename = os::String::format("%s%010u-s.png", snapshotPrefix, no);
} else if (mrt == -1) {
/* depth */
filename = os::String::format("%s%010u-z.png", snapshotPrefix, no);
} else {
filename = os::String::format("%s%010u-mrt%u.png", snapshotPrefix, no, mrt);
}
// Here we release our ownership on the Image, it is now the
// responsibility of the snapshotter to delete it.
snapshotter->writePNG(filename, src.release());
}
}
return;
}
static void
takeSnapshot(unsigned call_no, bool backBuffer)
{
static signed long long last_call_no = -1;
if (call_no == last_call_no) {
return;
}
last_call_no = call_no;
static unsigned snapshot_no = 0;
int cnt = dumper->getSnapshotCount();
if (retrace::snapshotMRT) {
for (int mrt = -2; mrt < cnt; mrt++) {
takeSnapshot(call_no, mrt, snapshot_no, backBuffer);
}
} else {
takeSnapshot(call_no, 0, snapshot_no, backBuffer);
}
snapshot_no++;
}
/**
* Retrace one call.
*
* Take snapshots before/after retracing (as appropriate) and dispatch it to
* the respective handler.
*/
static void
retraceCall(trace::Call *call) {
callNo = call->no;
if (ignoreCalls && callsToIgnore.contains(callNo)) {
return;
}
retracer.retrace(*call);
if (snapshotFrequency.contains(*call)) {
takeSnapshot(call->no, snapshotForceBackbuffer);
if (call->no >= snapshotFrequency.getLast()) {
exit(0);
}
}
// dumpStateCallNo is 0 when fetching default state
if (call->no == dumpStateCallNo || dumpStateCallNo == 0) {
if (dumper->canDump()) {
StateWriter *writer = stateWriterFactory(std::cout);
dumper->dumpState(*writer);
delete writer;
exit(0);
} else if (dumpStateCallNo != 0) {
std::cerr << call->no << ": error: failed to dump state\n";
exit(1);
}
}
}
class RelayRunner;
/**
* Implement multi-threading by mimicking a relay race.
*/
class RelayRace
{
private:
/**
* Runners indexed by the leg they run (i.e, the thread_ids from the
* trace).
*/
std::vector<RelayRunner*> runners;
public:
RelayRace();
~RelayRace();
RelayRunner *
getRunner(unsigned leg);
inline RelayRunner *
getForeRunner() {
return getRunner(0);
}
void
run(void);
void
passBaton(trace::Call *call);
void
finishLine();
void
stopRunners();
};
/**
* Each runner is a thread.
*
* The fore runner doesn't have its own thread, but instead uses the thread
* where the race started.
*/
class RelayRunner
{
private:
friend class RelayRace;
RelayRace *race;
unsigned leg;
std::mutex mutex;
std::condition_variable wake_cond;
/**
* There are protected by the mutex.
*/
bool finished;
trace::Call *baton;
std::thread thread;
static void
runnerThread(RelayRunner *_this);
public:
RelayRunner(RelayRace *race, unsigned _leg) :
race(race),
leg(_leg),
finished(false),
baton(0)
{
/* The fore runner does not need a new thread */
if (leg) {
thread = std::thread(runnerThread, this);
}
}
~RelayRunner() {
if (thread.joinable()) {
thread.join();
}
}
/**
* Thread main loop.
*/
void
runRace(void) {
std::unique_lock<std::mutex> lock(mutex);
while (1) {
while (!finished && !baton) {
wake_cond.wait(lock);
}
if (finished) {
break;
}
assert(baton);
trace::Call *call = baton;
baton = 0;
runLeg(call);
}
if (0) std::cerr << "leg " << leg << " actually finishing\n";
if (leg == 0) {
race->stopRunners();
}
}
/**
* Interpret successive calls.
*/
void
runLeg(trace::Call *call) {
/* Consume successive calls for this thread. */
do {
assert(call);
assert(call->thread_id == leg);
retraceCall(call);
if (!call->reuse_call)
delete call;
call = parser->parse_call();
} while (call && call->thread_id == leg);
if (call) {
/* Pass the baton */
assert(call->thread_id != leg);
flushRendering();
race->passBaton(call);
} else {
/* Reached the finish line */
if (0) std::cerr << "finished on leg " << leg << "\n";
if (leg) {
/* Notify the fore runner */
race->finishLine();
} else {
/* We are the fore runner */
finished = true;
}
}
}
/**
* Called by other threads when relinquishing the baton.
*/
void
receiveBaton(trace::Call *call) {
assert (call->thread_id == leg);
mutex.lock();
baton = call;
mutex.unlock();
wake_cond.notify_one();
}
/**
* Called by the fore runner when the race is over.
*/
void
finishRace() {
if (0) std::cerr << "notify finish to leg " << leg << "\n";
mutex.lock();
finished = true;
mutex.unlock();
wake_cond.notify_one();
}
};
void
RelayRunner::runnerThread(RelayRunner *_this) {
_this->runRace();
}
RelayRace::RelayRace() {
runners.push_back(new RelayRunner(this, 0));
}
RelayRace::~RelayRace() {
assert(runners.size() >= 1);
std::vector<RelayRunner*>::const_iterator it;
for (it = runners.begin(); it != runners.end(); ++it) {
RelayRunner* runner = *it;
delete runner;
}
}
/**
* Get (or instantiate) a runner for the specified leg.
*/
RelayRunner *
RelayRace::getRunner(unsigned leg) {
RelayRunner *runner;
if (leg >= runners.size()) {
runners.resize(leg + 1);
runner = 0;
} else {
runner = runners[leg];
}
if (!runner) {
runner = new RelayRunner(this, leg);
runners[leg] = runner;
}
return runner;
}
/**
* Start the race.
*/
void
RelayRace::run(void) {
trace::Call *call;
call = parser->parse_call();
if (!call) {
/* Nothing to do */
return;
}
RelayRunner *foreRunner = getForeRunner();
if (call->thread_id == 0) {
/* We are the forerunner thread, so no need to pass baton */
foreRunner->baton = call;
} else {
passBaton(call);
}
/* Start the forerunner thread */
foreRunner->runRace();
}
/**
* Pass the baton (i.e., the call) to the appropriate thread.
*/
void
RelayRace::passBaton(trace::Call *call) {
if (0) std::cerr << "switching to thread " << call->thread_id << "\n";
RelayRunner *runner = getRunner(call->thread_id);
runner->receiveBaton(call);
}
/**
* Called when a runner other than the forerunner reaches the finish line.
*
* Only the fore runner can finish the race, so inform him that the race is
* finished.
*/
void
RelayRace::finishLine(void) {
RelayRunner *foreRunner = getForeRunner();
foreRunner->finishRace();
}
/**
* Called by the fore runner after finish line to stop all other runners.
*/
void
RelayRace::stopRunners(void) {
std::vector<RelayRunner*>::const_iterator it;
for (it = runners.begin() + 1; it != runners.end(); ++it) {
RelayRunner* runner = *it;
if (runner) {
runner->finishRace();
}
}
}
static void
mainLoop() {
addCallbacks(retracer);
long long startTime = 0;
frameNo = 0;
startTime = os::getTime();
if (singleThread) {
trace::Call *call;
while ((call = parser->parse_call())) {
retraceCall(call);
if (!call->reuse_call)
delete call;
}
} else {
RelayRace race;
race.run();
}
finishRendering();
long long endTime = os::getTime();
float timeInterval = (endTime - startTime) * (1.0 / os::timeFrequency);
if ((retrace::verbosity >= -1) || (retrace::profiling)) {
std::cout <<
"Rendered " << frameNo << " frames"
" in " << timeInterval << " secs,"
" average of " << (frameNo/timeInterval) << " fps\n";
}
if (waitOnFinish) {
waitForInput();
} else {
return;
}
}
} /* namespace retrace */
static void
usage(const char *argv0) {
std::cout <<
"Usage: " << argv0 << " [OPTION] TRACE [...]\n"
"Replay TRACE.\n"
"\n"
" -b, --benchmark benchmark mode (no error checking or warning messages)\n"
" -d, --debug increase debugging checks\n"
" --markers insert call no markers in the command stream\n"
" --pframe-times frame times profiling (cpu times per frame)\n"
" --pcpu cpu profiling (cpu times per call)\n"
" --pgpu gpu profiling (gpu times per draw call)\n"
" --ppd pixels drawn profiling (pixels drawn per draw call)\n"
" --pmem memory usage profiling (vsize rss per call)\n"
" --pcalls call profiling metrics selection\n"
" --pframes frame profiling metrics selection\n"
" --pdrawcalls draw call profiling metrics selection\n"
" --list-metrics list all available metrics for TRACE\n"
" --query-handling How query readbacks should be handled: ('skip', 'run', 'check'), default is 'skip'\n"
" --query-tolerance Set a tolerance when comparing recorded query results to evaluated ones, a value >0 enables query-handling 'check'\n"
" --gen-passes generate profiling passes and output passes number\n"
" --call-nos[=BOOL] use call numbers in snapshot filenames\n"
" --core use core profile\n"
" --db use a double buffer visual (default)\n"
" --samples=N use GL_ARB_multisample (default is 1)\n"
" --driver=DRIVER force driver type (`hw`, `dgpu`, `igpu`, `sw`, `ref`, `null`, or driver module name)\n"
" --fullscreen allow fullscreen\n"
" --headless don't show windows\n"
" --sb use a single buffer visual\n"
" -m, --mrt dump all MRTs and depth/stencil\n"
" --msaa-no-resolve dump raw sample images of multisampled texture instead of resolved texture\n"
" -s, --snapshot-prefix=PREFIX take snapshots; `-` for PNM stdout output\n"
" --snapshot-alpha Include alpha channel in snapshots.\n"
" --snapshot-format=FMT use (PNM, RGB, or MD5; default is PNM) when writing to stdout output\n"
" -S, --snapshot=CALLSET calls to snapshot (default is every frame)\n"
" --snapshot-interval=N specify a frame interval when generating snaphots (default is 0)\n"
" -t, --snapshot-threaded encode screenshots on multiple threads\n"
" --snapshot-force-backbuffer always read from the backbuffer when taking a snapshot (default read from the current draw buffer)\n"
" -v, --verbose increase output verbosity\n"
" -D, --dump-state=CALL dump state at specific call no\n"
" --dump-format=FORMAT dump state format (`json` or `ubjson`)\n"
" --min-frame-duration=MICROSECONDS specify minimum frame rendering duration\n"
" --per-frame-delay=MICROSECONDS add extra delay after each frame (in addition to min-frame-duration)\n"
" -w, --wait waitOnFinish on final frame\n"
" --loop[=N] loop N times (N<0 continuously) replaying final frame.\n"
" --singlethread use a single thread to replay command stream\n"
" --ignore-retvals ignore return values in wglMakeCurrent, etc\n"
" --no-context-check don't check that the actual GL context version matches the requested version\n"
" --min-cpu-time=NANOSECONDS ignore calls with less than this CPU time when profiling (default is 1000)\n"
" --ignore-calls=CALLSET ignore calls in CALLSET\n"
;
}
enum {
CALL_NOS_OPT = CHAR_MAX + 1,
CORE_OPT,
DB_OPT,
SAMPLES_OPT,
DRIVER_OPT,
FULLSCREEN_OPT,
HEADLESS_OPT,
PFRAMETIMES_OPT,
PCPU_OPT,
PGPU_OPT,
PPD_OPT,
PMEM_OPT,
PCALLS_OPT,
PFRAMES_OPT,
PDRAWCALLS_OPT,
PLMETRICS_OPT,
GENPASS_OPT,
MSAA_NO_RESOLVE_OPT,
SB_OPT,
MIN_FRAME_DURATION_OPT,
PER_FRAME_DELAY_OPT,
LOOP_OPT,
SINGLETHREAD_OPT,
IGNORE_RETVALS_OPT,
NO_CONTEXT_CHECK,
SNAPSHOT_ALPHA_OPT,
SNAPSHOT_FORMAT_OPT,
SNAPSHOT_INTERVAL_OPT,
SNAPSHOT_FORCE_BACKBUFFER_OPT,
DUMP_FORMAT_OPT,
MARKERS_OPT,
MIN_CPU_TIME_OPT,
QUERY_HANDLING_OPT,
QUERY_CHECK_TOLARANCE_OPT,
IGNORE_CALLS_OPT,
};
const static char *
shortOptions = "bdD:hms:S:vwt";
const static struct option
longOptions[] = {
{"benchmark", no_argument, 0, 'b'},
{"debug", no_argument, 0, 'd'},
{"markers", no_argument, 0, MARKERS_OPT},
{"call-nos", optional_argument, 0, CALL_NOS_OPT },
{"core", no_argument, 0, CORE_OPT},
{"db", no_argument, 0, DB_OPT},
{"samples", required_argument, 0, SAMPLES_OPT},
{"driver", required_argument, 0, DRIVER_OPT},
{"dump-state", required_argument, 0, 'D'},
{"dump-format", required_argument, 0, DUMP_FORMAT_OPT},
{"fullscreen", no_argument, 0, FULLSCREEN_OPT},
{"headless", no_argument, 0, HEADLESS_OPT},
{"help", no_argument, 0, 'h'},
{"mrt", no_argument, 0, 'm'},
{"msaa-no-resolve", no_argument, 0, MSAA_NO_RESOLVE_OPT},
{"pframe-times", no_argument, 0, PFRAMETIMES_OPT},
{"pcpu", no_argument, 0, PCPU_OPT},
{"pgpu", no_argument, 0, PGPU_OPT},
{"ppd", no_argument, 0, PPD_OPT},
{"pmem", no_argument, 0, PMEM_OPT},
{"pcalls", required_argument, 0, PCALLS_OPT},
{"pframes", required_argument, 0, PFRAMES_OPT},
{"pdrawcalls", required_argument, 0, PDRAWCALLS_OPT},
{"query-handling", required_argument, 0, QUERY_HANDLING_OPT},
{"query-tolerance", required_argument, 0, QUERY_CHECK_TOLARANCE_OPT},
{"list-metrics", no_argument, 0, PLMETRICS_OPT},
{"gen-passes", no_argument, 0, GENPASS_OPT},
{"sb", no_argument, 0, SB_OPT},
{"snapshot", required_argument, 0, 'S'},
{"snapshot-alpha", no_argument, 0, SNAPSHOT_ALPHA_OPT},
{"snapshot-format", required_argument, 0, SNAPSHOT_FORMAT_OPT},
{"snapshot-interval", required_argument, 0, SNAPSHOT_INTERVAL_OPT},
{"snapshot-force-backbuffer", no_argument, 0, SNAPSHOT_FORCE_BACKBUFFER_OPT},
{"snapshot-prefix", required_argument, 0, 's'},
{"snapshot-threaded", no_argument, 0, 't'},
{"verbose", no_argument, 0, 'v'},
{"wait", no_argument, 0, 'w'},
{"min-frame-duration", required_argument, 0, MIN_FRAME_DURATION_OPT},
{"per-frame-delay", required_argument, 0, PER_FRAME_DELAY_OPT},
{"loop", optional_argument, 0, LOOP_OPT},
{"singlethread", no_argument, 0, SINGLETHREAD_OPT},
{"ignore-retvals", no_argument, 0, IGNORE_RETVALS_OPT},
{"no-context-check", no_argument, 0, NO_CONTEXT_CHECK},
{"min-cpu-time", required_argument, 0, MIN_CPU_TIME_OPT},
{"ignore-calls", required_argument, 0, IGNORE_CALLS_OPT},
{0, 0, 0, 0}
};
static void exceptionCallback(void)
{
std::cerr << retrace::callNo << ": error: caught an unhandled exception\n";
}
static bool
endsWith(const std::string &s1, const char *s2)
{
size_t len = strlen(s2);
return s1.length() >= len &&
s1.compare(s1.length() - len, len, s2) == 0;
}
// Try to compensate for different OS
static void
adjustProcessName(const std::string &name)
{
std::string adjustedName(name);
if (adjustedName.length() > 2 && adjustedName[1] == ':') {
#ifndef _WIN32
adjustedName.erase(0, 2);
#endif
} else {
#ifdef _WIN32
adjustedName.insert(0, "C:");
#endif
}
for (char &c: adjustedName) {
#ifdef _WIN32
if (c == '/') c = '\\';
#else
if (c == '\\') c = '/';
#endif
}
#ifndef _WIN32
static const std::regex programFiles("/Program Files( \\(x86\\))?/", std::regex_constants::icase);
adjustedName = std::regex_replace(adjustedName, programFiles, "/opt/");
#endif
if (endsWith(adjustedName, ".exe")) {
#ifndef _WIN32
adjustedName.resize(adjustedName.length() - strlen(".exe"));
#endif
} else {
#ifdef _WIN32
adjustedName.append(".exe");
#endif
}
std::cerr << adjustedName << "\n";
setProcessName(adjustedName.c_str());
}
#ifdef _WIN32
// Diagnose OOM
static int
new_failure_handler(size_t size)
{
fprintf(stderr, "error: failed to allocate %zu bytes\n", size);
// Describe the heap features:
// 0 - default heap
// 2 - low fragmentation heap
// etc.
ULONG HeapCompatibility;
if (HeapQueryInformation(reinterpret_cast<HANDLE>(_get_heap_handle()),
HeapCompatibilityInformation,
&HeapCompatibility, sizeof HeapCompatibility, nullptr)) {
fprintf(stderr, "info: heap features %lu\n", HeapCompatibility);
}
#define MB (1024*1024)
MEMORYSTATUSEX statex;
statex.dwLength = sizeof statex;
if (GlobalMemoryStatusEx(&statex)) {
fprintf(stderr, "info: %lu%% memory in use\n", statex.dwMemoryLoad);
fprintf(stderr, "info: %llu total MB of physical memory\n", statex.ullTotalPhys/MB);
fprintf(stderr, "info: %llu free MB of physical memory\n", statex.ullAvailPhys/MB);
fprintf(stderr, "info: %llu total MB of paging file\n", statex.ullTotalPageFile/MB);
fprintf(stderr, "info: %llu free MB of paging file\n", statex.ullAvailPageFile/MB);
fprintf(stderr, "info: %llu total MB of virtual memory\n", statex.ullTotalVirtual/MB);
fprintf(stderr, "info: %llu free MB of virtual memory\n", statex.ullAvailVirtual/MB);
fprintf(stderr, "info: %llu free MB of extended memory\n", statex.ullAvailExtendedVirtual/MB);
}
PROCESS_MEMORY_COUNTERS pmc;
if (GetProcessMemoryInfo( GetCurrentProcess(), &pmc, sizeof pmc)) {
fprintf(stderr, "info: %lu page faults\n", pmc.PageFaultCount);
fprintf(stderr, "info: %zu MB peak working set\n", size_t(pmc.PeakWorkingSetSize/MB));
fprintf(stderr, "info: %zu MB working set\n", size_t(pmc.WorkingSetSize/MB));
fprintf(stderr, "info: %zu MB quota peak paged pool usage\n", size_t(pmc.QuotaPeakPagedPoolUsage/MB));
fprintf(stderr, "info: %zu MB quota paged pool usage\n", size_t(pmc.QuotaPagedPoolUsage/MB));
fprintf(stderr, "info: %zu MB quota peak non-paged pool usage\n", size_t(pmc.QuotaPeakNonPagedPoolUsage/MB));
fprintf(stderr, "info: %zu MB quota non-paged pool usage\n", size_t(pmc.QuotaNonPagedPoolUsage/MB));
fprintf(stderr, "info: %zu MB page file used\n", size_t(pmc.PagefileUsage/MB));
fprintf(stderr, "info: %zu MB peak page file used\n", size_t(pmc.PeakPagefileUsage/MB));
}
// Describe free virtual memory
LPCVOID lpAddress = nullptr;
MEMORY_BASIC_INFORMATION MBI;
size_t NumFree = 0;
size_t TotalFree = 0;
size_t LargestFree = 0;
while (VirtualQuery(lpAddress, &MBI, sizeof MBI) == sizeof MBI) {
assert(MBI.RegionSize > 0);
if (MBI.State == MEM_FREE) {
++NumFree;
TotalFree += MBI.RegionSize;
LargestFree = std::max(LargestFree, size_t(MBI.RegionSize));
}
if (LPCBYTE(lpAddress) >= (LPCBYTE)MBI.BaseAddress + MBI.RegionSize) {
break;
}
lpAddress = (LPCBYTE)MBI.BaseAddress + MBI.RegionSize;
}
fprintf(stderr, "info: %zu MB virtual address free\n", TotalFree/MB);
fprintf(stderr, "info: %zu free virtual address regions\n", NumFree);
fprintf(stderr, "info: %zu MB largest free virtual address region\n", LargestFree/MB);
return 0;
}
#ifndef DBG_PRINTEXCEPTION_WIDE_C
#define DBG_PRINTEXCEPTION_WIDE_C 0x4001000A
#endif
// Intercept OutputDebugString and write the message to stderr.
static LONG CALLBACK
VectoredHandler(PEXCEPTION_POINTERS pExceptionInfo)
{
PEXCEPTION_RECORD pExceptionRecord = pExceptionInfo->ExceptionRecord;
DWORD ExceptionCode = pExceptionRecord->ExceptionCode;
if (ExceptionCode == DBG_PRINTEXCEPTION_C) {
ULONG_PTR nLength = pExceptionRecord->ExceptionInformation[0];
PCSTR pString = reinterpret_cast<PCSTR>(pExceptionRecord->ExceptionInformation[1]);
if (nLength > 1 && pString) {
// nLength includes trailing null character
--nLength;
fprintf(stderr, "%u: debug: %s",
retrace::callNo,
pString);
char last = pString[nLength - 1];
if (last != '\r' && last != '\n') {
fputc('\n', stderr);
}
}
return EXCEPTION_CONTINUE_EXECUTION;
}
if (ExceptionCode == DBG_PRINTEXCEPTION_WIDE_C) {
// Do nothing, as this exception will be rethrown as a
// DBG_PRINTEXCEPTION_C.
return EXCEPTION_CONTINUE_SEARCH;
}
return EXCEPTION_CONTINUE_SEARCH;
}
/*
* Show the current call number on the first Ctrl-C/Break event.