2008-12-02 Geoffrey Garen <ggaren@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 <wtf/VectorTraits.h>
34
35 #define POLYMORPHIC_LIST_CACHE_SIZE 4
36
37 namespace JSC {
38
39     class JSCell;
40     class Structure;
41     class StructureChain;
42
43     // Structure used by op_get_by_id_proto_list instruction to hold data off the main opcode stream.
44     struct PolymorphicAccessStructureList {
45         struct PolymorphicStubInfo {
46             unsigned cachedOffset : 31;
47             unsigned isChain : 1;
48             void* stubRoutine;
49             Structure* base;
50             union {
51                 Structure* proto;
52                 StructureChain* chain;
53             } u;
54
55             void set(int _cachedOffset, void* _stubRoutine, Structure* _base)
56             {
57                 cachedOffset = _cachedOffset;
58                 stubRoutine = _stubRoutine;
59                 base = _base;
60                 u.proto = 0;
61                 isChain = false;
62             }
63             
64             void set(int _cachedOffset, void* _stubRoutine, Structure* _base, Structure* _proto)
65             {
66                 cachedOffset = _cachedOffset;
67                 stubRoutine = _stubRoutine;
68                 base = _base;
69                 u.proto = _proto;
70                 isChain = false;
71             }
72             
73             void set(int _cachedOffset, void* _stubRoutine, Structure* _base, StructureChain* _chain)
74             {
75                 cachedOffset = _cachedOffset;
76                 stubRoutine = _stubRoutine;
77                 base = _base;
78                 u.chain = _chain;
79                 isChain = true;
80             }
81         } list[POLYMORPHIC_LIST_CACHE_SIZE];
82         
83         PolymorphicAccessStructureList(int cachedOffset, void* stubRoutine, Structure* firstBase)
84         {
85             list[0].set(cachedOffset, stubRoutine, firstBase);
86         }
87
88         PolymorphicAccessStructureList(int cachedOffset, void* stubRoutine, Structure* firstBase, Structure* firstProto)
89         {
90             list[0].set(cachedOffset, stubRoutine, firstBase, firstProto);
91         }
92
93         PolymorphicAccessStructureList(int cachedOffset, void* stubRoutine, Structure* firstBase, StructureChain* firstChain)
94         {
95             list[0].set(cachedOffset, stubRoutine, firstBase, firstChain);
96         }
97
98         void derefStructures(int count)
99         {
100             for (int i = 0; i < count; ++i) {
101                 PolymorphicStubInfo& info = list[i];
102
103                 ASSERT(info.base);
104                 info.base->deref();
105
106                 if (info.u.proto) {
107                     if (info.isChain)
108                         info.u.chain->deref();
109                     else
110                         info.u.proto->deref();
111                 }
112
113                 if (info.stubRoutine)
114                     WTF::fastFreeExecutable(info.stubRoutine);
115             }
116         }
117     };
118
119     struct Instruction {
120         Instruction(Opcode opcode) { u.opcode = opcode; }
121         Instruction(int operand)
122         {
123             // We have to initialize one of the pointer members to ensure that
124             // the entire struct is initialised in 64-bit.
125             u.jsCell = 0;
126             u.operand = operand;
127         }
128
129         Instruction(Structure* structure) { u.structure = structure; }
130         Instruction(StructureChain* structureChain) { u.structureChain = structureChain; }
131         Instruction(JSCell* jsCell) { u.jsCell = jsCell; }
132         Instruction(PolymorphicAccessStructureList* polymorphicStructures) { u.polymorphicStructures = polymorphicStructures; }
133
134         union {
135             Opcode opcode;
136             int operand;
137             Structure* structure;
138             StructureChain* structureChain;
139             JSCell* jsCell;
140             PolymorphicAccessStructureList* polymorphicStructures;
141         } u;
142     };
143
144 } // namespace JSC
145
146 namespace WTF {
147
148     template<> struct VectorTraits<JSC::Instruction> : VectorTraitsBase<true, JSC::Instruction> { };
149
150 } // namespace WTF
151
152 #endif // Instruction_h