chipsalliance/chisel.git:

代码拉取完成,页面将自动刷新

扫描微信二维码支付

取消

支付完成

richgiteeai

Watch

不关注关注所有动态仅关注版本发行动态关注但不提醒动态

1 Star 0 Fork 0

qturing/chisel

代码 Issues 0 Pull Requests 0 Wiki 统计流水线

服务

加入 Gitee

与超过 1400万开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)

免费加入

已有帐号? 立即登录

文件

新建文件新建 Diagram 文件

main

分支 (441)

标签 (123)

管理

main

gh-pages

ci/ci-circt-nightly

dev/seldridge/chiselsim-allow-overriding-a-cli-option

jackkoenig/remove-panama-bindings

publish-snapshots-backup

adkian-sifive/chisel-scala-compiler-plugins-blog

dev/chisel-naming-prefix-bug

jackkoenig/arbiter-typeclass

fix-firtool-lowering

6.x

azidar-create-colored-probes

cd/update-circt-from-firtool-1.112.0-to-firtool-1.113.0

simulation-test

mergify/configuration-deprecated-update

jackkoenig/fix-unpack

mergify/bp/6.x/pr-4829

cd/update-circt-from-firtool-1.109.0-to-firtool-1.110.0

jackkoenig/wip-on-better-sfc-deprecation

mergify/bp/6.x/pr-4805

v7.0.0

v7.0.0-RC4

v7.0.0-RC3

v7.0.0-RC2

v7.0.0-RC1

v6.7.0

v6.6.0

v7.0.0-M2

v6.5.0

v3.6.1

v6.4.0

v5.3.0

v5.2.0

v6.3.0

v6.2.0

v6.1.0

v7.0.0-M1

v6.0.0

v6.0.0-RC2

v6.0.0-RC1

克隆/下载

HTTPS SSH SVN SVN+SSH 下载ZIP

提示

下载代码请复制以下命令到终端执行

为确保你提交的代码身份被 Gitee 正确识别,请执行以下命令完成配置

git config --global user.name userName 
git config --global user.email userEmail

初次使用 SSH 协议进行代码克隆、推送等操作时,需按下述提示完成 SSH 配置

1 生成 RSA 密钥

2 获取 RSA 公钥内容,并配置到 SSH公钥中

在 Gitee 上使用 SVN,请访问使用指南

使用 HTTPS 协议时,命令行会出现如下账号密码验证步骤。基于安全考虑,Gitee 建议配置并使用私人令牌替代登录密码进行克隆、推送等操作

Username for 'https://gitee.com': userName

Password for 'https://userName@gitee.com': # 私人令牌

新建文件新建 Diagram 文件

分支 441

标签 123

贡献代码

同步代码

创建 Pull Request

了解更多

对比差异通过 Pull Request 同步

同步更新到分支

通过 Pull Request 同步

将会在向当前分支创建一个 Pull
Request,合入后将完成同步

Jack Koenig Re-enable SNAPSHOT publishing (#4976) c4ca27e

6767 次提交

File empty ...

src/main

README.md

package.mill

README

# Notes on the Compiler Plug-in

The Chisel plugin provides some operations that are too difficult, or not possbile,
to implement through regular Scala code.

# This documentation is for developers working on chisel internals.

## Compiler plugin operations
These are the two things that the compile plugin does.

1. Automatically generates the `cloneType` methods of Bundle
2. Changes the underlying mechanics of the `Bundle`s `elements` method in a way 
that does not require the use of **reflection** 
3. Future work: Make having a Seq[Data] in a bundle be a compiler error. See "Detecting Bundles with Seq[Data]" below.

### 1. Generating `cloneType` method
As of Mar 18, 2021, PR #1826, generating the `cloneType` method (1. above) is now the default behavior.
The cloneType method used to be a tricky thing to write for chisel developers.
For historical purposes, here is the flag was used to control that prior to full adoption.
```
-P:chiselplugin:useBundlePlugin
```

### 2. Changing `Bundle#elements` method

A `Bundle` has a default `elements` method that relies on **reflection**, which is slow and brittle, to access the list of
*fields* the bundle contains.
When enabled this second operation of the plugin examines
the `Bundle`s AST in order to determine the fields and then re-writes the underlying code of `elements`.
Technically, rewriting a lower level private method `_elementsImpl`.
It is expected that the using this feature will shortly become the default.

>The plugin should not be enabled for the `main` chisel3 project because of internal considerations.
> It is enabled for the `Test` section.

In the meantime, advanced users can try using the feature by adding the following flag to the scalac options in their
chisel projects.

```
-P:chiselplugin:buildElementAccessor
```

For example in an `build.sbt` file adding the line 
```
scalacOptions += "-P:chiselplugin:genBundleElements",
```
in the appropriate place.

## Future work
### Detecting Bundles with Seq[Data]
Trying to have a `val Seq[Data]` (as opposed to a `val Vec[Data]` in a `Bundle` is a run time error.
Here is a block of code that could be added to the plugin to detect this case at compile time (with some refinement in
the detection mechanism):
```scala
 if (member.isAccessor && typeIsSeqOfData(member.tpe) && !isIgnoreSeqInBundle(bundleSymbol)) {
 global.reporter.error(
 member.pos,
 s"Bundle.field ${bundleSymbol.name}.${member.name} cannot be a Seq[Data]. " +
 "Use Vec or MixedVec or mix in trait IgnoreSeqInBundle"
 )
 }
```
### Notes about working on the `_elementsImpl` generator for the plugin in `BundleComponent.scala`
In general the easiest way to develop and debug new code in the plugin is to use `println` statements.
Naively this can result in reams of text that can be very hard to look through.

What I found to be useful was creating some wrappers for `println` that only printed when the `Bundles` had a particular name pattern.
- Create a regular expression string in the `BundleComponent` class
- Add a printf wrapper name `show` that checks the `Bundle`'s name against the regex
- For recursive code in `getAllBundleFields` create a different wrapper `indentShow` that indents debug lines
- Sprinkle calls to these wrappers as needed for debugging

#### Bundle Regex
```scala
 val bundleNameDebugRegex = "MyBundle.*"
```
#### Add `show` wrapper
`show` should be inside `case bundle` block of the `transform` method in order to have access to the current `Bundle`

```scala
def show(string: => String): Unit = {
 if (bundle.symbol.name.toString.matches(bundleNameDebugRegex)) {
 println(string)
 }
}
```
#### Add `indentShow` wrapper
This method can be added into `BundleComponent.scala` in the `transform` method after `case Bundle`
Inside of `getAllBundleFields` I added the following code that indented for each recursion up the current
`Bundle`'s hierarchy.
```scala
def indentShow(s: => String): Unit = {
 val indentString = ("-" * depth) * 2 + "> "
 s.split("\n").foreach { line =>
 show(indentString + line)
 }
}
```