6baad9a64639791aa3200d832721701f212047a3
[WebKit-https.git] / Source / WebCore / platform / PlatformInstrumentation.h
1 /*
2  * Copyright (C) 2012 Google 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 are
6  * met:
7  *
8  *     * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *     * Redistributions in binary form must reproduce the above
11  * copyright notice, this list of conditions and the following disclaimer
12  * in the documentation and/or other materials provided with the
13  * distribution.
14  *     * Neither the name of Google Inc. nor the names of its
15  * contributors may be used to endorse or promote products derived from
16  * this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30
31 #ifndef PlatformInstrumentation_h
32 #define PlatformInstrumentation_h
33
34 #include <wtf/MainThread.h>
35 #include <wtf/text/WTFString.h>
36
37 #if PLATFORM(CHROMIUM)
38 #include "TraceEvent.h"
39 #endif
40
41 namespace WebCore {
42
43 class PlatformInstrumentationClient {
44 public:
45     virtual ~PlatformInstrumentationClient();
46
47     virtual void willDecodeImage(const String& imageType) = 0;
48     virtual void didDecodeImage() = 0;
49     virtual void willResizeImage(bool shouldCache) = 0;
50     virtual void didResizeImage() = 0;
51 };
52
53 class PlatformInstrumentation {
54 public:
55     static const char ImageDecodeEvent[];
56     static const char ImageResizeEvent[];
57
58     static const char ImageTypeArgument[];
59     static const char CachedArgument[];
60
61     static void setClient(PlatformInstrumentationClient*);
62     static bool hasClient() { return m_client; }
63
64     static void willDecodeImage(const String& imageType);
65     static void didDecodeImage();
66     static void willResizeImage(bool shouldCache);
67     static void didResizeImage();
68
69 private:
70     static const char CategoryName[];
71
72     static PlatformInstrumentationClient* m_client;
73 };
74
75 #define FAST_RETURN_IF_NO_CLIENT_OR_NOT_MAIN_THREAD() if (!m_client || !isMainThread()) return;
76
77 inline void PlatformInstrumentation::willDecodeImage(const String& imageType)
78 {
79 #if PLATFORM(CHROMIUM)
80     TRACE_EVENT_BEGIN1(CategoryName, ImageDecodeEvent, ImageTypeArgument, TRACE_STR_COPY(imageType.ascii().data()));
81 #endif
82     FAST_RETURN_IF_NO_CLIENT_OR_NOT_MAIN_THREAD();
83     m_client->willDecodeImage(imageType);
84 }
85
86 inline void PlatformInstrumentation::didDecodeImage()
87 {
88 #if PLATFORM(CHROMIUM)
89     TRACE_EVENT_END0(CategoryName, ImageDecodeEvent);
90 #endif
91     FAST_RETURN_IF_NO_CLIENT_OR_NOT_MAIN_THREAD();
92     m_client->didDecodeImage();
93 }
94
95 inline void PlatformInstrumentation::willResizeImage(bool shouldCache)
96 {
97 #if PLATFORM(CHROMIUM)
98     TRACE_EVENT_BEGIN1(CategoryName, ImageResizeEvent, CachedArgument, shouldCache);
99 #endif
100     FAST_RETURN_IF_NO_CLIENT_OR_NOT_MAIN_THREAD();
101     m_client->willResizeImage(shouldCache);
102 }
103
104 inline void PlatformInstrumentation::didResizeImage()
105 {
106 #if PLATFORM(CHROMIUM)
107     TRACE_EVENT_END0(CategoryName, ImageResizeEvent);
108 #endif
109     FAST_RETURN_IF_NO_CLIENT_OR_NOT_MAIN_THREAD();
110     m_client->didResizeImage();
111 }
112
113 } // namespace WebCore
114
115 #endif // PlatformInstrumentation_h