src/3rdparty/v8/src/builtins.h

   1 // Copyright 2011 the V8 project authors. All rights reserved.
   2 // Redistribution and use in source and binary forms, with or without
   3 // modification, are permitted provided that the following conditions are
   4 // met:
   5 //
   6 //     * Redistributions of source code must retain the above copyright
   7 //       notice, this list of conditions and the following disclaimer.
   8 //     * Redistributions in binary form must reproduce the above
   9 //       copyright notice, this list of conditions and the following
  10 //       disclaimer in the documentation and/or other materials provided
  11 //       with the distribution.
  12 //     * Neither the name of Google Inc. nor the names of its
  13 //       contributors may be used to endorse or promote products derived
  14 //       from this software without specific prior written permission.
  15 //
  16 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  17 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  18 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  19 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  20 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  21 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  22 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  26 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27
  28 #ifndef V8_BUILTINS_H_
  29 #define V8_BUILTINS_H_
  30
  31 namespace v8 {
  32 namespace internal {
  33
  34 // Specifies extra arguments required by a C++ builtin.
  35 enum BuiltinExtraArguments {
  36   NO_EXTRA_ARGUMENTS = 0,
  37   NEEDS_CALLED_FUNCTION = 1
  38 };
  39
  40
  41 // Define list of builtins implemented in C++.
  42 #define BUILTIN_LIST_C(V)                                           \
  43   V(Illegal, NO_EXTRA_ARGUMENTS)                                    \
  44                                                                     \
  45   V(EmptyFunction, NO_EXTRA_ARGUMENTS)                              \
  46                                                                     \
  47   V(InternalArrayCodeGeneric, NO_EXTRA_ARGUMENTS)                   \
  48   V(ArrayCodeGeneric, NO_EXTRA_ARGUMENTS)                           \
  49                                                                     \
  50   V(ArrayPush, NO_EXTRA_ARGUMENTS)                                  \
  51   V(ArrayPop, NO_EXTRA_ARGUMENTS)                                   \
  52   V(ArrayShift, NO_EXTRA_ARGUMENTS)                                 \
  53   V(ArrayUnshift, NO_EXTRA_ARGUMENTS)                               \
  54   V(ArraySlice, NO_EXTRA_ARGUMENTS)                                 \
  55   V(ArraySplice, NO_EXTRA_ARGUMENTS)                                \
  56   V(ArrayConcat, NO_EXTRA_ARGUMENTS)                                \
  57                                                                     \
  58   V(HandleApiCall, NEEDS_CALLED_FUNCTION)                           \
  59   V(HandleApiCallConstruct, NEEDS_CALLED_FUNCTION)                  \
  60   V(HandleApiCallAsFunction, NO_EXTRA_ARGUMENTS)                    \
  61   V(HandleApiCallAsConstructor, NO_EXTRA_ARGUMENTS)                 \
  62                                                                     \
  63   V(StrictModePoisonPill, NO_EXTRA_ARGUMENTS)
  64
  65 // Define list of builtins implemented in assembly.
  66 #define BUILTIN_LIST_A(V)                                               \
  67   V(ArgumentsAdaptorTrampoline,     BUILTIN, UNINITIALIZED,             \
  68                                     Code::kNoExtraICState)              \
  69   V(JSConstructStubCountdown,       BUILTIN, UNINITIALIZED,             \
  70                                     Code::kNoExtraICState)              \
  71   V(JSConstructStubGeneric,         BUILTIN, UNINITIALIZED,             \
  72                                     Code::kNoExtraICState)              \
  73   V(JSConstructStubApi,             BUILTIN, UNINITIALIZED,             \
  74                                     Code::kNoExtraICState)              \
  75   V(JSEntryTrampoline,              BUILTIN, UNINITIALIZED,             \
  76                                     Code::kNoExtraICState)              \
  77   V(JSConstructEntryTrampoline,     BUILTIN, UNINITIALIZED,             \
  78                                     Code::kNoExtraICState)              \
  79   V(LazyCompile,                    BUILTIN, UNINITIALIZED,             \
  80                                     Code::kNoExtraICState)              \
  81   V(LazyRecompile,                  BUILTIN, UNINITIALIZED,             \
  82                                     Code::kNoExtraICState)              \
  83   V(NotifyDeoptimized,              BUILTIN, UNINITIALIZED,             \
  84                                     Code::kNoExtraICState)              \
  85   V(NotifyLazyDeoptimized,          BUILTIN, UNINITIALIZED,             \
  86                                     Code::kNoExtraICState)              \
  87   V(NotifyOSR,                      BUILTIN, UNINITIALIZED,             \
  88                                     Code::kNoExtraICState)              \
  89                                                                         \
  90   V(LoadIC_Miss,                    BUILTIN, UNINITIALIZED,             \
  91                                     Code::kNoExtraICState)              \
  92   V(KeyedLoadIC_Miss,               BUILTIN, UNINITIALIZED,             \
  93                                     Code::kNoExtraICState)              \
  94   V(KeyedLoadIC_MissForceGeneric,   BUILTIN, UNINITIALIZED,             \
  95                                     Code::kNoExtraICState)              \
  96   V(KeyedLoadIC_Slow,               BUILTIN, UNINITIALIZED,             \
  97                                     Code::kNoExtraICState)              \
  98   V(StoreIC_Miss,                   BUILTIN, UNINITIALIZED,             \
  99                                     Code::kNoExtraICState)              \
 100   V(KeyedStoreIC_Miss,              BUILTIN, UNINITIALIZED,             \
 101                                     Code::kNoExtraICState)              \
 102   V(KeyedStoreIC_MissForceGeneric,  BUILTIN, UNINITIALIZED,             \
 103                                     Code::kNoExtraICState)              \
 104   V(KeyedStoreIC_Slow,              BUILTIN, UNINITIALIZED,             \
 105                                     Code::kNoExtraICState)              \
 106   V(LoadIC_Initialize,              LOAD_IC, UNINITIALIZED,             \
 107                                     Code::kNoExtraICState)              \
 108   V(LoadIC_PreMonomorphic,          LOAD_IC, PREMONOMORPHIC,            \
 109                                     Code::kNoExtraICState)              \
 110   V(LoadIC_Normal,                  LOAD_IC, MONOMORPHIC,               \
 111                                     Code::kNoExtraICState)              \
 112   V(LoadIC_ArrayLength,             LOAD_IC, MONOMORPHIC,               \
 113                                     Code::kNoExtraICState)              \
 114   V(LoadIC_StringLength,            LOAD_IC, MONOMORPHIC,               \
 115                                     Code::kNoExtraICState)              \
 116   V(LoadIC_StringWrapperLength,     LOAD_IC, MONOMORPHIC,               \
 117                                     Code::kNoExtraICState)              \
 118   V(LoadIC_FunctionPrototype,       LOAD_IC, MONOMORPHIC,               \
 119                                     Code::kNoExtraICState)              \
 120   V(LoadIC_Megamorphic,             LOAD_IC, MEGAMORPHIC,               \
 121                                     Code::kNoExtraICState)              \
 122                                                                         \
 123   V(KeyedLoadIC_Initialize,         KEYED_LOAD_IC, UNINITIALIZED,       \
 124                                     Code::kNoExtraICState)              \
 125   V(KeyedLoadIC_PreMonomorphic,     KEYED_LOAD_IC, PREMONOMORPHIC,      \
 126                                     Code::kNoExtraICState)              \
 127   V(KeyedLoadIC_Generic,            KEYED_LOAD_IC, MEGAMORPHIC,         \
 128                                     Code::kNoExtraICState)              \
 129   V(KeyedLoadIC_String,             KEYED_LOAD_IC, MEGAMORPHIC,         \
 130                                     Code::kNoExtraICState)              \
 131   V(KeyedLoadIC_IndexedInterceptor, KEYED_LOAD_IC, MEGAMORPHIC,         \
 132                                     Code::kNoExtraICState)              \
 133   V(KeyedLoadIC_NonStrictArguments, KEYED_LOAD_IC, MEGAMORPHIC,         \
 134                                     Code::kNoExtraICState)              \
 135                                                                         \
 136   V(StoreIC_Initialize,             STORE_IC, UNINITIALIZED,            \
 137                                     Code::kNoExtraICState)              \
 138   V(StoreIC_ArrayLength,            STORE_IC, MONOMORPHIC,              \
 139                                     Code::kNoExtraICState)              \
 140   V(StoreIC_Normal,                 STORE_IC, MONOMORPHIC,              \
 141                                     Code::kNoExtraICState)              \
 142   V(StoreIC_Megamorphic,            STORE_IC, MEGAMORPHIC,              \
 143                                     Code::kNoExtraICState)              \
 144   V(StoreIC_GlobalProxy,            STORE_IC, MEGAMORPHIC,              \
 145                                     Code::kNoExtraICState)              \
 146   V(StoreIC_Initialize_Strict,      STORE_IC, UNINITIALIZED,            \
 147                                     kStrictMode)                        \
 148   V(StoreIC_ArrayLength_Strict,     STORE_IC, MONOMORPHIC,              \
 149                                     kStrictMode)                        \
 150   V(StoreIC_Normal_Strict,          STORE_IC, MONOMORPHIC,              \
 151                                     kStrictMode)                        \
 152   V(StoreIC_Megamorphic_Strict,     STORE_IC, MEGAMORPHIC,              \
 153                                     kStrictMode)                        \
 154   V(StoreIC_GlobalProxy_Strict,     STORE_IC, MEGAMORPHIC,              \
 155                                     kStrictMode)                        \
 156                                                                         \
 157   V(KeyedStoreIC_Initialize,        KEYED_STORE_IC, UNINITIALIZED,      \
 158                                     Code::kNoExtraICState)              \
 159   V(KeyedStoreIC_Generic,           KEYED_STORE_IC, MEGAMORPHIC,        \
 160                                     Code::kNoExtraICState)              \
 161                                                                         \
 162   V(KeyedStoreIC_Initialize_Strict, KEYED_STORE_IC, UNINITIALIZED,      \
 163                                     kStrictMode)                        \
 164   V(KeyedStoreIC_Generic_Strict,    KEYED_STORE_IC, MEGAMORPHIC,        \
 165                                     kStrictMode)                        \
 166   V(KeyedStoreIC_NonStrictArguments, KEYED_STORE_IC, MEGAMORPHIC,       \
 167                                      Code::kNoExtraICState)             \
 168   V(TransitionElementsSmiToDouble,  BUILTIN, UNINITIALIZED,             \
 169                                     Code::kNoExtraICState)              \
 170   V(TransitionElementsDoubleToObject, BUILTIN, UNINITIALIZED,           \
 171                                       Code::kNoExtraICState)            \
 172                                                                         \
 173   /* Uses KeyedLoadIC_Initialize; must be after in list. */             \
 174   V(FunctionCall,                   BUILTIN, UNINITIALIZED,             \
 175                                     Code::kNoExtraICState)              \
 176   V(FunctionApply,                  BUILTIN, UNINITIALIZED,             \
 177                                     Code::kNoExtraICState)              \
 178                                                                         \
 179   V(InternalArrayCode,              BUILTIN, UNINITIALIZED,             \
 180                                     Code::kNoExtraICState)              \
 181   V(ArrayCode,                      BUILTIN, UNINITIALIZED,             \
 182                                     Code::kNoExtraICState)              \
 183   V(ArrayConstructCode,             BUILTIN, UNINITIALIZED,             \
 184                                     Code::kNoExtraICState)              \
 185                                                                         \
 186   V(StringConstructCode,            BUILTIN, UNINITIALIZED,             \
 187                                     Code::kNoExtraICState)              \
 188                                                                         \
 189   V(OnStackReplacement,             BUILTIN, UNINITIALIZED,             \
 190                                     Code::kNoExtraICState)
 191
 192
 193 #ifdef ENABLE_DEBUGGER_SUPPORT
 194 // Define list of builtins used by the debugger implemented in assembly.
 195 #define BUILTIN_LIST_DEBUG_A(V)                                 \
 196   V(Return_DebugBreak,                         BUILTIN, DEBUG_BREAK,          \
 197                                                Code::kNoExtraICState)         \
 198   V(CallFunctionStub_DebugBreak,               BUILTIN, DEBUG_BREAK,          \
 199                                                Code::kNoExtraICState)         \
 200   V(CallFunctionStub_Recording_DebugBreak,     BUILTIN, DEBUG_BREAK,          \
 201                                                Code::kNoExtraICState)         \
 202   V(CallConstructStub_DebugBreak,              BUILTIN, DEBUG_BREAK,          \
 203                                                Code::kNoExtraICState)         \
 204   V(CallConstructStub_Recording_DebugBreak,    BUILTIN, DEBUG_BREAK,          \
 205                                                Code::kNoExtraICState)         \
 206   V(LoadIC_DebugBreak,                         LOAD_IC, DEBUG_BREAK,          \
 207                                                Code::kNoExtraICState)         \
 208   V(KeyedLoadIC_DebugBreak,                    KEYED_LOAD_IC, DEBUG_BREAK,    \
 209                                                Code::kNoExtraICState)         \
 210   V(StoreIC_DebugBreak,                        STORE_IC, DEBUG_BREAK,         \
 211                                                Code::kNoExtraICState)         \
 212   V(KeyedStoreIC_DebugBreak,                   KEYED_STORE_IC, DEBUG_BREAK,   \
 213                                                Code::kNoExtraICState)         \
 214   V(Slot_DebugBreak,                           BUILTIN, DEBUG_BREAK,          \
 215                                                Code::kNoExtraICState)         \
 216   V(PlainReturn_LiveEdit,                      BUILTIN, DEBUG_BREAK,          \
 217                                                Code::kNoExtraICState)         \
 218   V(FrameDropper_LiveEdit,                     BUILTIN, DEBUG_BREAK,          \
 219                                                Code::kNoExtraICState)
 220 #else
 221 #define BUILTIN_LIST_DEBUG_A(V)
 222 #endif
 223
 224 // Define list of builtins implemented in JavaScript.
 225 #define BUILTINS_LIST_JS(V)              \
 226   V(EQUALS, 1)                           \
 227   V(STRICT_EQUALS, 1)                    \
 228   V(COMPARE, 2)                          \
 229   V(ADD, 1)                              \
 230   V(SUB, 1)                              \
 231   V(MUL, 1)                              \
 232   V(DIV, 1)                              \
 233   V(MOD, 1)                              \
 234   V(BIT_OR, 1)                           \
 235   V(BIT_AND, 1)                          \
 236   V(BIT_XOR, 1)                          \
 237   V(UNARY_MINUS, 0)                      \
 238   V(BIT_NOT, 0)                          \
 239   V(SHL, 1)                              \
 240   V(SAR, 1)                              \
 241   V(SHR, 1)                              \
 242   V(DELETE, 2)                           \
 243   V(IN, 1)                               \
 244   V(INSTANCE_OF, 1)                      \
 245   V(FILTER_KEY, 1)                       \
 246   V(CALL_NON_FUNCTION, 0)                \
 247   V(CALL_NON_FUNCTION_AS_CONSTRUCTOR, 0) \
 248   V(CALL_FUNCTION_PROXY, 1)                \
 249   V(CALL_FUNCTION_PROXY_AS_CONSTRUCTOR, 1) \
 250   V(TO_OBJECT, 0)                        \
 251   V(TO_NUMBER, 0)                        \
 252   V(TO_STRING, 0)                        \
 253   V(STRING_ADD_LEFT, 1)                  \
 254   V(STRING_ADD_RIGHT, 1)                 \
 255   V(APPLY_PREPARE, 1)                    \
 256   V(APPLY_OVERFLOW, 1)
 257
 258
 259 class BuiltinFunctionTable;
 260 class ObjectVisitor;
 261
 262
 263 class Builtins {
 264  public:
 265   ~Builtins();
 266
 267   // Generate all builtin code objects. Should be called once during
 268   // isolate initialization.
 269   void SetUp(bool create_heap_objects);
 270   void TearDown();
 271
 272   // Garbage collection support.
 273   void IterateBuiltins(ObjectVisitor* v);
 274
 275   // Disassembler support.
 276   const char* Lookup(byte* pc);
 277
 278   enum Name {
 279 #define DEF_ENUM_C(name, ignore) k##name,
 280 #define DEF_ENUM_A(name, kind, state, extra) k##name,
 281     BUILTIN_LIST_C(DEF_ENUM_C)
 282     BUILTIN_LIST_A(DEF_ENUM_A)
 283     BUILTIN_LIST_DEBUG_A(DEF_ENUM_A)
 284 #undef DEF_ENUM_C
 285 #undef DEF_ENUM_A
 286     builtin_count
 287   };
 288
 289   enum CFunctionId {
 290 #define DEF_ENUM_C(name, ignore) c_##name,
 291     BUILTIN_LIST_C(DEF_ENUM_C)
 292 #undef DEF_ENUM_C
 293     cfunction_count
 294   };
 295
 296   enum JavaScript {
 297 #define DEF_ENUM(name, ignore) name,
 298     BUILTINS_LIST_JS(DEF_ENUM)
 299 #undef DEF_ENUM
 300     id_count
 301   };
 302
 303 #define DECLARE_BUILTIN_ACCESSOR_C(name, ignore) Handle<Code> name();
 304 #define DECLARE_BUILTIN_ACCESSOR_A(name, kind, state, extra) \
 305   Handle<Code> name();
 306   BUILTIN_LIST_C(DECLARE_BUILTIN_ACCESSOR_C)
 307   BUILTIN_LIST_A(DECLARE_BUILTIN_ACCESSOR_A)
 308   BUILTIN_LIST_DEBUG_A(DECLARE_BUILTIN_ACCESSOR_A)
 309 #undef DECLARE_BUILTIN_ACCESSOR_C
 310 #undef DECLARE_BUILTIN_ACCESSOR_A
 311
 312   Code* builtin(Name name) {
 313     // Code::cast cannot be used here since we access builtins
 314     // during the marking phase of mark sweep. See IC::Clear.
 315     return reinterpret_cast<Code*>(builtins_[name]);
 316   }
 317
 318   Address builtin_address(Name name) {
 319     return reinterpret_cast<Address>(&builtins_[name]);
 320   }
 321
 322   static Address c_function_address(CFunctionId id) {
 323     return c_functions_[id];
 324   }
 325
 326   static const char* GetName(JavaScript id) { return javascript_names_[id]; }
 327   static int GetArgumentsCount(JavaScript id) { return javascript_argc_[id]; }
 328   Handle<Code> GetCode(JavaScript id, bool* resolved);
 329   static int NumberOfJavaScriptBuiltins() { return id_count; }
 330
 331   bool is_initialized() const { return initialized_; }
 332
 333  private:
 334   Builtins();
 335
 336   // The external C++ functions called from the code.
 337   static Address const c_functions_[cfunction_count];
 338
 339   // Note: These are always Code objects, but to conform with
 340   // IterateBuiltins() above which assumes Object**'s for the callback
 341   // function f, we use an Object* array here.
 342   Object* builtins_[builtin_count];
 343   const char* names_[builtin_count];
 344   static const char* const javascript_names_[id_count];
 345   static int const javascript_argc_[id_count];
 346
 347   static void Generate_Adaptor(MacroAssembler* masm,
 348                                CFunctionId id,
 349                                BuiltinExtraArguments extra_args);
 350   static void Generate_JSConstructStubCountdown(MacroAssembler* masm);
 351   static void Generate_JSConstructStubGeneric(MacroAssembler* masm);
 352   static void Generate_JSConstructStubApi(MacroAssembler* masm);
 353   static void Generate_JSEntryTrampoline(MacroAssembler* masm);
 354   static void Generate_JSConstructEntryTrampoline(MacroAssembler* masm);
 355   static void Generate_LazyCompile(MacroAssembler* masm);
 356   static void Generate_LazyRecompile(MacroAssembler* masm);
 357   static void Generate_NotifyDeoptimized(MacroAssembler* masm);
 358   static void Generate_NotifyLazyDeoptimized(MacroAssembler* masm);
 359   static void Generate_NotifyOSR(MacroAssembler* masm);
 360   static void Generate_ArgumentsAdaptorTrampoline(MacroAssembler* masm);
 361
 362   static void Generate_FunctionCall(MacroAssembler* masm);
 363   static void Generate_FunctionApply(MacroAssembler* masm);
 364
 365   static void Generate_InternalArrayCode(MacroAssembler* masm);
 366   static void Generate_ArrayCode(MacroAssembler* masm);
 367   static void Generate_ArrayConstructCode(MacroAssembler* masm);
 368
 369   static void Generate_StringConstructCode(MacroAssembler* masm);
 370   static void Generate_OnStackReplacement(MacroAssembler* masm);
 371
 372   static void InitBuiltinFunctionTable();
 373
 374   bool initialized_;
 375
 376   friend class BuiltinFunctionTable;
 377   friend class Isolate;
 378
 379   DISALLOW_COPY_AND_ASSIGN(Builtins);
 380 };
 381
 382 } }  // namespace v8::internal
 383
 384 #endif  // V8_BUILTINS_H_