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