← 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: 2006-07-20 13:00:31 UTC
  • mto: (1852.9.1 Tree.compare().)
  • mto: This revision was merged to the branch mainline in revision 1890.
  • Revision ID: robertc@robertcollins.net-20060720130031-d26103a427ea10f3
Start tree implementation tests.

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
 
 
14
11
__all__ = ['profile', 'Stats']
15
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
 
16
26
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()
 
27
    """XXX docstring"""
 
28
    global _g_threadmap
 
29
    p = Profiler()
 
30
    p.enable(subcalls=True)
 
31
    threading.setprofile(_thread_profile)
27
32
    try:
28
33
        ret = f(*args, **kwds)
29
34
    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():
 
35
        p.disable()
 
36
        for pp in _g_threadmap.values():
67
37
            pp.disable()
68
38
        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)
 
39
    
 
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)
84
45
 
85
46
 
86
47
class Stats(object):
143
104
        """Output profiling data in calltree format (for KCacheGrind)."""
144
105
        _CallTreeFilter(self.data).output(file)
145
106
 
146
 
    def save(self, filename, format=None):
147
 
        """Save profiling data to a file.
148
 
 
149
 
        :param filename: the name of the output file
150
 
        :param format: 'txt' for a text representation;
151
 
            'callgrind' for calltree format;
152
 
            otherwise a pickled Python object. A format of None indicates
153
 
            that the format to use is to be found from the filename. If
154
 
            the name starts with callgrind.out, callgrind format is used
155
 
            otherwise the format is given by the filename extension.
156
 
        """
157
 
        if format is None:
158
 
            basename = os.path.basename(filename)
159
 
            if basename.startswith('callgrind.out'):
160
 
                format = "callgrind"
161
 
            else:
162
 
                ext = os.path.splitext(filename)[1]
163
 
                if len(ext) > 1:
164
 
                    format = ext[1:]
165
 
        outfile = open(filename, 'wb')
166
 
        try:
167
 
            if format == "callgrind":
168
 
                self.calltree(outfile)
169
 
            elif format == "txt":
170
 
                self.pprint(file=outfile)
171
 
            else:
172
 
                self.freeze()
173
 
                cPickle.dump(self, outfile, 2)
174
 
        finally:
175
 
            outfile.close()
176
 
 
177
107
 
178
108
class _CallTreeFilter(object):
179
 
    """Converter of a Stats object to input suitable for KCacheGrind.
180
 
 
181
 
    This code is taken from http://ddaa.net/blog/python/lsprof-calltree
182
 
    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
184
 
    object is actually an external code object (with a filename, etc.) or
185
 
    a Python built-in.
186
 
    """
187
109
 
188
110
    def __init__(self, data):
189
111
        self.data = data
190
112
        self.out_file = None
191
113
 
192
114
    def output(self, out_file):
193
 
        self.out_file = out_file
194
 
        out_file.write('events: Ticks\n')
 
115
        self.out_file = out_file        
 
116
        print >> out_file, 'events: Ticks'
195
117
        self._print_summary()
196
118
        for entry in self.data:
197
119
            self._entry(entry)
201
123
        for entry in self.data:
202
124
            totaltime = int(entry.totaltime * 1000)
203
125
            max_cost = max(max_cost, totaltime)
204
 
        self.out_file.write('summary: %d\n' % (max_cost,))
 
126
        print >> self.out_file, 'summary: %d' % (max_cost,)
205
127
 
206
128
    def _entry(self, entry):
207
129
        out_file = self.out_file
208
130
        code = entry.code
209
131
        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))
 
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)
220
136
        # recursive calls are counted in entry.calls
221
137
        if entry.calls:
222
138
            calls = entry.calls
223
139
        else:
224
140
            calls = []
225
 
        if isinstance(code, str):
226
 
            lineno = 0
227
 
        else:
228
 
            lineno = code.co_firstlineno
229
141
        for subentry in calls:
230
 
            self._subentry(lineno, subentry)
231
 
        out_file.write('\n')
 
142
            self._subentry(code.co_firstlineno, subentry)
 
143
        print >> out_file
232
144
 
233
145
    def _subentry(self, lineno, subentry):
234
146
        out_file = self.out_file
235
147
        code = subentry.code
236
148
        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),))
239
 
        if isinstance(code, str):
240
 
            out_file.write('cfi=~\n')
241
 
            out_file.write('calls=%d 0\n' % (subentry.callcount,))
242
 
        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))
 
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
 
247
156
 
248
157
_fn2mod = {}
249
158
 
253
162
    try:
254
163
        mname = _fn2mod[code.co_filename]
255
164
    except KeyError:
256
 
        for k, v in sys.modules.items():
 
165
        for k, v in sys.modules.iteritems():
257
166
            if v is None:
258
167
                continue
259
 
            if getattr(v, '__file__', None) is None:
 
168
            if not hasattr(v, '__file__'):
260
169
                continue
261
170
            if not isinstance(v.__file__, str):
262
171
                continue
275
184
    import os
276
185
    sys.argv = sys.argv[1:]
277
186
    if not sys.argv:
278
 
        sys.stderr.write("usage: lsprof.py <script> <arguments...>\n")
 
187
        print >> sys.stderr, "usage: lsprof.py <script> <arguments...>"
279
188
        sys.exit(2)
280
189
    sys.path.insert(0, os.path.abspath(os.path.dirname(sys.argv[0])))
281
190
    stats = profile(execfile, sys.argv[0], globals(), locals())