@agoric/xsnap 0.14.3-upgrade-16-dev-0549112.0 → 0.14.3-upgrade-16-dev-b7c2f02.0

package/build.env

@@ -1,4 +1,4 @@
 MODDABLE_URL=https://github.com/agoric-labs/moddable.git
 MODDABLE_COMMIT_HASH=f6c5951fc055e4ca592b9166b9ae3cbb9cca6bf0
 XSNAP_NATIVE_URL=https://github.com/agoric-labs/xsnap-pub
-XSNAP_NATIVE_COMMIT_HASH=2d8ccb76b8508e490d9e03972bb4c64f402d5135
+XSNAP_NATIVE_COMMIT_HASH=eef9b67da5517ed18ff9e0073b842db20924eae3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agoric/xsnap",
-  "version": "0.14.3-upgrade-16-dev-0549112.0+0549112",
+  "version": "0.14.3-upgrade-16-dev-b7c2f02.0+b7c2f02",
   "description": "Snapshotting VM worker based on Moddable's XS Javascript engine",
   "author": "Agoric",
   "license": "Apache-2.0",
@@ -16,6 +16,7 @@
     "build:env": "node src/build.js --show-env > build.env",
     "build:from-env": "{ cat build.env; echo node src/build.js; } | xargs env",
     "build": "yarn build:bin && yarn build:env",
+    "check-version": "xsnap_version=$(./scripts/get_xsnap_version.sh); if test \"${npm_package_version}\" != \"${xsnap_version}\"; then echo \"xsnap version mismatch; expected '${npm_package_version}', got '${xsnap_version}'\"; exit 1; fi",
     "postinstall": "npm run build:from-env",
     "clean": "rm -rf xsnap-native/xsnap/build",
     "lint": "run-s --continue-on-error lint:*",
@@ -27,9 +28,9 @@
     "test:xs": "exit 0"
   },
   "dependencies": {
-    "@agoric/assert": "0.6.1-upgrade-16-dev-0549112.0+0549112",
-    "@agoric/internal": "0.3.3-upgrade-16-dev-0549112.0+0549112",
-    "@agoric/xsnap-lockdown": "0.14.1-upgrade-16-dev-0549112.0+0549112",
+    "@agoric/assert": "0.6.1-upgrade-16-dev-b7c2f02.0+b7c2f02",
+    "@agoric/internal": "0.3.3-upgrade-16-dev-b7c2f02.0+b7c2f02",
+    "@agoric/xsnap-lockdown": "0.14.1-upgrade-16-dev-b7c2f02.0+b7c2f02",
     "@endo/bundle-source": "^3.2.3",
     "@endo/eventual-send": "^1.2.2",
     "@endo/init": "^1.1.2",
@@ -56,6 +57,7 @@
     "moddable/xs/makefiles",
     "moddable/xs/platforms/*.h",
     "moddable/xs/sources",
+    "scripts",
     "src",
     "xsnap-native/xsnap/makefiles",
     "xsnap-native/xsnap/sources"
@@ -76,5 +78,5 @@
   "typeCoverage": {
     "atLeast": 93.95
   },
-  "gitHead": "05491122ee61362c8310a7924ac67f033b02e38f"
+  "gitHead": "b7c2f02873a830fc76909505a8637a69a72f1adb"
 }

package/scripts/get_xsnap_version.sh

@@ -0,0 +1,14 @@
+#!/usr/bin/env bash
+
+set -ueo pipefail
+
+# the xsnap binary lives in a platform-specific directory
+unameOut="$(uname -s)"
+case "${unameOut}" in
+  Linux*) platform=lin ;;
+  Darwin*) platform=mac ;;
+  *) platform=win ;;
+esac
+
+# extract the xsnap package version from the long version printed by xsnap-worker
+"./xsnap-native/xsnap/build/bin/${platform}/release/xsnap-worker" -v | sed -e 's/^xsnap \([^ ]*\) (XS [^)]*)$/\1/g'

package/scripts/test-package.sh

@@ -0,0 +1,21 @@
+#!/bin/bash
+# Verifies that files in package.json covers everything xsnap needs to compile
+# from sources out of an npm package.
+set -xueo pipefail
+
+TEMP=$(mktemp -d)
+# function cleanup() {
+#   rm -rf "$TEMP"
+# }
+# trap cleanup EXIT
+
+yarn pack -f "$TEMP/package.tar"
+(
+  cd "$TEMP"
+  tar xvf package.tar
+  cd package
+  time yarn
+  time yarn
+  time yarn
+  time yarn
+)

package/src/build.js

@@ -220,16 +220,34 @@ const updateSubmodules = async (showEnv, { env, stdout, spawn, fs }) => {
  *     existsSync: typeof import('fs').existsSync,
  *     rmdirSync: typeof import('fs').rmdirSync,
  *     readFile: typeof import('fs').promises.readFile,
+ *     writeFile: typeof import('fs').promises.writeFile,
  *   },
  *   os: {
  *     type: typeof import('os').type,
  *   }
  * }} io
+ * @param {object} [options]
+ * @param {boolean} [options.forceBuild]
  */
-const makeXsnap = async ({ spawn, fs, os }) => {
+const makeXsnap = async ({ spawn, fs, os }, { forceBuild = false } = {}) => {
   const pjson = await fs.readFile(asset('../package.json'), 'utf-8');
   const pkg = JSON.parse(pjson);
 
+  const configEnvs = [
+    `XSNAP_VERSION=${pkg.version}`,
+    `CC=cc "-D__has_builtin(x)=1"`,
+  ];
+
+  const configEnvFile = asset('../build.config.env');
+  const existingConfigEnvs = fs.existsSync(configEnvFile)
+    ? await fs.readFile(configEnvFile, 'utf-8')
+    : '';
+
+  const expectedConfigEnvs = configEnvs.concat('').join('\n');
+  if (forceBuild || existingConfigEnvs.trim() !== expectedConfigEnvs.trim()) {
+    await fs.writeFile(configEnvFile, expectedConfigEnvs);
+  }
+
   const platform = ModdableSDK.platforms[os.type()];
   if (!platform) {
     throw Error(`Unsupported OS found: ${os.type()}`);
@@ -241,8 +259,10 @@ const makeXsnap = async ({ spawn, fs, os }) => {
       [
         `MODDABLE=${ModdableSDK.MODDABLE}`,
         `GOAL=${goal}`,
-        `XSNAP_VERSION=${pkg.version}`,
-        `CC=cc "-D__has_builtin(x)=1"`,
+        // Any other configuration variables that affect the build output
+        // should be placed in `configEnvs` to force a rebuild if they change
+        ...configEnvs,
+        `EXTRA_DEPS=${configEnvFile}`,
         '-f',
         'xsnap-worker.mk',
       ],
@@ -263,6 +283,7 @@ const makeXsnap = async ({ spawn, fs, os }) => {
  *     existsSync: typeof import('fs').existsSync,
  *     rmdirSync: typeof import('fs').rmdirSync,
  *     readFile: typeof import('fs').promises.readFile,
+ *     writeFile: typeof import('fs').promises.writeFile,
  *   },
  *   os: {
  *     type: typeof import('os').type,
@@ -328,7 +349,18 @@ async function main(args, { env, stdout, spawn, fs, os }) {
 
   if (!showEnv) {
     if (hasSource) {
-      await makeXsnap({ spawn, fs, os });
+      // Force a rebuild if for some reason the binary is out of date
+      // Since the make checks may not always detect that situation
+      let forceBuild = !hasBin;
+      if (hasBin) {
+        const npm = makeCLI('npm', { spawn });
+        await npm
+          .run(['run', '-s', 'check-version'], { cwd: asset('..') })
+          .catch(() => {
+            forceBuild = true;
+          });
+      }
+      await makeXsnap({ spawn, fs, os }, { forceBuild });
     } else if (!hasBin) {
       throw new Error(
         'XSnap has neither sources nor a pre-built binary. Docker? .dockerignore? npm files?',
@@ -344,6 +376,7 @@ const run = () =>
     spawn: childProcessTop.spawn,
     fs: {
       readFile: fsTop.promises.readFile,
+      writeFile: fsTop.promises.writeFile,
       existsSync: fsTop.existsSync,
       rmdirSync: fsTop.rmdirSync,
     },

package/xsnap-native/xsnap/makefiles/lin/xsnap-worker.mk

@@ -7,6 +7,8 @@ ifneq ($(VERBOSE),1)
 MAKEFLAGS += --silent
 endif
 
+EXTRA_DEPS =
+
 # MODDABLE = $(CURDIR)/../../moddable
 BUILD_DIR = $(CURDIR)/../../build
 TLS_DIR = $(CURDIR)/../../sources
@@ -142,6 +144,7 @@ $(OBJECTS): $(SRC_DIR)/xsAll.h
 $(OBJECTS): $(SRC_DIR)/xsScript.h
 $(OBJECTS): $(SRC_DIR)/xsSnapshot.h
 $(OBJECTS): $(INC_DIR)/xs.h
+$(OBJECTS): $(EXTRA_DEPS)
 $(TMP_DIR)/%.o: %.c
 	@echo "#" $(NAME) $(GOAL) ": cc" $(<F)
 	$(CC) $< $(C_OPTIONS) -c -o $@

package/xsnap-native/xsnap/makefiles/mac/xsnap-worker.mk

@@ -7,6 +7,8 @@ ifneq ($(VERBOSE),1)
 MAKEFLAGS += --silent
 endif
 
+EXTRA_DEPS =
+
 # MODDABLE = $(CURDIR)/../../moddable
 BUILD_DIR = $(CURDIR)/../../build
 TLS_DIR = $(CURDIR)/../../sources
@@ -151,6 +153,7 @@ $(OBJECTS): $(SRC_DIR)/xsAll.h
 $(OBJECTS): $(SRC_DIR)/xsScript.h
 $(OBJECTS): $(SRC_DIR)/xsSnapshot.h
 $(OBJECTS): $(INC_DIR)/xs.h
+$(OBJECTS): $(EXTRA_DEPS)
 $(TMP_DIR)/%.o: %.c
 	@echo "#" $(NAME) $(GOAL) ": cc" $(<F)
 	$(CC) $< $(C_OPTIONS) -c -o $@

package/xsnap-native/xsnap/sources/xsnap-worker.c

@@ -17,6 +17,9 @@
 #define SNAPSHOT_SIGNATURE "xsnap 1"
 #ifndef XSNAP_VERSION
 # error "You must define XSNAP_VERSION in the right Makefile"
+#else
+// Allows grepping the binary's strings for the version: strings xsnap-worker | grep xsnap_version
+char *VERSION = "xsnap_version: " XSNAP_VERSION;
 #endif
 
 #ifndef XSNAP_TEST_RECORD
@@ -182,7 +185,7 @@ typedef enum {
 // 250 syscalls
 #define MAX_TIMESTAMPS 502
 static struct timeval timestamps[MAX_TIMESTAMPS];
-static unsigned int num_timestamps;
+static int num_timestamps;
 static unsigned int timestamps_overrun;
 static void resetTimestamps() {
 	timestamps_overrun = 0;
@@ -210,7 +213,7 @@ static char timestampBuffer[1 + MAX_TIMESTAMPS * (DIGITS_FOR_64 + 1 + 6 + 1) + 1
 
 static char *renderTimestamps() {
 	// return pointer to static string buffer with '[NN.NN,NN.NN]', or NULL
-	unsigned int size, i, wrote;
+	int size, i, wrote;
 	char *p = timestampBuffer;
 	size = sizeof(timestampBuffer); // holds all numbers, commas, and \0
 	*(p++) = '['; size--;
@@ -219,8 +222,17 @@ static char *renderTimestamps() {
 		// been printed if the size were unlimited, not including the
 		// final \0". It writes at most size-1 characters, then writes
 		// the trailing \0.
+		// The type of tv_usec is 32 bits on Darwin and 64 bits on Linux at
+		// time of writing.
+		// We cast into the wider precision to ensure the format specifier gets
+		// the expected number of bits behind the variadic args reference.
+		// We do the same for tv_sec out of an outrageous abundance of caution.
 		wrote = snprintf(p, size, "%lu.%06lu",
-						 timestamps[i].tv_sec, timestamps[i].tv_usec);
+						 (unsigned long)timestamps[i].tv_sec,
+						 (unsigned long)timestamps[i].tv_usec);
+		if (wrote > size) {
+			return NULL;
+		}
 		p += wrote;
 		size -= wrote;
 		if (size < 2) { // 2 is enough for "]\0", but 1 is not
@@ -329,7 +341,7 @@ int main(int argc, char* argv[])
 			return E_SUCCESS;
 		}
 		else if (!strcmp(argv[argi], "-n")) {
-			printf("agoric-upgrade-10\n");
+			printf("deprecated\n");
 			return E_SUCCESS;
 		} else {
 			xsPrintUsage();

package/xsnap-native/xsnap/sources/xsnap.c

@@ -12,7 +12,7 @@ static void xsReplay(xsMachine* machine);
 static void xs_currentMeterLimit(xsMachine* the);
 static void xs_gc(xsMachine* the);
 static void xs_issueCommand(xsMachine* the);
-static void xs_lockdown(xsMachine *the);
+//static void xs_lockdown(xsMachine *the);
 static void xs_performance_now(xsMachine* the);
 static void xs_print(xsMachine* the);
 static void xs_resetMeter(xsMachine* the);
@@ -515,7 +515,6 @@ void xs_currentMeterLimit(xsMachine* the)
 
 void xs_gc(xsMachine* the)
 {
-	fprintf(stderr, "gc()\n");
 	xsCollectGarbage();
 }
 
@@ -565,6 +564,7 @@ void xs_issueCommand(xsMachine* the)
 	fclose(file);
 }
 
+#if 0
 void xs_lockdown(xsMachine *the)
 {
 	fx_lockdown(the);
@@ -609,6 +609,7 @@ void xs_lockdown(xsMachine *the)
 // 	xsResult = xsGet(xsGlobal, xsID("setTimeout"));
 // 	xsCall1(xsGlobal, xsID("harden"), xsResult);
 }
+#endif
 
 void xs_performance_now(xsMachine *the)
 {

package/xsnap-native/xsnap/sources/xsnapPlatform.c

@@ -454,6 +454,8 @@ txID fxFindModule(txMachine* the, txSlot* realm, txID moduleID, txSlot* slot)
 	else
 		slash = path;
 	*slash = 0;
+	if ((c_strlen(path) + c_strlen(name + dot)) >= sizeof(path))
+		mxRangeError("path too long");
 	c_strcat(path, name + dot);
 	return fxNewNameC(the, path);
 }
@@ -802,8 +804,9 @@ void fxDumpSnapshot(txMachine* the, txSnapshot* snapshot)
 {
 	Atom atom;
 	txByte byte;
-	txID profileID;
 	txCreation creation;
+	txID profileID;
+	txInteger tag;
 	Atom blockAtom;
 	txByte* block = C_NULL;
 // 	txByte* blockLimit;
@@ -851,6 +854,7 @@ void fxDumpSnapshot(txMachine* the, txSnapshot* snapshot)
 		atom.atomSize = ntohl(atom.atomSize) - 8;
 		mxThrowIf((*snapshot->read)(snapshot->stream, &creation, sizeof(txCreation)));
 		mxThrowIf((*snapshot->read)(snapshot->stream, &profileID, sizeof(txID)));
+		mxThrowIf((*snapshot->read)(snapshot->stream, &tag, sizeof(txInteger)));
 		fprintf(stderr, "%4.4s %d\n", (txString)&(atom.atomType), atom.atomSize + 8);
 		fprintf(stderr, "\tinitialChunkSize: %d\n", creation.initialChunkSize);
 		fprintf(stderr, "\tincrementalChunkSize: %d\n", creation.incrementalChunkSize);
@@ -865,6 +869,7 @@ void fxDumpSnapshot(txMachine* the, txSnapshot* snapshot)
 		fprintf(stderr, "\tparserTableModulo: %d\n", creation.parserTableModulo);
 		fprintf(stderr, "\tstaticSize: %d\n", creation.staticSize);
 		fprintf(stderr, "\tprofileID: %d\n", profileID);
+		fprintf(stderr, "\ttag: %d\n", tag);
 
 		mxThrowIf((*snapshot->read)(snapshot->stream, &blockAtom, sizeof(Atom)));
 		blockAtom.atomSize = ntohl(blockAtom.atomSize) - 8;