Skip to content

Commit

Permalink
[JSC] Add stackcollapse-sampling-profiler-output script
Browse files Browse the repository at this point in the history
https://bugs.webkit.org/show_bug.cgi?id=264102
rdar://117863428

Reviewed by Justin Michaud.

This patch adds stackcollapse-sampling-profiler-output. This is FlameGraph's stackcollapse script
for JSC sampling profiler output JSON. We can use this with FlameGraph[1] scripts to generate FrameGraph.
The stackcollapse script's purpose is making stack sample to one line per sample in a specific format (as
the same to the other stackcollapse scripts in FlameGraph repository).

Usage is just like, `cat dump.json | stackcollapse-sampling-profiler-output | ~/dev/FlameGraph/flamegraph.pl > result.svg`

[1]: https://github.com/brendangregg/FlameGraph

* Tools/Scripts/stackcollapse-sampling-profiler-output: Added.

Canonical link: https://commits.webkit.org/270119@main
  • Loading branch information
Constellation committed Nov 2, 2023
1 parent 71add0a commit 77c6060
Showing 1 changed file with 59 additions and 0 deletions.
59 changes: 59 additions & 0 deletions Tools/Scripts/stackcollapse-sampling-profiler-output
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
#!/usr/bin/env ruby
# Copyright (C) 2023 Apple Inc. All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions
# are met:
# 1. Redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer.
# 2. Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in the
# documentation and/or other materials provided with the distribution.
#
# THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
# BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
# THE POSSIBILITY OF SUCH DAMAGE.

require 'rubygems'

begin
require 'json'
rescue LoadError
$stderr.puts "Error: some required gems are not installed!"
$stderr.puts
$stderr.puts "Try running:"
$stderr.puts
$stderr.puts "sudo gem install json"
exit 1
end

def dump(database)
database["traces"].each do |stackTrace|
next if stackTrace["frames"].empty?
line = stackTrace["frames"].reverse.map do |frame|
hash, category, offset = frame["location"].split(":")
"#{frame["name"]}#{hash}".gsub(/;/, '_').gsub(/[\n\r]/, ' ')
end.join(';')
puts "#{line} 1"
end
end

def main
json = nil
if ARGV.empty?
json = JSON.parse(STDIN.read)
else
json = JSON::parse(IO::read(ARGV[0]))
end
dump(json)
end

main

0 comments on commit 77c6060

Please sign in to comment.