d94b312ab9b27ebbe186b1037bc42cb896d00dbe
[WebKit-https.git] / Source / JavaScriptCore / bytecode / ComplexGetStatus.h
1 /*
2  * Copyright (C) 2014, 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 "JSCJSValue.h"
29 #include "ObjectPropertyConditionSet.h"
30 #include "PropertyOffset.h"
31
32 namespace JSC {
33
34 class CodeBlock;
35 class StructureChain;
36
37 // This class is useful for figuring out how to inline a cached get-like access. We
38 // say "get-like" because this is appropriate for loading the GetterSetter object in
39 // a put_by_id that hits a setter. Notably, this doesn't figure out how to call
40 // accessors, or even whether they should be called. What it gives us, is a way of
41 // determining how to load the value from the requested property (identified by a
42 // StringImpl* uid) from an object of the given structure in the given CodeBlock,
43 // assuming that such an access had already been cached by Repatch (and so Repatch had
44 // already done a bunch of safety checks). This doesn't reexecute any checks that
45 // Repatch would have executed, and for prototype chain accesses, it doesn't ask the
46 // objects in the prototype chain whether their getOwnPropertySlot would attempt to
47 // intercept the access - so this really is only appropriate if you already know that
48 // one of the JITOperations had OK'd this for caching and that Repatch concurred.
49 //
50 // The typical use pattern is something like:
51 //
52 //     ComplexGetStatus status = ComplexGetStatus::computeFor(...);
53 //     switch (status.kind()) {
54 //     case ComplexGetStatus::ShouldSkip:
55 //         // Handle the case where this kind of access is possibly safe but wouldn't
56 //         // pass the required safety checks. For example, if an IC gives us a list of
57 //         // accesses and one of them is ShouldSkip, then we should pretend as if it
58 //         // wasn't even there.
59 //         break;
60 //     case ComplexGetStatus::TakesSlowPath:
61 //         // This kind of access is not safe to inline. Bail out of any attempst to
62 //         // inline.
63 //         break;
64 //     case ComplexGetStatus::Inlineable:
65 //         // The good stuff goes here. If it's Inlineable then the other properties of
66 //         // the 'status' object will tell you everything you need to know about how
67 //         // to execute the get-like operation.
68 //         break;
69 //     }
70
71 class ComplexGetStatus {
72 public:
73     enum Kind {
74         ShouldSkip,
75         TakesSlowPath,
76         Inlineable
77     };
78     
79     ComplexGetStatus()
80         : m_kind(ShouldSkip)
81         , m_offset(invalidOffset)
82     {
83     }
84     
85     static ComplexGetStatus skip()
86     {
87         return ComplexGetStatus();
88     }
89     
90     static ComplexGetStatus takesSlowPath()
91     {
92         ComplexGetStatus result;
93         result.m_kind = TakesSlowPath;
94         return result;
95     }
96     
97     static ComplexGetStatus computeFor(
98         Structure* headStructure, const ObjectPropertyConditionSet&, UniquedStringImpl* uid);
99     
100     Kind kind() const { return m_kind; }
101     PropertyOffset offset() const { return m_offset; }
102     const ObjectPropertyConditionSet& conditionSet() const { return m_conditionSet; }
103     
104 private:
105     Kind m_kind;
106     PropertyOffset m_offset;
107     ObjectPropertyConditionSet m_conditionSet;
108 };
109
110 } // namespace JSC