@earendil-works/djs 0.0.0-stage → 0.1.0

package/dist/layout.generated.js

@@ -0,0 +1,442 @@
+// Generated from djs-core's heap layout (`heap::layout::layout_json`). Do not edit.
+// Regenerate: DJS_UPDATE_LAYOUT=1 cargo test -p djs-core layout_generated
+export const LAYOUT = {
+    "layoutHash": 3968409435,
+    "magic": 5458500,
+    "headerSize": 8,
+    "header": { "KIND": 0, "GC": 1, "FLAGS": 2, "SIZE": 4 },
+    "value": {
+        "tagPrefix": 65528,
+        "firstRef": 8,
+        "tags": { "UNDEFINED": 1, "NULL": 2, "BOOL": 3, "INT": 4, "HOLE": 5, "UNINITIALIZED": 6, "STRING": 8, "OBJECT": 9, "SYMBOL": 10, "BIGINT": 11, "HOST_REF": 12, "INTERNAL": 13 }
+    },
+    "atom": { "intBit": 2147483648, "symbolBit": 1073741824, "indexMask": 1073741823 },
+    "flags": { "ROPE_TWO_BYTE": 1, "ROPE_FLATTENED": 2, "ROPE_APPEND": 4, "STR_APPEND_BUF": 1, "OBJ_EXTENSIBLE": 1, "OBJ_INDEXED_PROPS": 2, "OBJ_LENGTH_READONLY": 4, "OBJ_DICTIONARY": 128, "BIGINT_NEG": 1 },
+    "objectClasses": { "Ordinary": 0, "Array": 1, "Function": 2, "HostFunction": 3, "Error": 4, "Arguments": 5, "ArrayIterator": 6, "BoundFunction": 7, "Boolean": 8, "Number": 9, "String": 10, "Symbol": 11, "Map": 12, "Set": 13, "WeakMap": 14, "WeakSet": 15, "CollectionIterator": 16, "Promise": 17, "BuiltinClosure": 18, "Record": 19, "Date": 20, "Generator": 21, "ArrayBuffer": 22, "TypedArray": 23, "DataView": 24, "RegExp": 25, "RegExpStringIterator": 26, "Proxy": 27, "IteratorHelper": 28, "RawJSON": 29, "BigInt": 30, "WeakRef": 31, "FinalizationRegistry": 32, "DisposableStack": 33, "CallSite": 34 },
+    "propFlags": { "WRITABLE": 1, "ENUMERABLE": 2, "CONFIGURABLE": 4, "ACCESSOR": 8 },
+    "cells": {
+        "Roots": {
+            "kind": 1,
+            "minSize": 112,
+            "fields": {
+                "MAGIC": { "offset": 8, "type": "u32" },
+                "VERSION": { "offset": 12, "type": "u32" },
+                "ATOMS": { "offset": 16, "type": "Ref" },
+                "STACK": { "offset": 20, "type": "Ref" },
+                "REALM": { "offset": 24, "type": "Value" },
+                "JOBS": { "offset": 32, "type": "Ref" },
+                "HOST_CALLS": { "offset": 36, "type": "Ref" },
+                "HANDLES": { "offset": 40, "type": "Ref" },
+                "INTERP": { "offset": 44, "type": "Ref" },
+                "COMPAT": { "offset": 48, "type": "u32" },
+                "FLAGS": { "offset": 52, "type": "u32" },
+                "GC_THRESHOLD": { "offset": 56, "type": "u32" },
+                "PROTO_EPOCH": { "offset": 60, "type": "u32" },
+                "ROOT_SHAPE": { "offset": 64, "type": "Ref" },
+                "SHAPES": { "offset": 68, "type": "u32" },
+                "OLD_END": { "offset": 72, "type": "u32" },
+                "MINORS": { "offset": 76, "type": "u32" },
+                "BASE_END": { "offset": 80, "type": "u32" },
+                "OPS": { "offset": 84, "type": "u32" },
+                "INTRINSICS": { "offset": 88, "type": "u32" },
+                "RECORDS": { "offset": 92, "type": "u32" },
+                "FEATURES": { "offset": 96, "type": "u32" },
+                "HASH_KEY": { "offset": 104, "type": "u64" }
+            },
+            "tail": null
+        },
+        "Str8": {
+            "kind": 2,
+            "minSize": 16,
+            "fields": {
+                "LEN": { "offset": 8, "type": "u32" },
+                "HASH": { "offset": 12, "type": "u32" }
+            },
+            "tail": {
+                "name": "DATA",
+                "offset": 16,
+                "elem": "u8",
+                "elemSize": 1,
+                "fields": {
+                    "": { "offset": 0, "type": "u8" }
+                }
+            }
+        },
+        "Str16": {
+            "kind": 3,
+            "minSize": 16,
+            "fields": {
+                "LEN": { "offset": 8, "type": "u32" },
+                "HASH": { "offset": 12, "type": "u32" }
+            },
+            "tail": {
+                "name": "DATA",
+                "offset": 16,
+                "elem": "u16",
+                "elemSize": 2,
+                "fields": {
+                    "": { "offset": 0, "type": "u16" }
+                }
+            }
+        },
+        "Rope": {
+            "kind": 4,
+            "minSize": 24,
+            "fields": {
+                "LEN": { "offset": 8, "type": "u32" },
+                "HASH": { "offset": 12, "type": "u32" },
+                "LEFT": { "offset": 16, "type": "Ref" },
+                "RIGHT": { "offset": 20, "type": "Ref" }
+            },
+            "tail": null
+        },
+        "Slice": {
+            "kind": 22,
+            "minSize": 24,
+            "fields": {
+                "LEN": { "offset": 8, "type": "u32" },
+                "HASH": { "offset": 12, "type": "u32" },
+                "PARENT": { "offset": 16, "type": "Ref" },
+                "OFF": { "offset": 20, "type": "u32" }
+            },
+            "tail": null
+        },
+        "Symbol": {
+            "kind": 5,
+            "minSize": 24,
+            "fields": {
+                "ATOM": { "offset": 8, "type": "u32" },
+                "DESCRIPTION": { "offset": 16, "type": "Value" }
+            },
+            "tail": null
+        },
+        "Object": {
+            "kind": 6,
+            "minSize": 24,
+            "fields": {
+                "CLASS": { "offset": 8, "type": "u32" },
+                "PROTO": { "offset": 12, "type": "Ref" },
+                "PROPS": { "offset": 16, "type": "Ref" },
+                "ELEMENTS": { "offset": 20, "type": "Ref" }
+            },
+            "tail": {
+                "name": "SLOTS",
+                "offset": 24,
+                "elem": "Value",
+                "elemSize": 8,
+                "fields": {
+                    "": { "offset": 0, "type": "Value" }
+                }
+            }
+        },
+        "PropTable": {
+            "kind": 7,
+            "minSize": 24,
+            "fields": {
+                "COUNT": { "offset": 8, "type": "u32" },
+                "DELETED": { "offset": 12, "type": "u32" },
+                "INDEX": { "offset": 16, "type": "Ref" }
+            },
+            "tail": {
+                "name": "ENTRIES",
+                "offset": 24,
+                "elem": "PropEntry",
+                "elemSize": 16,
+                "fields": {
+                    "KEY": { "offset": 0, "type": "u32" },
+                    "FLAGS": { "offset": 4, "type": "u32" },
+                    "VALUE": { "offset": 8, "type": "Value" }
+                }
+            }
+        },
+        "ValueArray": {
+            "kind": 8,
+            "minSize": 16,
+            "fields": {
+                "LEN": { "offset": 8, "type": "u32" }
+            },
+            "tail": {
+                "name": "VALUES",
+                "offset": 16,
+                "elem": "Value",
+                "elemSize": 8,
+                "fields": {
+                    "": { "offset": 0, "type": "Value" }
+                }
+            }
+        },
+        "U32Array": {
+            "kind": 9,
+            "minSize": 16,
+            "fields": {
+                "LEN": { "offset": 8, "type": "u32" }
+            },
+            "tail": {
+                "name": "DATA",
+                "offset": 12,
+                "elem": "u32",
+                "elemSize": 4,
+                "fields": {
+                    "": { "offset": 0, "type": "u32" }
+                }
+            }
+        },
+        "AtomTable": {
+            "kind": 10,
+            "minSize": 32,
+            "fields": {
+                "STRINGS": { "offset": 8, "type": "u32" },
+                "ENTRIES": { "offset": 12, "type": "Ref" },
+                "INDEX": { "offset": 16, "type": "Ref" },
+                "BASE_ENTRIES": { "offset": 20, "type": "Ref" },
+                "BASE_INDEX": { "offset": 24, "type": "Ref" },
+                "BASE_COUNT": { "offset": 28, "type": "u32" }
+            },
+            "tail": null
+        },
+        "HandleTable": {
+            "kind": 11,
+            "minSize": 24,
+            "fields": {
+                "LEN": { "offset": 8, "type": "u32" },
+                "FREE": { "offset": 12, "type": "u32" },
+                "LIVE": { "offset": 16, "type": "u32" }
+            },
+            "tail": {
+                "name": "SLOTS",
+                "offset": 24,
+                "elem": "HandleSlot",
+                "elemSize": 16,
+                "fields": {
+                    "VALUE": { "offset": 0, "type": "Value" },
+                    "NEXT": { "offset": 8, "type": "u32" }
+                }
+            }
+        },
+        "FuncTemplate": {
+            "kind": 12,
+            "minSize": 48,
+            "fields": {
+                "NO_ELEMENTS": { "offset": 8, "type": "u32" },
+                "NAME": { "offset": 12, "type": "u32" },
+                "PARAMS": { "offset": 16, "type": "u16" },
+                "LENGTH": { "offset": 18, "type": "u16" },
+                "LOCALS": { "offset": 20, "type": "u16" },
+                "STACK": { "offset": 22, "type": "u16" },
+                "CAPTURES": { "offset": 24, "type": "u16" },
+                "IC_COUNT": { "offset": 26, "type": "u16" },
+                "CODE_LEN": { "offset": 28, "type": "u32" },
+                "CONSTS": { "offset": 32, "type": "Ref" },
+                "IC": { "offset": 36, "type": "Ref" },
+                "INFO": { "offset": 40, "type": "Ref" },
+                "FLAGS": { "offset": 44, "type": "u16" },
+                "NATIVE": { "offset": 46, "type": "u8" },
+                "FAST": { "offset": 47, "type": "u8" }
+            },
+            "tail": {
+                "name": "DATA",
+                "offset": 48,
+                "elem": "u8",
+                "elemSize": 1,
+                "fields": {
+                    "": { "offset": 0, "type": "u8" }
+                }
+            }
+        },
+        "Script": {
+            "kind": 13,
+            "minSize": 24,
+            "fields": {
+                "NAME": { "offset": 8, "type": "Ref" },
+                "SOURCE": { "offset": 12, "type": "Ref" },
+                "OPTIONS": { "offset": 16, "type": "u32" },
+                "PARAMS": { "offset": 20, "type": "Ref" }
+            },
+            "tail": null
+        },
+        "BoxCell": {
+            "kind": 14,
+            "minSize": 16,
+            "fields": {
+                "VALUE": { "offset": 8, "type": "Value" }
+            },
+            "tail": null
+        },
+        "Bytes": {
+            "kind": 15,
+            "minSize": 16,
+            "fields": {
+                "LEN": { "offset": 8, "type": "u32" }
+            },
+            "tail": {
+                "name": "DATA",
+                "offset": 12,
+                "elem": "u8",
+                "elemSize": 1,
+                "fields": {
+                    "": { "offset": 0, "type": "u8" }
+                }
+            }
+        },
+        "RefArray": {
+            "kind": 16,
+            "minSize": 16,
+            "fields": {
+                "LEN": { "offset": 8, "type": "u32" }
+            },
+            "tail": {
+                "name": "REFS",
+                "offset": 12,
+                "elem": "Ref",
+                "elemSize": 4,
+                "fields": {
+                    "": { "offset": 0, "type": "Ref" }
+                }
+            }
+        },
+        "FuncInfo": {
+            "kind": 21,
+            "minSize": 32,
+            "fields": {
+                "SCRIPT": { "offset": 8, "type": "Ref" },
+                "SRC_START": { "offset": 12, "type": "u32" },
+                "SRC_END": { "offset": 16, "type": "u32" },
+                "LINES": { "offset": 20, "type": "Ref" },
+                "NAMES": { "offset": 24, "type": "Ref" },
+                "CHILD_COUNT": { "offset": 28, "type": "u32" }
+            },
+            "tail": {
+                "name": "CHILDREN",
+                "offset": 32,
+                "elem": "Ref",
+                "elemSize": 4,
+                "fields": {
+                    "": { "offset": 0, "type": "Ref" }
+                }
+            }
+        },
+        "Interp": {
+            "kind": 17,
+            "minSize": 88,
+            "fields": {
+                "STATE": { "offset": 8, "type": "u32" },
+                "BP": { "offset": 12, "type": "u32" },
+                "HP": { "offset": 16, "type": "u32" },
+                "SP": { "offset": 20, "type": "u32" },
+                "PC": { "offset": 24, "type": "u32" },
+                "HOST_CALL": { "offset": 28, "type": "u32" },
+                "NEXT_CALL_ID": { "offset": 32, "type": "u32" },
+                "FLAGS": { "offset": 36, "type": "u32" },
+                "RESULT": { "offset": 40, "type": "Value" },
+                "OUTCOME": { "offset": 48, "type": "u32" },
+                "JOB_HEAD": { "offset": 52, "type": "u32" },
+                "THROW": { "offset": 56, "type": "Value" },
+                "REJECTIONS": { "offset": 64, "type": "Ref" },
+                "REPORTED": { "offset": 68, "type": "u32" },
+                "INBOX": { "offset": 72, "type": "Ref" },
+                "INBOX_HEAD": { "offset": 76, "type": "u32" },
+                "FUEL_DEBT": { "offset": 80, "type": "Value" }
+            },
+            "tail": null
+        },
+        "Realm": {
+            "kind": 18,
+            "minSize": 16,
+            "fields": {
+                "GLOBAL_LEX": { "offset": 8, "type": "Ref" },
+                "INSTALLED": { "offset": 12, "type": "Ref" }
+            },
+            "tail": {
+                "name": "INTRINSICS",
+                "offset": 16,
+                "elem": "Value",
+                "elemSize": 8,
+                "fields": {
+                    "": { "offset": 0, "type": "Value" }
+                }
+            }
+        },
+        "HostCall": {
+            "kind": 19,
+            "minSize": 48,
+            "fields": {
+                "ID": { "offset": 8, "type": "u32" },
+                "FN": { "offset": 12, "type": "u32" },
+                "ARGS": { "offset": 16, "type": "Ref" },
+                "THIS": { "offset": 24, "type": "Value" },
+                "PROMISE": { "offset": 32, "type": "Value" },
+                "FLAGS": { "offset": 40, "type": "u32" }
+            },
+            "tail": null
+        },
+        "EphemeronArray": {
+            "kind": 20,
+            "minSize": 16,
+            "fields": {
+                "LEN": { "offset": 8, "type": "u32" }
+            },
+            "tail": {
+                "name": "VALUES",
+                "offset": 16,
+                "elem": "Value",
+                "elemSize": 8,
+                "fields": {
+                    "": { "offset": 0, "type": "Value" }
+                }
+            }
+        },
+        "AccessorPair": {
+            "kind": 25,
+            "minSize": 24,
+            "fields": {
+                "GETTER": { "offset": 8, "type": "Value" },
+                "SETTER": { "offset": 16, "type": "Value" }
+            },
+            "tail": null
+        },
+        "Shape": {
+            "kind": 26,
+            "minSize": 24,
+            "fields": {
+                "PARENT": { "offset": 8, "type": "Ref" },
+                "DESCS": { "offset": 12, "type": "Ref" },
+                "COUNT": { "offset": 16, "type": "u32" },
+                "TRANSITIONS": { "offset": 20, "type": "Ref" }
+            },
+            "tail": null
+        },
+        "PropValues": {
+            "kind": 27,
+            "minSize": 16,
+            "fields": {
+                "SHAPE": { "offset": 8, "type": "Ref" },
+                "LEN": { "offset": 12, "type": "u32" }
+            },
+            "tail": {
+                "name": "VALUES",
+                "offset": 16,
+                "elem": "Value",
+                "elemSize": 8,
+                "fields": {
+                    "": { "offset": 0, "type": "Value" }
+                }
+            }
+        },
+        "BigInt": {
+            "kind": 24,
+            "minSize": 16,
+            "fields": {
+                "LEN": { "offset": 8, "type": "u32" }
+            },
+            "tail": {
+                "name": "LIMBS",
+                "offset": 12,
+                "elem": "u32",
+                "elemSize": 4,
+                "fields": {
+                    "": { "offset": 0, "type": "u32" }
+                }
+            }
+        }
+    }
+};

package/dist/reader.d.ts

@@ -0,0 +1,47 @@
+/**
+ * A VM value with no host equivalent: a symbol, a function or other non-plain object, a
+ * host ref or an internal value (BigInts are read as native bigints). `ref` is the arena offset of its cell (0 if none).
+ */
+export declare class Opaque {
+    readonly type: string;
+    readonly ref: number;
+    /** The object class (`Function`, `Error`, ...) for objects. */
+    readonly className?: string;
+    /** A symbol's description. */
+    readonly description?: string;
+    constructor(type: string, ref: number, className?: string, description?: string);
+}
+export interface ReadOptions {
+    /** Use only standard APIs (TextDecoder, String.fromCharCode), not node's Buffer. */
+    portable?: boolean;
+    /**
+     * The most values (containers and elements) to produce. Shared references are read
+     * once per occurrence, so a heap with sharing at every level could otherwise expand
+     * exponentially. Default: four times the arena's value slots, plus a million.
+     */
+    maxValues?: number;
+    /**
+     * Atom index -> key string, filled while reading. Reusing one array across reads of the
+     * same VM is safe: atoms are never freed and their strings never change.
+     */
+    atomCache?: (string | undefined)[];
+}
+/** Thrown when the memory does not hold a heap of this build's layout. */
+export declare class LayoutMismatch extends Error {
+}
+/**
+ * Checks that `memory` holds a djs heap with the layout this reader was generated for
+ * (the magic and `LAYOUT_HASH` in the roots cell).
+ */
+export declare function checkHeap(memory: Uint8Array): void;
+/**
+ * Decodes the VM value `value` (its 64 bits, or `[lo, hi]` as two u32) from the heap arena
+ * `memory` (offset 0 of the view is the arena start, i.e. the roots cell).
+ *
+ * Primitives map to themselves; strings (flat or ropes) to strings; arrays to arrays (holes
+ * stay holes); ordinary objects to plain objects with their own enumerable string-keyed data
+ * properties in property order. Accessors, non-enumerable and symbol-keyed properties are
+ * left out. Everything else becomes an {@link Opaque}. The result is a tree, as with JSON:
+ * a shared object is read once per reference, and a cycle is a TypeError naming its path.
+ */
+export declare function readValue(memory: Uint8Array, value: bigint | readonly [number, number], opts?: ReadOptions): unknown;