Use args in build, manage flushCall bug

.github/workflows/test_ubuntu_20p04.yml

@@ -0,0 +1,29 @@
+name: TestUbuntu20p04
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-20.04
+    strategy:
+      matrix:
+        python-version: ["3.8", "3.9"]
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        sudo apt install verilator
+    - name: check verilator version
+      run: | 
+        verilator --version
+    - name: install pyverilator
+      run: |
+        python -m pip install -e ./
+    - name: test
+      run: |
+        cd ./pyverilator/tests
+        python ./test_pyverilator.py

.github/workflows/test_ubuntu_latest.yml

@@ -0,0 +1,29 @@
+name: TestUbuntuLatest
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11"]
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        sudo apt install verilator
+    - name: check verilator version
+      run: | 
+        verilator --version
+    - name: install pyverilator
+      run: |
+        python -m pip install -e ./
+    - name: test
+      run: |
+        cd ./pyverilator/tests
+        python ./test_pyverilator.py

.github/workflows/test_verilator_dev.yml

@@ -0,0 +1,62 @@
+name: TestVerilatorDev
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11"]
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install build pre-requisites
+      run: |
+        sudo apt update
+        sudo apt install gcc-9 gcc-10
+        sudo apt-get install git help2man perl python3 make autoconf g++ flex bison ccache
+        sudo apt-get install numactl perl-doc # libgoogle-perftools-dev 
+        sudo apt-get install libfl2  # Ubuntu only (ignore if gives error)
+        sudo apt-get install libfl-dev  # Ubuntu only (ignore if gives error)
+        # sudo apt-get install zlibc zlib1g zlib1g-dev  # Ubuntu only (ignore if gives error)
+    - name: Install verilator from github
+      run: |
+        git clone https://github.com/verilator/verilator
+
+        # Every time you need to build:
+        # unsetenv VERILATOR_ROOT  # For csh; ignore error if on bash
+        unset VERILATOR_ROOT  # For bash
+        cd verilator
+        git pull         # Make sure git repository is up-to-date
+        git tag          # See what versions exist
+        git checkout master      # Use development branch (e.g. recent bug fixes)
+        #git checkout stable      # Use most recent stable release
+        #git checkout v{version}  # Switch to specified release version
+
+        autoconf         # Create ./configure script
+        ./configure      # Configure and create Makefile
+        make -j `nproc`  # Build Verilator itself (if error, try just 'make')
+        sudo make install
+
+        export VERILATOR_ROOT=`pwd`
+        cd ..
+    - name: check verilator version
+      run: | 
+        verilator --version
+    - name: check gcc version
+      run: | 
+        gcc --version
+    - name: update pip
+      run: |
+        pip install --upgrade pip
+    - name: install pyverilator
+      run: |
+        python -m pip install -e ./
+    - name: test
+      run: |
+        cd ./pyverilator/tests
+        python ./test_pyverilator.py

.gitignore

@@ -2,3 +2,4 @@
 __pycache__/
 examples/build
 .*
+*.gz

README.rst

@@ -1,3 +1,10 @@
+PyVerilator-mm
+==============
+
+This is a fork of the original pyverilator package, that manages a newer verilator syntax 
+and works with WSL (by importing tclwraper only if gtkwave is required).
+Below the original readme.
+
 PyVerilator
 ===========
 
@@ -14,6 +21,10 @@ using the following command:
 
     $ pip3 install pyverilator
 
+Installing Development Version
+-------------------------------
+
+    pip3 install git+https://github.com/bat52/pyverilator.git@master
 
 Usage
 -----
@@ -36,7 +47,7 @@ Assume you have the following verilog module stored in ``counter.v``.
             if (rst == 1) count_reg <= 0;
             else          count_reg <= next_count_reg;
         end
-    endmodule'''
+    endmodule
 
 Then you can use ``pyverilator`` to simulate this module using verilator in
 python.
@@ -50,11 +61,11 @@ python.
 
     # add all the io and internal signals to gtkwave
     sim.send_signals_to_gtkwave(sim.io)
-    sim.send_signals_to_gtkwave(sim.internals)
+    # sim.send_signals_to_gtkwave(sim.internals) # not working anymore
 
     # add all the io and internal signals to gtkwave
     sim.send_to_gtkwave(sim.io)
-    sim.send_to_gtkwave(sim.internals)
+    # sim.send_to_gtkwave(sim.internals) # not working anymore
 
     # tick the automatically detected clock
     sim.clock.tick()

examples/simple_example.py

@@ -26,14 +26,21 @@
 with open('counter.v', 'w') as f:
     f.write(test_verilog)
 
-sim = pyverilator.PyVerilator.build('counter.v')
+
+dump_fst = True
+if dump_fst:
+    dump_filename = 'dump.fst'
+else:
+    dump_filename = 'dump.vcd'
+sim = pyverilator.PyVerilator.build('counter.v',dump_fst=dump_fst,dump_level=1)
 
 # start gtkwave to view the waveforms as they are made
-sim.start_gtkwave()
+# sim.start_gtkwave() # moved at the bottom... updating gtkwave during simulation is slow
+sim.start_vcd_trace(dump_filename)
 
 # add all the io and internal signals to gtkwave
-sim.send_to_gtkwave(sim.io)
-sim.send_to_gtkwave(sim.internals)
+# sim.send_to_gtkwave(sim.io)        # this still works
+# sim.send_to_gtkwave(sim.internals) # not working anymore
 
 # set the rst input to 1
 sim.io.rst = 1
@@ -57,3 +64,6 @@
 
 curr_out = sim.io.out.value
 print('sim.io.out = ' + str(curr_out))
+
+sim.stop_vcd_trace()
+sim.start_gtkwave() # moved at the bottom works both with fst and vcd

pypi.sh

@@ -0,0 +1,80 @@
+#!/usr/bin/env bash
+
+DIST=dist
+PACKAGE=pyverilator-mm
+PIP=pip3
+
+function show_usage(){
+    echo "Usage: $0 [OPTION]"
+    echo " Available options:"
+    echo " -h|--help     : Show help"
+    echo " -c|--create   : Create local package"
+    echo " -u            : Upload local package on test repository"
+    echo " --upload      : Upload local package on pypi repository"
+    echo " -i            : Install package from test repository"
+    echo " --install     : Install package from pypi repository"
+    echo " -un|--install : Uninstall package"
+}
+
+# if no argument is specified, show usage
+if [[ "$#" -lt 1 ]]; 
+then 
+    show_usage
+fi
+
+## parse input args
+while [[ "$#" -gt 0 ]]; do
+    case $1 in
+        -h|--help)       HELP=1;         shift ;;
+        -c|--create)     CREATE=1;       shift ;;
+        -u)              UPLOAD_TEST=1;  shift ;;
+        --upload)        UPLOAD=1;       shift ;;
+        -i)              INSTALL_TEST=1; shift ;;
+        --install)       INSTALL=1;      shift ;;
+        -un|--uninstall) UNINSTALL=1           ;;
+        *) echo "Unknown parameter passed: $1"; exit 1 ;;
+    esac
+    shift
+done
+
+if [[ "$HELP" -gt 0 ]];
+then
+    show_usage
+fi
+
+if [[ "$CREATE" -gt 0 || "$UPLOAD" -gt 0 || "$UPLOAD_TEST" -gt 0 ]];
+then
+    echo "Creating new package... "
+    rm -rf $DIST # remove old package folder
+    python3 setup.py sdist # create package
+fi
+
+if [[ "$UPLOAD_TEST" -gt 0 ]];
+then
+    echo "Uploading package to testpypi... "
+    twine upload --repository testpypi ${DIST}/* # upload to testpypi
+fi
+
+if [[ "$UPLOAD" -gt 0 ]];
+then
+    echo "Uploading package to pypi... "
+    twine upload ${DIST}/* # upload to pypi
+fi
+
+if [[ "$UNINSTALL" -gt 0 || "$INSTALL" -gt 0 || "$INSTALL_TEST" -gt 0 ]];
+then
+    echo "Uninstalling package... "
+    $PIP uninstall ${PACKAGE}
+fi
+
+if [[ "$INSTALL_TEST" -gt 0 ]];
+then
+    echo "Installing package from testpypi... "
+    $PIP install --index-url https://test.pypi.org/simple/ ${PACKAGE}
+fi
+
+if [[ "$INSTALL" -gt 0 ]];
+then
+    echo "Installing package from pypi... "
+    $PIP install ${PACKAGE}
+fi