← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/lsprof.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2007-07-19 16:09:34 UTC
  • mfrom: (2520.4.135 bzr.mpbundle)
  • Revision ID: pqm@pqm.ubuntu.com-20070719160934-d51fyijw69oto88p
Add new bundle and merge-directive formats

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
 
 
17
13
__all__ = ['profile', 'Stats']
18
14
 
 
15
_g_threadmap = {}
 
16
 
 
17
 
 
18
def _thread_profile(f, *args, **kwds):
 
19
    # we lose the first profile point for a new thread in order to trampoline
 
20
    # a new Profile object into place
 
21
    global _g_threadmap
 
22
    thr = thread.get_ident()
 
23
    _g_threadmap[thr] = p = Profiler()
 
24
    # this overrides our sys.setprofile hook:
 
25
    p.enable(subcalls=True, builtins=True)
 
26
 
 
27
 
19
28
def profile(f, *args, **kwds):
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()
 
29
    """XXX docstring"""
 
30
    global _g_threadmap
 
31
    p = Profiler()
 
32
    p.enable(subcalls=True)
 
33
    threading.setprofile(_thread_profile)
33
34
    try:
34
35
        ret = f(*args, **kwds)
35
36
    finally:
36
 
        stats = profiler.stop()
37
 
    return ret, stats
38
 
 
39
 
 
40
 
class BzrProfiler(object):
41
 
    """Bzr utility wrapper around Profiler.
 
37
        p.disable()
 
38
        for pp in _g_threadmap.values():
 
39
            pp.disable()
 
40
        threading.setprofile(None)
42
41
    
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)
 
42
    threads = {}
 
43
    for tid, pp in _g_threadmap.items():
 
44
        threads[tid] = Stats(pp.getstats(), {})
 
45
    _g_threadmap = {}
 
46
    return ret, Stats(p.getstats(), threads)
114
47
 
115
48
 
116
49
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
 
    """
 
50
    """XXX docstring"""
123
51
 
124
52
    def __init__(self, data, threads):
125
53
        self.data = data
126
54
        self.threads = threads
127
55
 
128
56
    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."""
 
57
        """XXX docstring"""
132
58
        if crit not in profiler_entry.__dict__:
133
59
            raise ValueError, "Can't sort by %s" % crit
134
60
        self.data.sort(lambda b, a: cmp(getattr(a, crit),
139
65
                                              getattr(b, crit)))
140
66
 
141
67
    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."""
 
68
        """XXX docstring"""
148
69
        if file is None:
149
70
            file = sys.stdout
150
71
        d = self.data
192
113
        :param format: 'txt' for a text representation;
193
114
            'callgrind' for calltree format;
194
115
            otherwise a pickled Python object. A format of None indicates
195
 
            that the format to use is to be found from the filename. If
196
 
            the name starts with callgrind.out, callgrind format is used
197
 
            otherwise the format is given by the filename extension.
 
116
            that the format to use is to be found from the extension of
 
117
            filename.
198
118
        """
199
119
        if format is None:
200
 
            basename = os.path.basename(filename)
201
 
            if basename.startswith('callgrind.out'):
202
 
                format = "callgrind"
203
 
            else:
204
 
                ext = os.path.splitext(filename)[1]
205
 
                if len(ext) > 1:
206
 
                    format = ext[1:]
 
120
            ext = os.path.splitext(filename)[1]
 
121
            if len(ext) > 1:
 
122
                format = ext[1:]
207
123
        outfile = open(filename, 'wb')
208
124
        try:
209
125
            if format == "callgrind":
222
138
 
223
139
    This code is taken from http://ddaa.net/blog/python/lsprof-calltree
224
140
    with the changes made by J.P. Calderone and Itamar applied. Note that
225
 
    isinstance(code, str) needs to be used at times to determine if the code
 
141
    isinstance(code, str) needs to be used at times to determine if the code 
226
142
    object is actually an external code object (with a filename, etc.) or
227
143
    a Python built-in.
228
144
    """
232
148
        self.out_file = None
233
149
 
234
150
    def output(self, out_file):
235
 
        self.out_file = out_file
236
 
        out_file.write('events: Ticks\n')
 
151
        self.out_file = out_file        
 
152
        print >> out_file, 'events: Ticks'
237
153
        self._print_summary()
238
154
        for entry in self.data:
239
155
            self._entry(entry)
243
159
        for entry in self.data:
244
160
            totaltime = int(entry.totaltime * 1000)
245
161
            max_cost = max(max_cost, totaltime)
246
 
        self.out_file.write('summary: %d\n' % (max_cost,))
 
162
        print >> self.out_file, 'summary: %d' % (max_cost,)
247
163
 
248
164
    def _entry(self, entry):
249
165
        out_file = self.out_file
250
166
        code = entry.code
251
167
        inlinetime = int(entry.inlinetime * 1000)
252
 
        #out_file.write('ob=%s\n' % (code.co_filename,))
253
 
        if isinstance(code, str):
254
 
            out_file.write('fi=~\n')
255
 
        else:
256
 
            out_file.write('fi=%s\n' % (code.co_filename,))
257
 
        out_file.write('fn=%s\n' % (label(code, True),))
258
 
        if isinstance(code, str):
259
 
            out_file.write('0  %s\n' % (inlinetime,))
260
 
        else:
261
 
            out_file.write('%d %d\n' % (code.co_firstlineno, inlinetime))
 
168
        #print >> out_file, 'ob=%s' % (code.co_filename,)
 
169
        if isinstance(code, str):
 
170
            print >> out_file, 'fi=~'
 
171
        else:
 
172
            print >> out_file, 'fi=%s' % (code.co_filename,)
 
173
        print >> out_file, 'fn=%s' % (label(code, True),)
 
174
        if isinstance(code, str):
 
175
            print >> out_file, '0 ', inlinetime
 
176
        else:
 
177
            print >> out_file, '%d %d' % (code.co_firstlineno, inlinetime)
262
178
        # recursive calls are counted in entry.calls
263
179
        if entry.calls:
264
180
            calls = entry.calls
270
186
            lineno = code.co_firstlineno
271
187
        for subentry in calls:
272
188
            self._subentry(lineno, subentry)
273
 
        out_file.write('\n')
 
189
        print >> out_file
274
190
 
275
191
    def _subentry(self, lineno, subentry):
276
192
        out_file = self.out_file
277
193
        code = subentry.code
278
194
        totaltime = int(subentry.totaltime * 1000)
279
 
        #out_file.write('cob=%s\n' % (code.co_filename,))
 
195
        #print >> out_file, 'cob=%s' % (code.co_filename,)
 
196
        print >> out_file, 'cfn=%s' % (label(code, True),)
280
197
        if isinstance(code, str):
281
 
            out_file.write('cfi=~\n')
282
 
            out_file.write('cfn=%s\n' % (label(code, True),))
283
 
            out_file.write('calls=%d 0\n' % (subentry.callcount,))
 
198
            print >> out_file, 'cfi=~'
 
199
            print >> out_file, 'calls=%d 0' % (subentry.callcount,)
284
200
        else:
285
 
            out_file.write('cfi=%s\n' % (code.co_filename,))
286
 
            out_file.write('cfn=%s\n' % (label(code, True),))
287
 
            out_file.write('calls=%d %d\n' % (
288
 
                subentry.callcount, code.co_firstlineno))
289
 
        out_file.write('%d %d\n' % (lineno, totaltime))
 
201
            print >> out_file, 'cfi=%s' % (code.co_filename,)
 
202
            print >> out_file, 'calls=%d %d' % (
 
203
                subentry.callcount, code.co_firstlineno)
 
204
        print >> out_file, '%d %d' % (lineno, totaltime)
290
205
 
291
206
_fn2mod = {}
292
207
 
318
233
    import os
319
234
    sys.argv = sys.argv[1:]
320
235
    if not sys.argv:
321
 
        sys.stderr.write("usage: lsprof.py <script> <arguments...>\n")
 
236
        print >> sys.stderr, "usage: lsprof.py <script> <arguments...>"
322
237
        sys.exit(2)
323
238
    sys.path.insert(0, os.path.abspath(os.path.dirname(sys.argv[0])))
324
239
    stats = profile(execfile, sys.argv[0], globals(), locals())