← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/strace.py

  • Committer: Martin Pool
  • Date: 2007-04-04 06:17:31 UTC
  • mto: This revision was merged to the branch mainline in revision 2397.
  • Revision ID: mbp@sourcefrog.net-20070404061731-tt2xrzllqhbodn83
Contents of TODO file moved into bug tracker

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/strace.py
1
 
# Copyright (C) 2007, 2009, 2010 Canonical Ltd
 
1
# Copyright (C) 2007 Canonical Ltd
2
2
#   Authors: Robert Collins <robert.collins@canonical.com>
3
3
#
4
4
# This program is free software; you can redistribute it and/or modify
13
13
#
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
17
17
 
18
18
"""Support for running strace against the current process."""
19
19
 
20
 
import errno
21
20
import os
22
21
import signal
23
22
import subprocess
24
23
import tempfile
25
24
 
26
 
from bzrlib import errors
27
 
 
28
 
 
29
25
# this is currently test-focused, so importing bzrlib.tests is ok. We might
30
26
# want to move feature to its own module though.
31
 
from bzrlib.tests.features import Feature
 
27
from bzrlib.tests import Feature
32
28
 
33
29
 
34
30
def strace(function, *args, **kwargs):
36
32
 
37
33
    :return: a tuple: function-result, a StraceResult.
38
34
    """
39
 
    return strace_detailed(function, args, kwargs)
40
 
 
41
 
 
42
 
def strace_detailed(function, args, kwargs, follow_children=True):
43
 
    # FIXME: strace is buggy
44
 
    # (https://bugs.launchpad.net/ubuntu/+source/strace/+bug/103133) and the
45
 
    # test suite hangs if the '-f' is given to strace *and* more than one
46
 
    # thread is running. Using follow_children=False allows the test suite to
47
 
    # disable fork following to work around the bug.
48
 
 
49
35
    # capture strace output to a file
50
 
    log_file = tempfile.NamedTemporaryFile()
 
36
    log_file = tempfile.TemporaryFile()
51
37
    log_file_fd = log_file.fileno()
52
 
    err_file = tempfile.NamedTemporaryFile()
53
38
    pid = os.getpid()
54
39
    # start strace
55
 
    strace_cmd = ['strace', '-r', '-tt', '-p', str(pid), '-o', log_file.name]
56
 
    if follow_children:
57
 
        strace_args.append('-f')
58
 
    # need to catch both stdout and stderr to work around
59
 
    # bug 627208
60
 
    proc = subprocess.Popen(strace_cmd,
61
 
                            stdout=subprocess.PIPE,
62
 
                            stderr=err_file.fileno())
63
 
    # Wait for strace to attach
64
 
    attached_notice = proc.stdout.readline()
65
 
    # Run the function to strace
 
40
    proc = subprocess.Popen(['strace',
 
41
        '-f', '-r', '-tt', '-p', str(pid),
 
42
        ],
 
43
        stderr=log_file_fd,
 
44
        stdout=log_file_fd)
 
45
    # TODO? confirm its started (test suite should be sufficient)
 
46
    # (can loop on proc.pid, but that may not indicate started and attached.)
66
47
    result = function(*args, **kwargs)
67
48
    # stop strace
68
49
    os.kill(proc.pid, signal.SIGQUIT)
71
52
    log_file.seek(0)
72
53
    log = log_file.read()
73
54
    log_file.close()
74
 
    # and stderr
75
 
    err_file.seek(0)
76
 
    err_messages = err_file.read()
77
 
    err_file.close()
78
 
    # and read any errors
79
 
    if err_messages.startswith("attach: ptrace(PTRACE_ATTACH,"):
80
 
        raise StraceError(err_messages=err_messages)
81
 
    return result, StraceResult(log, err_messages)
82
 
 
83
 
 
84
 
class StraceError(errors.BzrError):
85
 
    
86
 
    _fmt = "strace failed: %(err_messages)s"
 
55
    return result, StraceResult(log)
87
56
 
88
57
 
89
58
class StraceResult(object):
90
59
    """The result of stracing a function."""
91
60
 
92
 
    def __init__(self, raw_log, err_messages):
 
61
    def __init__(self, raw_log):
93
62
        """Create a StraceResult.
94
63
 
95
64
        :param raw_log: The output that strace created.
96
65
        """
97
66
        self.raw_log = raw_log
98
 
        self.err_messages = err_messages
99
 
 
100
 
 
 
67
 
 
68
 
 
69
class _StraceFeature(Feature):
 
70
 
 
71
    def _probe(self):
 
72
        try:
 
73
            proc = subprocess.Popen(['strace'],
 
74
                stderr=subprocess.PIPE,
 
75
                stdout=subprocess.PIPE)
 
76
            proc.communicate()
 
77
            return True
 
78
        except OSError, e:
 
79
            if e.errno == errno.ENOENT:
 
80
                # strace is not installed
 
81
                return False
 
82
            else:
 
83
                raise
 
84
 
 
85
    def feature_name(self):
 
86
        return 'strace'
 
87
 
 
88
StraceFeature = _StraceFeature()