1
# Copyright (C) 2007, 2009, 2010 Canonical Ltd
2
# Authors: Robert Collins <robert.collins@canonical.com>
4
# This program is free software; you can redistribute it and/or modify
5
# it under the terms of the GNU General Public License as published by
6
# the Free Software Foundation; either version 2 of the License, or
7
# (at your option) any later version.
9
# This program is distributed in the hope that it will be useful,
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12
# GNU General Public License for more details.
14
# You should have received a copy of the GNU General Public License
15
# along with this program; if not, write to the Free Software
16
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
"""Support for running strace against the current process."""
28
def strace(function, *args, **kwargs):
29
"""Invoke strace on function.
31
:return: a tuple: function-result, a StraceResult.
33
return strace_detailed(function, args, kwargs)
36
def strace_detailed(function, args, kwargs, follow_children=True):
37
# FIXME: strace is buggy
38
# (https://bugs.launchpad.net/ubuntu/+source/strace/+bug/103133) and the
39
# test suite hangs if the '-f' is given to strace *and* more than one
40
# thread is running. Using follow_children=False allows the test suite to
41
# disable fork following to work around the bug.
43
# capture strace output to a file
44
log_file = tempfile.NamedTemporaryFile()
45
err_file = tempfile.NamedTemporaryFile()
48
strace_cmd = ['strace', '-r', '-tt', '-p', str(pid), '-o', log_file.name]
50
strace_cmd.append('-f')
51
# need to catch both stdout and stderr to work around
53
proc = subprocess.Popen(strace_cmd,
54
stdout=subprocess.PIPE,
55
stderr=err_file.fileno())
56
# Wait for strace to attach
57
proc.stdout.readline()
58
# Run the function to strace
59
result = function(*args, **kwargs)
61
os.kill(proc.pid, signal.SIGQUIT)
69
err_messages = err_file.read()
72
if err_messages.startswith("attach: ptrace(PTRACE_ATTACH,"):
73
raise StraceError(err_messages=err_messages)
74
return result, StraceResult(log, err_messages)
77
class StraceError(errors.BzrError):
79
_fmt = "strace failed: %(err_messages)s"
82
class StraceResult(object):
83
"""The result of stracing a function."""
85
def __init__(self, raw_log, err_messages):
86
"""Create a StraceResult.
88
:param raw_log: The output that strace created.
90
self.raw_log = raw_log
91
self.err_messages = err_messages