/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/strace.py

A quick note about how I'd *like* to do things.

Basically, if I could procedurally declare my API, then all of the boilerplate
could be easily generated from that. However, it needs to be 'static' in a C
header file, and to get that you'd have to generate it from some other source
or have a *lot* more voodoo in your C pre-processor code. Shame that C sucks so
much. Note that Pyrex gets this right, where doing all the boilerplate amounts
to adding 'api' to your definition. Aka
    cdef api object myfunc(int foo)
Is enough to generate all the boilerplate C headers, etc you would need.
It is unfortunate I can't really use that here, because I want a pure C class
to avoid the python garbage collector.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/strace.py
 
1
# Copyright (C) 2007 Canonical Ltd
 
2
#   Authors: Robert Collins <robert.collins@canonical.com>
 
3
#
 
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.
 
8
#
 
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.
 
13
#
 
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
 
17
 
 
18
"""Support for running strace against the current process."""
 
19
 
 
20
import errno
 
21
import os
 
22
import signal
 
23
import subprocess
 
24
import tempfile
 
25
 
 
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
 
29
 
 
30
 
 
31
def strace(function, *args, **kwargs):
 
32
    """Invoke strace on function.
 
33
 
 
34
    :return: a tuple: function-result, a StraceResult.
 
35
    """
 
36
    return strace_detailed(function, args, kwargs)
 
37
 
 
38
 
 
39
def strace_detailed(function, args, kwargs, follow_children=True):
 
40
    # FIXME: strace is buggy
 
41
    # (https://bugs.launchpad.net/ubuntu/+source/strace/+bug/103133) and the
 
42
    # test suite hangs if the '-f' is given to strace *and* more than one
 
43
    # thread is running. Using follow_children=False allows the test suite to
 
44
    # disable fork following to work around the bug.
 
45
 
 
46
    # capture strace output to a file
 
47
    log_file = tempfile.NamedTemporaryFile()
 
48
    log_file_fd = log_file.fileno()
 
49
    pid = os.getpid()
 
50
    # start strace
 
51
    strace_cmd = ['strace', '-r', '-tt', '-p', str(pid), '-o', log_file.name]
 
52
    if follow_children:
 
53
        strace_args.append('-f')
 
54
    proc = subprocess.Popen(strace_cmd,
 
55
                            stdout=subprocess.PIPE,
 
56
                            stderr=subprocess.STDOUT)
 
57
    # Wait for strace to attach
 
58
    attached_notice = proc.stdout.readline()
 
59
    # Run the function to strace
 
60
    result = function(*args, **kwargs)
 
61
    # stop strace
 
62
    os.kill(proc.pid, signal.SIGQUIT)
 
63
    proc.communicate()
 
64
    # grab the log
 
65
    log_file.seek(0)
 
66
    log = log_file.read()
 
67
    log_file.close()
 
68
    return result, StraceResult(log)
 
69
 
 
70
 
 
71
class StraceResult(object):
 
72
    """The result of stracing a function."""
 
73
 
 
74
    def __init__(self, raw_log):
 
75
        """Create a StraceResult.
 
76
 
 
77
        :param raw_log: The output that strace created.
 
78
        """
 
79
        self.raw_log = raw_log
 
80
 
 
81
 
 
82
class _StraceFeature(Feature):
 
83
 
 
84
    def _probe(self):
 
85
        try:
 
86
            proc = subprocess.Popen(['strace'],
 
87
                stderr=subprocess.PIPE,
 
88
                stdout=subprocess.PIPE)
 
89
            proc.communicate()
 
90
            return True
 
91
        except OSError, e:
 
92
            if e.errno == errno.ENOENT:
 
93
                # strace is not installed
 
94
                return False
 
95
            else:
 
96
                raise
 
97
 
 
98
    def feature_name(self):
 
99
        return 'strace'
 
100
 
 
101
StraceFeature = _StraceFeature()