← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/lsprof.py

(vila) Fix test failures blocking package builds. (Vincent Ladeuil)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/lsprof.py
3
3
# I made one modification to profile so that it returns a pair
4
4
# instead of just the Stats object
5
5
 
 
6
from __future__ import absolute_import
 
7
 
6
8
import cPickle
7
9
import os
8
10
import sys
10
12
import threading
11
13
from _lsprof import Profiler, profiler_entry
12
14
 
 
15
from bzrlib import errors
13
16
 
14
17
__all__ = ['profile', 'Stats']
15
18
 
16
 
_g_threadmap = {}
17
 
 
18
 
 
19
 
def _thread_profile(f, *args, **kwds):
20
 
    # we lose the first profile point for a new thread in order to trampoline
21
 
    # a new Profile object into place
22
 
    global _g_threadmap
23
 
    thr = thread.get_ident()
24
 
    _g_threadmap[thr] = p = Profiler()
25
 
    # this overrides our sys.setprofile hook:
26
 
    p.enable(subcalls=True, builtins=True)
27
 
 
28
 
 
29
19
def profile(f, *args, **kwds):
30
 
    """XXX docstring"""
31
 
    global _g_threadmap
32
 
    p = Profiler()
33
 
    p.enable(subcalls=True)
34
 
    threading.setprofile(_thread_profile)
35
 
    # Note: The except clause is needed below so that profiling data still
36
 
    # gets dumped even when exceptions are encountered. The except clause code
37
 
    # is taken straight from run_bzr_catch_errrors() in commands.py and ought
38
 
    # to be kept in sync with it.
 
20
    """Run a function profile.
 
21
 
 
22
    Exceptions are not caught: If you need stats even when exceptions are to be
 
23
    raised, pass in a closure that will catch the exceptions and transform them
 
24
    appropriately for your driver function.
 
25
 
 
26
    Important caveat: only one profile can execute at a time. See BzrProfiler
 
27
    for details.
 
28
 
 
29
    :return: The functions return value and a stats object.
 
30
    """
 
31
    profiler = BzrProfiler()
 
32
    profiler.start()
39
33
    try:
40
 
        try:
41
 
            ret = f(*args, **kwds)
42
 
        except (KeyboardInterrupt, Exception), e:
43
 
            import bzrlib.trace
44
 
            bzrlib.trace.report_exception(sys.exc_info(), sys.stderr)
45
 
            ret = 3
 
34
        ret = f(*args, **kwds)
46
35
    finally:
47
 
        p.disable()
48
 
        for pp in _g_threadmap.values():
49
 
            pp.disable()
50
 
        threading.setprofile(None)
 
36
        stats = profiler.stop()
 
37
    return ret, stats
 
38
 
 
39
 
 
40
class BzrProfiler(object):
 
41
    """Bzr utility wrapper around Profiler.
51
42
    
52
 
    threads = {}
53
 
    for tid, pp in _g_threadmap.items():
54
 
        threads[tid] = Stats(pp.getstats(), {})
55
 
    _g_threadmap = {}
56
 
    return ret, Stats(p.getstats(), threads)
 
43
    For most uses the module level 'profile()' function will be suitable.
 
44
    However profiling when a simple wrapped function isn't available may
 
45
    be easier to accomplish using this class.
 
46
 
 
47
    To use it, create a BzrProfiler and call start() on it. Some arbitrary
 
48
    time later call stop() to stop profiling and retrieve the statistics
 
49
    from the code executed in the interim.
 
50
 
 
51
    Note that profiling involves a threading.Lock around the actual profiling.
 
52
    This is needed because profiling involves global manipulation of the python
 
53
    interpreter state. As such you cannot perform multiple profiles at once.
 
54
    Trying to do so will lock out the second profiler unless the global 
 
55
    bzrlib.lsprof.BzrProfiler.profiler_block is set to 0. Setting it to 0 will
 
56
    cause profiling to fail rather than blocking.
 
57
    """
 
58
 
 
59
    profiler_block = 1
 
60
    """Serialise rather than failing to profile concurrent profile requests."""
 
61
 
 
62
    profiler_lock = threading.Lock()
 
63
    """Global lock used to serialise profiles."""
 
64
 
 
65
    def start(self):
 
66
        """Start profiling.
 
67
        
 
68
        This hooks into threading and will record all calls made until
 
69
        stop() is called.
 
70
        """
 
71
        self._g_threadmap = {}
 
72
        self.p = Profiler()
 
73
        permitted = self.__class__.profiler_lock.acquire(
 
74
            self.__class__.profiler_block)
 
75
        if not permitted:
 
76
            raise errors.InternalBzrError(msg="Already profiling something")
 
77
        try:
 
78
            self.p.enable(subcalls=True)
 
79
            threading.setprofile(self._thread_profile)
 
80
        except:
 
81
            self.__class__.profiler_lock.release()
 
82
            raise
 
83
 
 
84
    def stop(self):
 
85
        """Stop profiling.
 
86
 
 
87
        This unhooks from threading and cleans up the profiler, returning
 
88
        the gathered Stats object.
 
89
 
 
90
        :return: A bzrlib.lsprof.Stats object.
 
91
        """
 
92
        try:
 
93
            self.p.disable()
 
94
            for pp in self._g_threadmap.values():
 
95
                pp.disable()
 
96
            threading.setprofile(None)
 
97
            p = self.p
 
98
            self.p = None
 
99
            threads = {}
 
100
            for tid, pp in self._g_threadmap.items():
 
101
                threads[tid] = Stats(pp.getstats(), {})
 
102
            self._g_threadmap = None
 
103
            return Stats(p.getstats(), threads)
 
104
        finally:
 
105
            self.__class__.profiler_lock.release()
 
106
 
 
107
    def _thread_profile(self, f, *args, **kwds):
 
108
        # we lose the first profile point for a new thread in order to
 
109
        # trampoline a new Profile object into place
 
110
        thr = thread.get_ident()
 
111
        self._g_threadmap[thr] = p = Profiler()
 
112
        # this overrides our sys.setprofile hook:
 
113
        p.enable(subcalls=True, builtins=True)
57
114
 
58
115
 
59
116
class Stats(object):
60
 
    """XXX docstring"""
 
117
    """Wrapper around the collected data.
 
118
 
 
119
    A Stats instance is created when the profiler finishes. Normal
 
120
    usage is to use save() to write out the data to a file, or pprint()
 
121
    to write human-readable information to the command line.
 
122
    """
61
123
 
62
124
    def __init__(self, data, threads):
63
125
        self.data = data
64
126
        self.threads = threads
65
127
 
66
128
    def sort(self, crit="inlinetime"):
67
 
        """XXX docstring"""
 
129
        """Sort the data by the supplied critera.
 
130
 
 
131
        :param crit: the data attribute used as the sort key."""
68
132
        if crit not in profiler_entry.__dict__:
69
133
            raise ValueError, "Can't sort by %s" % crit
70
134
        self.data.sort(lambda b, a: cmp(getattr(a, crit),
75
139
                                              getattr(b, crit)))
76
140
 
77
141
    def pprint(self, top=None, file=None):
78
 
        """XXX docstring"""
 
142
        """Pretty-print the data as plain text for human consumption.
 
143
 
 
144
        :param top: only output the top n entries.
 
145
            The default value of None means output all data.
 
146
        :param file: the output file; if None, output will
 
147
            default to stdout."""
79
148
        if file is None:
80
149
            file = sys.stdout
81
150
        d = self.data
153
222
 
154
223
    This code is taken from http://ddaa.net/blog/python/lsprof-calltree
155
224
    with the changes made by J.P. Calderone and Itamar applied. Note that
156
 
    isinstance(code, str) needs to be used at times to determine if the code 
 
225
    isinstance(code, str) needs to be used at times to determine if the code
157
226
    object is actually an external code object (with a filename, etc.) or
158
227
    a Python built-in.
159
228
    """
163
232
        self.out_file = None
164
233
 
165
234
    def output(self, out_file):
166
 
        self.out_file = out_file        
 
235
        self.out_file = out_file
167
236
        out_file.write('events: Ticks\n')
168
237
        self._print_summary()
169
238
        for entry in self.data:
208
277
        code = subentry.code
209
278
        totaltime = int(subentry.totaltime * 1000)
210
279
        #out_file.write('cob=%s\n' % (code.co_filename,))
211
 
        out_file.write('cfn=%s\n' % (label(code, True),))
212
280
        if isinstance(code, str):
213
281
            out_file.write('cfi=~\n')
 
282
            out_file.write('cfn=%s\n' % (label(code, True),))
214
283
            out_file.write('calls=%d 0\n' % (subentry.callcount,))
215
284
        else:
216
285
            out_file.write('cfi=%s\n' % (code.co_filename,))
 
286
            out_file.write('cfn=%s\n' % (label(code, True),))
217
287
            out_file.write('calls=%d %d\n' % (
218
288
                subentry.callcount, code.co_firstlineno))
219
289
        out_file.write('%d %d\n' % (lineno, totaltime))