src/x87/macro-assembler-x87.h

   1 // Copyright 2012 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_X87_MACRO_ASSEMBLER_X87_H_
   6 #define V8_X87_MACRO_ASSEMBLER_X87_H_
   7
   8 #include "src/assembler.h"
   9 #include "src/frames.h"
  10 #include "src/globals.h"
  11
  12 namespace v8 {
  13 namespace internal {
  14
  15 // Convenience for platform-independent signatures.  We do not normally
  16 // distinguish memory operands from other operands on ia32.
  17 typedef Operand MemOperand;
  18
  19 enum RememberedSetAction { EMIT_REMEMBERED_SET, OMIT_REMEMBERED_SET };
  20 enum SmiCheck { INLINE_SMI_CHECK, OMIT_SMI_CHECK };
  21 enum PointersToHereCheck {
  22   kPointersToHereMaybeInteresting,
  23   kPointersToHereAreAlwaysInteresting
  24 };
  25
  26
  27 enum RegisterValueType {
  28   REGISTER_VALUE_IS_SMI,
  29   REGISTER_VALUE_IS_INT32
  30 };
  31
  32
  33 #ifdef DEBUG
  34 bool AreAliased(Register reg1,
  35                 Register reg2,
  36                 Register reg3 = no_reg,
  37                 Register reg4 = no_reg,
  38                 Register reg5 = no_reg,
  39                 Register reg6 = no_reg,
  40                 Register reg7 = no_reg,
  41                 Register reg8 = no_reg);
  42 #endif
  43
  44
  45 // MacroAssembler implements a collection of frequently used macros.
  46 class MacroAssembler: public Assembler {
  47  public:
  48   // The isolate parameter can be NULL if the macro assembler should
  49   // not use isolate-dependent functionality. In this case, it's the
  50   // responsibility of the caller to never invoke such function on the
  51   // macro assembler.
  52   MacroAssembler(Isolate* isolate, void* buffer, int size);
  53
  54   void Load(Register dst, const Operand& src, Representation r);
  55   void Store(Register src, const Operand& dst, Representation r);
  56
  57   // Operations on roots in the root-array.
  58   void LoadRoot(Register destination, Heap::RootListIndex index);
  59   void StoreRoot(Register source, Register scratch, Heap::RootListIndex index);
  60   void CompareRoot(Register with, Register scratch, Heap::RootListIndex index);
  61   // These methods can only be used with constant roots (i.e. non-writable
  62   // and not in new space).
  63   void CompareRoot(Register with, Heap::RootListIndex index);
  64   void CompareRoot(const Operand& with, Heap::RootListIndex index);
  65
  66   // ---------------------------------------------------------------------------
  67   // GC Support
  68   enum RememberedSetFinalAction {
  69     kReturnAtEnd,
  70     kFallThroughAtEnd
  71   };
  72
  73   // Record in the remembered set the fact that we have a pointer to new space
  74   // at the address pointed to by the addr register.  Only works if addr is not
  75   // in new space.
  76   void RememberedSetHelper(Register object,  // Used for debug code.
  77                            Register addr,
  78                            Register scratch,
  79                            RememberedSetFinalAction and_then);
  80
  81   void CheckPageFlag(Register object,
  82                      Register scratch,
  83                      int mask,
  84                      Condition cc,
  85                      Label* condition_met,
  86                      Label::Distance condition_met_distance = Label::kFar);
  87
  88   void CheckPageFlagForMap(
  89       Handle<Map> map,
  90       int mask,
  91       Condition cc,
  92       Label* condition_met,
  93       Label::Distance condition_met_distance = Label::kFar);
  94
  95   void CheckMapDeprecated(Handle<Map> map,
  96                           Register scratch,
  97                           Label* if_deprecated);
  98
  99   // Check if object is in new space.  Jumps if the object is not in new space.
 100   // The register scratch can be object itself, but scratch will be clobbered.
 101   void JumpIfNotInNewSpace(Register object,
 102                            Register scratch,
 103                            Label* branch,
 104                            Label::Distance distance = Label::kFar) {
 105     InNewSpace(object, scratch, zero, branch, distance);
 106   }
 107
 108   // Check if object is in new space.  Jumps if the object is in new space.
 109   // The register scratch can be object itself, but it will be clobbered.
 110   void JumpIfInNewSpace(Register object,
 111                         Register scratch,
 112                         Label* branch,
 113                         Label::Distance distance = Label::kFar) {
 114     InNewSpace(object, scratch, not_zero, branch, distance);
 115   }
 116
 117   // Check if an object has a given incremental marking color.  Also uses ecx!
 118   void HasColor(Register object,
 119                 Register scratch0,
 120                 Register scratch1,
 121                 Label* has_color,
 122                 Label::Distance has_color_distance,
 123                 int first_bit,
 124                 int second_bit);
 125
 126   void JumpIfBlack(Register object,
 127                    Register scratch0,
 128                    Register scratch1,
 129                    Label* on_black,
 130                    Label::Distance on_black_distance = Label::kFar);
 131
 132   // Checks the color of an object.  If the object is already grey or black
 133   // then we just fall through, since it is already live.  If it is white and
 134   // we can determine that it doesn't need to be scanned, then we just mark it
 135   // black and fall through.  For the rest we jump to the label so the
 136   // incremental marker can fix its assumptions.
 137   void EnsureNotWhite(Register object,
 138                       Register scratch1,
 139                       Register scratch2,
 140                       Label* object_is_white_and_not_data,
 141                       Label::Distance distance);
 142
 143   // Notify the garbage collector that we wrote a pointer into an object.
 144   // |object| is the object being stored into, |value| is the object being
 145   // stored.  value and scratch registers are clobbered by the operation.
 146   // The offset is the offset from the start of the object, not the offset from
 147   // the tagged HeapObject pointer.  For use with FieldOperand(reg, off).
 148   void RecordWriteField(
 149       Register object,
 150       int offset,
 151       Register value,
 152       Register scratch,
 153       RememberedSetAction remembered_set_action = EMIT_REMEMBERED_SET,
 154       SmiCheck smi_check = INLINE_SMI_CHECK,
 155       PointersToHereCheck pointers_to_here_check_for_value =
 156           kPointersToHereMaybeInteresting);
 157
 158   // As above, but the offset has the tag presubtracted.  For use with
 159   // Operand(reg, off).
 160   void RecordWriteContextSlot(
 161       Register context,
 162       int offset,
 163       Register value,
 164       Register scratch,
 165       RememberedSetAction remembered_set_action = EMIT_REMEMBERED_SET,
 166       SmiCheck smi_check = INLINE_SMI_CHECK,
 167       PointersToHereCheck pointers_to_here_check_for_value =
 168           kPointersToHereMaybeInteresting) {
 169     RecordWriteField(context,
 170                      offset + kHeapObjectTag,
 171                      value,
 172                      scratch,
 173                      remembered_set_action,
 174                      smi_check,
 175                      pointers_to_here_check_for_value);
 176   }
 177
 178   // Notify the garbage collector that we wrote a pointer into a fixed array.
 179   // |array| is the array being stored into, |value| is the
 180   // object being stored.  |index| is the array index represented as a
 181   // Smi. All registers are clobbered by the operation RecordWriteArray
 182   // filters out smis so it does not update the write barrier if the
 183   // value is a smi.
 184   void RecordWriteArray(
 185       Register array,
 186       Register value,
 187       Register index,
 188       RememberedSetAction remembered_set_action = EMIT_REMEMBERED_SET,
 189       SmiCheck smi_check = INLINE_SMI_CHECK,
 190       PointersToHereCheck pointers_to_here_check_for_value =
 191           kPointersToHereMaybeInteresting);
 192
 193   // For page containing |object| mark region covering |address|
 194   // dirty. |object| is the object being stored into, |value| is the
 195   // object being stored. The address and value registers are clobbered by the
 196   // operation. RecordWrite filters out smis so it does not update the
 197   // write barrier if the value is a smi.
 198   void RecordWrite(
 199       Register object,
 200       Register address,
 201       Register value,
 202       RememberedSetAction remembered_set_action = EMIT_REMEMBERED_SET,
 203       SmiCheck smi_check = INLINE_SMI_CHECK,
 204       PointersToHereCheck pointers_to_here_check_for_value =
 205           kPointersToHereMaybeInteresting);
 206
 207   // For page containing |object| mark the region covering the object's map
 208   // dirty. |object| is the object being stored into, |map| is the Map object
 209   // that was stored.
 210   void RecordWriteForMap(
 211       Register object,
 212       Handle<Map> map,
 213       Register scratch1,
 214       Register scratch2);
 215
 216   // ---------------------------------------------------------------------------
 217   // Debugger Support
 218
 219   void DebugBreak();
 220
 221   // Generates function and stub prologue code.
 222   void StubPrologue();
 223   void Prologue(bool code_pre_aging);
 224
 225   // Enter specific kind of exit frame. Expects the number of
 226   // arguments in register eax and sets up the number of arguments in
 227   // register edi and the pointer to the first argument in register
 228   // esi.
 229   void EnterExitFrame();
 230
 231   void EnterApiExitFrame(int argc);
 232
 233   // Leave the current exit frame. Expects the return value in
 234   // register eax:edx (untouched) and the pointer to the first
 235   // argument in register esi.
 236   void LeaveExitFrame();
 237
 238   // Leave the current exit frame. Expects the return value in
 239   // register eax (untouched).
 240   void LeaveApiExitFrame(bool restore_context);
 241
 242   // Find the function context up the context chain.
 243   void LoadContext(Register dst, int context_chain_length);
 244
 245   // Conditionally load the cached Array transitioned map of type
 246   // transitioned_kind from the native context if the map in register
 247   // map_in_out is the cached Array map in the native context of
 248   // expected_kind.
 249   void LoadTransitionedArrayMapConditional(
 250       ElementsKind expected_kind,
 251       ElementsKind transitioned_kind,
 252       Register map_in_out,
 253       Register scratch,
 254       Label* no_map_match);
 255
 256   // Load the global function with the given index.
 257   void LoadGlobalFunction(int index, Register function);
 258
 259   // Load the initial map from the global function. The registers
 260   // function and map can be the same.
 261   void LoadGlobalFunctionInitialMap(Register function, Register map);
 262
 263   // Push and pop the registers that can hold pointers.
 264   void PushSafepointRegisters() { pushad(); }
 265   void PopSafepointRegisters() { popad(); }
 266   // Store the value in register/immediate src in the safepoint
 267   // register stack slot for register dst.
 268   void StoreToSafepointRegisterSlot(Register dst, Register src);
 269   void StoreToSafepointRegisterSlot(Register dst, Immediate src);
 270   void LoadFromSafepointRegisterSlot(Register dst, Register src);
 271
 272   void LoadHeapObject(Register result, Handle<HeapObject> object);
 273   void CmpHeapObject(Register reg, Handle<HeapObject> object);
 274   void PushHeapObject(Handle<HeapObject> object);
 275
 276   void LoadObject(Register result, Handle<Object> object) {
 277     AllowDeferredHandleDereference heap_object_check;
 278     if (object->IsHeapObject()) {
 279       LoadHeapObject(result, Handle<HeapObject>::cast(object));
 280     } else {
 281       Move(result, Immediate(object));
 282     }
 283   }
 284
 285   void CmpObject(Register reg, Handle<Object> object) {
 286     AllowDeferredHandleDereference heap_object_check;
 287     if (object->IsHeapObject()) {
 288       CmpHeapObject(reg, Handle<HeapObject>::cast(object));
 289     } else {
 290       cmp(reg, Immediate(object));
 291     }
 292   }
 293
 294   // ---------------------------------------------------------------------------
 295   // JavaScript invokes
 296
 297   // Invoke the JavaScript function code by either calling or jumping.
 298   void InvokeCode(Register code,
 299                   const ParameterCount& expected,
 300                   const ParameterCount& actual,
 301                   InvokeFlag flag,
 302                   const CallWrapper& call_wrapper) {
 303     InvokeCode(Operand(code), expected, actual, flag, call_wrapper);
 304   }
 305
 306   void InvokeCode(const Operand& code,
 307                   const ParameterCount& expected,
 308                   const ParameterCount& actual,
 309                   InvokeFlag flag,
 310                   const CallWrapper& call_wrapper);
 311
 312   // Invoke the JavaScript function in the given register. Changes the
 313   // current context to the context in the function before invoking.
 314   void InvokeFunction(Register function,
 315                       const ParameterCount& actual,
 316                       InvokeFlag flag,
 317                       const CallWrapper& call_wrapper);
 318
 319   void InvokeFunction(Register function,
 320                       const ParameterCount& expected,
 321                       const ParameterCount& actual,
 322                       InvokeFlag flag,
 323                       const CallWrapper& call_wrapper);
 324
 325   void InvokeFunction(Handle<JSFunction> function,
 326                       const ParameterCount& expected,
 327                       const ParameterCount& actual,
 328                       InvokeFlag flag,
 329                       const CallWrapper& call_wrapper);
 330
 331   // Invoke specified builtin JavaScript function. Adds an entry to
 332   // the unresolved list if the name does not resolve.
 333   void InvokeBuiltin(Builtins::JavaScript id,
 334                      InvokeFlag flag,
 335                      const CallWrapper& call_wrapper = NullCallWrapper());
 336
 337   // Store the function for the given builtin in the target register.
 338   void GetBuiltinFunction(Register target, Builtins::JavaScript id);
 339
 340   // Store the code object for the given builtin in the target register.
 341   void GetBuiltinEntry(Register target, Builtins::JavaScript id);
 342
 343   // Expression support
 344   // Support for constant splitting.
 345   bool IsUnsafeImmediate(const Immediate& x);
 346   void SafeMove(Register dst, const Immediate& x);
 347   void SafePush(const Immediate& x);
 348
 349   // Compare object type for heap object.
 350   // Incoming register is heap_object and outgoing register is map.
 351   void CmpObjectType(Register heap_object, InstanceType type, Register map);
 352
 353   // Compare instance type for map.
 354   void CmpInstanceType(Register map, InstanceType type);
 355
 356   // Check if a map for a JSObject indicates that the object has fast elements.
 357   // Jump to the specified label if it does not.
 358   void CheckFastElements(Register map,
 359                          Label* fail,
 360                          Label::Distance distance = Label::kFar);
 361
 362   // Check if a map for a JSObject indicates that the object can have both smi
 363   // and HeapObject elements.  Jump to the specified label if it does not.
 364   void CheckFastObjectElements(Register map,
 365                                Label* fail,
 366                                Label::Distance distance = Label::kFar);
 367
 368   // Check if a map for a JSObject indicates that the object has fast smi only
 369   // elements.  Jump to the specified label if it does not.
 370   void CheckFastSmiElements(Register map,
 371                             Label* fail,
 372                             Label::Distance distance = Label::kFar);
 373
 374   // Check to see if maybe_number can be stored as a double in
 375   // FastDoubleElements. If it can, store it at the index specified by key in
 376   // the FastDoubleElements array elements, otherwise jump to fail.
 377   void StoreNumberToDoubleElements(Register maybe_number,
 378                                    Register elements,
 379                                    Register key,
 380                                    Register scratch,
 381                                    Label* fail,
 382                                    int offset = 0);
 383
 384   // Compare an object's map with the specified map.
 385   void CompareMap(Register obj, Handle<Map> map);
 386
 387   // Check if the map of an object is equal to a specified map and branch to
 388   // label if not. Skip the smi check if not required (object is known to be a
 389   // heap object). If mode is ALLOW_ELEMENT_TRANSITION_MAPS, then also match
 390   // against maps that are ElementsKind transition maps of the specified map.
 391   void CheckMap(Register obj,
 392                 Handle<Map> map,
 393                 Label* fail,
 394                 SmiCheckType smi_check_type);
 395
 396   // Check if the map of an object is equal to a specified map and branch to a
 397   // specified target if equal. Skip the smi check if not required (object is
 398   // known to be a heap object)
 399   void DispatchMap(Register obj,
 400                    Register unused,
 401                    Handle<Map> map,
 402                    Handle<Code> success,
 403                    SmiCheckType smi_check_type);
 404
 405   // Check if the object in register heap_object is a string. Afterwards the
 406   // register map contains the object map and the register instance_type
 407   // contains the instance_type. The registers map and instance_type can be the
 408   // same in which case it contains the instance type afterwards. Either of the
 409   // registers map and instance_type can be the same as heap_object.
 410   Condition IsObjectStringType(Register heap_object,
 411                                Register map,
 412                                Register instance_type);
 413
 414   // Check if the object in register heap_object is a name. Afterwards the
 415   // register map contains the object map and the register instance_type
 416   // contains the instance_type. The registers map and instance_type can be the
 417   // same in which case it contains the instance type afterwards. Either of the
 418   // registers map and instance_type can be the same as heap_object.
 419   Condition IsObjectNameType(Register heap_object,
 420                              Register map,
 421                              Register instance_type);
 422
 423   // Check if a heap object's type is in the JSObject range, not including
 424   // JSFunction.  The object's map will be loaded in the map register.
 425   // Any or all of the three registers may be the same.
 426   // The contents of the scratch register will always be overwritten.
 427   void IsObjectJSObjectType(Register heap_object,
 428                             Register map,
 429                             Register scratch,
 430                             Label* fail);
 431
 432   // The contents of the scratch register will be overwritten.
 433   void IsInstanceJSObjectType(Register map, Register scratch, Label* fail);
 434
 435   // FCmp is similar to integer cmp, but requires unsigned
 436   // jcc instructions (je, ja, jae, jb, jbe, je, and jz).
 437   void FCmp();
 438
 439   void ClampUint8(Register reg);
 440
 441   void SlowTruncateToI(Register result_reg, Register input_reg,
 442       int offset = HeapNumber::kValueOffset - kHeapObjectTag);
 443
 444   void TruncateHeapNumberToI(Register result_reg, Register input_reg);
 445   void TruncateX87TOSToI(Register result_reg);
 446
 447   void X87TOSToI(Register result_reg, MinusZeroMode minus_zero_mode,
 448       Label* conversion_failed, Label::Distance dst = Label::kFar);
 449
 450   void TaggedToI(Register result_reg, Register input_reg,
 451       MinusZeroMode minus_zero_mode, Label* lost_precision);
 452
 453   // Smi tagging support.
 454   void SmiTag(Register reg) {
 455     STATIC_ASSERT(kSmiTag == 0);
 456     STATIC_ASSERT(kSmiTagSize == 1);
 457     add(reg, reg);
 458   }
 459   void SmiUntag(Register reg) {
 460     sar(reg, kSmiTagSize);
 461   }
 462
 463   // Modifies the register even if it does not contain a Smi!
 464   void SmiUntag(Register reg, Label* is_smi) {
 465     STATIC_ASSERT(kSmiTagSize == 1);
 466     sar(reg, kSmiTagSize);
 467     STATIC_ASSERT(kSmiTag == 0);
 468     j(not_carry, is_smi);
 469   }
 470
 471   void LoadUint32NoSSE2(Register src);
 472
 473   // Jump the register contains a smi.
 474   inline void JumpIfSmi(Register value,
 475                         Label* smi_label,
 476                         Label::Distance distance = Label::kFar) {
 477     test(value, Immediate(kSmiTagMask));
 478     j(zero, smi_label, distance);
 479   }
 480   // Jump if the operand is a smi.
 481   inline void JumpIfSmi(Operand value,
 482                         Label* smi_label,
 483                         Label::Distance distance = Label::kFar) {
 484     test(value, Immediate(kSmiTagMask));
 485     j(zero, smi_label, distance);
 486   }
 487   // Jump if register contain a non-smi.
 488   inline void JumpIfNotSmi(Register value,
 489                            Label* not_smi_label,
 490                            Label::Distance distance = Label::kFar) {
 491     test(value, Immediate(kSmiTagMask));
 492     j(not_zero, not_smi_label, distance);
 493   }
 494
 495   void LoadInstanceDescriptors(Register map, Register descriptors);
 496   void EnumLength(Register dst, Register map);
 497   void NumberOfOwnDescriptors(Register dst, Register map);
 498
 499   template<typename Field>
 500   void DecodeField(Register reg) {
 501     static const int shift = Field::kShift;
 502     static const int mask = Field::kMask >> Field::kShift;
 503     if (shift != 0) {
 504       sar(reg, shift);
 505     }
 506     and_(reg, Immediate(mask));
 507   }
 508
 509   template<typename Field>
 510   void DecodeFieldToSmi(Register reg) {
 511     static const int shift = Field::kShift;
 512     static const int mask = (Field::kMask >> Field::kShift) << kSmiTagSize;
 513     STATIC_ASSERT((mask & (0x80000000u >> (kSmiTagSize - 1))) == 0);
 514     STATIC_ASSERT(kSmiTag == 0);
 515     if (shift < kSmiTagSize) {
 516       shl(reg, kSmiTagSize - shift);
 517     } else if (shift > kSmiTagSize) {
 518       sar(reg, shift - kSmiTagSize);
 519     }
 520     and_(reg, Immediate(mask));
 521   }
 522
 523   // Abort execution if argument is not a number, enabled via --debug-code.
 524   void AssertNumber(Register object);
 525
 526   // Abort execution if argument is not a smi, enabled via --debug-code.
 527   void AssertSmi(Register object);
 528
 529   // Abort execution if argument is a smi, enabled via --debug-code.
 530   void AssertNotSmi(Register object);
 531
 532   // Abort execution if argument is not a string, enabled via --debug-code.
 533   void AssertString(Register object);
 534
 535   // Abort execution if argument is not a name, enabled via --debug-code.
 536   void AssertName(Register object);
 537
 538   // Abort execution if argument is not undefined or an AllocationSite, enabled
 539   // via --debug-code.
 540   void AssertUndefinedOrAllocationSite(Register object);
 541
 542   // ---------------------------------------------------------------------------
 543   // Exception handling
 544
 545   // Push a new try handler and link it into try handler chain.
 546   void PushTryHandler(StackHandler::Kind kind, int handler_index);
 547
 548   // Unlink the stack handler on top of the stack from the try handler chain.
 549   void PopTryHandler();
 550
 551   // Throw to the top handler in the try hander chain.
 552   void Throw(Register value);
 553
 554   // Throw past all JS frames to the top JS entry frame.
 555   void ThrowUncatchable(Register value);
 556
 557   // ---------------------------------------------------------------------------
 558   // Inline caching support
 559
 560   // Generate code for checking access rights - used for security checks
 561   // on access to global objects across environments. The holder register
 562   // is left untouched, but the scratch register is clobbered.
 563   void CheckAccessGlobalProxy(Register holder_reg,
 564                               Register scratch1,
 565                               Register scratch2,
 566                               Label* miss);
 567
 568   void GetNumberHash(Register r0, Register scratch);
 569
 570   void LoadFromNumberDictionary(Label* miss,
 571                                 Register elements,
 572                                 Register key,
 573                                 Register r0,
 574                                 Register r1,
 575                                 Register r2,
 576                                 Register result);
 577
 578
 579   // ---------------------------------------------------------------------------
 580   // Allocation support
 581
 582   // Allocate an object in new space or old pointer space. If the given space
 583   // is exhausted control continues at the gc_required label. The allocated
 584   // object is returned in result and end of the new object is returned in
 585   // result_end. The register scratch can be passed as no_reg in which case
 586   // an additional object reference will be added to the reloc info. The
 587   // returned pointers in result and result_end have not yet been tagged as
 588   // heap objects. If result_contains_top_on_entry is true the content of
 589   // result is known to be the allocation top on entry (could be result_end
 590   // from a previous call). If result_contains_top_on_entry is true scratch
 591   // should be no_reg as it is never used.
 592   void Allocate(int object_size,
 593                 Register result,
 594                 Register result_end,
 595                 Register scratch,
 596                 Label* gc_required,
 597                 AllocationFlags flags);
 598
 599   void Allocate(int header_size,
 600                 ScaleFactor element_size,
 601                 Register element_count,
 602                 RegisterValueType element_count_type,
 603                 Register result,
 604                 Register result_end,
 605                 Register scratch,
 606                 Label* gc_required,
 607                 AllocationFlags flags);
 608
 609   void Allocate(Register object_size,
 610                 Register result,
 611                 Register result_end,
 612                 Register scratch,
 613                 Label* gc_required,
 614                 AllocationFlags flags);
 615
 616   // Undo allocation in new space. The object passed and objects allocated after
 617   // it will no longer be allocated. Make sure that no pointers are left to the
 618   // object(s) no longer allocated as they would be invalid when allocation is
 619   // un-done.
 620   void UndoAllocationInNewSpace(Register object);
 621
 622   // Allocate a heap number in new space with undefined value. The
 623   // register scratch2 can be passed as no_reg; the others must be
 624   // valid registers. Returns tagged pointer in result register, or
 625   // jumps to gc_required if new space is full.
 626   void AllocateHeapNumber(Register result,
 627                           Register scratch1,
 628                           Register scratch2,
 629                           Label* gc_required,
 630                           MutableMode mode = IMMUTABLE);
 631
 632   // Allocate a sequential string. All the header fields of the string object
 633   // are initialized.
 634   void AllocateTwoByteString(Register result,
 635                              Register length,
 636                              Register scratch1,
 637                              Register scratch2,
 638                              Register scratch3,
 639                              Label* gc_required);
 640   void AllocateOneByteString(Register result, Register length,
 641                              Register scratch1, Register scratch2,
 642                              Register scratch3, Label* gc_required);
 643   void AllocateOneByteString(Register result, int length, Register scratch1,
 644                              Register scratch2, Label* gc_required);
 645
 646   // Allocate a raw cons string object. Only the map field of the result is
 647   // initialized.
 648   void AllocateTwoByteConsString(Register result,
 649                           Register scratch1,
 650                           Register scratch2,
 651                           Label* gc_required);
 652   void AllocateOneByteConsString(Register result, Register scratch1,
 653                                  Register scratch2, Label* gc_required);
 654
 655   // Allocate a raw sliced string object. Only the map field of the result is
 656   // initialized.
 657   void AllocateTwoByteSlicedString(Register result,
 658                             Register scratch1,
 659                             Register scratch2,
 660                             Label* gc_required);
 661   void AllocateOneByteSlicedString(Register result, Register scratch1,
 662                                    Register scratch2, Label* gc_required);
 663
 664   // Copy memory, byte-by-byte, from source to destination.  Not optimized for
 665   // long or aligned copies.
 666   // The contents of index and scratch are destroyed.
 667   void CopyBytes(Register source,
 668                  Register destination,
 669                  Register length,
 670                  Register scratch);
 671
 672   // Initialize fields with filler values.  Fields starting at |start_offset|
 673   // not including end_offset are overwritten with the value in |filler|.  At
 674   // the end the loop, |start_offset| takes the value of |end_offset|.
 675   void InitializeFieldsWithFiller(Register start_offset,
 676                                   Register end_offset,
 677                                   Register filler);
 678
 679   // ---------------------------------------------------------------------------
 680   // Support functions.
 681
 682   // Check a boolean-bit of a Smi field.
 683   void BooleanBitTest(Register object, int field_offset, int bit_index);
 684
 685   // Check if result is zero and op is negative.
 686   void NegativeZeroTest(Register result, Register op, Label* then_label);
 687
 688   // Check if result is zero and any of op1 and op2 are negative.
 689   // Register scratch is destroyed, and it must be different from op2.
 690   void NegativeZeroTest(Register result, Register op1, Register op2,
 691                         Register scratch, Label* then_label);
 692
 693   // Try to get function prototype of a function and puts the value in
 694   // the result register. Checks that the function really is a
 695   // function and jumps to the miss label if the fast checks fail. The
 696   // function register will be untouched; the other registers may be
 697   // clobbered.
 698   void TryGetFunctionPrototype(Register function,
 699                                Register result,
 700                                Register scratch,
 701                                Label* miss,
 702                                bool miss_on_bound_function = false);
 703
 704   // Picks out an array index from the hash field.
 705   // Register use:
 706   //   hash - holds the index's hash. Clobbered.
 707   //   index - holds the overwritten index on exit.
 708   void IndexFromHash(Register hash, Register index);
 709
 710   // ---------------------------------------------------------------------------
 711   // Runtime calls
 712
 713   // Call a code stub.  Generate the code if necessary.
 714   void CallStub(CodeStub* stub, TypeFeedbackId ast_id = TypeFeedbackId::None());
 715
 716   // Tail call a code stub (jump).  Generate the code if necessary.
 717   void TailCallStub(CodeStub* stub);
 718
 719   // Return from a code stub after popping its arguments.
 720   void StubReturn(int argc);
 721
 722   // Call a runtime routine.
 723   void CallRuntime(const Runtime::Function* f, int num_arguments);
 724   // Convenience function: Same as above, but takes the fid instead.
 725   void CallRuntime(Runtime::FunctionId id) {
 726     const Runtime::Function* function = Runtime::FunctionForId(id);
 727     CallRuntime(function, function->nargs);
 728   }
 729   void CallRuntime(Runtime::FunctionId id, int num_arguments) {
 730     CallRuntime(Runtime::FunctionForId(id), num_arguments);
 731   }
 732
 733   // Convenience function: call an external reference.
 734   void CallExternalReference(ExternalReference ref, int num_arguments);
 735
 736   // Tail call of a runtime routine (jump).
 737   // Like JumpToExternalReference, but also takes care of passing the number
 738   // of parameters.
 739   void TailCallExternalReference(const ExternalReference& ext,
 740                                  int num_arguments,
 741                                  int result_size);
 742
 743   // Convenience function: tail call a runtime routine (jump).
 744   void TailCallRuntime(Runtime::FunctionId fid,
 745                        int num_arguments,
 746                        int result_size);
 747
 748   // Before calling a C-function from generated code, align arguments on stack.
 749   // After aligning the frame, arguments must be stored in esp[0], esp[4],
 750   // etc., not pushed. The argument count assumes all arguments are word sized.
 751   // Some compilers/platforms require the stack to be aligned when calling
 752   // C++ code.
 753   // Needs a scratch register to do some arithmetic. This register will be
 754   // trashed.
 755   void PrepareCallCFunction(int num_arguments, Register scratch);
 756
 757   // Calls a C function and cleans up the space for arguments allocated
 758   // by PrepareCallCFunction. The called function is not allowed to trigger a
 759   // garbage collection, since that might move the code and invalidate the
 760   // return address (unless this is somehow accounted for by the called
 761   // function).
 762   void CallCFunction(ExternalReference function, int num_arguments);
 763   void CallCFunction(Register function, int num_arguments);
 764
 765   // Prepares stack to put arguments (aligns and so on). Reserves
 766   // space for return value if needed (assumes the return value is a handle).
 767   // Arguments must be stored in ApiParameterOperand(0), ApiParameterOperand(1)
 768   // etc. Saves context (esi). If space was reserved for return value then
 769   // stores the pointer to the reserved slot into esi.
 770   void PrepareCallApiFunction(int argc);
 771
 772   // Calls an API function.  Allocates HandleScope, extracts returned value
 773   // from handle and propagates exceptions.  Clobbers ebx, edi and
 774   // caller-save registers.  Restores context.  On return removes
 775   // stack_space * kPointerSize (GCed).
 776   void CallApiFunctionAndReturn(Register function_address,
 777                                 ExternalReference thunk_ref,
 778                                 Operand thunk_last_arg,
 779                                 int stack_space,
 780                                 Operand return_value_operand,
 781                                 Operand* context_restore_operand);
 782
 783   // Jump to a runtime routine.
 784   void JumpToExternalReference(const ExternalReference& ext);
 785
 786   // ---------------------------------------------------------------------------
 787   // Utilities
 788
 789   void Ret();
 790
 791   // Return and drop arguments from stack, where the number of arguments
 792   // may be bigger than 2^16 - 1.  Requires a scratch register.
 793   void Ret(int bytes_dropped, Register scratch);
 794
 795   // Emit code to discard a non-negative number of pointer-sized elements
 796   // from the stack, clobbering only the esp register.
 797   void Drop(int element_count);
 798
 799   void Call(Label* target) { call(target); }
 800   void Push(Register src) { push(src); }
 801   void Pop(Register dst) { pop(dst); }
 802
 803   // Emit call to the code we are currently generating.
 804   void CallSelf() {
 805     Handle<Code> self(reinterpret_cast<Code**>(CodeObject().location()));
 806     call(self, RelocInfo::CODE_TARGET);
 807   }
 808
 809   // Move if the registers are not identical.
 810   void Move(Register target, Register source);
 811
 812   // Move a constant into a destination using the most efficient encoding.
 813   void Move(Register dst, const Immediate& x);
 814   void Move(const Operand& dst, const Immediate& x);
 815
 816   // Push a handle value.
 817   void Push(Handle<Object> handle) { push(Immediate(handle)); }
 818   void Push(Smi* smi) { Push(Handle<Smi>(smi, isolate())); }
 819
 820   Handle<Object> CodeObject() {
 821     DCHECK(!code_object_.is_null());
 822     return code_object_;
 823   }
 824
 825   // Insert code to verify that the x87 stack has the specified depth (0-7)
 826   void VerifyX87StackDepth(uint32_t depth);
 827
 828   // Emit code for a truncating division by a constant. The dividend register is
 829   // unchanged, the result is in edx, and eax gets clobbered.
 830   void TruncatingDiv(Register dividend, int32_t divisor);
 831
 832   // ---------------------------------------------------------------------------
 833   // StatsCounter support
 834
 835   void SetCounter(StatsCounter* counter, int value);
 836   void IncrementCounter(StatsCounter* counter, int value);
 837   void DecrementCounter(StatsCounter* counter, int value);
 838   void IncrementCounter(Condition cc, StatsCounter* counter, int value);
 839   void DecrementCounter(Condition cc, StatsCounter* counter, int value);
 840
 841
 842   // ---------------------------------------------------------------------------
 843   // Debugging
 844
 845   // Calls Abort(msg) if the condition cc is not satisfied.
 846   // Use --debug_code to enable.
 847   void Assert(Condition cc, BailoutReason reason);
 848
 849   void AssertFastElements(Register elements);
 850
 851   // Like Assert(), but always enabled.
 852   void Check(Condition cc, BailoutReason reason);
 853
 854   // Print a message to stdout and abort execution.
 855   void Abort(BailoutReason reason);
 856
 857   // Check that the stack is aligned.
 858   void CheckStackAlignment();
 859
 860   // Verify restrictions about code generated in stubs.
 861   void set_generating_stub(bool value) { generating_stub_ = value; }
 862   bool generating_stub() { return generating_stub_; }
 863   void set_has_frame(bool value) { has_frame_ = value; }
 864   bool has_frame() { return has_frame_; }
 865   inline bool AllowThisStubCall(CodeStub* stub);
 866
 867   // ---------------------------------------------------------------------------
 868   // String utilities.
 869
 870   // Generate code to do a lookup in the number string cache. If the number in
 871   // the register object is found in the cache the generated code falls through
 872   // with the result in the result register. The object and the result register
 873   // can be the same. If the number is not found in the cache the code jumps to
 874   // the label not_found with only the content of register object unchanged.
 875   void LookupNumberStringCache(Register object,
 876                                Register result,
 877                                Register scratch1,
 878                                Register scratch2,
 879                                Label* not_found);
 880
 881   // Check whether the instance type represents a flat one-byte string. Jump to
 882   // the label if not. If the instance type can be scratched specify same
 883   // register for both instance type and scratch.
 884   void JumpIfInstanceTypeIsNotSequentialOneByte(
 885       Register instance_type, Register scratch,
 886       Label* on_not_flat_one_byte_string);
 887
 888   // Checks if both objects are sequential one-byte strings, and jumps to label
 889   // if either is not.
 890   void JumpIfNotBothSequentialOneByteStrings(
 891       Register object1, Register object2, Register scratch1, Register scratch2,
 892       Label* on_not_flat_one_byte_strings);
 893
 894   // Checks if the given register or operand is a unique name
 895   void JumpIfNotUniqueName(Register reg, Label* not_unique_name,
 896                            Label::Distance distance = Label::kFar) {
 897     JumpIfNotUniqueName(Operand(reg), not_unique_name, distance);
 898   }
 899
 900   void JumpIfNotUniqueName(Operand operand, Label* not_unique_name,
 901                            Label::Distance distance = Label::kFar);
 902
 903   void EmitSeqStringSetCharCheck(Register string,
 904                                  Register index,
 905                                  Register value,
 906                                  uint32_t encoding_mask);
 907
 908   static int SafepointRegisterStackIndex(Register reg) {
 909     return SafepointRegisterStackIndex(reg.code());
 910   }
 911
 912   // Activation support.
 913   void EnterFrame(StackFrame::Type type);
 914   void LeaveFrame(StackFrame::Type type);
 915
 916   // Expects object in eax and returns map with validated enum cache
 917   // in eax.  Assumes that any other register can be used as a scratch.
 918   void CheckEnumCache(Label* call_runtime);
 919
 920   // AllocationMemento support. Arrays may have an associated
 921   // AllocationMemento object that can be checked for in order to pretransition
 922   // to another type.
 923   // On entry, receiver_reg should point to the array object.
 924   // scratch_reg gets clobbered.
 925   // If allocation info is present, conditional code is set to equal.
 926   void TestJSArrayForAllocationMemento(Register receiver_reg,
 927                                        Register scratch_reg,
 928                                        Label* no_memento_found);
 929
 930   void JumpIfJSArrayHasAllocationMemento(Register receiver_reg,
 931                                          Register scratch_reg,
 932                                          Label* memento_found) {
 933     Label no_memento_found;
 934     TestJSArrayForAllocationMemento(receiver_reg, scratch_reg,
 935                                     &no_memento_found);
 936     j(equal, memento_found);
 937     bind(&no_memento_found);
 938   }
 939
 940   // Jumps to found label if a prototype map has dictionary elements.
 941   void JumpIfDictionaryInPrototypeChain(Register object, Register scratch0,
 942                                         Register scratch1, Label* found);
 943
 944  private:
 945   bool generating_stub_;
 946   bool has_frame_;
 947   // This handle will be patched with the code object on installation.
 948   Handle<Object> code_object_;
 949
 950   // Helper functions for generating invokes.
 951   void InvokePrologue(const ParameterCount& expected,
 952                       const ParameterCount& actual,
 953                       Handle<Code> code_constant,
 954                       const Operand& code_operand,
 955                       Label* done,
 956                       bool* definitely_mismatches,
 957                       InvokeFlag flag,
 958                       Label::Distance done_distance,
 959                       const CallWrapper& call_wrapper = NullCallWrapper());
 960
 961   void EnterExitFramePrologue();
 962   void EnterExitFrameEpilogue(int argc);
 963
 964   void LeaveExitFrameEpilogue(bool restore_context);
 965
 966   // Allocation support helpers.
 967   void LoadAllocationTopHelper(Register result,
 968                                Register scratch,
 969                                AllocationFlags flags);
 970
 971   void UpdateAllocationTopHelper(Register result_end,
 972                                  Register scratch,
 973                                  AllocationFlags flags);
 974
 975   // Helper for implementing JumpIfNotInNewSpace and JumpIfInNewSpace.
 976   void InNewSpace(Register object,
 977                   Register scratch,
 978                   Condition cc,
 979                   Label* condition_met,
 980                   Label::Distance condition_met_distance = Label::kFar);
 981
 982   // Helper for finding the mark bits for an address.  Afterwards, the
 983   // bitmap register points at the word with the mark bits and the mask
 984   // the position of the first bit.  Uses ecx as scratch and leaves addr_reg
 985   // unchanged.
 986   inline void GetMarkBits(Register addr_reg,
 987                           Register bitmap_reg,
 988                           Register mask_reg);
 989
 990   // Helper for throwing exceptions.  Compute a handler address and jump to
 991   // it.  See the implementation for register usage.
 992   void JumpToHandlerEntry();
 993
 994   // Compute memory operands for safepoint stack slots.
 995   Operand SafepointRegisterSlot(Register reg);
 996   static int SafepointRegisterStackIndex(int reg_code);
 997
 998   // Needs access to SafepointRegisterStackIndex for compiled frame
 999   // traversal.
1000   friend class StandardFrame;
1001 };
1002
1003
1004 // The code patcher is used to patch (typically) small parts of code e.g. for
1005 // debugging and other types of instrumentation. When using the code patcher
1006 // the exact number of bytes specified must be emitted. Is not legal to emit
1007 // relocation information. If any of these constraints are violated it causes
1008 // an assertion.
1009 class CodePatcher {
1010  public:
1011   CodePatcher(byte* address, int size);
1012   virtual ~CodePatcher();
1013
1014   // Macro assembler to emit code.
1015   MacroAssembler* masm() { return &masm_; }
1016
1017  private:
1018   byte* address_;  // The address of the code being patched.
1019   int size_;  // Number of bytes of the expected patch size.
1020   MacroAssembler masm_;  // Macro assembler used to generate the code.
1021 };
1022
1023
1024 // -----------------------------------------------------------------------------
1025 // Static helper functions.
1026
1027 // Generate an Operand for loading a field from an object.
1028 inline Operand FieldOperand(Register object, int offset) {
1029   return Operand(object, offset - kHeapObjectTag);
1030 }
1031
1032
1033 // Generate an Operand for loading an indexed field from an object.
1034 inline Operand FieldOperand(Register object,
1035                             Register index,
1036                             ScaleFactor scale,
1037                             int offset) {
1038   return Operand(object, index, scale, offset - kHeapObjectTag);
1039 }
1040
1041
1042 inline Operand FixedArrayElementOperand(Register array,
1043                                         Register index_as_smi,
1044                                         int additional_offset = 0) {
1045   int offset = FixedArray::kHeaderSize + additional_offset * kPointerSize;
1046   return FieldOperand(array, index_as_smi, times_half_pointer_size, offset);
1047 }
1048
1049
1050 inline Operand ContextOperand(Register context, int index) {
1051   return Operand(context, Context::SlotOffset(index));
1052 }
1053
1054
1055 inline Operand GlobalObjectOperand() {
1056   return ContextOperand(esi, Context::GLOBAL_OBJECT_INDEX);
1057 }
1058
1059
1060 // Generates an Operand for saving parameters after PrepareCallApiFunction.
1061 Operand ApiParameterOperand(int index);
1062
1063
1064 #ifdef GENERATED_CODE_COVERAGE
1065 extern void LogGeneratedCodeCoverage(const char* file_line);
1066 #define CODE_COVERAGE_STRINGIFY(x) #x
1067 #define CODE_COVERAGE_TOSTRING(x) CODE_COVERAGE_STRINGIFY(x)
1068 #define __FILE_LINE__ __FILE__ ":" CODE_COVERAGE_TOSTRING(__LINE__)
1069 #define ACCESS_MASM(masm) {                                               \
1070     byte* ia32_coverage_function =                                        \
1071         reinterpret_cast<byte*>(FUNCTION_ADDR(LogGeneratedCodeCoverage)); \
1072     masm->pushfd();                                                       \
1073     masm->pushad();                                                       \
1074     masm->push(Immediate(reinterpret_cast<int>(&__FILE_LINE__)));         \
1075     masm->call(ia32_coverage_function, RelocInfo::RUNTIME_ENTRY);         \
1076     masm->pop(eax);                                                       \
1077     masm->popad();                                                        \
1078     masm->popfd();                                                        \
1079   }                                                                       \
1080   masm->
1081 #else
1082 #define ACCESS_MASM(masm) masm->
1083 #endif
1084
1085
1086 } }  // namespace v8::internal
1087
1088 #endif  // V8_X87_MACRO_ASSEMBLER_X87_H_