Merge pull request #3450 from Agoric/mfig-consensus-mode

The beginnings of SwingSet consensus mode

golang/cosmos/x/vbank/vbank.go

@@ -121,7 +121,7 @@ func rewardRate(pool sdk.Coins, blocks int64) sdk.Coins {
 }
 
 func (ch portHandler) Receive(ctx *vm.ControllerContext, str string) (ret string, err error) {
-	fmt.Println("vbank.go downcall", str)
+	// fmt.Println("vbank.go downcall", str)
 	keeper := ch.keeper
 
 	var msg portMessage
@@ -223,13 +223,13 @@ func (ch portHandler) Receive(ctx *vm.ControllerContext, str string) (ret string
 		err = fmt.Errorf("unrecognized type %s", msg.Type)
 	}
 
-	fmt.Println("vbank.go downcall reply", ret, err)
+	// fmt.Println("vbank.go downcall reply", ret, err)
 	return
 }
 
 func (am AppModule) CallToController(ctx sdk.Context, send string) (string, error) {
-	// fmt.Println("ibc.go upcall", send)
+	// fmt.Println("vbank.go upcall", send)
 	reply, err := am.keeper.CallToController(ctx, send)
-	// fmt.Println("ibc.go upcall reply", reply, err)
+	// fmt.Println("vbank.go upcall reply", reply, err)
 	return reply, err
 }

packages/SwingSet/src/controller.js

@@ -124,6 +124,7 @@ export function makeStartXSnap(bundles, { snapStore, env, spawn }) {
  *   slogFile?: string,
  *   testTrackDecref?: unknown,
  *   warehousePolicy?: { maxVatsOnline?: number },
+ *   overrideVatManagerOptions?: { consensusMode?: boolean },
  *   spawn?: typeof import('child_process').spawn,
  *   env?: Record<string, string | undefined>
  * }} runtimeOptions
@@ -147,6 +148,7 @@ export async function makeSwingsetController(
     slogFile,
     spawn = ambientSpawn,
     warehousePolicy = {},
+    overrideVatManagerOptions = {},
   } = runtimeOptions;
   if (typeof Compartment === 'undefined') {
     throw Error('SES must be installed before calling makeSwingsetController');
@@ -306,7 +308,7 @@ export async function makeSwingsetController(
     gcAndFinalize: makeGcAndFinalize(engineGC),
   };
 
-  const kernelOptions = { verbose, warehousePolicy };
+  const kernelOptions = { verbose, warehousePolicy, overrideVatManagerOptions };
   /** @type { ReturnType<typeof import('./kernel').default> } */
   const kernel = buildKernel(kernelEndowments, deviceEndowments, kernelOptions);
 
@@ -421,6 +423,7 @@ export async function makeSwingsetController(
  *   slogCallbacks?: unknown,
  *   testTrackDecref?: unknown,
  *   warehousePolicy?: { maxVatsOnline?: number },
+ *   overrideVatManagerOptions?: { consensusMode?: boolean },
  *   slogFile?: string,
  * }} runtimeOptions
  * @typedef { import('@agoric/swing-store-simple').KVStore } KVStore

packages/SwingSet/src/kernel/kernel.js

@@ -135,6 +135,7 @@ export default function buildKernel(
     verbose,
     defaultManagerType = 'local',
     warehousePolicy,
+    overrideVatManagerOptions = {},
   } = kernelOptions;
   const logStartup = verbose ? console.debug : () => 0;
 
@@ -800,6 +801,7 @@ export default function buildKernel(
     panic,
     buildVatSyscallHandler,
     vatAdminRootKref,
+    overrideVatManagerOptions,
   });
 
   const vatWarehouse = makeVatWarehouse(

packages/SwingSet/src/kernel/loadVat.js

@@ -10,6 +10,7 @@ export function makeVatRootObjectSlot() {
 
 export function makeVatLoader(stuff) {
   const {
+    overrideVatManagerOptions = {},
     vatManagerFactory,
     kernelSlog,
     makeVatConsole,
@@ -241,6 +242,7 @@ export function makeVatLoader(stuff) {
       virtualObjectCacheSize,
       useTranscript,
       name,
+      ...overrideVatManagerOptions,
     };
 
     const vatSyscallHandler = buildVatSyscallHandler(vatID, translators);
@@ -262,6 +264,7 @@ export function makeVatLoader(stuff) {
       enableSetup: true,
       managerType: 'local',
       useTranscript: true,
+      ...overrideVatManagerOptions,
     };
     const translators = makeVatTranslators(vatID, kernelKeeper);
     const vatSyscallHandler = buildVatSyscallHandler(vatID, translators);

packages/SwingSet/src/kernel/vatManager/factory.js

@@ -52,6 +52,7 @@ export function makeVatManagerFactory({
 
   function validateManagerOptions(managerOptions) {
     assertKnownOptions(managerOptions, [
+      'consensusMode',
       'enablePipelining',
       'managerType',
       'gcEveryCrank',

packages/SwingSet/src/kernel/vatManager/manager-local.js

@@ -7,6 +7,7 @@ import {
   makeSupervisorDispatch,
   makeMeteredDispatch,
   makeSupervisorSyscall,
+  makeVatConsole,
 } from './supervisor-helper.js';
 
 export function makeLocalVatManagerFactory(tools) {
@@ -91,6 +92,7 @@ export function makeLocalVatManagerFactory(tools) {
     vatSyscallHandler,
   ) {
     const {
+      consensusMode,
       metered = false,
       enableDisavow = false,
       enableSetup = false,
@@ -148,7 +150,9 @@ export function makeLocalVatManagerFactory(tools) {
     const endowments = harden({
       ...vatEndowments,
       ...ls.vatGlobals,
-      console: vatConsole,
+      console: makeVatConsole(vatConsole, (logger, args) => {
+        consensusMode || logger(...args);
+      }),
       assert,
     });
     const inescapableTransforms = [];

packages/SwingSet/src/kernel/vatManager/manager-nodeworker.js

@@ -37,6 +37,7 @@ export function makeNodeWorkerVatManagerFactory(tools) {
 
   function createFromBundle(vatID, bundle, managerOptions, vatSyscallHandler) {
     const {
+      consensusMode,
       vatParameters,
       virtualObjectCacheSize,
       enableDisavow,
@@ -116,6 +117,7 @@ export function makeNodeWorkerVatManagerFactory(tools) {
       virtualObjectCacheSize,
       enableDisavow,
       enableVatstore,
+      consensusMode,
     ]);
 
     function deliverToWorker(delivery) {

packages/SwingSet/src/kernel/vatManager/manager-subprocess-node.js

@@ -17,6 +17,7 @@ export function makeNodeSubprocessFactory(tools) {
 
   function createFromBundle(vatID, bundle, managerOptions, vatSyscallHandler) {
     const {
+      consensusMode,
       vatParameters,
       virtualObjectCacheSize,
       enableDisavow,
@@ -111,6 +112,7 @@ export function makeNodeSubprocessFactory(tools) {
       virtualObjectCacheSize,
       enableDisavow,
       enableVatstore,
+      consensusMode,
     ]);
 
     function shutdown() {

packages/SwingSet/src/kernel/vatManager/manager-subprocess-xsnap.js

@@ -51,6 +51,7 @@ export function makeXsSubprocessFactory({
   ) {
     parentLog(vatID, 'createFromBundle', { vatID });
     const {
+      consensusMode,
       vatParameters,
       virtualObjectCacheSize,
       enableDisavow,
@@ -60,6 +61,7 @@ export function makeXsSubprocessFactory({
       metered,
       compareSyscalls,
       useTranscript,
+      vatConsole,
     } = managerOptions;
     assert(
       !managerOptions.enableSetup,
@@ -86,9 +88,9 @@ export function makeXsSubprocessFactory({
           return mk.syscallFromWorker(vso);
         }
         case 'console': {
-          const [level, tag, ...rest] = args;
-          if (typeof level === 'string' && level in console) {
-            console[level](tag, ...rest);
+          const [level, ...rest] = args;
+          if (typeof level === 'string' && level in vatConsole) {
+            vatConsole[level](...rest);
           } else {
             console.error('bad console level', level);
           }
@@ -142,6 +144,7 @@ export function makeXsSubprocessFactory({
         virtualObjectCacheSize,
         enableDisavow,
         enableVatstore,
+        consensusMode,
         gcEveryCrank,
       ]);
       if (bundleReply[0] === 'dispatchReady') {
@@ -160,7 +163,7 @@ export function makeXsSubprocessFactory({
       parentLog(vatID, `sending delivery`, delivery);
       let result;
       try {
-        result = await issueTagged(['deliver', delivery]);
+        result = await issueTagged(['deliver', delivery, consensusMode]);
       } catch (err) {
         parentLog('issueTagged error:', err.code, err.message);
         let message;

packages/SwingSet/src/kernel/vatManager/supervisor-helper.js

@@ -1,5 +1,5 @@
 // @ts-check
-import { assert } from '@agoric/assert';
+import { assert, details as X } from '@agoric/assert';
 import {
   insistVatSyscallObject,
   insistVatSyscallResult,
@@ -191,3 +191,39 @@ function makeSupervisorSyscall(syscallToManager, workerCanBlock) {
 
 harden(makeSupervisorSyscall);
 export { makeSupervisorSyscall };
+
+/**
+ * Create a vat console, or a no-op if consensusMode is true.
+ *
+ * TODO: consider other methods per SES VirtualConsole.
+ * See https://github.com/Agoric/agoric-sdk/issues/2146
+ *
+ * @param {Record<'debug' | 'log' | 'info' | 'warn' | 'error', (...args: any[]) => void>} logger
+ * the backing log method
+ * @param {(logger: any, args: any[]) => void} [wrapper]
+ */
+function makeVatConsole(logger, wrapper) {
+  assert.typeof(
+    wrapper,
+    'function',
+    X`Invalid VatConsole wrapper value ${wrapper}`,
+  );
+  const cons = Object.fromEntries(
+    ['debug', 'log', 'info', 'warn', 'error'].map(level => {
+      const backingLog = logger[level];
+
+      return [
+        level,
+        (...args) => {
+          // Wrap the actual backing log message, in case there is logic to impose.
+          wrapper(backingLog, args);
+        },
+      ];
+    }),
+  );
+
+  return harden(cons);
+}
+
+harden(makeVatConsole);
+export { makeVatConsole };

packages/SwingSet/src/kernel/vatManager/supervisor-nodeworker.js

@@ -17,6 +17,7 @@ import { makeLiveSlots } from '../liveSlots.js';
 import {
   makeSupervisorDispatch,
   makeSupervisorSyscall,
+  makeVatConsole,
 } from './supervisor-helper.js';
 
 assert(parentPort, 'parentPort somehow missing, am I not a Worker?');
@@ -28,15 +29,6 @@ function workerLog(first, ...args) {
 
 workerLog(`supervisor started`);
 
-function makeConsole(tag) {
-  const log = anylogger(tag);
-  const cons = {};
-  for (const level of ['debug', 'log', 'info', 'warn', 'error']) {
-    cons[level] = log[level];
-  }
-  return harden(cons);
-}
-
 function sendUplink(msg) {
   assert(msg instanceof Array, X`msg must be an Array`);
   assert(parentPort, 'parentPort somehow missing, am I not a Worker?');
@@ -58,6 +50,7 @@ parentPort.on('message', ([type, ...margs]) => {
       virtualObjectCacheSize,
       enableDisavow,
       enableVatstore,
+      consensusMode,
     ] = margs;
 
     function testLog(...args) {
@@ -96,7 +89,12 @@ parentPort.on('message', ([type, ...margs]) => {
 
     const endowments = {
       ...ls.vatGlobals,
-      console: makeConsole(`SwingSet:vatWorker`),
+      console: makeVatConsole(
+        anylogger(`SwingSet:vat:${vatID}`),
+        (logger, args) => {
+          consensusMode || logger(...args);
+        },
+      ),
       assert,
     };
 

packages/SwingSet/src/kernel/vatManager/supervisor-subprocess-node.js

@@ -23,6 +23,7 @@ import { makeLiveSlots } from '../liveSlots.js';
 import {
   makeSupervisorDispatch,
   makeSupervisorSyscall,
+  makeVatConsole,
 } from './supervisor-helper.js';
 
 // eslint-disable-next-line no-unused-vars
@@ -32,15 +33,6 @@ function workerLog(first, ...args) {
 
 workerLog(`supervisor started`);
 
-function makeConsole(tag) {
-  const log = anylogger(tag);
-  const cons = {};
-  for (const level of ['debug', 'log', 'info', 'warn', 'error']) {
-    cons[level] = log[level];
-  }
-  return harden(cons);
-}
-
 let dispatch;
 
 const toParent = arrayEncoderStream();
@@ -76,6 +68,7 @@ fromParent.on('data', ([type, ...margs]) => {
       virtualObjectCacheSize,
       enableDisavow,
       enableVatstore,
+      consensusMode,
     ] = margs;
 
     function testLog(...args) {
@@ -110,9 +103,15 @@ fromParent.on('data', ([type, ...margs]) => {
       gcTools,
     );
 
+    // Enable or disable the console accordingly.
     const endowments = {
       ...ls.vatGlobals,
-      console: makeConsole(`SwingSet:vatWorker`),
+      console: makeVatConsole(
+        anylogger(`SwingSet:vat:${vatID}`),
+        (logger, args) => {
+          consensusMode || logger(...args);
+        },
+      ),
       assert,
     };