Skip to content

Commit

Permalink
utilities: New helper ovs-parse-backtrace.
Browse files Browse the repository at this point in the history
The new ovs-parse-backtrace utility makes the output of ovs-appctl
backtrace more human readable by removing duplicate traces and
converting addresses to function names.

Signed-off-by: Ethan Jackson <[email protected]>
  • Loading branch information
ejj committed Oct 17, 2012
1 parent 3d7cab5 commit 013061c
Show file tree
Hide file tree
Showing 9 changed files with 149 additions and 0 deletions.
1 change: 1 addition & 0 deletions debian/openvswitch-common.install
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
usr/bin/ovs-appctl
usr/bin/ovs-benchmark
usr/bin/ovs-ofctl
usr/bin/ovs-parse-backtrace
usr/bin/ovs-parse-leaks
usr/bin/ovs-pki
usr/bin/ovsdb-client
Expand Down
1 change: 1 addition & 0 deletions debian/openvswitch-common.manpages
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,5 @@ _debian/utilities/ovs-benchmark.1
_debian/utilities/ovs-ofctl.8
_debian/utilities/ovs-pki.8
utilities/bugtool/ovs-bugtool.8
utilities/ovs-parse-backtrace.8
utilities/ovs-parse-leaks.8
2 changes: 2 additions & 0 deletions rhel/openvswitch-fedora.spec.in
Original file line number Diff line number Diff line change
Expand Up @@ -170,6 +170,7 @@ systemctl start openvswitch.service
%doc /usr/share/man/man8/ovs-brcompatd.8.gz
%doc /usr/share/man/man8/ovs-dpctl.8.gz
%doc /usr/share/man/man8/ovs-ofctl.8.gz
%doc /usr/share/man/man8/ovs-parse-backtrace.8.gz
%doc /usr/share/man/man8/ovs-parse-leaks.8.gz
%doc /usr/share/man/man8/ovs-vsctl.8.gz
%doc /usr/share/man/man8/ovs-vswitchd.8.gz
Expand All @@ -179,6 +180,7 @@ systemctl start openvswitch.service
/usr/share/openvswitch/scripts/ovs-ctl
%exclude /etc/openvswitch
%exclude /usr/bin/ovs-benchmark
%exclude /usr/bin/ovs-parse-backtrace
%exclude /usr/bin/ovs-parse-leaks
%exclude /usr/bin/ovs-pcap
%exclude /usr/bin/ovs-tcpundump
Expand Down
2 changes: 2 additions & 0 deletions rhel/openvswitch.spec.in
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,7 @@ exit 0
/usr/bin/ovs-benchmark
/usr/bin/ovs-dpctl
/usr/bin/ovs-ofctl
/usr/bin/ovs-parse-backtrace
/usr/bin/ovs-parse-leaks
/usr/bin/ovs-pcap
/usr/bin/ovs-pki
Expand All @@ -140,6 +141,7 @@ exit 0
/usr/share/man/man8/ovs-ctl.8.gz
/usr/share/man/man8/ovs-dpctl.8.gz
/usr/share/man/man8/ovs-ofctl.8.gz
/usr/share/man/man8/ovs-parse-backtrace.8.gz
/usr/share/man/man8/ovs-parse-leaks.8.gz
/usr/share/man/man8/ovs-pki.8.gz
/usr/share/man/man8/ovs-vlan-test.8.gz
Expand Down
1 change: 1 addition & 0 deletions utilities/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
/ovs-lib
/ovs-ofctl
/ovs-ofctl.8
/ovs-parse-backtrace
/ovs-parse-leaks
/ovs-pcap
/ovs-pcap.1
Expand Down
5 changes: 5 additions & 0 deletions utilities/automake.mk
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ bin_SCRIPTS += utilities/ovs-pki utilities/ovs-parse-leaks
if HAVE_PYTHON
bin_SCRIPTS += \
utilities/ovs-l3ping \
utilities/ovs-parse-backtrace \
utilities/ovs-pcap \
utilities/ovs-tcpundump \
utilities/ovs-test \
Expand All @@ -24,6 +25,7 @@ EXTRA_DIST += \
utilities/ovs-ctl.in \
utilities/ovs-l3ping.in \
utilities/ovs-lib.in \
utilities/ovs-parse-backtrace.in \
utilities/ovs-parse-leaks.in \
utilities/ovs-pcap.in \
utilities/ovs-pki.in \
Expand All @@ -39,6 +41,7 @@ MAN_ROOTS += \
utilities/ovs-dpctl.8.in \
utilities/ovs-l3ping.8.in \
utilities/ovs-ofctl.8.in \
utilities/ovs-parse-backtrace.8 \
utilities/ovs-parse-leaks.8 \
utilities/ovs-pcap.1.in \
utilities/ovs-pki.8.in \
Expand All @@ -59,6 +62,7 @@ DISTCLEANFILES += \
utilities/ovs-l3ping.8 \
utilities/ovs-lib \
utilities/ovs-ofctl.8 \
utilities/ovs-parse-backtrace \
utilities/ovs-parse-leaks \
utilities/ovs-pcap \
utilities/ovs-pcap.1 \
Expand All @@ -80,6 +84,7 @@ man_MANS += \
utilities/ovs-dpctl.8 \
utilities/ovs-l3ping.8 \
utilities/ovs-ofctl.8 \
utilities/ovs-parse-backtrace.8 \
utilities/ovs-parse-leaks.8 \
utilities/ovs-pcap.1 \
utilities/ovs-pki.8 \
Expand Down
28 changes: 28 additions & 0 deletions utilities/ovs-parse-backtrace.8
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
.TH ovs\-parse\-backtrace 8 "October 2012" "Open vSwitch" "Open vSwitch Manual"
.
.SH NAME
ovs\-parse\-backtrace \- parses ovs-appctl backtrace output
.
.SH SYNOPSIS
\fBovs\-appctl backtrace\fR | \fBovs\-parse\-backtrace\fR [\fIbinary\fR]
.P
\fBovs\-parse\-backtrace\fR [\fIbinary\fR] < \fIbacktrace\fR
.
.SH DESCRIPTION
In some configurations, many Open vSwitch daemons can produce a series of
backtraces using the \fBovs\-appctl backtrace\fR command. Users can analyze
these backtraces to figure out what the given Open vSwitch daemon may be
spending most of its time doing. \fBovs\-parse\-backtrace\fR makes this output
easier to interpret.
.PP
The \fBovs\-appctl backtrace\fR output must be supplied on standard input. The
binary that produced the output should be supplied as the sole non-option
argument. For best results, the binary should have debug symbols.
.
.SH OPTIONS
.TP
\fB\-\-help\fR
Prints a usage message and exits.
.P
\fB\-\-version\fR
Prints the version and exits.
107 changes: 107 additions & 0 deletions utilities/ovs-parse-backtrace.in
Original file line number Diff line number Diff line change
@@ -0,0 +1,107 @@
#! @PYTHON@
#
# Copyright (c) 2012 Nicira, Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at:
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

import optparse
import os
import re
import subprocess
import sys


addr2line_cache = {} # None if addr2line is missing or broken.


def addr2line(binary, addr):
global addr2line_cache

if addr2line_cache is None:
return ""

if addr in addr2line_cache:
return addr2line_cache[addr]

cmd = ["addr2line", "-f", "-s", "-e", binary, addr]
try:
proc = subprocess.Popen(cmd, stdout=subprocess.PIPE,
stderr=subprocess.PIPE)
lines = proc.stdout.readlines()
failed = proc.returncode
except OSError:
failed = True

if failed:
addr2line_cache = None
return ""

lines = [l.strip() for l in lines]
return " ".join(lines)


def main():
parser = optparse.OptionParser(version='@VERSION@',
usage="usage: %prog [binary]",
description="""\
Parses the output of ovs-appctl backtrace producing a more human readable
result. Expected usage is for ovs-appctl backtrace to be piped in.""")
options, args = parser.parse_args()

if len(args) > 1:
parser.print_help()
sys.exit(1)

if len(args) == 1:
binary = args[0]
else:
binary = "@sbindir@/ovs-vswitchd"
debug = "/usr/lib/debug%s.debug" % binary
if os.path.exists(debug):
binary = debug

print "Binary: %s\n" % binary

stdin = sys.stdin.read()
trace_list = stdin.strip().split("\n\n")

try:
#Remove the first line from each trace.
trace_list = [trace[(trace.index("\n") + 1):] for trace in trace_list]
except ValueError:
sys.stdout.write(stdin)
sys.exit(1)

trace_map = {}
for trace in trace_list:
trace_map[trace] = trace_map.get(trace, 0) + 1

sorted_traces = sorted(trace_map.items(), key=(lambda x: x[1]),
reverse=True)
for trace, count in sorted_traces:
lines = trace.splitlines()
longest = max(len(l) for l in lines)

print "Backtrace Count: %d" % count
for line in lines:
match = re.search(r'\[(0x.*)]', line)
if match:
print "%s %s" % (line.ljust(longest),
addr2line(binary, match.group(1)))
else:
print line
print


if __name__ == "__main__":
main()
2 changes: 2 additions & 0 deletions xenserver/openvswitch-xen.spec.in
Original file line number Diff line number Diff line change
Expand Up @@ -428,6 +428,7 @@ exit 0
/usr/bin/ovs-appctl
/usr/bin/ovs-dpctl
/usr/bin/ovs-ofctl
/usr/bin/ovs-parse-backtrace
/usr/bin/ovs-parse-leaks
/usr/bin/ovs-pcap
/usr/bin/ovs-tcpundump
Expand All @@ -444,6 +445,7 @@ exit 0
/usr/share/man/man8/ovs-ctl.8.gz
/usr/share/man/man8/ovs-dpctl.8.gz
/usr/share/man/man8/ovs-ofctl.8.gz
/usr/share/man/man8/ovs-parse-backtrace.8.gz
/usr/share/man/man8/ovs-parse-leaks.8.gz
/usr/share/man/man1/ovs-pcap.1.gz
/usr/share/man/man1/ovs-tcpundump.1.gz
Expand Down

0 comments on commit 013061c

Please sign in to comment.