A bunch of improvements

glimmerjs · Nov 3, 2024 · bda4a4b · bda4a4b
1 parent 8f8686e
commit bda4a4b
Show file tree

Hide file tree

Showing 5 changed files with 126 additions and 120 deletions.
diff --git a/packages/@glimmer/runtime/lib/opcodes.ts b/packages/@glimmer/runtime/lib/opcodes.ts
@@ -53,6 +53,9 @@ export type DebugState = {
 export class AppendOpcodes {
   private evaluateOpcode: Evaluate[] = new Array(Op.Size).fill(null);
 
+  declare debugBefore?: (vm: VM, opcode: RuntimeOp) => DebugState;
+  declare debugAfter?: (vm: VM, pre: DebugState) => void;
+
   add<Name extends VmOp>(name: Name, evaluate: Syscall): void;
   add<Name extends VmMachineOp>(name: Name, evaluate: MachineOpcode, kind: 'machine'): void;
   add<Name extends SomeVmOp>(
@@ -66,111 +69,6 @@ export class AppendOpcodes {
     } as Evaluate;
   }
 
-  debugBefore(vm: VM, opcode: RuntimeOp): DebugState {
-    let params: Maybe<Dict> = undefined;
-    let opName: string | undefined = undefined;
-
-    if (LOCAL_TRACE_LOGGING) {
-      const lowlevel = unwrap(vm.debug).lowlevel;
-      let pos = lowlevel.fetchRegister($pc) - opcode.size;
-
-      [opName, params] = debug(vm.constants, opcode, opcode.isMachine)!;
-
-      // console.log(`${typePos(vm['pc'])}.`);
-      LOCAL_LOGGER.debug(`${pos}. ${logOpcode(opName, params)}`);
-
-      let debugParams = [];
-      for (let prop in params) {
-        debugParams.push(prop, '=', params[prop]);
-      }
-
-      LOCAL_LOGGER.debug(...debugParams);
-    }
-
-    let sp: number;
-
-    if (LOCAL_DEBUG) {
-      sp = vm.fetchValue($sp);
-    }
-
-    recordStackSize(vm.fetchValue($sp));
-    return {
-      sp: sp!,
-      pc: vm.fetchValue($pc),
-      name: opName,
-      params,
-      type: opcode.type,
-      isMachine: opcode.isMachine,
-      size: opcode.size,
-      state: undefined,
-    };
-  }
-
-  debugAfter(vm: VM, pre: DebugState) {
-    let { sp, type, isMachine, pc } = pre;
-
-    if (LOCAL_DEBUG) {
-      const debug = unwrap(vm.debug);
-
-      let meta = opcodeMetadata(type, isMachine);
-      let actualChange = vm.fetchValue($sp) - sp;
-      if (
-        meta &&
-        meta.check &&
-        typeof meta.stackChange! === 'number' &&
-        meta.stackChange !== actualChange
-      ) {
-        throw new Error(
-          `Error in ${pre.name}:\n\n${pc}. ${logOpcode(
-            pre.name!,
-            pre.params
-          )}\n\nStack changed by ${actualChange}, expected ${meta.stackChange}`
-        );
-      }
-
-      if (LOCAL_TRACE_LOGGING) {
-        const { lowlevel, registers } = unwrap(vm.debug);
-        LOCAL_LOGGER.debug(
-          '%c -> pc: %d, ra: %d, fp: %d, sp: %d, s0: %O, s1: %O, t0: %O, t1: %O, v0: %O',
-          'color: orange',
-          lowlevel.registers[$pc],
-          lowlevel.registers[$ra],
-          lowlevel.registers[$fp],
-          lowlevel.registers[$sp],
-          registers[$s0],
-          registers[$s1],
-          registers[$t0],
-          registers[$t1],
-          registers[$v0]
-        );
-        LOCAL_LOGGER.debug('%c -> eval stack', 'color: red', vm.stack.toArray());
-        LOCAL_LOGGER.debug('%c -> block stack', 'color: magenta', vm.elements().debugBlocks());
-        LOCAL_LOGGER.debug(
-          '%c -> destructor stack',
-          'color: violet',
-          debug.destroyableStack.toArray()
-        );
-        if (debug.stacks.scope.current === null) {
-          LOCAL_LOGGER.debug('%c -> scope', 'color: green', 'null');
-        } else {
-          LOCAL_LOGGER.debug(
-            '%c -> scope',
-            'color: green',
-            vm.scope().slots.map((s) => (isScopeReference(s) ? valueForRef(s) : s))
-          );
-        }
-
-        LOCAL_LOGGER.debug(
-          '%c -> elements',
-          'color: blue',
-          vm.elements()[CURSOR_STACK].current!.element
-        );
-
-        LOCAL_LOGGER.debug('%c -> constructing', 'color: aqua', vm.elements()['constructing']);
-      }
-    }
-  }
-
   evaluate(vm: VM, opcode: RuntimeOp, type: number) {
     let operation = unwrap(this.evaluateOpcode[type]);
 
@@ -190,4 +88,113 @@ export class AppendOpcodes {
   }
 }
 
+if (import.meta.env.VM_LOCAL_DEV) {
+  Object.assign(AppendOpcodes.prototype, {
+    debugBefore(vm: VM, opcode: RuntimeOp): DebugState {
+      let params: Maybe<Dict> = undefined;
+      let opName: string | undefined = undefined;
+
+      if (LOCAL_TRACE_LOGGING) {
+        const lowlevel = unwrap(vm.debug).lowlevel;
+        let pos = lowlevel.fetchRegister($pc) - opcode.size;
+
+        [opName, params] = debug(vm.constants, opcode, opcode.isMachine)!;
+
+        // console.log(`${typePos(vm['pc'])}.`);
+        LOCAL_LOGGER.debug(`${pos}. ${logOpcode(opName, params)}`);
+
+        let debugParams = [];
+        for (let prop in params) {
+          debugParams.push(prop, '=', params[prop]);
+        }
+
+        LOCAL_LOGGER.debug(...debugParams);
+      }
+
+      let sp: number;
+
+      if (LOCAL_DEBUG) {
+        sp = vm.fetchValue($sp);
+      }
+
+      recordStackSize(vm.fetchValue($sp));
+      return {
+        sp: sp!,
+        pc: vm.fetchValue($pc),
+        name: opName,
+        params,
+        type: opcode.type,
+        isMachine: opcode.isMachine,
+        size: opcode.size,
+        state: undefined,
+      };
+    },
+
+    debugAfter(vm: VM, pre: DebugState) {
+      let { sp, type, isMachine, pc } = pre;
+
+      if (LOCAL_DEBUG) {
+        const debug = unwrap(vm.debug);
+
+        let meta = opcodeMetadata(type, isMachine);
+        let actualChange = vm.fetchValue($sp) - sp;
+        if (
+          meta &&
+          meta.check &&
+          typeof meta.stackChange! === 'number' &&
+          meta.stackChange !== actualChange
+        ) {
+          throw new Error(
+            `Error in ${pre.name}:\n\n${pc}. ${logOpcode(
+              pre.name!,
+              pre.params
+            )}\n\nStack changed by ${actualChange}, expected ${meta.stackChange}`
+          );
+        }
+
+        if (LOCAL_TRACE_LOGGING) {
+          const { lowlevel, registers } = unwrap(vm.debug);
+          LOCAL_LOGGER.debug(
+            '%c -> pc: %d, ra: %d, fp: %d, sp: %d, s0: %O, s1: %O, t0: %O, t1: %O, v0: %O',
+            'color: orange',
+            lowlevel.registers[$pc],
+            lowlevel.registers[$ra],
+            lowlevel.registers[$fp],
+            lowlevel.registers[$sp],
+            registers[$s0],
+            registers[$s1],
+            registers[$t0],
+            registers[$t1],
+            registers[$v0]
+          );
+          LOCAL_LOGGER.debug('%c -> eval stack', 'color: red', vm.stack.toArray());
+          LOCAL_LOGGER.debug('%c -> block stack', 'color: magenta', vm.elements().debugBlocks());
+          LOCAL_LOGGER.debug(
+            '%c -> destructor stack',
+            'color: violet',
+            debug.destroyableStack.toArray()
+          );
+          if (debug.stacks.scope.current === null) {
+            LOCAL_LOGGER.debug('%c -> scope', 'color: green', 'null');
+          } else {
+            LOCAL_LOGGER.debug(
+              '%c -> scope',
+              'color: green',
+              vm.scope().slots.map((s) => (isScopeReference(s) ? valueForRef(s) : s))
+            );
+          }
+
+          LOCAL_LOGGER.debug(
+            '%c -> elements',
+            'color: blue',
+            vm.elements()[CURSOR_STACK].current!.element
+          );
+
+          LOCAL_LOGGER.debug('%c -> constructing', 'color: aqua', vm.elements()['constructing']);
+        }
+      }
+    },
+  });
+}
+
 export const APPEND_OPCODES = new AppendOpcodes();
diff --git a/packages/@glimmer/runtime/lib/vm/append.ts b/packages/@glimmer/runtime/lib/vm/append.ts
@@ -207,15 +207,17 @@ export class VM implements PublicVM {
       evalStack,
       this.#heap,
       runtime.program,
-      {
-        debugBefore: (opcode: RuntimeOpImpl): DebugState => {
-          return APPEND_OPCODES.debugBefore(this, opcode);
-        },
-
-        debugAfter: (state: DebugState): void => {
-          APPEND_OPCODES.debugAfter(this, state);
-        },
-      },
+      import.meta.env.VM_LOCAL_DEV
+        ? {
+            debugBefore: (opcode: RuntimeOpImpl): DebugState => {
+              return APPEND_OPCODES.debugBefore!(this, opcode);
+            },
+
+            debugAfter: (state: DebugState): void => {
+              APPEND_OPCODES.debugAfter!(this, state);
+            },
+          }
+        : undefined,
       evalStack.registers
     );
 

diff --git a/packages/@glimmer/runtime/lib/vm/low-level.ts b/packages/@glimmer/runtime/lib/vm/low-level.ts
@@ -49,7 +49,7 @@ export class LowLevelVM {
     public stack: VmStack,
     public heap: RuntimeHeap,
     public program: RuntimeProgram,
-    public externs: Externs,
+    public externs: Externs | undefined,
     readonly registers: LowLevelRegisters
   ) {}
 
@@ -139,7 +139,7 @@ export class LowLevelVM {
   }
 
   evaluateOuter(opcode: RuntimeOp, vm: VM) {
-    if (LOCAL_DEBUG) {
+    if (LOCAL_DEBUG && this.externs) {
       let {
         externs: { debugBefore, debugAfter },
       } = this;

diff --git a/packages/@glimmer/runtime/lib/vm/stack.ts b/packages/@glimmer/runtime/lib/vm/stack.ts
@@ -1,5 +1,5 @@
+import { assert } from '@glimmer/debug-util';
 import { LOCAL_DEBUG } from '@glimmer/local-debug-flags';
-import { assert } from '@glimmer/util';
 import { $fp, $pc, $sp } from '@glimmer/vm';
 
 import type { LowLevelRegisters } from './low-level';

diff --git a/vite.config.mts b/vite.config.mts
@@ -6,9 +6,6 @@ export default defineConfig({
   },
   mode: 'testing',
   plugins: [
-    /**
-     * A similar plugin exists for our rollup builds
-     */
     {
       name: 'define custom import.meta.env',
       async transform(code) {