1
# Copyright (C) 2007, 2009, 2010 Canonical Ltd
1
# Copyright (C) 2007 Canonical Ltd
2
2
# Authors: Robert Collins <robert.collins@canonical.com>
4
4
# This program is free software; you can redistribute it and/or modify
14
14
# You should have received a copy of the GNU General Public License
15
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
16
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
18
"""Support for running strace against the current process."""
26
# this is currently test-focused, so importing bzrlib.tests is ok. We might
27
# want to move feature to its own module though.
28
from bzrlib.tests import Feature
28
31
def strace(function, *args, **kwargs):
31
34
: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
36
# capture strace output to a file
44
37
log_file = tempfile.NamedTemporaryFile()
45
err_file = tempfile.NamedTemporaryFile()
38
log_file_fd = log_file.fileno()
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())
41
proc = subprocess.Popen(['strace',
42
'-f', '-r', '-tt', '-p', str(pid), '-o', log_file.name
44
stdout=subprocess.PIPE,
45
stderr=subprocess.STDOUT)
56
46
# Wait for strace to attach
57
proc.stdout.readline()
47
attached_notice = proc.stdout.readline()
58
48
# Run the function to strace
59
49
result = function(*args, **kwargs)
65
55
log = log_file.read()
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"
57
return result, StraceResult(log)
82
60
class StraceResult(object):
83
61
"""The result of stracing a function."""
85
def __init__(self, raw_log, err_messages):
63
def __init__(self, raw_log):
86
64
"""Create a StraceResult.
88
66
:param raw_log: The output that strace created.
90
68
self.raw_log = raw_log
91
self.err_messages = err_messages
71
class _StraceFeature(Feature):
75
proc = subprocess.Popen(['strace'],
76
stderr=subprocess.PIPE,
77
stdout=subprocess.PIPE)
81
if e.errno == errno.ENOENT:
82
# strace is not installed
87
def feature_name(self):
90
StraceFeature = _StraceFeature()