Templatize CodePtr/Refs/FunctionPtrs with PtrTags.
[WebKit-https.git] / Source / JavaScriptCore / profiler / ProfilerCompilation.h
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 #pragma once
27
28 #include "ExitKind.h"
29 #include "JSCJSValue.h"
30 #include "ProfilerCompilationKind.h"
31 #include "ProfilerCompiledBytecode.h"
32 #include "ProfilerExecutionCounter.h"
33 #include "ProfilerJettisonReason.h"
34 #include "ProfilerOSRExit.h"
35 #include "ProfilerOSRExitSite.h"
36 #include "ProfilerOriginStack.h"
37 #include "ProfilerProfiledBytecodes.h"
38 #include "ProfilerUID.h"
39 #include <wtf/RefCounted.h>
40 #include <wtf/SegmentedVector.h>
41
42 namespace JSC {
43
44 class FireDetail;
45
46 namespace Profiler {
47
48 class Bytecodes;
49 class Database;
50
51 // Represents the act of executing some bytecodes in some engine, and does
52 // all of the counting for those executions.
53
54 class Compilation : public RefCounted<Compilation> {
55 public:
56     Compilation(Bytecodes*, CompilationKind);
57     ~Compilation();
58     
59     void addProfiledBytecodes(Database&, CodeBlock*);
60     unsigned profiledBytecodesSize() const { return m_profiledBytecodes.size(); }
61     const ProfiledBytecodes& profiledBytecodesAt(unsigned i) const { return m_profiledBytecodes[i]; }
62     
63     void noticeInlinedGetById() { m_numInlinedGetByIds++; }
64     void noticeInlinedPutById() { m_numInlinedPutByIds++; }
65     void noticeInlinedCall() { m_numInlinedCalls++; }
66     
67     Bytecodes* bytecodes() const { return m_bytecodes; }
68     CompilationKind kind() const { return m_kind; }
69     
70     void addDescription(const CompiledBytecode&);
71     void addDescription(const OriginStack&, const CString& description);
72     ExecutionCounter* executionCounterFor(const OriginStack&);
73     void addOSRExitSite(const Vector<MacroAssemblerCodePtr<JSInternalPtrTag>>& codeAddresses);
74     OSRExit* addOSRExit(unsigned id, const OriginStack&, ExitKind, bool isWatchpoint);
75     
76     void setJettisonReason(JettisonReason, const FireDetail*);
77     
78     UID uid() const { return m_uid; }
79     
80     void dump(PrintStream&) const;
81     JSValue toJS(ExecState*) const;
82     
83 private:
84     Bytecodes* m_bytecodes;
85     CompilationKind m_kind;
86     JettisonReason m_jettisonReason;
87     CString m_additionalJettisonReason;
88     Vector<ProfiledBytecodes> m_profiledBytecodes;
89     Vector<CompiledBytecode> m_descriptions;
90     HashMap<OriginStack, std::unique_ptr<ExecutionCounter>> m_counters;
91     Vector<OSRExitSite> m_osrExitSites;
92     SegmentedVector<OSRExit> m_osrExits;
93     unsigned m_numInlinedGetByIds;
94     unsigned m_numInlinedPutByIds;
95     unsigned m_numInlinedCalls;
96     UID m_uid;
97 };
98
99 } } // namespace JSC::Profiler