This is an automated email from the ASF dual-hosted git repository.
github-bot pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/datafusion.git
The following commit(s) were added to refs/heads/asf-site by this push:
new b824afc630 Publish built docs triggered by
21e35eeb4e106835cc059205315d94ad0201a921
b824afc630 is described below
commit b824afc630715e0395c1791bfd45e5e11a233d84
Author: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
AuthorDate: Wed Sep 18 15:32:40 2024 +0000
Publish built docs triggered by 21e35eeb4e106835cc059205315d94ad0201a921
---
_images/flamegraph.svg | 491 +++++++++++++++++++++++++++
_sources/library-user-guide/profiling.md.txt | 42 ++-
_static/images/flamegraph.svg | 491 +++++++++++++++++++++++++++
library-user-guide/profiling.html | 38 ++-
searchindex.js | 2 +-
5 files changed, 1029 insertions(+), 35 deletions(-)
diff --git a/_images/flamegraph.svg b/_images/flamegraph.svg
new file mode 100644
index 0000000000..951cbb1ff3
--- /dev/null
+++ b/_images/flamegraph.svg
@@ -0,0 +1,491 @@
+<?xml version="1.0" standalone="no"?><!DOCTYPE svg PUBLIC "-//W3C//DTD SVG
1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd";><svg version="1.1"
width="1200" height="694" onload="init(evt)" viewBox="0 0 1200 694"
xmlns="http://www.w3.org/2000/svg"; xmlns:xlink="http://www.w3.org/1999/xlink";
xmlns:fg="http://github.com/jonhoo/inferno";><!--Flame graph stack
visualization. See https://github.com/brendangregg/FlameGraph for latest
version, and http://www.brendangregg.com/flamegraphs. [...]
+text { font-family:monospace; font-size:12px }
+#title { text-anchor:middle; font-size:17px; }
+#matched { text-anchor:end; }
+#search { text-anchor:end; opacity:0.1; cursor:pointer; }
+#search:hover, #search.show { opacity:1; }
+#subtitle { text-anchor:middle; font-color:rgb(160,160,160); }
+#unzoom { cursor:pointer; }
+#frames > *:hover { stroke:black; stroke-width:0.5; cursor:pointer; }
+.hide { display:none; }
+.parent { opacity:0.5; }
+</style><script type="text/ecmascript"><![CDATA[
+ var nametype = 'Function:';
+ var fontsize = 12;
+ var fontwidth = 0.59;
+ var xpad = 10;
+ var inverted = false;
+ var searchcolor = 'rgb(230,0,230)';
+ var fluiddrawing = true;
+ var truncate_text_right = false;
+ ]]><![CDATA["use strict";
+var details, searchbtn, unzoombtn, matchedtxt, svg, searching, frames,
known_font_width;
+function init(evt) {
+ details = document.getElementById("details").firstChild;
+ searchbtn = document.getElementById("search");
+ unzoombtn = document.getElementById("unzoom");
+ matchedtxt = document.getElementById("matched");
+ svg = document.getElementsByTagName("svg")[0];
+ frames = document.getElementById("frames");
+ known_font_width = get_monospace_width(frames);
+ total_samples = parseInt(frames.attributes.total_samples.value);
+ searching = 0;
+
+ // Use GET parameters to restore a flamegraph's state.
+ var restore_state = function() {
+ var params = get_params();
+ if (params.x && params.y)
+ zoom(find_group(document.querySelector('[*|x="' + params.x +
'"][y="' + params.y + '"]')));
+ if (params.s)
+ search(params.s);
+ };
+
+ if (fluiddrawing) {
+ // Make width dynamic so the SVG fits its parent's width.
+ svg.removeAttribute("width");
+ // Edge requires us to have a viewBox that gets updated with size
changes.
+ var isEdge = /Edge\/\d./i.test(navigator.userAgent);
+ if (!isEdge) {
+ svg.removeAttribute("viewBox");
+ }
+ var update_for_width_change = function() {
+ if (isEdge) {
+ svg.attributes.viewBox.value = "0 0 " +
svg.width.baseVal.value + " " + svg.height.baseVal.value;
+ }
+
+ // Keep consistent padding on left and right of frames container.
+ frames.attributes.width.value = svg.width.baseVal.value - xpad * 2;
+
+ // Text truncation needs to be adjusted for the current width.
+ update_text_for_elements(frames.children);
+
+ // Keep search elements at a fixed distance from right edge.
+ var svgWidth = svg.width.baseVal.value;
+ searchbtn.attributes.x.value = svgWidth - xpad;
+ matchedtxt.attributes.x.value = svgWidth - xpad;
+ };
+ window.addEventListener('resize', function() {
+ update_for_width_change();
+ });
+ // This needs to be done asynchronously for Safari to work.
+ setTimeout(function() {
+ unzoom();
+ update_for_width_change();
+ restore_state();
+ }, 0);
+ } else {
+ restore_state();
+ }
+}
+// event listeners
+window.addEventListener("click", function(e) {
+ var target = find_group(e.target);
+ if (target) {
+ if (target.nodeName == "a") {
+ if (e.ctrlKey === false) return;
+ e.preventDefault();
+ }
+ if (target.classList.contains("parent")) unzoom();
+ zoom(target);
+
+ // set parameters for zoom state
+ var el = target.querySelector("rect");
+ if (el && el.attributes && el.attributes.y && el.attributes["fg:x"]) {
+ var params = get_params()
+ params.x = el.attributes["fg:x"].value;
+ params.y = el.attributes.y.value;
+ history.replaceState(null, null, parse_params(params));
+ }
+ }
+ else if (e.target.id == "unzoom") {
+ unzoom();
+
+ // remove zoom state
+ var params = get_params();
+ if (params.x) delete params.x;
+ if (params.y) delete params.y;
+ history.replaceState(null, null, parse_params(params));
+ }
+ else if (e.target.id == "search") search_prompt();
+}, false)
+// mouse-over for info
+// show
+window.addEventListener("mouseover", function(e) {
+ var target = find_group(e.target);
+ if (target) details.nodeValue = nametype + " " + g_to_text(target);
+}, false)
+// clear
+window.addEventListener("mouseout", function(e) {
+ var target = find_group(e.target);
+ if (target) details.nodeValue = ' ';
+}, false)
+// ctrl-F for search
+window.addEventListener("keydown",function (e) {
+ if (e.keyCode === 114 || (e.ctrlKey && e.keyCode === 70)) {
+ e.preventDefault();
+ search_prompt();
+ }
+}, false)
+// functions
+function get_params() {
+ var params = {};
+ var paramsarr = window.location.search.substr(1).split('&');
+ for (var i = 0; i < paramsarr.length; ++i) {
+ var tmp = paramsarr[i].split("=");
+ if (!tmp[0] || !tmp[1]) continue;
+ params[tmp[0]] = decodeURIComponent(tmp[1]);
+ }
+ return params;
+}
+function parse_params(params) {
+ var uri = "?";
+ for (var key in params) {
+ uri += key + '=' + encodeURIComponent(params[key]) + '&';
+ }
+ if (uri.slice(-1) == "&")
+ uri = uri.substring(0, uri.length - 1);
+ if (uri == '?')
+ uri = window.location.href.split('?')[0];
+ return uri;
+}
+function find_child(node, selector) {
+ var children = node.querySelectorAll(selector);
+ if (children.length) return children[0];
+ return;
+}
+function find_group(node) {
+ var parent = node.parentElement;
+ if (!parent) return;
+ if (parent.id == "frames") return node;
+ return find_group(parent);
+}
+function orig_save(e, attr, val) {
+ if (e.attributes["fg:orig_" + attr] != undefined) return;
+ if (e.attributes[attr] == undefined) return;
+ if (val == undefined) val = e.attributes[attr].value;
+ e.setAttribute("fg:orig_" + attr, val);
+}
+function orig_load(e, attr) {
+ if (e.attributes["fg:orig_"+attr] == undefined) return;
+ e.attributes[attr].value = e.attributes["fg:orig_" + attr].value;
+ e.removeAttribute("fg:orig_" + attr);
+}
+function g_to_text(e) {
+ var text = find_child(e, "title").firstChild.nodeValue;
+ return (text)
+}
+function g_to_func(e) {
+ var func = g_to_text(e);
+ // if there's any manipulation we want to do to the function
+ // name before it's searched, do it here before returning.
+ return (func);
+}
+function get_monospace_width(frames) {
+ // Given the id="frames" element, return the width of text characters if
+ // this is a monospace font, otherwise return 0.
+ text = find_child(frames.children[0], "text");
+ originalContent = text.textContent;
+ text.textContent = "!";
+ bangWidth = text.getComputedTextLength();
+ text.textContent = "W";
+ wWidth = text.getComputedTextLength();
+ text.textContent = originalContent;
+ if (bangWidth === wWidth) {
+ return bangWidth;
+ } else {
+ return 0;
+ }
+}
+function update_text_for_elements(elements) {
+ // In order to render quickly in the browser, you want to do one pass of
+ // reading attributes, and one pass of mutating attributes. See
+ // https://web.dev/avoid-large-complex-layouts-and-layout-thrashing/ for
details.
+
+ // Fall back to inefficient calculation, if we're variable-width font.
+ // TODO This should be optimized somehow too.
+ if (known_font_width === 0) {
+ for (var i = 0; i < elements.length; i++) {
+ update_text(elements[i]);
+ }
+ return;
+ }
+
+ var textElemNewAttributes = [];
+ for (var i = 0; i < elements.length; i++) {
+ var e = elements[i];
+ var r = find_child(e, "rect");
+ var t = find_child(e, "text");
+ var w = parseFloat(r.attributes.width.value) *
frames.attributes.width.value / 100 - 3;
+ var txt = find_child(e, "title").textContent.replace(/\([^(]*\)$/,"");
+ var newX = format_percent((parseFloat(r.attributes.x.value) + (100 * 3
/ frames.attributes.width.value)));
+
+ // Smaller than this size won't fit anything
+ if (w < 2 * known_font_width) {
+ textElemNewAttributes.push([newX, ""]);
+ continue;
+ }
+
+ // Fit in full text width
+ if (txt.length * known_font_width < w) {
+ textElemNewAttributes.push([newX, txt]);
+ continue;
+ }
+
+ var substringLength = Math.floor(w / known_font_width) - 2;
+ if (truncate_text_right) {
+ // Truncate the right side of the text.
+ textElemNewAttributes.push([newX, txt.substring(0,
substringLength) + ".."]);
+ continue;
+ } else {
+ // Truncate the left side of the text.
+ textElemNewAttributes.push([newX, ".." + txt.substring(txt.length
- substringLength, txt.length)]);
+ continue;
+ }
+ }
+
+ console.assert(textElemNewAttributes.length === elements.length, "Resize
failed, please file a bug at https://github.com/jonhoo/inferno/";);
+
+ // Now that we know new textContent, set it all in one go so we don't
refresh a bazillion times.
+ for (var i = 0; i < elements.length; i++) {
+ var e = elements[i];
+ var values = textElemNewAttributes[i];
+ var t = find_child(e, "text");
+ t.attributes.x.value = values[0];
+ t.textContent = values[1];
+ }
+}
+
+function update_text(e) {
+ var r = find_child(e, "rect");
+ var t = find_child(e, "text");
+ var w = parseFloat(r.attributes.width.value) *
frames.attributes.width.value / 100 - 3;
+ var txt = find_child(e, "title").textContent.replace(/\([^(]*\)$/,"");
+ t.attributes.x.value = format_percent((parseFloat(r.attributes.x.value) +
(100 * 3 / frames.attributes.width.value)));
+
+ // Smaller than this size won't fit anything
+ if (w < 2 * fontsize * fontwidth) {
+ t.textContent = "";
+ return;
+ }
+ t.textContent = txt;
+ // Fit in full text width
+ if (t.getComputedTextLength() < w)
+ return;
+ if (truncate_text_right) {
+ // Truncate the right side of the text.
+ for (var x = txt.length - 2; x > 0; x--) {
+ if (t.getSubStringLength(0, x + 2) <= w) {
+ t.textContent = txt.substring(0, x) + "..";
+ return;
+ }
+ }
+ } else {
+ // Truncate the left side of the text.
+ for (var x = 2; x < txt.length; x++) {
+ if (t.getSubStringLength(x - 2, txt.length) <= w) {
+ t.textContent = ".." + txt.substring(x, txt.length);
+ return;
+ }
+ }
+ }
+ t.textContent = "";
+}
+// zoom
+function zoom_reset(e) {
+ if (e.tagName == "rect") {
+ e.attributes.x.value = format_percent(100 *
parseInt(e.attributes["fg:x"].value) / total_samples);
+ e.attributes.width.value = format_percent(100 *
parseInt(e.attributes["fg:w"].value) / total_samples);
+ }
+ if (e.childNodes == undefined) return;
+ for(var i = 0, c = e.childNodes; i < c.length; i++) {
+ zoom_reset(c[i]);
+ }
+}
+function zoom_child(e, x, zoomed_width_samples) {
+ if (e.tagName == "text") {
+ var parent_x = parseFloat(find_child(e.parentNode,
"rect[x]").attributes.x.value);
+ e.attributes.x.value = format_percent(parent_x + (100 * 3 /
frames.attributes.width.value));
+ } else if (e.tagName == "rect") {
+ e.attributes.x.value = format_percent(100 *
(parseInt(e.attributes["fg:x"].value) - x) / zoomed_width_samples);
+ e.attributes.width.value = format_percent(100 *
parseInt(e.attributes["fg:w"].value) / zoomed_width_samples);
+ }
+ if (e.childNodes == undefined) return;
+ for(var i = 0, c = e.childNodes; i < c.length; i++) {
+ zoom_child(c[i], x, zoomed_width_samples);
+ }
+}
+function zoom_parent(e) {
+ if (e.attributes) {
+ if (e.attributes.x != undefined) {
+ e.attributes.x.value = "0.0%";
+ }
+ if (e.attributes.width != undefined) {
+ e.attributes.width.value = "100.0%";
+ }
+ }
+ if (e.childNodes == undefined) return;
+ for(var i = 0, c = e.childNodes; i < c.length; i++) {
+ zoom_parent(c[i]);
+ }
+}
+function zoom(node) {
+ var attr = find_child(node, "rect").attributes;
+ var width = parseInt(attr["fg:w"].value);
+ var xmin = parseInt(attr["fg:x"].value);
+ var xmax = xmin + width;
+ var ymin = parseFloat(attr.y.value);
+ unzoombtn.classList.remove("hide");
+ var el = frames.children;
+ var to_update_text = [];
+ for (var i = 0; i < el.length; i++) {
+ var e = el[i];
+ var a = find_child(e, "rect").attributes;
+ var ex = parseInt(a["fg:x"].value);
+ var ew = parseInt(a["fg:w"].value);
+ // Is it an ancestor
+ if (!inverted) {
+ var upstack = parseFloat(a.y.value) > ymin;
+ } else {
+ var upstack = parseFloat(a.y.value) < ymin;
+ }
+ if (upstack) {
+ // Direct ancestor
+ if (ex <= xmin && (ex+ew) >= xmax) {
+ e.classList.add("parent");
+ zoom_parent(e);
+ to_update_text.push(e);
+ }
+ // not in current path
+ else
+ e.classList.add("hide");
+ }
+ // Children maybe
+ else {
+ // no common path
+ if (ex < xmin || ex >= xmax) {
+ e.classList.add("hide");
+ }
+ else {
+ zoom_child(e, xmin, width);
+ to_update_text.push(e);
+ }
+ }
+ }
+ update_text_for_elements(to_update_text);
+}
+function unzoom() {
+ unzoombtn.classList.add("hide");
+ var el = frames.children;
+ for(var i = 0; i < el.length; i++) {
+ el[i].classList.remove("parent");
+ el[i].classList.remove("hide");
+ zoom_reset(el[i]);
+ }
+ update_text_for_elements(el);
+}
+// search
+function reset_search() {
+ var el = document.querySelectorAll("#frames rect");
+ for (var i = 0; i < el.length; i++) {
+ orig_load(el[i], "fill")
+ }
+ var params = get_params();
+ delete params.s;
+ history.replaceState(null, null, parse_params(params));
+}
+function search_prompt() {
+ if (!searching) {
+ var term = prompt("Enter a search term (regexp " +
+ "allowed, eg: ^ext4_)", "");
+ if (term != null) {
+ search(term)
+ }
+ } else {
+ reset_search();
+ searching = 0;
+ searchbtn.classList.remove("show");
+ searchbtn.firstChild.nodeValue = "Search"
+ matchedtxt.classList.add("hide");
+ matchedtxt.firstChild.nodeValue = ""
+ }
+}
+function search(term) {
+ var re = new RegExp(term);
+ var el = frames.children;
+ var matches = new Object();
+ var maxwidth = 0;
+ for (var i = 0; i < el.length; i++) {
+ var e = el[i];
+ // Skip over frames which are either not visible, or below the
zoomed-to frame
+ if (e.classList.contains("hide") || e.classList.contains("parent")) {
+ continue;
+ }
+ var func = g_to_func(e);
+ var rect = find_child(e, "rect");
+ if (func == null || rect == null)
+ continue;
+ // Save max width. Only works as we have a root frame
+ var w = parseInt(rect.attributes["fg:w"].value);
+ if (w > maxwidth)
+ maxwidth = w;
+ if (func.match(re)) {
+ // highlight
+ var x = parseInt(rect.attributes["fg:x"].value);
+ orig_save(rect, "fill");
+ rect.attributes.fill.value = searchcolor;
+ // remember matches
+ if (matches[x] == undefined) {
+ matches[x] = w;
+ } else {
+ if (w > matches[x]) {
+ // overwrite with parent
+ matches[x] = w;
+ }
+ }
+ searching = 1;
+ }
+ }
+ if (!searching)
+ return;
+ var params = get_params();
+ params.s = term;
+ history.replaceState(null, null, parse_params(params));
+
+ searchbtn.classList.add("show");
+ searchbtn.firstChild.nodeValue = "Reset Search";
+ // calculate percent matched, excluding vertical overlap
+ var count = 0;
+ var lastx = -1;
+ var lastw = 0;
+ var keys = Array();
+ for (k in matches) {
+ if (matches.hasOwnProperty(k))
+ keys.push(k);
+ }
+ // sort the matched frames by their x location
+ // ascending, then width descending
+ keys.sort(function(a, b){
+ return a - b;
+ });
+ // Step through frames saving only the biggest bottom-up frames
+ // thanks to the sort order. This relies on the tree property
+ // where children are always smaller than their parents.
+ for (var k in keys) {
+ var x = parseInt(keys[k]);
+ var w = matches[keys[k]];
+ if (x >= lastx + lastw) {
+ count += w;
+ lastx = x;
+ lastw = w;
+ }
+ }
+ // display matched percent
+ matchedtxt.classList.remove("hide");
+ var pct = 100 * count / maxwidth;
+ if (pct != 100) pct = pct.toFixed(1);
+ matchedtxt.firstChild.nodeValue = "Matched: " + pct + "%";
+}
+function format_percent(n) {
+ return n.toFixed(4) + "%";
+}
+]]></script><rect x="0" y="0" width="100%" height="694"
fill="url(#background)"/><text id="title" fill="rgb(0,0,0)" x="50.0000%"
y="24.00">Flame Graph</text><text id="details" fill="rgb(0,0,0)" x="10"
y="677.00"> </text><text id="unzoom" class="hide" fill="rgb(0,0,0)" x="10"
y="24.00">Reset Zoom</text><text id="search" fill="rgb(0,0,0)" x="1190"
y="24.00">Search</text><text id="matched" fill="rgb(0,0,0)" x="1190"
y="677.00"> </text><svg id="frames" x="10" width="1180" total_samples="8514
[...]
\ No newline at end of file
diff --git a/_sources/library-user-guide/profiling.md.txt
b/_sources/library-user-guide/profiling.md.txt
index c8afe15f25..75f2394a22 100644
--- a/_sources/library-user-guide/profiling.md.txt
+++ b/_sources/library-user-guide/profiling.md.txt
@@ -25,34 +25,44 @@ The section contains examples how to perform CPU profiling
for Apache DataFusion
### Building a flamegraph
-- [cargo-flamegraph](https://github.com/flamegraph-rs/flamegraph)
+[Video: how to CPU profile DataFusion with a
Flamegraph](https://youtu.be/2z11xtYw_xs)
-Test:
+A flamegraph is a visual representation of which functions are being run
+You can create flamegraphs in many ways; The instructions below are for
+[cargo-flamegraph](https://github.com/flamegraph-rs/flamegraph) which results
+in images such as this:
-```bash
-CARGO_PROFILE_RELEASE_DEBUG=true cargo flamegraph --root --unit-test
datafusion -- dataframe::tests::test_array_agg
+
+
+To create a flamegraph, you need to install the `flamegraph` tool:
+
+```shell
+cargo install flamegraph
```
-Benchmark:
+Then you can run the flamegraph tool with the `--` separator to pass arguments
+to the binary you want to profile.
-```bash
-CARGO_PROFILE_RELEASE_DEBUG=true cargo flamegraph --root --bench sql_planner
-- --bench
+Example: Flamegraph for `datafusion-cli` executing `q28.sql`. Note this
+must be run as root on Mac OSx to access DTrace.
+
+```shell
+sudo flamegraph -- datafusion-cli -f q28.sq
```
-Open `flamegraph.svg` file with the browser
+You can also invoke the flamegraph tool with `cargo` to profile a specific
test or benchmark.
-- dtrace with DataFusion CLI
+Example: Flamegraph for a specific test:
```bash
-git clone https://github.com/brendangregg/FlameGraph.git /tmp/fg
-cd datafusion-cli
-CARGO_PROFILE_RELEASE_DEBUG=true cargo build --release
-echo "select * from table;" >> test.sql
-sudo dtrace -c './target/debug/datafusion-cli -f test.sql' -o out.stacks -n
'profile-997 /execname == "datafusion-cli"/ { @[ustack(100)] = count(); }'
-/tmp/fg/FlameGraph/stackcollapse.pl out.stacks |
/tmp/fg/FlameGraph/flamegraph.pl > flamegraph.svg
+CARGO_PROFILE_RELEASE_DEBUG=true cargo flamegraph --root --unit-test
datafusion -- dataframe::tests::test_array_agg
```
-Open `flamegraph.svg` file with the browser
+Example: Flamegraph for a benchmark
+
+```bash
+CARGO_PROFILE_RELEASE_DEBUG=true cargo flamegraph --root --bench sql_planner
-- --bench
+```
### CPU profiling with XCode Instruments
diff --git a/_static/images/flamegraph.svg b/_static/images/flamegraph.svg
new file mode 100644
index 0000000000..951cbb1ff3
--- /dev/null
+++ b/_static/images/flamegraph.svg
@@ -0,0 +1,491 @@
+<?xml version="1.0" standalone="no"?><!DOCTYPE svg PUBLIC "-//W3C//DTD SVG
1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd";><svg version="1.1"
width="1200" height="694" onload="init(evt)" viewBox="0 0 1200 694"
xmlns="http://www.w3.org/2000/svg"; xmlns:xlink="http://www.w3.org/1999/xlink";
xmlns:fg="http://github.com/jonhoo/inferno";><!--Flame graph stack
visualization. See https://github.com/brendangregg/FlameGraph for latest
version, and http://www.brendangregg.com/flamegraphs. [...]
+text { font-family:monospace; font-size:12px }
+#title { text-anchor:middle; font-size:17px; }
+#matched { text-anchor:end; }
+#search { text-anchor:end; opacity:0.1; cursor:pointer; }
+#search:hover, #search.show { opacity:1; }
+#subtitle { text-anchor:middle; font-color:rgb(160,160,160); }
+#unzoom { cursor:pointer; }
+#frames > *:hover { stroke:black; stroke-width:0.5; cursor:pointer; }
+.hide { display:none; }
+.parent { opacity:0.5; }
+</style><script type="text/ecmascript"><![CDATA[
+ var nametype = 'Function:';
+ var fontsize = 12;
+ var fontwidth = 0.59;
+ var xpad = 10;
+ var inverted = false;
+ var searchcolor = 'rgb(230,0,230)';
+ var fluiddrawing = true;
+ var truncate_text_right = false;
+ ]]><![CDATA["use strict";
+var details, searchbtn, unzoombtn, matchedtxt, svg, searching, frames,
known_font_width;
+function init(evt) {
+ details = document.getElementById("details").firstChild;
+ searchbtn = document.getElementById("search");
+ unzoombtn = document.getElementById("unzoom");
+ matchedtxt = document.getElementById("matched");
+ svg = document.getElementsByTagName("svg")[0];
+ frames = document.getElementById("frames");
+ known_font_width = get_monospace_width(frames);
+ total_samples = parseInt(frames.attributes.total_samples.value);
+ searching = 0;
+
+ // Use GET parameters to restore a flamegraph's state.
+ var restore_state = function() {
+ var params = get_params();
+ if (params.x && params.y)
+ zoom(find_group(document.querySelector('[*|x="' + params.x +
'"][y="' + params.y + '"]')));
+ if (params.s)
+ search(params.s);
+ };
+
+ if (fluiddrawing) {
+ // Make width dynamic so the SVG fits its parent's width.
+ svg.removeAttribute("width");
+ // Edge requires us to have a viewBox that gets updated with size
changes.
+ var isEdge = /Edge\/\d./i.test(navigator.userAgent);
+ if (!isEdge) {
+ svg.removeAttribute("viewBox");
+ }
+ var update_for_width_change = function() {
+ if (isEdge) {
+ svg.attributes.viewBox.value = "0 0 " +
svg.width.baseVal.value + " " + svg.height.baseVal.value;
+ }
+
+ // Keep consistent padding on left and right of frames container.
+ frames.attributes.width.value = svg.width.baseVal.value - xpad * 2;
+
+ // Text truncation needs to be adjusted for the current width.
+ update_text_for_elements(frames.children);
+
+ // Keep search elements at a fixed distance from right edge.
+ var svgWidth = svg.width.baseVal.value;
+ searchbtn.attributes.x.value = svgWidth - xpad;
+ matchedtxt.attributes.x.value = svgWidth - xpad;
+ };
+ window.addEventListener('resize', function() {
+ update_for_width_change();
+ });
+ // This needs to be done asynchronously for Safari to work.
+ setTimeout(function() {
+ unzoom();
+ update_for_width_change();
+ restore_state();
+ }, 0);
+ } else {
+ restore_state();
+ }
+}
+// event listeners
+window.addEventListener("click", function(e) {
+ var target = find_group(e.target);
+ if (target) {
+ if (target.nodeName == "a") {
+ if (e.ctrlKey === false) return;
+ e.preventDefault();
+ }
+ if (target.classList.contains("parent")) unzoom();
+ zoom(target);
+
+ // set parameters for zoom state
+ var el = target.querySelector("rect");
+ if (el && el.attributes && el.attributes.y && el.attributes["fg:x"]) {
+ var params = get_params()
+ params.x = el.attributes["fg:x"].value;
+ params.y = el.attributes.y.value;
+ history.replaceState(null, null, parse_params(params));
+ }
+ }
+ else if (e.target.id == "unzoom") {
+ unzoom();
+
+ // remove zoom state
+ var params = get_params();
+ if (params.x) delete params.x;
+ if (params.y) delete params.y;
+ history.replaceState(null, null, parse_params(params));
+ }
+ else if (e.target.id == "search") search_prompt();
+}, false)
+// mouse-over for info
+// show
+window.addEventListener("mouseover", function(e) {
+ var target = find_group(e.target);
+ if (target) details.nodeValue = nametype + " " + g_to_text(target);
+}, false)
+// clear
+window.addEventListener("mouseout", function(e) {
+ var target = find_group(e.target);
+ if (target) details.nodeValue = ' ';
+}, false)
+// ctrl-F for search
+window.addEventListener("keydown",function (e) {
+ if (e.keyCode === 114 || (e.ctrlKey && e.keyCode === 70)) {
+ e.preventDefault();
+ search_prompt();
+ }
+}, false)
+// functions
+function get_params() {
+ var params = {};
+ var paramsarr = window.location.search.substr(1).split('&');
+ for (var i = 0; i < paramsarr.length; ++i) {
+ var tmp = paramsarr[i].split("=");
+ if (!tmp[0] || !tmp[1]) continue;
+ params[tmp[0]] = decodeURIComponent(tmp[1]);
+ }
+ return params;
+}
+function parse_params(params) {
+ var uri = "?";
+ for (var key in params) {
+ uri += key + '=' + encodeURIComponent(params[key]) + '&';
+ }
+ if (uri.slice(-1) == "&")
+ uri = uri.substring(0, uri.length - 1);
+ if (uri == '?')
+ uri = window.location.href.split('?')[0];
+ return uri;
+}
+function find_child(node, selector) {
+ var children = node.querySelectorAll(selector);
+ if (children.length) return children[0];
+ return;
+}
+function find_group(node) {
+ var parent = node.parentElement;
+ if (!parent) return;
+ if (parent.id == "frames") return node;
+ return find_group(parent);
+}
+function orig_save(e, attr, val) {
+ if (e.attributes["fg:orig_" + attr] != undefined) return;
+ if (e.attributes[attr] == undefined) return;
+ if (val == undefined) val = e.attributes[attr].value;
+ e.setAttribute("fg:orig_" + attr, val);
+}
+function orig_load(e, attr) {
+ if (e.attributes["fg:orig_"+attr] == undefined) return;
+ e.attributes[attr].value = e.attributes["fg:orig_" + attr].value;
+ e.removeAttribute("fg:orig_" + attr);
+}
+function g_to_text(e) {
+ var text = find_child(e, "title").firstChild.nodeValue;
+ return (text)
+}
+function g_to_func(e) {
+ var func = g_to_text(e);
+ // if there's any manipulation we want to do to the function
+ // name before it's searched, do it here before returning.
+ return (func);
+}
+function get_monospace_width(frames) {
+ // Given the id="frames" element, return the width of text characters if
+ // this is a monospace font, otherwise return 0.
+ text = find_child(frames.children[0], "text");
+ originalContent = text.textContent;
+ text.textContent = "!";
+ bangWidth = text.getComputedTextLength();
+ text.textContent = "W";
+ wWidth = text.getComputedTextLength();
+ text.textContent = originalContent;
+ if (bangWidth === wWidth) {
+ return bangWidth;
+ } else {
+ return 0;
+ }
+}
+function update_text_for_elements(elements) {
+ // In order to render quickly in the browser, you want to do one pass of
+ // reading attributes, and one pass of mutating attributes. See
+ // https://web.dev/avoid-large-complex-layouts-and-layout-thrashing/ for
details.
+
+ // Fall back to inefficient calculation, if we're variable-width font.
+ // TODO This should be optimized somehow too.
+ if (known_font_width === 0) {
+ for (var i = 0; i < elements.length; i++) {
+ update_text(elements[i]);
+ }
+ return;
+ }
+
+ var textElemNewAttributes = [];
+ for (var i = 0; i < elements.length; i++) {
+ var e = elements[i];
+ var r = find_child(e, "rect");
+ var t = find_child(e, "text");
+ var w = parseFloat(r.attributes.width.value) *
frames.attributes.width.value / 100 - 3;
+ var txt = find_child(e, "title").textContent.replace(/\([^(]*\)$/,"");
+ var newX = format_percent((parseFloat(r.attributes.x.value) + (100 * 3
/ frames.attributes.width.value)));
+
+ // Smaller than this size won't fit anything
+ if (w < 2 * known_font_width) {
+ textElemNewAttributes.push([newX, ""]);
+ continue;
+ }
+
+ // Fit in full text width
+ if (txt.length * known_font_width < w) {
+ textElemNewAttributes.push([newX, txt]);
+ continue;
+ }
+
+ var substringLength = Math.floor(w / known_font_width) - 2;
+ if (truncate_text_right) {
+ // Truncate the right side of the text.
+ textElemNewAttributes.push([newX, txt.substring(0,
substringLength) + ".."]);
+ continue;
+ } else {
+ // Truncate the left side of the text.
+ textElemNewAttributes.push([newX, ".." + txt.substring(txt.length
- substringLength, txt.length)]);
+ continue;
+ }
+ }
+
+ console.assert(textElemNewAttributes.length === elements.length, "Resize
failed, please file a bug at https://github.com/jonhoo/inferno/";);
+
+ // Now that we know new textContent, set it all in one go so we don't
refresh a bazillion times.
+ for (var i = 0; i < elements.length; i++) {
+ var e = elements[i];
+ var values = textElemNewAttributes[i];
+ var t = find_child(e, "text");
+ t.attributes.x.value = values[0];
+ t.textContent = values[1];
+ }
+}
+
+function update_text(e) {
+ var r = find_child(e, "rect");
+ var t = find_child(e, "text");
+ var w = parseFloat(r.attributes.width.value) *
frames.attributes.width.value / 100 - 3;
+ var txt = find_child(e, "title").textContent.replace(/\([^(]*\)$/,"");
+ t.attributes.x.value = format_percent((parseFloat(r.attributes.x.value) +
(100 * 3 / frames.attributes.width.value)));
+
+ // Smaller than this size won't fit anything
+ if (w < 2 * fontsize * fontwidth) {
+ t.textContent = "";
+ return;
+ }
+ t.textContent = txt;
+ // Fit in full text width
+ if (t.getComputedTextLength() < w)
+ return;
+ if (truncate_text_right) {
+ // Truncate the right side of the text.
+ for (var x = txt.length - 2; x > 0; x--) {
+ if (t.getSubStringLength(0, x + 2) <= w) {
+ t.textContent = txt.substring(0, x) + "..";
+ return;
+ }
+ }
+ } else {
+ // Truncate the left side of the text.
+ for (var x = 2; x < txt.length; x++) {
+ if (t.getSubStringLength(x - 2, txt.length) <= w) {
+ t.textContent = ".." + txt.substring(x, txt.length);
+ return;
+ }
+ }
+ }
+ t.textContent = "";
+}
+// zoom
+function zoom_reset(e) {
+ if (e.tagName == "rect") {
+ e.attributes.x.value = format_percent(100 *
parseInt(e.attributes["fg:x"].value) / total_samples);
+ e.attributes.width.value = format_percent(100 *
parseInt(e.attributes["fg:w"].value) / total_samples);
+ }
+ if (e.childNodes == undefined) return;
+ for(var i = 0, c = e.childNodes; i < c.length; i++) {
+ zoom_reset(c[i]);
+ }
+}
+function zoom_child(e, x, zoomed_width_samples) {
+ if (e.tagName == "text") {
+ var parent_x = parseFloat(find_child(e.parentNode,
"rect[x]").attributes.x.value);
+ e.attributes.x.value = format_percent(parent_x + (100 * 3 /
frames.attributes.width.value));
+ } else if (e.tagName == "rect") {
+ e.attributes.x.value = format_percent(100 *
(parseInt(e.attributes["fg:x"].value) - x) / zoomed_width_samples);
+ e.attributes.width.value = format_percent(100 *
parseInt(e.attributes["fg:w"].value) / zoomed_width_samples);
+ }
+ if (e.childNodes == undefined) return;
+ for(var i = 0, c = e.childNodes; i < c.length; i++) {
+ zoom_child(c[i], x, zoomed_width_samples);
+ }
+}
+function zoom_parent(e) {
+ if (e.attributes) {
+ if (e.attributes.x != undefined) {
+ e.attributes.x.value = "0.0%";
+ }
+ if (e.attributes.width != undefined) {
+ e.attributes.width.value = "100.0%";
+ }
+ }
+ if (e.childNodes == undefined) return;
+ for(var i = 0, c = e.childNodes; i < c.length; i++) {
+ zoom_parent(c[i]);
+ }
+}
+function zoom(node) {
+ var attr = find_child(node, "rect").attributes;
+ var width = parseInt(attr["fg:w"].value);
+ var xmin = parseInt(attr["fg:x"].value);
+ var xmax = xmin + width;
+ var ymin = parseFloat(attr.y.value);
+ unzoombtn.classList.remove("hide");
+ var el = frames.children;
+ var to_update_text = [];
+ for (var i = 0; i < el.length; i++) {
+ var e = el[i];
+ var a = find_child(e, "rect").attributes;
+ var ex = parseInt(a["fg:x"].value);
+ var ew = parseInt(a["fg:w"].value);
+ // Is it an ancestor
+ if (!inverted) {
+ var upstack = parseFloat(a.y.value) > ymin;
+ } else {
+ var upstack = parseFloat(a.y.value) < ymin;
+ }
+ if (upstack) {
+ // Direct ancestor
+ if (ex <= xmin && (ex+ew) >= xmax) {
+ e.classList.add("parent");
+ zoom_parent(e);
+ to_update_text.push(e);
+ }
+ // not in current path
+ else
+ e.classList.add("hide");
+ }
+ // Children maybe
+ else {
+ // no common path
+ if (ex < xmin || ex >= xmax) {
+ e.classList.add("hide");
+ }
+ else {
+ zoom_child(e, xmin, width);
+ to_update_text.push(e);
+ }
+ }
+ }
+ update_text_for_elements(to_update_text);
+}
+function unzoom() {
+ unzoombtn.classList.add("hide");
+ var el = frames.children;
+ for(var i = 0; i < el.length; i++) {
+ el[i].classList.remove("parent");
+ el[i].classList.remove("hide");
+ zoom_reset(el[i]);
+ }
+ update_text_for_elements(el);
+}
+// search
+function reset_search() {
+ var el = document.querySelectorAll("#frames rect");
+ for (var i = 0; i < el.length; i++) {
+ orig_load(el[i], "fill")
+ }
+ var params = get_params();
+ delete params.s;
+ history.replaceState(null, null, parse_params(params));
+}
+function search_prompt() {
+ if (!searching) {
+ var term = prompt("Enter a search term (regexp " +
+ "allowed, eg: ^ext4_)", "");
+ if (term != null) {
+ search(term)
+ }
+ } else {
+ reset_search();
+ searching = 0;
+ searchbtn.classList.remove("show");
+ searchbtn.firstChild.nodeValue = "Search"
+ matchedtxt.classList.add("hide");
+ matchedtxt.firstChild.nodeValue = ""
+ }
+}
+function search(term) {
+ var re = new RegExp(term);
+ var el = frames.children;
+ var matches = new Object();
+ var maxwidth = 0;
+ for (var i = 0; i < el.length; i++) {
+ var e = el[i];
+ // Skip over frames which are either not visible, or below the
zoomed-to frame
+ if (e.classList.contains("hide") || e.classList.contains("parent")) {
+ continue;
+ }
+ var func = g_to_func(e);
+ var rect = find_child(e, "rect");
+ if (func == null || rect == null)
+ continue;
+ // Save max width. Only works as we have a root frame
+ var w = parseInt(rect.attributes["fg:w"].value);
+ if (w > maxwidth)
+ maxwidth = w;
+ if (func.match(re)) {
+ // highlight
+ var x = parseInt(rect.attributes["fg:x"].value);
+ orig_save(rect, "fill");
+ rect.attributes.fill.value = searchcolor;
+ // remember matches
+ if (matches[x] == undefined) {
+ matches[x] = w;
+ } else {
+ if (w > matches[x]) {
+ // overwrite with parent
+ matches[x] = w;
+ }
+ }
+ searching = 1;
+ }
+ }
+ if (!searching)
+ return;
+ var params = get_params();
+ params.s = term;
+ history.replaceState(null, null, parse_params(params));
+
+ searchbtn.classList.add("show");
+ searchbtn.firstChild.nodeValue = "Reset Search";
+ // calculate percent matched, excluding vertical overlap
+ var count = 0;
+ var lastx = -1;
+ var lastw = 0;
+ var keys = Array();
+ for (k in matches) {
+ if (matches.hasOwnProperty(k))
+ keys.push(k);
+ }
+ // sort the matched frames by their x location
+ // ascending, then width descending
+ keys.sort(function(a, b){
+ return a - b;
+ });
+ // Step through frames saving only the biggest bottom-up frames
+ // thanks to the sort order. This relies on the tree property
+ // where children are always smaller than their parents.
+ for (var k in keys) {
+ var x = parseInt(keys[k]);
+ var w = matches[keys[k]];
+ if (x >= lastx + lastw) {
+ count += w;
+ lastx = x;
+ lastw = w;
+ }
+ }
+ // display matched percent
+ matchedtxt.classList.remove("hide");
+ var pct = 100 * count / maxwidth;
+ if (pct != 100) pct = pct.toFixed(1);
+ matchedtxt.firstChild.nodeValue = "Matched: " + pct + "%";
+}
+function format_percent(n) {
+ return n.toFixed(4) + "%";
+}
+]]></script><rect x="0" y="0" width="100%" height="694"
fill="url(#background)"/><text id="title" fill="rgb(0,0,0)" x="50.0000%"
y="24.00">Flame Graph</text><text id="details" fill="rgb(0,0,0)" x="10"
y="677.00"> </text><text id="unzoom" class="hide" fill="rgb(0,0,0)" x="10"
y="24.00">Reset Zoom</text><text id="search" fill="rgb(0,0,0)" x="1190"
y="24.00">Search</text><text id="matched" fill="rgb(0,0,0)" x="1190"
y="677.00"> </text><svg id="frames" x="10" width="1180" total_samples="8514
[...]
\ No newline at end of file
diff --git a/library-user-guide/profiling.html
b/library-user-guide/profiling.html
index 983936b969..fa63344e4d 100644
--- a/library-user-guide/profiling.html
+++ b/library-user-guide/profiling.html
@@ -568,30 +568,32 @@
<h2>MacOS<a class="headerlink" href="#macos" title="Link to this
heading">¶</a></h2>
<section id="building-a-flamegraph">
<h3>Building a flamegraph<a class="headerlink" href="#building-a-flamegraph"
title="Link to this heading">¶</a></h3>
-<ul class="simple">
-<li><p><a class="reference external"
href="https://github.com/flamegraph-rs/flamegraph";>cargo-flamegraph</a></p></li>
-</ul>
-<p>Test:</p>
-<div class="highlight-bash notranslate"><div
class="highlight"><pre><span></span><span
class="nv">CARGO_PROFILE_RELEASE_DEBUG</span><span class="o">=</span><span
class="nb">true</span><span class="w"> </span>cargo<span class="w">
</span>flamegraph<span class="w"> </span>--root<span class="w">
</span>--unit-test<span class="w"> </span>datafusion<span class="w">
</span>--<span class="w"> </span>dataframe::tests::test_array_agg
+<p><a class="reference external" href="https://youtu.be/2z11xtYw_xs";>Video:
how to CPU profile DataFusion with a Flamegraph</a></p>
+<p>A flamegraph is a visual representation of which functions are being run
+You can create flamegraphs in many ways; The instructions below are for
+<a class="reference external"
href="https://github.com/flamegraph-rs/flamegraph";>cargo-flamegraph</a> which
results
+in images such as this:</p>
+<p><img alt="Flamegraph" src="../_images/flamegraph.svg" /></p>
+<p>To create a flamegraph, you need to install the <code class="docutils
literal notranslate"><span class="pre">flamegraph</span></code> tool:</p>
+<div class="highlight-shell notranslate"><div
class="highlight"><pre><span></span>cargo<span class="w"> </span>install<span
class="w"> </span>flamegraph
</pre></div>
</div>
-<p>Benchmark:</p>
-<div class="highlight-bash notranslate"><div
class="highlight"><pre><span></span><span
class="nv">CARGO_PROFILE_RELEASE_DEBUG</span><span class="o">=</span><span
class="nb">true</span><span class="w"> </span>cargo<span class="w">
</span>flamegraph<span class="w"> </span>--root<span class="w">
</span>--bench<span class="w"> </span>sql_planner<span class="w">
</span>--<span class="w"> </span>--bench
+<p>Then you can run the flamegraph tool with the <code class="docutils literal
notranslate"><span class="pre">--</span></code> separator to pass arguments
+to the binary you want to profile.</p>
+<p>Example: Flamegraph for <code class="docutils literal notranslate"><span
class="pre">datafusion-cli</span></code> executing <code class="docutils
literal notranslate"><span class="pre">q28.sql</span></code>. Note this
+must be run as root on Mac OSx to access DTrace.</p>
+<div class="highlight-shell notranslate"><div
class="highlight"><pre><span></span>sudo<span class="w"> </span>flamegraph<span
class="w"> </span>--<span class="w"> </span>datafusion-cli<span class="w">
</span>-f<span class="w"> </span>q28.sq
</pre></div>
</div>
-<p>Open <code class="docutils literal notranslate"><span
class="pre">flamegraph.svg</span></code> file with the browser</p>
-<ul class="simple">
-<li><p>dtrace with DataFusion CLI</p></li>
-</ul>
-<div class="highlight-bash notranslate"><div
class="highlight"><pre><span></span>git<span class="w"> </span>clone<span
class="w"> </span>https://github.com/brendangregg/FlameGraph.git<span
class="w"> </span>/tmp/fg
-<span class="nb">cd</span><span class="w"> </span>datafusion-cli
-<span class="nv">CARGO_PROFILE_RELEASE_DEBUG</span><span
class="o">=</span><span class="nb">true</span><span class="w">
</span>cargo<span class="w"> </span>build<span class="w"> </span>--release
-<span class="nb">echo</span><span class="w"> </span><span
class="s2">"select * from table;"</span><span class="w">
</span>>><span class="w"> </span>test.sql
-sudo<span class="w"> </span>dtrace<span class="w"> </span>-c<span class="w">
</span><span class="s1">'./target/debug/datafusion-cli -f
test.sql'</span><span class="w"> </span>-o<span class="w">
</span>out.stacks<span class="w"> </span>-n<span class="w"> </span><span
class="s1">'profile-997 /execname == "datafusion-cli"/ {
@[ustack(100)] = count(); }'</span>
-/tmp/fg/FlameGraph/stackcollapse.pl<span class="w"> </span>out.stacks<span
class="w"> </span><span class="p">|</span><span class="w">
</span>/tmp/fg/FlameGraph/flamegraph.pl<span class="w"> </span>><span
class="w"> </span>flamegraph.svg
+<p>You can also invoke the flamegraph tool with <code class="docutils literal
notranslate"><span class="pre">cargo</span></code> to profile a specific test
or benchmark.</p>
+<p>Example: Flamegraph for a specific test:</p>
+<div class="highlight-bash notranslate"><div
class="highlight"><pre><span></span><span
class="nv">CARGO_PROFILE_RELEASE_DEBUG</span><span class="o">=</span><span
class="nb">true</span><span class="w"> </span>cargo<span class="w">
</span>flamegraph<span class="w"> </span>--root<span class="w">
</span>--unit-test<span class="w"> </span>datafusion<span class="w">
</span>--<span class="w"> </span>dataframe::tests::test_array_agg
+</pre></div>
+</div>
+<p>Example: Flamegraph for a benchmark</p>
+<div class="highlight-bash notranslate"><div
class="highlight"><pre><span></span><span
class="nv">CARGO_PROFILE_RELEASE_DEBUG</span><span class="o">=</span><span
class="nb">true</span><span class="w"> </span>cargo<span class="w">
</span>flamegraph<span class="w"> </span>--root<span class="w">
</span>--bench<span class="w"> </span>sql_planner<span class="w">
</span>--<span class="w"> </span>--bench
</pre></div>
</div>
-<p>Open <code class="docutils literal notranslate"><span
class="pre">flamegraph.svg</span></code> file with the browser</p>
</section>
<section id="cpu-profiling-with-xcode-instruments">
<h3>CPU profiling with XCode Instruments<a class="headerlink"
href="#cpu-profiling-with-xcode-instruments" title="Link to this
heading">¶</a></h3>
diff --git a/searchindex.js b/searchindex.js
index b82f1da9ed..f5e2c9588f 100644
--- a/searchindex.js
+++ b/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"alltitles": {"!=": [[46, "op-neq"]], "!~": [[46,
"op-re-not-match"]], "!~*": [[46, "op-re-not-match-i"]], "!~~": [[46, "id18"]],
"!~~*": [[46, "id19"]], "#": [[46, "op-bit-xor"]], "%": [[46, "op-modulo"]],
"&": [[46, "op-bit-and"]], "(relation, name) tuples in logical fields and
logical columns are unique": [[9,
"relation-name-tuples-in-logical-fields-and-logical-columns-are-unique"]], "*":
[[46, "op-multiply"]], "+": [[46, "op-plus"]], "-": [[46, "op-minus"]], "/":
[[4 [...]
\ No newline at end of file
+Search.setIndex({"alltitles": {"!=": [[46, "op-neq"]], "!~": [[46,
"op-re-not-match"]], "!~*": [[46, "op-re-not-match-i"]], "!~~": [[46, "id18"]],
"!~~*": [[46, "id19"]], "#": [[46, "op-bit-xor"]], "%": [[46, "op-modulo"]],
"&": [[46, "op-bit-and"]], "(relation, name) tuples in logical fields and
logical columns are unique": [[9,
"relation-name-tuples-in-logical-fields-and-logical-columns-are-unique"]], "*":
[[46, "op-multiply"]], "+": [[46, "op-plus"]], "-": [[46, "op-minus"]], "/":
[[4 [...]
\ No newline at end of file
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
