@swf2es/runtime 0.0.0-stage → 0.1.1

package/dist/avm2/natives/sync.d.ts

@@ -0,0 +1,215 @@
+/** The memory every thread of a primordial's shares, plain data a structured clone carries. */
+export interface SyncMemory {
+    /** The heap: its header, then blocks, each a power of two words. */
+    heap: SharedArrayBuffer | ArrayBuffer;
+    /** Two words a thread, by its worker's number: whether it is blocked in a wait, and whether it runs or has ended. */
+    threads: SharedArrayBuffer | ArrayBuffer;
+}
+/** How a runtime takes part: the memory, and the worker it runs. */
+export interface SyncInit {
+    memory: SyncMemory;
+    /** Its worker's number, 0 being the primordial. */
+    thread: number;
+    /**
+     * Spin rather than block even where the thread could, as a browser's
+     * main thread must: for tests of the spinning path.
+     */
+    spin?: boolean;
+    /** How long a spinning lock or wait may take before it fails, in milliseconds: Flash's 15 s by default. */
+    timeout?: number;
+}
+/** Flash's script timeout, which a primordial that blocks too long hits. */
+export declare const SCRIPT_TIMEOUT = 15000;
+/** New memory for a primordial's workers: shared where it can be, else this thread's alone. */
+export declare function newSyncMemory(): SyncMemory;
+/**
+ * What a terminated worker's thread gets for anything it asks of the shared
+ * memory while it still runs: it changes nothing there any more, and its
+ * code stops, as avmplus interrupts a terminated worker.
+ */
+export declare class SyncTerminated extends Error {
+    constructor();
+}
+/** The shared heap has no room for a block, or a block would be larger than it. */
+export declare class SyncFull extends RangeError {
+    constructor();
+}
+/** A lock or wait that spun for longer than the script timeout. */
+export declare class SyncTimeout extends Error {
+    constructor();
+}
+/** The shared heap as one thread sees it. */
+export declare class Sync {
+    readonly memory: SyncMemory;
+    readonly thread: number;
+    readonly words: Int32Array;
+    readonly bytes: Uint8Array;
+    private readonly threads;
+    /** Whether other threads see this memory: else nothing else can take a lock or notify. */
+    readonly shared: boolean;
+    /** Whether this thread blocks in Atomics.wait, or spins. */
+    readonly waits: boolean;
+    readonly timeout: number;
+    private record;
+    /** See spinningSince. */
+    private spinning;
+    /**
+     * What this thread does whenever it waits, between waits of no more
+     * than a few milliseconds: the primordial takes its requests then, as
+     * a background worker that asks for a worker may be what it waits for.
+     */
+    poll: (() => void) | null;
+    /** Whether a refused thread's code has ended with it (see refuse). */
+    private readonly selfEnds;
+    constructor(memory: SyncMemory, thread: number, options?: {
+        spin?: boolean;
+        timeout?: number;
+        selfEnds?: boolean;
+    });
+    /** A number for a new worker, unique among the primordial's whichever thread makes it, with room in the threads' table. */
+    newThread(): number;
+    /** The shared table's version, which every change moves on. */
+    tableVersion(): number;
+    /** The shared table's bytes, and their version. */
+    readTable(): {
+        version: number;
+        bytes: Uint8Array;
+    };
+    /** Replace the shared table's bytes with what `f` makes of them, in one step every thread sees. */
+    updateTable(f: (bytes: Uint8Array) => Uint8Array): void;
+    /** A number never given out before, for an entry of the table. */
+    nextToken(): number;
+    private tableBytes;
+    /** The primordial's queue of requests, once it has made it; 0 before. */
+    get requests(): number;
+    set requests(q: number);
+    /** Make room for worker `id` in the threads' table, before it starts. */
+    addThread(id: number): void;
+    private stateOf;
+    /** Whether worker `id` is neither terminated nor ended: a notify may pick it, a queue waits for it. */
+    alive(id: number): boolean;
+    /**
+     * Whether worker `id`'s thread has stopped, or ended its code: a lock it
+     * holds is free to take. A worker terminated while its thread may still
+     * run is not, as it may still be writing what the lock guards.
+     */
+    stopped(id: number): boolean;
+    /** Whether worker `id` has started and not ended, as its own thread says. */
+    running(id: number): boolean;
+    /** Worker `id`, this thread's, runs; unless it has ended already. */
+    start(id: number): void;
+    /**
+     * Worker `id` was terminated: no notify picks it, no queue waits for it,
+     * and its thread, while it still runs, gets SyncTerminated for anything
+     * it asks of this memory. The locks it holds stay held until end.
+     */
+    stop(id: number): void;
+    /**
+     * Worker `id`'s thread has stopped, or the worker has ended its own code:
+     * the locks it held are free to take. Only the thread itself, or one that
+     * knows it has stopped, may say so.
+     */
+    end(id: number): void;
+    /**
+     * Refuse anything more of a thread whose worker was terminated: the
+     * script that asked stops here, as avmplus interrupts a terminated worker
+     * that waits (the runtime lets no script catch the error). Where that
+     * ends all of the worker's code, as an avmshell worker's (`selfEnds`),
+     * the locks it holds are free to take from now on, as avmplus lets go of
+     * them when the worker goes; a player's worker plays on to the end of its
+     * frame, and says it has stopped itself (end) once no code of it can run.
+     */
+    private refuse;
+    /** Whether this thread's worker was terminated, which the next thing it asks of this memory says too. */
+    get terminated(): boolean;
+    /** Wait until worker `id`'s thread says it has stopped, up to `ms`; whether it has. */
+    waitStopped(id: number, ms: number): boolean;
+    /** A block of at least `n` words, zeroed: the address of its first. */
+    alloc(n: number): number;
+    free(address: number): void;
+    /**
+     * Take the lock in word `index`, which holds its holder's number plus
+     * one; from a holder whose thread has stopped, at once. `start` is when the
+     * operation began, for the script timeout of a thread that spins.
+     */
+    acquire(index: number, start: number): void;
+    /** Take the lock in word `index` if it is free, or its holder's thread has stopped. */
+    tryAcquire(index: number): boolean;
+    /** Let go of the lock in word `index`, unless another thread has taken it over meanwhile. */
+    release(index: number): void;
+    /**
+     * Wait up to `ms` while word `index` holds `value`: Atomics.wait where
+     * this thread can, else spinning on it with a backoff that never sleeps,
+     * failing with SyncTimeout once this thread has spun for longer than the
+     * script timeout without returning to its event loop, as Flash times a
+     * script out: content that waits a millisecond at a time in a loop, as
+     * Crossbridge's startup does, is stopped too. Where there is no event
+     * loop to tell, from `start`, when the operation began.
+     */
+    park(index: number, value: number, ms: number, start: number): void;
+    /** Whether worker `id` is blocked in a lock or a wait now. */
+    blocked(id: number): boolean;
+    private spinOrWait;
+    /** When this thread began to spin since it last returned to its event loop. */
+    private spinningSince;
+    newMutex(): number;
+    /** Whether this thread holds the mutex at `m`. */
+    holds(m: number): boolean;
+    /**
+     * As avmplus' MutexObject::lock: held again by its holder, or taken in
+     * the order the threads came for it. A thread that ended leaves the
+     * queue to the next, and the mutex if it held it.
+     */
+    lock(m: number): void;
+    /** As MutexObject::tryLock: never while another thread waits for it, as avmplus' hasWaiters. */
+    tryLock(m: number): boolean;
+    /** Whether this thread held it, once less now. */
+    unlock(m: number): boolean;
+    /** Add record `r` at the end of the queue of the threads waiting for mutex `m`. */
+    private enqueue;
+    /** The first thread waiting for mutex `m` that has not ended, those that ended taken out; 0 for none. */
+    private waiter;
+    /** Take record `r` from the head of mutex `m`'s queue, if it is still there. */
+    private dequeue;
+    /** Wait, this thread's record in mutex `m`'s queue, until it is first and takes the mutex. */
+    private takeTurn;
+    newCondition(m: number): number;
+    conditionMutex(c: number): number;
+    /**
+     * As avmplus' ConditionObject::wait, its mutex held by this thread: the
+     * mutex let go, however many times it was held, until a notify picks
+     * this thread or `ms` have passed (never, for -1), then held again as
+     * it was. A notify picks the waiters in the order they came, and they
+     * take the mutex again in that order. Whether the time ran out.
+     */
+    wait(c: number, ms: number): boolean;
+    /**
+     * Pick the first waiter that has not ended or timed out, or all of them,
+     * the mutex held by this thread: each moves to the mutex's queue, to take
+     * it in turn once this thread lets go of it.
+     */
+    notify(c: number, all: boolean): void;
+    /**
+     * Run `f`, which may leave this thread's record in a queue: one it
+     * leaves for the script timeout is given up, its owner none, so that
+     * the queue passes over it, and the next wait or lock makes another.
+     */
+    private timed;
+    /** This thread's record, made once, and again after a timeout gave it up. */
+    private ownRecord;
+    /** Take record `r`, whose wait timed out, from the queue of `c`, if a notify has not passed over it. */
+    private unqueue;
+    newQueue(): number;
+    /** How many entries queue `q` holds. */
+    queued(q: number): number;
+    closed(q: number): boolean;
+    /** Add `bytes` at the end of queue `q`, waking a thread that waits on it. */
+    push(q: number, bytes: Uint8Array): void;
+    /** Take the first entry of queue `q`, if it has one. */
+    shift(q: number): Uint8Array | null;
+    /** Mark queue `q` closed, waking a thread that waits on it. */
+    close(q: number): void;
+    /** Block until queue `q` holds an entry or is closed. */
+    waitFor(q: number): void;
+}
+//# sourceMappingURL=sync.d.ts.map

package/dist/avm2/natives/sync.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sync.d.ts","sourceRoot":"","sources":["../../../src/avm2/natives/sync.ts"],"names":[],"mappings":"AAmBA,+FAA+F;AAC/F,MAAM,WAAW,UAAU;IACzB,oEAAoE;IACpE,IAAI,EAAE,iBAAiB,GAAG,WAAW,CAAC;IACtC,qHAAqH;IACrH,OAAO,EAAE,iBAAiB,GAAG,WAAW,CAAC;CAC1C;AAED,oEAAoE;AACpE,MAAM,WAAW,QAAQ;IACvB,MAAM,EAAE,UAAU,CAAC;IACnB,mDAAmD;IACnD,MAAM,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,2GAA2G;IAC3G,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,4EAA4E;AAC5E,eAAO,MAAM,cAAc,QAAQ,CAAC;AA0HpC,+FAA+F;AAC/F,wBAAgB,aAAa,IAAI,UAAU,CAO1C;AAkBD;;;;GAIG;AACH,qBAAa,cAAe,SAAQ,KAAK;IACvC,cAEC;CACF;AAED,mFAAmF;AACnF,qBAAa,QAAS,SAAQ,UAAU;IACtC,cAEC;CACF;AAED,mEAAmE;AACnE,qBAAa,WAAY,SAAQ,KAAK;IACpC,cAEC;CACF;AAED,6CAA6C;AAC7C,qBAAa,IAAI;IAuBb,QAAQ,CAAC,MAAM,EAAE,UAAU;IAC3B,QAAQ,CAAC,MAAM,EAAE,MAAM;IAvBzB,QAAQ,CAAC,KAAK,EAAE,UAAU,CAAC;IAC3B,QAAQ,CAAC,KAAK,EAAE,UAAU,CAAC;IAC3B,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAa;IACrC,0FAA0F;IAC1F,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;IACzB,4DAA4D;IAC5D,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC;IACxB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,OAAO,CAAC,MAAM,CAAK;IACnB,yBAAyB;IACzB,OAAO,CAAC,QAAQ,CAAuB;IACvC;;;;OAIG;IACH,IAAI,EAAE,CAAC,MAAM,IAAI,CAAC,GAAG,IAAI,CAAQ;IAEjC,sEAAsE;IACtE,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAU;IAEnC,YACW,MAAM,EAAE,UAAU,EAClB,MAAM,EAAE,MAAM,EACvB,OAAO,GAAE;QAAE,IAAI,CAAC,EAAE,OAAO,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,OAAO,CAAA;KAAO,EAWvE;IAED,2HAA2H;IAC3H,SAAS,IAAI,MAAM,CAIlB;IAED,+DAA+D;IAC/D,YAAY,IAAI,MAAM,CAErB;IAED,mDAAmD;IACnD,SAAS,IAAI;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,UAAU,CAAA;KAAE,CAOlD;IAED,mGAAmG;IACnG,WAAW,CAAC,CAAC,EAAE,CAAC,KAAK,EAAE,UAAU,KAAK,UAAU,GAAG,IAAI,CAetD;IAED,kEAAkE;IAClE,SAAS,IAAI,MAAM,CAElB;IAED,OAAO,CAAC,UAAU;IAUlB,yEAAyE;IACzE,IAAI,QAAQ,IAAI,MAAM,CAErB;IAED,IAAI,QAAQ,CAAC,CAAC,EAAE,MAAM,EAErB;IAED,yEAAyE;IACzE,SAAS,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI,CAE1B;IAED,OAAO,CAAC,OAAO;IAIf,uGAAuG;IACvG,KAAK,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAOzB;IAED;;;;OAIG;IACH,OAAO,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAE3B;IAED,6EAA6E;IAC7E,OAAO,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAE3B;IAED,qEAAqE;IACrE,KAAK,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI,CAGtB;IAED;;;;OAIG;IACH,IAAI,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI,CAKrB;IAED;;;;OAIG;IACH,GAAG,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI,CAIpB;IAED;;;;;;;;OAQG;IACH,OAAO,CAAC,MAAM;IAad,yGAAyG;IACzG,IAAI,UAAU,IAAI,OAAO,CAGxB;IAED,uFAAuF;IACvF,WAAW,CAAC,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAe3C;IAED,uEAAuE;IACvE,KAAK,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAgCvB;IAED,IAAI,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAU1B;IAED;;;;OAIG;IACH,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,CAkB1C;IAED,uFAAuF;IACvF,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CASjC;IAED,6FAA6F;IAC7F,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAI3B;IAED;;;;;;;;OAQG;IACH,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,CASlE;IAED,8DAA8D;IAC9D,OAAO,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAE3B;IAED,OAAO,CAAC,UAAU;IA+BlB,+EAA+E;IAC/E,OAAO,CAAC,aAAa;IAkBrB,QAAQ,IAAI,MAAM,CAEjB;IAED,kDAAkD;IAClD,KAAK,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAExB;IAED;;;;OAIG;IACH,IAAI,CAAC,CAAC,EAAE,MAAM,GAAG,IAAI,CAapB;IAED,gGAAgG;IAChG,OAAO,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAgB1B;IAED,kDAAkD;IAClD,MAAM,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAYzB;IAED,mFAAmF;IACnF,OAAO,CAAC,OAAO;IAkBf,yGAAyG;IACzG,OAAO,CAAC,MAAM;IAYd,gFAAgF;IAChF,OAAO,CAAC,OAAO;IAkBf,8FAA8F;IAC9F,OAAO,CAAC,QAAQ;IAahB,YAAY,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAI9B;IAED,cAAc,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAEhC;IAED;;;;;;OAMG;IACH,IAAI,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAmDnC;IAED;;;;OAIG;IACH,MAAM,CAAC,CAAC,EAAE,MAAM,EAAE,GAAG,EAAE,OAAO,GAAG,IAAI,CA6BpC;IAED;;;;OAIG;IACH,OAAO,CAAC,KAAK;IAab,6EAA6E;IAC7E,OAAO,CAAC,SAAS;IASjB,wGAAwG;IACxG,OAAO,CAAC,OAAO;IAyBf,QAAQ,IAAI,MAAM,CAEjB;IAED,wCAAwC;IACxC,MAAM,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAExB;IAED,MAAM,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAEzB;IAED,6EAA6E;IAC7E,IAAI,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,GAAG,IAAI,CAqBvC;IAED,wDAAwD;IACxD,KAAK,CAAC,CAAC,EAAE,MAAM,GAAG,UAAU,GAAG,IAAI,CAyBlC;IAED,+DAA+D;IAC/D,KAAK,CAAC,CAAC,EAAE,MAAM,GAAG,IAAI,CAGrB;IAED,yDAAyD;IACzD,OAAO,CAAC,CAAC,EAAE,MAAM,GAAG,IAAI,CAUvB;CACF"}