f8ea799ca6833b5cc1d7ec885cc2f8158a4f2c73
[WebKit-https.git] / Source / JavaScriptCore / tools / CodeProfiling.cpp
1 /*
2  * Copyright (C) 2012-2018 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 #include "config.h"
27 #include "CodeProfiling.h"
28
29 #include "CodeProfile.h"
30 #include "MachineContext.h"
31 #include <wtf/Environment.h>
32 #include <wtf/MetaAllocator.h>
33
34 #if HAVE(SIGNAL_H)
35 #include <signal.h>
36 #endif
37
38 #if HAVE(MACHINE_CONTEXT)
39 #include <sys/time.h>
40 #endif
41
42 namespace JSC {
43
44 volatile CodeProfile* CodeProfiling::s_profileStack = 0;
45 CodeProfiling::Mode CodeProfiling::s_mode = CodeProfiling::Disabled;
46 WTF::MetaAllocatorTracker* CodeProfiling::s_tracker = 0;
47
48 IGNORE_WARNINGS_BEGIN("missing-noreturn")
49
50 #if HAVE(MACHINE_CONTEXT)
51 // Helper function to start & stop the timer.
52 // Presently we're using the wall-clock timer, since this seems to give the best results.
53 static void setProfileTimer(unsigned usec)
54 {
55     itimerval timer;
56     timer.it_value.tv_sec = 0;
57     timer.it_value.tv_usec = usec;
58     timer.it_interval.tv_sec = 0;
59     timer.it_interval.tv_usec = usec;
60     setitimer(ITIMER_REAL, &timer, 0);
61 }
62 #endif
63
64 IGNORE_WARNINGS_END
65
66 #if HAVE(MACHINE_CONTEXT)
67 static void profilingTimer(int, siginfo_t*, void* uap)
68 {
69     PlatformRegisters& platformRegisters = WTF::registersFromUContext(static_cast<ucontext_t*>(uap));
70     if (auto instructionPointer = MachineContext::instructionPointer(platformRegisters)) {
71         CodeProfiling::sample(
72             instructionPointer->untaggedExecutableAddress(),
73             reinterpret_cast<void**>(MachineContext::framePointer(platformRegisters)));
74     }
75 }
76 #endif
77
78 // Callback triggered when the timer is fired.
79 void CodeProfiling::sample(void* pc, void** framePointer)
80 {
81     CodeProfile* profileStack = const_cast<CodeProfile*>(s_profileStack);
82     if (profileStack)
83         profileStack->sample(pc, framePointer);
84 }
85
86 void CodeProfiling::notifyAllocator(WTF::MetaAllocator* allocator)
87 {
88     // Check for JSC_CODE_PROFILING.
89     auto codeProfilingMode = Environment::getUInt("JSC_CODE_PROFILING");
90     if (!codeProfilingMode)
91         return;
92
93     // Check for a valid mode, currently 1, 2, or 3.
94     switch (*codeProfilingMode) {
95     case 1:
96         s_mode = Enabled;
97         break;
98     case 2:
99         s_mode = Verbose;
100         break;
101     case 3:
102         s_mode = VeryVerbose;
103         break;
104     default:
105         return;
106     }
107
108     ASSERT(enabled());
109     ASSERT(!s_tracker);
110     s_tracker = new WTF::MetaAllocatorTracker();
111     allocator->trackAllocations(s_tracker);
112 }
113
114 void* CodeProfiling::getOwnerUIDForPC(void* address)
115 {
116     if (!s_tracker)
117         return 0;
118     WTF::MetaAllocatorHandle* handle = s_tracker->find(address);
119     if (!handle)
120         return 0;
121     return handle->ownerUID();
122 }
123
124 void CodeProfiling::begin(const SourceCode& source)
125 {
126     // Push a new CodeProfile onto the stack for each script encountered.
127     CodeProfile* profileStack = const_cast<CodeProfile*>(s_profileStack);
128     bool alreadyProfiling = profileStack;
129     s_profileStack = profileStack = new CodeProfile(source, profileStack);
130
131     // Is the profiler already running - if so, the timer will already be set up.
132     if (alreadyProfiling)
133         return;
134
135 #if HAVE(MACHINE_CONTEXT)
136     // Regsiter a signal handler & itimer.
137     struct sigaction action;
138     action.sa_sigaction = reinterpret_cast<void (*)(int, siginfo_t *, void *)>(profilingTimer);
139     sigfillset(&action.sa_mask);
140     action.sa_flags = SA_SIGINFO;
141     sigaction(SIGALRM, &action, 0);
142     setProfileTimer(100);
143 #endif
144 }
145
146 void CodeProfiling::end()
147 {
148     // Pop the current profiler off the stack.
149     CodeProfile* current = const_cast<CodeProfile*>(s_profileStack);
150     ASSERT(current);
151     s_profileStack = current->parent();
152
153     // Is this the outermost script being profiled? - if not, just return.
154     // We perform all output of profiles recursively from the outermost script,
155     // to minimize profiling overhead from skewing results.
156     if (s_profileStack)
157         return;
158
159 #if HAVE(MACHINE_CONTEXT)
160     // Stop profiling
161     setProfileTimer(0);
162 #endif
163
164     current->report();
165     delete current;
166 }
167
168 }