1 /*
2  * Copyright (C) 2008, 2009 Apple Inc. All rights reserved.
3  * Copyright (C) 2008 Cameron Zwarich <cwzwarich@uwaterloo.ca>
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * 1.  Redistributions of source code must retain the above copyright
10  *     notice, this list of conditions and the following disclaimer.
11  * 2.  Redistributions in binary form must reproduce the above copyright
12  *     notice, this list of conditions and the following disclaimer in the
13  *     documentation and/or other materials provided with the distribution.
14  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
15  *     its contributors may be used to endorse or promote products derived
16  *     from this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
19  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
20  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
22  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
24  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
25  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28  */
29 
30 #ifndef Opcode_h
31 #define Opcode_h
32 
33 #include <algorithm>
34 #include <string.h>
35 
36 #include <wtf/Assertions.h>
37 
38 namespace JSC {
39 
40     #define FOR_EACH_OPCODE_ID(macro) \
41         macro(op_enter, 1) \
42         macro(op_enter_with_activation, 2) \
43         macro(op_init_arguments, 1) \
44         macro(op_create_arguments, 1) \
45         macro(op_convert_this, 2) \
46         \
47         macro(op_new_object, 2) \
48         macro(op_new_array, 4) \
49         macro(op_new_regexp, 3) \
50         macro(op_mov, 3) \
51         \
52         macro(op_not, 3) \
53         macro(op_eq, 4) \
54         macro(op_eq_null, 3) \
55         macro(op_neq, 4) \
56         macro(op_neq_null, 3) \
57         macro(op_stricteq, 4) \
58         macro(op_nstricteq, 4) \
59         macro(op_less, 4) \
60         macro(op_lesseq, 4) \
61         \
62         macro(op_pre_inc, 2) \
63         macro(op_pre_dec, 2) \
64         macro(op_post_inc, 3) \
65         macro(op_post_dec, 3) \
66         macro(op_to_jsnumber, 3) \
67         macro(op_negate, 3) \
68         macro(op_add, 5) \
69         macro(op_mul, 5) \
70         macro(op_div, 5) \
71         macro(op_mod, 4) \
72         macro(op_sub, 5) \
73         \
74         macro(op_lshift, 4) \
75         macro(op_rshift, 4) \
76         macro(op_urshift, 4) \
77         macro(op_bitand, 5) \
78         macro(op_bitxor, 5) \
79         macro(op_bitor, 5) \
80         macro(op_bitnot, 3) \
81         \
82         macro(op_instanceof, 5) \
83         macro(op_typeof, 3) \
84         macro(op_is_undefined, 3) \
85         macro(op_is_boolean, 3) \
86         macro(op_is_number, 3) \
87         macro(op_is_string, 3) \
88         macro(op_is_object, 3) \
89         macro(op_is_function, 3) \
90         macro(op_in, 4) \
91         \
92         macro(op_resolve, 3) \
93         macro(op_resolve_skip, 4) \
94         macro(op_resolve_global, 6) \
95         macro(op_get_scoped_var, 4) \
96         macro(op_put_scoped_var, 4) \
97         macro(op_get_global_var, 4) \
98         macro(op_put_global_var, 4) \
99         macro(op_resolve_base, 3) \
100         macro(op_resolve_with_base, 4) \
101         macro(op_get_by_id, 8) \
102         macro(op_get_by_id_self, 8) \
103         macro(op_get_by_id_self_list, 8) \
104         macro(op_get_by_id_proto, 8) \
105         macro(op_get_by_id_proto_list, 8) \
106         macro(op_get_by_id_chain, 8) \
107         macro(op_get_by_id_generic, 8) \
108         macro(op_get_array_length, 8) \
109         macro(op_get_string_length, 8) \
110         macro(op_put_by_id, 8) \
111         macro(op_put_by_id_transition, 8) \
112         macro(op_put_by_id_replace, 8) \
113         macro(op_put_by_id_generic, 8) \
114         macro(op_del_by_id, 4) \
115         macro(op_get_by_val, 4) \
116         macro(op_get_by_pname, 7) \
117         macro(op_put_by_val, 4) \
118         macro(op_del_by_val, 4) \
119         macro(op_put_by_index, 4) \
120         macro(op_put_getter, 4) \
121         macro(op_put_setter, 4) \
122         \
123         macro(op_jmp, 2) \
124         macro(op_jtrue, 3) \
125         macro(op_jfalse, 3) \
126         macro(op_jeq_null, 3) \
127         macro(op_jneq_null, 3) \
128         macro(op_jneq_ptr, 4) \
129         macro(op_jnless, 4) \
130         macro(op_jnlesseq, 4) \
131         macro(op_jless, 4) \
132         macro(op_jmp_scopes, 3) \
133         macro(op_loop, 2) \
134         macro(op_loop_if_true, 3) \
135         macro(op_loop_if_false, 3) \
136         macro(op_loop_if_less, 4) \
137         macro(op_loop_if_lesseq, 4) \
138         macro(op_switch_imm, 4) \
139         macro(op_switch_char, 4) \
140         macro(op_switch_string, 4) \
141         \
142         macro(op_new_func, 3) \
143         macro(op_new_func_exp, 3) \
144         macro(op_call, 5) \
145         macro(op_call_eval, 5) \
146         macro(op_call_varargs, 5) \
147         macro(op_load_varargs, 3) \
148         macro(op_tear_off_activation, 2) \
149         macro(op_tear_off_arguments, 1) \
150         macro(op_ret, 2) \
151         macro(op_method_check, 1) \
152         \
153         macro(op_construct, 7) \
154         macro(op_construct_verify, 3) \
155         macro(op_strcat, 4) \
156         macro(op_to_primitive, 3) \
157         \
158         macro(op_get_pnames, 6) \
159         macro(op_next_pname, 7) \
160         \
161         macro(op_push_scope, 2) \
162         macro(op_pop_scope, 1) \
163         macro(op_push_new_scope, 4) \
164         \
165         macro(op_catch, 2) \
166         macro(op_throw, 2) \
167         macro(op_new_error, 4) \
168         \
169         macro(op_jsr, 3) \
170         macro(op_sret, 2) \
171         \
172         macro(op_debug, 4) \
173         macro(op_profile_will_call, 2) \
174         macro(op_profile_did_call, 2) \
175         \
176         macro(op_end, 2) // end must be the last opcode in the list
177 
178     #define OPCODE_ID_ENUM(opcode, length) opcode,
179         typedef enum { FOR_EACH_OPCODE_ID(OPCODE_ID_ENUM) } OpcodeID;
180     #undef OPCODE_ID_ENUM
181 
182     const int numOpcodeIDs = op_end + 1;
183 
184     #define OPCODE_ID_LENGTHS(id, length) const int id##_length = length;
185          FOR_EACH_OPCODE_ID(OPCODE_ID_LENGTHS);
186     #undef OPCODE_ID_LENGTHS
187 
188     #define OPCODE_LENGTH(opcode) opcode##_length
189 
190     #define OPCODE_ID_LENGTH_MAP(opcode, length) length,
191         const int opcodeLengths[numOpcodeIDs] = { FOR_EACH_OPCODE_ID(OPCODE_ID_LENGTH_MAP) };
192     #undef OPCODE_ID_LENGTH_MAP
193 
194     #define VERIFY_OPCODE_ID(id, size) COMPILE_ASSERT(id <= op_end, ASSERT_THAT_JS_OPCODE_IDS_ARE_VALID);
195         FOR_EACH_OPCODE_ID(VERIFY_OPCODE_ID);
196     #undef VERIFY_OPCODE_ID
197 
198 #if HAVE(COMPUTED_GOTO)
199 #if COMPILER(RVCT) || COMPILER(INTEL)
200     typedef void* Opcode;
201 #else
202     typedef const void* Opcode;
203 #endif
204 #else
205     typedef OpcodeID Opcode;
206 #endif
207 
208 #if ENABLE(OPCODE_SAMPLING) || ENABLE(CODEBLOCK_SAMPLING) || ENABLE(OPCODE_STATS)
209 
210 #define PADDING_STRING "                                "
211 #define PADDING_STRING_LENGTH static_cast<unsigned>(strlen(PADDING_STRING))
212 
213     extern const char* const opcodeNames[];
214 
padOpcodeName(OpcodeID op,unsigned width)215     inline const char* padOpcodeName(OpcodeID op, unsigned width)
216     {
217         unsigned pad = width - strlen(opcodeNames[op]);
218         pad = std::min(pad, PADDING_STRING_LENGTH);
219         return PADDING_STRING + PADDING_STRING_LENGTH - pad;
220     }
221 
222 #undef PADDING_STRING_LENGTH
223 #undef PADDING_STRING
224 
225 #endif
226 
227 #if ENABLE(OPCODE_STATS)
228 
229     struct OpcodeStats {
230         OpcodeStats();
231         ~OpcodeStats();
232         static long long opcodeCounts[numOpcodeIDs];
233         static long long opcodePairCounts[numOpcodeIDs][numOpcodeIDs];
234         static int lastOpcode;
235 
236         static void recordInstruction(int opcode);
237         static void resetLastInstruction();
238     };
239 
240 #endif
241 
242 } // namespace JSC
243 
244 #endif // Opcode_h
245