1/*
2 * Copyright (C) 2017 Apple Inc. All rights reserved.
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
6 * are met:
7 * 1. Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * 2. Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
12 *
13 * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR
17 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24 */
25
26#pragma once
27
28#include <wtf/MonotonicTime.h>
29#include <wtf/Noncopyable.h>
30
31namespace WTF {
32
33// TimingScope is intended for microbenchmarking sections of code.
34//
35// Do not leave in shipping code.
36//
37// Mean scope durations are printed using WTFLogAlways every Nth call, where N is specified by logIterationInterval.
38
39class TimingScope {
40 WTF_MAKE_FAST_ALLOCATED;
41 WTF_MAKE_NONCOPYABLE(TimingScope);
42public:
43 TimingScope(const char* name, unsigned logIterationInterval = 1)
44 : m_startTime(MonotonicTime::now())
45 , m_name(name)
46 , m_logIterationInterval(logIterationInterval)
47 {
48 }
49
50 ~TimingScope()
51 {
52 scopeDidEnd();
53 }
54
55private:
56 WTF_EXPORT_PRIVATE void scopeDidEnd();
57
58 MonotonicTime m_startTime;
59 const char* m_name;
60 unsigned m_logIterationInterval;
61};
62
63} // namespace WTF
64
65using WTF::TimingScope;
66
67