3f5c81ab4ea1af1a765ab36c083787d87c0c8f82
[WebKit-https.git] / Source / JavaScriptCore / bytecode / BytecodeUseDef.h
1 /*
2  * Copyright (C) 2013, 2015-2016 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. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #ifndef BytecodeUseDef_h
27 #define BytecodeUseDef_h
28
29 #include "CodeBlock.h"
30
31 namespace JSC {
32
33 template<typename Functor>
34 void computeUsesForBytecodeOffset(
35     CodeBlock* codeBlock, BytecodeBasicBlock* block, unsigned bytecodeOffset, const Functor& functor)
36 {
37     Interpreter* interpreter = codeBlock->vm()->interpreter;
38     Instruction* instructionsBegin = codeBlock->instructions().begin();
39     Instruction* instruction = &instructionsBegin[bytecodeOffset];
40     OpcodeID opcodeID = interpreter->getOpcodeID(instruction->u.opcode);
41     switch (opcodeID) {
42     // No uses.
43     case op_new_regexp:
44     case op_new_array_buffer:
45     case op_throw_static_error:
46     case op_debug:
47     case op_jneq_ptr:
48     case op_loop_hint:
49     case op_jmp:
50     case op_new_object:
51     case op_enter:
52     case op_catch:
53     case op_profile_control_flow:
54     case op_create_direct_arguments:
55     case op_create_cloned_arguments:
56     case op_get_rest_length:
57     case op_watchdog:
58         return;
59     case op_assert:
60     case op_get_scope:
61     case op_to_this:
62     case op_check_tdz:
63     case op_profile_type:
64     case op_throw:
65     case op_end:
66     case op_ret:
67     case op_jtrue:
68     case op_jfalse:
69     case op_jeq_null:
70     case op_jneq_null:
71     case op_dec:
72     case op_inc:
73     case op_log_shadow_chicken_prologue:
74     case op_resume: {
75         ASSERT(opcodeLengths[opcodeID] > 1);
76         functor(codeBlock, instruction, opcodeID, instruction[1].u.operand);
77         return;
78     }
79     case op_jlesseq:
80     case op_jgreater:
81     case op_jgreatereq:
82     case op_jnless:
83     case op_jnlesseq:
84     case op_jngreater:
85     case op_jngreatereq:
86     case op_jless:
87     case op_set_function_name:
88     case op_log_shadow_chicken_tail:
89     case op_copy_rest: {
90         ASSERT(opcodeLengths[opcodeID] > 2);
91         functor(codeBlock, instruction, opcodeID, instruction[1].u.operand);
92         functor(codeBlock, instruction, opcodeID, instruction[2].u.operand);
93         return;
94     }
95     case op_put_by_val_direct:
96     case op_put_by_val: {
97         ASSERT(opcodeLengths[opcodeID] > 3);
98         functor(codeBlock, instruction, opcodeID, instruction[1].u.operand);
99         functor(codeBlock, instruction, opcodeID, instruction[2].u.operand);
100         functor(codeBlock, instruction, opcodeID, instruction[3].u.operand);
101         return;
102     }
103     case op_put_by_index:
104     case op_put_by_id:
105     case op_put_to_scope:
106     case op_put_to_arguments: {
107         ASSERT(opcodeLengths[opcodeID] > 3);
108         functor(codeBlock, instruction, opcodeID, instruction[1].u.operand);
109         functor(codeBlock, instruction, opcodeID, instruction[3].u.operand);
110         return;
111     }
112     case op_put_by_id_with_this: {
113         ASSERT(opcodeLengths[opcodeID] > 4);
114         functor(codeBlock, instruction, opcodeID, instruction[1].u.operand);
115         functor(codeBlock, instruction, opcodeID, instruction[2].u.operand);
116         functor(codeBlock, instruction, opcodeID, instruction[4].u.operand);
117         return;
118     }
119     case op_put_by_val_with_this: {
120         ASSERT(opcodeLengths[opcodeID] > 4);
121         functor(codeBlock, instruction, opcodeID, instruction[1].u.operand);
122         functor(codeBlock, instruction, opcodeID, instruction[2].u.operand);
123         functor(codeBlock, instruction, opcodeID, instruction[3].u.operand);
124         functor(codeBlock, instruction, opcodeID, instruction[4].u.operand);
125         return;
126     }
127     case op_put_getter_by_id:
128     case op_put_setter_by_id: {
129         ASSERT(opcodeLengths[opcodeID] > 4);
130         functor(codeBlock, instruction, opcodeID, instruction[1].u.operand);
131         functor(codeBlock, instruction, opcodeID, instruction[4].u.operand);
132         return;
133     }
134     case op_put_getter_setter_by_id: {
135         ASSERT(opcodeLengths[opcodeID] > 5);
136         functor(codeBlock, instruction, opcodeID, instruction[1].u.operand);
137         functor(codeBlock, instruction, opcodeID, instruction[4].u.operand);
138         functor(codeBlock, instruction, opcodeID, instruction[5].u.operand);
139         return;
140     }
141     case op_put_getter_by_val:
142     case op_put_setter_by_val: {
143         ASSERT(opcodeLengths[opcodeID] > 4);
144         functor(codeBlock, instruction, opcodeID, instruction[1].u.operand);
145         functor(codeBlock, instruction, opcodeID, instruction[2].u.operand);
146         functor(codeBlock, instruction, opcodeID, instruction[4].u.operand);
147         return;
148     }
149     case op_get_property_enumerator:
150     case op_get_enumerable_length:
151     case op_new_func_exp:
152     case op_new_generator_func_exp:
153     case op_to_index_string:
154     case op_create_lexical_environment:
155     case op_resolve_scope:
156     case op_get_from_scope:
157     case op_to_primitive:
158     case op_try_get_by_id:
159     case op_get_by_id:
160     case op_get_array_length:
161     case op_typeof:
162     case op_is_empty:
163     case op_is_undefined:
164     case op_is_boolean:
165     case op_is_number:
166     case op_is_string:
167     case op_is_object:
168     case op_is_object_or_null:
169     case op_is_function:
170     case op_to_number:
171     case op_to_string:
172     case op_negate:
173     case op_neq_null:
174     case op_eq_null:
175     case op_not:
176     case op_mov:
177     case op_new_array_with_size:
178     case op_create_this:
179     case op_del_by_id:
180     case op_unsigned:
181     case op_new_func:
182     case op_new_generator_func:
183     case op_get_parent_scope:
184     case op_create_scoped_arguments:
185     case op_get_from_arguments: {
186         ASSERT(opcodeLengths[opcodeID] > 2);
187         functor(codeBlock, instruction, opcodeID, instruction[2].u.operand);
188         return;
189     }
190     case op_has_generic_property:
191     case op_has_indexed_property:
192     case op_enumerator_structure_pname:
193     case op_enumerator_generic_pname:
194     case op_get_by_val:
195     case op_in:
196     case op_overrides_has_instance:
197     case op_instanceof:
198     case op_add:
199     case op_mul:
200     case op_div:
201     case op_mod:
202     case op_sub:
203     case op_lshift:
204     case op_rshift:
205     case op_urshift:
206     case op_bitand:
207     case op_bitxor:
208     case op_bitor:
209     case op_less:
210     case op_lesseq:
211     case op_greater:
212     case op_greatereq:
213     case op_nstricteq:
214     case op_stricteq:
215     case op_neq:
216     case op_eq:
217     case op_push_with_scope:
218     case op_get_by_id_with_this:
219     case op_del_by_val: {
220         ASSERT(opcodeLengths[opcodeID] > 3);
221         functor(codeBlock, instruction, opcodeID, instruction[2].u.operand);
222         functor(codeBlock, instruction, opcodeID, instruction[3].u.operand);
223         return;
224     }
225     case op_get_by_val_with_this: {
226         ASSERT(opcodeLengths[opcodeID] > 4);
227         functor(codeBlock, instruction, opcodeID, instruction[2].u.operand);
228         functor(codeBlock, instruction, opcodeID, instruction[3].u.operand);
229         functor(codeBlock, instruction, opcodeID, instruction[4].u.operand);
230         return;
231     }
232     case op_instanceof_custom:
233     case op_has_structure_property:
234     case op_construct_varargs:
235     case op_call_varargs:
236     case op_tail_call_varargs: {
237         ASSERT(opcodeLengths[opcodeID] > 4);
238         functor(codeBlock, instruction, opcodeID, instruction[2].u.operand);
239         functor(codeBlock, instruction, opcodeID, instruction[3].u.operand);
240         functor(codeBlock, instruction, opcodeID, instruction[4].u.operand);
241         return;
242     }
243     case op_get_direct_pname: {
244         ASSERT(opcodeLengths[opcodeID] > 5);
245         functor(codeBlock, instruction, opcodeID, instruction[2].u.operand);
246         functor(codeBlock, instruction, opcodeID, instruction[3].u.operand);
247         functor(codeBlock, instruction, opcodeID, instruction[4].u.operand);
248         functor(codeBlock, instruction, opcodeID, instruction[5].u.operand);
249         return;
250     }
251     case op_switch_string:
252     case op_switch_char:
253     case op_switch_imm: {
254         ASSERT(opcodeLengths[opcodeID] > 3);
255         functor(codeBlock, instruction, opcodeID, instruction[3].u.operand);
256         return;
257     }
258     case op_new_array:
259     case op_strcat: {
260         int base = instruction[2].u.operand;
261         int count = instruction[3].u.operand;
262         for (int i = 0; i < count; i++)
263             functor(codeBlock, instruction, opcodeID, base - i);
264         return;
265     }
266     case op_construct:
267     case op_call_eval:
268     case op_call:
269     case op_tail_call: {
270         functor(codeBlock, instruction, opcodeID, instruction[2].u.operand);
271         int argCount = instruction[3].u.operand;
272         int registerOffset = -instruction[4].u.operand;
273         int lastArg = registerOffset + CallFrame::thisArgumentOffset();
274         for (int i = 0; i < argCount; i++)
275             functor(codeBlock, instruction, opcodeID, lastArg + i);
276         return;
277     }
278     case op_save: {
279         functor(codeBlock, instruction, opcodeID, instruction[1].u.operand);
280         unsigned mergePointBytecodeOffset = bytecodeOffset + instruction[3].u.operand;
281         BytecodeBasicBlock* mergePointBlock = nullptr;
282         for (BytecodeBasicBlock* successor : block->successors()) {
283             if (successor->leaderBytecodeOffset() == mergePointBytecodeOffset) {
284                 mergePointBlock = successor;
285                 break;
286             }
287         }
288         ASSERT(mergePointBlock);
289         mergePointBlock->in().forEachSetBit([&](unsigned local) {
290             functor(codeBlock, instruction, opcodeID, virtualRegisterForLocal(local).offset());
291         });
292         return;
293     }
294     default:
295         RELEASE_ASSERT_NOT_REACHED();
296         break;
297     }
298 }
299
300 template<typename Functor>
301 void computeDefsForBytecodeOffset(CodeBlock* codeBlock, BytecodeBasicBlock* block, unsigned bytecodeOffset, const Functor& functor)
302 {
303     Interpreter* interpreter = codeBlock->vm()->interpreter;
304     Instruction* instructionsBegin = codeBlock->instructions().begin();
305     Instruction* instruction = &instructionsBegin[bytecodeOffset];
306     OpcodeID opcodeID = interpreter->getOpcodeID(instruction->u.opcode);
307     switch (opcodeID) {
308     // These don't define anything.
309     case op_copy_rest:
310     case op_put_to_scope:
311     case op_end:
312     case op_throw:
313     case op_throw_static_error:
314     case op_save:
315     case op_assert:
316     case op_debug:
317     case op_ret:
318     case op_jmp:
319     case op_jtrue:
320     case op_jfalse:
321     case op_jeq_null:
322     case op_jneq_null:
323     case op_jneq_ptr:
324     case op_jless:
325     case op_jlesseq:
326     case op_jgreater:
327     case op_jgreatereq:
328     case op_jnless:
329     case op_jnlesseq:
330     case op_jngreater:
331     case op_jngreatereq:
332     case op_loop_hint:
333     case op_switch_imm:
334     case op_switch_char:
335     case op_switch_string:
336     case op_put_by_id:
337     case op_put_by_id_with_this:
338     case op_put_by_val_with_this:
339     case op_put_getter_by_id:
340     case op_put_setter_by_id:
341     case op_put_getter_setter_by_id:
342     case op_put_getter_by_val:
343     case op_put_setter_by_val:
344     case op_put_by_val:
345     case op_put_by_val_direct:
346     case op_put_by_index:
347     case op_profile_type:
348     case op_profile_control_flow:
349     case op_put_to_arguments:
350     case op_set_function_name:
351     case op_watchdog:
352     case op_log_shadow_chicken_prologue:
353     case op_log_shadow_chicken_tail:
354 #define LLINT_HELPER_OPCODES(opcode, length) case opcode:
355         FOR_EACH_LLINT_OPCODE_EXTENSION(LLINT_HELPER_OPCODES);
356 #undef LLINT_HELPER_OPCODES
357         return;
358     // These all have a single destination for the first argument.
359     case op_to_index_string:
360     case op_get_enumerable_length:
361     case op_has_indexed_property:
362     case op_has_structure_property:
363     case op_has_generic_property:
364     case op_get_direct_pname:
365     case op_get_property_enumerator:
366     case op_enumerator_structure_pname:
367     case op_enumerator_generic_pname:
368     case op_get_parent_scope:
369     case op_push_with_scope:
370     case op_create_lexical_environment:
371     case op_resolve_scope:
372     case op_strcat:
373     case op_to_primitive:
374     case op_create_this:
375     case op_new_array:
376     case op_new_array_buffer:
377     case op_new_array_with_size:
378     case op_new_regexp:
379     case op_new_func:
380     case op_new_func_exp:
381     case op_new_generator_func:
382     case op_new_generator_func_exp:
383     case op_call_varargs:
384     case op_tail_call_varargs:
385     case op_construct_varargs:
386     case op_get_from_scope:
387     case op_call:
388     case op_tail_call:
389     case op_call_eval:
390     case op_construct:
391     case op_try_get_by_id:
392     case op_get_by_id:
393     case op_get_by_id_with_this:
394     case op_get_by_val_with_this:
395     case op_get_array_length:
396     case op_overrides_has_instance:
397     case op_instanceof:
398     case op_instanceof_custom:
399     case op_get_by_val:
400     case op_typeof:
401     case op_is_empty:
402     case op_is_undefined:
403     case op_is_boolean:
404     case op_is_number:
405     case op_is_string:
406     case op_is_object:
407     case op_is_object_or_null:
408     case op_is_function:
409     case op_in:
410     case op_to_number:
411     case op_to_string:
412     case op_negate:
413     case op_add:
414     case op_mul:
415     case op_div:
416     case op_mod:
417     case op_sub:
418     case op_lshift:
419     case op_rshift:
420     case op_urshift:
421     case op_bitand:
422     case op_bitxor:
423     case op_bitor:
424     case op_inc:
425     case op_dec:
426     case op_eq:
427     case op_neq:
428     case op_stricteq:
429     case op_nstricteq:
430     case op_less:
431     case op_lesseq:
432     case op_greater:
433     case op_greatereq:
434     case op_neq_null:
435     case op_eq_null:
436     case op_not:
437     case op_mov:
438     case op_new_object:
439     case op_to_this:
440     case op_check_tdz:
441     case op_get_scope:
442     case op_create_direct_arguments:
443     case op_create_scoped_arguments:
444     case op_create_cloned_arguments:
445     case op_del_by_id:
446     case op_del_by_val:
447     case op_unsigned:
448     case op_get_from_arguments: 
449     case op_get_rest_length: {
450         ASSERT(opcodeLengths[opcodeID] > 1);
451         functor(codeBlock, instruction, opcodeID, instruction[1].u.operand);
452         return;
453     }
454     case op_catch: {
455         ASSERT(opcodeLengths[opcodeID] > 2);
456         functor(codeBlock, instruction, opcodeID, instruction[1].u.operand);
457         functor(codeBlock, instruction, opcodeID, instruction[2].u.operand);
458         return;
459     }
460     case op_enter: {
461         for (unsigned i = codeBlock->m_numVars; i--;)
462             functor(codeBlock, instruction, opcodeID, virtualRegisterForLocal(i).offset());
463         return;
464     }
465     case op_resume: {
466         RELEASE_ASSERT(block->successors().size() == 1);
467         block->successors()[0]->in().forEachSetBit([&](unsigned local) {
468             functor(codeBlock, instruction, opcodeID, virtualRegisterForLocal(local).offset());
469         });
470         return;
471     }
472     }
473 }
474
475 } // namespace JSC
476
477 #endif // BytecodeUseDef_h
478