Merge pull request #7138 from Agoric/6693-vo-lru-cache

rewrite VOM LRU cache

packages/SwingSet/src/controller/initializeKernel.js

@@ -81,7 +81,6 @@ export async function initializeKernel(config, kernelStorage, options = {}) {
         'managerType',
         'enableDisavow',
         'enableSetup',
-        'virtualObjectCacheSize',
         'useTranscript',
         'critical',
         'reapInterval',

packages/SwingSet/src/kernel/vat-loader/manager-factory.js

@@ -36,7 +36,6 @@ export function makeVatManagerFactory({
       'metered',
       'enableDisavow',
       'enableSetup',
-      'virtualObjectCacheSize',
       'useTranscript',
       'critical',
       'reapInterval',

packages/SwingSet/src/kernel/vat-loader/vat-loader.js

@@ -26,7 +26,6 @@ export function makeVatLoader(stuff) {
     'enableDisavow',
     'enableSetup',
     'enablePipelining',
-    'virtualObjectCacheSize',
     'useTranscript',
     'critical',
     'reapInterval',
@@ -92,7 +91,6 @@ export function makeVatLoader(stuff) {
       enableSetup = false,
       enableDisavow = false,
       enablePipelining = false,
-      virtualObjectCacheSize,
       useTranscript = true,
       critical = false,
       name,
@@ -128,7 +126,6 @@ export function makeVatLoader(stuff) {
       ...overrideVatManagerOptions,
     };
     const liveSlotsOptions = {
-      virtualObjectCacheSize,
       enableDisavow,
       relaxDurabilityRules: kernelKeeper.getRelaxDurabilityRules(),
     };

packages/SwingSet/src/types-external.js

@@ -285,7 +285,6 @@ export {};
  *            waiting for the promises to be resolved.  If false, such
  *            messages will be queued inside the kernel.  Defaults to
  *            false.
- * @property { number } [virtualObjectCacheSize]
  * @property { boolean } [useTranscript]
  *            If true, saves a transcript of a vat's inbound deliveries and
  *            outbound syscalls so that the vat's internal state can be

packages/SwingSet/src/types-internal.js

@@ -33,7 +33,6 @@ export {};
  *   critical: boolean,
  *   enableDisavow: boolean,
  *   useTranscript: boolean,
- *   virtualObjectCacheSize: number,
  *   name: string,
  *   compareSyscalls?: (originalSyscall: {}, newSyscall: {}) => Error | undefined,
  *   sourcedConsole: Pick<Console, 'debug' | 'log' | 'info' | 'warn' | 'error'>,

packages/SwingSet/src/vats/vat-admin/vat-vat-admin.js

@@ -314,9 +314,6 @@ export function buildRootObject(vatPowers, _vatParameters, baggage) {
                 'invalid reapInterval value',
               );
               break;
-            case 'virtualObjectCacheSize':
-              assert(isNat(value), 'invalid virtualObjectCacheSize value');
-              break;
             default:
               assert.fail(`invalid option "${option}"`);
           }
@@ -357,7 +354,6 @@ export function buildRootObject(vatPowers, _vatParameters, baggage) {
       vatParameters, // stripped out and re-added
       enableSetup,
       enablePipelining,
-      virtualObjectCacheSize,
       useTranscript,
       reapInterval,
       critical, // converted from cap key to boolean
@@ -391,7 +387,6 @@ export function buildRootObject(vatPowers, _vatParameters, baggage) {
     }
     assertType('enableSetup', enableSetup, 'boolean');
     assertType('enablePipelining', enablePipelining, 'boolean');
-    assertType('virtualObjectCacheSize', virtualObjectCacheSize, 'number');
     assertType('useTranscript', useTranscript, 'boolean');
     assertType('reapInterval', reapInterval, 'number');
 
@@ -423,7 +418,6 @@ export function buildRootObject(vatPowers, _vatParameters, baggage) {
       vatParameters,
       enableSetup,
       enablePipelining,
-      virtualObjectCacheSize,
       useTranscript,
       reapInterval,
       critical: isCriticalVat,

packages/SwingSet/test/change-parameters/test-change-parameters.js

@@ -64,19 +64,11 @@ async function testChangeParameters(t) {
   t.is(c1Status, 'fulfilled');
   t.is(c1Result, 'invalid option "foo"');
 
-  const [c2Status, c2Result] = await run('change', [
-    { virtualObjectCacheSize: -1 },
-  ]);
-  t.is(c2Status, 'fulfilled');
-  t.is(c2Result, 'invalid virtualObjectCacheSize value');
-
   const [c3Status, c3Result] = await run('change', [{ reapInterval: 'maybe' }]);
   t.is(c3Status, 'fulfilled');
   t.is(c3Result, 'invalid reapInterval value');
 
-  const [c4Status, c4Result] = await run('change', [
-    { virtualObjectCacheSize: 100, reapInterval: 20 },
-  ]);
+  const [c4Status, c4Result] = await run('change', [{ reapInterval: 20 }]);
   t.is(c4Status, 'fulfilled');
   t.is(c4Result, 'ok');
   t.is(kvStore.get('v6.reapInterval'), '20');

packages/SwingSet/test/upgrade/vat-ulrik-1.js

@@ -28,7 +28,6 @@ const holderMethods = {
 };
 const makeVir = defineKind('virtual', initHolder, holderMethods);
 const makeDur = defineDurableKind(durandalHandle, initHolder, holderMethods);
-const makeDummy = defineKind('dummy', initHolder, holderMethods);
 
 // TODO: explore 'export modRetains'
 // eslint-disable-next-line no-unused-vars
@@ -115,13 +114,6 @@ const buildExports = (baggage, imp) => {
   baggage.init('dur37', dur[37]);
   baggage.init('imp38', imp[38]);
 
-  // we set virtualObjectCacheSize=0 to ensure all data writes are
-  // made promptly, But the cache will still retain the last
-  // Representative, which inhibits GC. So the last thing we do here
-  // should be to create/deserialize a throwaway object, to
-  // flush the last dur/vir/vc/dc from the cache.
-  makeDummy();
-
   // we share dur1/vir2 with the test harness so it can glean the
   // baserefs and interpolate the full vrefs for everything else
   // without holding a GC pin on them

packages/SwingSet/test/vat-admin/terminate/test-terminate-replay.js

@@ -19,6 +19,7 @@ test.serial('replay does not resurrect dead vat', async t => {
   const configPath = new URL('swingset-no-zombies.json', import.meta.url)
     .pathname;
   const config = await loadSwingsetConfigFile(configPath);
+  config.defaultReapInterval = 'never';
 
   const ss1 = initSwingStore();
   {

packages/SwingSet/test/vat-admin/terminate/test-terminate.js

@@ -41,6 +41,7 @@ async function doTerminateNonCritical(
   const configPath = new URL('swingset-terminate.json', import.meta.url)
     .pathname;
   const config = await loadSwingsetConfigFile(configPath);
+  config.defaultReapInterval = 'never';
   const kernelStorage = initSwingStore().kernelStorage;
   const controller = await buildVatController(config, [], {
     ...t.context.data,
@@ -104,6 +105,7 @@ async function doTerminateCritical(
   const configPath = new URL('swingset-terminate.json', import.meta.url)
     .pathname;
   const config = await loadSwingsetConfigFile(configPath);
+  config.defaultReapInterval = 'never';
   const kernelStorage = initSwingStore().kernelStorage;
   const controller = await buildVatController(config, [], {
     ...t.context.data,
@@ -374,6 +376,7 @@ test.serial('exit with presence', async t => {
   const configPath = new URL('swingset-die-with-presence.json', import.meta.url)
     .pathname;
   const config = await loadSwingsetConfigFile(configPath);
+  config.defaultReapInterval = 'never';
   const controller = await buildVatController(config, [], t.context.data);
   t.teardown(controller.shutdown);
   await controller.run();
@@ -389,6 +392,7 @@ test.serial('dispatches to the dead do not harm kernel', async t => {
   const configPath = new URL('swingset-speak-to-dead.json', import.meta.url)
     .pathname;
   const config = await loadSwingsetConfigFile(configPath);
+  config.defaultReapInterval = 'never';
 
   const ss1 = initSwingStore();
   {
@@ -432,6 +436,7 @@ test.serial('invalid criticalVatKey causes vat creation to fail', async t => {
   const configPath = new URL('swingset-bad-vat-key.json', import.meta.url)
     .pathname;
   const config = await loadSwingsetConfigFile(configPath);
+  config.defaultReapInterval = 'never';
   const controller = await buildVatController(config, [], t.context.data);
   t.teardown(controller.shutdown);
   await t.throwsAsync(() => controller.run(), {
@@ -443,6 +448,7 @@ test.serial('dead vat state removed', async t => {
   const configPath = new URL('swingset-die-cleanly.json', import.meta.url)
     .pathname;
   const config = await loadSwingsetConfigFile(configPath);
+  config.defaultReapInterval = 'never';
   const { kernelStorage, debug } = initSwingStore();
 
   const controller = await buildVatController(config, [], {
@@ -480,6 +486,7 @@ test.serial('terminate with presence', async t => {
     import.meta.url,
   ).pathname;
   const config = await loadSwingsetConfigFile(configPath);
+  config.defaultReapInterval = 'never';
   const controller = await buildVatController(config, [], t.context.data);
   t.teardown(controller.shutdown);
   await controller.run();

packages/SwingSet/test/virtualObjects/collection-slots/test-collection-slots.js

@@ -30,9 +30,6 @@ test('collection entry slots trigger doMoreGC', async t => {
       bootstrap: { sourceSpec: bfile('bootstrap-collection-slots.js') },
       target: {
         sourceSpec: bfile('vat-collection-slots.js'),
-        creationOptions: {
-          virtualObjectCacheSize: 0,
-        },
       },
     },
   };

packages/SwingSet/test/virtualObjects/delete-stored-vo/test-delete-stored-vo.js

@@ -29,9 +29,6 @@ test('VO property deletion is not short-circuited', async t => {
       bootstrap: { sourceSpec: bfile('bootstrap-delete-stored-vo.js') },
       target: {
         sourceSpec: bfile('vat-delete-stored-vo.js'),
-        creationOptions: {
-          virtualObjectCacheSize: 0,
-        },
       },
     },
   };

packages/SwingSet/test/virtualObjects/double-retire-import/bootstrap-dri.js

@@ -14,9 +14,7 @@ export function buildRootObject() {
     async build() {
       // build the target vat
       const bcap = await E(vatAdmin).getNamedBundleCap('dri');
-      const options = {};
-      options.virtualObjectCacheSize = 0;
-      const res = await E(vatAdmin).createVat(bcap, options);
+      const res = await E(vatAdmin).createVat(bcap);
       root = res.root;
       await E(root).buildVir(sensor0, sensor1);
       await E(root).ping();

packages/SwingSet/test/virtualObjects/test-facet-retention.js

@@ -52,9 +52,14 @@ import { kunser } from '../../src/lib/kmarshal.js';
 // Representative objects). All facets of a given cohort/instance
 // share the same 'context' object.
 
-// Currently, we create the 'context' and 'state' objects via an LRU
-// cache, so their lifetime is somewhat complicated, but still a
-// deterministic function of userspace behavior.
+// In any given crank, a new 'context'/'state' object pair is created
+// the first time a VO method is invoked, and is given to all VO
+// method invocations within that crank. They remain functional
+// forever. The VOM discards the context/state pair at end-of-crank,
+// and will make new ones in subsequent cranks (if they invoke VO
+// methods again). Userspace might retain either one, and use them in
+// a recognizer, but their lifetime is not related to VO GC behavior,
+// so they do not provide a GC sensor, merely a crank sensor.
 
 // The 'facets' cohort is a record, one property per facet. So a
 // defineKindMulti with a pair of `incrementer` and `decrementer`
@@ -150,16 +155,16 @@ test('retention', async t => {
   await go('multi', 'method', 'weakset', true);
   await go('multi', 'proto', 'weakset', true);
 
-  // 'context' currently shares a lifetime with the facet cluster
-  await go('single', 'context', 'retain', true);
-  await go('multi', 'context', 'retain', true);
-  await go('single', 'context', 'weakset', true);
-  await go('multi', 'context', 'weakset', true);
-  // as does 'state'
-  await go('single', 'state', 'retain', true);
-  await go('multi', 'state', 'retain', true);
-  await go('single', 'state', 'weakset', true);
-  await go('multi', 'state', 'weakset', true);
+  // 'context' is remade on each crank
+  await go('single', 'context', 'retain', false);
+  await go('multi', 'context', 'retain', false);
+  await go('single', 'context', 'weakset', false);
+  await go('multi', 'context', 'weakset', false);
+  // as is 'state'
+  await go('single', 'state', 'retain', false);
+  await go('multi', 'state', 'retain', false);
+  await go('single', 'state', 'weakset', false);
+  await go('multi', 'state', 'weakset', false);
 
   if (remaining.size) {
     const missed = [...remaining].join(', ');