1/*
2 * Copyright (C) 2011-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#if ENABLE(DFG_JIT)
29
30#include "CompilerTimingScope.h"
31#include "DFGCommon.h"
32#include "DFGGraph.h"
33
34namespace JSC { namespace DFG {
35
36class Phase {
37public:
38 Phase(Graph& graph, const char* name)
39 : m_graph(graph)
40 , m_name(name)
41 {
42 beginPhase();
43 }
44
45 ~Phase()
46 {
47 endPhase();
48 }
49
50 const char* name() const { return m_name; }
51
52 Graph& graph() { return m_graph; }
53
54 // Each phase must have a run() method.
55
56 Prefix prefix;
57
58protected:
59 // Things you need to have a DFG compiler phase.
60 Graph& m_graph;
61
62 VM& vm() { return m_graph.m_vm; }
63 CodeBlock* codeBlock() { return m_graph.m_codeBlock; }
64 CodeBlock* profiledBlock() { return m_graph.m_profiledBlock; }
65
66 // This runs validation, and uses the graph dump before the phase if possible.
67 void validate();
68
69 const char* m_name;
70
71private:
72 // Call these hooks when starting and finishing.
73 void beginPhase();
74 void endPhase();
75
76 CString m_graphDumpBeforePhase;
77};
78
79template<typename PhaseType>
80bool runAndLog(PhaseType& phase)
81{
82 CompilerTimingScope timingScope("DFG", phase.name());
83
84 bool result = phase.run();
85
86 if (result && logCompilationChanges(phase.graph().m_plan.mode()))
87 dataLogLn(phase.graph().prefix(), "Phase ", phase.name(), " changed the IR.\n");
88 return result;
89}
90
91template<typename PhaseType>
92bool runPhase(Graph& graph)
93{
94 PhaseType phase(graph);
95 return runAndLog(phase);
96}
97
98} } // namespace JSC::DFG
99
100#endif // ENABLE(DFG_JIT)
101