@yowasp/yosys 0.0.0-experimental4 → 0.37.13-dev.628

package/README.md

@@ -0,0 +1,47 @@
+YoWASP Yosys package
+====================
+
+This package provides [Yosys][] binaries built for [WebAssembly][]. See the [overview of the YoWASP project][yowasp] for details.
+
+At the moment, this package only provides an API allowing to run Yosys in a virtual filesystem; no binaries are provided.
+
+This package does not provide access to `sby`, `yowasp-yosys-smtbmc`, and `yowasp-yosys-witness`; only the main `yosys` application is available.
+
+[yosys]: https://github.com/YosysHQ/yosys/
+[webassembly]: https://webassembly.org/
+[yowasp]: https://yowasp.github.io/
+
+
+API reference
+-------------
+
+This package provides one function:
+
+- `runYosys` (alias `cmd:yosys`)
+
+For more detail, see the documentation for [the JavaScript YoWASP runtime](https://github.com/YoWASP/runtime-js#api-reference).
+
+
+Versioning
+----------
+
+The version of this package is derived from the upstream Yosys package version in the `X.Y[.Z][+N]` format, and can be in one of the two formats, `X.Y.M` (for builds from release branches) or `X.(Y+1).N-dev.M` (for development builds), where the symbols are:
+
+1. `X`: Yosys major version
+2. `Y`: Yosys minor version
+3. `Z`: Yosys patch version; ignored if present
+4. `N`: matches the `N` in the `X.Y+N` upstream version, if present
+5. `M`: package build version; disambiguates different builds produced from the same Yosys source tree
+6. `-dev`: present only for packages built from unreleased Yosys snapshots; marks these packages as pre-releases
+
+With this scheme, there is a direct correspondence between upstream versions and [SemVer][semver] NPM package versions.
+
+Note that for development builds, the minor version is incremented as required by the SemVer comparison order. This means that an NPM package built from the upstream version `0.45+12` and the 120th commit in this repository will have the version `0.46.12-dev.120`. Because this is a pre-release package, it will not be matched by version specifiers such as `^0.46` or `>=0.46`.
+
+[semver]: https://semver.org/
+
+
+License
+-------
+
+This package is covered by the [ISC license](LICENSE.txt), which is the same as the [Yosys license](https://github.com/YosysHQ/yosys/blob/master/COPYING).

package/gen/bundle-browser.js

@@ -14,6 +14,15 @@ function wallClockNow() {
   const nanoseconds = now % 1e3 * 1e6;
   return { seconds, nanoseconds };
 }
+var randomBytesImpl = function() {
+  throw "not implemented";
+};
+function setRandomBytesImpl(impl) {
+  randomBytesImpl = impl;
+}
+function getRandomBytes(len) {
+  return randomBytesImpl(Number(len));
+}
 var IoError = class extends Error {
 };
 var InputStream = class {
@@ -201,9 +210,21 @@ var Descriptor = class _Descriptor {
     }
     return new _Descriptor(openEntry);
   }
+  read(length, offset) {
+    if (this.entry instanceof Directory)
+      throw "is-directory";
+    [length, offset] = [Number(length), Number(offset)];
+    return [this.entry.data.subarray(offset, offset + length), offset + length >= this.entry.data.byteLength];
+  }
   readViaStream(offset) {
     return new ReadStream(this.entry, offset);
   }
+  write(_buffer, _offset) {
+    if (this.entry instanceof Directory)
+      throw "is-directory";
+    console.error("Descriptor.write not implemented");
+    throw "unsupported";
+  }
   writeViaStream(offset) {
     return new WriteStream(this.entry, offset);
   }
@@ -253,13 +274,19 @@ function directoryFromTree(tree) {
   }
   return new Directory(files);
 }
-function directoryIntoTree(directory) {
+function directoryIntoTree(directory, { decodeASCII = true } = {}) {
+  function isASCII(buffer) {
+    for (const byte of buffer)
+      if (byte < 32 && byte !== 9 && byte !== 10 && byte !== 13 || byte >= 127)
+        return false;
+    return true;
+  }
   const tree = {};
   for (const [filename, entry] of Object.entries(directory.files)) {
     if (entry instanceof File)
-      tree[filename] = new TextDecoder().decode(entry.data);
+      tree[filename] = decodeASCII && isASCII(entry.data) ? new TextDecoder().decode(entry.data) : entry.data;
     if (entry instanceof Directory)
-      tree[filename] = directoryIntoTree(entry);
+      tree[filename] = directoryIntoTree(entry, { decodeASCII });
   }
   return tree;
 }
@@ -280,6 +307,9 @@ var Environment = class {
       wallClock: {
         now: wallClockNow
       },
+      random: {
+        getRandomBytes
+      },
       io: {
         Error: IoError,
         InputStream,
@@ -339,51 +369,89 @@ var Environment = class {
 
 // node_modules/@yowasp/runtime/lib/api-base.js
 var BaseApplication = class {
-  constructor(getResources, wasmModules, instantiate2, argv0) {
-    this._resources = null;
-    this.getResources = getResources;
-    this.wasmModules = wasmModules;
+  constructor(resourceFileURL2, instantiate2, argv0) {
+    this.resourceFileURL = resourceFileURL2;
+    this.resources = null;
     this.instantiate = instantiate2;
     this.argv0 = argv0;
   }
-  async run(args, files = {}, printLine = console.log) {
-    if (this._resources === null)
-      this._resources = await this.getResources();
+  async run(args = null, files = {}, { printLine = console.log, decodeASCII = true } = {}) {
+    if (this.resources === null)
+      this.resources = await this._fetchResources();
+    if (args === null)
+      return;
     const environment = new Environment();
     environment.args = [this.argv0].concat(args);
     environment.root = directoryFromTree(files);
-    for (const [dirName, resourceFiles] of Object.entries(this._resources))
-      environment.root.files[dirName] = directoryFromTree(resourceFiles);
+    for (const [dirName, dirContents] of Object.entries(this.resources.filesystem))
+      environment.root.files[dirName] = directoryFromTree(dirContents);
     environment.printLine = printLine;
     const wasmCommand = await this.instantiate(
-      (filename) => this.wasmModules[filename],
+      (filename) => this.resources.modules[filename],
       { runtime: environment.exports }
     );
+    let error = null;
     try {
       wasmCommand.run.run();
     } catch (e) {
-      if (!(e instanceof Exit && e.code === 0))
+      if (!(e instanceof Exit))
         throw e;
+      if (e instanceof Exit && e.code !== 0)
+        error = e;
     }
-    for (const dirName of Object.keys(this._resources))
+    for (const dirName of Object.keys(this.resources.filesystem))
       delete environment.root.files[dirName];
-    return directoryIntoTree(environment.root);
+    files = directoryIntoTree(environment.root, { decodeASCII });
+    if (error !== null) {
+      error.files = files;
+      throw error;
+    } else {
+      return files;
+    }
+  }
+  async _fetchResources() {
+    console.log(`[YoWASP runtime] Fetching resource bundle ${this.resourceFileURL}`);
+    const { modules, filesystem } = await import(this.resourceFileURL);
+    return {
+      modules: await this._fetchObject(modules, this._fetchWebAssembly),
+      filesystem: await this._fetchObject(filesystem, this._fetchUint8Array)
+    };
+  }
+  async _fetchObject(obj, fetchFn) {
+    for (const [key, value] of Object.entries(obj)) {
+      if (value instanceof URL) {
+        console.log(`[YoWASP runtime] Fetching resource file ${value}`);
+        obj[key] = await fetchFn(value);
+      } else if (typeof value === "string" || value instanceof Uint8Array) {
+        obj[key] = value;
+      } else {
+        obj[key] = await this._fetchObject(value, fetchFn);
+      }
+    }
+    return obj;
+  }
+  async _fetchUint8Array(_url) {
+    throw "not implemented";
+  }
+  async _fetchWebAssembly(_url) {
+    throw "not implemented";
   }
 };
 
 // node_modules/@yowasp/runtime/lib/api-browser.js
+setRandomBytesImpl(function(length) {
+  const QUOTA = 65536;
+  const bytes = new Uint8Array(length);
+  for (var offset = 0; offset < length; offset += QUOTA)
+    crypto.getRandomValues(bytes.slice(offset, offset + QUOTA));
+  return bytes;
+});
 var Application = class extends BaseApplication {
-  constructor(baseURL, resourceFilenames, wasmFilenames, instantiate2, argv0) {
-    async function getResources() {
-      const resources = {};
-      for (const [dirName, jsonFilename] of Object.entries(resourceFilenames))
-        resources[dirName] = await fetch(new URL(jsonFilename, baseURL)).then((resp) => resp.json());
-      return resources;
-    }
-    const wasmModules = {};
-    for (const [modName, wasmFilename] of Object.entries(wasmFilenames))
-      wasmModules[modName] = fetch(new URL(wasmFilename, baseURL)).then(WebAssembly.compileStreaming);
-    super(getResources, wasmModules, instantiate2, argv0);
+  _fetchUint8Array(url) {
+    return fetch(url).then((resp) => resp.arrayBuffer()).then((buf) => new Uint8Array(buf));
+  }
+  _fetchWebAssembly(url) {
+    return fetch(url).then(WebAssembly.compileStreaming);
   }
 };
 
@@ -4537,16 +4605,12 @@ async function instantiate(getCoreModule, imports, instantiateCore = WebAssembly
 }
 
 // lib/api.js
-var yosys = new Application(import.meta.url, {
-  "share": "./yosys-share.json"
-}, {
-  "yosys.core.wasm": "./yosys.core.wasm",
-  "yosys.core2.wasm": "./yosys.core2.wasm",
-  "yosys.core3.wasm": "./yosys.core3.wasm",
-  "yosys.core4.wasm": "./yosys.core4.wasm"
-}, instantiate, "yowasp-yosys");
+var resourceFileURL = new URL("./resources-yosys.js", import.meta.url);
+var yosys = new Application(resourceFileURL, instantiate, "yowasp-yosys");
 var runYosys = yosys.run.bind(yosys);
+var commands = { "yosys": runYosys };
 export {
   Exit,
+  commands,
   runYosys
 };

package/gen/bundle-node.js

@@ -1,5 +1,5 @@
 // node_modules/@yowasp/runtime/lib/api-node.js
-import { readFile } from "fs/promises";
+import { randomBytes } from "crypto";
 
 // node_modules/@yowasp/runtime/lib/wasi-virt.js
 var Exit = class extends Error {
@@ -17,6 +17,15 @@ function wallClockNow() {
   const nanoseconds = now % 1e3 * 1e6;
   return { seconds, nanoseconds };
 }
+var randomBytesImpl = function() {
+  throw "not implemented";
+};
+function setRandomBytesImpl(impl) {
+  randomBytesImpl = impl;
+}
+function getRandomBytes(len) {
+  return randomBytesImpl(Number(len));
+}
 var IoError = class extends Error {
 };
 var InputStream = class {
@@ -204,9 +213,21 @@ var Descriptor = class _Descriptor {
     }
     return new _Descriptor(openEntry);
   }
+  read(length, offset) {
+    if (this.entry instanceof Directory)
+      throw "is-directory";
+    [length, offset] = [Number(length), Number(offset)];
+    return [this.entry.data.subarray(offset, offset + length), offset + length >= this.entry.data.byteLength];
+  }
   readViaStream(offset) {
     return new ReadStream(this.entry, offset);
   }
+  write(_buffer, _offset) {
+    if (this.entry instanceof Directory)
+      throw "is-directory";
+    console.error("Descriptor.write not implemented");
+    throw "unsupported";
+  }
   writeViaStream(offset) {
     return new WriteStream(this.entry, offset);
   }
@@ -256,13 +277,19 @@ function directoryFromTree(tree) {
   }
   return new Directory(files);
 }
-function directoryIntoTree(directory) {
+function directoryIntoTree(directory, { decodeASCII = true } = {}) {
+  function isASCII(buffer) {
+    for (const byte of buffer)
+      if (byte < 32 && byte !== 9 && byte !== 10 && byte !== 13 || byte >= 127)
+        return false;
+    return true;
+  }
   const tree = {};
   for (const [filename, entry] of Object.entries(directory.files)) {
     if (entry instanceof File)
-      tree[filename] = new TextDecoder().decode(entry.data);
+      tree[filename] = decodeASCII && isASCII(entry.data) ? new TextDecoder().decode(entry.data) : entry.data;
     if (entry instanceof Directory)
-      tree[filename] = directoryIntoTree(entry);
+      tree[filename] = directoryIntoTree(entry, { decodeASCII });
   }
   return tree;
 }
@@ -283,6 +310,9 @@ var Environment = class {
       wallClock: {
         now: wallClockNow
       },
+      random: {
+        getRandomBytes
+      },
       io: {
         Error: IoError,
         InputStream,
@@ -340,53 +370,88 @@ var Environment = class {
   }
 };
 
+// node_modules/@yowasp/runtime/lib/api-node.js
+import { readFile } from "fs/promises";
+
 // node_modules/@yowasp/runtime/lib/api-base.js
 var BaseApplication = class {
-  constructor(getResources, wasmModules, instantiate2, argv0) {
-    this._resources = null;
-    this.getResources = getResources;
-    this.wasmModules = wasmModules;
+  constructor(resourceFileURL2, instantiate2, argv0) {
+    this.resourceFileURL = resourceFileURL2;
+    this.resources = null;
     this.instantiate = instantiate2;
     this.argv0 = argv0;
   }
-  async run(args, files = {}, printLine = console.log) {
-    if (this._resources === null)
-      this._resources = await this.getResources();
+  async run(args = null, files = {}, { printLine = console.log, decodeASCII = true } = {}) {
+    if (this.resources === null)
+      this.resources = await this._fetchResources();
+    if (args === null)
+      return;
     const environment = new Environment();
     environment.args = [this.argv0].concat(args);
     environment.root = directoryFromTree(files);
-    for (const [dirName, resourceFiles] of Object.entries(this._resources))
-      environment.root.files[dirName] = directoryFromTree(resourceFiles);
+    for (const [dirName, dirContents] of Object.entries(this.resources.filesystem))
+      environment.root.files[dirName] = directoryFromTree(dirContents);
     environment.printLine = printLine;
     const wasmCommand = await this.instantiate(
-      (filename) => this.wasmModules[filename],
+      (filename) => this.resources.modules[filename],
       { runtime: environment.exports }
     );
+    let error = null;
     try {
       wasmCommand.run.run();
     } catch (e) {
-      if (!(e instanceof Exit && e.code === 0))
+      if (!(e instanceof Exit))
         throw e;
+      if (e instanceof Exit && e.code !== 0)
+        error = e;
     }
-    for (const dirName of Object.keys(this._resources))
+    for (const dirName of Object.keys(this.resources.filesystem))
       delete environment.root.files[dirName];
-    return directoryIntoTree(environment.root);
+    files = directoryIntoTree(environment.root, { decodeASCII });
+    if (error !== null) {
+      error.files = files;
+      throw error;
+    } else {
+      return files;
+    }
+  }
+  async _fetchResources() {
+    console.log(`[YoWASP runtime] Fetching resource bundle ${this.resourceFileURL}`);
+    const { modules, filesystem } = await import(this.resourceFileURL);
+    return {
+      modules: await this._fetchObject(modules, this._fetchWebAssembly),
+      filesystem: await this._fetchObject(filesystem, this._fetchUint8Array)
+    };
+  }
+  async _fetchObject(obj, fetchFn) {
+    for (const [key, value] of Object.entries(obj)) {
+      if (value instanceof URL) {
+        console.log(`[YoWASP runtime] Fetching resource file ${value}`);
+        obj[key] = await fetchFn(value);
+      } else if (typeof value === "string" || value instanceof Uint8Array) {
+        obj[key] = value;
+      } else {
+        obj[key] = await this._fetchObject(value, fetchFn);
+      }
+    }
+    return obj;
+  }
+  async _fetchUint8Array(_url) {
+    throw "not implemented";
+  }
+  async _fetchWebAssembly(_url) {
+    throw "not implemented";
   }
 };
 
 // node_modules/@yowasp/runtime/lib/api-node.js
+setRandomBytesImpl(randomBytes);
 var Application = class extends BaseApplication {
-  constructor(baseURL, resourceFilenames, wasmFilenames, instantiate2, argv0) {
-    async function getResources() {
-      const resources = {};
-      for (const [dirName, jsonFilename] of Object.entries(resourceFilenames))
-        resources[dirName] = JSON.parse(await readFile(new URL(jsonFilename, baseURL)));
-      return resources;
-    }
-    const wasmModules = {};
-    for (const [modName, wasmFilename] of Object.entries(wasmFilenames))
-      wasmModules[modName] = readFile(new URL(wasmFilename, baseURL)).then(WebAssembly.compile);
-    super(getResources, wasmModules, instantiate2, argv0);
+  _fetchUint8Array(url) {
+    return readFile(url);
+  }
+  _fetchWebAssembly(url) {
+    return readFile(url).then(WebAssembly.compile);
   }
 };
 
@@ -4540,16 +4605,12 @@ async function instantiate(getCoreModule, imports, instantiateCore = WebAssembly
 }
 
 // lib/api.js
-var yosys = new Application(import.meta.url, {
-  "share": "./yosys-share.json"
-}, {
-  "yosys.core.wasm": "./yosys.core.wasm",
-  "yosys.core2.wasm": "./yosys.core2.wasm",
-  "yosys.core3.wasm": "./yosys.core3.wasm",
-  "yosys.core4.wasm": "./yosys.core4.wasm"
-}, instantiate, "yowasp-yosys");
+var resourceFileURL = new URL("./resources-yosys.js", import.meta.url);
+var yosys = new Application(resourceFileURL, instantiate, "yowasp-yosys");
 var runYosys = yosys.run.bind(yosys);
+var commands = { "yosys": runYosys };
 export {
   Exit,
+  commands,
   runYosys
 };