deps/v8/src/builtins.h

   1 // Copyright 2011 the V8 project authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef V8_BUILTINS_H_
   6 #define V8_BUILTINS_H_
   7
   8 namespace v8 {
   9 namespace internal {
  10
  11 // Specifies extra arguments required by a C++ builtin.
  12 enum BuiltinExtraArguments {
  13   NO_EXTRA_ARGUMENTS = 0,
  14   NEEDS_CALLED_FUNCTION = 1
  15 };
  16
  17
  18 #define CODE_AGE_LIST_WITH_ARG(V, A)     \
  19   V(Quadragenarian, A)                   \
  20   V(Quinquagenarian, A)                  \
  21   V(Sexagenarian, A)                     \
  22   V(Septuagenarian, A)                   \
  23   V(Octogenarian, A)
  24
  25 #define CODE_AGE_LIST_IGNORE_ARG(X, V) V(X)
  26
  27 #define CODE_AGE_LIST(V) \
  28   CODE_AGE_LIST_WITH_ARG(CODE_AGE_LIST_IGNORE_ARG, V)
  29
  30 #define CODE_AGE_LIST_COMPLETE(V)                  \
  31   V(NotExecuted)                                   \
  32   V(ExecutedOnce)                                  \
  33   V(NoAge)                                         \
  34   CODE_AGE_LIST_WITH_ARG(CODE_AGE_LIST_IGNORE_ARG, V)
  35
  36 #define DECLARE_CODE_AGE_BUILTIN(C, V)             \
  37   V(Make##C##CodeYoungAgainOddMarking, BUILTIN,    \
  38     UNINITIALIZED, kNoExtraICState)                \
  39   V(Make##C##CodeYoungAgainEvenMarking, BUILTIN,   \
  40     UNINITIALIZED, kNoExtraICState)
  41
  42
  43 // Define list of builtins implemented in C++.
  44 #define BUILTIN_LIST_C(V)                                           \
  45   V(Illegal, NO_EXTRA_ARGUMENTS)                                    \
  46                                                                     \
  47   V(EmptyFunction, NO_EXTRA_ARGUMENTS)                              \
  48                                                                     \
  49   V(ArrayPush, NO_EXTRA_ARGUMENTS)                                  \
  50   V(ArrayPop, NO_EXTRA_ARGUMENTS)                                   \
  51   V(ArrayShift, NO_EXTRA_ARGUMENTS)                                 \
  52   V(ArrayUnshift, NO_EXTRA_ARGUMENTS)                               \
  53   V(ArraySlice, NO_EXTRA_ARGUMENTS)                                 \
  54   V(ArraySplice, NO_EXTRA_ARGUMENTS)                                \
  55   V(ArrayConcat, NO_EXTRA_ARGUMENTS)                                \
  56                                                                     \
  57   V(HandleApiCall, NEEDS_CALLED_FUNCTION)                           \
  58   V(HandleApiCallConstruct, NEEDS_CALLED_FUNCTION)                  \
  59   V(HandleApiCallAsFunction, NO_EXTRA_ARGUMENTS)                    \
  60   V(HandleApiCallAsConstructor, NO_EXTRA_ARGUMENTS)                 \
  61                                                                     \
  62   V(StrictModePoisonPill, NO_EXTRA_ARGUMENTS)                       \
  63   V(GeneratorPoisonPill, NO_EXTRA_ARGUMENTS)
  64
  65 // Define list of builtins implemented in assembly.
  66 #define BUILTIN_LIST_A(V)                                                      \
  67   V(ArgumentsAdaptorTrampoline, BUILTIN, UNINITIALIZED, kNoExtraICState)       \
  68   V(InOptimizationQueue, BUILTIN, UNINITIALIZED, kNoExtraICState)              \
  69   V(JSConstructStubGeneric, BUILTIN, UNINITIALIZED, kNoExtraICState)           \
  70   V(JSConstructStubForDerived, BUILTIN, UNINITIALIZED, kNoExtraICState)        \
  71   V(JSConstructStubApi, BUILTIN, UNINITIALIZED, kNoExtraICState)               \
  72   V(JSEntryTrampoline, BUILTIN, UNINITIALIZED, kNoExtraICState)                \
  73   V(JSConstructEntryTrampoline, BUILTIN, UNINITIALIZED, kNoExtraICState)       \
  74   V(CompileLazy, BUILTIN, UNINITIALIZED, kNoExtraICState)                      \
  75   V(CompileOptimized, BUILTIN, UNINITIALIZED, kNoExtraICState)                 \
  76   V(CompileOptimizedConcurrent, BUILTIN, UNINITIALIZED, kNoExtraICState)       \
  77   V(NotifyDeoptimized, BUILTIN, UNINITIALIZED, kNoExtraICState)                \
  78   V(NotifySoftDeoptimized, BUILTIN, UNINITIALIZED, kNoExtraICState)            \
  79   V(NotifyLazyDeoptimized, BUILTIN, UNINITIALIZED, kNoExtraICState)            \
  80   V(NotifyStubFailure, BUILTIN, UNINITIALIZED, kNoExtraICState)                \
  81   V(NotifyStubFailureSaveDoubles, BUILTIN, UNINITIALIZED, kNoExtraICState)     \
  82                                                                                \
  83   V(LoadIC_Miss, BUILTIN, UNINITIALIZED, kNoExtraICState)                      \
  84   V(KeyedLoadIC_Miss, BUILTIN, UNINITIALIZED, kNoExtraICState)                 \
  85   V(StoreIC_Miss, BUILTIN, UNINITIALIZED, kNoExtraICState)                     \
  86   V(KeyedStoreIC_Miss, BUILTIN, UNINITIALIZED, kNoExtraICState)                \
  87   V(LoadIC_Getter_ForDeopt, LOAD_IC, MONOMORPHIC, kNoExtraICState)             \
  88   V(KeyedLoadIC_Initialize, KEYED_LOAD_IC, UNINITIALIZED, kNoExtraICState)     \
  89   V(KeyedLoadIC_PreMonomorphic, KEYED_LOAD_IC, PREMONOMORPHIC,                 \
  90     kNoExtraICState)                                                           \
  91   V(KeyedLoadIC_Megamorphic, KEYED_LOAD_IC, MEGAMORPHIC, kNoExtraICState)      \
  92                                                                                \
  93   V(StoreIC_Setter_ForDeopt, STORE_IC, MONOMORPHIC, StoreIC::kStrictModeState) \
  94                                                                                \
  95   V(KeyedStoreIC_Initialize, KEYED_STORE_IC, UNINITIALIZED, kNoExtraICState)   \
  96   V(KeyedStoreIC_PreMonomorphic, KEYED_STORE_IC, PREMONOMORPHIC,               \
  97     kNoExtraICState)                                                           \
  98   V(KeyedStoreIC_Megamorphic, KEYED_STORE_IC, MEGAMORPHIC, kNoExtraICState)    \
  99                                                                                \
 100   V(KeyedStoreIC_Initialize_Strict, KEYED_STORE_IC, UNINITIALIZED,             \
 101     StoreIC::kStrictModeState)                                                 \
 102   V(KeyedStoreIC_PreMonomorphic_Strict, KEYED_STORE_IC, PREMONOMORPHIC,        \
 103     StoreIC::kStrictModeState)                                                 \
 104   V(KeyedStoreIC_Megamorphic_Strict, KEYED_STORE_IC, MEGAMORPHIC,              \
 105     StoreIC::kStrictModeState)                                                 \
 106   V(KeyedStoreIC_SloppyArguments, KEYED_STORE_IC, MONOMORPHIC,                 \
 107     kNoExtraICState)                                                           \
 108                                                                                \
 109   /* Uses KeyedLoadIC_Initialize; must be after in list. */                    \
 110   V(FunctionCall, BUILTIN, UNINITIALIZED, kNoExtraICState)                     \
 111   V(FunctionApply, BUILTIN, UNINITIALIZED, kNoExtraICState)                    \
 112   V(ReflectApply, BUILTIN, UNINITIALIZED, kNoExtraICState)                     \
 113   V(ReflectConstruct, BUILTIN, UNINITIALIZED, kNoExtraICState)                 \
 114                                                                                \
 115   V(InternalArrayCode, BUILTIN, UNINITIALIZED, kNoExtraICState)                \
 116   V(ArrayCode, BUILTIN, UNINITIALIZED, kNoExtraICState)                        \
 117                                                                                \
 118   V(StringConstructCode, BUILTIN, UNINITIALIZED, kNoExtraICState)              \
 119                                                                                \
 120   V(OnStackReplacement, BUILTIN, UNINITIALIZED, kNoExtraICState)               \
 121   V(InterruptCheck, BUILTIN, UNINITIALIZED, kNoExtraICState)                   \
 122   V(OsrAfterStackCheck, BUILTIN, UNINITIALIZED, kNoExtraICState)               \
 123   V(StackCheck, BUILTIN, UNINITIALIZED, kNoExtraICState)                       \
 124                                                                                \
 125   V(MarkCodeAsExecutedOnce, BUILTIN, UNINITIALIZED, kNoExtraICState)           \
 126   V(MarkCodeAsExecutedTwice, BUILTIN, UNINITIALIZED, kNoExtraICState)          \
 127   CODE_AGE_LIST_WITH_ARG(DECLARE_CODE_AGE_BUILTIN, V)
 128
 129 // Define list of builtin handlers implemented in assembly.
 130 #define BUILTIN_LIST_H(V)                                               \
 131   V(LoadIC_Slow,                    LOAD_IC)                            \
 132   V(KeyedLoadIC_Slow,               KEYED_LOAD_IC)                      \
 133   V(StoreIC_Slow,                   STORE_IC)                           \
 134   V(KeyedStoreIC_Slow,              KEYED_STORE_IC)                     \
 135   V(LoadIC_Normal,                  LOAD_IC)                            \
 136   V(StoreIC_Normal,                 STORE_IC)
 137
 138 // Define list of builtins used by the debugger implemented in assembly.
 139 #define BUILTIN_LIST_DEBUG_A(V)                                               \
 140   V(Return_DebugBreak,                         BUILTIN, DEBUG_STUB,           \
 141                                                DEBUG_BREAK)                   \
 142   V(CallFunctionStub_DebugBreak,               BUILTIN, DEBUG_STUB,           \
 143                                                DEBUG_BREAK)                   \
 144   V(CallConstructStub_DebugBreak,              BUILTIN, DEBUG_STUB,           \
 145                                                DEBUG_BREAK)                   \
 146   V(CallConstructStub_Recording_DebugBreak,    BUILTIN, DEBUG_STUB,           \
 147                                                DEBUG_BREAK)                   \
 148   V(CallICStub_DebugBreak,                     CALL_IC, DEBUG_STUB,           \
 149                                                DEBUG_BREAK)                   \
 150   V(LoadIC_DebugBreak,                         LOAD_IC, DEBUG_STUB,           \
 151                                                DEBUG_BREAK)                   \
 152   V(KeyedLoadIC_DebugBreak,                    KEYED_LOAD_IC, DEBUG_STUB,     \
 153                                                DEBUG_BREAK)                   \
 154   V(StoreIC_DebugBreak,                        STORE_IC, DEBUG_STUB,          \
 155                                                DEBUG_BREAK)                   \
 156   V(KeyedStoreIC_DebugBreak,                   KEYED_STORE_IC, DEBUG_STUB,    \
 157                                                DEBUG_BREAK)                   \
 158   V(CompareNilIC_DebugBreak,                   COMPARE_NIL_IC, DEBUG_STUB,    \
 159                                                DEBUG_BREAK)                   \
 160   V(Slot_DebugBreak,                           BUILTIN, DEBUG_STUB,           \
 161                                                DEBUG_BREAK)                   \
 162   V(PlainReturn_LiveEdit,                      BUILTIN, DEBUG_STUB,           \
 163                                                DEBUG_BREAK)                   \
 164   V(FrameDropper_LiveEdit,                     BUILTIN, DEBUG_STUB,           \
 165                                                DEBUG_BREAK)
 166
 167 // Define list of builtins implemented in JavaScript.
 168 #define BUILTINS_LIST_JS(V)                \
 169   V(EQUALS, 1)                             \
 170   V(STRICT_EQUALS, 1)                      \
 171   V(COMPARE, 2)                            \
 172   V(ADD, 1)                                \
 173   V(SUB, 1)                                \
 174   V(MUL, 1)                                \
 175   V(DIV, 1)                                \
 176   V(MOD, 1)                                \
 177   V(BIT_OR, 1)                             \
 178   V(BIT_AND, 1)                            \
 179   V(BIT_XOR, 1)                            \
 180   V(SHL, 1)                                \
 181   V(SAR, 1)                                \
 182   V(SHR, 1)                                \
 183   V(DELETE, 2)                             \
 184   V(IN, 1)                                 \
 185   V(INSTANCE_OF, 1)                        \
 186   V(FILTER_KEY, 1)                         \
 187   V(CALL_NON_FUNCTION, 0)                  \
 188   V(CALL_NON_FUNCTION_AS_CONSTRUCTOR, 0)   \
 189   V(CALL_FUNCTION_PROXY, 1)                \
 190   V(CALL_FUNCTION_PROXY_AS_CONSTRUCTOR, 1) \
 191   V(TO_OBJECT, 0)                          \
 192   V(TO_NUMBER, 0)                          \
 193   V(TO_STRING, 0)                          \
 194   V(TO_NAME, 0)                            \
 195   V(STRING_ADD_LEFT, 1)                    \
 196   V(STRING_ADD_RIGHT, 1)                   \
 197   V(APPLY_PREPARE, 1)                      \
 198   V(REFLECT_APPLY_PREPARE, 1)              \
 199   V(REFLECT_CONSTRUCT_PREPARE, 2)          \
 200   V(STACK_OVERFLOW, 1)
 201
 202 class BuiltinFunctionTable;
 203 class ObjectVisitor;
 204
 205
 206 class Builtins {
 207  public:
 208   ~Builtins();
 209
 210   // Generate all builtin code objects. Should be called once during
 211   // isolate initialization.
 212   void SetUp(Isolate* isolate, bool create_heap_objects);
 213   void TearDown();
 214
 215   // Garbage collection support.
 216   void IterateBuiltins(ObjectVisitor* v);
 217
 218   // Disassembler support.
 219   const char* Lookup(byte* pc);
 220
 221   enum Name {
 222 #define DEF_ENUM_C(name, ignore) k##name,
 223 #define DEF_ENUM_A(name, kind, state, extra) k##name,
 224 #define DEF_ENUM_H(name, kind) k##name,
 225     BUILTIN_LIST_C(DEF_ENUM_C)
 226     BUILTIN_LIST_A(DEF_ENUM_A)
 227     BUILTIN_LIST_H(DEF_ENUM_H)
 228     BUILTIN_LIST_DEBUG_A(DEF_ENUM_A)
 229 #undef DEF_ENUM_C
 230 #undef DEF_ENUM_A
 231     builtin_count
 232   };
 233
 234   enum CFunctionId {
 235 #define DEF_ENUM_C(name, ignore) c_##name,
 236     BUILTIN_LIST_C(DEF_ENUM_C)
 237 #undef DEF_ENUM_C
 238     cfunction_count
 239   };
 240
 241   enum JavaScript {
 242 #define DEF_ENUM(name, ignore) name,
 243     BUILTINS_LIST_JS(DEF_ENUM)
 244 #undef DEF_ENUM
 245     id_count
 246   };
 247
 248 #define DECLARE_BUILTIN_ACCESSOR_C(name, ignore) Handle<Code> name();
 249 #define DECLARE_BUILTIN_ACCESSOR_A(name, kind, state, extra) \
 250   Handle<Code> name();
 251 #define DECLARE_BUILTIN_ACCESSOR_H(name, kind) Handle<Code> name();
 252   BUILTIN_LIST_C(DECLARE_BUILTIN_ACCESSOR_C)
 253   BUILTIN_LIST_A(DECLARE_BUILTIN_ACCESSOR_A)
 254   BUILTIN_LIST_H(DECLARE_BUILTIN_ACCESSOR_H)
 255   BUILTIN_LIST_DEBUG_A(DECLARE_BUILTIN_ACCESSOR_A)
 256 #undef DECLARE_BUILTIN_ACCESSOR_C
 257 #undef DECLARE_BUILTIN_ACCESSOR_A
 258
 259   Code* builtin(Name name) {
 260     // Code::cast cannot be used here since we access builtins
 261     // during the marking phase of mark sweep. See IC::Clear.
 262     return reinterpret_cast<Code*>(builtins_[name]);
 263   }
 264
 265   Address builtin_address(Name name) {
 266     return reinterpret_cast<Address>(&builtins_[name]);
 267   }
 268
 269   static Address c_function_address(CFunctionId id) {
 270     return c_functions_[id];
 271   }
 272
 273   static const char* GetName(JavaScript id) { return javascript_names_[id]; }
 274   const char* name(int index) {
 275     DCHECK(index >= 0);
 276     DCHECK(index < builtin_count);
 277     return names_[index];
 278   }
 279   static int GetArgumentsCount(JavaScript id) { return javascript_argc_[id]; }
 280   static int NumberOfJavaScriptBuiltins() { return id_count; }
 281
 282   bool is_initialized() const { return initialized_; }
 283
 284   MUST_USE_RESULT static MaybeHandle<Object> InvokeApiFunction(
 285       Handle<JSFunction> function, Handle<Object> receiver, int argc,
 286       Handle<Object> args[]);
 287
 288  private:
 289   Builtins();
 290
 291   // The external C++ functions called from the code.
 292   static Address const c_functions_[cfunction_count];
 293
 294   // Note: These are always Code objects, but to conform with
 295   // IterateBuiltins() above which assumes Object**'s for the callback
 296   // function f, we use an Object* array here.
 297   Object* builtins_[builtin_count];
 298   const char* names_[builtin_count];
 299   static const char* const javascript_names_[id_count];
 300   static int const javascript_argc_[id_count];
 301
 302   static void Generate_Adaptor(MacroAssembler* masm,
 303                                CFunctionId id,
 304                                BuiltinExtraArguments extra_args);
 305   static void Generate_CompileLazy(MacroAssembler* masm);
 306   static void Generate_InOptimizationQueue(MacroAssembler* masm);
 307   static void Generate_CompileOptimized(MacroAssembler* masm);
 308   static void Generate_CompileOptimizedConcurrent(MacroAssembler* masm);
 309   static void Generate_JSConstructStubGeneric(MacroAssembler* masm);
 310   static void Generate_JSConstructStubForDerived(MacroAssembler* masm);
 311   static void Generate_JSConstructStubApi(MacroAssembler* masm);
 312   static void Generate_JSEntryTrampoline(MacroAssembler* masm);
 313   static void Generate_JSConstructEntryTrampoline(MacroAssembler* masm);
 314   static void Generate_NotifyDeoptimized(MacroAssembler* masm);
 315   static void Generate_NotifySoftDeoptimized(MacroAssembler* masm);
 316   static void Generate_NotifyLazyDeoptimized(MacroAssembler* masm);
 317   static void Generate_NotifyStubFailure(MacroAssembler* masm);
 318   static void Generate_NotifyStubFailureSaveDoubles(MacroAssembler* masm);
 319   static void Generate_ArgumentsAdaptorTrampoline(MacroAssembler* masm);
 320
 321   static void Generate_FunctionCall(MacroAssembler* masm);
 322   static void Generate_FunctionApply(MacroAssembler* masm);
 323   static void Generate_ReflectApply(MacroAssembler* masm);
 324   static void Generate_ReflectConstruct(MacroAssembler* masm);
 325
 326   static void Generate_InternalArrayCode(MacroAssembler* masm);
 327   static void Generate_ArrayCode(MacroAssembler* masm);
 328
 329   static void Generate_StringConstructCode(MacroAssembler* masm);
 330   static void Generate_OnStackReplacement(MacroAssembler* masm);
 331   static void Generate_OsrAfterStackCheck(MacroAssembler* masm);
 332   static void Generate_InterruptCheck(MacroAssembler* masm);
 333   static void Generate_StackCheck(MacroAssembler* masm);
 334
 335 #define DECLARE_CODE_AGE_BUILTIN_GENERATOR(C)                \
 336   static void Generate_Make##C##CodeYoungAgainEvenMarking(   \
 337       MacroAssembler* masm);                                 \
 338   static void Generate_Make##C##CodeYoungAgainOddMarking(    \
 339       MacroAssembler* masm);
 340   CODE_AGE_LIST(DECLARE_CODE_AGE_BUILTIN_GENERATOR)
 341 #undef DECLARE_CODE_AGE_BUILTIN_GENERATOR
 342
 343   static void Generate_MarkCodeAsExecutedOnce(MacroAssembler* masm);
 344   static void Generate_MarkCodeAsExecutedTwice(MacroAssembler* masm);
 345
 346   static void InitBuiltinFunctionTable();
 347
 348   bool initialized_;
 349
 350   friend class BuiltinFunctionTable;
 351   friend class Isolate;
 352
 353   DISALLOW_COPY_AND_ASSIGN(Builtins);
 354 };
 355
 356 } }  // namespace v8::internal
 357
 358 #endif  // V8_BUILTINS_H_