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