]> gitweb.factorcode.org Git - factor.git/blobdiff - vm/objects.hpp
webapps.wiki: adding search bar
[factor.git] / vm / objects.hpp
index b792763f1f861a1853e88611a4d084e91dbc620d..a51e198a44c2e72999c8f66e3c7bb6a826973bb6 100644 (file)
@@ -2,38 +2,37 @@ namespace factor {
 
 // Special object count and identifiers must be kept in sync with:
 //   core/kernel/kernel.factor
-//   core/bootstrap/image/image.factor
+//   basis/bootstrap/image/image.factor
 
-static const cell special_object_count = 80;
+static const cell special_object_count = 85;
 
 enum special_object {
-  OBJ_WALKER_HOOK = 3, /* non-local exit hook, used by library only */
-  OBJ_CALLCC_1,        /* used to pass the value in callcc1 */
+  OBJ_WALKER_HOOK = 3, // non-local exit hook, used by library only
+  OBJ_CALLCC_1,        // used to pass the value in callcc1
 
-  ERROR_HANDLER_QUOT = 5, /* quotation called when VM throws an error */
-  OBJ_ERROR,              /* a marker consed onto kernel errors */
+  ERROR_HANDLER_QUOT = 5, // quotation called when VM throws an error
 
-  OBJ_CELL_SIZE = 7, /* sizeof(cell) */
-  OBJ_CPU,           /* CPU architecture */
-  OBJ_OS,            /* operating system name */
+  OBJ_CELL_SIZE = 7, // sizeof(cell)
+  OBJ_CPU,           // CPU architecture
+  OBJ_OS,            // operating system name
 
-  OBJ_ARGS = 10, /* command line arguments */
-  OBJ_STDIN,     /* stdin FILE* handle */
-  OBJ_STDOUT,    /* stdout FILE* handle */
+  OBJ_ARGS = 10, // command line arguments
+  OBJ_STDIN,     // stdin FILE* handle
+  OBJ_STDOUT,    // stdout FILE* handle
 
-  OBJ_IMAGE = 13, /* image path name */
-  OBJ_EXECUTABLE, /* runtime executable path name */
+  OBJ_IMAGE = 13, // image path name
+  OBJ_EXECUTABLE, // runtime executable path name
 
-  OBJ_EMBEDDED = 15,  /* are we embedded in another app? */
-  OBJ_EVAL_CALLBACK,  /* used when Factor is embedded in a C app */
-  OBJ_YIELD_CALLBACK, /* used when Factor is embedded in a C app */
-  OBJ_SLEEP_CALLBACK, /* used when Factor is embedded in a C app */
+  OBJ_EMBEDDED = 15,  // are we embedded in another app?
+  OBJ_EVAL_CALLBACK,  // used when Factor is embedded in a C app
+  OBJ_YIELD_CALLBACK, // used when Factor is embedded in a C app
+  OBJ_SLEEP_CALLBACK, // used when Factor is embedded in a C app
 
-  OBJ_STARTUP_QUOT = 20, /* startup quotation */
-  OBJ_GLOBAL,            /* global namespace */
-  OBJ_SHUTDOWN_QUOT,     /* shutdown quotation */
+  OBJ_STARTUP_QUOT = 20, // startup quotation
+  OBJ_GLOBAL,            // global namespace
+  OBJ_SHUTDOWN_QUOT,     // shutdown quotation
 
-  /* Quotation compilation in quotations.c */
+  // Quotation compilation in quotations.cpp
   JIT_PROLOG = 23,
   JIT_PRIMITIVE_WORD,
   JIT_PRIMITIVE,
@@ -44,8 +43,8 @@ enum special_object {
   JIT_SAFEPOINT,
   JIT_EPILOG,
   JIT_RETURN,
-  JIT_PROFILING,
-  JIT_PUSH_IMMEDIATE,
+  JIT_UNUSED,
+  JIT_PUSH_LITERAL,
   JIT_DIP_WORD,
   JIT_DIP,
   JIT_2DIP_WORD,
@@ -55,7 +54,8 @@ enum special_object {
   JIT_EXECUTE,
   JIT_DECLARE_WORD,
 
-  /* External entry points */
+  // External entry points. These are defined in the files in
+  // bootstrap/assembler/
   C_TO_FACTOR_WORD = 43,
   LAZY_JIT_COMPILE_WORD,
   UNWIND_NATIVE_FRAMES_WORD,
@@ -63,17 +63,20 @@ enum special_object {
   SET_FPU_STATE_WORD,
   SIGNAL_HANDLER_WORD,
   LEAF_SIGNAL_HANDLER_WORD,
-  FFI_SIGNAL_HANDLER_WORD,
-  FFI_LEAF_SIGNAL_HANDLER_WORD,
+  WIN_EXCEPTION_HANDLER,
 
-  /* Incremented on every modify-code-heap call; invalidates call( inline
-     caching */
+  // Vector used by the sampling profiler to store collected call
+  // frames.
+  OBJ_SAMPLE_CALLSTACKS = 51,
+
+  // Incremented on every modify-code-heap call; invalidates call(
+  // inline caching
   REDEFINITION_COUNTER = 52,
 
-  /* Callback stub generation in callbacks.c */
+  // Callback stub generation in callbacks.cpp
   CALLBACK_STUB = 53,
 
-  /* Polymorphic inline cache generation in inline_cache.c */
+  // Polymorphic inline cache generation in inline_cache.cpp
   PIC_LOAD = 54,
   PIC_TAG,
   PIC_TUPLE,
@@ -83,16 +86,16 @@ enum special_object {
   PIC_MISS_WORD,
   PIC_MISS_TAIL_WORD,
 
-  /* Megamorphic cache generation in dispatch.c */
+  // Megamorphic cache generation in dispatch.cpp
   MEGA_LOOKUP = 62,
   MEGA_LOOKUP_WORD,
   MEGA_MISS_WORD,
 
-  OBJ_UNDEFINED = 65, /* default quotation for undefined words */
+  OBJ_UNDEFINED = 65, // default quotation for undefined words
 
-  OBJ_STDERR = 66, /* stderr FILE* handle */
+  OBJ_STDERR = 66, // stderr FILE* handle
 
-  OBJ_STAGE2 = 67, /* have we bootstrapped? */
+  OBJ_STAGE2 = 67, // have we bootstrapped?
 
   OBJ_CURRENT_THREAD = 68,
 
@@ -100,33 +103,43 @@ enum special_object {
   OBJ_RUN_QUEUE = 70,
   OBJ_SLEEP_QUEUE = 71,
 
-  OBJ_VM_COMPILER = 72, /* version string of the compiler we were built with */
+  OBJ_VM_COMPILER = 72, // version string of the compiler we were built with
 
   OBJ_WAITING_CALLBACKS = 73,
 
-  OBJ_SIGNAL_PIPE = 74, /* file descriptor for pipe used to communicate signals
-                           only used on unix */
-};
+  OBJ_SIGNAL_PIPE = 74, // file descriptor for pipe used to communicate signals
+                        //  only used on unix
+  OBJ_VM_COMPILE_TIME = 75, // when the binary was built
+  OBJ_VM_VERSION = 76, // factor version
+  OBJ_VM_GIT_LABEL = 77, // git label (git describe --all --long)
 
-/* save-image-and-exit discards special objects that are filled in on startup
-   anyway, to reduce image size */
-#define OBJ_FIRST_SAVE OBJ_STARTUP_QUOT
-#define OBJ_LAST_SAVE OBJ_STAGE2
+  // Canonical truth value. In Factor, 't'
+  OBJ_CANONICAL_TRUE = 78,
 
+  // Canonical bignums. These needs to be kept in the image in case
+  // some heap objects refer to them.
+  OBJ_BIGNUM_ZERO,
+  OBJ_BIGNUM_POS_ONE,
+  OBJ_BIGNUM_NEG_ONE = 81,
+};
+
+// save-image-and-exit discards special objects that are filled in on startup
+// anyway, to reduce image size
 inline static bool save_special_p(cell i) {
-  return (i >= OBJ_FIRST_SAVE && i <= OBJ_LAST_SAVE);
+  // Need to fix the order here.
+  return (i >= OBJ_STARTUP_QUOT && i <= LEAF_SIGNAL_HANDLER_WORD) ||
+      (i >= REDEFINITION_COUNTER && i <= OBJ_UNDEFINED) ||
+      i == OBJ_STAGE2 ||
+      (i >= OBJ_CANONICAL_TRUE && i <= OBJ_BIGNUM_NEG_ONE);
 }
 
 template <typename Iterator> void object::each_slot(Iterator& iter) {
-  cell scan = (cell) this;
-  cell payload_start = binary_payload_start();
-  cell end = scan + payload_start;
-
-  scan += sizeof(cell);
+  cell* start = (cell*)this + 1;
+  cell* end = start + slot_count();
 
-  while (scan < end) {
-    iter((cell*)scan);
-    scan += sizeof(cell);
+  while (start < end) {
+    iter(start);
+    start++;
   }
 }