Skip to content

docs: add build guide and simulation resource guidelines#135

Open
ping-long-github wants to merge 3 commits intopulp-platform:mainfrom
SiliconLanguage:main
Open

docs: add build guide and simulation resource guidelines#135
ping-long-github wants to merge 3 commits intopulp-platform:mainfrom
SiliconLanguage:main

Conversation

@ping-long-github
Copy link
Copy Markdown

Add BUILD_GUIDE.md documenting a complete from-source build and simulation workflow on Ubuntu 24.04 without sudo access, covering:

  • Host dependency builds (m4, bison, flex, texinfo, GMP/MPFR/MPC, autoconf, dtc, libelf) into ~/.local
  • RISC-V GCC cross-compiler build and known issues with GCC 13
  • Verilator build (v4.228 upgrade to fix v4.218 internal fault on fpnew RTL)
  • Successful hello_world run on the minpool (16-core) configuration
  • Summary table of all 14 issues encountered and their resolutions

Add a 'Simulation Performance and Resource Considerations' section to README.md documenting that the default 256-core Verilator simulation can exhaust host memory due to serialized mempool_barrier synchronization and per-hart tracing I/O, with recommendations to use minpool for interactive work or provision 64 GB+ RAM for full-scale runs.

Summarize the changes concisely

Changelog

Added

Changed

Fixed

(Reference to issues, labels, and related merge requests)

Checklist

  • Automated tests pass
  • Changelog updated
  • Code style guideline is observed

Please check our contributing guidelines before opening a Pull Request.

Add BUILD_GUIDE.md documenting a complete from-source build and simulation
workflow on Ubuntu 24.04 without sudo access, covering:
- Host dependency builds (m4, bison, flex, texinfo, GMP/MPFR/MPC, autoconf,
  dtc, libelf) into ~/.local
- RISC-V GCC cross-compiler build and known issues with GCC 13
- Verilator build (v4.228 upgrade to fix v4.218 internal fault on fpnew RTL)
- Successful hello_world run on the minpool (16-core) configuration
- Summary table of all 14 issues encountered and their resolutions

Add a 'Simulation Performance and Resource Considerations' section to
README.md documenting that the default 256-core Verilator simulation can
exhaust host memory due to serialized mempool_barrier synchronization and
per-hart tracing I/O, with recommendations to use minpool for interactive
work or provision 64 GB+ RAM for full-scale runs.
Add .github/agents/, .github/prompts/, and .github/skills/ to
.gitignore to prevent accidental commits of user-specific Copilot
customization files.
Ignore disassembly dump artifacts generated during simulation.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant