1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498
|
""" This module contains utility functions to construct and manipulate counting
data structures for frames.
When performing statistical profiling we obtain many call stacks. We aggregate
these call stacks into data structures that maintain counts of how many times
each function in that call stack has been called. Because these stacks will
overlap this aggregation counting structure forms a tree, such as is commonly
visualized by profiling tools.
We represent this tree as a nested dictionary with the following form:
{
'identifier': 'root',
'description': 'A long description of the line of code being run.',
'count': 10 # the number of times we have seen this line
'children': { # callers of this line. Recursive dicts
'ident-b': {'description': ...
'identifier': 'ident-a',
'count': ...
'children': {...}},
'ident-b': {'description': ...
'identifier': 'ident-b',
'count': ...
'children': {...}}}
}
"""
import bisect
from collections import defaultdict, deque
import linecache
import sys
import threading
from time import sleep
import tlz as toolz
from .metrics import time
from .utils import format_time, color_of, parse_timedelta
def identifier(frame):
"""A string identifier from a frame
Strings are cheaper to use as indexes into dicts than tuples or dicts
"""
if frame is None:
return "None"
else:
return ";".join(
(
frame.f_code.co_name,
frame.f_code.co_filename,
str(frame.f_code.co_firstlineno),
)
)
def repr_frame(frame):
""" Render a frame as a line for inclusion into a text traceback """
co = frame.f_code
text = ' File "%s", line %s, in %s' % (co.co_filename, frame.f_lineno, co.co_name)
line = linecache.getline(co.co_filename, frame.f_lineno, frame.f_globals).lstrip()
return text + "\n\t" + line
def info_frame(frame):
co = frame.f_code
line = linecache.getline(co.co_filename, frame.f_lineno, frame.f_globals).lstrip()
return {
"filename": co.co_filename,
"name": co.co_name,
"line_number": frame.f_lineno,
"line": line,
}
def process(frame, child, state, stop=None, omit=None):
"""Add counts from a frame stack onto existing state
This recursively adds counts to the existing state dictionary and creates
new entries for new functions.
Examples
--------
>>> import sys, threading
>>> ident = threading.get_ident() # replace with your thread of interest
>>> frame = sys._current_frames()[ident]
>>> state = {'children': {}, 'count': 0, 'description': 'root',
... 'identifier': 'root'}
>>> process(frame, None, state)
>>> state
{'count': 1,
'identifier': 'root',
'description': 'root',
'children': {'...'}}
"""
if omit is not None and any(frame.f_code.co_filename.endswith(o) for o in omit):
return False
prev = frame.f_back
if prev is not None and (
stop is None or not prev.f_code.co_filename.endswith(stop)
):
state = process(prev, frame, state, stop=stop)
if state is False:
return False
ident = identifier(frame)
try:
d = state["children"][ident]
except KeyError:
d = {
"count": 0,
"description": info_frame(frame),
"children": {},
"identifier": ident,
}
state["children"][ident] = d
state["count"] += 1
if child is not None:
return d
else:
d["count"] += 1
def merge(*args):
""" Merge multiple frame states together """
if not args:
return create()
s = {arg["identifier"] for arg in args}
if len(s) != 1:
raise ValueError("Expected identifiers, got %s" % str(s))
children = defaultdict(list)
for arg in args:
for child in arg["children"]:
children[child].append(arg["children"][child])
children = {k: merge(*v) for k, v in children.items()}
count = sum(arg["count"] for arg in args)
return {
"description": args[0]["description"],
"children": dict(children),
"count": count,
"identifier": args[0]["identifier"],
}
def create():
return {
"count": 0,
"children": {},
"identifier": "root",
"description": {"filename": "", "name": "", "line_number": 0, "line": ""},
}
def call_stack(frame):
"""Create a call text stack from a frame
Returns
-------
list of strings
"""
L = []
while frame:
L.append(repr_frame(frame))
frame = frame.f_back
return L[::-1]
def plot_data(state, profile_interval=0.010):
"""Convert a profile state into data useful by Bokeh
See Also
--------
plot_figure
distributed.bokeh.components.ProfilePlot
"""
starts = []
stops = []
heights = []
widths = []
colors = []
states = []
times = []
filenames = []
lines = []
line_numbers = []
names = []
def traverse(state, start, stop, height):
if not state["count"]:
return
starts.append(start)
stops.append(stop)
heights.append(height)
width = stop - start
widths.append(width)
states.append(state)
times.append(format_time(state["count"] * profile_interval))
desc = state["description"]
filenames.append(desc["filename"])
lines.append(desc["line"])
line_numbers.append(desc["line_number"])
names.append(desc["name"])
ident = state["identifier"]
try:
fn = desc["filename"]
except IndexError:
colors.append("gray")
else:
if fn == "<low-level>":
colors.append("lightgray")
else:
colors.append(color_of(fn))
delta = (stop - start) / state["count"]
x = start
for name, child in state["children"].items():
width = child["count"] * delta
traverse(child, x, x + width, height + 1)
x += width
traverse(state, 0, 1, 0)
percentages = ["{:.1f}%".format(100 * w) for w in widths]
return {
"left": starts,
"right": stops,
"bottom": heights,
"width": widths,
"top": [x + 1 for x in heights],
"color": colors,
"states": states,
"filename": filenames,
"line": lines,
"line_number": line_numbers,
"name": names,
"time": times,
"percentage": percentages,
}
def _watch(thread_id, log, interval="20ms", cycle="2s", omit=None, stop=lambda: False):
interval = parse_timedelta(interval)
cycle = parse_timedelta(cycle)
recent = create()
last = time()
while not stop():
if time() > last + cycle:
log.append((time(), recent))
recent = create()
last = time()
try:
frame = sys._current_frames()[thread_id]
except KeyError:
return
process(frame, None, recent, omit=omit)
sleep(interval)
def watch(
thread_id=None,
interval="20ms",
cycle="2s",
maxlen=1000,
omit=None,
stop=lambda: False,
):
"""Gather profile information on a particular thread
This starts a new thread to watch a particular thread and returns a deque
that holds periodic profile information.
Parameters
----------
thread_id: int
interval: str
Time per sample
cycle: str
Time per refreshing to a new profile state
maxlen: int
Passed onto deque, maximum number of periods
omit: str
Don't include entries that start with this filename
stop: callable
Function to call to see if we should stop
Returns
-------
deque
"""
if thread_id is None:
thread_id = threading.get_ident()
log = deque(maxlen=maxlen)
thread = threading.Thread(
target=_watch,
name="Profile",
kwargs={
"thread_id": thread_id,
"interval": interval,
"cycle": cycle,
"log": log,
"omit": omit,
"stop": stop,
},
)
thread.daemon = True
thread.start()
return log
def get_profile(history, recent=None, start=None, stop=None, key=None):
"""Collect profile information from a sequence of profile states
Parameters
----------
history: Sequence[Tuple[time, Dict]]
A list or deque of profile states
recent: dict
The most recent accumulating state
start: time
stop: time
"""
now = time()
if start is None:
istart = 0
else:
istart = bisect.bisect_left(history, (start,))
if stop is None:
istop = None
else:
istop = bisect.bisect_right(history, (stop,)) + 1
if istop >= len(history):
istop = None # include end
if istart == 0 and istop is None:
history = list(history)
else:
iistop = len(history) if istop is None else istop
history = [history[i] for i in range(istart, iistop)]
prof = merge(*toolz.pluck(1, history))
if not history:
return create()
if recent:
prof = merge(prof, recent)
return prof
def plot_figure(data, **kwargs):
"""Plot profile data using Bokeh
This takes the output from the function ``plot_data`` and produces a Bokeh
figure
See Also
--------
plot_data
"""
from bokeh.plotting import ColumnDataSource, figure
from bokeh.models import HoverTool
if "states" in data:
data = toolz.dissoc(data, "states")
source = ColumnDataSource(data=data)
fig = figure(tools="tap,box_zoom,xwheel_zoom,reset", **kwargs)
r = fig.quad(
"left",
"right",
"top",
"bottom",
color="color",
line_color="black",
line_width=2,
source=source,
)
r.selection_glyph = None
r.nonselection_glyph = None
hover = HoverTool(
point_policy="follow_mouse",
tooltips="""
<div>
<span style="font-size: 14px; font-weight: bold;">Name:</span>
<span style="font-size: 10px; font-family: Monaco, monospace;">@name</span>
</div>
<div>
<span style="font-size: 14px; font-weight: bold;">Filename:</span>
<span style="font-size: 10px; font-family: Monaco, monospace;">@filename</span>
</div>
<div>
<span style="font-size: 14px; font-weight: bold;">Line number:</span>
<span style="font-size: 10px; font-family: Monaco, monospace;">@line_number</span>
</div>
<div>
<span style="font-size: 14px; font-weight: bold;">Line:</span>
<span style="font-size: 10px; font-family: Monaco, monospace;">@line</span>
</div>
<div>
<span style="font-size: 14px; font-weight: bold;">Time:</span>
<span style="font-size: 10px; font-family: Monaco, monospace;">@time</span>
</div>
<div>
<span style="font-size: 14px; font-weight: bold;">Percentage:</span>
<span style="font-size: 10px; font-family: Monaco, monospace;">@percentage</span>
</div>
""",
)
fig.add_tools(hover)
fig.xaxis.visible = False
fig.yaxis.visible = False
fig.grid.visible = False
return fig, source
def _remove_py_stack(frames):
for entry in frames:
if entry.is_python:
break
yield entry
def llprocess(frames, child, state):
"""Add counts from low level profile information onto existing state
This uses the ``stacktrace`` module to collect low level stack trace
information and place it onto the given sttate.
It is configured with the ``distributed.worker.profile.low-level`` config
entry.
See Also
--------
process
ll_get_stack
"""
if not frames:
return
frame = frames.pop()
if frames:
state = llprocess(frames, frame, state)
addr = hex(frame.addr - frame.offset)
ident = ";".join(map(str, (frame.name, "<low-level>", addr)))
try:
d = state["children"][ident]
except KeyError:
d = {
"count": 0,
"description": {
"filename": "<low-level>",
"name": frame.name,
"line_number": 0,
"line": str(frame),
},
"children": {},
"identifier": ident,
}
state["children"][ident] = d
state["count"] += 1
if child is not None:
return d
else:
d["count"] += 1
def ll_get_stack(tid):
""" Collect low level stack information from thread id """
from stacktrace import get_thread_stack
frames = get_thread_stack(tid, show_python=False)
llframes = list(_remove_py_stack(frames))[::-1]
return llframes
|