mirror of
https://github.com/torvalds/linux.git
synced 2026-11-10 17:11:02 +01:00
eb08738a7f
Port flamegraph.py to a standalone script in tools/perf/python/ that
uses the perf module directly, avoiding intermediate dictionary
allocations for event fields.
Improvements compared to the legacy script:
- Add Subresource Integrity (integrity="sha256-...") and
crossorigin="anonymous" attributes to external CDN stylesheet and
script tags in MINIMAL_HTML.
- Upgrade CDN HTML template hash verification from weak MD5
(hashlib.md5) to cryptographic SHA-256 (hashlib.sha256).
- Escape '<', '>', and '&' ('\u003c', '\u003e', '\u0026') in embedded
JSON payloads (stacks_json and options_json) to prevent HTML script
injection / XSS when rendering untrusted symbol or command names.
- Skip invoking 'perf report --header-only' when the input is stdin
('-'), a FIFO pipe, or a character device (S_ISFIFO / S_ISCHR) so
non-seekable streams do not hang or fail.
Add a shell test (test_flamegraph_python.sh) to verify the standalone
script.
Assisted-by: Antigravity:gemini-3.1-pro
Signed-off-by: Ian Rogers <irogers@google.com>
Signed-off-by: Arnaldo Carvalho de Melo <acme@redhat.com>
123 lines
3.2 KiB
Bash
Executable File
123 lines
3.2 KiB
Bash
Executable File
#!/bin/bash
|
|
# SPDX-License-Identifier: GPL-2.0
|
|
# flamegraph python test
|
|
|
|
set -e
|
|
|
|
shelldir=$(dirname "$0")
|
|
# shellcheck source=lib/setup_python.sh
|
|
. "${shelldir}"/lib/setup_python.sh
|
|
|
|
# If we don't have the perf python module, we can't test
|
|
if ! "$PYTHON" -c 'import perf' > /dev/null 2>&1; then
|
|
echo "Skipping test, perf python module not found"
|
|
exit 2
|
|
fi
|
|
|
|
script_dir="$(dirname "$0")/../../python"
|
|
script_path="${script_dir}/flamegraph.py"
|
|
|
|
if [ ! -f "$script_path" ]; then
|
|
echo "Skipping test, flamegraph.py not found at $script_path"
|
|
exit 2
|
|
fi
|
|
|
|
err=0
|
|
temp_data=""
|
|
temp_json=""
|
|
temp_html=""
|
|
temp_tpl=""
|
|
|
|
cleanup() {
|
|
rm -f "${temp_data}" "${temp_json}" "${temp_html}" "${temp_tpl}"
|
|
}
|
|
|
|
trap 'cleanup' EXIT TERM INT
|
|
|
|
temp_data=$(mktemp /tmp/perf.data.XXXXXX)
|
|
temp_json=$(mktemp /tmp/perf.flamegraph.json.XXXXXX)
|
|
temp_html=$(mktemp /tmp/perf.flamegraph.html.XXXXXX)
|
|
temp_tpl=$(mktemp /tmp/perf.flamegraph.tpl.XXXXXX)
|
|
|
|
validate_json() {
|
|
local json_file="$1"
|
|
local label="$2"
|
|
|
|
if ! "$PYTHON" -m json.tool "${json_file}" /dev/null >/dev/null 2>&1; then
|
|
echo "${label} JSON validation failed."
|
|
err=1
|
|
elif ! "$PYTHON" -c "import json, sys
|
|
d = json.load(open(sys.argv[1]))
|
|
assert d.get('v', 0) > 0 or len(d.get('c', [])) > 0" "${json_file}" >/dev/null 2>&1; then
|
|
echo "${label} JSON flamegraph structure is empty."
|
|
err=1
|
|
else
|
|
echo "${label} JSON test passed."
|
|
fi
|
|
}
|
|
|
|
test_file_mode() {
|
|
echo "Testing flamegraph.py..."
|
|
|
|
# Generate some events with callchains
|
|
if ! perf record -g -o "${temp_data}" -- perf test -w noploop >/dev/null 2>&1; then
|
|
echo "Skipping test, perf record -g failed (permissions or lack of support)"
|
|
exit 2
|
|
fi
|
|
|
|
# Run the script in file mode and validate JSON output
|
|
if ! "$PYTHON" "$script_path" -i "${temp_data}" -f json -o "${temp_json}" >/dev/null; then
|
|
echo "File mode JSON test failed."
|
|
err=1
|
|
else
|
|
validate_json "${temp_json}" "File mode"
|
|
fi
|
|
|
|
# Run the script in pipe ('-') mode and validate JSON output
|
|
rm -f "${temp_json}"
|
|
if ! perf record -g -o - -- perf test -w noploop 2>/dev/null | \
|
|
"$PYTHON" "$script_path" -i - -f json -o "${temp_json}" >/dev/null; then
|
|
echo "Pipe stdin JSON mode test failed."
|
|
err=1
|
|
else
|
|
validate_json "${temp_json}" "Pipe mode"
|
|
fi
|
|
|
|
# Run the script, dump as html to temp_html using MINIMAL_HTML fallback
|
|
if ! "$PYTHON" "$script_path" -i "${temp_data}" -f html \
|
|
--template /nonexistent/template.html -o "${temp_html}" >/dev/null 2>&1; then
|
|
echo "File mode HTML test failed."
|
|
err=1
|
|
else
|
|
if ! grep -q "<head>" "${temp_html}" || \
|
|
! grep -q 'crossorigin="anonymous"' "${temp_html}"; then
|
|
echo "HTML validation failed."
|
|
err=1
|
|
else
|
|
echo "File mode HTML test passed."
|
|
fi
|
|
fi
|
|
|
|
# Test custom local HTML template and --colorscheme option
|
|
cat << 'EOF' > "${temp_tpl}"
|
|
<html><body><script>
|
|
const opts = /** @options_json **/;
|
|
const data = /** @flamegraph_json **/;
|
|
</script></body></html>
|
|
EOF
|
|
if ! "$PYTHON" "$script_path" -i "${temp_data}" -f html --template "${temp_tpl}" \
|
|
--colorscheme blue-green -o "${temp_html}" >/dev/null 2>&1; then
|
|
echo "Custom template HTML test failed."
|
|
err=1
|
|
elif ! grep -q "blue-green" "${temp_html}"; then
|
|
echo "Custom template colorscheme substitution failed."
|
|
err=1
|
|
else
|
|
echo "Custom template HTML test passed."
|
|
fi
|
|
}
|
|
|
|
test_file_mode
|
|
|
|
exit $err
|