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