public inbox for gcc-cvs@sourceware.org help / color / mirror / Atom feed
From: Arthur Cohen <cohenarthur@gcc.gnu.org> To: gcc-cvs@gcc.gnu.org Subject: [gcc r14-8090] gccrs: borrowck: Dev notes Date: Tue, 16 Jan 2024 18:17:47 +0000 (GMT) [thread overview] Message-ID: <20240116181747.EE6B23860C37@sourceware.org> (raw) https://gcc.gnu.org/g:ea90f52b9a373fcab8accc2ef7a49d089dcc4aea commit r14-8090-gea90f52b9a373fcab8accc2ef7a49d089dcc4aea Author: Jakub Dupak <dev@jakubdupak.com> Date: Tue Oct 24 08:32:20 2023 +0200 gccrs: borrowck: Dev notes gcc/rust/ChangeLog: * checks/errors/borrowck/dev-notes.md: New file. Signed-off-by: Jakub Dupak <dev@jakubdupak.com> Diff: --- gcc/rust/checks/errors/borrowck/dev-notes.md | 40 ++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) diff --git a/gcc/rust/checks/errors/borrowck/dev-notes.md b/gcc/rust/checks/errors/borrowck/dev-notes.md new file mode 100644 index 00000000000..2e170e76102 --- /dev/null +++ b/gcc/rust/checks/errors/borrowck/dev-notes.md @@ -0,0 +1,40 @@ +# Borrow-checker Development Notes + +## Testing BIR building + +There is no way to test BIR building directly, since it is a dead branch of the compilation pipeline. +The only way to verify its generations is through manual inspection. +The best way to inspect the BIR is to compare it with rustc's MIR. + +The following command will compile a rust file into a library and dump its MIR: + +```shell +rustc --crate-type=lib -A dead_code -A unused -Z dump-mir="" <file> +``` + +The MIR dump directory `mir_dump` contains a dump before and after each MIR pass. +We are interested in the one used for borrow-checking, which is called `<crate>.<function>.002-000.analysis.after.mir`. + +BIR dump is emitted to a `bir_dump` directory. With the following naming scheme: `<crate>.<function>.bir.dump`. + +At this point, MIR dump contains helper constructions that BIR does not contain yet (like storage live/dead annotations). To remove them from the MIR dump, run the following command: + +```shell +awk -i inplace '!/^\s*(\/\/|StorageLive|StorageDead|FakeRead)/' mir_dump/* +``` + +To get the BIR dump into a similar format, run the following command: + +```shell +./crab1 <file> -frust-incomplete-and-experimental-compiler-do-not-use -frust-borrowcheck -frust-dump-bir -frust-compile-until=compilation +``` + + +## TODO + +- scope handling, cleanup +- switch coercions to adjustments from typechecking +- operator overloading +- match selection +- let without an initializer +- lifetime parameters \ No newline at end of file
reply other threads:[~2024-01-16 18:17 UTC|newest] Thread overview: [no followups] expand[flat|nested] mbox.gz Atom feed
Reply instructions: You may reply publicly to this message via plain-text email using any one of the following methods: * Save the following mbox file, import it into your mail client, and reply-to-all from there: mbox Avoid top-posting and favor interleaved quoting: https://en.wikipedia.org/wiki/Posting_style#Interleaved_style * Reply using the --to, --cc, and --in-reply-to switches of git-send-email(1): git send-email \ --in-reply-to=20240116181747.EE6B23860C37@sourceware.org \ --to=cohenarthur@gcc.gnu.org \ --cc=gcc-cvs@gcc.gnu.org \ /path/to/YOUR_REPLY https://kernel.org/pub/software/scm/git/docs/git-send-email.html * If your mail client supports setting the In-Reply-To header via mailto: links, try the mailto: linkBe sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions for how to clone and mirror all data and code used for this inbox; as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).