[turbofan] Unify referencing of stack slots

src/compiler/frame.h

 // Copyright 2014 the V8 project authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #ifndef V8_COMPILER_FRAME_H_
 #define V8_COMPILER_FRAME_H_
 
 #include "src/bit-vector.h"
+#include "src/frames.h"
 
 namespace v8 {
 namespace internal {
 namespace compiler {
 
-// Collects the spill slot requirements and the allocated general and double
-// registers for a compiled function. Frames are usually populated by the
-// register allocator and are used by Linkage to generate code for the prologue
-// and epilogue to compiled code.
+// Collects the spill slot and other frame slot requirements for a compiled
+// function. Frames are usually populated by the register allocator and are used
+// by Linkage to generate code for the prologue and epilogue to compiled code.
+//
+// Frames are divided up into three regions. The first is the fixed header,
+// which always has a constant size and can be predicted before code generation
+// begins depending on the type of code being generated. The second is the
+// region for spill slots, which is immediately below the fixed header and grows
+// as the register allocator needs to spill to the stack and asks the frame for
+// more space. The third region, which contains the callee-saved registers must
+// be reserved after register allocation, since its size can only be precisely
+// determined after register allocation once the number of used callee-saved
+// register is certain.
+//
+// Every pointer in a frame has a slot id. On 32-bit platforms, doubles consume
+// two slots.
+//
+// Stack slot indices >= 0 access the callee stack with slot 0 corresponding to
+// the callee's saved return address and 1 corresponding to the saved frame
+// pointer. Some frames have additional information stored in the fixed header,
+// for example JSFunctions store the function context and marker in the fixed
+// header, with slot index 2 corresponding to the current function context and 3
+// corresponding to the frame marker/JSFunction. The frame region immediately
+// below the fixed header contains spill slots starting a 4 for JsFunctions. The
+// callee-saved frame region below that starts at 4+spilled_slot_count. Callee
+// stack slots corresponding to parameters are accessible through negative slot
+// ids.
+//
+// Every slot of a caller or callee frame is accessible by the register
+// allocator and gab resolver with a SpillSlotOperand containing its

[Benedikt Meurer, 2015/08/16 07:04:35]

Nit: gap resolver

[danno, 2015/08/18 13:23:10]

Done

+// corresponding slot id.
+//
+// Below an example JSFunction Frame with slot ids, frame regions and contents:
+//
+//  slot      JS frame
+//       +-----------------+----------------------------
+//  -n-1 |   parameter 0   |                        ^
+//       |- - - - - - - - -|                        |
+//  -n   |                 |                      Caller
+//  ...  |       ...       |                   frame slots
+//  -2   |  parameter n-1  |                   (slot < 0)
+//       |- - - - - - - - -|                        |
+//  -1   |   parameter n   |                        v
+//  -----+-----------------+----------------------------
+//   0   |   return addr   |   ^                    ^
+//       |- - - - - - - - -|   |                    |
+//   1   | saved frame ptr | Fixed                  |
+//       |- - - - - - - - -| Header <-- frame ptr   |
+//   2   |   JSFunction    |   |                    |

[Benedikt Meurer, 2015/08/16 07:04:35]

Nit: Context

[danno, 2015/08/18 13:23:10]

Done

+//       |- - - - - - - - -|   |                    |
+//   3   |     Marker      |   v                    |

[Benedikt Meurer, 2015/08/16 07:04:35]

Nit: JSFunction/Marker

[danno, 2015/08/18 13:23:10]

Done

+//       +-----------------+----                    |
+//   4   |    spill 1      |   ^                  Callee
+//       |- - - - - - - - -|   |               frame slots
+//  ...  |      ...        | Spill slots       (slot >= 0)
+//       |- - - - - - - - -|   |                    |
+//  m+4  |    spill m      |   v                    |
+//       +-----------------+----                    |
+//  m+5  |  callee-saved 1 |   ^                    |
+//       |- - - - - - - - -|   |                    |
+//       |      ...        | Callee-saved           |
+//       |- - - - - - - - -|   |                    |
+// m+r+4 |  callee-saved r |   v                    v
+//  -----+-----------------+----- <-- stack ptr ---------
+//
 class Frame : public ZoneObject {
  public:
-  Frame()
-      : register_save_area_size_(0),
-        spill_slot_count_(0),
-        osr_stack_slot_count_(0),
-        allocated_registers_(NULL),
-        allocated_double_registers_(NULL),
-        pc_on_stack_(true) {}
+  explicit Frame(int fixed_frame_size_in_slots);
 
-  inline int GetSpillSlotCount() { return spill_slot_count_; }
+  static const int kFixedSlotCount =

[titzer, 2015/08/17 10:58:42]

I think this is dead now?

[danno, 2015/08/18 13:23:10]

No, it's not. It is used to initialize the Frame with the initial number of
slots.

[titzer, 2015/08/18 13:30:04]

In that case recommend moving it to the usage sites.

+      (kPCOnStackSize + kFPOnStackSize) / kPointerSize;
+  static const int kJSFixedSlotCount =
+      StandardFrameConstants::kFixedFrameSize / kPointerSize;
+
+  inline int GetTotalFrameSlotCount() { return frame_slot_count_; }
+
+  inline int GetSavedCalleeRegisterSlotCount() {
+    return spilled_callee_register_slot_count_;
+  }
+  inline int GetSpillSlotCount() { return stack_slot_count_; }
+
+  inline void SetElidedFrameSizeInSlots(int slots) {
+    DCHECK_EQ(0, spilled_callee_register_slot_count_);
+    DCHECK_EQ(0, stack_slot_count_);
+    frame_slot_count_ = slots;
+  }
 
   void SetAllocatedRegisters(BitVector* regs) {
     DCHECK(allocated_registers_ == NULL);
     allocated_registers_ = regs;
   }
 
   void SetAllocatedDoubleRegisters(BitVector* regs) {
     DCHECK(allocated_double_registers_ == NULL);
     allocated_double_registers_ = regs;
   }
 
   bool DidAllocateDoubleRegisters() {
     return !allocated_double_registers_->IsEmpty();
   }
 
-  void SetRegisterSaveAreaSize(int size) {
-    DCHECK(IsAligned(size, kPointerSize));
-    register_save_area_size_ = size;
+  int AlignSavedCalleeRegisterSlots() {
+    DCHECK_EQ(0, spilled_callee_register_slot_count_);
+    int frame_slot_count_before = frame_slot_count_;
+    frame_slot_count_ = RoundUp(frame_slot_count_, 2);
+    return frame_slot_count_before - frame_slot_count_;
   }
 
-  int GetRegisterSaveAreaSize() { return register_save_area_size_; }
-
-  // OSR stack slots, including locals and expression stack slots.
-  void SetOsrStackSlotCount(int slots) {
-    DCHECK(slots >= 0);
-    osr_stack_slot_count_ = slots;
+  void AllocateSavedCalleeRegisterSlots(int count) {
+    ++frame_slot_count_ += count;
+    ++spilled_callee_register_slot_count_ += count;

[Jarin, 2015/08/16 09:28:59]

How about 'frame_slot_count_ += count + 1;'? I am not even sure what you do here
is well-defined.

[Benedikt Meurer, 2015/08/16 09:31:34]

Oh indeed. Missed this one. Should really be

frame_slot_count_ += count + 1;

[danno, 2015/08/18 13:23:10]

Fixed.

   }
 
-  int GetOsrStackSlotCount() { return osr_stack_slot_count_; }
+  int AllocateSpillSlot(int width) {
+    DCHECK_EQ(0, spilled_callee_register_slot_count_);
+    int frame_slot_count_before = frame_slot_count_;
+    int slot = AllocateAlignedFrameSlot(width);
+    stack_slot_count_ += (frame_slot_count_ - frame_slot_count_before);
+    return slot;
+  }
 
-  int AllocateSpillSlot(int width) {
+  int ReserveSpillSlots(size_t slot_count) {
+    DCHECK_EQ(0, spilled_callee_register_slot_count_);
+    DCHECK_EQ(0, stack_slot_count_);
+    stack_slot_count_ += static_cast<int>(slot_count);
+    frame_slot_count_ += static_cast<int>(slot_count);
+    return frame_slot_count_ - 1;
+  }
+
+ private:
+  int AllocateAlignedFrameSlot(int width) {
     DCHECK(width == 4 || width == 8);
     // Skip one slot if necessary.
     if (width > kPointerSize) {
       DCHECK(width == kPointerSize * 2);
-      spill_slot_count_++;
-      spill_slot_count_ |= 1;
+      frame_slot_count_++;
+      frame_slot_count_ |= 1;
     }
-    return spill_slot_count_++;
+    return frame_slot_count_++;
   }
 
-  void ReserveSpillSlots(size_t slot_count) {
-    DCHECK_EQ(0, spill_slot_count_);  // can only reserve before allocation.
-    spill_slot_count_ = static_cast<int>(slot_count);
-  }
-
-  void SetPCOnStack(bool val) { pc_on_stack_ = val; }
-
-  int PCOnStackSize() { return pc_on_stack_ ? kRegisterSize : 0; }
-
  private:
-  int register_save_area_size_;
-  int spill_slot_count_;
-  int osr_stack_slot_count_;
+  int frame_slot_count_;
+  int spilled_callee_register_slot_count_;
+  int stack_slot_count_;
   BitVector* allocated_registers_;
   BitVector* allocated_double_registers_;
-  bool pc_on_stack_;
 
   DISALLOW_COPY_AND_ASSIGN(Frame);
 };
 
 
 // Represents an offset from either the stack pointer or frame pointer.
 class FrameOffset {
  public:
   inline bool from_stack_pointer() { return (offset_ & 1) == kFromSp; }
   inline bool from_frame_pointer() { return (offset_ & 1) == kFromFp; }
@@ skipping 15 matching lines @@
   int offset_;  // Encodes SP or FP in the low order bit.
 
   static const int kFromSp = 1;
   static const int kFromFp = 0;
 };
 }
 }
 }  // namespace v8::internal::compiler
 
 #endif  // V8_COMPILER_FRAME_H_