← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/strace.py

  • Committer: Robert Collins
  • Date: 2007-03-23 00:18:31 UTC
  • mto: (2378.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 2379.
  • Revision ID: robertc@robertcollins.net-20070323001831-czc15dtustiat7j7
Added ``bzrlib.strace.strace`` which will strace a single callable and
return a StraceResult object which contains just the syscalls involved
in running it. (Robert Collins)

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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
17
 
 
18
"""Support for running strace against the current process."""
 
19
 
 
20
import os
 
21
import signal
 
22
import subprocess
 
23
import tempfile
 
24
 
 
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
 
 
29
def strace(function, *args, **kwargs):
 
30
    """Invoke strace on function.
 
31
 
 
32
    :return: A StraceResult.
 
33
    """
 
34
    # capture strace output to a file
 
35
    log_file = tempfile.TemporaryFile()
 
36
    log_file_fd = log_file.fileno()
 
37
    pid = os.getpid()
 
38
    # start strace
 
39
    proc = subprocess.Popen(['strace',
 
40
        '-f', '-r', '-tt', '-p', str(pid),
 
41
        ],
 
42
        stderr=log_file_fd,
 
43
        stdout=log_file_fd)
 
44
    # TODO? confirm its started (test suite should be sufficient)
 
45
    # (can loop on proc.pid, but that may not indicate started and attached.)
 
46
    function(*args, **kwargs)
 
47
    # stop strace
 
48
    os.kill(proc.pid, signal.SIGQUIT)
 
49
    proc.communicate()
 
50
    # grab the log
 
51
    log_file.seek(0)
 
52
    log = log_file.read()
 
53
    log_file.close()
 
54
    return StraceResult(log)
 
55
 
 
56
 
 
57
class StraceResult(object):
 
58
    """The result of stracing a function."""
 
59
 
 
60
    def __init__(self, raw_log):
 
61
        """Create a StraceResult.
 
62
 
 
63
        :param raw_log: The output that strace created.
 
64
        """
 
65
        self.raw_log = raw_log
 
66
 
 
67
 
 
68
class _StraceFeature(Feature):
 
69
 
 
70
    def _probe(self):
 
71
        try:
 
72
            proc = subprocess.Popen(['strace'],
 
73
                stderr=subprocess.PIPE,
 
74
                stdout=subprocess.PIPE)
 
75
            proc.communicate()
 
76
            return True
 
77
        except OSError, e:
 
78
            if e.errno == errno.ENOENT:
 
79
                # strace is not installed
 
80
                return False
 
81
            else:
 
82
                raise
 
83
 
 
84
    def feature_name(self):
 
85
        return 'strace'
 
86
 
 
87
StraceFeature = _StraceFeature()