← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/lsprof.py

  • Committer: Andrew Bennetts
  • Date: 2007-10-29 08:34:38 UTC
  • mto: (2535.4.22 streaming-smart-fetch)
  • mto: This revision was merged to the branch mainline in revision 2981.
  • Revision ID: andrew.bennetts@canonical.com-20071029083438-ke1vsv97dvgrvup5
Improve some docstrings.

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
 
13
 
 
14
import bzrlib.osutils
 
15
 
16
16
 
17
17
__all__ = ['profile', 'Stats']
18
18
 
 
19
_g_threadmap = {}
 
20
 
 
21
 
 
22
def _thread_profile(f, *args, **kwds):
 
23
    # we lose the first profile point for a new thread in order to trampoline
 
24
    # a new Profile object into place
 
25
    global _g_threadmap
 
26
    thr = thread.get_ident()
 
27
    _g_threadmap[thr] = p = Profiler()
 
28
    # this overrides our sys.setprofile hook:
 
29
    p.enable(subcalls=True, builtins=True)
 
30
 
 
31
 
19
32
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()
 
33
    """XXX docstring"""
 
34
    global _g_threadmap
 
35
    p = Profiler()
 
36
    p.enable(subcalls=True)
 
37
    threading.setprofile(_thread_profile)
 
38
    # Note: The except clause is needed below so that profiling data still
 
39
    # gets dumped even when exceptions are encountered. The except clause code
 
40
    # is taken straight from run_bzr_catch_errrors() in commands.py and ought
 
41
    # to be kept in sync with it.
33
42
    try:
34
 
        ret = f(*args, **kwds)
 
43
        try:
 
44
            ret = f(*args, **kwds)
 
45
        except (KeyboardInterrupt, Exception), e:
 
46
            import bzrlib.trace
 
47
            bzrlib.trace.report_exception(sys.exc_info(), sys.stderr)
 
48
            ret = 3
35
49
    finally:
36
 
        stats = profiler.stop()
37
 
    return ret, stats
38
 
 
39
 
 
40
 
class BzrProfiler(object):
41
 
    """Bzr utility wrapper around Profiler.
 
50
        p.disable()
 
51
        for pp in _g_threadmap.values():
 
52
            pp.disable()
 
53
        threading.setprofile(None)
42
54
    
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)
 
55
    threads = {}
 
56
    for tid, pp in _g_threadmap.items():
 
57
        threads[tid] = Stats(pp.getstats(), {})
 
58
    _g_threadmap = {}
 
59
    return ret, Stats(p.getstats(), threads)
114
60
 
115
61
 
116
62
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
 
    """
 
63
    """XXX docstring"""
123
64
 
124
65
    def __init__(self, data, threads):
125
66
        self.data = data
126
67
        self.threads = threads
127
68
 
128
69
    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."""
 
70
        """XXX docstring"""
132
71
        if crit not in profiler_entry.__dict__:
133
72
            raise ValueError, "Can't sort by %s" % crit
134
73
        self.data.sort(lambda b, a: cmp(getattr(a, crit),
139
78
                                              getattr(b, crit)))
140
79
 
141
80
    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."""
 
81
        """XXX docstring"""
148
82
        if file is None:
149
83
            file = sys.stdout
150
84
        d = self.data
197
131
            otherwise the format is given by the filename extension.
198
132
        """
199
133
        if format is None:
200
 
            basename = os.path.basename(filename)
 
134
            basename = bzrlib.osutils.basename(filename)
201
135
            if basename.startswith('callgrind.out'):
202
136
                format = "callgrind"
203
137
            else:
204
 
                ext = os.path.splitext(filename)[1]
 
138
                ext = bzrlib.osutils.splitext(filename)[1]
205
139
                if len(ext) > 1:
206
140
                    format = ext[1:]
207
141
        outfile = open(filename, 'wb')
222
156
 
223
157
    This code is taken from http://ddaa.net/blog/python/lsprof-calltree
224
158
    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
 
159
    isinstance(code, str) needs to be used at times to determine if the code 
226
160
    object is actually an external code object (with a filename, etc.) or
227
161
    a Python built-in.
228
162
    """
232
166
        self.out_file = None
233
167
 
234
168
    def output(self, out_file):
235
 
        self.out_file = out_file
236
 
        out_file.write('events: Ticks\n')
 
169
        self.out_file = out_file        
 
170
        print >> out_file, 'events: Ticks'
237
171
        self._print_summary()
238
172
        for entry in self.data:
239
173
            self._entry(entry)
243
177
        for entry in self.data:
244
178
            totaltime = int(entry.totaltime * 1000)
245
179
            max_cost = max(max_cost, totaltime)
246
 
        self.out_file.write('summary: %d\n' % (max_cost,))
 
180
        print >> self.out_file, 'summary: %d' % (max_cost,)
247
181
 
248
182
    def _entry(self, entry):
249
183
        out_file = self.out_file
250
184
        code = entry.code
251
185
        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))
 
186
        #print >> out_file, 'ob=%s' % (code.co_filename,)
 
187
        if isinstance(code, str):
 
188
            print >> out_file, 'fi=~'
 
189
        else:
 
190
            print >> out_file, 'fi=%s' % (code.co_filename,)
 
191
        print >> out_file, 'fn=%s' % (label(code, True),)
 
192
        if isinstance(code, str):
 
193
            print >> out_file, '0 ', inlinetime
 
194
        else:
 
195
            print >> out_file, '%d %d' % (code.co_firstlineno, inlinetime)
262
196
        # recursive calls are counted in entry.calls
263
197
        if entry.calls:
264
198
            calls = entry.calls
270
204
            lineno = code.co_firstlineno
271
205
        for subentry in calls:
272
206
            self._subentry(lineno, subentry)
273
 
        out_file.write('\n')
 
207
        print >> out_file
274
208
 
275
209
    def _subentry(self, lineno, subentry):
276
210
        out_file = self.out_file
277
211
        code = subentry.code
278
212
        totaltime = int(subentry.totaltime * 1000)
279
 
        #out_file.write('cob=%s\n' % (code.co_filename,))
 
213
        #print >> out_file, 'cob=%s' % (code.co_filename,)
 
214
        print >> out_file, 'cfn=%s' % (label(code, True),)
280
215
        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,))
 
216
            print >> out_file, 'cfi=~'
 
217
            print >> out_file, 'calls=%d 0' % (subentry.callcount,)
284
218
        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))
 
219
            print >> out_file, 'cfi=%s' % (code.co_filename,)
 
220
            print >> out_file, 'calls=%d %d' % (
 
221
                subentry.callcount, code.co_firstlineno)
 
222
        print >> out_file, '%d %d' % (lineno, totaltime)
290
223
 
291
224
_fn2mod = {}
292
225
 
318
251
    import os
319
252
    sys.argv = sys.argv[1:]
320
253
    if not sys.argv:
321
 
        sys.stderr.write("usage: lsprof.py <script> <arguments...>\n")
 
254
        print >> sys.stderr, "usage: lsprof.py <script> <arguments...>"
322
255
        sys.exit(2)
323
256
    sys.path.insert(0, os.path.abspath(os.path.dirname(sys.argv[0])))
324
257
    stats = profile(execfile, sys.argv[0], globals(), locals())