yosys2digitaljs 0.9.0 → 0.9.2

package/README.md

@@ -1,5 +1,5 @@
 # yosys2digitaljs
-This program converts JSON netlist output generated by [Yosys](https://yosyshq.net/yosys/) 
+This program converts JSON netlist output generated by [Yosys](https://yosyshq.net/yosys/)
 circuit synthesis software (Github repo [here](https://github.com/YosysHQ/yosys/)) for use with the
 [DigitalJS](http://github.com/tilk/digitaljs) graphical circuit simulator.
 
@@ -26,8 +26,8 @@ Yosys2digitaljs can be used as a library. The API is promise (or async/await) ba
 
  - `yosys2digitaljs(json, options)` - converts the Yosys JSON output `json` (passed as an JS object) to a DigitalJS representation of the same circuit.
  - `process_sv(sv_text, options)` - converts a single SystemVerilog source passed as a string.
- - `process_files(texts, options)` - converts multiple Verilog/SystemVerilog sources. The `texts` parameter is an object, with keys being file names, and corresponding values containing the file contents as strings. Example: `{ 'test.sv': 'module test; ...' }`.
- - `process(filenames, dirname, options)` - converts Verilog/SystemVerilog sources saved on the filesystem under names `filenames` in the directory `dirname`.
+ - `process_files(texts, options)` - converts multiple Verilog/SystemVerilog/RTLIL sources. The `texts` parameter is an object, with keys being file names, and corresponding values containing the file contents as strings. Example: `{ 'test.sv': 'module test; ...' }`.
+ - `process(filenames, dirname, options)` - converts Verilog/SystemVerilog/RTLIL sources saved on the filesystem under names `filenames` in the directory `dirname`.
 
 The functions return a promise, which fulfills with an object value with following keys:
 

package/dist/core.d.ts

@@ -130,9 +130,11 @@ declare namespace Yosys {
         };
     };
 }
-export type ConvertOptions = {
+export declare type ConvertOptions = {
     propagation?: number;
 };
 export declare function yosys2digitaljs(obj: Yosys.Output, options?: ConvertOptions): Digitaljs.TopModule;
 export declare function io_ui(output: Digitaljs.Module): void;
+export declare function prepare_yosys_script(filenames: string[], options: Options): string;
+export declare function prepare_verilator_args(filenames: string[]): string[];
 export {};

package/dist/core.js

@@ -1,8 +1,7 @@
 #!/usr/bin/env node
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.yosys2digitaljs = yosys2digitaljs;
-exports.io_ui = io_ui;
+exports.prepare_verilator_args = exports.prepare_yosys_script = exports.io_ui = exports.yosys2digitaljs = void 0;
 const HashMap = require("hashmap");
 const bigInt = require("big-integer");
 const _3vl_1 = require("3vl");
@@ -1012,6 +1011,7 @@ function yosys2digitaljs(obj, options = {}) {
         output.subcircuits[x] = out[x];
     return output;
 }
+exports.yosys2digitaljs = yosys2digitaljs;
 function io_ui(output) {
     for (const [name, dev] of Object.entries(output.devices)) {
         if (dev.type == 'Input' || dev.type == 'Output') {
@@ -1034,3 +1034,62 @@ function io_ui(output) {
         }
     }
 }
+exports.io_ui = io_ui;
+function ansi_c_escape_contents(cmd) {
+    function func(ch) {
+        if (ch == '\t')
+            return '\\t';
+        if (ch == '\r')
+            return '\\r';
+        if (ch == '\n')
+            return '\\n';
+        return '\\x' + ch.charCodeAt(0).toString(16).padStart(2, '0');
+    }
+    return cmd.replace(/(["'\\])/g, '\\$1')
+        .replace(/[\x00-\x1F\x7F-\x9F]/g, func);
+}
+function ansi_c_escape(cmd) {
+    return '"' + ansi_c_escape_contents(cmd) + '"';
+}
+function shell_escape_contents(cmd) {
+    return cmd.replace(/(["\r\n$`\\])/g, '\\$1');
+}
+function shell_escape(cmd) {
+    return '"' + shell_escape_contents(cmd) + '"';
+}
+function process_filename(filename) {
+    var _a;
+    const ext = (_a = filename.match(/\.[a-z]+$/)) === null || _a === void 0 ? void 0 : _a[0];
+    const commands = {
+        '.il': 'read_rtlil',
+        '.sv': 'read_verilog -sv',
+        '.v': 'read_verilog',
+        '.vh': 'read_verilog'
+    };
+    if (ext && ext in commands) {
+        return `${commands[ext]} ${ansi_c_escape(filename)}`;
+    }
+    else {
+        return '';
+    }
+}
+function prepare_yosys_script(filenames, options) {
+    const optimize_simp = options.optimize ? "opt" : "opt_clean";
+    const optimize = options.optimize ? "opt -full" : "opt_clean";
+    const fsmexpand = options.fsmexpand ? " -expand" : "";
+    const fsmpass = options.fsm == "nomap"
+        ? "fsm -nomap" + fsmexpand
+        : options.fsm
+            ? "fsm" + fsmexpand
+            : "";
+    const readFilesScript = filenames
+        .map((filename) => process_filename(filename));
+    const yosysScript = [...readFilesScript, 'setattr -mod -unset top', 'hierarchy -auto-top', 'proc', optimize_simp, fsmpass, 'memory -nomap', 'wreduce -memx', optimize];
+    return yosysScript.join('; ');
+}
+exports.prepare_yosys_script = prepare_yosys_script;
+function prepare_verilator_args(filenames) {
+    const processed_filenames = filenames.map(shell_escape);
+    return ['-lint-only', '-Wall', '-Wno-DECLFILENAME', '-Wno-UNOPT', '-Wno-UNOPTFLAT', ...processed_filenames];
+}
+exports.prepare_verilator_args = prepare_verilator_args;

package/dist/index.d.ts

@@ -1,20 +1,20 @@
 #!/usr/bin/env node
 import { ConvertOptions, Digitaljs } from './core';
-type Options = ConvertOptions & {
+declare type Options = ConvertOptions & {
     optimize?: boolean;
     fsmexpand?: boolean;
     fsm?: boolean | "nomap";
     timeout?: number;
     lint?: boolean;
 };
-type Output = {
+declare type Output = {
     output?: Digitaljs.TopModule;
     yosys_output?: any;
     yosys_stdout: string;
     yosys_stderr: string;
     lint?: LintMessage[];
 };
-type LintMessage = {
+declare type LintMessage = {
     type: string;
     file: string;
     line: number;

package/dist/index.js

@@ -1,10 +1,7 @@
 #!/usr/bin/env node
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.verilator_lint = verilator_lint;
-exports.process = process;
-exports.process_files = process_files;
-exports.process_sv = process_sv;
+exports.process_sv = exports.process_files = exports.process = exports.verilator_lint = void 0;
 const tmp = require("tmp-promise");
 const child_process = require("child_process");
 const fs = require("fs");
@@ -12,37 +9,11 @@ const path = require("path");
 const util_1 = require("util");
 const core_1 = require("./core");
 const sanitize = require('sanitize-filename');
-function ansi_c_escape_contents(cmd) {
-    function func(ch) {
-        if (ch == '\t')
-            return '\\t';
-        if (ch == '\r')
-            return '\\r';
-        if (ch == '\n')
-            return '\\n';
-        return '\\x' + ch.charCodeAt(0).toString(16).padStart(2, '0');
-    }
-    return cmd.replace(/(["'\\])/g, '\\$1')
-        .replace(/[\x00-\x1F\x7F-\x9F]/g, func);
-}
-function ansi_c_escape(cmd) {
-    return '"' + ansi_c_escape_contents(cmd) + '"';
-}
-function shell_escape_contents(cmd) {
-    return cmd.replace(/(["\r\n$`\\])/g, '\\$1');
-}
-function shell_escape(cmd) {
-    return '"' + shell_escape_contents(cmd) + '"';
-}
-function process_filename(filename) {
-    const flags = /\.sv$/.test(filename) ? " -sv" : "";
-    return "read_verilog" + flags + " " + ansi_c_escape(filename);
-}
 const verilator_re = /^%(Warning|Error)[^:]*: ([^:]*):([0-9]+):([0-9]+): (.*)$/;
 async function verilator_lint(filenames, dirname, options = {}) {
     try {
         const output = [];
-        const verilator_result = await (0, util_1.promisify)(child_process.exec)('timeout -k10s 40s verilator -lint-only -Wall -Wno-DECLFILENAME -Wno-UNOPT -Wno-UNOPTFLAT ' + filenames.map(shell_escape).join(' '), { maxBuffer: 1000000, cwd: dirname || null, timeout: options.timeout || 60000 })
+        const verilator_result = await (0, util_1.promisify)(child_process.exec)(`timeout -k10s 40s verilator ${(0, core_1.prepare_verilator_args)(filenames).join(' ')}`, { maxBuffer: 1000000, cwd: dirname || null, timeout: options.timeout || 60000 })
             .catch(exc => exc);
         for (const line of verilator_result.stderr.split('\n')) {
             const result = line.match(verilator_re);
@@ -62,18 +33,11 @@ async function verilator_lint(filenames, dirname, options = {}) {
         return null;
     }
 }
+exports.verilator_lint = verilator_lint;
 async function process(filenames, dirname, options = {}) {
-    const optimize_simp = options.optimize ? "; opt" : "; opt_clean";
-    const optimize = options.optimize ? "; opt -full" : "; opt_clean";
-    const fsmexpand = options.fsmexpand ? " -expand" : "";
-    const fsmpass = options.fsm == "nomap" ? "; fsm -nomap" + fsmexpand
-        : options.fsm ? "; fsm" + fsmexpand
-            : "";
     const tmpjson = await tmp.tmpName({ postfix: '.json' });
     let obj = undefined;
-    const yosys_result = await (0, util_1.promisify)(child_process.exec)('timeout -k10s 40s yosys -p "' + shell_escape_contents(filenames.map(process_filename).join('; ')) +
-        '; hierarchy -auto-top; proc' + optimize_simp + fsmpass + '; memory -nomap; wreduce -memx' +
-        optimize + '" -o "' + tmpjson + '"', { maxBuffer: 1000000, cwd: dirname || null, timeout: options.timeout || 60000 })
+    const yosys_result = await (0, util_1.promisify)(child_process.exec)(`timeout -k10s 40s yosys -p "${(0, core_1.prepare_yosys_script)(filenames, options)}" -o ${tmpjson}`, { maxBuffer: 1000000, cwd: dirname || null, timeout: options.timeout || 60000 })
         .catch(exc => exc);
     try {
         if (yosys_result instanceof Error) {
@@ -106,6 +70,7 @@ async function process(filenames, dirname, options = {}) {
         throw exc;
     }
 }
+exports.process = process;
 async function process_files(data, options = {}) {
     const dir = await tmp.dir();
     const names = [];
@@ -113,7 +78,7 @@ async function process_files(data, options = {}) {
         for (const [name, content] of Object.entries(data)) {
             const sname = sanitize(name);
             await (0, util_1.promisify)(fs.writeFile)(path.resolve(dir.path, sname), content);
-            if (/\.(v|sv)$/.test(sname))
+            if (/\.(v|sv|il)$/.test(sname))
                 names.push(sname);
         }
         return await process(names, dir.path, options);
@@ -125,6 +90,7 @@ async function process_files(data, options = {}) {
         dir.cleanup();
     }
 }
+exports.process_files = process_files;
 async function process_sv(text, options = {}) {
     const tmpsv = await tmp.file({ postfix: '.sv' });
     try {
@@ -136,3 +102,4 @@ async function process_sv(text, options = {}) {
         tmpsv.cleanup();
     }
 }
+exports.process_sv = process_sv;

package/dist/types.d.ts

@@ -129,43 +129,43 @@ declare namespace Yosys {
         };
     };
 }
-type ConvertOptions = {
+declare type ConvertOptions = {
     propagation?: number;
 };
-type Options = ConvertOptions & {
+declare type Options = ConvertOptions & {
     optimize?: boolean;
     fsmexpand?: boolean;
     fsm?: boolean | "nomap";
     timeout?: number;
     lint?: boolean;
 };
-type Output = {
+declare type Output = {
     output?: Digitaljs.TopModule;
     yosys_output?: any;
     yosys_stdout: string;
     yosys_stderr: string;
     lint?: LintMessage[];
 };
-type Portmap = {
+declare type Portmap = {
     [key: string]: string;
 };
-type Portmaps = {
+declare type Portmaps = {
     [key: string]: Portmap;
 };
-type Bit = Yosys.Bit | `bit${number}`;
-type Net = Bit[];
-type NetInfo = {
+declare type Bit = Yosys.Bit | `bit${number}`;
+declare type Net = Bit[];
+declare type NetInfo = {
     source: undefined | Digitaljs.Port;
     targets: Digitaljs.Port[];
     name: undefined | string;
     source_positions: Digitaljs.SourcePosition[];
 };
-type BitInfo = {
+declare type BitInfo = {
     id: string;
     port: string;
     num: number;
 };
-type LintMessage = {
+declare type LintMessage = {
     type: string;
     file: string;
     line: number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "yosys2digitaljs",
-  "version": "0.9.0",
+  "version": "0.9.2",
   "description": "Export Yosys netlists to a logic simulator",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/run_tests.sh

@@ -1,6 +1,6 @@
 #!/bin/bash
 
-for X in tests/*.sv; do
+for X in tests/*.sv tests/*.il; do
     echo $X
     ./process.js $X > /dev/null || exit 1
 done

package/src/core.ts

@@ -1158,3 +1158,65 @@ export function io_ui(output: Digitaljs.Module) {
         }
     }
 }
+
+function ansi_c_escape_contents(cmd: string): string {
+    function func(ch: string) {
+        if (ch == '\t') return '\\t';
+        if (ch == '\r') return '\\r';
+        if (ch == '\n') return '\\n';
+        return '\\x' + ch.charCodeAt(0).toString(16).padStart(2, '0');
+    }
+    return cmd.replace(/(["'\\])/g,'\\$1')
+              .replace(/[\x00-\x1F\x7F-\x9F]/g, func);
+}
+
+function ansi_c_escape(cmd: string): string {
+    return '"' + ansi_c_escape_contents(cmd) + '"';
+}
+
+function shell_escape_contents(cmd: string): string {
+    return cmd.replace(/(["\r\n$`\\])/g,'\\$1');
+}
+
+function shell_escape(cmd: string): string {
+    return '"' + shell_escape_contents(cmd) + '"';
+}
+
+function process_filename(filename: string): string {
+    const ext = filename.match(/\.[a-z]+$/)?.[0];
+
+    const commands: { [key: string]: string } = {
+        '.il': 'read_rtlil',
+        '.sv': 'read_verilog -sv',
+        '.v': 'read_verilog',
+        '.vh': 'read_verilog'
+    };
+
+    if (ext && ext in commands) {
+        return `${commands[ext]} ${ansi_c_escape(filename)}`;
+    } else {
+        return ''
+    }
+}
+
+export function prepare_yosys_script(filenames: string[], options: Options): string {
+    const optimize_simp = options.optimize ? "opt" : "opt_clean";
+    const optimize = options.optimize ? "opt -full" : "opt_clean";
+    const fsmexpand = options.fsmexpand ? " -expand" : "";
+    const fsmpass = options.fsm == "nomap"
+                ? "fsm -nomap" + fsmexpand
+                : options.fsm
+                    ? "fsm" + fsmexpand
+                    : "";
+
+    const readFilesScript = filenames
+        .map((filename) => process_filename(filename))
+
+    const yosysScript = [...readFilesScript, 'setattr -mod -unset top', 'hierarchy -auto-top', 'proc', optimize_simp, fsmpass, 'memory -nomap', 'wreduce -memx', optimize]
+    return yosysScript.join('; ');
+}
+
+export function prepare_verilator_args(filenames: string[]): string[] {
+    const processed_filenames = filenames.map(shell_escape);
+    return ['-lint-only', '-Wall', '-Wno-DECLFILENAME', '-Wno-UNOPT', '-Wno-UNOPTFLAT', ...processed_filenames];
+}

package/src/index.ts

@@ -6,7 +6,7 @@ import * as child_process from 'child_process';
 import * as fs from 'fs';
 import * as path from 'path';
 import { promisify } from 'util';
-import { yosys2digitaljs, ConvertOptions, Digitaljs } from './core';
+import { prepare_yosys_script, prepare_verilator_args, yosys2digitaljs, ConvertOptions, Digitaljs } from './core';
 const sanitize = require('sanitize-filename');
 
 type Options = ConvertOptions & {
@@ -33,42 +33,13 @@ type LintMessage = {
     message: string
 };
 
-
-function ansi_c_escape_contents(cmd: string): string {
-    function func(ch: string) {
-        if (ch == '\t') return '\\t';
-        if (ch == '\r') return '\\r';
-        if (ch == '\n') return '\\n';
-        return '\\x' + ch.charCodeAt(0).toString(16).padStart(2, '0');
-    }
-    return cmd.replace(/(["'\\])/g,'\\$1')
-              .replace(/[\x00-\x1F\x7F-\x9F]/g, func);
-}
-
-function ansi_c_escape(cmd: string): string {
-    return '"' + ansi_c_escape_contents(cmd) + '"';
-}
-
-function shell_escape_contents(cmd: string): string {
-    return cmd.replace(/(["\r\n$`\\])/g,'\\$1');
-}
-
-function shell_escape(cmd: string): string {
-    return '"' + shell_escape_contents(cmd) + '"';
-}
-
-function process_filename(filename: string): string {
-    const flags = /\.sv$/.test(filename) ? " -sv" : "";
-    return "read_verilog" + flags + " " + ansi_c_escape(filename);
-}
-
 const verilator_re = /^%(Warning|Error)[^:]*: ([^:]*):([0-9]+):([0-9]+): (.*)$/;
 
 export async function verilator_lint(filenames: string[], dirname?: string, options: Options = {}): Promise<LintMessage[]> {
     try {
         const output: LintMessage[] = [];
         const verilator_result: {stdout: string, stderr: string} = await promisify(child_process.exec)(
-            'timeout -k10s 40s verilator -lint-only -Wall -Wno-DECLFILENAME -Wno-UNOPT -Wno-UNOPTFLAT ' + filenames.map(shell_escape).join(' '),
+            `timeout -k10s 40s verilator ${prepare_verilator_args(filenames).join(' ')}`,
             {maxBuffer: 1000000, cwd: dirname || null, timeout: options.timeout || 60000})
             .catch(exc => exc);
         for (const line of verilator_result.stderr.split('\n')) {
@@ -89,23 +60,15 @@ export async function verilator_lint(filenames: string[], dirname?: string, opti
 }
 
 export async function process(filenames: string[], dirname?: string, options: Options = {}): Promise<Output> {
-    const optimize_simp = options.optimize ? "; opt" : "; opt_clean";
-    const optimize = options.optimize ? "; opt -full" : "; opt_clean";
-    const fsmexpand = options.fsmexpand ? " -expand" : "";
-    const fsmpass = options.fsm == "nomap" ? "; fsm -nomap" + fsmexpand
-                  : options.fsm ? "; fsm" + fsmexpand
-                  : "";
     const tmpjson = await tmp.tmpName({ postfix: '.json' });
     let obj = undefined;
     const yosys_result: {stdout: string, stderr: string, killed?: boolean, code?: number} = await promisify(child_process.exec)(
-        'timeout -k10s 40s yosys -p "' + shell_escape_contents(filenames.map(process_filename).join('; ')) +
-        '; hierarchy -auto-top; proc' + optimize_simp + fsmpass + '; memory -nomap; wreduce -memx' +
-        optimize + '" -o "' + tmpjson + '"',
+        `timeout -k10s 40s yosys -p "${prepare_yosys_script(filenames, options)}" -o ${tmpjson}`,
         {maxBuffer: 1000000, cwd: dirname || null, timeout: options.timeout || 60000})
         .catch(exc => exc);
     try {
         if (yosys_result instanceof Error) {
-            if (yosys_result.killed) 
+            if (yosys_result.killed)
                 yosys_result.message = "Yosys killed"
             else if (yosys_result.code)
                 yosys_result.message = "Yosys failed with code " + yosys_result.code;
@@ -140,7 +103,7 @@ export async function process_files(data: {[key: string]: string}, options: Opti
         for (const [name, content] of Object.entries(data)) {
             const sname = sanitize(name);
             await promisify(fs.writeFile)(path.resolve(dir.path, sname), content);
-            if (/\.(v|sv)$/.test(sname)) names.push(sname);
+            if (/\.(v|sv|il)$/.test(sname)) names.push(sname);
         }
         return await process(names, dir.path, options);
     } finally {

package/tests/overflow_counter.il

@@ -0,0 +1,78 @@
+attribute \generator "Amaranth"
+attribute \src "<exec>:18"
+attribute \top 1
+module \top
+
+  attribute \src "<exec>:13"
+  attribute \init 4'0000
+  wire width 4 \count
+
+  attribute \src "<exec>:8"
+  wire width 1 input 0  \en
+
+  attribute \src "/lib/python3.11/site-packages/amaranth/hdl/_ir.py:283"
+  wire width 1 input 1  \clk
+
+  attribute \src "/lib/python3.11/site-packages/amaranth/hdl/_ir.py:283"
+  wire width 1 input 2  \rst
+
+  attribute \src "<exec>:9"
+  wire width 1 output 3  \ovf
+
+  wire width 5 $1
+
+  wire width 4 $2
+
+  attribute \src "<exec>:19"
+  cell $eq $3
+    parameter \A_SIGNED 0
+    parameter \B_SIGNED 0
+    parameter \A_WIDTH 4
+    parameter \B_WIDTH 4
+    parameter \Y_WIDTH 1
+    connect \A \count [3:0]
+    connect \B 4'1010
+    connect \Y \ovf
+  end
+
+  attribute \src "<exec>:24"
+  cell $add $4
+    parameter \A_SIGNED 0
+    parameter \B_SIGNED 0
+    parameter \A_WIDTH 4
+    parameter \B_WIDTH 1
+    parameter \Y_WIDTH 5
+    connect \A \count [3:0]
+    connect \B 1'1
+    connect \Y $1
+  end
+
+  attribute \src "<exec>:13"
+  process $5
+    assign $2 [3:0] \count [3:0]
+    switch \en [0]
+      case 1'1
+        switch \ovf [0]
+          case 1'1
+            assign $2 [3:0] 4'0000
+          case
+            assign $2 [3:0] $1 [3:0]
+        end
+    end
+    switch \rst [0]
+      case 1'1
+        assign $2 [3:0] 4'0000
+    end
+  end
+
+  attribute \src "<exec>:13"
+  cell $dff $6
+    parameter \WIDTH 4
+    parameter \CLK_POLARITY 1
+    connect \D $2 [3:0]
+    connect \CLK \clk [0]
+    connect \Q \count
+  end
+
+end
+