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
|
from __future__ import annotations
import os
import sys
import textwrap
import threading
import timeit
import types
from contextvars import ContextVar
from typing import Any, Callable, List, NamedTuple, Optional
from pyinstrument.low_level.stat_profile import (
get_frame_info,
measure_timing_overhead,
setstatprofile,
walltime_coarse_resolution,
)
from pyinstrument.low_level.types import TimerType
from pyinstrument.typing import LiteralStr
from pyinstrument.util import format_float_with_sig_figs, strtobool, unwrap
# pyright: strict
thread_locals = threading.local()
StackSamplerSubscriberTarget = Callable[[List[str], float, Optional["AsyncState"]], None]
IGNORE_OVERHEAD_WARNING = strtobool(os.environ.get("PYINSTRUMENT_IGNORE_OVERHEAD_WARNING", "0"))
class StackSamplerSubscriber:
def __init__(
self,
*,
target: StackSamplerSubscriberTarget,
desired_interval: float,
bound_to_async_context: bool,
async_state: AsyncState | None,
use_timing_thread: bool | None = None,
) -> None:
self.target = target
self.desired_interval = desired_interval
self.use_timing_thread = use_timing_thread
self.bound_to_async_context = bound_to_async_context
self.async_state = async_state
active_profiler_context_var: ContextVar[object | None] = ContextVar(
"active_profiler_context_var", default=None
)
class StackSampler:
"""Manages setstatprofile for Profilers on a single thread"""
subscribers: list[StackSamplerSubscriber]
current_sampling_interval: float | None
last_profile_time: float
timer_func: Callable[[], float] | None
has_warned_about_timing_overhead: bool
def __init__(self) -> None:
self.subscribers = []
self.current_sampling_interval = None
self.last_profile_time = 0.0
self.timer_func = None
self.has_warned_about_timing_overhead = False
def subscribe(
self,
target: StackSamplerSubscriberTarget,
*,
desired_interval: float,
use_timing_thread: bool | None = None,
use_async_context: bool,
):
if use_async_context:
if active_profiler_context_var.get() is not None:
raise RuntimeError(
"There is already a profiler running. You cannot run multiple profilers in the same thread or async context, unless you disable async support."
)
active_profiler_context_var.set(target)
self.subscribers.append(
StackSamplerSubscriber(
target=target,
desired_interval=desired_interval,
use_timing_thread=use_timing_thread,
bound_to_async_context=use_async_context,
async_state=AsyncState("in_context") if use_async_context else None,
)
)
self._update()
def unsubscribe(self, target: StackSamplerSubscriberTarget):
try:
subscriber = next(s for s in self.subscribers if s.target == target) # type: ignore
except StopIteration:
raise StackSampler.SubscriberNotFound()
if subscriber.bound_to_async_context:
# (don't need to use context_var.reset() because we verified it was
# None before we started)
active_profiler_context_var.set(None)
self.subscribers.remove(subscriber)
self._update()
def _update(self):
if len(self.subscribers) == 0:
self._stop_sampling()
return
min_subscribers_interval = min(s.desired_interval for s in self.subscribers)
timing_thread_preferences = set(
s.use_timing_thread for s in self.subscribers if s.use_timing_thread is not None
)
if len(timing_thread_preferences) > 1:
raise ValueError(
f"Profiler requested different timing thread preferences from a profiler that is already running."
)
use_timing_thread = next(iter(timing_thread_preferences), False)
if self.current_sampling_interval != min_subscribers_interval:
self._start_sampling(
interval=min_subscribers_interval, use_timing_thread=use_timing_thread
)
def _start_sampling(self, interval: float, use_timing_thread: bool):
if use_timing_thread and self.timer_func is not None:
raise ValueError(
f"Profiler requested to use the timing thread but this stack sampler is already using a custom timer function."
)
timer_type: TimerType
if self.timer_func:
timer_type = "timer_func"
elif use_timing_thread:
timer_type = "walltime_thread"
else:
coarse_resolution = walltime_coarse_resolution()
if coarse_resolution is not None and coarse_resolution <= interval:
timer_type = "walltime_coarse"
else:
timer_type = "walltime"
self._check_timing_overhead(interval=interval, timer_type=timer_type)
self.current_sampling_interval = interval
if self.last_profile_time == 0.0:
self.last_profile_time = self._timer()
setstatprofile(
target=self._sample,
interval=interval,
context_var=active_profiler_context_var,
timer_type=timer_type,
timer_func=self.timer_func,
)
def _stop_sampling(self):
setstatprofile(None)
self.current_sampling_interval = None
self.last_profile_time = 0.0
def _sample(self, frame: types.FrameType, event: str, arg: Any):
if event == "context_changed":
new, old, coroutine_stack = arg
for subscriber in self.subscribers:
if subscriber.target == old:
assert subscriber.bound_to_async_context
full_stack = build_call_stack(frame, event, arg)
if coroutine_stack:
full_stack.extend(reversed(coroutine_stack))
subscriber.async_state = AsyncState(
"out_of_context_awaited", info=full_stack
)
else:
subscriber.async_state = AsyncState(
"out_of_context_unknown", info=full_stack
)
elif subscriber.target == new:
assert subscriber.bound_to_async_context
subscriber.async_state = AsyncState("in_context")
else:
now = self._timer()
time_since_last_sample = now - self.last_profile_time
call_stack = build_call_stack(frame, event, arg)
for subscriber in self.subscribers:
subscriber.target(call_stack, time_since_last_sample, subscriber.async_state)
self.last_profile_time = now
def _timer(self):
if self.timer_func:
return self.timer_func()
else:
return timeit.default_timer()
def _check_timing_overhead(self, interval: float, timer_type: TimerType):
if self.has_warned_about_timing_overhead:
return
if IGNORE_OVERHEAD_WARNING:
return
overheads = timing_overhead()
overhead = overheads.get(timer_type)
if overhead is None:
return
if timer_type == "walltime":
if overhead > 300e-9:
self.has_warned_about_timing_overhead = True
message_parts: list[str] = []
message_parts.append(
f"""
pyinstrument: the timer on your system has an overhead of
{overhead * 1e9:.0f} nanoseconds, which is considered
high. You might experience longer runtimes than usual, and
programs with lots of pure-python code might be distorted.
"""
)
message_parts.append(
f"""
You might want to try the timing thread option, which can
be enabled using --use-timing-thread at the command line,
or by setting the use_timing_thread parameter in the
Profiler constructor.
"""
)
if "walltime_coarse" in overheads and overheads["walltime_coarse"] < 300e-9:
coarse_resolution = walltime_coarse_resolution()
assert coarse_resolution is not None
message_parts.append(
f"""
Your system does offer a 'coarse' timer, with a lower
overhead ({overheads["walltime_coarse"] * 1e9:.2g}
nanoseconds). You can enable it by setting
pyinstrument's interval to a value higher than
{format_float_with_sig_figs(coarse_resolution,
trim_zeroes=True)} seconds. If you're happy with the
lower precision, this is the best option.
"""
)
message_parts.append(
f"""
If you want to suppress this warning, you can set the
environment variable PYINSTRUMENT_IGNORE_OVERHEAD_WARNING
to '1'.
"""
)
message = "\n\n".join(
textwrap.fill(unwrap(part), width=80) for part in message_parts
)
print(message, file=sys.stderr)
class SubscriberNotFound(Exception):
pass
def get_stack_sampler() -> StackSampler:
"""
Gets the stack sampler for the current thread, creating it if necessary
"""
try:
return thread_locals.stack_sampler
except AttributeError:
# Attribute 'stack_sampler' doesn't exist in thread_locals, create it
stack_sampler = StackSampler()
thread_locals.stack_sampler = stack_sampler
return stack_sampler
def build_call_stack(frame: types.FrameType | None, event: str, arg: Any) -> list[str]:
call_stack: list[str] = []
if event == "call":
# if we're entering a function, the time should be attributed to
# the caller
frame = frame.f_back if frame else None
elif event == "c_return" or event == "c_exception":
# if we're exiting a C function, we should add a frame before
# any Python frames that attributes the time to that C function
c_frame_identifier = "%s\x00%s\x00%i" % (
getattr(arg, "__qualname__", arg.__name__),
"<built-in>",
0,
)
call_stack.append(c_frame_identifier)
while frame is not None:
call_stack.append(get_frame_info(frame))
frame = frame.f_back
thread = threading.current_thread()
thread_identifier = "%s\x00%s\x00%i" % (thread.name, "<thread>", thread.ident)
call_stack.append(thread_identifier)
# we iterated from the leaf to the root, we actually want the call stack
# starting at the root, so reverse this array
call_stack.reverse()
return call_stack
class AsyncState(NamedTuple):
state: LiteralStr["in_context", "out_of_context_awaited", "out_of_context_unknown"]
"""
Definitions:
``in_context``: indicates that the sample comes from the subscriber's
context.
``out_of_context_awaited``: the sample comes from outside the
subscriber's context, but we tracked the await that happened before the
context exited. :attr:`info` contains the call stack of the await.
``out_of_context_unknown``: the sample comes from outside the
subscriber's context, but the change of context didn't look like an
await. :attr:`info` contains the call stack when the context changed.
"""
info: Any = None
_timing_overhead: dict[TimerType, float] | None = None
def timing_overhead() -> dict[TimerType, float]:
global _timing_overhead
if _timing_overhead is None:
_timing_overhead = measure_timing_overhead()
return _timing_overhead
|