JavaScriptCore/VM/Opcode.h

   1 /*
   2  * Copyright (C) 2008 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 Opcodes_h
  31 #define Opcodes_h
  32
  33 #include <algorithm>
  34 #include <string.h>
  35
  36 #include <wtf/Assertions.h>
  37
  38 namespace JSC {
  39
  40 #define DUMP_OPCODE_STATS 0
  41
  42     #define FOR_EACH_OPCODE_ID(macro) \
  43         macro(op_initialise_locals) \
  44         macro(op_unexpected_load) \
  45         macro(op_new_object) \
  46         macro(op_new_array) \
  47         macro(op_new_regexp) \
  48         macro(op_mov) \
  49         \
  50         macro(op_not) \
  51         macro(op_eq) \
  52         macro(op_eq_null) \
  53         macro(op_neq) \
  54         macro(op_neq_null) \
  55         macro(op_stricteq) \
  56         macro(op_nstricteq) \
  57         macro(op_less) \
  58         macro(op_lesseq) \
  59         \
  60         macro(op_pre_inc) \
  61         macro(op_pre_dec) \
  62         macro(op_post_inc) \
  63         macro(op_post_dec) \
  64         macro(op_to_jsnumber) \
  65         macro(op_negate) \
  66         macro(op_add) \
  67         macro(op_mul) \
  68         macro(op_div) \
  69         macro(op_mod) \
  70         macro(op_sub) \
  71         \
  72         macro(op_lshift) \
  73         macro(op_rshift) \
  74         macro(op_urshift) \
  75         macro(op_bitand) \
  76         macro(op_bitxor) \
  77         macro(op_bitor) \
  78         macro(op_bitnot) \
  79         \
  80         macro(op_instanceof) \
  81         macro(op_typeof) \
  82         macro(op_is_undefined) \
  83         macro(op_is_boolean) \
  84         macro(op_is_number) \
  85         macro(op_is_string) \
  86         macro(op_is_object) \
  87         macro(op_is_function) \
  88         macro(op_in) \
  89         \
  90         macro(op_resolve) \
  91         macro(op_resolve_skip) \
  92         macro(op_resolve_global) \
  93         macro(op_get_scoped_var) \
  94         macro(op_put_scoped_var) \
  95         macro(op_get_global_var) \
  96         macro(op_put_global_var) \
  97         macro(op_resolve_base) \
  98         macro(op_resolve_with_base) \
  99         macro(op_resolve_func) \
 100         macro(op_get_by_id) \
 101         macro(op_get_by_id_self) \
 102         macro(op_get_by_id_proto) \
 103         macro(op_get_by_id_chain) \
 104         macro(op_get_by_id_generic) \
 105         macro(op_get_array_length) \
 106         macro(op_get_string_length) \
 107         macro(op_put_by_id) \
 108         macro(op_put_by_id_transition) \
 109         macro(op_put_by_id_replace) \
 110         macro(op_put_by_id_generic) \
 111         macro(op_del_by_id) \
 112         macro(op_get_by_val) \
 113         macro(op_put_by_val) \
 114         macro(op_del_by_val) \
 115         macro(op_put_by_index) \
 116         macro(op_put_getter) \
 117         macro(op_put_setter) \
 118         \
 119         macro(op_jmp) \
 120         macro(op_jtrue) \
 121         macro(op_jfalse) \
 122         macro(op_jnless) \
 123         macro(op_jmp_scopes) \
 124         macro(op_loop) \
 125         macro(op_loop_if_true) \
 126         macro(op_loop_if_less) \
 127         macro(op_loop_if_lesseq) \
 128         macro(op_switch_imm) \
 129         macro(op_switch_char) \
 130         macro(op_switch_string) \
 131         \
 132         macro(op_new_func) \
 133         macro(op_new_func_exp) \
 134         macro(op_call) \
 135         macro(op_call_eval) \
 136         macro(op_ret) \
 137         \
 138         macro(op_construct) \
 139         macro(op_construct_verify) \
 140         \
 141         macro(op_get_pnames) \
 142         macro(op_next_pname) \
 143         \
 144         macro(op_push_scope) \
 145         macro(op_pop_scope) \
 146         macro(op_push_new_scope) \
 147         \
 148         macro(op_catch) \
 149         macro(op_throw) \
 150         macro(op_new_error) \
 151         \
 152         macro(op_jsr) \
 153         macro(op_sret) \
 154         \
 155         macro(op_debug) \
 156         \
 157         macro(op_end) // end must be the last opcode in the list
 158
 159     #define OPCODE_ID_ENUM(opcode) opcode,
 160         typedef enum { FOR_EACH_OPCODE_ID(OPCODE_ID_ENUM) } OpcodeID;
 161     #undef OPCODE_ID_ENUM
 162
 163     const int numOpcodeIDs = op_end + 1;
 164
 165     #define VERIFY_OPCODE_ID(id) COMPILE_ASSERT(id <= op_end, ASSERT_THAT_JS_OPCODE_IDS_ARE_VALID);
 166         FOR_EACH_OPCODE_ID(VERIFY_OPCODE_ID);
 167     #undef VERIFY_OPCODE_ID
 168
 169 #if HAVE(COMPUTED_GOTO)
 170     typedef void* Opcode;
 171 #else
 172     typedef OpcodeID Opcode;
 173 #endif
 174
 175 #if ENABLE(SAMPLING_TOOL) || DUMP_OPCODE_STATS
 176
 177 #define PADDING_STRING "                                "
 178 #define PADDING_STRING_LENGTH static_cast<unsigned>(strlen(PADDING_STRING))
 179
 180     extern const char* const opcodeNames[];
 181
 182     inline const char* padOpcodeName(OpcodeID op, unsigned width)
 183     {
 184         unsigned pad = width - strlen(opcodeNames[op]);
 185         pad = std::min(pad, PADDING_STRING_LENGTH);
 186         return PADDING_STRING + PADDING_STRING_LENGTH - pad;
 187     }
 188
 189 #undef PADDING_STRING_LENGTH
 190 #undef PADDING_STRING
 191
 192 #endif
 193
 194 #if DUMP_OPCODE_STATS
 195
 196     struct OpcodeStats {
 197         OpcodeStats();
 198         ~OpcodeStats();
 199         static long long opcodeCounts[numOpcodeIDs];
 200         static long long opcodePairCounts[numOpcodeIDs][numOpcodeIDs];
 201         static int lastOpcode;
 202
 203         static void recordInstruction(int opcode);
 204         static void resetLastInstruction();
 205     };
 206
 207 #endif
 208
 209 } // namespace JSC
 210
 211 #endif // Opcodes_h