| <!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 `crates/profile/src/lib.rs`."><title>lib.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" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-84e720fa.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="profile" data-themes="" data-resource-suffix="" data-rustdoc-version="1.89.0 (29483883e 2025-08-04)" data-channel="1.89.0" data-search-js="search-92309212.js" data-settings-js="settings-5514c975.js" ><script src="../../static.files/storage-4e99c027.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-fd3af306.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-32bb7600.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.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><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">profile/</div>lib.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-2"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="doccomment">//! A collection of tools for profiling rust-analyzer. |
| <a href=#2 id=2 data-nosnippet>2</a> |
| <a href=#3 id=3 data-nosnippet>3</a></span><span class="attr">#[cfg(feature = <span class="string">"cpu_profiler"</span>)] |
| <a href=#4 id=4 data-nosnippet>4</a></span><span class="kw">mod </span>google_cpu_profiler; |
| <a href=#5 id=5 data-nosnippet>5</a><span class="kw">mod </span>memory_usage; |
| <a href=#6 id=6 data-nosnippet>6</a><span class="kw">mod </span>stop_watch; |
| <a href=#7 id=7 data-nosnippet>7</a> |
| <a href=#8 id=8 data-nosnippet>8</a><span class="kw">use </span>std::cell::RefCell; |
| <a href=#9 id=9 data-nosnippet>9</a> |
| <a href=#10 id=10 data-nosnippet>10</a><span class="kw">pub use crate</span>::{ |
| <a href=#11 id=11 data-nosnippet>11</a> memory_usage::{Bytes, MemoryUsage}, |
| <a href=#12 id=12 data-nosnippet>12</a> stop_watch::{StopWatch, StopWatchSpan}, |
| <a href=#13 id=13 data-nosnippet>13</a>}; |
| <a href=#14 id=14 data-nosnippet>14</a> |
| <a href=#15 id=15 data-nosnippet>15</a><span class="macro">thread_local!</span>(<span class="kw">static </span>IN_SCOPE: RefCell<bool> = <span class="kw">const </span>{ RefCell::new(<span class="bool-val">false</span>) }); |
| <a href=#16 id=16 data-nosnippet>16</a> |
| <a href=#17 id=17 data-nosnippet>17</a><span class="doccomment">/// A wrapper around google_cpu_profiler. |
| <a href=#18 id=18 data-nosnippet>18</a>/// |
| <a href=#19 id=19 data-nosnippet>19</a>/// Usage: |
| <a href=#20 id=20 data-nosnippet>20</a>/// 1. Install gperf_tools (<https://github.com/gperftools/gperftools>), probably packaged with your Linux distro. |
| <a href=#21 id=21 data-nosnippet>21</a>/// 2. Build with `cpu_profiler` feature. |
| <a href=#22 id=22 data-nosnippet>22</a>/// 3. Run the code, the *raw* output would be in the `./out.profile` file. |
| <a href=#23 id=23 data-nosnippet>23</a>/// 4. Install pprof for visualization (<https://github.com/google/pprof>). |
| <a href=#24 id=24 data-nosnippet>24</a>/// 5. Bump sampling frequency to once per ms: `export CPUPROFILE_FREQUENCY=1000` |
| <a href=#25 id=25 data-nosnippet>25</a>/// 6. Use something like `pprof -svg target/release/rust-analyzer ./out.profile` to see the results. |
| <a href=#26 id=26 data-nosnippet>26</a>/// |
| <a href=#27 id=27 data-nosnippet>27</a>/// For example, here's how I run profiling on NixOS: |
| <a href=#28 id=28 data-nosnippet>28</a>/// |
| <a href=#29 id=29 data-nosnippet>29</a>/// ```bash |
| <a href=#30 id=30 data-nosnippet>30</a>/// $ bat -p shell.nix |
| <a href=#31 id=31 data-nosnippet>31</a>/// with import <nixpkgs> {}; |
| <a href=#32 id=32 data-nosnippet>32</a>/// mkShell { |
| <a href=#33 id=33 data-nosnippet>33</a>/// buildInputs = [ gperftools ]; |
| <a href=#34 id=34 data-nosnippet>34</a>/// shellHook = '' |
| <a href=#35 id=35 data-nosnippet>35</a>/// export LD_LIBRARY_PATH="${gperftools}/lib:" |
| <a href=#36 id=36 data-nosnippet>36</a>/// ''; |
| <a href=#37 id=37 data-nosnippet>37</a>/// } |
| <a href=#38 id=38 data-nosnippet>38</a>/// $ set -x CPUPROFILE_FREQUENCY 1000 |
| <a href=#39 id=39 data-nosnippet>39</a>/// $ nix-shell --run 'cargo test --release --package rust-analyzer --lib -- benchmarks::benchmark_integrated_highlighting --exact --nocapture' |
| <a href=#40 id=40 data-nosnippet>40</a>/// $ pprof -svg target/release/deps/rust_analyzer-8739592dc93d63cb crates/rust-analyzer/out.profile > profile.svg |
| <a href=#41 id=41 data-nosnippet>41</a>/// ``` |
| <a href=#42 id=42 data-nosnippet>42</a>/// |
| <a href=#43 id=43 data-nosnippet>43</a>/// See this diff for how to profile completions: |
| <a href=#44 id=44 data-nosnippet>44</a>/// |
| <a href=#45 id=45 data-nosnippet>45</a>/// <https://github.com/rust-lang/rust-analyzer/pull/5306> |
| <a href=#46 id=46 data-nosnippet>46</a></span><span class="attr">#[derive(Debug)] |
| <a href=#47 id=47 data-nosnippet>47</a></span><span class="kw">pub struct </span>CpuSpan { |
| <a href=#48 id=48 data-nosnippet>48</a> _private: (), |
| <a href=#49 id=49 data-nosnippet>49</a>} |
| <a href=#50 id=50 data-nosnippet>50</a> |
| <a href=#51 id=51 data-nosnippet>51</a><span class="attr">#[must_use] |
| <a href=#52 id=52 data-nosnippet>52</a></span><span class="kw">pub fn </span>cpu_span() -> CpuSpan { |
| <a href=#53 id=53 data-nosnippet>53</a> <span class="attr">#[cfg(feature = <span class="string">"cpu_profiler"</span>)] |
| <a href=#54 id=54 data-nosnippet>54</a> </span>{ |
| <a href=#55 id=55 data-nosnippet>55</a> google_cpu_profiler::start(<span class="string">"./out.profile"</span>.as_ref()) |
| <a href=#56 id=56 data-nosnippet>56</a> } |
| <a href=#57 id=57 data-nosnippet>57</a> |
| <a href=#58 id=58 data-nosnippet>58</a> <span class="attr">#[cfg(not(feature = <span class="string">"cpu_profiler"</span>))] |
| <a href=#59 id=59 data-nosnippet>59</a> #[allow(clippy::print_stderr)] |
| <a href=#60 id=60 data-nosnippet>60</a> </span>{ |
| <a href=#61 id=61 data-nosnippet>61</a> <span class="macro">eprintln!</span>( |
| <a href=#62 id=62 data-nosnippet>62</a> <span class="string">r#"cpu profiling is disabled, uncomment `default = [ "cpu_profiler" ]` in Cargo.toml to enable."# |
| <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> |
| <a href=#66 id=66 data-nosnippet>66</a> CpuSpan { _private: () } |
| <a href=#67 id=67 data-nosnippet>67</a>} |
| <a href=#68 id=68 data-nosnippet>68</a> |
| <a href=#69 id=69 data-nosnippet>69</a><span class="kw">impl </span>Drop <span class="kw">for </span>CpuSpan { |
| <a href=#70 id=70 data-nosnippet>70</a> <span class="kw">fn </span>drop(<span class="kw-2">&mut </span><span class="self">self</span>) { |
| <a href=#71 id=71 data-nosnippet>71</a> <span class="attr">#[cfg(feature = <span class="string">"cpu_profiler"</span>)] |
| <a href=#72 id=72 data-nosnippet>72</a> </span>{ |
| <a href=#73 id=73 data-nosnippet>73</a> google_cpu_profiler::stop(); |
| <a href=#74 id=74 data-nosnippet>74</a> <span class="kw">let </span>profile_data = std::env::current_dir().unwrap().join(<span class="string">"out.profile"</span>); |
| <a href=#75 id=75 data-nosnippet>75</a> <span class="macro">eprintln!</span>(<span class="string">"Profile data saved to:\n\n {}\n"</span>, profile_data.display()); |
| <a href=#76 id=76 data-nosnippet>76</a> <span class="kw">let </span><span class="kw-2">mut </span>cmd = std::process::Command::new(<span class="string">"pprof"</span>); |
| <a href=#77 id=77 data-nosnippet>77</a> cmd.arg(<span class="string">"-svg"</span>).arg(std::env::current_exe().unwrap()).arg(<span class="kw-2">&</span>profile_data); |
| <a href=#78 id=78 data-nosnippet>78</a> <span class="kw">let </span>out = cmd.output(); |
| <a href=#79 id=79 data-nosnippet>79</a> |
| <a href=#80 id=80 data-nosnippet>80</a> <span class="kw">match </span>out { |
| <a href=#81 id=81 data-nosnippet>81</a> <span class="prelude-val">Ok</span>(out) <span class="kw">if </span>out.status.success() => { |
| <a href=#82 id=82 data-nosnippet>82</a> <span class="kw">let </span>svg = profile_data.with_extension(<span class="string">"svg"</span>); |
| <a href=#83 id=83 data-nosnippet>83</a> std::fs::write(<span class="kw-2">&</span>svg, out.stdout).unwrap(); |
| <a href=#84 id=84 data-nosnippet>84</a> <span class="macro">eprintln!</span>(<span class="string">"Profile rendered to:\n\n {}\n"</span>, svg.display()); |
| <a href=#85 id=85 data-nosnippet>85</a> } |
| <a href=#86 id=86 data-nosnippet>86</a> <span class="kw">_ </span>=> { |
| <a href=#87 id=87 data-nosnippet>87</a> <span class="macro">eprintln!</span>(<span class="string">"Failed to run:\n\n {cmd:?}\n"</span>); |
| <a href=#88 id=88 data-nosnippet>88</a> } |
| <a href=#89 id=89 data-nosnippet>89</a> } |
| <a href=#90 id=90 data-nosnippet>90</a> } |
| <a href=#91 id=91 data-nosnippet>91</a> } |
| <a href=#92 id=92 data-nosnippet>92</a>} |
| <a href=#93 id=93 data-nosnippet>93</a> |
| <a href=#94 id=94 data-nosnippet>94</a><span class="kw">pub fn </span>memory_usage() -> MemoryUsage { |
| <a href=#95 id=95 data-nosnippet>95</a> MemoryUsage::now() |
| <a href=#96 id=96 data-nosnippet>96</a>}</code></pre></div></section></main></body></html> |
