2008-12-01 Gavin Barraclough <barraclough@apple.com>
[WebKit-https.git] / JavaScriptCore / bytecode / Instruction.h
1 /*
2  * Copyright (C) 2008 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  *
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer.
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution.
13  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
14  *     its contributors may be used to endorse or promote products derived
15  *     from this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28
29 #ifndef Instruction_h
30 #define Instruction_h
31
32 #include "Opcode.h"
33 #include "ResultType.h"
34 #include <wtf/VectorTraits.h>
35
36 #define POLYMORPHIC_LIST_CACHE_SIZE 4
37
38 namespace JSC {
39
40     class JSCell;
41     class Structure;
42     class StructureChain;
43
44     // Structure used by op_get_by_id_proto_list instruction to hold data off the main opcode stream.
45     struct PolymorphicAccessStructureList {
46         struct PolymorphicStubInfo {
47             unsigned cachedOffset : 31;
48             unsigned isChain : 1;
49             void* stubRoutine;
50             Structure* base;
51             union {
52                 Structure* proto;
53                 StructureChain* chain;
54             } u;
55
56             void set(int _cachedOffset, void* _stubRoutine, Structure* _base)
57             {
58                 cachedOffset = _cachedOffset;
59                 stubRoutine = _stubRoutine;
60                 base = _base;
61                 u.proto = 0;
62                 isChain = false;
63             }
64             
65             void set(int _cachedOffset, void* _stubRoutine, Structure* _base, Structure* _proto)
66             {
67                 cachedOffset = _cachedOffset;
68                 stubRoutine = _stubRoutine;
69                 base = _base;
70                 u.proto = _proto;
71                 isChain = false;
72             }
73             
74             void set(int _cachedOffset, void* _stubRoutine, Structure* _base, StructureChain* _chain)
75             {
76                 cachedOffset = _cachedOffset;
77                 stubRoutine = _stubRoutine;
78                 base = _base;
79                 u.chain = _chain;
80                 isChain = true;
81             }
82         } list[POLYMORPHIC_LIST_CACHE_SIZE];
83         
84         PolymorphicAccessStructureList(int cachedOffset, void* stubRoutine, Structure* firstBase)
85         {
86             list[0].set(cachedOffset, stubRoutine, firstBase);
87         }
88
89         PolymorphicAccessStructureList(int cachedOffset, void* stubRoutine, Structure* firstBase, Structure* firstProto)
90         {
91             list[0].set(cachedOffset, stubRoutine, firstBase, firstProto);
92         }
93
94         PolymorphicAccessStructureList(int cachedOffset, void* stubRoutine, Structure* firstBase, StructureChain* firstChain)
95         {
96             list[0].set(cachedOffset, stubRoutine, firstBase, firstChain);
97         }
98
99         void derefStructures(int count)
100         {
101             for (int i = 0; i < count; ++i) {
102                 PolymorphicStubInfo& info = list[i];
103
104                 ASSERT(info.base);
105                 info.base->deref();
106
107                 if (info.u.proto) {
108                     if (info.isChain)
109                         info.u.chain->deref();
110                     else
111                         info.u.proto->deref();
112                 }
113
114                 if (info.stubRoutine)
115                     WTF::fastFreeExecutable(info.stubRoutine);
116             }
117         }
118     };
119
120     struct Instruction {
121         Instruction(Opcode opcode) { u.opcode = opcode; }
122         Instruction(int operand)
123         {
124             // We have to initialize one of the pointer members to ensure that
125             // the entire struct is initialised in 64-bit.
126             u.jsCell = 0;
127             u.operand = operand;
128         }
129
130         Instruction(Structure* structure) { u.structure = structure; }
131         Instruction(StructureChain* structureChain) { u.structureChain = structureChain; }
132         Instruction(JSCell* jsCell) { u.jsCell = jsCell; }
133         Instruction(PolymorphicAccessStructureList* polymorphicStructures) { u.polymorphicStructures = polymorphicStructures; }
134
135         union {
136             Opcode opcode;
137             int operand;
138             Structure* structure;
139             StructureChain* structureChain;
140             JSCell* jsCell;
141             ResultType::Type resultType;
142             PolymorphicAccessStructureList* polymorphicStructures;
143         } u;
144     };
145
146 } // namespace JSC
147
148 namespace WTF {
149
150     template<> struct VectorTraits<JSC::Instruction> : VectorTraitsBase<true, JSC::Instruction> { };
151
152 } // namespace WTF
153
154 #endif // Instruction_h