blob: 30ceb88acbb4bcaeb60fa945bc50c426a929a64c [file] [log] [blame]
epoger@google.comec3ed6a2011-07-28 14:26:00 +00001/*
2 * Copyright 2011 Google Inc.
3 *
4 * Use of this source code is governed by a BSD-style license that can be
5 * found in the LICENSE file.
6 */
reed@android.combd700c32009-01-05 03:34:50 +00007
tfarinaf168b862014-06-19 12:32:29 -07008#ifndef Benchmark_DEFINED
9#define Benchmark_DEFINED
10
reed@android.combd700c32009-01-05 03:34:50 +000011#include "SkPoint.h"
tfarinaf168b862014-06-19 12:32:29 -070012#include "SkRefCnt.h"
scroggo@google.com111fd112013-09-25 21:42:12 +000013#include "SkString.h"
reed@android.comf523e252009-01-26 23:15:37 +000014#include "SkTRegistry.h"
reed@android.combd700c32009-01-05 03:34:50 +000015
mtkleind0a10882015-05-13 11:54:00 -070016#define DEF_BENCH3(code, N) \
17 static BenchRegistry gBench##N([](void*) -> Benchmark* { code; });
18#define DEF_BENCH2(code, N) DEF_BENCH3(code, N)
19#define DEF_BENCH(code) DEF_BENCH2(code, __COUNTER__)
reed@google.comb8b92ea2012-10-16 15:57:13 +000020
21/*
22 * With the above macros, you can register benches as follows (at the bottom
23 * of your .cpp)
24 *
mtklein@google.com410e6e82013-09-13 19:52:27 +000025 * DEF_BENCH(return new MyBenchmark(...))
26 * DEF_BENCH(return new MyBenchmark(...))
27 * DEF_BENCH(return new MyBenchmark(...))
reed@google.comb8b92ea2012-10-16 15:57:13 +000028 */
29
30
reed@android.combd700c32009-01-05 03:34:50 +000031class SkCanvas;
reed@android.com4bc19832009-01-19 20:08:35 +000032class SkPaint;
reed@android.combd700c32009-01-05 03:34:50 +000033
reed@android.com4e635f92009-10-19 17:39:46 +000034class SkTriState {
35public:
36 enum State {
37 kDefault,
38 kTrue,
39 kFalse
40 };
mtklein@google.comc2897432013-09-10 19:23:38 +000041 static const char* Name[];
reed@android.com4e635f92009-10-19 17:39:46 +000042};
43
tfarinaf168b862014-06-19 12:32:29 -070044class Benchmark : public SkRefCnt {
reed@android.combd700c32009-01-05 03:34:50 +000045public:
tfarinaf168b862014-06-19 12:32:29 -070046 SK_DECLARE_INST_COUNT(Benchmark)
robertphillips@google.com15e9d3e2012-06-21 20:25:03 +000047
tfarinaf168b862014-06-19 12:32:29 -070048 Benchmark();
reed@android.com4bc19832009-01-19 20:08:35 +000049
reed@android.combd700c32009-01-05 03:34:50 +000050 const char* getName();
mtklein96289052014-09-10 12:05:59 -070051 const char* getUniqueName();
reed@android.combd700c32009-01-05 03:34:50 +000052 SkIPoint getSize();
bsalomon@google.com30e6d2c2012-08-13 14:03:31 +000053
commit-bot@chromium.org644629c2013-11-21 06:21:58 +000054 enum Backend {
55 kNonRendering_Backend,
56 kRaster_Backend,
57 kGPU_Backend,
58 kPDF_Backend,
tomhudsond968a6f2015-03-26 11:28:06 -070059 kHWUI_Backend,
commit-bot@chromium.org644629c2013-11-21 06:21:58 +000060 };
61
62 // Call to determine whether the benchmark is intended for
63 // the rendering mode.
64 virtual bool isSuitableFor(Backend backend) {
65 return backend != kNonRendering_Backend;
66 }
67
cdaltonb4022962015-06-25 10:51:56 -070068 virtual int calculateLoops(int defaultLoops) const {
69 return defaultLoops;
70 }
71
bsalomon@google.com30e6d2c2012-08-13 14:03:31 +000072 // Call before draw, allows the benchmark to do setup work outside of the
73 // timer. When a benchmark is repeatedly drawn, this should be called once
74 // before the initial draw.
75 void preDraw();
76
robertphillips5b693772014-11-21 06:19:36 -080077 // Called once before and after a series of draw calls to a single canvas.
78 // The setup/break down in these calls is not timed.
79 void perCanvasPreDraw(SkCanvas*);
80 void perCanvasPostDraw(SkCanvas*);
81
commit-bot@chromium.org33614712013-12-03 18:17:16 +000082 // Bench framework can tune loops to be large enough for stable timing.
83 void draw(const int loops, SkCanvas*);
bsalomon@google.com30e6d2c2012-08-13 14:03:31 +000084
reed@android.com4bc19832009-01-19 20:08:35 +000085 void setForceAlpha(int alpha) {
86 fForceAlpha = alpha;
87 }
rmistry@google.comfbfcd562012-08-23 18:09:54 +000088
reed@android.com4e635f92009-10-19 17:39:46 +000089 void setDither(SkTriState::State state) {
90 fDither = state;
91 }
reed@android.come9d00602009-09-02 21:12:42 +000092
reed@google.comef77ec22013-05-29 15:39:54 +000093 /** Assign masks for paint-flags. These will be applied when setupPaint()
94 * is called.
95 *
96 * Performs the following on the paint:
97 * uint32_t flags = paint.getFlags();
98 * flags &= ~clearMask;
99 * flags |= orMask;
100 * paint.setFlags(flags);
101 */
102 void setPaintMasks(uint32_t orMask, uint32_t clearMask) {
103 fOrMask = orMask;
104 fClearMask = clearMask;
105 }
106
reed@android.combd700c32009-01-05 03:34:50 +0000107protected:
reed@google.com0561a3c2012-11-15 19:52:20 +0000108 virtual void setupPaint(SkPaint* paint);
reed@android.com4bc19832009-01-19 20:08:35 +0000109
reed@android.combd700c32009-01-05 03:34:50 +0000110 virtual const char* onGetName() = 0;
mtklein96289052014-09-10 12:05:59 -0700111 virtual const char* onGetUniqueName() { return this->onGetName(); }
bsalomon@google.com30e6d2c2012-08-13 14:03:31 +0000112 virtual void onPreDraw() {}
robertphillips5b693772014-11-21 06:19:36 -0800113 virtual void onPerCanvasPreDraw(SkCanvas*) {}
114 virtual void onPerCanvasPostDraw(SkCanvas*) {}
commit-bot@chromium.org33614712013-12-03 18:17:16 +0000115 // Each bench should do its main work in a loop like this:
116 // for (int i = 0; i < loops; i++) { <work here> }
117 virtual void onDraw(const int loops, SkCanvas*) = 0;
reed@android.comf523e252009-01-26 23:15:37 +0000118
119 virtual SkIPoint onGetSize();
120
reed@android.com4bc19832009-01-19 20:08:35 +0000121private:
122 int fForceAlpha;
reed@android.com4e635f92009-10-19 17:39:46 +0000123 SkTriState::State fDither;
reed@google.comef77ec22013-05-29 15:39:54 +0000124 uint32_t fOrMask, fClearMask;
robertphillips@google.com15e9d3e2012-06-21 20:25:03 +0000125
126 typedef SkRefCnt INHERITED;
reed@android.combd700c32009-01-05 03:34:50 +0000127};
128
tfarinaf168b862014-06-19 12:32:29 -0700129typedef SkTRegistry<Benchmark*(*)(void*)> BenchRegistry;
reed@android.comf523e252009-01-26 23:15:37 +0000130
reed@android.combd700c32009-01-05 03:34:50 +0000131#endif