← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/lsprof.py

  • Committer: Patch Queue Manager
  • Date: 2015-10-05 13:45:00 UTC
  • mfrom: (6603.3.1 bts794146)
  • Revision ID: pqm@pqm.ubuntu.com-20151005134500-v244rho557tv0ukd
(vila) Resolve Bug #1480015: Test failure: hexify removed from paramiko
 (Andrew Starr-Bochicchio) (Andrew Starr-Bochicchio)

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
 
6
8
import cPickle
7
9
import os
8
10
import sys
10
12
import threading
11
13
from _lsprof import Profiler, profiler_entry
12
14
 
 
15
from bzrlib import errors
13
16
 
14
17
__all__ = ['profile', 'Stats']
15
18
 
20
23
    raised, pass in a closure that will catch the exceptions and transform them
21
24
    appropriately for your driver function.
22
25
 
 
26
    Important caveat: only one profile can execute at a time. See BzrProfiler
 
27
    for details.
 
28
 
23
29
    :return: The functions return value and a stats object.
24
30
    """
25
31
    profiler = BzrProfiler()
41
47
    To use it, create a BzrProfiler and call start() on it. Some arbitrary
42
48
    time later call stop() to stop profiling and retrieve the statistics
43
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.
44
57
    """
45
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
 
46
65
    def start(self):
47
66
        """Start profiling.
48
67
        
51
70
        """
52
71
        self._g_threadmap = {}
53
72
        self.p = Profiler()
54
 
        self.p.enable(subcalls=True)
55
 
        threading.setprofile(self._thread_profile)
 
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
56
83
 
57
84
    def stop(self):
58
85
        """Stop profiling.
62
89
 
63
90
        :return: A bzrlib.lsprof.Stats object.
64
91
        """
65
 
        self.p.disable()
66
 
        for pp in self._g_threadmap.values():
67
 
            pp.disable()
68
 
        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)
 
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()
76
106
 
77
107
    def _thread_profile(self, f, *args, **kwds):
78
108
        # we lose the first profile point for a new thread in order to
84
114
 
85
115
 
86
116
class Stats(object):
87
 
    """XXX docstring"""
 
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
    """
88
123
 
89
124
    def __init__(self, data, threads):
90
125
        self.data = data
91
126
        self.threads = threads
92
127
 
93
128
    def sort(self, crit="inlinetime"):
94
 
        """XXX docstring"""
 
129
        """Sort the data by the supplied critera.
 
130
 
 
131
        :param crit: the data attribute used as the sort key."""
95
132
        if crit not in profiler_entry.__dict__:
96
133
            raise ValueError, "Can't sort by %s" % crit
97
134
        self.data.sort(lambda b, a: cmp(getattr(a, crit),
102
139
                                              getattr(b, crit)))
103
140
 
104
141
    def pprint(self, top=None, file=None):
105
 
        """XXX docstring"""
 
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."""
106
148
        if file is None:
107
149
            file = sys.stdout
108
150
        d = self.data
235
277
        code = subentry.code
236
278
        totaltime = int(subentry.totaltime * 1000)
237
279
        #out_file.write('cob=%s\n' % (code.co_filename,))
238
 
        out_file.write('cfn=%s\n' % (label(code, True),))
239
280
        if isinstance(code, str):
240
281
            out_file.write('cfi=~\n')
 
282
            out_file.write('cfn=%s\n' % (label(code, True),))
241
283
            out_file.write('calls=%d 0\n' % (subentry.callcount,))
242
284
        else:
243
285
            out_file.write('cfi=%s\n' % (code.co_filename,))
 
286
            out_file.write('cfn=%s\n' % (label(code, True),))
244
287
            out_file.write('calls=%d %d\n' % (
245
288
                subentry.callcount, code.co_firstlineno))
246
289
        out_file.write('%d %d\n' % (lineno, totaltime))