CodeOrigin.h 6.97 KB
Newer Older
1
/*
2
 * Copyright (C) 2011, 2012, 2013 Apple Inc. All rights reserved.
3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
 */

#ifndef CodeOrigin_h
#define CodeOrigin_h

29 30
#include "CodeBlockHash.h"
#include "CodeSpecializationKind.h"
fpizlo@apple.com's avatar
fpizlo@apple.com committed
31
#include "JSFunction.h"
32
#include "ValueRecovery.h"
fpizlo@apple.com's avatar
fpizlo@apple.com committed
33
#include "WriteBarrier.h"
34
#include <wtf/BitVector.h>
35
#include <wtf/HashMap.h>
36
#include <wtf/PrintStream.h>
37
#include <wtf/StdLibExtras.h>
fpizlo@apple.com's avatar
fpizlo@apple.com committed
38
#include <wtf/Vector.h>
39 40 41 42

namespace JSC {

struct InlineCallFrame;
43
class ExecState;
44
class ScriptExecutable;
45
class JSFunction;
46 47

struct CodeOrigin {
48
    static const unsigned invalidBytecodeIndex = UINT_MAX;
49
    
50 51 52 53 54
    // Bytecode offset that you'd use to re-execute this instruction, and the
    // bytecode index of the bytecode instruction that produces some result that
    // you're interested in (used for mapping Nodes whose values you're using
    // to bytecode instructions that have the appropriate value profile).
    unsigned bytecodeIndex;
55
    
56 57 58
    InlineCallFrame* inlineCallFrame;
    
    CodeOrigin()
59
        : bytecodeIndex(invalidBytecodeIndex)
60 61 62 63
        , inlineCallFrame(0)
    {
    }
    
64 65 66 67 68 69
    CodeOrigin(WTF::HashTableDeletedValueType)
        : bytecodeIndex(invalidBytecodeIndex)
        , inlineCallFrame(bitwise_cast<InlineCallFrame*>(static_cast<uintptr_t>(1)))
    {
    }
    
70
    explicit CodeOrigin(unsigned bytecodeIndex, InlineCallFrame* inlineCallFrame = 0)
71 72 73
        : bytecodeIndex(bytecodeIndex)
        , inlineCallFrame(inlineCallFrame)
    {
74
        ASSERT(bytecodeIndex < invalidBytecodeIndex);
75 76
    }
    
77
    bool isSet() const { return bytecodeIndex != invalidBytecodeIndex; }
78
    
79 80 81 82 83
    bool isHashTableDeletedValue() const
    {
        return bytecodeIndex == invalidBytecodeIndex && !!inlineCallFrame;
    }
    
fpizlo@apple.com's avatar
fpizlo@apple.com committed
84 85 86 87
    // The inline depth is the depth of the inline stack, so 1 = not inlined,
    // 2 = inlined one deep, etc.
    unsigned inlineDepth() const;
    
88 89
    // If the code origin corresponds to inlined code, gives you the heap object that
    // would have owned the code if it had not been inlined. Otherwise returns 0.
90
    ScriptExecutable* codeOriginOwner() const;
91
    
92
    int stackOffset() const;
93
    
fpizlo@apple.com's avatar
fpizlo@apple.com committed
94 95
    static unsigned inlineDepthForCallFrame(InlineCallFrame*);
    
96
    unsigned hash() const;
fpizlo@apple.com's avatar
fpizlo@apple.com committed
97
    bool operator==(const CodeOrigin& other) const;
98 99
    bool operator!=(const CodeOrigin& other) const { return !(*this == other); }
    
fpizlo@apple.com's avatar
fpizlo@apple.com committed
100 101
    // Get the inline stack. This is slow, and is intended for debugging only.
    Vector<CodeOrigin> inlineStack() const;
102 103
    
    void dump(PrintStream&) const;
104
    void dumpInContext(PrintStream&, DumpContext*) const;
105 106 107
};

struct InlineCallFrame {
108
    Vector<ValueRecovery> arguments;
109
    WriteBarrier<ScriptExecutable> executable;
fpizlo@apple.com's avatar
fpizlo@apple.com committed
110
    ValueRecovery calleeRecovery;
111
    CodeOrigin caller;
112
    BitVector capturedVars; // Indexed by the machine call frame's variable numbering.
fpizlo@apple.com's avatar
fpizlo@apple.com committed
113
    signed stackOffset : 30;
fpizlo@apple.com's avatar
fpizlo@apple.com committed
114
    bool isCall : 1;
fpizlo@apple.com's avatar
fpizlo@apple.com committed
115 116
    bool isClosureCall : 1; // If false then we know that callee/scope are constants and the DFG won't treat them as variables, i.e. they have to be recovered manually.
    VirtualRegister argumentsRegister; // This is only set if the code uses arguments. The unmodified arguments register follows the unmodifiedArgumentsRegister() convention (see CodeBlock.h).
117
    
118 119 120 121 122 123
    // There is really no good notion of a "default" set of values for
    // InlineCallFrame's fields. This constructor is here just to reduce confusion if
    // we forgot to initialize explicitly.
    InlineCallFrame()
        : stackOffset(0)
        , isCall(false)
fpizlo@apple.com's avatar
fpizlo@apple.com committed
124
        , isClosureCall(false)
125 126 127
    {
    }
    
128
    CodeSpecializationKind specializationKind() const { return specializationFromIsCall(isCall); }
fpizlo@apple.com's avatar
fpizlo@apple.com committed
129 130 131 132 133 134 135

    JSFunction* calleeConstant() const
    {
        if (calleeRecovery.isConstant())
            return jsCast<JSFunction*>(calleeRecovery.constant());
        return 0;
    }
136
    
137 138 139
    // Get the callee given a machine call frame to which this InlineCallFrame belongs.
    JSFunction* calleeForCallFrame(ExecState*) const;
    
140
    CString inferredName() const;
141
    CodeBlockHash hash() const;
142
    
143 144
    CodeBlock* baselineCodeBlock() const;
    
145 146 147
    ptrdiff_t callerFrameOffset() const { return stackOffset * sizeof(Register) + CallFrame::callerFrameOffset(); }
    ptrdiff_t returnPCOffset() const { return stackOffset * sizeof(Register) + CallFrame::returnPCOffset(); }

148
    void dumpBriefFunctionInformation(PrintStream&) const;
149
    void dump(PrintStream&) const;
150
    void dumpInContext(PrintStream&, DumpContext*) const;
151 152

    MAKE_PRINT_METHOD(InlineCallFrame, dumpBriefFunctionInformation, briefFunctionInformation);
153 154
};

155
inline int CodeOrigin::stackOffset() const
156 157 158 159 160 161 162
{
    if (!inlineCallFrame)
        return 0;
    
    return inlineCallFrame->stackOffset;
}

163 164 165 166 167 168
inline unsigned CodeOrigin::hash() const
{
    return WTF::IntHash<unsigned>::hash(bytecodeIndex) +
        WTF::PtrHash<InlineCallFrame*>::hash(inlineCallFrame);
}

fpizlo@apple.com's avatar
fpizlo@apple.com committed
169 170 171 172 173 174
inline bool CodeOrigin::operator==(const CodeOrigin& other) const
{
    return bytecodeIndex == other.bytecodeIndex
        && inlineCallFrame == other.inlineCallFrame;
}
    
175
inline ScriptExecutable* CodeOrigin::codeOriginOwner() const
176 177 178 179 180 181
{
    if (!inlineCallFrame)
        return 0;
    return inlineCallFrame->executable.get();
}

182 183 184 185 186 187
struct CodeOriginHash {
    static unsigned hash(const CodeOrigin& key) { return key.hash(); }
    static bool equal(const CodeOrigin& a, const CodeOrigin& b) { return a == b; }
    static const bool safeToCompareToEmptyOrDeleted = true;
};

188 189
} // namespace JSC

190 191 192 193 194 195 196 197 198 199 200 201 202 203
namespace WTF {

template<typename T> struct DefaultHash;
template<> struct DefaultHash<JSC::CodeOrigin> {
    typedef JSC::CodeOriginHash Hash;
};

template<typename T> struct HashTraits;
template<> struct HashTraits<JSC::CodeOrigin> : SimpleClassHashTraits<JSC::CodeOrigin> {
    static const bool emptyValueIsZero = false;
};

} // namespace WTF

204 205
#endif // CodeOrigin_h