Allocate ID numbers from counters that are kept in persistent storage

packages/SwingSet/src/liveslots/collectionManager.js

@@ -22,6 +22,7 @@ export function makeCollectionManager(
   syscall,
   vrm,
   allocateExportID,
+  allocateCollectionID,
   convertValToSlot,
   convertSlotToVal,
   registerValue,
@@ -546,8 +547,6 @@ export function makeCollectionManager(
     return doMoreGC;
   }
 
-  let nextCollectionID = 1;
-
   function makeCollection(label, kindName, keySchema, valueSchema) {
     assert.typeof(label, 'string');
     assert(storeKindInfo[kindName]);
@@ -557,8 +556,7 @@ export function makeCollectionManager(
       assertPattern(valueSchema);
       schemata.push(valueSchema);
     }
-    const collectionID = nextCollectionID;
-    nextCollectionID += 1;
+    const collectionID = allocateCollectionID();
     const kindID = obtainStoreKindID(kindName);
     const vobjID = `o+${kindID}/${collectionID}`;
 

packages/SwingSet/src/liveslots/liveslots.js

@@ -294,8 +294,6 @@ function build(
   const disavowalError = harden(Error(`this Presence has been disavowed`));
 
   const importedPromisesByPromiseID = new Map(); // vpid -> { resolve, reject }
-  let nextExportID = 1;
-  let nextPromiseID = 5;
 
   function makeImportedPresence(slot, iface = `Alleged: presence ${slot}`) {
     // Called by convertSlotToVal for type=object (an `o-NN` reference). We
@@ -438,6 +436,46 @@ function build(
     return Remotable(iface);
   }
 
+  let idCounters;
+  let idCountersAreDirty = false;
+
+  function initializeIDCounters() {
+    if (!idCounters) {
+      const raw = syscall.vatstoreGet('idCounters');
+      if (raw) {
+        idCounters = JSON.parse(raw);
+      } else {
+        idCounters = {};
+      }
+    }
+  }
+
+  function allocateNextID(name, initialValue = 1) {
+    if (!idCounters) {
+      // Normally `initializeIDCounters` would be called from startVat, but some
+      // tests bypass that so this is a backstop.  Note that the invocation from
+      // startVat is there to make vatStore access patterns a bit more
+      // consistent from one vat to another, principally as a confusion
+      // reduction measure in service of debugging; it is not a correctness
+      // issue.
+      initializeIDCounters();
+    }
+    if (!idCounters[name]) {
+      idCounters[name] = initialValue;
+    }
+    const result = idCounters[name];
+    idCounters[name] += 1;
+    idCountersAreDirty = true;
+    return result;
+  }
+
+  function flushIDCounters() {
+    if (idCountersAreDirty) {
+      syscall.vatstoreSet('idCounters', JSON.stringify(idCounters));
+      idCountersAreDirty = false;
+    }
+  }
+
   // TODO: fix awkward non-orthogonality: allocateExportID() returns a number,
   // allocatePromiseID() returns a slot, exportPromise() uses the slot from
   // allocatePromiseID(), exportPassByPresence() generates a slot itself using
@@ -446,14 +484,22 @@ function build(
   // use a slot from the corresponding allocateX
 
   function allocateExportID() {
-    const exportID = nextExportID;
-    nextExportID += 1;
-    return exportID;
+    // We start exportIDs with 1 because 'o+0' is always automatically
+    // pre-assigned to the root object.
+    return allocateNextID('exportID', 1);
+  }
+
+  function allocateCollectionID() {
+    return allocateNextID('collectionID', 1);
   }
 
   function allocatePromiseID() {
-    const promiseID = nextPromiseID;
-    nextPromiseID += 1;
+    // The starting point for numbering promiseIDs is pretty arbitrary.  We start
+    // from 5 as a very minor aid to debugging: It helps, when puzzling over
+    // trace logs and the like, for the numbers in the various species of IDs to
+    // be a little out of sync and thus a little less similar to each other when
+    // jumbled together.
+    const promiseID = allocateNextID('promiseID', 5);
     return makeVatSlot('promise', true, promiseID);
   }
 
@@ -539,6 +585,7 @@ function build(
     syscall,
     vrm,
     allocateExportID,
+    allocateCollectionID,
     // eslint-disable-next-line no-use-before-define
     convertValToSlot,
     unmeteredConvertSlotToVal,
@@ -1164,6 +1211,7 @@ function build(
       });
     }
 
+    initializeIDCounters();
     const vatParameters = m.unserialize(vatParametersCapData);
     baggage = collectionManager.provideBaggage();
 
@@ -1266,6 +1314,14 @@ function build(
     return undefined;
   }
 
+  /**
+   * Do things that should be done (such as flushing caches to disk) after a
+   * dispatch has completed and user code has relinquished agency.
+   */
+  function afterDispatchActions() {
+    flushIDCounters();
+  }
+
   /**
    * This 'dispatch' function is the entry point for the vat as a whole: the
    * vat-worker supervisor gives us VatDeliveryObjects (like
@@ -1315,11 +1371,14 @@ function build(
       // any promise it returns to fire.
       const p = Promise.resolve(delivery).then(unmeteredDispatch);
 
-      // Instead, we wait for userspace to become idle by draining the
-      // promise queue. We return 'p' so that any bugs in liveslots that
+      // Instead, we wait for userspace to become idle by draining the promise
+      // queue. We clean up and then return 'p' so any bugs in liveslots that
       // cause an error during unmeteredDispatch will be reported to the
       // supervisor (but only after userspace is idle).
-      return gcTools.waitUntilQuiescent().then(() => p);
+      return gcTools.waitUntilQuiescent().then(() => {
+        afterDispatchActions();
+        return p;
+      });
     }
   }
   harden(dispatch);

packages/SwingSet/test/liveslots-helpers.js

@@ -240,7 +240,11 @@ export function matchVatstoreDelete(key) {
 }
 
 export function matchVatstoreSet(key, value) {
-  return { type: 'vatstoreSet', key, value };
+  if (value !== undefined) {
+    return { type: 'vatstoreSet', key, value };
+  } else {
+    return { type: 'vatstoreSet', key };
+  }
 }
 
 export function matchRetireExports(...slots) {
@@ -256,7 +260,7 @@ export function matchRetireImports(...slots) {
 }
 
 export function validate(v, match) {
-  v.t.deepEqual(v.log.shift(), match);
+  v.t.like(v.log.shift(), match);
 }
 
 export function validateDone(v) {

packages/SwingSet/test/stores/test-storeGC.js

@@ -263,6 +263,7 @@ function validateUpdate(v, key, before, after) {
 function validateMakeAndHold(v, rp) {
   validateCreateStore(v, mainHeldIdx);
   validateReturned(v, rp);
+  validate(v, matchVatstoreSet('idCounters'));
   validateDone(v);
 }
 
@@ -442,6 +443,9 @@ function validateImportAndHold(v, rp, idx) {
     validate(v, matchVatstoreGet(`vc.${idx}.|label`, `store #${idx}`));
   }
   validateReturned(v, rp);
+  if (idx === NONE) {
+    validate(v, matchVatstoreSet('idCounters'));
+  }
   validateDone(v);
 }
 
@@ -461,6 +465,7 @@ function validateCreateHolder(v, idx) {
 }
 
 function validateInit(v) {
+  validate(v, matchVatstoreGet('idCounters', NONE));
   validate(v, matchVatstoreGet('baggageID', NONE));
   validate(v, matchVatstoreGet('storeKindIDTable', NONE));
   validate(
@@ -858,6 +863,7 @@ function validatePrepareStore3(
   validate(v, matchVatstoreSet(`vc.${base + 2}.|entryCount`, '1'));
 
   validateReturned(v, rp);
+  validate(v, matchVatstoreSet('idCounters'));
   if (!nonVirtual) {
     validateRefCountCheck(v, contentRef, '3');
     if (checkES) {
@@ -971,6 +977,7 @@ test.serial('store refcount management 3', async t => {
   validate(v, matchVatstoreGet(`vc.${base + 2}.|entryCount`, '0'));
   validate(v, matchVatstoreSet(`vc.${base + 2}.|entryCount`, '1'));
   validateReturned(v, rp);
+  validate(v, matchVatstoreSet('idCounters'));
   validateStatusCheck(v, mapRef(mainHeldIdx), '1', NONE);
   validateStatusCheck(v, mapRef(base), '1', NONE);
   validateStatusCheck(v, mapRef(base + 1), '1', NONE);
@@ -1078,6 +1085,7 @@ test.serial('remotable refcount management 1', async t => {
   let rp = await dispatchMessage('makeAndHoldRemotable');
   validateInit(v);
   validateReturned(v, rp);
+  validate(v, matchVatstoreSet('idCounters'));
   validateDone(v);
 
   rp = await dispatchMessage('prepareStore3');
@@ -1109,6 +1117,7 @@ test.serial('remotable refcount management 2', async t => {
   let rp = await dispatchMessage('makeAndHoldRemotable');
   validateInit(v);
   validateReturned(v, rp);
+  validate(v, matchVatstoreSet('idCounters'));
   validateDone(v);
 
   rp = await dispatchMessage('prepareStore3');
@@ -1163,6 +1172,7 @@ test.serial('verify store weak key GC', async t => {
   validate(v, matchVatstoreGet(`vc.${setID}.|${mapRef(keyID)}`, '1'));
   validate(v, matchVatstoreSet(`vc.${setID}.${ordinalKey}`, nullValString));
   validateReturned(v, rp);
+  validate(v, matchVatstoreSet('idCounters'));
   validateDone(v);
 
   t.is(testHooks.countCollectionsForWeakKey(mapRef(keyID)), 2);
@@ -1246,6 +1256,7 @@ test.serial('verify presence weak key GC', async t => {
   validate(v, matchVatstoreGet(`vc.${setID}.|${presenceRef}`, '1'));
   validate(v, matchVatstoreSet(`vc.${setID}.${ordinalKey}`, nullValString));
   validateReturned(v, rp);
+  validate(v, matchVatstoreSet('idCounters'));
 
   t.is(testHooks.countCollectionsForWeakKey(presenceRef), 2);
   t.is(testHooks.storeSizeInternal(mapRef(mapID)), 1);

packages/SwingSet/test/test-baggage.js

@@ -46,6 +46,7 @@ function validateCreateBaggage(v, idx) {
 }
 
 function validateSetup(v) {
+  validate(v, matchVatstoreGet('idCounters', NONE));
   validate(v, matchVatstoreGet('baggageID', NONE));
   validate(v, matchVatstoreGet('storeKindIDTable', NONE));
   validate(
@@ -80,5 +81,6 @@ test.serial('exercise baggage', async t => {
   validate(v, matchVatstoreGet('vc.1.|entryCount', '1'));
   validate(v, matchVatstoreSet('vc.1.|entryCount', '2'));
   validateReturned(v, rp);
+  validate(v, matchVatstoreSet('idCounters'));
   validateDone(v);
 });