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