Remove excessive headers from JavaScriptCore
[WebKit-https.git] / Source / JavaScriptCore / dfg / DFGOSRAvailabilityAnalysisPhase.h
1 /*
2  * Copyright (C) 2013, 2014 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 "DFGBasicBlock.h"
31
32 namespace JSC { namespace DFG {
33
34 class Graph;
35
36 // Computes BasicBlock::ssa->availabiltiyAtHead/Tail. This is a forward flow type inference
37 // over MovHints and SetLocals. This analysis is run directly by the Plan for preparing for
38 // lowering to B3 IR, but it can also be used as a utility. Note that if you run it before
39 // stack layout, all of the flush availability will omit the virtual register - but it will
40 // tell you the format.
41
42 bool performOSRAvailabilityAnalysis(Graph&);
43
44 // Local calculator for figuring out the availability at any node in a basic block. Requires
45 // having run the availability analysis.
46 class LocalOSRAvailabilityCalculator {
47 public:
48     LocalOSRAvailabilityCalculator(Graph&);
49     ~LocalOSRAvailabilityCalculator();
50     
51     void beginBlock(BasicBlock*);
52     void endBlock(BasicBlock*); // Useful if you want to get data for the end of the block. You don't need to call this if you did beginBlock() and then executeNode() for every node.
53     void executeNode(Node*);
54     
55     AvailabilityMap m_availability;
56     Graph& m_graph;
57 };
58
59 } } // namespace JSC::DFG
60
61 #endif // ENABLE(DFG_JIT)