]> gitweb.factorcode.org Git - factor.git/blobdiff - vm/layouts.hpp
audio.engine.test: cleanup using
[factor.git] / vm / layouts.hpp
index f6c88064d4b5934aeeef92c18a89781703d2b718..6c79aec31e708073b23835bb3ed099a898842ec3 100644 (file)
-namespace factor
-{
-
-typedef unsigned char u8;
-typedef unsigned short u16;
-typedef unsigned int u32;
-typedef unsigned long long u64;
-typedef signed char s8;
-typedef signed short s16;
-typedef signed int s32;
-typedef signed long long s64;
-
-#ifdef _WIN64
-       typedef long long fixnum;
-       typedef unsigned long long cell;
-#else
-       typedef long fixnum;
-       typedef unsigned long cell;
-#endif
+namespace factor {
 
-inline static cell align(cell a, cell b)
-{
-       return (a + (b-1)) & ~(b-1);
-}
+typedef intptr_t fixnum;
+typedef uintptr_t cell;
+
+inline static cell align(cell a, cell b) { return (a + (b - 1)) & ~(b - 1); }
+
+inline static cell alignment_for(cell a, cell b) { return align(a, b) - a; }
 
 static const cell data_alignment = 16;
 
-#define WORD_SIZE (signed)(sizeof(cell)*8)
+// Must match leaf-stack-frame-size in basis/bootstrap/layouts.factor
+#define LEAF_FRAME_SIZE 16
+
+#define WORD_SIZE (signed)(sizeof(cell) * 8)
 
-#define TAG_MASK 7
-#define TAG_BITS 3
+#define TAG_MASK 15
+#define TAG_BITS 4
 #define TAG(x) ((cell)(x) & TAG_MASK)
 #define UNTAG(x) ((cell)(x) & ~TAG_MASK)
-#define RETAG(x,tag) (UNTAG(x) | (tag))
-
-/*** Tags ***/
-#define FIXNUM_TYPE 0
-#define BIGNUM_TYPE 1
-#define ARRAY_TYPE 2
-#define FLOAT_TYPE 3
-#define QUOTATION_TYPE 4
-#define F_TYPE 5
-#define OBJECT_TYPE 6
-#define TUPLE_TYPE 7
-
-#define HEADER_TYPE 8 /* anything less than this is a tag */
-
-#define GC_COLLECTED 5 /* can be anything other than FIXNUM_TYPE */
-
-/*** Header types ***/
-#define WRAPPER_TYPE 8
-#define BYTE_ARRAY_TYPE 9
-#define CALLSTACK_TYPE 10
-#define STRING_TYPE 11
-#define WORD_TYPE 12
-#define DLL_TYPE 13
-#define ALIEN_TYPE 14
-
-#define TYPE_COUNT 15
-
-enum code_block_type
-{
-       code_block_unoptimized,
-       code_block_optimized,
-       code_block_profiling,
-       code_block_pic
+#define RETAG(x, tag) (UNTAG(x) | (tag))
+
+// Type tags, should be kept in sync with:
+//   basis/bootstrap/layouts.factor
+enum type_tags {
+  FIXNUM_TYPE,
+  F_TYPE,
+  ARRAY_TYPE,
+  FLOAT_TYPE,
+  QUOTATION_TYPE,
+  BIGNUM_TYPE,
+  ALIEN_TYPE,
+  TUPLE_TYPE,
+  WRAPPER_TYPE,
+  BYTE_ARRAY_TYPE,
+  CALLSTACK_TYPE,
+  STRING_TYPE,
+  WORD_TYPE,
+  DLL_TYPE,
+
+  TYPE_COUNT
+};
+
+static inline const char* type_name(cell type) {
+  static const char* const type_names[]={
+    "fixnum",
+    "f",
+    "array",
+    "float",
+    "quotation",
+    "bignum",
+    "alien",
+    "tuple",
+    "wrapper",
+    "byte-array",
+    "callstack",
+    "string",
+    "word",
+    "dll",
+  };
+
+  if (type>=TYPE_COUNT) {
+      FACTOR_ASSERT(false);
+      return "";
+  }
+  return type_names[type];
+}
+
+enum code_block_type {
+  CODE_BLOCK_UNOPTIMIZED,
+  CODE_BLOCK_OPTIMIZED,
+  CODE_BLOCK_PIC
 };
 
-/* Constants used when floating-point trap exceptions are thrown */
-enum
-{
-       FP_TRAP_INVALID_OPERATION = 1 << 0,
-       FP_TRAP_OVERFLOW          = 1 << 1,
-       FP_TRAP_UNDERFLOW         = 1 << 2,
-       FP_TRAP_ZERO_DIVIDE       = 1 << 3,
-       FP_TRAP_INEXACT           = 1 << 4,
+// Constants used when floating-point trap exceptions are thrown
+enum {
+  FP_TRAP_INVALID_OPERATION = 1 << 0,
+  FP_TRAP_OVERFLOW = 1 << 1,
+  FP_TRAP_UNDERFLOW = 1 << 2,
+  FP_TRAP_ZERO_DIVIDE = 1 << 3,
+  FP_TRAP_INEXACT = 1 << 4,
 };
 
-/* What Factor calls 'f' */
+// What Factor calls 'f'
 static const cell false_object = F_TYPE;
 
-inline static bool immediate_p(cell obj)
-{
-       return (obj == false_object || TAG(obj) == FIXNUM_TYPE);
+inline static bool immediate_p(cell obj) {
+  // We assume that fixnums have tag 0 and false_object has tag 1
+  return TAG(obj) <= F_TYPE;
 }
 
-inline static fixnum untag_fixnum(cell tagged)
-{
-#ifdef FACTOR_DEBUG
-       assert(TAG(tagged) == FIXNUM_TYPE);
-#endif
-       return ((fixnum)tagged) >> TAG_BITS;
+inline static fixnum untag_fixnum(cell tagged) {
+  FACTOR_ASSERT(TAG(tagged) == FIXNUM_TYPE);
+  return ((fixnum)tagged) >> TAG_BITS;
 }
 
-inline static cell tag_fixnum(fixnum untagged)
-{
-       return RETAG(untagged << TAG_BITS,FIXNUM_TYPE);
+inline static cell tag_fixnum(fixnum untagged) {
+  return ( (cell)untagged << TAG_BITS) | FIXNUM_TYPE;
 }
 
-inline static cell tag_for(cell type)
-{
-       return type < HEADER_TYPE ? type : OBJECT_TYPE;
-}
+#define NO_TYPE_CHECK static const cell type_number = TYPE_COUNT
 
-struct object;
+struct object {
+  NO_TYPE_CHECK;
+  // header format (bits indexed with least significant as zero):
+  // bit 0      : free?
+  // bit 1      : forwarding pointer?
+  // if not forwarding:
+  //   bit 2-5    : tag
+  //   bit 7-end  : hashcode
+  // if forwarding:
+  //   bit 2-end  : forwarding pointer
+  cell header;
 
-struct header {
-       cell value;
+  template <typename Fixup> cell base_size(Fixup fixup) const;
+  template <typename Fixup> cell size(Fixup fixup) const;
+  cell size() const;
 
-        /* Default ctor to make gcc 3.x happy */
-        explicit header() { abort(); }
+  cell slot_count() const;
+  template <typename Fixup> cell slot_count(Fixup fixup) const;
 
-       explicit header(cell value_) : value(value_ << TAG_BITS) {}
+  cell* slots() const { return (cell*)this; }
 
-       void check_header() const
-       {
-#ifdef FACTOR_DEBUG
-               assert(TAG(value) == FIXNUM_TYPE && untag_fixnum(value) < TYPE_COUNT);
-#endif
-       }
-
-       cell hi_tag() const
-       {
-               check_header();
-               return value >> TAG_BITS;
-       }
-
-       bool forwarding_pointer_p() const
-       {
-               return TAG(value) == GC_COLLECTED;
-       }
-
-       object *forwarding_pointer() const
-       {
-               return (object *)UNTAG(value);
-       }
-
-       void forward_to(object *pointer)
-       {
-               value = RETAG(pointer,GC_COLLECTED);
-       }
-};
+  template <typename Iterator> void each_slot(Iterator& iter);
 
-#define NO_TYPE_CHECK static const cell type_number = TYPE_COUNT
+  // Only valid for objects in tenured space; must cast to free_heap_block
+  // to do anything with it if its free
+  bool free_p() const { return (header & 1) == 1; }
 
-struct object {
-       NO_TYPE_CHECK;
-       header h;
+  cell type() const { return (header >> 2) & TAG_MASK; }
 
-       cell size() const;
-       cell binary_payload_start() const;
+  void initialize(cell type) { header = type << 2; }
 
-       cell *slots()  const { return (cell *)this; }
+  cell hashcode() const { return (header >> 6); }
 
-       /* Only valid for objects in tenured space; must fast to free_heap_block
-       to do anything with it if its free */
-       bool free_p() const
-       {
-               return h.value & 1 == 1;
-       }
+  void set_hashcode(cell hashcode) {
+    header = (header & 0x3f) | (hashcode << 6);
+  }
+
+  bool forwarding_pointer_p() const { return (header & 2) == 2; }
+
+  object* forwarding_pointer() const { return (object*)UNTAG(header); }
+
+  void forward_to(object* pointer) { header = ((cell)pointer | 2); }
 };
 
-/* Assembly code makes assumptions about the layout of this struct */
+// Assembly code makes assumptions about the layout of this struct
 struct array : public object {
-       static const cell type_number = ARRAY_TYPE;
-       static const cell element_size = sizeof(cell);
-       /* tagged */
-       cell capacity;
+  static const cell type_number = ARRAY_TYPE;
+  static const cell element_size = sizeof(cell);
+  // tagged
+  cell capacity;
 
-       cell *data() const { return (cell *)(this + 1); }
+  cell* data() const { return (cell*)(this + 1); }
 };
 
-/* These are really just arrays, but certain elements have special
-significance */
+// These are really just arrays, but certain elements have special
+// significance
 struct tuple_layout : public array {
-       NO_TYPE_CHECK;
-       /* tagged */
-       cell klass;
-       /* tagged fixnum */
-       cell size;
-       /* tagged fixnum */
-       cell echelon;
+  NO_TYPE_CHECK;
+  // tagged
+  cell klass;
+  // tagged fixnum
+  cell size;
+  // tagged fixnum
+  cell echelon;
 };
 
 struct bignum : public object {
-       static const cell type_number = BIGNUM_TYPE;
-       static const cell element_size = sizeof(cell);
-       /* tagged */
-       cell capacity;
+  static const cell type_number = BIGNUM_TYPE;
+  static const cell element_size = sizeof(cell);
+  // tagged
+  cell capacity;
 
-       cell *data() const { return (cell *)(this + 1); }
+  cell* data() const { return (cell*)(this + 1); }
 };
 
 struct byte_array : public object {
-       static const cell type_number = BYTE_ARRAY_TYPE;
-       static const cell element_size = 1;
-       /* tagged */
-       cell capacity;
+  static const cell type_number = BYTE_ARRAY_TYPE;
+  static const cell element_size = 1;
+  // tagged
+  cell capacity;
 
 #ifndef FACTOR_64
-       cell padding0;
-       cell padding1;
+  cell padding0;
+  cell padding1;
 #endif
 
-       template<typename Scalar> Scalar *data() const { return (Scalar *)(this + 1); }
+  template <typename Scalar> Scalar* data() const {
+    return (Scalar*)(this + 1);
+  }
 };
 
-/* Assembly code makes assumptions about the layout of this struct */
+// Assembly code makes assumptions about the layout of this struct
 struct string : public object {
-       static const cell type_number = STRING_TYPE;
-       /* tagged num of chars */
-       cell length;
-       /* tagged */
-       cell aux;
-       /* tagged */
-       cell hashcode;
-
-       u8 *data() const { return (u8 *)(this + 1); }
-
-       cell nth(cell i) const;
+  static const cell type_number = STRING_TYPE;
+  // tagged num of chars
+  cell length;
+  // tagged
+  cell aux;
+  // tagged
+  cell hashcode;
+
+  uint8_t* data() const { return (uint8_t*)(this + 1); }
 };
 
-/* The compiled code heap is structured into blocks. */
-struct code_block
-{
-       cell header;
-       cell owner; /* tagged pointer to word, quotation or f */
-       cell literals; /* tagged pointer to array or f */
-       cell relocation; /* tagged pointer to byte-array or f */
-
-       bool free_p() const
-       {
-               return header & 1 == 1;
-       }
-
-       code_block_type type() const
-       {
-               return (code_block_type)((header >> 1) & 0x3);
-       }
-
-       void set_type(code_block_type type)
-       {
-               header = ((header & ~0x7) | (type << 1));
-       }
-
-       bool pic_p() const
-       {
-               return type() == code_block_pic;
-       }
-
-       bool optimized_p() const
-       {
-               return type() == code_block_optimized;
-       }
-
-       cell size() const
-       {
-               return header >> 3;
-       }
-
-       void *xt() const
-       {
-               return (void *)(this + 1);
-       }
-};
+struct code_block;
+
+// Assembly code makes assumptions about the layout of this struct:
+//   basis/bootstrap/images/images.factor
+//   basis/compiler/constants/constants.factor
+//   core/bootstrap/primitives.factor
 
-/* Assembly code makes assumptions about the layout of this struct */
 struct word : public object {
-       static const cell type_number = WORD_TYPE;
-       /* TAGGED hashcode */
-       cell hashcode;
-       /* TAGGED word name */
-       cell name;
-       /* TAGGED word vocabulary */
-       cell vocabulary;
-       /* TAGGED definition */
-       cell def;
-       /* TAGGED property assoc for library code */
-       cell props;
-       /* TAGGED alternative entry point for direct non-tail calls. Used for inline caching */
-       cell pic_def;
-       /* TAGGED alternative entry point for direct tail calls. Used for inline caching */
-       cell pic_tail_def;
-       /* TAGGED call count for profiling */
-       cell counter;
-       /* TAGGED machine code for sub-primitive */
-       cell subprimitive;
-       /* UNTAGGED execution token: jump here to execute word */
-       void *xt;
-       /* UNTAGGED compiled code block */
-       code_block *code;
-       /* UNTAGGED profiler stub */
-       code_block *profiling;
+  static const cell type_number = WORD_TYPE;
+  // TAGGED hashcode
+  cell hashcode;
+  // TAGGED word name
+  cell name;
+  // TAGGED word vocabulary
+  cell vocabulary;
+  // TAGGED definition
+  cell def;
+  // TAGGED property assoc for library code
+  cell props;
+  // TAGGED alternative entry point for direct non-tail calls. Used for inline
+  // caching
+  cell pic_def;
+  // TAGGED alternative entry point for direct tail calls. Used for inline
+  // caching
+  cell pic_tail_def;
+  // TAGGED machine code for sub-primitive
+  cell subprimitive;
+  // UNTAGGED entry point: jump here to execute word
+  cell entry_point;
+  // UNTAGGED compiled code block
+
+  // defined in code_blocks.hpp
+  code_block* code() const;
 };
 
-/* Assembly code makes assumptions about the layout of this struct */
+// Assembly code makes assumptions about the layout of this struct
 struct wrapper : public object {
-       static const cell type_number = WRAPPER_TYPE;
-       cell object;
+  static const cell type_number = WRAPPER_TYPE;
+  cell object;
 };
 
-/* Assembly code makes assumptions about the layout of this struct */
+// Assembly code makes assumptions about the layout of this struct
 struct boxed_float : object {
-       static const cell type_number = FLOAT_TYPE;
+  static const cell type_number = FLOAT_TYPE;
 
 #ifndef FACTOR_64
-       cell padding;
+  cell padding;
 #endif
 
-       double n;
+  double n;
 };
 
-/* Assembly code makes assumptions about the layout of this struct */
+// Assembly code makes assumptions about the layout of this struct:
+//   basis/bootstrap/images/images.factor
+//   basis/compiler/constants/constants.factor
+//   core/bootstrap/primitives.factor
+
 struct quotation : public object {
-       static const cell type_number = QUOTATION_TYPE;
-       /* tagged */
-       cell array;
-       /* tagged */
-       cell cached_effect;
-       /* tagged */
-       cell cache_counter;
-       /* UNTAGGED */
-       void *xt;
-       /* UNTAGGED compiled code block */
-       code_block *code;
+  static const cell type_number = QUOTATION_TYPE;
+  // tagged
+  cell array;
+  // tagged
+  cell cached_effect;
+  // tagged
+  cell cache_counter;
+  // UNTAGGED entry point; jump here to call quotation
+  cell entry_point;
+
+  // defined in code_blocks.hpp
+  code_block* code() const;
 };
 
-/* Assembly code makes assumptions about the layout of this struct */
+// Assembly code makes assumptions about the layout of this struct
 struct alien : public object {
-       static const cell type_number = ALIEN_TYPE;
-       /* tagged */
-       cell base;
-       /* tagged */
-       cell expired;
-       /* untagged */
-       cell displacement;
+  static const cell type_number = ALIEN_TYPE;
+  // tagged
+  cell base;
+  // tagged
+  cell expired;
+  // untagged
+  cell displacement;
+  // untagged
+  cell address;
+
+  void update_address() {
+    if (base == false_object)
+      address = displacement;
+    else
+      address = UNTAG(base) + sizeof(byte_array) + displacement;
+  }
 };
 
 struct dll : public object {
-       static const cell type_number = DLL_TYPE;
-       /* tagged byte array holding a C string */
-       cell path;
-       /* OS-specific handle */
-       void *dll;
-};
-
-struct stack_frame
-{
-       void *xt;
-       /* Frame size in bytes */
-       cell size;
+  static const cell type_number = DLL_TYPE;
+  // tagged byte array holding a C string
+  cell path;
+  // OS-specific handle
+  void* handle;
 };
 
 struct callstack : public object {
-       static const cell type_number = CALLSTACK_TYPE;
-       /* tagged */
-       cell length;
-       
-       stack_frame *frame_at(cell offset) const
-       {
-               return (stack_frame *)((char *)(this + 1) + offset);
-       }
-
-       stack_frame *top() const { return (stack_frame *)(this + 1); }
-       stack_frame *bottom() const { return (stack_frame *)((cell)(this + 1) + untag_fixnum(length)); }
+  static const cell type_number = CALLSTACK_TYPE;
+  // tagged
+  cell length;
+
+  cell frame_top_at(cell offset) const {
+    return (cell)(this + 1) + offset;
+  }
+
+  void* top() const { return (void*)(this + 1); }
+  void* bottom() const {
+    return (void*)((cell)(this + 1) + untag_fixnum(length));
+  }
 };
 
 struct tuple : public object {
-       static const cell type_number = TUPLE_TYPE;
-       /* tagged layout */
-       cell layout;
+  static const cell type_number = TUPLE_TYPE;
+  // tagged layout
+  cell layout;
 
-       cell *data() const { return (cell *)(this + 1); }
+  cell* data() const { return (cell*)(this + 1); }
 };
 
+inline static cell tuple_capacity(const tuple_layout *layout) {
+  return untag_fixnum(layout->size);
+}
+
+inline static cell tuple_size(const tuple_layout* layout) {
+  return sizeof(tuple) + tuple_capacity(layout) * sizeof(cell);
+}
+
+inline static cell string_capacity(const string* str) {
+  return untag_fixnum(str->length);
+}
+
+inline static cell string_size(cell size) { return sizeof(string) + size; }
+
 }