← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/lsprof.py

(mbp) more integrated 0.15 fixes

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
 
import cPickle
7
 
import os
8
6
import sys
9
7
import thread
10
8
import threading
11
9
from _lsprof import Profiler, profiler_entry
12
10
 
13
 
from bzrlib import errors
14
 
 
15
11
__all__ = ['profile', 'Stats']
16
12
 
 
13
_g_threadmap = {}
 
14
 
 
15
 
 
16
def _thread_profile(f, *args, **kwds):
 
17
    # we lose the first profile point for a new thread in order to trampoline
 
18
    # a new Profile object into place
 
19
    global _g_threadmap
 
20
    thr = thread.get_ident()
 
21
    _g_threadmap[thr] = p = Profiler()
 
22
    # this overrides our sys.setprofile hook:
 
23
    p.enable(subcalls=True, builtins=True)
 
24
 
 
25
 
17
26
def profile(f, *args, **kwds):
18
 
    """Run a function profile.
19
 
 
20
 
    Exceptions are not caught: If you need stats even when exceptions are to be
21
 
    raised, pass in a closure that will catch the exceptions and transform them
22
 
    appropriately for your driver function.
23
 
 
24
 
    Important caveat: only one profile can execute at a time. See BzrProfiler
25
 
    for details.
26
 
 
27
 
    :return: The functions return value and a stats object.
28
 
    """
29
 
    profiler = BzrProfiler()
30
 
    profiler.start()
 
27
    """XXX docstring"""
 
28
    global _g_threadmap
 
29
    p = Profiler()
 
30
    p.enable(subcalls=True)
 
31
    threading.setprofile(_thread_profile)
31
32
    try:
32
33
        ret = f(*args, **kwds)
33
34
    finally:
34
 
        stats = profiler.stop()
35
 
    return ret, stats
36
 
 
37
 
 
38
 
class BzrProfiler(object):
39
 
    """Bzr utility wrapper around Profiler.
 
35
        p.disable()
 
36
        for pp in _g_threadmap.values():
 
37
            pp.disable()
 
38
        threading.setprofile(None)
40
39
    
41
 
    For most uses the module level 'profile()' function will be suitable.
42
 
    However profiling when a simple wrapped function isn't available may
43
 
    be easier to accomplish using this class.
44
 
 
45
 
    To use it, create a BzrProfiler and call start() on it. Some arbitrary
46
 
    time later call stop() to stop profiling and retrieve the statistics
47
 
    from the code executed in the interim.
48
 
 
49
 
    Note that profiling involves a threading.Lock around the actual profiling.
50
 
    This is needed because profiling involves global manipulation of the python
51
 
    interpreter state. As such you cannot perform multiple profiles at once.
52
 
    Trying to do so will lock out the second profiler unless the global 
53
 
    bzrlib.lsprof.BzrProfiler.profiler_block is set to 0. Setting it to 0 will
54
 
    cause profiling to fail rather than blocking.
55
 
    """
56
 
 
57
 
    profiler_block = 1
58
 
    """Serialise rather than failing to profile concurrent profile requests."""
59
 
 
60
 
    profiler_lock = threading.Lock()
61
 
    """Global lock used to serialise profiles."""
62
 
 
63
 
    def start(self):
64
 
        """Start profiling.
65
 
        
66
 
        This hooks into threading and will record all calls made until
67
 
        stop() is called.
68
 
        """
69
 
        self._g_threadmap = {}
70
 
        self.p = Profiler()
71
 
        permitted = self.__class__.profiler_lock.acquire(
72
 
            self.__class__.profiler_block)
73
 
        if not permitted:
74
 
            raise errors.InternalBzrError(msg="Already profiling something")
75
 
        try:
76
 
            self.p.enable(subcalls=True)
77
 
            threading.setprofile(self._thread_profile)
78
 
        except:
79
 
            self.__class__.profiler_lock.release()
80
 
            raise
81
 
 
82
 
    def stop(self):
83
 
        """Stop profiling.
84
 
 
85
 
        This unhooks from threading and cleans up the profiler, returning
86
 
        the gathered Stats object.
87
 
 
88
 
        :return: A bzrlib.lsprof.Stats object.
89
 
        """
90
 
        try:
91
 
            self.p.disable()
92
 
            for pp in self._g_threadmap.values():
93
 
                pp.disable()
94
 
            threading.setprofile(None)
95
 
            p = self.p
96
 
            self.p = None
97
 
            threads = {}
98
 
            for tid, pp in self._g_threadmap.items():
99
 
                threads[tid] = Stats(pp.getstats(), {})
100
 
            self._g_threadmap = None
101
 
            return Stats(p.getstats(), threads)
102
 
        finally:
103
 
            self.__class__.profiler_lock.release()
104
 
 
105
 
    def _thread_profile(self, f, *args, **kwds):
106
 
        # we lose the first profile point for a new thread in order to
107
 
        # trampoline a new Profile object into place
108
 
        thr = thread.get_ident()
109
 
        self._g_threadmap[thr] = p = Profiler()
110
 
        # this overrides our sys.setprofile hook:
111
 
        p.enable(subcalls=True, builtins=True)
 
40
    threads = {}
 
41
    for tid, pp in _g_threadmap.items():
 
42
        threads[tid] = Stats(pp.getstats(), {})
 
43
    _g_threadmap = {}
 
44
    return ret, Stats(p.getstats(), threads)
112
45
 
113
46
 
114
47
class Stats(object):
115
 
    """Wrapper around the collected data.
116
 
 
117
 
    A Stats instance is created when the profiler finishes. Normal
118
 
    usage is to use save() to write out the data to a file, or pprint()
119
 
    to write human-readable information to the command line.
120
 
    """
 
48
    """XXX docstring"""
121
49
 
122
50
    def __init__(self, data, threads):
123
51
        self.data = data
124
52
        self.threads = threads
125
53
 
126
54
    def sort(self, crit="inlinetime"):
127
 
        """Sort the data by the supplied critera.
128
 
 
129
 
        :param crit: the data attribute used as the sort key."""
 
55
        """XXX docstring"""
130
56
        if crit not in profiler_entry.__dict__:
131
57
            raise ValueError, "Can't sort by %s" % crit
132
58
        self.data.sort(lambda b, a: cmp(getattr(a, crit),
137
63
                                              getattr(b, crit)))
138
64
 
139
65
    def pprint(self, top=None, file=None):
140
 
        """Pretty-print the data as plain text for human consumption.
141
 
 
142
 
        :param top: only output the top n entries.
143
 
            The default value of None means output all data.
144
 
        :param file: the output file; if None, output will
145
 
            default to stdout."""
 
66
        """XXX docstring"""
146
67
        if file is None:
147
68
            file = sys.stdout
148
69
        d = self.data
183
104
        """Output profiling data in calltree format (for KCacheGrind)."""
184
105
        _CallTreeFilter(self.data).output(file)
185
106
 
186
 
    def save(self, filename, format=None):
187
 
        """Save profiling data to a file.
188
 
 
189
 
        :param filename: the name of the output file
190
 
        :param format: 'txt' for a text representation;
191
 
            'callgrind' for calltree format;
192
 
            otherwise a pickled Python object. A format of None indicates
193
 
            that the format to use is to be found from the filename. If
194
 
            the name starts with callgrind.out, callgrind format is used
195
 
            otherwise the format is given by the filename extension.
196
 
        """
197
 
        if format is None:
198
 
            basename = os.path.basename(filename)
199
 
            if basename.startswith('callgrind.out'):
200
 
                format = "callgrind"
201
 
            else:
202
 
                ext = os.path.splitext(filename)[1]
203
 
                if len(ext) > 1:
204
 
                    format = ext[1:]
205
 
        outfile = open(filename, 'wb')
206
 
        try:
207
 
            if format == "callgrind":
208
 
                self.calltree(outfile)
209
 
            elif format == "txt":
210
 
                self.pprint(file=outfile)
211
 
            else:
212
 
                self.freeze()
213
 
                cPickle.dump(self, outfile, 2)
214
 
        finally:
215
 
            outfile.close()
216
 
 
217
107
 
218
108
class _CallTreeFilter(object):
219
 
    """Converter of a Stats object to input suitable for KCacheGrind.
220
 
 
221
 
    This code is taken from http://ddaa.net/blog/python/lsprof-calltree
222
 
    with the changes made by J.P. Calderone and Itamar applied. Note that
223
 
    isinstance(code, str) needs to be used at times to determine if the code
224
 
    object is actually an external code object (with a filename, etc.) or
225
 
    a Python built-in.
226
 
    """
227
109
 
228
110
    def __init__(self, data):
229
111
        self.data = data
230
112
        self.out_file = None
231
113
 
232
114
    def output(self, out_file):
233
 
        self.out_file = out_file
234
 
        out_file.write('events: Ticks\n')
 
115
        self.out_file = out_file        
 
116
        print >> out_file, 'events: Ticks'
235
117
        self._print_summary()
236
118
        for entry in self.data:
237
119
            self._entry(entry)
241
123
        for entry in self.data:
242
124
            totaltime = int(entry.totaltime * 1000)
243
125
            max_cost = max(max_cost, totaltime)
244
 
        self.out_file.write('summary: %d\n' % (max_cost,))
 
126
        print >> self.out_file, 'summary: %d' % (max_cost,)
245
127
 
246
128
    def _entry(self, entry):
247
129
        out_file = self.out_file
248
130
        code = entry.code
249
131
        inlinetime = int(entry.inlinetime * 1000)
250
 
        #out_file.write('ob=%s\n' % (code.co_filename,))
251
 
        if isinstance(code, str):
252
 
            out_file.write('fi=~\n')
253
 
        else:
254
 
            out_file.write('fi=%s\n' % (code.co_filename,))
255
 
        out_file.write('fn=%s\n' % (label(code, True),))
256
 
        if isinstance(code, str):
257
 
            out_file.write('0  %s\n' % (inlinetime,))
258
 
        else:
259
 
            out_file.write('%d %d\n' % (code.co_firstlineno, inlinetime))
 
132
        #print >> out_file, 'ob=%s' % (code.co_filename,)
 
133
        print >> out_file, 'fi=%s' % (code.co_filename,)
 
134
        print >> out_file, 'fn=%s' % (label(code, True),)
 
135
        print >> out_file, '%d %d' % (code.co_firstlineno, inlinetime)
260
136
        # recursive calls are counted in entry.calls
261
137
        if entry.calls:
262
138
            calls = entry.calls
263
139
        else:
264
140
            calls = []
265
 
        if isinstance(code, str):
266
 
            lineno = 0
267
 
        else:
268
 
            lineno = code.co_firstlineno
269
141
        for subentry in calls:
270
 
            self._subentry(lineno, subentry)
271
 
        out_file.write('\n')
 
142
            self._subentry(code.co_firstlineno, subentry)
 
143
        print >> out_file
272
144
 
273
145
    def _subentry(self, lineno, subentry):
274
146
        out_file = self.out_file
275
147
        code = subentry.code
276
148
        totaltime = int(subentry.totaltime * 1000)
277
 
        #out_file.write('cob=%s\n' % (code.co_filename,))
278
 
        if isinstance(code, str):
279
 
            out_file.write('cfi=~\n')
280
 
            out_file.write('cfn=%s\n' % (label(code, True),))
281
 
            out_file.write('calls=%d 0\n' % (subentry.callcount,))
282
 
        else:
283
 
            out_file.write('cfi=%s\n' % (code.co_filename,))
284
 
            out_file.write('cfn=%s\n' % (label(code, True),))
285
 
            out_file.write('calls=%d %d\n' % (
286
 
                subentry.callcount, code.co_firstlineno))
287
 
        out_file.write('%d %d\n' % (lineno, totaltime))
 
149
        #print >> out_file, 'cob=%s' % (code.co_filename,)
 
150
        print >> out_file, 'cfn=%s' % (label(code, True),)
 
151
        print >> out_file, 'cfi=%s' % (code.co_filename,)
 
152
        print >> out_file, 'calls=%d %d' % (
 
153
            subentry.callcount, code.co_firstlineno)
 
154
        print >> out_file, '%d %d' % (lineno, totaltime)
 
155
 
288
156
 
289
157
_fn2mod = {}
290
158
 
316
184
    import os
317
185
    sys.argv = sys.argv[1:]
318
186
    if not sys.argv:
319
 
        sys.stderr.write("usage: lsprof.py <script> <arguments...>\n")
 
187
        print >> sys.stderr, "usage: lsprof.py <script> <arguments...>"
320
188
        sys.exit(2)
321
189
    sys.path.insert(0, os.path.abspath(os.path.dirname(sys.argv[0])))
322
190
    stats = profile(execfile, sys.argv[0], globals(), locals())