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