← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/strace.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2007-03-28 06:58:22 UTC
  • mfrom: (2379.2.3 hpss-chroot)
  • Revision ID: pqm@pqm.ubuntu.com-20070328065822-999550a858a3ced3
(robertc) Fix chroot urls to not expose the url of the transport they are protecting, allowing regular url operations to work on them. (Robert Collins, Andrew Bennetts)

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
 
from __future__ import absolute_import
21
 
 
22
20
import os
23
21
import signal
24
22
import subprocess
25
23
import tempfile
26
24
 
27
 
from bzrlib import errors
 
25
# this is currently test-focused, so importing bzrlib.tests is ok. We might
 
26
# want to move feature to its own module though.
 
27
from bzrlib.tests import Feature
28
28
 
29
29
 
30
30
def strace(function, *args, **kwargs):
32
32
 
33
33
    :return: a tuple: function-result, a StraceResult.
34
34
    """
35
 
    return strace_detailed(function, args, kwargs)
36
 
 
37
 
 
38
 
def strace_detailed(function, args, kwargs, follow_children=True):
39
 
    # FIXME: strace is buggy
40
 
    # (https://bugs.launchpad.net/ubuntu/+source/strace/+bug/103133) and the
41
 
    # test suite hangs if the '-f' is given to strace *and* more than one
42
 
    # thread is running. Using follow_children=False allows the test suite to
43
 
    # disable fork following to work around the bug.
44
 
 
45
35
    # capture strace output to a file
46
 
    log_file = tempfile.NamedTemporaryFile()
 
36
    log_file = tempfile.TemporaryFile()
47
37
    log_file_fd = log_file.fileno()
48
 
    err_file = tempfile.NamedTemporaryFile()
49
38
    pid = os.getpid()
50
39
    # start strace
51
 
    strace_cmd = ['strace', '-r', '-tt', '-p', str(pid), '-o', log_file.name]
52
 
    if follow_children:
53
 
        strace_cmd.append('-f')
54
 
    # need to catch both stdout and stderr to work around
55
 
    # bug 627208
56
 
    proc = subprocess.Popen(strace_cmd,
57
 
                            stdout=subprocess.PIPE,
58
 
                            stderr=err_file.fileno())
59
 
    # Wait for strace to attach
60
 
    attached_notice = proc.stdout.readline()
61
 
    # 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.)
62
47
    result = function(*args, **kwargs)
63
48
    # stop strace
64
49
    os.kill(proc.pid, signal.SIGQUIT)
67
52
    log_file.seek(0)
68
53
    log = log_file.read()
69
54
    log_file.close()
70
 
    # and stderr
71
 
    err_file.seek(0)
72
 
    err_messages = err_file.read()
73
 
    err_file.close()
74
 
    # and read any errors
75
 
    if err_messages.startswith("attach: ptrace(PTRACE_ATTACH,"):
76
 
        raise StraceError(err_messages=err_messages)
77
 
    return result, StraceResult(log, err_messages)
78
 
 
79
 
 
80
 
class StraceError(errors.BzrError):
81
 
    
82
 
    _fmt = "strace failed: %(err_messages)s"
 
55
    return result, StraceResult(log)
83
56
 
84
57
 
85
58
class StraceResult(object):
86
59
    """The result of stracing a function."""
87
60
 
88
 
    def __init__(self, raw_log, err_messages):
 
61
    def __init__(self, raw_log):
89
62
        """Create a StraceResult.
90
63
 
91
64
        :param raw_log: The output that strace created.
92
65
        """
93
66
        self.raw_log = raw_log
94
 
        self.err_messages = err_messages
95
 
 
96
 
 
 
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()