profiling/wpa_profiling.html - rust-lang/rustc-dev-guide - Git at Google

 <!DOCTYPE HTML>
 <html lang="en" class="light sidebar-visible" dir="ltr">
     <head>
         <!-- Book generated using mdBook -->
         <meta charset="UTF-8">
         <title>with Windows Performance Analyzer - Rust Compiler Development Guide</title>


         <!-- Custom HTML head -->

         <meta name="description" content="A guide to developing the Rust compiler (rustc)">
         <meta name="viewport" content="width=device-width, initial-scale=1">
         <meta name="theme-color" content="#ffffff">

         <link rel="icon" href="../favicon.svg">
         <link rel="shortcut icon" href="../favicon.png">
         <link rel="stylesheet" href="../css/variables.css">
         <link rel="stylesheet" href="../css/general.css">
         <link rel="stylesheet" href="../css/chrome.css">
         <link rel="stylesheet" href="../css/print.css" media="print">

         <!-- Fonts -->
         <link rel="stylesheet" href="../FontAwesome/css/font-awesome.css">
         <link rel="stylesheet" href="../fonts/fonts.css">

         <!-- Highlight.js Stylesheets -->
         <link rel="stylesheet" id="highlight-css" href="../highlight.css">
         <link rel="stylesheet" id="tomorrow-night-css" href="../tomorrow-night.css">
         <link rel="stylesheet" id="ayu-highlight-css" href="../ayu-highlight.css">

         <!-- Custom theme stylesheets -->


         <!-- Provide site root and default themes to javascript -->
         <script>
             const path_to_root = "../";
             const default_light_theme = "light";
             const default_dark_theme = "navy";
         </script>
         <!-- Start loading toc.js asap -->
         <script src="../toc.js"></script>
     </head>
     <body>
     <div id="body-container">
         <!-- Work around some values being stored in localStorage wrapped in quotes -->
         <script>
             try {
                 let theme = localStorage.getItem('mdbook-theme');
                 let sidebar = localStorage.getItem('mdbook-sidebar');

                 if (theme.startsWith('"') && theme.endsWith('"')) {
                     localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
                 }

                 if (sidebar.startsWith('"') && sidebar.endsWith('"')) {
                     localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
                 }
             } catch (e) { }
         </script>

         <!-- Set the theme before any content is loaded, prevents flash -->
         <script>
             const default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? default_dark_theme : default_light_theme;
             let theme;
             try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
             if (theme === null || theme === undefined) { theme = default_theme; }
             const html = document.documentElement;
             html.classList.remove('light')
             html.classList.add(theme);
             html.classList.add("js");
         </script>

         <input type="checkbox" id="sidebar-toggle-anchor" class="hidden">

         <!-- Hide / unhide sidebar before it is displayed -->
         <script>
             let sidebar = null;
             const sidebar_toggle = document.getElementById("sidebar-toggle-anchor");
             if (document.body.clientWidth >= 1080) {
                 try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
                 sidebar = sidebar || 'visible';
             } else {
                 sidebar = 'hidden';
             }
             sidebar_toggle.checked = sidebar === 'visible';
             html.classList.remove('sidebar-visible');
             html.classList.add("sidebar-" + sidebar);
         </script>

         <nav id="sidebar" class="sidebar" aria-label="Table of contents">
             <!-- populated by js -->
             <mdbook-sidebar-scrollbox class="sidebar-scrollbox"></mdbook-sidebar-scrollbox>
             <noscript>
                 <iframe class="sidebar-iframe-outer" src="../toc.html"></iframe>
             </noscript>
             <div id="sidebar-resize-handle" class="sidebar-resize-handle">
                 <div class="sidebar-resize-indicator"></div>
             </div>
         </nav>

         <div id="page-wrapper" class="page-wrapper">

             <div class="page">
                 <div id="menu-bar-hover-placeholder"></div>
                 <div id="menu-bar" class="menu-bar sticky">
                     <div class="left-buttons">
                         <label id="sidebar-toggle" class="icon-button" for="sidebar-toggle-anchor" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
                             <i class="fa fa-bars"></i>
                         </label>
                         <button id="theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="theme-list">
                             <i class="fa fa-paint-brush"></i>
                         </button>
                         <ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu">
                             <li role="none"><button role="menuitem" class="theme" id="default_theme">Auto</button></li>
                             <li role="none"><button role="menuitem" class="theme" id="light">Light</button></li>
                             <li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li>
                             <li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li>
                             <li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li>
                             <li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li>
                         </ul>
                         <button id="search-toggle" class="icon-button" type="button" title="Search. (Shortkey: s)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="S" aria-controls="searchbar">
                             <i class="fa fa-search"></i>
                         </button>
                     </div>

                     <h1 class="menu-title">Rust Compiler Development Guide</h1>

                     <div class="right-buttons">
                         <a href="../print.html" title="Print this book" aria-label="Print this book">
                             <i id="print-button" class="fa fa-print"></i>
                         </a>
                         <a href="https://github.com/rust-lang/rustc-dev-guide" title="Git repository" aria-label="Git repository">
                             <i id="git-repository-button" class="fa fa-github"></i>
                         </a>
                         <a href="https://github.com/rust-lang/rustc-dev-guide/edit/master/src/profiling/wpa_profiling.md" title="Suggest an edit" aria-label="Suggest an edit">
                             <i id="git-edit-button" class="fa fa-edit"></i>
                         </a>

                     </div>
                 </div>

                 <div id="search-wrapper" class="hidden">
                     <form id="searchbar-outer" class="searchbar-outer">
                         <input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header">
                     </form>
                     <div id="searchresults-outer" class="searchresults-outer hidden">
                         <div id="searchresults-header" class="searchresults-header"></div>
                         <ul id="searchresults">
                         </ul>
                     </div>
                 </div>

                 <!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
                 <script>
                     document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
                     document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
                     Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
                         link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
                     });
                 </script>

                 <div id="content" class="content">
                     <main>
                         <h1 id="profiling-on-windows"><a class="header" href="#profiling-on-windows">Profiling on Windows</a></h1>
 <h2 id="introducing-wpr-and-wpa"><a class="header" href="#introducing-wpr-and-wpa">Introducing WPR and WPA</a></h2>
 <p>High-level performance analysis (including memory usage) can be performed with the Windows
 Performance Recorder (WPR) and Windows Performance Analyzer (WPA). As the names suggest, WPR is for
 recording system statistics (in the form of event trace log a.k.a. ETL files), while WPA is for
 analyzing these ETL files.</p>
 <p>WPR collects system wide statistics, so it won't just record things relevant to rustc but also
 everything else that's running on the machine. During analysis, we can filter to just the things we
 find interesting.</p>
 <p>These tools are quite powerful but also require a bit of learning
 before we can successfully profile the Rust compiler.</p>
 <p>Here we will explore how to use WPR and WPA for analyzing the Rust compiler as well as provide
 links to useful "profiles" (i.e., settings files that tweak the defaults for WPR and WPA) that are
 specifically designed to make analyzing rustc easier.</p>
 <h3 id="installing-wpr-and-wpa"><a class="header" href="#installing-wpr-and-wpa">Installing WPR and WPA</a></h3>
 <p>You can install WPR and WPA as part of the Windows Performance Toolkit which itself is an option as
 part of downloading the Windows Assessment and Deployment Kit (ADK). You can download the ADK
 installer <a href="https://go.microsoft.com/fwlink/?linkid=2086042">here</a>. Make sure to select the Windows
 Performance Toolkit (you don't need to select anything else).</p>
 <h2 id="recording"><a class="header" href="#recording">Recording</a></h2>
 <p>In order to perform system analysis, you'll first need to record your system with WPR. Open WPR and
 at the bottom of the window select the "profiles" of the things you want to record. For looking
 into memory usage of the rustc bootstrap process, we'll want to select the following items:</p>
 <ul>
 <li>CPU usage</li>
 <li>VirtualAlloc usage</li>
 </ul>
 <p>You might be tempted to record "Heap usage" as well, but this records every single heap allocation
 and can be very, very expensive. For high-level analysis, it might be best to leave that turned
 off.</p>
 <p>Now we need to get our setup ready to record. For memory usage analysis, it is best to record the
 stage 2 compiler build with a stage 1 compiler build with debug symbols. Having symbols in the
 compiler we're using to build rustc will aid our analysis greatly by allowing WPA to resolve Rust
 symbols correctly. Unfortunately, the stage 0 compiler does not have symbols turned on which is why
 we'll need to build a stage 1 compiler and then a stage 2 compiler ourselves.</p>
 <p>To do this, make sure you have set <code>debuginfo-level = 1</code> in your <code>bootstrap.toml</code> file. This tells
 rustc to generate debug information which includes stack frames when bootstrapping.</p>
 <p>Now you can build the stage 1 compiler: <code>x build --stage 1 -i library</code> or however
 else you want to build the stage 1 compiler.</p>
 <p>Now that the stage 1 compiler is built, we can record the stage 2 build. Go back to WPR, click the
 "start" button and build the stage 2 compiler (e.g., <code>x build --stage=2 -i library</code>).
 When this process finishes, stop the recording.</p>
 <p>Click the Save button and once that process is complete, click the "Open in WPA" button which
 appears.</p>
 <blockquote>
 <p>Note: The trace file is fairly large so it can take WPA some time to finish opening the file.</p>
 </blockquote>
 <h2 id="analysis"><a class="header" href="#analysis">Analysis</a></h2>
 <p>Now that our ETL file is open in WPA, we can analyze the results. First, we'll want to apply the
 pre-made "profile" which will put WPA into a state conducive to analyzing rustc bootstrap. Download
 the profile <a href="https://github.com/wesleywiser/rustc-bootstrap-wpa-analysis/releases/download/1/rustc.generic.wpaProfile">here</a>.
 Select the "Profiles" menu at the top, then "apply" and then choose the downloaded profile.</p>
 <p>You should see something resembling the following:</p>
 <p><img src="../img/wpa-initial-memory.png" alt="WPA with profile applied" /></p>
 <p>Next, we will need to tell WPA to load and process debug symbols so that it can properly demangle
 the Rust stack traces. To do this, click "Trace" and then choose "Load Symbols". This step can take
 a while.</p>
 <p>Once WPA has loaded symbols for rustc, we can expand the rustc.exe node and begin drilling down
 into the stack with the largest allocations.</p>
 <p>To do that, we'll expand the <code>[Root]</code> node in the "Commit Stack" column and continue expanding
 until we find interesting stack frames.</p>
 <blockquote>
 <p>Tip: After selecting the node you want to expand, press the right arrow key. This will expand the
 node and put the selection on the next largest node in the expanded set. You can continue pressing
 the right arrow key until you reach an interesting frame.</p>
 </blockquote>
 <p><img src="../img/wpa-stack.png" alt="WPA with expanded stack" /></p>
 <p>In this sample, you can see calls through codegen are allocating ~30gb of memory in total
 throughout this profile.</p>
 <h2 id="other-analysis-tabs"><a class="header" href="#other-analysis-tabs">Other Analysis Tabs</a></h2>
 <p>The profile also includes a few other tabs which can be helpful:</p>
 <ul>
 <li>System Configuration
 <ul>
 <li>General information about the system the capture was recorded on.</li>
 </ul>
 </li>
 <li>rustc Build Processes
 <ul>
 <li>A flat list of relevant processes such as rustc.exe, cargo.exe, link.exe etc.</li>
 <li>Each process lists its command line arguments.</li>
 <li>Useful for figuring out what a specific rustc process was working on.</li>
 </ul>
 </li>
 <li>rustc Build Process Tree
 <ul>
 <li>Timeline showing when processes started and exited.</li>
 </ul>
 </li>
 <li>rustc CPU Analysis
 <ul>
 <li>Contains charts preconfigured to show hotspots in rustc.</li>
 <li>These charts are designed to support analyzing where rustc is spending its time.</li>
 </ul>
 </li>
 <li>rustc Memory Analysis
 <ul>
 <li>Contains charts preconfigured to show where rustc is allocating memory.</li>
 </ul>
 </li>
 </ul>

                     </main>

                     <nav class="nav-wrapper" aria-label="Page navigation">
                         <!-- Mobile navigation buttons -->
                             <a rel="prev" href="../profiling/with_perf.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
                                 <i class="fa fa-angle-left"></i>
                             </a>

                             <a rel="next prefetch" href="../profiling/with_rustc_perf.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
                                 <i class="fa fa-angle-right"></i>
                             </a>

                         <div style="clear: both"></div>
                     </nav>
                 </div>
             </div>

             <nav class="nav-wide-wrapper" aria-label="Page navigation">
                     <a rel="prev" href="../profiling/with_perf.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
                         <i class="fa fa-angle-left"></i>
                     </a>

                     <a rel="next prefetch" href="../profiling/with_rustc_perf.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
                         <i class="fa fa-angle-right"></i>
                     </a>
             </nav>

         </div>


         <script>
             window.playground_copyable = true;
         </script>


         <script src="../elasticlunr.min.js"></script>
         <script src="../mark.min.js"></script>
         <script src="../searcher.js"></script>

         <script src="../clipboard.min.js"></script>
         <script src="../highlight.js"></script>
         <script src="../book.js"></script>

         <!-- Custom JS scripts -->
         <script src="../mermaid.min.js"></script>
         <script src="../mermaid-init.js"></script>


     </div>
     </body>
 </html>
	<!DOCTYPE HTML>
	<html lang="en" class="light sidebar-visible" dir="ltr">
	<head>
	<!-- Book generated using mdBook -->
	<meta charset="UTF-8">
	<title>with Windows Performance Analyzer - Rust Compiler Development Guide</title>


	<!-- Custom HTML head -->

	<meta name="description" content="A guide to developing the Rust compiler (rustc)">
	<meta name="viewport" content="width=device-width, initial-scale=1">
	<meta name="theme-color" content="#ffffff">

	<link rel="icon" href="../favicon.svg">
	<link rel="shortcut icon" href="../favicon.png">
	<link rel="stylesheet" href="../css/variables.css">
	<link rel="stylesheet" href="../css/general.css">
	<link rel="stylesheet" href="../css/chrome.css">
	<link rel="stylesheet" href="../css/print.css" media="print">

	<!-- Fonts -->
	<link rel="stylesheet" href="../FontAwesome/css/font-awesome.css">
	<link rel="stylesheet" href="../fonts/fonts.css">

	<!-- Highlight.js Stylesheets -->
	<link rel="stylesheet" id="highlight-css" href="../highlight.css">
	<link rel="stylesheet" id="tomorrow-night-css" href="../tomorrow-night.css">
	<link rel="stylesheet" id="ayu-highlight-css" href="../ayu-highlight.css">

	<!-- Custom theme stylesheets -->


	<!-- Provide site root and default themes to javascript -->
	<script>
	const path_to_root = "../";
	const default_light_theme = "light";
	const default_dark_theme = "navy";
	</script>
	<!-- Start loading toc.js asap -->
	<script src="../toc.js"></script>
	</head>
	<body>
	<div id="body-container">
	<!-- Work around some values being stored in localStorage wrapped in quotes -->
	<script>
	try {
	let theme = localStorage.getItem('mdbook-theme');
	let sidebar = localStorage.getItem('mdbook-sidebar');

	if (theme.startsWith('"') && theme.endsWith('"')) {
	localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
	}

	if (sidebar.startsWith('"') && sidebar.endsWith('"')) {
	localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
	}
	} catch (e) { }
	</script>

	<!-- Set the theme before any content is loaded, prevents flash -->
	<script>
	const default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? default_dark_theme : default_light_theme;
	let theme;
	try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
	if (theme === null \|\| theme === undefined) { theme = default_theme; }
	const html = document.documentElement;
	html.classList.remove('light')
	html.classList.add(theme);
	html.classList.add("js");
	</script>

	<input type="checkbox" id="sidebar-toggle-anchor" class="hidden">

	<!-- Hide / unhide sidebar before it is displayed -->
	<script>
	let sidebar = null;
	const sidebar_toggle = document.getElementById("sidebar-toggle-anchor");
	if (document.body.clientWidth >= 1080) {
	try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
	sidebar = sidebar \|\| 'visible';
	} else {
	sidebar = 'hidden';
	}
	sidebar_toggle.checked = sidebar === 'visible';
	html.classList.remove('sidebar-visible');
	html.classList.add("sidebar-" + sidebar);
	</script>

	<nav id="sidebar" class="sidebar" aria-label="Table of contents">
	<!-- populated by js -->
	<mdbook-sidebar-scrollbox class="sidebar-scrollbox"></mdbook-sidebar-scrollbox>
	<noscript>
	<iframe class="sidebar-iframe-outer" src="../toc.html"></iframe>
	</noscript>
	<div id="sidebar-resize-handle" class="sidebar-resize-handle">
	<div class="sidebar-resize-indicator"></div>
	</div>
	</nav>

	<div id="page-wrapper" class="page-wrapper">

	<div class="page">
	<div id="menu-bar-hover-placeholder"></div>
	<div id="menu-bar" class="menu-bar sticky">
	<div class="left-buttons">
	<label id="sidebar-toggle" class="icon-button" for="sidebar-toggle-anchor" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
	<i class="fa fa-bars"></i>
	</label>
	<button id="theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="theme-list">
	<i class="fa fa-paint-brush"></i>
	</button>
	<ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu">
	<li role="none"><button role="menuitem" class="theme" id="default_theme">Auto</button></li>
	<li role="none"><button role="menuitem" class="theme" id="light">Light</button></li>
	<li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li>
	<li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li>
	<li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li>
	<li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li>
	</ul>
	<button id="search-toggle" class="icon-button" type="button" title="Search. (Shortkey: s)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="S" aria-controls="searchbar">
	<i class="fa fa-search"></i>
	</button>
	</div>

	<h1 class="menu-title">Rust Compiler Development Guide</h1>

	<div class="right-buttons">
	<a href="../print.html" title="Print this book" aria-label="Print this book">
	<i id="print-button" class="fa fa-print"></i>
	</a>
	<a href="https://github.com/rust-lang/rustc-dev-guide" title="Git repository" aria-label="Git repository">
	<i id="git-repository-button" class="fa fa-github"></i>
	</a>
	<a href="https://github.com/rust-lang/rustc-dev-guide/edit/master/src/profiling/wpa_profiling.md" title="Suggest an edit" aria-label="Suggest an edit">
	<i id="git-edit-button" class="fa fa-edit"></i>
	</a>

	</div>
	</div>

	<div id="search-wrapper" class="hidden">
	<form id="searchbar-outer" class="searchbar-outer">
	<input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header">
	</form>
	<div id="searchresults-outer" class="searchresults-outer hidden">
	<div id="searchresults-header" class="searchresults-header"></div>
	<ul id="searchresults">
	</ul>
	</div>
	</div>

	<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
	<script>
	document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
	document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
	Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
	link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
	});
	</script>

	<div id="content" class="content">
	<main>
	<h1 id="profiling-on-windows"><a class="header" href="#profiling-on-windows">Profiling on Windows</a></h1>
	<h2 id="introducing-wpr-and-wpa"><a class="header" href="#introducing-wpr-and-wpa">Introducing WPR and WPA</a></h2>
	<p>High-level performance analysis (including memory usage) can be performed with the Windows
	Performance Recorder (WPR) and Windows Performance Analyzer (WPA). As the names suggest, WPR is for
	recording system statistics (in the form of event trace log a.k.a. ETL files), while WPA is for
	analyzing these ETL files.</p>
	<p>WPR collects system wide statistics, so it won't just record things relevant to rustc but also
	everything else that's running on the machine. During analysis, we can filter to just the things we
	find interesting.</p>
	<p>These tools are quite powerful but also require a bit of learning
	before we can successfully profile the Rust compiler.</p>
	<p>Here we will explore how to use WPR and WPA for analyzing the Rust compiler as well as provide
	links to useful "profiles" (i.e., settings files that tweak the defaults for WPR and WPA) that are
	specifically designed to make analyzing rustc easier.</p>
	<h3 id="installing-wpr-and-wpa"><a class="header" href="#installing-wpr-and-wpa">Installing WPR and WPA</a></h3>
	<p>You can install WPR and WPA as part of the Windows Performance Toolkit which itself is an option as
	part of downloading the Windows Assessment and Deployment Kit (ADK). You can download the ADK
	installer <a href="https://go.microsoft.com/fwlink/?linkid=2086042">here</a>. Make sure to select the Windows
	Performance Toolkit (you don't need to select anything else).</p>
	<h2 id="recording"><a class="header" href="#recording">Recording</a></h2>
	<p>In order to perform system analysis, you'll first need to record your system with WPR. Open WPR and
	at the bottom of the window select the "profiles" of the things you want to record. For looking
	into memory usage of the rustc bootstrap process, we'll want to select the following items:</p>
	<ul>
	<li>CPU usage</li>
	<li>VirtualAlloc usage</li>
	</ul>
	<p>You might be tempted to record "Heap usage" as well, but this records every single heap allocation
	and can be very, very expensive. For high-level analysis, it might be best to leave that turned
	off.</p>
	<p>Now we need to get our setup ready to record. For memory usage analysis, it is best to record the
	stage 2 compiler build with a stage 1 compiler build with debug symbols. Having symbols in the
	compiler we're using to build rustc will aid our analysis greatly by allowing WPA to resolve Rust
	symbols correctly. Unfortunately, the stage 0 compiler does not have symbols turned on which is why
	we'll need to build a stage 1 compiler and then a stage 2 compiler ourselves.</p>
	<p>To do this, make sure you have set <code>debuginfo-level = 1</code> in your <code>bootstrap.toml</code> file. This tells
	rustc to generate debug information which includes stack frames when bootstrapping.</p>
	<p>Now you can build the stage 1 compiler: <code>x build --stage 1 -i library</code> or however
	else you want to build the stage 1 compiler.</p>
	<p>Now that the stage 1 compiler is built, we can record the stage 2 build. Go back to WPR, click the
	"start" button and build the stage 2 compiler (e.g., <code>x build --stage=2 -i library</code>).
	When this process finishes, stop the recording.</p>
	<p>Click the Save button and once that process is complete, click the "Open in WPA" button which
	appears.</p>
	<blockquote>
	<p>Note: The trace file is fairly large so it can take WPA some time to finish opening the file.</p>
	</blockquote>
	<h2 id="analysis"><a class="header" href="#analysis">Analysis</a></h2>
	<p>Now that our ETL file is open in WPA, we can analyze the results. First, we'll want to apply the
	pre-made "profile" which will put WPA into a state conducive to analyzing rustc bootstrap. Download
	the profile <a href="https://github.com/wesleywiser/rustc-bootstrap-wpa-analysis/releases/download/1/rustc.generic.wpaProfile">here</a>.
	Select the "Profiles" menu at the top, then "apply" and then choose the downloaded profile.</p>
	<p>You should see something resembling the following:</p>
	<p><img src="../img/wpa-initial-memory.png" alt="WPA with profile applied" /></p>
	<p>Next, we will need to tell WPA to load and process debug symbols so that it can properly demangle
	the Rust stack traces. To do this, click "Trace" and then choose "Load Symbols". This step can take
	a while.</p>
	<p>Once WPA has loaded symbols for rustc, we can expand the rustc.exe node and begin drilling down
	into the stack with the largest allocations.</p>
	<p>To do that, we'll expand the <code>[Root]</code> node in the "Commit Stack" column and continue expanding
	until we find interesting stack frames.</p>
	<blockquote>
	<p>Tip: After selecting the node you want to expand, press the right arrow key. This will expand the
	node and put the selection on the next largest node in the expanded set. You can continue pressing
	the right arrow key until you reach an interesting frame.</p>
	</blockquote>
	<p><img src="../img/wpa-stack.png" alt="WPA with expanded stack" /></p>
	<p>In this sample, you can see calls through codegen are allocating ~30gb of memory in total
	throughout this profile.</p>
	<h2 id="other-analysis-tabs"><a class="header" href="#other-analysis-tabs">Other Analysis Tabs</a></h2>
	<p>The profile also includes a few other tabs which can be helpful:</p>
	<ul>
	<li>System Configuration
	<ul>
	<li>General information about the system the capture was recorded on.</li>
	</ul>
	</li>
	<li>rustc Build Processes
	<ul>
	<li>A flat list of relevant processes such as rustc.exe, cargo.exe, link.exe etc.</li>
	<li>Each process lists its command line arguments.</li>
	<li>Useful for figuring out what a specific rustc process was working on.</li>
	</ul>
	</li>
	<li>rustc Build Process Tree
	<ul>
	<li>Timeline showing when processes started and exited.</li>
	</ul>
	</li>
	<li>rustc CPU Analysis
	<ul>
	<li>Contains charts preconfigured to show hotspots in rustc.</li>
	<li>These charts are designed to support analyzing where rustc is spending its time.</li>
	</ul>
	</li>
	<li>rustc Memory Analysis
	<ul>
	<li>Contains charts preconfigured to show where rustc is allocating memory.</li>
	</ul>
	</li>
	</ul>

	</main>

	<nav class="nav-wrapper" aria-label="Page navigation">
	<!-- Mobile navigation buttons -->
	<a rel="prev" href="../profiling/with_perf.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
	<i class="fa fa-angle-left"></i>
	</a>

	<a rel="next prefetch" href="../profiling/with_rustc_perf.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
	<i class="fa fa-angle-right"></i>
	</a>

	<div style="clear: both"></div>
	</nav>
	</div>
	</div>

	<nav class="nav-wide-wrapper" aria-label="Page navigation">
	<a rel="prev" href="../profiling/with_perf.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
	<i class="fa fa-angle-left"></i>
	</a>

	<a rel="next prefetch" href="../profiling/with_rustc_perf.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
	<i class="fa fa-angle-right"></i>
	</a>
	</nav>

	</div>




	<script>
	window.playground_copyable = true;
	</script>


	<script src="../elasticlunr.min.js"></script>
	<script src="../mark.min.js"></script>
	<script src="../searcher.js"></script>

	<script src="../clipboard.min.js"></script>
	<script src="../highlight.js"></script>
	<script src="../book.js"></script>

	<!-- Custom JS scripts -->
	<script src="../mermaid.min.js"></script>
	<script src="../mermaid-init.js"></script>


	</div>
	</body>
	</html>