Rust 編譯器快速上手從克隆倉(cāng)庫(kù)到構(gòu)建、測(cè)試 rustc 的完整實(shí)戰(zhàn)指南【免費(fèi)下載鏈接】rustEmpowering everyone to build reliable and efficient software.項(xiàng)目地址: https://gitcode.com/GitHub_Trending/ru/rust本指南面向想要參與 rustc 開發(fā)或自建編譯器的開發(fā)者以rustc-dev-guide中的 Quickstart 為主線完整演示從克隆rust-lang/rust倉(cāng)庫(kù)、生成bootstrap.toml配置、調(diào)用x構(gòu)建工具鏈到鏈接 rustup 工具鏈、運(yùn)行 UI 測(cè)試套件的全流程。讀完本文你將掌握./x setup、./x build、./x check、./x test等核心命令的用法與加速技巧并理解 stage0/stage1/stage2 分級(jí)構(gòu)建背后的原理可以立即上手對(duì)編譯器進(jìn)行修改與驗(yàn)證。一、準(zhǔn)備工作獲取 rustc 源碼構(gòu)建 Rust 編譯器的第一步是獲取源碼。主倉(cāng)庫(kù)同時(shí)包含編譯器rustc、標(biāo)準(zhǔn)庫(kù)core、alloc、test、proc_macro等以及一系列工具rustdoc、bootstrap 基礎(chǔ)設(shè)施等因此一次克隆即可獲得完整的開發(fā)環(huán)境git clone https://github.com/rust-lang/rust.git cd rust注意在 Windows 上殺毒軟件的全盤掃描會(huì)明顯拖慢大倉(cāng)庫(kù)的 Git 與構(gòu)建命令。如果遇到這種情況可考慮僅將 Rust 檢出目錄加入 Windows 安全中心的排除列表避免過(guò)寬的排除范圍?？寺》绞降倪x擇由于倉(cāng)庫(kù)體積龐大、歷史記錄完整在較慢的網(wǎng)絡(luò)下完整克隆耗時(shí)長(zhǎng)、占磁盤大。rustc-dev-guide提供了兩種替代方案Partial clone推薦只拉取當(dāng)前文件內(nèi)容歷史內(nèi)容在需要時(shí)按需自動(dòng)獲取。所有 Git 命令照?？捎么鷥r(jià)是訪問(wèn)未加載的歷史節(jié)點(diǎn)時(shí)需要聯(lián)網(wǎng)git clone --filterblob:none https://github.com/rust-lang/rust.git cd rustShallow clone淺克隆使用--depth N只保留最近 N 次提交--depth 1即只取main分支的最新一次提交適合瀏覽源碼或快速構(gòu)建git clone --depth 1 https://github.com/rust-lang/rust.git cd rust但淺克隆會(huì)限制部分 Git 命令git bisect和git blame依賴完整提交歷史因此如果打算參與編譯器開發(fā)并貢獻(xiàn)代碼建議使用完整克隆或 partial clone。另外請(qǐng)預(yù)留足夠的磁盤空間構(gòu)建編譯器需要相對(duì)較大的存儲(chǔ)文檔建議至少預(yù)留 10~15 GB而完整的多階段構(gòu)建尤其超過(guò) stage 1 時(shí)可能占用接近 100 GB 的空間。二、認(rèn)識(shí) x構(gòu)建 rust 倉(cāng)庫(kù)的統(tǒng)一入口構(gòu)建 rustc 時(shí)不直接使用cargo而是使用一個(gè)名為 x 的包裝器通過(guò)./x調(diào)用。x 的底層是倉(cāng)庫(kù)中的 bootstrap 構(gòu)建系統(tǒng)位于 src/bootstrap它負(fù)責(zé)構(gòu)建文檔、運(yùn)行測(cè)試、構(gòu)建編譯器和標(biāo)準(zhǔn)庫(kù)。./x是 bootstrap 的推薦入口但根據(jù)操作系統(tǒng)與 Shell 的不同還有多種等價(jià)形式參見 how-to-build-and-run.md./x subcommand [flags] # Unix shell 或配置好的 Windows PowerShell ./x.ps1 subcommand [flags] # Windows NuShell x.py subcommand [flags] # Windows 命令提示符需 .py 關(guān)聯(lián) Python python x.py subcommand [flags] # 手動(dòng)調(diào)用 Python ./x.py subcommand [flags] # 僅有 python3 且 sh 不支持 local 的環(huán)境如 Solaris倉(cāng)庫(kù)根目錄下實(shí)際存在 x、x.ps1、x.py 三個(gè)入口文件對(duì)應(yīng)上述調(diào)用方式。在 Windows PowerShell 中直接運(yùn)行./x可能報(bào)錯(cuò)File ... x.ps1 cannot be loaded because running scripts is disabled on this system可執(zhí)行以下命令允許運(yùn)行本地腳本Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser如果想要更方便地在倉(cāng)庫(kù)任意子目錄中運(yùn)行x還可以安裝系統(tǒng)級(jí)的x二進(jìn)制源碼位于 src/tools/x它會(huì)自動(dòng)查找合適的 Python 版本不依賴當(dāng)前 Shellcargo install --locked --path src/tools/x三、生成構(gòu)建配置./x setup 與 bootstrap.toml克隆完成后需要為構(gòu)建創(chuàng)建配置文件。運(yùn)行./x setup會(huì)執(zhí)行初始化并生成一份帶合理默認(rèn)值的bootstrap.toml./x setup交互式設(shè)置會(huì)詢問(wèn)你選擇哪種默認(rèn)配置profile常見選項(xiàng)對(duì)應(yīng) src/bootstrap/defaults 下的模板文件compilerbootstrap.compiler.toml面向編譯器貢獻(xiàn)者啟用debug-logging、debug-assertions、incremental、backtrace-on-ice等開發(fā)友好選項(xiàng)并從 CI 下載預(yù)編譯 LLVMdownload-ci-llvm truelibrarybootstrap.library.toml面向標(biāo)準(zhǔn)庫(kù)與文檔貢獻(xiàn)者test-stage 1、bench-stage 1避免構(gòu)建編譯器本身toolsbootstrap.tools.toml面向 rustdoc、cargo、clippy 等工具貢獻(xiàn)者download-rustc if-unchanged且默認(rèn)test-stage 2distbootstrap.dist.toml面向從源碼安裝的用戶與發(fā)行版維護(hù)者默認(rèn)完整的 stage 2 構(gòu)建build-stage 2、extended true。例如 compiler profile 會(huì)設(shè)置[rust]下的incremental true顯著加快增量重建、lto off以約 20% 運(yùn)行時(shí)性能為代價(jià)換取更快的構(gòu)建、frame-pointers true便于性能分析等這些配置共同定義了面向開發(fā)、而非面向發(fā)布的構(gòu)建形態(tài)。也可以手寫bootstrap.toml倉(cāng)庫(kù)根目錄的 bootstrap.example.toml 列出了全部可用配置項(xiàng)及其說(shuō)明src/bootstrap/defaults 則給出了常見的組合。如果你已經(jīng)構(gòu)建過(guò) rustc 后修改了與 LLVM 相關(guān)的配置可能需要執(zhí)行./x clean --all才能讓后續(xù)配置變更生效注意./x clean不會(huì)觸發(fā) LLVM 重建。多配置管理config extensions不同任務(wù)可能需要切換不同的 bootstrap 配置。與其手工復(fù)制粘貼配置值bootstrap.toml支持通過(guò)include引入配置擴(kuò)展且擴(kuò)展可以遞歸嵌套# cross.toml [build] build x86_64-unknown-linux-gnu host [i686-unknown-linux-gnu] target [i686-unknown-linux-gnu] [llvm] download-ci-llvm false [target.x86_64-unknown-linux-gnu] llvm-config /path/to/llvm-19/bin/llvm-config# bootstrap.toml include [cross.toml]注意include的覆蓋邏輯為從右到左——include [a.toml, b.toml]中b.toml覆蓋a.toml且父級(jí)擴(kuò)展總是覆蓋內(nèi)層擴(kuò)展。四、構(gòu)建編譯器./x build 與 ./x check配置就緒后即可開始構(gòu)建。最常用的黃金命令是構(gòu)建標(biāo)準(zhǔn)庫(kù)同時(shí)也會(huì)用 stage0 編譯器構(gòu)建 rustc再用新構(gòu)建的 stage1 編譯器構(gòu)建標(biāo)準(zhǔn)庫(kù)并組裝出可用的 stage1 sysroot./x build library該命令的完整執(zhí)行鏈條為用 stage0 編譯器下載的預(yù)發(fā)布編譯器和 stage0 標(biāo)準(zhǔn)庫(kù)構(gòu)建 rustc用剛構(gòu)建出的 stage1 編譯器構(gòu)建library標(biāo)準(zhǔn)庫(kù)組裝出包含 stage1 編譯器與 stage1 標(biāo)準(zhǔn)庫(kù)的 stage1 sysroot。最終產(chǎn)物stage1 編譯器 用它構(gòu)建的庫(kù)就是編譯普通 Rust 程序所需的一切除非程序使用#![no_std]或#![no_core]?？焖偃腴T文檔 quickstart.md 中推薦的做法是./x setup ./x build./x build會(huì)構(gòu)建編譯器、標(biāo)準(zhǔn)庫(kù)以及少量工具如果只想快速驗(yàn)證代碼能否編譯可以改用./x check。兩類命令都支持指定組件或路徑作為參數(shù)例如./x check compiler只檢查編譯器部分。常用 x 命令速查命令適用場(chǎng)景./x check快速檢查大部分代碼能否編譯重構(gòu)類型更改時(shí)首選rust-analyzer 可自動(dòng)執(zhí)行./x build構(gòu)建rustc、std和rustdoc./x test運(yùn)行全部測(cè)試./x fmt格式化所有代碼x還支持compiler、library與src/tools目錄的各種路徑后綴簡(jiǎn)寫例如x test tidy等價(jià)于x test src/tools/tidyx build std等價(jià)于x build library/std。構(gòu)建特定組件如果只改標(biāo)準(zhǔn)庫(kù)無(wú)需構(gòu)建全部默認(rèn)組件./x build --stage 1 library選擇 library profile 時(shí)--stage 1是默認(rèn)值可省略。構(gòu)建某個(gè)工具則直接給出其路徑./x build src/tools/cargo交叉編譯需要構(gòu)建支持其他目標(biāo)的編譯器時(shí)向x build傳入任意數(shù)量的--target標(biāo)志./x build --target x86_64-unknown-linux-gnu,wasm32-wasip1若要讓編譯器能構(gòu)建包含 proc macro 或 build script 的 crate必須顯式包含宿主平臺(tái)目標(biāo)。也可以在bootstrap.toml的[build]段中固化目標(biāo)列表[build] target [x86_64-unknown-linux-gnu, wasm32-wasip1]避免 std 重復(fù)構(gòu)建--keep-stage-std 1構(gòu)建 stage1 標(biāo)準(zhǔn)庫(kù)往往是整個(gè)流程的瓶頸。當(dāng)修改不改變標(biāo)準(zhǔn)庫(kù)的編譯方式例如僅修改錯(cuò)誤信息文案時(shí)可以跳過(guò) std 的重編./x build library --keep-stage-std1該標(biāo)志會(huì)假設(shè)舊的標(biāo)準(zhǔn)庫(kù)可以復(fù)用——因?yàn)榫幾g器代碼沒(méi)有被改動(dòng)時(shí)這通常是成立的。但要注意如果修改的是影響元數(shù)據(jù)編碼的部分例如 rlib 中類型編碼、MIR 的定義等復(fù)用的 std 可能與新編譯器不兼容導(dǎo)致奇怪的 ICE 或 panic。遇到此類異常時(shí)去掉--keep-stage-std1重新構(gòu)建即可。測(cè)試同樣可以使用該技巧./x test tests/ui --keep-stage-std1清理構(gòu)建目錄需要完全重新開始時(shí)運(yùn)行./x clean雖然rm -rf build也能達(dá)到目的但會(huì)丟失已編譯的 LLVM 緩存重建 LLVM 即使在較快的機(jī)器上也非常耗時(shí)因此通常建議使用./x clean。五、鏈接 rustup 工具鏈并使用自建編譯器構(gòu)建完成后build目錄下會(huì)生成一系列產(chǎn)物。推薦用 rustup 將產(chǎn)物鏈接為自定義工具鏈以便隨時(shí)調(diào)用rustup toolchain link stage1 build/host/stage1特別注意如果使用./x setup tools默認(rèn) stage 會(huì)是 2 而非 1鏈接命令需相應(yīng)調(diào)整rustup toolchain link stage2 build/host/stage2之后即可通過(guò)stage1選擇器使用自建編譯器rustc stage1 testfile.rs運(yùn)行rustc stage1 -vV可以驗(yàn)證版本號(hào)以-dev結(jié)尾表明來(lái)自本地構(gòu)建$ rustc stage1 -vV rustc 1.48.0-dev binary: rustc commit-hash: unknown commit-date: unknown host: x86_64-unknown-linux-gnu release: 1.48.0-dev LLVM version: 11.0rustup 工具鏈指向的是build目錄中的產(chǎn)物因此每次運(yùn)行x build或x test后工具鏈會(huì)自動(dòng)指向最新構(gòu)建結(jié)果。需要注意的是自建工具鏈不包含 cargorustup 會(huì)按 nightly → beta → stable 的順序回退使用已安裝工具鏈的 cargo如果需要不穩(wěn)定的 cargo 標(biāo)志請(qǐng)先rustup install nightlyrust-analyzer 與 IntelliJ Rust 插件依賴rust-analyzer-proc-macro-srv組件處理 proc macro若要通過(guò)rustup override set stage1在項(xiàng)目中使用自定義工具鏈可額外構(gòu)建./x build proc-macro-srv-cli六、運(yùn)行測(cè)試./x test 與 UI 測(cè)試套件完成修改后用./x test運(yùn)行測(cè)試套件。但完整測(cè)試套件很慢通常并非所需對(duì)編譯器修改而言./x test tests/ui才是最常用的命令——它運(yùn)行所有 UI 測(cè)試對(duì)每個(gè)特定測(cè)試文件調(diào)用編譯器并核對(duì)編譯器輸出。./x test tests/uiUI 測(cè)試位于 tests/ui本質(zhì)上是一個(gè)編譯器輸出快照測(cè)試體系compiletest 用rustc編譯測(cè)試文件將輸出與同目錄下的.stderr/.stdout文件比對(duì)。測(cè)試文件內(nèi)還會(huì)用//~ ERROR之類的注釋標(biāo)注預(yù)期的診斷信息。當(dāng)你修改了編譯器導(dǎo)致輸出變化后需要更新.stderr快照./x test tests/ui --bless--bless會(huì)用新輸出自動(dòng)重寫.stderr/.stdout文件之后務(wù)必人工檢查快照內(nèi)容是否符合預(yù)期——這正是 UI 測(cè)試保證診斷輸出穩(wěn)定性的核心機(jī)制。其他常用的測(cè)試命令還包括./x test library/std # 運(yùn)行 std 的單元與集成測(cè)試 ./x test tests/ui/const-generics # 運(yùn)行 ui 套件下某子目錄的測(cè)試 ./x test tests/ui/const-generics/const-types.rs # 運(yùn)行單個(gè)測(cè)試文件加快測(cè)試循環(huán)增量編譯./x test tests/ui --incremental --test-args issue-1234可加快后續(xù)重建也可以在bootstrap.toml中固化[rust] incremental true注意增量編譯會(huì)占用更多磁盤空間磁盤緊張時(shí)應(yīng)定期檢查build目錄體積。精細(xì)優(yōu)化將optimize false會(huì)讓編譯器慢到無(wú)法測(cè)試若想縮短重建周期可只對(duì)高頻重建的 crate 關(guān)閉優(yōu)化在根目錄 Cargo.toml 中[profile.release.package.rustc_mir_build] opt-level 0 [profile.release.package.rustc_driver] opt-level 0rust-analyzer 自動(dòng)檢查配置完成后rust-analyzer 可在每次保存文件時(shí)自動(dòng)運(yùn)行./x check詳見下一節(jié)。七、提升開發(fā)效率的常用工作流重構(gòu)期多用 ./x check進(jìn)行類型化重構(gòu)如重命名方法、修改函數(shù)簽名時(shí)./x check比./x build快得多足夠驗(yàn)證編譯器能否構(gòu)建?？梢猿掷m(xù)執(zhí)行./x check積累重構(gòu)提交稍后再集中運(yùn)行測(cè)試并借助git bisect精確定位出問(wèn)題的提交。這樣留下的細(xì)粒度提交既全部可構(gòu)建、又便于審查。安裝 pre-push 鉤子CI 會(huì)要求代碼通過(guò)tidy倉(cāng)庫(kù)內(nèi)置的代碼質(zhì)量檢查工具?？梢园惭b Git 鉤子讓每次 push 自動(dòng)運(yùn)行./x test tidy若鉤子失敗運(yùn)行./x test tidy --bless并提交修復(fù)。倉(cāng)庫(kù)已提供現(xiàn)成鉤子腳本 src/etc/pre-push.sh復(fù)制到.git/hooks并去掉.sh后綴即可./x setup交互流程中也提供安裝鉤子的選項(xiàng)。配置 rust-analyzer./x setup會(huì)詢問(wèn)是否為 VSCode、Vim、Emacs、Helix 或 Zed 設(shè)置編輯器配置也可通過(guò)./x setup editor單獨(dú)觸發(fā)VSCode生成 .vscode/settings.json 風(fēng)格的推薦配置若希望保存時(shí)手動(dòng)觸發(fā)檢查可改用 Build Task如 .vscode/tasks.json 同目錄的配置思路將./x check注冊(cè)為構(gòu)建任務(wù)Emacs選擇emacs生成.dir-locals.el推薦配置見 src/etc/rust_analyzer_eglot.elHelix選擇helix生成languages.toml推薦配置見 src/etc/rust_analyzer_helix.tomlZed選擇zed生成.zed/settings.json推薦配置見 src/etc/rust_analyzer_zed.json。rust-analyzer 默認(rèn)運(yùn)行cargo check與rustfmt對(duì) rustc 倉(cāng)庫(kù)應(yīng)覆蓋為./x check與 stage0 rustfmt。若只關(guān)注編譯器部分可將檢查命令限制為x check compiler --json-output以節(jié)省時(shí)間可用x check --help --verbose查看可選部分。另外rust-analyzer 默認(rèn)使用獨(dú)立構(gòu)建目錄如需共享build目錄以節(jié)省磁盤可以覆蓋生成配置但這會(huì)導(dǎo)致命令行構(gòu)建與后臺(tái)檢查互相鎖定構(gòu)建目錄官方并不推薦。使用 nightly 工具鏈bootstrap 的部分環(huán)節(jié)如 rustfmt使用固定的 nightly 版本。要讓倉(cāng)庫(kù)內(nèi)的cargo fmt正常工作cd rustc 倉(cāng)庫(kù)路徑 rustup override set nightly注意這并不會(huì)讓你能用 cargo 直接構(gòu)建 rustc編譯器與標(biāo)準(zhǔn)庫(kù)的開發(fā)仍須通過(guò)x此操作只是讓cargo fmt等工具可用。如需固定版本可參考 src/stage0 中的 pinned nightly 版本。并行開發(fā)多個(gè)分支git worktree在不同分支并行開發(fā)時(shí)構(gòu)建產(chǎn)物與增量緩存會(huì)互相覆蓋。與其維護(hù)多個(gè)克隆重復(fù)存儲(chǔ) Git 元數(shù)據(jù)不如使用 Git worktree——多個(gè)工作樹共享同一 Git 數(shù)據(jù)庫(kù)git worktree add ../rust2 # 新建工作樹 git worktree add -b my-feature ../rust2 main # 基于 main 創(chuàng)建新分支的工作樹唯一需要注意的是子模塊不會(huì)共享仍會(huì)被多次克隆。Shell 補(bǔ)全./x的自動(dòng)補(bǔ)全腳本位于 src/etc/completions覆蓋 Bash、Zsh、Fish、PowerShell。例如 Bash/Zsh/Fish 可執(zhí)行source ./src/etc/completions/x.extensionPowerShell 執(zhí)行 .\src\etc\completions\x.ps1將其加入 Shell 啟動(dòng)腳本即可自動(dòng)加載。八、常見問(wèn)題速查問(wèn)題解決辦法Windows PowerShell 報(bào)腳本執(zhí)行被禁用Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser修改 LLVM 相關(guān)配置后構(gòu)建不生效執(zhí)行./x clean --all不會(huì)觸發(fā) LLVM 重建--keep-stage-std1構(gòu)建出奇怪的 ICE去掉該標(biāo)志重新構(gòu)建磁盤空間不足清理build/目錄、獨(dú)立的build-rust-analyzer/目錄或用rustup toolchain list卸載不用的工具鏈?zhǔn)褂胐ownload-rustc true時(shí)./x test library/std失敗臨時(shí)以./x test library/std --set rust.download-rustcfalse關(guān)閉download-rustc或在bootstrap.toml中設(shè)置rust.download-rustc false代價(jià)是需要構(gòu)建 stage1 編譯器相關(guān)修復(fù)正在推進(jìn)中結(jié)語(yǔ)從git clone、./x setup生成配置到./x build產(chǎn)出可用的 stage1 工具鏈、rustup toolchain link接入系統(tǒng)、./x test tests/ui --bless維護(hù)診斷快照這一套流程就是 rustc 貢獻(xiàn)者最核心的日常工作閉環(huán)。深入閱讀 how-to-build-and-run.md 與 suggested.md 可以獲得更多細(xì)節(jié)如果仍有疑問(wèn)可以在 Zulip 的t-compiler/help頻道向社區(qū)求助。現(xiàn)在你可以放心地對(duì)編譯器做出第一處修改了?！久赓M(fèi)下載鏈接】rustEmpowering everyone to build reliable and efficient software.項(xiàng)目地址: https://gitcode.com/GitHub_Trending/ru/rust創(chuàng)作聲明：本文部分內(nèi)容由AI輔助生成（AIGC），僅供參考