deps/v8/src/ia32/macro-assembler-ia32.h

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