{"id":5317,"date":"2021-02-23T16:01:01","date_gmt":"2021-02-24T00:01:01","guid":{"rendered":"https:\/\/devblogs.microsoft.com\/pix\/?p=5317"},"modified":"2021-02-24T17:35:12","modified_gmt":"2021-02-25T01:35:12","slug":"memory-leak-detection-features-in-timing-captures","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/pix\/memory-leak-detection-features-in-timing-captures\/","title":{"rendered":"Finding memory leaks using Timing Captures"},"content":{"rendered":"

PIX Timing Captures<\/a> include several analysis features aimed at making it easy to find memory leaks in your title.\u00a0 These features, coupled with the ability to take captures for extended periods of time, are a compelling combination for finding leaks, even those that\u00a0can take a considerable amount of time to manifest themselves.<\/span><\/p>\n

To enable the leak tracking features, select one or both of the memory tracking options when starting a Timing Capture.<\/p>\n

\"Image<\/a><\/p>\n

The easiest way to visualize the amount of memory in use over the duration of the capture is to use the Metrics View.\u00a0 The Memory Usage<\/strong> counters under the Derived System Metrics\/CPU Memory<\/strong> node in the Selector<\/strong> panel can be used to view the amount of memory in use due to calls to HeapAlloc and VirtualAlloc.<\/p>\n

\"Image<\/a><\/p>\n

The following picture shows a graph of the amount of memory allocated by VirtualAlloc.\u00a0 The amount of memory allocated is clearly growing over time.\u00a0 There are periods of time in which usage is flat, following by periods of time where memory usage grows and doesn’t appear to be freed by the end of the capture.\u00a0 The periods of memory growth may indicate a leak.<\/p>\n

\"Image<\/a><\/p>\n

To determine if that’s the case, select a range of time in the Metrics view that corresponds to one or more periods of memory growth.\u00a0 We’ll then use the Range Details<\/strong> view to analyze an Allocation Stack Tree<\/strong> for the selected period of time.<\/p>\n

To make the analysis easier, I’ve created a custom layout that adds a Range Details<\/strong> view to the predefined Metrics View layout.\u00a0 I’ve also used the Display Options<\/strong> panel in Range Details<\/strong> to set the Time Range<\/strong> dropdown to Sync with Metric View’s Selected Range<\/strong>.\u00a0 Note that creating this custom layout isn’t required for analyzing memory leaks, I’ve just set it up this was as a convenience.\u00a0 The Range Details<\/strong> view in the standard Timeline<\/strong> layout can be used as well.<\/p>\n

Here’s my custom layout, with an area of growth selected in the graph and the Range Details<\/strong> viewing showing the Allocation Stack Tree<\/strong>.<\/p>\n

\"Image<\/a><\/p>\n

The allocations in the stack tree are grouped by allocator.\u00a0 The tree has two root nodes: one for those allocations that came from calls to VirtualAlloc and one for those that came from calls to HeapAlloc.\u00a0 Given that we know our leak is coming from virtual memory allocations,\u00a0 we’ll start expanding the tree and monitoring the values in the Unfreed<\/strong> Size<\/strong> column to find allocations that weren’t freed.<\/p>\n

The following Range Details<\/strong> view shows a function in my title, named ResizeBuffer, that is leaking 560MB of VirtualAlloc’d memory.\u00a0 Furthermore, I can see there are two call paths into ResizeBuffer, one callpath comes from a function named Process and another callpath comes from a function named UpdateEnemyPositions.\u00a0 The Unfreed Size<\/strong> column shows that all of the leaked memory is coming from the call to ResizeBuffer that comes from Process.<\/p>\n

\"Image<\/a><\/p>\n

Drilling into the stack and using the Unfreed Size<\/strong> column is one way to find leaks, but given that the memory leak scenario is such a common workflow, PIX includes a shortcut to make this even easier. To find the call tree(s) in your title that are causing leaks, simply use the !Freed<\/strong> button at the top of the Range Details<\/strong> view.<\/p>\n

\"Image<\/a><\/p>\n

Easy!<\/p>\n

Steven Pratschner<\/p>\n

PIX Program Manager<\/p>\n","protected":false},"excerpt":{"rendered":"

PIX Timing Captures include several analysis features aimed at making it easy to find memory leaks in your title.\u00a0 These features, coupled with the ability to take captures for extended periods of time, are a compelling combination for finding leaks, even those that\u00a0can take a considerable amount of time to manifest themselves. To enable the […]<\/p>\n","protected":false},"author":1915,"featured_media":4769,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[1],"tags":[],"class_list":["post-5317","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-pix"],"acf":[],"blog_post_summary":"

PIX Timing Captures include several analysis features aimed at making it easy to find memory leaks in your title.\u00a0 These features, coupled with the ability to take captures for extended periods of time, are a compelling combination for finding leaks, even those that\u00a0can take a considerable amount of time to manifest themselves. To enable the […]<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/pix\/wp-json\/wp\/v2\/posts\/5317","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/devblogs.microsoft.com\/pix\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/devblogs.microsoft.com\/pix\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/pix\/wp-json\/wp\/v2\/users\/1915"}],"replies":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/pix\/wp-json\/wp\/v2\/comments?post=5317"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/pix\/wp-json\/wp\/v2\/posts\/5317\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/pix\/wp-json\/wp\/v2\/media\/4769"}],"wp:attachment":[{"href":"https:\/\/devblogs.microsoft.com\/pix\/wp-json\/wp\/v2\/media?parent=5317"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/pix\/wp-json\/wp\/v2\/categories?post=5317"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/pix\/wp-json\/wp\/v2\/tags?post=5317"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}