← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/lsprof.py

  • Committer: Ian Clatworthy
  • Date: 2007-08-14 03:59:22 UTC
  • mto: (2733.1.1 ianc-integration)
  • mto: This revision was merged to the branch mainline in revision 2734.
  • Revision ID: ian.clatworthy@internode.on.net-20070814035922-siavg542cwvkf4r5
Fix pretty doc generation so works for all html docs

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/lsprof.py
10
10
import threading
11
11
from _lsprof import Profiler, profiler_entry
12
12
 
13
 
 
14
13
__all__ = ['profile', 'Stats']
15
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
 
16
28
def profile(f, *args, **kwds):
17
 
    """Run a function profile.
18
 
 
19
 
    Exceptions are not caught: If you need stats even when exceptions are to be
20
 
    raised, pass in a closure that will catch the exceptions and transform them
21
 
    appropriately for your driver function.
22
 
 
23
 
    :return: The functions return value and a stats object.
24
 
    """
25
 
    profiler = BzrProfiler()
26
 
    profiler.start()
 
29
    """XXX docstring"""
 
30
    global _g_threadmap
 
31
    p = Profiler()
 
32
    p.enable(subcalls=True)
 
33
    threading.setprofile(_thread_profile)
27
34
    try:
28
35
        ret = f(*args, **kwds)
29
36
    finally:
30
 
        stats = profiler.stop()
31
 
    return ret, stats
32
 
 
33
 
 
34
 
class BzrProfiler(object):
35
 
    """Bzr utility wrapper around Profiler.
36
 
    
37
 
    For most uses the module level 'profile()' function will be suitable.
38
 
    However profiling when a simple wrapped function isn't available may
39
 
    be easier to accomplish using this class.
40
 
 
41
 
    To use it, create a BzrProfiler and call start() on it. Some arbitrary
42
 
    time later call stop() to stop profiling and retrieve the statistics
43
 
    from the code executed in the interim.
44
 
    """
45
 
 
46
 
    def start(self):
47
 
        """Start profiling.
48
 
        
49
 
        This hooks into threading and will record all calls made until
50
 
        stop() is called.
51
 
        """
52
 
        self._g_threadmap = {}
53
 
        self.p = Profiler()
54
 
        self.p.enable(subcalls=True)
55
 
        threading.setprofile(self._thread_profile)
56
 
 
57
 
    def stop(self):
58
 
        """Stop profiling.
59
 
 
60
 
        This unhooks from threading and cleans up the profiler, returning
61
 
        the gathered Stats object.
62
 
 
63
 
        :return: A bzrlib.lsprof.Stats object.
64
 
        """
65
 
        self.p.disable()
66
 
        for pp in self._g_threadmap.values():
 
37
        p.disable()
 
38
        for pp in _g_threadmap.values():
67
39
            pp.disable()
68
40
        threading.setprofile(None)
69
 
        p = self.p
70
 
        self.p = None
71
 
        threads = {}
72
 
        for tid, pp in self._g_threadmap.items():
73
 
            threads[tid] = Stats(pp.getstats(), {})
74
 
        self._g_threadmap = None
75
 
        return Stats(p.getstats(), threads)
76
 
 
77
 
    def _thread_profile(self, f, *args, **kwds):
78
 
        # we lose the first profile point for a new thread in order to
79
 
        # trampoline a new Profile object into place
80
 
        thr = thread.get_ident()
81
 
        self._g_threadmap[thr] = p = Profiler()
82
 
        # this overrides our sys.setprofile hook:
83
 
        p.enable(subcalls=True, builtins=True)
 
41
    
 
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)
84
47
 
85
48
 
86
49
class Stats(object):
155
118
            otherwise the format is given by the filename extension.
156
119
        """
157
120
        if format is None:
158
 
            basename = os.path.basename(filename)
159
 
            if basename.startswith('callgrind.out'):
 
121
            if filename.startswith('callgrind.out'):
160
122
                format = "callgrind"
161
123
            else:
162
124
                ext = os.path.splitext(filename)[1]
180
142
 
181
143
    This code is taken from http://ddaa.net/blog/python/lsprof-calltree
182
144
    with the changes made by J.P. Calderone and Itamar applied. Note that
183
 
    isinstance(code, str) needs to be used at times to determine if the code
 
145
    isinstance(code, str) needs to be used at times to determine if the code 
184
146
    object is actually an external code object (with a filename, etc.) or
185
147
    a Python built-in.
186
148
    """
190
152
        self.out_file = None
191
153
 
192
154
    def output(self, out_file):
193
 
        self.out_file = out_file
194
 
        out_file.write('events: Ticks\n')
 
155
        self.out_file = out_file        
 
156
        print >> out_file, 'events: Ticks'
195
157
        self._print_summary()
196
158
        for entry in self.data:
197
159
            self._entry(entry)
201
163
        for entry in self.data:
202
164
            totaltime = int(entry.totaltime * 1000)
203
165
            max_cost = max(max_cost, totaltime)
204
 
        self.out_file.write('summary: %d\n' % (max_cost,))
 
166
        print >> self.out_file, 'summary: %d' % (max_cost,)
205
167
 
206
168
    def _entry(self, entry):
207
169
        out_file = self.out_file
208
170
        code = entry.code
209
171
        inlinetime = int(entry.inlinetime * 1000)
210
 
        #out_file.write('ob=%s\n' % (code.co_filename,))
211
 
        if isinstance(code, str):
212
 
            out_file.write('fi=~\n')
213
 
        else:
214
 
            out_file.write('fi=%s\n' % (code.co_filename,))
215
 
        out_file.write('fn=%s\n' % (label(code, True),))
216
 
        if isinstance(code, str):
217
 
            out_file.write('0  %s\n' % (inlinetime,))
218
 
        else:
219
 
            out_file.write('%d %d\n' % (code.co_firstlineno, inlinetime))
 
172
        #print >> out_file, 'ob=%s' % (code.co_filename,)
 
173
        if isinstance(code, str):
 
174
            print >> out_file, 'fi=~'
 
175
        else:
 
176
            print >> out_file, 'fi=%s' % (code.co_filename,)
 
177
        print >> out_file, 'fn=%s' % (label(code, True),)
 
178
        if isinstance(code, str):
 
179
            print >> out_file, '0 ', inlinetime
 
180
        else:
 
181
            print >> out_file, '%d %d' % (code.co_firstlineno, inlinetime)
220
182
        # recursive calls are counted in entry.calls
221
183
        if entry.calls:
222
184
            calls = entry.calls
228
190
            lineno = code.co_firstlineno
229
191
        for subentry in calls:
230
192
            self._subentry(lineno, subentry)
231
 
        out_file.write('\n')
 
193
        print >> out_file
232
194
 
233
195
    def _subentry(self, lineno, subentry):
234
196
        out_file = self.out_file
235
197
        code = subentry.code
236
198
        totaltime = int(subentry.totaltime * 1000)
237
 
        #out_file.write('cob=%s\n' % (code.co_filename,))
238
 
        out_file.write('cfn=%s\n' % (label(code, True),))
 
199
        #print >> out_file, 'cob=%s' % (code.co_filename,)
 
200
        print >> out_file, 'cfn=%s' % (label(code, True),)
239
201
        if isinstance(code, str):
240
 
            out_file.write('cfi=~\n')
241
 
            out_file.write('calls=%d 0\n' % (subentry.callcount,))
 
202
            print >> out_file, 'cfi=~'
 
203
            print >> out_file, 'calls=%d 0' % (subentry.callcount,)
242
204
        else:
243
 
            out_file.write('cfi=%s\n' % (code.co_filename,))
244
 
            out_file.write('calls=%d %d\n' % (
245
 
                subentry.callcount, code.co_firstlineno))
246
 
        out_file.write('%d %d\n' % (lineno, totaltime))
 
205
            print >> out_file, 'cfi=%s' % (code.co_filename,)
 
206
            print >> out_file, 'calls=%d %d' % (
 
207
                subentry.callcount, code.co_firstlineno)
 
208
        print >> out_file, '%d %d' % (lineno, totaltime)
247
209
 
248
210
_fn2mod = {}
249
211
 
275
237
    import os
276
238
    sys.argv = sys.argv[1:]
277
239
    if not sys.argv:
278
 
        sys.stderr.write("usage: lsprof.py <script> <arguments...>\n")
 
240
        print >> sys.stderr, "usage: lsprof.py <script> <arguments...>"
279
241
        sys.exit(2)
280
242
    sys.path.insert(0, os.path.abspath(os.path.dirname(sys.argv[0])))
281
243
    stats = profile(execfile, sys.argv[0], globals(), locals())