update readme and remove outdated files

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,22 +1,8 @@
-<!--
-
-********** NOTICE **********
-
-This repository is only accepting bug fixes
-
--->
-
 ### Contributor Checklist
 
-- [ ] Did you add Scaladoc to every public function/method?
-- [ ] Did you update the FIRRTL spec to include every new feature/behavior?
 - [ ] Did you add at least one test demonstrating the PR?
 - [ ] Did you delete any extraneous printlns/debugging code?
 - [ ] Did you specify the type of improvement?
-- [ ] Did you state the API impact?
-- [ ] Did you specify the code generation impact?
-- [ ] Did you request a desired merge strategy?
-- [ ] Did you add text to be included in the Release Notes for this change?
 
 #### Type of Improvement
 
@@ -29,30 +15,3 @@ This repository is only accepting bug fixes
 <!--   - backend code generation            -->
 <!--   - new feature/API                    -->
 
-#### API Impact
-
-<!-- How would this affect the current API? Does this add, extend, deprecate, remove, or break any existing API? -->
-
-#### Backend Code Generation Impact
-
-<!-- Does this change any generated Verilog?  -->
-<!-- How does it change it or in what circumstances would it?  -->
-
-#### Desired Merge Strategy
-
-<!-- If approved, how should this PR be merged? -->
-<!-- Options are: -->
-<!--   - Squash: The PR will be squashed and merged (choose this if you have no preference. -->
-<!--   - Rebase: You will rebase the PR onto master and it will be merged with a merge commit. -->
-
-#### Release Notes
-<!--
-Text from here to the end of the body will be considered for inclusion in the release notes for the version containing this pull request.
--->
-
-### Reviewer Checklist (only modified by reviewer)
-- [ ] Did you add the appropriate labels?
-- [ ] Did you mark the proper milestone (1.6.x, 1.5.x) ?
-- [ ] Did you review?
-- [ ] Did you check whether all relevant Contributor checkboxes have been checked?
-- [ ] Did you mark as `Please Merge`?

.github/workflows/test.yml

@@ -58,12 +58,6 @@ jobs:
         uses: actions/checkout@v2
       - name: Install Tabby OSS Cad Suite
         uses: ./.github/workflows/setup-oss-cad-suite
-      - name: Setup Scala
-        uses: olafurpg/setup-scala@v10
-        with:
-          java-version: adopt@1.8
-      - name: Cache Scala
-        uses: coursier/cache-action@v5
       - name: Run Formal Equivalence
         # This is here instead of on the whole job because if a job is skipped, so are dependent jobs
         # If this job were skipped, all_tests_passed would be skipped to

README.md

@@ -1,24 +1,12 @@
-# This project is in maintenance mode
-
-Pull Requests should only be made for bug fixes against versions 1.6 and below (Chisel 3.6 and below).
-
-Please see [CIRCT](https://github.com/llvm/circt) for the next generation FIRRTL compiler.
-Also see [Chisel](https://github.com/chipsalliance/chisel).
-
 ---
 
 ![FIRRTL](https://raw.githubusercontent.com/freechipsproject/firrtl/master/doc/images/firrtl_logo.svg?sanitize=true)
 
 ---
 
-[![Join the chat at https://gitter.im/freechipsproject/firrtl](https://badges.gitter.im/freechipsproject/firrtl.svg)](https://gitter.im/freechipsproject/firrtl?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
-![Build Status](https://github.com/chipsalliance/firrtl/workflows/Continuous%20Integration/badge.svg)
-[![Mergify Status][mergify-status]][mergify]
+![Build Status](https://github.com/ucb-bar/firrtl2/workflows/Continuous%20Integration/badge.svg)
 
-[mergify]: https://mergify.io
-[mergify-status]: https://img.shields.io/endpoint.svg?url=https://gh.mergify.io/badges/chipsalliance/firrtl&style=flat
-
-#### Flexible Internal Representation for RTL
+### Flexible Internal Representation for RTL
 
  Firrtl is an intermediate representation (IR) for digital circuits designed as a platform for writing circuit-level transformations.
  This repository consists of a collection of transformations (written in Scala) which simplify, verify, transform, or emit their input circuit.
@@ -27,151 +15,8 @@ Also see [Chisel](https://github.com/chipsalliance/chisel).
 
  For a detailed description of Firrtl's intermediate representation, see the [FIRRTL Language Specification](https://github.com/chipsalliance/firrtl-spec/releases/latest/download/spec.pdf) ([source](https://github.com/chipsalliance/firrtl-spec)).
 
-#### Wiki Pages and Tutorials
-
-Useful information is on our wiki, located here:
-* https://github.com/freechipsproject/firrtl/wiki
-
-Some important pages to read, before writing your own transform:
-* [Submitting Pull Requests](https://github.com/freechipsproject/firrtl/wiki/Submitting-a-Pull-Request)
-* [Understanding Firrtl's IR](https://github.com/freechipsproject/firrtl/wiki/Understanding-Firrtl-Intermediate-Representation)
-* [Traversing a Circuit](https://github.com/freechipsproject/firrtl/wiki/traversing-a-circuit)
-* [Common Pass Idioms](https://github.com/freechipsproject/firrtl/wiki/Common-Pass-Idioms)
-
-To write a Firrtl transform, please start with the tutorial here: [src/main/scala/tutorial](https://github.com/freechipsproject/firrtl/blob/master/src/main/scala/tutorial).
-To run these examples:
-```
-sbt assembly
-./utils/bin/firrtl -td regress -i regress/RocketCore.fir --custom-transforms tutorial.lesson1.AnalyzeCircuit
-./utils/bin/firrtl -td regress -i regress/RocketCore.fir --custom-transforms tutorial.lesson2.AnalyzeCircuit
-```
-
-#### Other Tools
-* Firrtl syntax highlighting for Vim users: https://github.com/azidar/firrtl-syntax
-* Firrtl syntax highlighting for Sublime Text 3 users: https://github.com/codelec/highlight-firrtl
-* Firrtl syntax highlighting for Atom users: https://atom.io/packages/language-firrtl
-* Firrtl syntax highlighting, structure view, navigate to corresponding Chisel code for IntelliJ platform: [install](https://plugins.jetbrains.com/plugin/14183-easysoc-firrtl), [source](https://github.com/easysoc/easysoc-firrtl)
-* Firrtl mode for Emacs users: https://github.com/ibm/firrtl-mode
-* Chisel3, an embedded hardware DSL that generates Firrtl: https://github.com/freechipsproject/chisel3
-* Treadle, a Firrtl Interpreter: https://github.com/freechipsproject/treadle
-* Yosys Verilog-to-Firrtl Front-end: https://github.com/cliffordwolf/yosys
-
-#### Installation Instructions
-*Disclaimer*: The installation instructions should work for OSX/Linux machines. Other environments may not be tested.
-
-##### Prerequisites
- 1. If not already installed, install [verilator](http://www.veripool.org/projects/verilator/wiki/Installing) (Requires at least v3.886)
- 1. If not already installed, install [yosys](https://github.com/YosysHQ/yosys) (Requires at least v0.8)
- 1. If not already installed, install [sbt](http://www.scala-sbt.org/) (Recommend v1.6.2)
-
-##### Installation
- 1. Clone the repository:
-    ```git clone https://github.com/freechipsproject/firrtl.git && cd firrtl```
- 1. Compile firrtl: ```sbt compile```
- 1. Run tests: ```sbt test```
- 1. Build executable (`utils/bin/firrtl`): ```sbt assembly```
-    * **Note:** You can add `utils/bin` to your path to call firrtl from other processes
- 1. Publish this version locally in order to satisfy other tool chain library dependencies:
-```
-sbt publishLocal
-```
-
-##### Useful sbt Tips
- 1. Run a single test suite:
- `sbt "testOnly firrtlTests.UnitTests"`
- 2. Continually execute a command:
- `sbt ~compile`
- 3. Only invoke sbt once:
-```
-sbt
-> compile
-> test
-```
-
-##### Use scalafix to remove unused import and deprecated procedure syntax
- 1. Remove unused import:
-```
-sbt "firrtl/scalafix RemoveUnused"
-```
- 2. Remove deprecated procedure syntax
-```
-sbt "firrtl/scalafix ProcedureSyntax"
-```
-
-##### Using Firrtl as a commandline tool
-```
-utils/bin/firrtl -i regress/rocket.fir -o regress/rocket.v -X verilog // Compiles rocket-chip to Verilog
-utils/bin/firrtl --help // Returns usage string
-```
-
-##### Using the JQF Fuzzer
-The `build.sbt` defines the `fuzzer/jqfFuzz` and `fuzzer/jqfRepro` tasks. These
-can be used to randomly generate and run test cases and reproduce failing test
-cases respectively. These tasks are Scala implementations of the [FuzzGoal and
-ReproGoal](https://github.com/rohanpadhye/JQF/tree/master/maven-plugin/src/main/java/edu/berkeley/cs/jqf/plugin)
-of the JQF maven plugin and should be functionally identical.
-
-The format for the arguments to jqfFuzz are as follows:
-```
-sbt> fuzzer/jqfFuzz <testClassName> <testMethodName> <otherArgs>...
-```
-
-The available options are:
-```
-  --classpath <value>       the classpath to instrument and load the test class from
-  --outputDirectory <value> the directory to output test results
-  --testClassName <value>   the full class path of the test class
-  --testMethod <value>      the method of the test class to run
-  --excludes <value>        comma-separated list of FQN prefixes to exclude from coverage instrumentation
-  --includes <value>        comma-separated list of FQN prefixes to forcibly include, even if they match an exclude
-  --time <value>            the duration of time for which to run fuzzing
-  --blind                   whether to generate inputs blindly without taking into account coverage feedback
-  --engine <value>          the fuzzing engine, valid choices are zest|zeal
-  --disableCoverage         disable code-coverage instrumentation
-  --inputDirectory <value>  the name of the input directory containing seed files
-  --saveAll                 save ALL inputs generated during fuzzing, even the ones that do not have any unique code coverage
-  --libFuzzerCompatOutput   use libFuzzer like output instead of AFL like stats screen
-  --quiet                   avoid printing fuzzing statistics progress in the console
-  --exitOnCrash             stop fuzzing once a crash is found.
-  --runTimeout <value>      the timeout for each individual trial, in milliseconds
-```
-
-The `fuzzer/jqfFuzz` sbt task is a thin wrapper around the `firrtl.jqf.jqfFuzz`
-main method that provides the `--classpath` argument and a default
-`--outputDirectory` and passes the rest of the arguments to the main method
-verbatim.
-
-The results will be put in the `fuzzer/target/JQf/$testClassName/$testMethod`
-directory. Input files in the
-`fuzzer/target/JQf/$testClassName/$testMethod/corpus` and
-`fuzzer/target/JQf/$testClassName/$testMethod/failures` directories can be
-passed as inputs to the `fuzzer/jqfRepro` task.
-
-
-The format for the arguments to jqfRepro are the same as `jqfFuzz`
-```
-sbt> fuzzer/jqfRepro <testClassName> <testMethodName> <otherArgs>...
-```
-
-The available options are:
-
-```
-  --classpath <value>      the classpath to instrument and load the test class from
-  --testClassName <value>  the full class path of the test class
-  --testMethod <value>     the method of the test class to run
-  --input <value>          input file or directory to reproduce test case(s)
-  --logCoverage <value>    output file to dump coverage info
-  --excludes <value>       comma-separated list of FQN prefixes to exclude from coverage instrumentation
-  --includes <value>       comma-separated list of FQN prefixes to forcibly include, even if they match an exclude
-  --printArgs              whether to print the args to each test case
-```
-
-Like `fuzzer/jqfFuzz`, the `fuzzer/jqfRepro` sbt task is a thin wrapper around
-the `firrtl.jqf.jqfRepro` main method that provides the `--classpath` argument
-and a default `--outputDirectory` and passes the rest of the arguments to the
-main method verbatim.
 
-##### Citing Firrtl
+### Citing Firrtl
 
 If you use Firrtl in a paper, please cite the following ICCAD paper and technical report:
 https://ieeexplore.ieee.org/document/8203780

benchmark/scripts/benchmark_cold_compile.py

@@ -73,7 +73,7 @@ def clone_and_build(hashcode):
             assert res.returncode == 0
         res = subprocess.run(['git', '-C', repo, 'checkout', hashcode])
         assert res.returncode == 0
-        res = subprocess.run(['make', '-C', repo, 'build-scala'])
+        res = subprocess.run(['sbt', 'assembly'], cwd=repo)
         assert res.returncode == 0
         res = subprocess.run(['cp', '{}/utils/bin/firrtl.jar'.format(repo), jar])
         assert res.returncode == 0