- Add ability to specify CI branch
- Add CIRCT nightly CI

Add nightly testing using the latest binary of firtool.  This includes
checks that will run for PRs that target the nighlty staging branch,
ci/ci-circt-nightly.

Signed-off-by: Schuyler Eldridge <schuyler.eldridge@sifive.com>

Add the ability to run tests with a specific commit as opposed to always
using the default branch.  This is done to support nightly testing with
CIRCT.

Signed-off-by: Schuyler Eldridge <schuyler.eldridge@sifive.com>

Add a skeleton of a CD GitHub action so that I can play with using
workflow_dispatch to test the real action.  GitHub actions can only be
triggered by workflow_dispatch once the action has been pushed to the
default branch.

Signed-off-by: Schuyler Eldridge <schuyler.eldridge@sifive.com>

Make it such that using "Install CIRCT" does not require specifying a
CIRCT version, instead using the string 'default' as a way to pick the
"default version". The "default version" is the version that Chisel is
tested and released against.

This fixes "Generate Scala CLI Template" which does not care to specify
a CIRCT version.

Change how the CIRCT version is specified for non-nightly flows to a
single environment variable in the ci.yml script.  This makes things
easier for either: (1) a human to update this or (2) a machine to update
this in a CD flow.

Signed-off-by: Schuyler Eldridge <schuyler.eldridge@sifive.com>

Whoopsie...

Signed-off-by: Schuyler Eldridge <schuyler.eldridge@sifive.com>

Add a skeleton of a CI job for running with CIRCT nightly.  It is
necessary to have an action merged onto the default branch in order to do
manual triggers (workflow_dispatch).  This skeleton is added to facilitate
this.

Signed-off-by: Schuyler Eldridge <schuyler.eldridge@sifive.com>

Change the monolithic test.yml Continuous Integration GitHub Action into a
reusable workflow that is called by a new "ci.yml" workflow.  The
check-tests/all_tests_passed are moved into "ci.yml" as are publishing and
deploy jobs.

Signed-off-by: Schuyler Eldridge <schuyler.eldridge@sifive.com>

* [ci] Scala-CLI Template Action -> Workflow, NFC

Change the existing Scala-CLI composite action to a workflow.  Update
other workflows which now need to work a little differently.  The main
change is that a reusable workflow can only communicate through
uploads/downloads.  Hence, change the job that publishes the Scala-CLI
template to download this from the new, reusable workflow.

Signed-off-by: Schuyler Eldridge <schuyler.eldridge@sifive.com>

* [ci] Display Scala-CLI Template in Summary, NFC

Show the resulting Scala-CLI template as a "GITHUB_STEP_SUMMARY" in the
GitHub action for publishing it.  This is likely more useful than making
it available as a download artifact.

Signed-off-by: Schuyler Eldridge <schuyler.eldridge@sifive.com>

* [ci] Whitespace cleanup, NFC

Signed-off-by: Schuyler Eldridge <schuyler.eldridge@sifive.com>

---------

Signed-off-by: Schuyler Eldridge <schuyler.eldridge@sifive.com>

Add support for grabbing the latest nightly version of `firtool` to the
install-circt action.  This requires passing the "github.token" so that
the GitHub API can be used.  Note that the token is marked as "required",
however, it is only actually needed when using a nightly build.

Signed-off-by: Schuyler Eldridge <schuyler.eldridge@sifive.com>

Firtool improvements have optimized many examples to the point where
they do not show anything. Using registers and assigning the same value
to multiple outputs helps make the examples show interesting naming
behavior.

This option will dump the .fir before invoking firtool.

Additional changes:
* Use os.lib for invoking firtool
* Use lazy serialization to avoid holding the entire FIRRTL in
  memory.
* Mix NoStackTrace into FirtoolNotFound
* Fix detection of no firtool

Also make notice about the older sections bold and thus more noticable.

* remove intermediary wire for taps

* clean up test cases

Remove tests that were relying on use of the Java 17-deprecated
SecurityManager.  These does decrease test coverage of "no file writing"
and "exit code checking" behaviors.  However, there doesn't appear to be a
viable workaround for this for testing inside the JVM, i.e., using
Scalatest.

See: https://openjdk.org/jeps/411



Signed-off-by: Schuyler Eldridge <schuyler.eldridge@sifive.com>

* Add FirtoolBinaryPath option

* Format

* Add Scaladoc

* Add HasShellOptions

* Fix build

* Update src/main/scala/circt/stage/Annotations.scala

Co-authored-by: Schuyler Eldridge <schuyler.eldridge@gmail.com>

* Register shell option

---------

Co-authored-by: Schuyler Eldridge <schuyler.eldridge@gmail.com>

Also make line comments work on lines with filter-action pairs.

It causes issues in downstream codebases and really adding it just isn't
worth the pain.

Warnings have been assigned unique integers to use as identifiers for
purposes of documentation and configuration.

New CLI option --warn-conf accepts a comma-separated sequence of
<filter>:<action> pairs for customizing warnings.

Supported filters are:
* any          - matches all warnings
* id=<integer> - matches warnings with the integer id
* src=<glob>   - matches warnings where <glob> matches the warning
                 source file

id and src filters can be combined with &.

Supported actions are:
* :s - suppress the warning
* :w - report the warning as a warning (default behavior)
* :e - error on the warning

For example, the new Vec dynamic width matching warning can be
suppressed for source files in src/main/scala while all other warnings
elevated to errors with:
  --warn-conf "id=4&src=src/main/scala/**:s,any:e"

The is also --warn-conf-file which works similarly to --warn-conf except
the <filter>:<action> pairs are newline separated in a file. # is used
for line comments.

* clean up pkg code

* pad force statements

* adding width known check

* fixing checks and adding test case for unknown wire width force

* error out on probes of unknown width

* fixing check

Co-authored-by: Schuyler Eldridge <schuyler.eldridge@sifive.com>

Add a simple test that `take(0)` return a zero width wire.

This moves name sanitation a little earlier and ensures that the
sanitized names are use more consistently throughout Chisel internals.

This fixes a bug in D/I where unsanitary names would lead to a crash.

* Update BoringUtils.bore to not add a port when boring from a port.

When drilling from the original source, if it's already a port, just
use it directly. Added a simple test from this behavior.

Also removed an errant println in the BoringUtilsSpec while updating
it.

Closes https://github.com/chipsalliance/chisel/issues/3401

.

* Updates from PR review.

---------

Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>

Also add mill to CI.

[svsim] Don't redirect simulation stderr to a pipe (#3403)