← 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: 2010-10-08 04:25:10 UTC
  • mto: This revision was merged to the branch mainline in revision 5472.
  • Revision ID: andrew.bennetts@canonical.com-20101008042510-sg9vdhmnggilzxsk
Fix stray TAB in source.

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
from bzrlib import errors
13
14
 
14
15
__all__ = ['profile', 'Stats']
15
16
 
16
 
_g_threadmap = {}
17
 
 
18
 
 
19
 
def _thread_profile(f, *args, **kwds):
20
 
    # we lose the first profile point for a new thread in order to trampoline
21
 
    # a new Profile object into place
22
 
    global _g_threadmap
23
 
    thr = thread.get_ident()
24
 
    _g_threadmap[thr] = p = Profiler()
25
 
    # this overrides our sys.setprofile hook:
26
 
    p.enable(subcalls=True, builtins=True)
27
 
 
28
 
 
29
17
def profile(f, *args, **kwds):
30
18
    """Run a function profile.
31
19
 
32
20
    Exceptions are not caught: If you need stats even when exceptions are to be
33
 
    raised, passing in a closure that will catch the exceptions and transform
34
 
    them appropriately for your driver function.
 
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.
35
26
 
36
27
    :return: The functions return value and a stats object.
37
28
    """
38
 
    global _g_threadmap
39
 
    p = Profiler()
40
 
    p.enable(subcalls=True)
41
 
    threading.setprofile(_thread_profile)
 
29
    profiler = BzrProfiler()
 
30
    profiler.start()
42
31
    try:
43
32
        ret = f(*args, **kwds)
44
33
    finally:
45
 
        p.disable()
46
 
        for pp in _g_threadmap.values():
47
 
            pp.disable()
48
 
        threading.setprofile(None)
49
 
 
50
 
    threads = {}
51
 
    for tid, pp in _g_threadmap.items():
52
 
        threads[tid] = Stats(pp.getstats(), {})
53
 
    _g_threadmap = {}
54
 
    return ret, Stats(p.getstats(), threads)
 
34
        stats = profiler.stop()
 
35
    return ret, stats
 
36
 
 
37
 
 
38
class BzrProfiler(object):
 
39
    """Bzr utility wrapper around Profiler.
 
40
    
 
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)
55
112
 
56
113
 
57
114
class Stats(object):
58
 
    """XXX docstring"""
 
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
    """
59
121
 
60
122
    def __init__(self, data, threads):
61
123
        self.data = data
62
124
        self.threads = threads
63
125
 
64
126
    def sort(self, crit="inlinetime"):
65
 
        """XXX docstring"""
 
127
        """Sort the data by the supplied critera.
 
128
 
 
129
        :param crit: the data attribute used as the sort key."""
66
130
        if crit not in profiler_entry.__dict__:
67
131
            raise ValueError, "Can't sort by %s" % crit
68
132
        self.data.sort(lambda b, a: cmp(getattr(a, crit),
73
137
                                              getattr(b, crit)))
74
138
 
75
139
    def pprint(self, top=None, file=None):
76
 
        """XXX docstring"""
 
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."""
77
146
        if file is None:
78
147
            file = sys.stdout
79
148
        d = self.data