| <!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `xtask/src/pgo.rs`."><title>pgo.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-77263533.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="xtask" data-themes="" data-resource-suffix="" data-rustdoc-version="1.94.0 (4a4ef493e 2026-03-02)" data-channel="1.94.0" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-b897f86f.js" data-settings-js="settings-c38705f0.js" ><script src="../../static.files/storage-e2aeef58.js"></script><script defer src="../../static.files/src-script-813739b1.js"></script><script defer src="../../src-files.js"></script><script defer src="../../static.files/main-7bab91a1.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-ffcac47a.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">xtask/</div>pgo.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-3"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="doccomment">//! PGO (Profile-Guided Optimization) utilities. |
| <a href=#2 id=2 data-nosnippet>2</a> |
| <a href=#3 id=3 data-nosnippet>3</a></span><span class="kw">use </span>anyhow::Context; |
| <a href=#4 id=4 data-nosnippet>4</a><span class="kw">use </span>std::env::consts::EXE_EXTENSION; |
| <a href=#5 id=5 data-nosnippet>5</a><span class="kw">use </span>std::ffi::OsStr; |
| <a href=#6 id=6 data-nosnippet>6</a><span class="kw">use </span>std::path::{Path, PathBuf}; |
| <a href=#7 id=7 data-nosnippet>7</a><span class="kw">use </span>xshell::{Cmd, Shell, cmd}; |
| <a href=#8 id=8 data-nosnippet>8</a> |
| <a href=#9 id=9 data-nosnippet>9</a><span class="kw">use </span><span class="kw">crate</span>::flags::PgoTrainingCrate; |
| <a href=#10 id=10 data-nosnippet>10</a> |
| <a href=#11 id=11 data-nosnippet>11</a><span class="doccomment">/// Decorates `ra_build_cmd` to add PGO instrumentation, and then runs the PGO instrumented |
| <a href=#12 id=12 data-nosnippet>12</a>/// Rust Analyzer on itself to gather a PGO profile. |
| <a href=#13 id=13 data-nosnippet>13</a></span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>gather_pgo_profile<<span class="lifetime">'a</span>>( |
| <a href=#14 id=14 data-nosnippet>14</a> sh: <span class="kw-2">&</span><span class="lifetime">'a </span>Shell, |
| <a href=#15 id=15 data-nosnippet>15</a> ra_build_cmd: Cmd<<span class="lifetime">'a</span>>, |
| <a href=#16 id=16 data-nosnippet>16</a> target: <span class="kw-2">&</span>str, |
| <a href=#17 id=17 data-nosnippet>17</a> train_crate: PgoTrainingCrate, |
| <a href=#18 id=18 data-nosnippet>18</a>) -> anyhow::Result<PathBuf> { |
| <a href=#19 id=19 data-nosnippet>19</a> <span class="kw">let </span>pgo_dir = std::path::absolute(<span class="string">"rust-analyzer-pgo"</span>)<span class="question-mark">?</span>; |
| <a href=#20 id=20 data-nosnippet>20</a> <span class="comment">// Clear out any stale profiles |
| <a href=#21 id=21 data-nosnippet>21</a> </span><span class="kw">if </span>pgo_dir.is_dir() { |
| <a href=#22 id=22 data-nosnippet>22</a> std::fs::remove_dir_all(<span class="kw-2">&</span>pgo_dir)<span class="question-mark">?</span>; |
| <a href=#23 id=23 data-nosnippet>23</a> } |
| <a href=#24 id=24 data-nosnippet>24</a> std::fs::create_dir_all(<span class="kw-2">&</span>pgo_dir)<span class="question-mark">?</span>; |
| <a href=#25 id=25 data-nosnippet>25</a> |
| <a href=#26 id=26 data-nosnippet>26</a> <span class="comment">// Figure out a path to `llvm-profdata` |
| <a href=#27 id=27 data-nosnippet>27</a> </span><span class="kw">let </span>target_libdir = <span class="macro">cmd!</span>(sh, <span class="string">"rustc --print=target-libdir"</span>) |
| <a href=#28 id=28 data-nosnippet>28</a> .read() |
| <a href=#29 id=29 data-nosnippet>29</a> .context(<span class="string">"cannot resolve target-libdir from rustc"</span>)<span class="question-mark">?</span>; |
| <a href=#30 id=30 data-nosnippet>30</a> <span class="kw">let </span>target_bindir = PathBuf::from(target_libdir).parent().unwrap().join(<span class="string">"bin"</span>); |
| <a href=#31 id=31 data-nosnippet>31</a> <span class="kw">let </span>llvm_profdata = target_bindir.join(<span class="string">"llvm-profdata"</span>).with_extension(EXE_EXTENSION); |
| <a href=#32 id=32 data-nosnippet>32</a> |
| <a href=#33 id=33 data-nosnippet>33</a> <span class="comment">// Build RA with PGO instrumentation |
| <a href=#34 id=34 data-nosnippet>34</a> </span><span class="kw">let </span>cmd_gather = |
| <a href=#35 id=35 data-nosnippet>35</a> ra_build_cmd.env(<span class="string">"RUSTFLAGS"</span>, <span class="macro">format!</span>(<span class="string">"-Cprofile-generate={}"</span>, pgo_dir.to_str().unwrap())); |
| <a href=#36 id=36 data-nosnippet>36</a> cmd_gather.run().context(<span class="string">"cannot build rust-analyzer with PGO instrumentation"</span>)<span class="question-mark">?</span>; |
| <a href=#37 id=37 data-nosnippet>37</a> |
| <a href=#38 id=38 data-nosnippet>38</a> <span class="kw">let </span>(train_path, label) = <span class="kw">match </span><span class="kw-2">&</span>train_crate { |
| <a href=#39 id=39 data-nosnippet>39</a> PgoTrainingCrate::RustAnalyzer => (PathBuf::from(<span class="string">"."</span>), <span class="string">"itself"</span>), |
| <a href=#40 id=40 data-nosnippet>40</a> PgoTrainingCrate::GitHub(repo) => { |
| <a href=#41 id=41 data-nosnippet>41</a> (download_crate_for_training(sh, <span class="kw-2">&</span>pgo_dir, repo)<span class="question-mark">?</span>, repo.as_str()) |
| <a href=#42 id=42 data-nosnippet>42</a> } |
| <a href=#43 id=43 data-nosnippet>43</a> }; |
| <a href=#44 id=44 data-nosnippet>44</a> |
| <a href=#45 id=45 data-nosnippet>45</a> <span class="comment">// Run RA either on itself or on a downloaded crate |
| <a href=#46 id=46 data-nosnippet>46</a> </span><span class="macro">eprintln!</span>(<span class="string">"Training RA on {label}..."</span>); |
| <a href=#47 id=47 data-nosnippet>47</a> <span class="macro">cmd!</span>( |
| <a href=#48 id=48 data-nosnippet>48</a> sh, |
| <a href=#49 id=49 data-nosnippet>49</a> <span class="string">"target/{target}/release/rust-analyzer analysis-stats -q --run-all-ide-things {train_path}" |
| <a href=#50 id=50 data-nosnippet>50</a> </span>) |
| <a href=#51 id=51 data-nosnippet>51</a> .run() |
| <a href=#52 id=52 data-nosnippet>52</a> .context(<span class="string">"cannot generate PGO profiles"</span>)<span class="question-mark">?</span>; |
| <a href=#53 id=53 data-nosnippet>53</a> |
| <a href=#54 id=54 data-nosnippet>54</a> <span class="comment">// Merge profiles into a single file |
| <a href=#55 id=55 data-nosnippet>55</a> </span><span class="kw">let </span>merged_profile = pgo_dir.join(<span class="string">"merged.profdata"</span>); |
| <a href=#56 id=56 data-nosnippet>56</a> <span class="kw">let </span>profile_files = std::fs::read_dir(pgo_dir)<span class="question-mark">? |
| <a href=#57 id=57 data-nosnippet>57</a> </span>.filter_map(|entry| { |
| <a href=#58 id=58 data-nosnippet>58</a> <span class="kw">let </span>entry = entry.ok()<span class="question-mark">?</span>; |
| <a href=#59 id=59 data-nosnippet>59</a> <span class="kw">if </span>entry.path().extension() == <span class="prelude-val">Some</span>(OsStr::new(<span class="string">"profraw"</span>)) { |
| <a href=#60 id=60 data-nosnippet>60</a> <span class="prelude-val">Some</span>(entry.path().to_str().unwrap().to_owned()) |
| <a href=#61 id=61 data-nosnippet>61</a> } <span class="kw">else </span>{ |
| <a href=#62 id=62 data-nosnippet>62</a> <span class="prelude-val">None |
| <a href=#63 id=63 data-nosnippet>63</a> </span>} |
| <a href=#64 id=64 data-nosnippet>64</a> }) |
| <a href=#65 id=65 data-nosnippet>65</a> .collect::<Vec<<span class="kw">_</span>>>(); |
| <a href=#66 id=66 data-nosnippet>66</a> |
| <a href=#67 id=67 data-nosnippet>67</a> <span class="kw">if </span>profile_files.is_empty() { |
| <a href=#68 id=68 data-nosnippet>68</a> <span class="macro">anyhow::bail!</span>( |
| <a href=#69 id=69 data-nosnippet>69</a> <span class="string">"rust-analyzer analysis-stats produced no pgo files. This is a bug in rust-analyzer; please file an issue." |
| <a href=#70 id=70 data-nosnippet>70</a> </span>); |
| <a href=#71 id=71 data-nosnippet>71</a> } |
| <a href=#72 id=72 data-nosnippet>72</a> |
| <a href=#73 id=73 data-nosnippet>73</a> <span class="macro">cmd!</span>(sh, <span class="string">"{llvm_profdata} merge {profile_files...} -o {merged_profile}"</span>).run().context( |
| <a href=#74 id=74 data-nosnippet>74</a> <span class="string">"cannot merge PGO profiles. Do you have the rustup `llvm-tools` component installed?"</span>, |
| <a href=#75 id=75 data-nosnippet>75</a> )<span class="question-mark">?</span>; |
| <a href=#76 id=76 data-nosnippet>76</a> |
| <a href=#77 id=77 data-nosnippet>77</a> <span class="prelude-val">Ok</span>(merged_profile) |
| <a href=#78 id=78 data-nosnippet>78</a>} |
| <a href=#79 id=79 data-nosnippet>79</a> |
| <a href=#80 id=80 data-nosnippet>80</a><span class="doccomment">/// Downloads a crate from GitHub, stores it into `pgo_dir` and returns a path to it. |
| <a href=#81 id=81 data-nosnippet>81</a></span><span class="kw">fn </span>download_crate_for_training(sh: <span class="kw-2">&</span>Shell, pgo_dir: <span class="kw-2">&</span>Path, repo: <span class="kw-2">&</span>str) -> anyhow::Result<PathBuf> { |
| <a href=#82 id=82 data-nosnippet>82</a> <span class="kw">let </span><span class="kw-2">mut </span>it = repo.splitn(<span class="number">2</span>, <span class="string">'@'</span>); |
| <a href=#83 id=83 data-nosnippet>83</a> <span class="kw">let </span>repo = it.next().unwrap(); |
| <a href=#84 id=84 data-nosnippet>84</a> <span class="kw">let </span>revision = it.next(); |
| <a href=#85 id=85 data-nosnippet>85</a> |
| <a href=#86 id=86 data-nosnippet>86</a> <span class="comment">// FIXME: switch to `--revision` here around 2035 or so |
| <a href=#87 id=87 data-nosnippet>87</a> </span><span class="kw">let </span>revision = |
| <a href=#88 id=88 data-nosnippet>88</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(revision) = revision { <span class="kw-2">&</span>[<span class="string">"--branch"</span>, revision] <span class="kw">as </span><span class="kw-2">&</span>[<span class="kw-2">&</span>str] } <span class="kw">else </span>{ <span class="kw-2">&</span>[] }; |
| <a href=#89 id=89 data-nosnippet>89</a> |
| <a href=#90 id=90 data-nosnippet>90</a> <span class="kw">let </span>normalized_path = repo.replace(<span class="string">"/"</span>, <span class="string">"-"</span>); |
| <a href=#91 id=91 data-nosnippet>91</a> <span class="kw">let </span>target_path = pgo_dir.join(normalized_path); |
| <a href=#92 id=92 data-nosnippet>92</a> <span class="macro">cmd!</span>(sh, <span class="string">"git clone --depth 1 https://github.com/{repo} {revision...} {target_path}"</span>) |
| <a href=#93 id=93 data-nosnippet>93</a> .run() |
| <a href=#94 id=94 data-nosnippet>94</a> .with_context(|| <span class="string">"cannot download PGO training crate from {repo}"</span>)<span class="question-mark">?</span>; |
| <a href=#95 id=95 data-nosnippet>95</a> |
| <a href=#96 id=96 data-nosnippet>96</a> <span class="prelude-val">Ok</span>(target_path) |
| <a href=#97 id=97 data-nosnippet>97</a>} |
| <a href=#98 id=98 data-nosnippet>98</a> |
| <a href=#99 id=99 data-nosnippet>99</a><span class="doccomment">/// Helper function to create a build command for rust-analyzer |
| <a href=#100 id=100 data-nosnippet>100</a></span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>build_command<<span class="lifetime">'a</span>>( |
| <a href=#101 id=101 data-nosnippet>101</a> sh: <span class="kw-2">&</span><span class="lifetime">'a </span>Shell, |
| <a href=#102 id=102 data-nosnippet>102</a> command: <span class="kw-2">&</span>str, |
| <a href=#103 id=103 data-nosnippet>103</a> target_name: <span class="kw-2">&</span>str, |
| <a href=#104 id=104 data-nosnippet>104</a> features: <span class="kw-2">&</span>[<span class="kw-2">&</span>str], |
| <a href=#105 id=105 data-nosnippet>105</a>) -> Cmd<<span class="lifetime">'a</span>> { |
| <a href=#106 id=106 data-nosnippet>106</a> <span class="macro">cmd!</span>( |
| <a href=#107 id=107 data-nosnippet>107</a> sh, |
| <a href=#108 id=108 data-nosnippet>108</a> <span class="string">"cargo {command} --manifest-path ./crates/rust-analyzer/Cargo.toml --bin rust-analyzer --target {target_name} {features...} --release" |
| <a href=#109 id=109 data-nosnippet>109</a> </span>) |
| <a href=#110 id=110 data-nosnippet>110</a>} |
| <a href=#111 id=111 data-nosnippet>111</a> |
| <a href=#112 id=112 data-nosnippet>112</a><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>apply_pgo_to_cmd<<span class="lifetime">'a</span>>(cmd: Cmd<<span class="lifetime">'a</span>>, profile_path: <span class="kw-2">&</span>Path) -> Cmd<<span class="lifetime">'a</span>> { |
| <a href=#113 id=113 data-nosnippet>113</a> cmd.env(<span class="string">"RUSTFLAGS"</span>, <span class="macro">format!</span>(<span class="string">"-Cprofile-use={}"</span>, profile_path.to_str().unwrap())) |
| <a href=#114 id=114 data-nosnippet>114</a>} |
| </code></pre></div></section></main></body></html> |
