OSR entry: delay outer-loop compilation when at inner-loop
[WebKit-https.git] / Source / JavaScriptCore / dfg / DFGOSREntry.h
1 /*
2  * Copyright (C) 2011, 2013, 2015 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 "DFGAbstractValue.h"
29 #include "Operands.h"
30 #include <wtf/BitVector.h>
31 #include <wtf/Expected.h>
32
33 namespace JSC {
34
35 class ExecState;
36 class CodeBlock;
37
38 namespace DFG {
39
40 enum class OSREntryFail {
41     Disabled,
42     TargetNotDFG,
43     TargetOptimizedOut,
44     BadPrediction,
45     StackGrowthFailed,
46 };
47
48 #if ENABLE(DFG_JIT)
49 struct OSREntryReshuffling {
50     OSREntryReshuffling() { }
51     
52     OSREntryReshuffling(int fromOffset, int toOffset)
53         : fromOffset(fromOffset)
54         , toOffset(toOffset)
55     {
56     }
57     
58     int fromOffset;
59     int toOffset;
60 };
61
62 struct OSREntryData {
63     unsigned m_bytecodeIndex;
64     unsigned m_machineCodeOffset;
65     Operands<AbstractValue> m_expectedValues;
66     // Use bitvectors here because they tend to only require one word.
67     BitVector m_localsForcedDouble;
68     BitVector m_localsForcedAnyInt;
69     Vector<OSREntryReshuffling> m_reshufflings;
70     BitVector m_machineStackUsed;
71     
72     void dumpInContext(PrintStream&, DumpContext*) const;
73     void dump(PrintStream&) const;
74 };
75
76 inline unsigned getOSREntryDataBytecodeIndex(OSREntryData* osrEntryData)
77 {
78     return osrEntryData->m_bytecodeIndex;
79 }
80
81 // Returns a pointer to a data buffer that the OSR entry thunk will recognize and parse.
82 Expected<void*, OSREntryFail> prepareOSREntry(ExecState*, CodeBlock*, unsigned bytecodeIndex);
83 #else
84 inline Expected<void*, OSREntryFail> prepareOSREntry(ExecState*, CodeBlock*, unsigned) { return makeUnexpected(OSREntryFail::Disabled); }
85 #endif
86
87 } } // namespace JSC::DFG