DFGVariableAccessData.h 11.7 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 DFGVariableAccessData_h
#define DFGVariableAccessData_h

29
#include "DFGCommon.h"
30
#include "DFGDoubleFormatState.h"
31
#include "DFGFlushFormat.h"
fpizlo@apple.com's avatar
fpizlo@apple.com committed
32
#include "DFGFlushedAt.h"
33
#include "DFGNodeFlags.h"
34
#include "Operands.h"
35
#include "SpeculatedType.h"
36
#include "VirtualRegister.h"
37 38
#include <wtf/Platform.h>
#include <wtf/UnionFind.h>
39
#include <wtf/Vector.h>
40 41 42

namespace JSC { namespace DFG {

43 44
struct Node;

45 46
enum DoubleBallot { VoteValue, VoteDouble };

47
class VariableAccessData : public UnionFind<VariableAccessData> {
48 49 50
public:
    VariableAccessData()
        : m_local(static_cast<VirtualRegister>(std::numeric_limits<int>::min()))
51 52
        , m_prediction(SpecNone)
        , m_argumentAwarePrediction(SpecNone)
53
        , m_flags(0)
54
        , m_isCaptured(false)
55
        , m_shouldNeverUnbox(false)
56
        , m_isArgumentsAlias(false)
57
        , m_structureCheckHoistingFailed(false)
58
        , m_checkArrayHoistingFailed(false)
59
        , m_isProfitableToUnbox(false)
60
        , m_isLoadedFrom(false)
61
        , m_doubleFormatState(EmptyDoubleFormatState)
62
    {
63
        clearVotes();
64 65
    }
    
66
    VariableAccessData(VirtualRegister local, bool isCaptured)
67
        : m_local(local)
68 69
        , m_prediction(SpecNone)
        , m_argumentAwarePrediction(SpecNone)
70
        , m_flags(0)
71
        , m_isCaptured(isCaptured)
72
        , m_shouldNeverUnbox(isCaptured)
73
        , m_isArgumentsAlias(false)
74
        , m_structureCheckHoistingFailed(false)
75
        , m_checkArrayHoistingFailed(false)
76
        , m_isProfitableToUnbox(false)
77
        , m_isLoadedFrom(false)
78
        , m_doubleFormatState(EmptyDoubleFormatState)
79
    {
80
        clearVotes();
81 82 83 84 85 86 87
    }
    
    VirtualRegister local()
    {
        ASSERT(m_local == find()->m_local);
        return m_local;
    }
fpizlo@apple.com's avatar
fpizlo@apple.com committed
88 89 90 91 92 93
    
    VirtualRegister& machineLocal()
    {
        ASSERT(find() == this);
        return m_machineLocal;
    }
94

95 96
    bool mergeIsCaptured(bool isCaptured)
    {
97 98
        return checkAndSet(m_shouldNeverUnbox, m_shouldNeverUnbox | isCaptured)
            | checkAndSet(m_isCaptured, m_isCaptured | isCaptured);
99 100 101 102 103 104 105
    }
    
    bool isCaptured()
    {
        return m_isCaptured;
    }
    
106 107 108 109 110 111 112 113 114 115
    bool mergeIsProfitableToUnbox(bool isProfitableToUnbox)
    {
        return checkAndSet(m_isProfitableToUnbox, m_isProfitableToUnbox | isProfitableToUnbox);
    }
    
    bool isProfitableToUnbox()
    {
        return m_isProfitableToUnbox;
    }
    
116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138
    bool mergeShouldNeverUnbox(bool shouldNeverUnbox)
    {
        bool newShouldNeverUnbox = m_shouldNeverUnbox | shouldNeverUnbox;
        if (newShouldNeverUnbox == m_shouldNeverUnbox)
            return false;
        m_shouldNeverUnbox = newShouldNeverUnbox;
        return true;
    }
    
    // Returns true if it would be unsound to store the value in an unboxed fashion.
    // If this returns false, it simply means that it is sound to unbox; it doesn't
    // mean that we have actually done so.
    bool shouldNeverUnbox()
    {
        ASSERT(!(m_isCaptured && !m_shouldNeverUnbox));
        return m_shouldNeverUnbox;
    }
    
    // Returns true if we should be unboxing the value provided that the predictions
    // and double format vote say so. This may return false even if shouldNeverUnbox()
    // returns false, since this incorporates heuristics of profitability.
    bool shouldUnboxIfPossible()
    {
139
        return !shouldNeverUnbox() && isProfitableToUnbox();
140
    }
141

142 143
    bool mergeStructureCheckHoistingFailed(bool failed)
    {
144
        return checkAndSet(m_structureCheckHoistingFailed, m_structureCheckHoistingFailed | failed);
145 146
    }
    
147 148 149 150 151
    bool mergeCheckArrayHoistingFailed(bool failed)
    {
        return checkAndSet(m_checkArrayHoistingFailed, m_checkArrayHoistingFailed | failed);
    }
    
152 153 154 155 156
    bool structureCheckHoistingFailed()
    {
        return m_structureCheckHoistingFailed;
    }
    
157 158 159 160 161
    bool checkArrayHoistingFailed()
    {
        return m_checkArrayHoistingFailed;
    }
    
162 163
    bool mergeIsArgumentsAlias(bool isArgumentsAlias)
    {
164
        return checkAndSet(m_isArgumentsAlias, m_isArgumentsAlias | isArgumentsAlias);
165 166 167 168 169 170 171
    }
    
    bool isArgumentsAlias()
    {
        return m_isArgumentsAlias;
    }
    
172 173 174 175 176 177 178 179 180 181 182 183 184 185 186
    bool mergeIsLoadedFrom(bool isLoadedFrom)
    {
        return checkAndSet(m_isLoadedFrom, m_isLoadedFrom | isLoadedFrom);
    }
    
    void setIsLoadedFrom(bool isLoadedFrom)
    {
        m_isLoadedFrom = isLoadedFrom;
    }
    
    bool isLoadedFrom()
    {
        return m_isLoadedFrom;
    }
    
187
    bool predict(SpeculatedType prediction)
188
    {
189
        VariableAccessData* self = find();
190
        bool result = mergeSpeculation(self->m_prediction, prediction);
191
        if (result)
192
            mergeSpeculation(m_argumentAwarePrediction, m_prediction);
193
        return result;
194 195
    }
    
196
    SpeculatedType nonUnifiedPrediction()
197 198 199 200
    {
        return m_prediction;
    }
    
201
    SpeculatedType prediction()
202 203 204 205
    {
        return find()->m_prediction;
    }
    
206
    SpeculatedType argumentAwarePrediction()
207 208 209 210
    {
        return find()->m_argumentAwarePrediction;
    }
    
211
    bool mergeArgumentAwarePrediction(SpeculatedType prediction)
212
    {
213
        return mergeSpeculation(find()->m_argumentAwarePrediction, prediction);
214 215
    }
    
216 217 218
    void clearVotes()
    {
        ASSERT(find() == this);
219 220
        m_votes[0] = 0;
        m_votes[1] = 0;
221 222
    }
    
223
    void vote(unsigned ballot)
224
    {
225
        ASSERT(ballot < 2);
226 227 228
        m_votes[ballot]++;
    }
    
229
    double voteRatio()
230 231
    {
        ASSERT(find() == this);
232
        return static_cast<double>(m_votes[1]) / m_votes[0];
233 234 235 236
    }
    
    bool shouldUseDoubleFormatAccordingToVote()
    {
237
        // We don't support this facility for arguments, yet.
238
        // FIXME: make this work for arguments.
239
        if (local().isArgument())
240 241 242 243
            return false;
        
        // If the variable is not a number prediction, then this doesn't
        // make any sense.
244
        if (!isFullNumberSpeculation(prediction())) {
245 246 247
            // FIXME: we may end up forcing a local in inlined argument position to be a double even
            // if it is sometimes not even numeric, since this never signals the fact that it doesn't
            // want doubles. https://bugs.webkit.org/show_bug.cgi?id=109511
248
            return false;
249
        }
250 251 252
        
        // If the variable is predicted to hold only doubles, then it's a
        // no-brainer: it should be formatted as a double.
253
        if (isDoubleSpeculation(prediction()))
254 255 256 257
            return true;
        
        // If the variable is known to be used as an integer, then be safe -
        // don't force it to be a double.
258
        if (flags() & NodeBytecodeUsesAsInt)
259 260 261 262
            return false;
        
        // If the variable has been voted to become a double, then make it a
        // double.
263
        if (voteRatio() >= Options::doubleVoteRatioForDoubleFormat())
264 265 266
            return true;
        
        return false;
267 268
    }
    
269 270 271 272 273
    DoubleFormatState doubleFormatState()
    {
        return find()->m_doubleFormatState;
    }
    
274 275
    bool shouldUseDoubleFormat()
    {
276
        ASSERT(isRoot());
277 278 279 280
        bool doubleState = m_doubleFormatState == UsingDoubleFormat;
        ASSERT(!(doubleState && shouldNeverUnbox()));
        ASSERT(!(doubleState && isCaptured()));
        return doubleState && isProfitableToUnbox();
281 282 283 284
    }
    
    bool tallyVotesForShouldUseDoubleFormat()
    {
285 286
        ASSERT(isRoot());
        
287
        if (local().isArgument() || shouldNeverUnbox())
288 289
            return DFG::mergeDoubleFormatState(m_doubleFormatState, NotUsingDoubleFormat);
        
290 291
        if (m_doubleFormatState == CantUseDoubleFormat)
            return false;
292 293 294
        
        bool newValueOfShouldUseDoubleFormat = shouldUseDoubleFormatAccordingToVote();
        if (!newValueOfShouldUseDoubleFormat) {
295 296
            // We monotonically convert to double. Hence, if the fixpoint leads us to conclude that we should
            // switch back to int, we instead ignore this and stick with double.
297 298 299
            return false;
        }
        
300
        if (m_doubleFormatState == UsingDoubleFormat)
301 302
            return false;
        
303 304 305 306 307 308 309 310 311 312 313 314 315 316 317
        return DFG::mergeDoubleFormatState(m_doubleFormatState, UsingDoubleFormat);
    }
    
    bool mergeDoubleFormatState(DoubleFormatState doubleFormatState)
    {
        return DFG::mergeDoubleFormatState(find()->m_doubleFormatState, doubleFormatState);
    }
    
    bool makePredictionForDoubleFormat()
    {
        ASSERT(isRoot());
        
        if (m_doubleFormatState != UsingDoubleFormat)
            return false;
        
318
        return mergeSpeculation(m_prediction, SpecDouble);
319 320
    }
    
321 322 323 324
    NodeFlags flags() const { return m_flags; }
    
    bool mergeFlags(NodeFlags newFlags)
    {
325
        return checkAndSet(m_flags, m_flags | newFlags);
326 327
    }
    
328 329 330 331
    FlushFormat flushFormat()
    {
        ASSERT(find() == this);
        
332 333 334
        if (isArgumentsAlias())
            return FlushedArguments;
        
335 336 337 338 339 340 341 342 343 344
        if (!shouldUnboxIfPossible())
            return FlushedJSValue;
        
        if (shouldUseDoubleFormat())
            return FlushedDouble;
        
        SpeculatedType prediction = argumentAwarePrediction();
        if (isInt32Speculation(prediction))
            return FlushedInt32;
        
345
        if (enableInt52() && !m_local.isArgument() && isMachineIntSpeculation(prediction))
346 347
            return FlushedInt52;
        
348 349 350 351 352 353 354 355 356
        if (isCellSpeculation(prediction))
            return FlushedCell;
        
        if (isBooleanSpeculation(prediction))
            return FlushedBoolean;
        
        return FlushedJSValue;
    }
    
fpizlo@apple.com's avatar
fpizlo@apple.com committed
357 358 359 360
    FlushedAt flushedAt()
    {
        return FlushedAt(flushFormat(), machineLocal());
    }
361

362 363 364 365 366 367 368
private:
    // This is slightly space-inefficient, since anything we're unified with
    // will have the same operand and should have the same prediction. But
    // putting them here simplifies the code, and we don't expect DFG space
    // usage for variable access nodes do be significant.

    VirtualRegister m_local;
fpizlo@apple.com's avatar
fpizlo@apple.com committed
369
    VirtualRegister m_machineLocal;
370 371
    SpeculatedType m_prediction;
    SpeculatedType m_argumentAwarePrediction;
372
    NodeFlags m_flags;
373

374
    bool m_isCaptured;
375
    bool m_shouldNeverUnbox;
376
    bool m_isArgumentsAlias;
377
    bool m_structureCheckHoistingFailed;
378
    bool m_checkArrayHoistingFailed;
379
    bool m_isProfitableToUnbox;
380
    bool m_isLoadedFrom;
381 382 383

    float m_votes[2]; // Used primarily for double voting but may be reused for other purposes.
    DoubleFormatState m_doubleFormatState;
384 385 386 387 388
};

} } // namespace JSC::DFG

#endif // DFGVariableAccessData_h