fix: include platform-summary

Author: nhtyy

src/bootstrap/Cargo.lock

@@ -88,9 +88,8 @@ dependencies = [
 
 [[package]]
 name = "cc"
-version = "1.1.22"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "9540e661f81799159abee814118cc139a2004b3a3aa3ea37724a1b66530b90e0"
+version = "1.2.0"
+source = "git+https://github.com/nhtyy/cc-rs?branch=n%2Fadd-succinct-target#424acb084e212c330de96e06cab69be0d9df55f4"
 dependencies = [
  "shlex",
 ]

src/bootstrap/Cargo.toml

@@ -39,7 +39,11 @@ test = false
 # otherwise, some targets will fail. That's why these dependencies are explicitly pinned.
 #
 # Do not upgrade this crate unless https://github.com/rust-lang/cc-rs/issues/1317 is fixed.
-cc = "=1.1.22"
+#
+# todo(succinct): remove this change that was explicity against the rules.
+# This just happens to work, and ideally cc-rs will fix the target parsing issue before our target is merged.
+cc = "=1.2.0"
+# cc = "=1.1.22"
 cmake = "=0.1.48"
 
 build_helper = { path = "../build_helper" }
@@ -73,6 +77,9 @@ tracing-chrome = { version = "0.7", optional = true }
 tracing-subscriber = { version = "0.3", optional = true, features = ["env-filter", "fmt", "registry", "std"] }
 tracing-tree = { version = "0.4.0", optional = true }
 
+[patch.crates-io]
+cc = { git = "https://github.com/nhtyy/cc-rs", branch = "n/add-succinct-target" }
+
 [target.'cfg(windows)'.dependencies.junction]
 version = "1.0.0"
 

src/doc/rustc/src/SUMMARY.md

@@ -77,6 +77,7 @@
     - [riscv32e\*-unknown-none-elf](platform-support/riscv32e-unknown-none-elf.md)
     - [riscv32i\*-unknown-none-elf](platform-support/riscv32-unknown-none-elf.md)
     - [riscv32im-risc0-zkvm-elf](platform-support/riscv32im-risc0-zkvm-elf.md)
+    - [riscv32im-succinct-zkvm-elf](platform-support/riscv32im-succinct-zkvm-elf.md)
     - [riscv32imac-unknown-xous-elf](platform-support/riscv32imac-unknown-xous-elf.md)
     - [riscv64gc-unknown-linux-gnu](platform-support/riscv64gc-unknown-linux-gnu.md)
     - [riscv64gc-unknown-linux-musl](platform-support/riscv64gc-unknown-linux-musl.md)

src/doc/rustc/src/platform-support/riscv32im-succinct-zkvm-elf.md

@@ -0,0 +1,83 @@
+# `riscv32im-risc0-zkvm-elf`
+
+**Tier: 3**
+
+Succinct's ISA for the SP1 zkVM (Zero Knowledge Virtual Machine).
+
+## Target maintainers
+
+- John Guibas, `[email protected]`, https://github.com/jtguibas
+- Nathan Bustamante, `[email protected]`, https://github.com/nhtyy
+
+## Background
+
+This target is an execution environment to produce a proof of execution of
+a RISC-V ELF binary and any output that the developer of the binary wishes to
+display publicly. In order to do this, the target will execute the ELF and
+create a cryptographic proof of the "trace" of the programs runtime.
+
+We have a cargo extension called [cargo-prove] that allow users to generate
+project templates, install tools for improved user experience and build binaries.
+
+## Requirements
+
+The target only supports cross compilation and no host tools. The target
+supports `alloc` with a default allocator and will have support for std soon.
+
+The target's execution environment is single threaded, non-preemptive, and does
+not support any privileged instructions, nor unaligned accesses. At the time of
+writing the VM has 192 MB of memory and text/data, heap, and stack need to be
+with in the address range `0x400` - `0x0C000000`. The binaries themselves expect
+no operating system and can be thought of as running on bare-metal. The target
+does not use `#[target_feature(...)]` or `-C target-feature=` values.
+
+Calling `extern "C"` on the target uses the C calling convention outlined in the
+[RISC-V specification].
+
+## Building for the zkVM
+
+Programs for the zkVM could be built by adding it to the `target` list in
+`config.toml`. However, we recommend building programs in our starter template
+generated by the [cargo-prove] utility and the [sp1-build] crate. This
+crate calls `rustc` with `-C "link-arg=-Ttext=` so that it maps the text in the
+appropriate location as well as generating variables that represent the ELF and
+a unique ID associated with the ELF.
+
+The starter template provides developers with system calls that are useful
+to zero knowledge computing such as writing to
+the public output, hashing using sha256, and multiply big integers.
+
+## Building Rust programs
+
+Rust does not yet ship pre-compiled artifacts for this target. To compile for
+this target, you will either need to build Rust with the target enabled (see
+"Building the target" above). We do not recommend using `build-std` as we have
+run into issues building core in the past on our starter template. An alternate
+solution is to download the risc0 tool chain by running `cargo prove install-toolchain`.
+
+## Testing
+
+Note: the target is implemented as a software emulator called the zkVM and there
+is no hardware implementation of the target.
+
+The most practical way to test the target program is to use our starter template
+that can be generated by using the `cargo prove new` command. The template
+generates a sample "host" and "guest" code. The guest code compiled to the
+target (which is RV32IM) whereas the "host" code is compiled to run on the
+programmer's machine running either a Linux distribution or macOS.
+
+The host program is responsible for running the guest binary on the zkVM and retrieving
+its public output.
+
+The target currently does not support running the Rust test suite.
+
+## Cross-compilation toolchains and C code
+
+Compatible C code can be built for this target on any compiler that has a RV32IM
+target.  On clang and ld.lld linker, it can be generated using the
+`-march=rv32im`, `-mabi=ilp32` with llvm features flag `features=+m` and llvm
+target `riscv32-unknown-none`.
+
+[RISC-V specification]: https://riscv.org/wp-content/uploads/2015/01/riscv-calling.pdf
+[cargo-prove]: https://docs.succinct.xyz/docs/sp1/getting-started/install
+[sp1-build]: https://crates.io/crates/sp1-build