← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/lsprof.py

  • Committer: Robert Collins
  • Date: 2009-09-30 21:38:49 UTC
  • mto: (4634.52.8 2.0)
  • mto: This revision was merged to the branch mainline in revision 4723.
  • Revision ID: robertc@robertcollins.net-20090930213849-0vyqtge2lfd16nx5
Review feedback.

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
 
 
8
6
import cPickle
9
7
import os
10
8
import sys
12
10
import threading
13
11
from _lsprof import Profiler, profiler_entry
14
12
 
15
 
from bzrlib import errors
16
13
 
17
14
__all__ = ['profile', 'Stats']
18
15
 
 
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
 
19
29
def profile(f, *args, **kwds):
20
30
    """Run a function profile.
21
31
 
22
32
    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.
 
33
    raised, passing in a closure that will catch the exceptions and transform
 
34
    them appropriately for your driver function.
28
35
 
29
36
    :return: The functions return value and a stats object.
30
37
    """
31
 
    profiler = BzrProfiler()
32
 
    profiler.start()
 
38
    global _g_threadmap
 
39
    p = Profiler()
 
40
    p.enable(subcalls=True)
 
41
    threading.setprofile(_thread_profile)
33
42
    try:
34
43
        ret = f(*args, **kwds)
35
44
    finally:
36
 
        stats = profiler.stop()
37
 
    return ret, stats
38
 
 
39
 
 
40
 
class BzrProfiler(object):
41
 
    """Bzr utility wrapper around Profiler.
42
 
    
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)
 
45
        p.disable()
 
46
        for pp in _g_threadmap.values():
 
47
            pp.disable()
 
48
        threading.setprofile(None)
 
49
 
 
50
    threads = {}
 
51
    for tid, pp in _g_threadmap.items():
 
52
        threads[tid] = Stats(pp.getstats(), {})
 
53
    _g_threadmap = {}
 
54
    return ret, Stats(p.getstats(), threads)
114
55
 
115
56
 
116
57
class Stats(object):
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
 
    """
 
58
    """XXX docstring"""
123
59
 
124
60
    def __init__(self, data, threads):
125
61
        self.data = data
126
62
        self.threads = threads
127
63
 
128
64
    def sort(self, crit="inlinetime"):
129
 
        """Sort the data by the supplied critera.
130
 
 
131
 
        :param crit: the data attribute used as the sort key."""
 
65
        """XXX docstring"""
132
66
        if crit not in profiler_entry.__dict__:
133
67
            raise ValueError, "Can't sort by %s" % crit
134
68
        self.data.sort(lambda b, a: cmp(getattr(a, crit),
139
73
                                              getattr(b, crit)))
140
74
 
141
75
    def pprint(self, top=None, file=None):
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."""
 
76
        """XXX docstring"""
148
77
        if file is None:
149
78
            file = sys.stdout
150
79
        d = self.data
277
206
        code = subentry.code
278
207
        totaltime = int(subentry.totaltime * 1000)
279
208
        #out_file.write('cob=%s\n' % (code.co_filename,))
 
209
        out_file.write('cfn=%s\n' % (label(code, True),))
280
210
        if isinstance(code, str):
281
211
            out_file.write('cfi=~\n')
282
 
            out_file.write('cfn=%s\n' % (label(code, True),))
283
212
            out_file.write('calls=%d 0\n' % (subentry.callcount,))
284
213
        else:
285
214
            out_file.write('cfi=%s\n' % (code.co_filename,))
286
 
            out_file.write('cfn=%s\n' % (label(code, True),))
287
215
            out_file.write('calls=%d %d\n' % (
288
216
                subentry.callcount, code.co_firstlineno))
289
217
        out_file.write('%d %d\n' % (lineno, totaltime))