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
|
# This file is part of "austin" which is released under GPL.
#
# See file LICENCE or go to http://www.gnu.org/licenses/ for full license
# details.
#
# Austin is a Python frame stack sampler for CPython.
#
# Copyright (c) 2022 Gabriele N. Tornetta <phoenix1987@gmail.com>.
# All rights reserved.
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
import importlib
import os
import platform
from asyncio.subprocess import STDOUT
from collections import Counter
from collections import defaultdict
from io import BytesIO
from io import StringIO
from pathlib import Path
from shutil import rmtree
from subprocess import PIPE
from subprocess import CalledProcessError
from subprocess import CompletedProcess
from subprocess import Popen
from subprocess import TimeoutExpired
from subprocess import check_output
from tempfile import gettempdir
from test import PYTHON_VERSIONS
from time import sleep
from types import ModuleType
from typing import Iterator
from typing import List
from typing import TypeVar
from typing import Union
try:
import pytest
except ImportError:
pytest = None
try:
from austin.format.mojo import MojoFile
except ImportError:
MojoFile = None
HERE = Path(__file__).parent
def target(name: str = "target34.py") -> str:
return str(HERE / "targets" / name)
def allpythons(min=None, max=None):
def _(f):
versions = PYTHON_VERSIONS
if min is not None:
versions = [_ for _ in versions if _ >= min]
if max is not None:
versions = [_ for _ in versions if _ <= max]
return pytest.mark.parametrize(
"py", [".".join([str(_) for _ in v]) for v in versions]
)(f)
return _
if platform.system() == "Darwin":
BREW_PREFIX = check_output(["brew", "--prefix"], text=True, stderr=STDOUT).strip()
def python(version: str) -> list[str]:
match platform.system():
case "Windows":
py = ["py", f"-{version}"]
case "Darwin" | "Linux":
py = [f"python{version}"]
case _:
raise RuntimeError(f"Unsupported platform: {platform.system()}")
try:
check_output([*py, "-V"], stderr=STDOUT)
return py
except FileNotFoundError:
pytest.skip(f"Python {version} not found")
def gdb(cmds: list[str], *args: tuple[str]) -> str:
return check_output(
["gdb", "-q", "-batch"]
+ [_ for cs in (("-ex", _) for _ in cmds) for _ in cs]
+ list(args),
stderr=STDOUT,
).decode()
def apport_unpack(report: Path, target_dir: Path):
return check_output(
["apport-unpack", str(report), str(target_dir)],
stderr=STDOUT,
).decode()
def bt(binary: Path, pid: int) -> str:
core_file = f"core.{pid}"
if Path(core_file).is_file():
return gdb(["bt full", "q"], str(binary), core_file)
# On Ubuntu, apport puts crashes in /var/crash
crash_dir = Path("/var/crash")
if crash_dir.is_dir():
crashes = list(crash_dir.glob("*.crash"))
if crashes:
# Take the last one
crash = crashes[-1]
target_dir = Path(crash.stem)
apport_unpack(crash, target_dir)
result = gdb(["bt full", "q"], str(binary), target_dir / "CoreDump")
crash.unlink()
rmtree(str(target_dir))
return result
return "No core dump available."
def collect_logs(variant: str, pid: int) -> List[str]:
match platform.system():
case "Linux":
with Path("/var/log/syslog").open() as logfile:
needles = (f"{variant}[{pid}]", f"systemd-coredump[{pid}]")
return [
f" logs for {variant}[{pid}] ".center(80, "="),
*(
line.strip().replace("#012", "\n")
for line in logfile.readlines()
if any(needle in line for needle in needles)
),
f" end of logs for {variant}[{pid}] ".center(80, "="),
]
case "Windows":
with (Path(gettempdir()) / "austin.log").open() as logfile:
needles = (f"{variant}[{pid}]",)
return [
f" logs for {variant}[{pid}] ".center(80, "="),
*(
line.strip()
for line in logfile.readlines()
if any(needle in line for needle in needles)
),
f" end of logs for {variant}[{pid}] ".center(80, "="),
]
case _:
return []
EXEEXT = ".exe" if platform.system() == "Windows" else ""
# Taken from the subprocess module. We make our own version that can also
# propagate the PID.
def run(
*popenargs, input=None, capture_output=False, timeout=None, check=False, **kwargs
):
if input is not None:
if kwargs.get("stdin") is not None:
raise ValueError("stdin and input arguments may not both be used.")
kwargs["stdin"] = PIPE
if capture_output:
if kwargs.get("stdout") is not None or kwargs.get("stderr") is not None:
raise ValueError(
"stdout and stderr arguments may not be used " "with capture_output."
)
kwargs["stdout"] = PIPE
kwargs["stderr"] = PIPE
with Popen(*popenargs, **kwargs) as process:
try:
stdout, stderr = process.communicate(input, timeout=timeout)
except TimeoutExpired as exc:
exc.pid = process.pid
process.kill()
if platform.system() == "Windows":
exc.stdout, exc.stderr = process.communicate()
else:
process.wait()
raise
except Exception as e:
e.pid = process.pid
process.kill()
raise
retcode = process.poll()
if check and retcode:
exc = CalledProcessError(
retcode, process.args, output=stdout, stderr=stderr
)
exc.pid = process.pid
raise exc
result = CompletedProcess(process.args, retcode, stdout, stderr)
result.pid = process.pid
return result
def print_logs(logs: List[str]) -> None:
if logs:
for log in logs:
print(log)
else:
print("<< no logs available >>")
class Variant(str):
ALL: list["Variant"] = []
def __init__(self, name: str) -> None:
super().__init__()
path = (Path("src") / name).with_suffix(EXEEXT)
if not path.is_file():
path = Path(name).with_suffix(EXEEXT)
self.name = name
self.path = path
self.ALL.append(self)
def __call__(
self,
*args: str,
timeout: int = 60,
mojo: bool = False,
convert: bool = True,
expect_fail: Union[bool, int] = False,
) -> CompletedProcess:
if not self.path.is_file():
pytest.skip(f"Variant '{self}' not available")
mojo_args = ["-b"] if mojo else []
try:
result = run(
[str(self.path)] + mojo_args + list(args),
capture_output=True,
timeout=timeout,
)
except Exception as exc:
if (pid := getattr(exc, "pid", None)) is not None:
print_logs(collect_logs(self.name, pid))
raise
if result.returncode in (-11, 139): # SIGSEGV
print(bt(self.path, result.pid))
if mojo and not ({"-o", "-w", "--output", "--where"} & set(args)):
# We produce MOJO binary data only if we are not writing to file
# or using the "where" option.
if convert:
result.stdout = demojo(result.stdout)
else:
result.stdout = result.stdout.decode(errors="ignore")
result.stderr = result.stderr.decode()
logs = collect_logs(self.name, result.pid)
result.logs = logs
if result.returncode != int(expect_fail):
print_logs(logs)
return result
austin = Variant("austin")
austinp = Variant("austinp")
def run_async(command: list[str], *args: tuple[str], env: dict | None = None) -> Popen:
return Popen(command + list(args), stdout=PIPE, stderr=PIPE, env=env)
def run_python(
version,
*args: tuple[str],
env: dict | None = None,
prefix: list[str] = [],
sleep_after: float | None = None,
) -> Popen:
result = run_async(prefix + python(version), *args, env=env)
if sleep_after is not None:
sleep(sleep_after)
return result
def samples(data: str) -> Iterator[bytes]:
return (_ for _ in data.splitlines() if _ and _[0] == "P")
T = TypeVar("T")
def denoise(data: Iterator[T], threshold: float = 0.1) -> set[T]:
c = Counter(data)
try:
m = max(c.values())
except ValueError:
return set()
return {t for t, c in c.items() if c / m > threshold}
def processes(data: str) -> set[str]:
return denoise(_.partition(";")[0] for _ in samples(data))
def threads(data: str, threshold: float = 0.1) -> set[tuple[str, str]]:
return denoise(
tuple(_.rpartition(" ")[0].split(";", maxsplit=2)[:2]) for _ in samples(data)
)
def metadata(data: str) -> dict[str, str]:
meta = dict(
_[1:].strip().split(": ", maxsplit=1)
for _ in data.splitlines()
if _ and _[0] == "#" and not _.startswith("# map:")
)
for v in ("austin", "python"):
if v in meta:
meta[v] = tuple(int(_.replace("?", "-1")) for _ in meta[v].split(".")[:3])
return meta
def maps(data: str) -> defaultdict[str, list[str]]:
maps = defaultdict(list)
for r, f in (
_[7:].split(" ", maxsplit=1)
for _ in data.splitlines()
if _.startswith("# map:")
):
maps[f].append(r)
return maps
def has_pattern(data: str, pattern: str) -> bool:
for _ in samples(data):
if pattern in _:
return True
return False
def sum_metric(data: str) -> int:
return sum(int(_.rpartition(" ")[-1]) for _ in samples(data))
def sum_metrics(data: str) -> tuple[int, int, int, int]:
wall = cpu = alloc = dealloc = 0
for t, i, m in (
_.rpartition(" ")[-1].split(",", maxsplit=2) for _ in samples(data)
):
time = int(t)
wall += time
if i == "0":
cpu += time
memory = int(m)
if memory > 0:
alloc += memory
else:
dealloc += memory
return wall, cpu, alloc, dealloc
def compress(data: str) -> str:
stacks: dict[str, int] = {}
for _ in (_.strip() for _ in data.splitlines() if _ and _[0] == "P"):
stack, _, metric = _.rpartition(" ")
stacks[stack] = stacks.setdefault(stack, 0) + int(metric)
compressed_stacks = "\n".join((f"{k} {v}" for k, v in stacks.items()))
output = (
f"# Metadata\n{metadata(data)}\n\n# Stacks\n{compressed_stacks or '<no data>'}"
)
ms = maps(data)
if ms:
output = f"# Maps\n{list(ms.keys())}\n\n" + output
return output
if MojoFile is None:
def demojo(data: bytes) -> str:
raise ImportError("austin")
else:
def demojo(data: bytes) -> str:
result = StringIO()
for e in MojoFile(BytesIO(data)).parse():
result.write(e.to_austin())
return result.getvalue()
# Load from the utils scripts
def load_util(name: str) -> ModuleType:
module_path = (Path(__file__).parent.parent / "utils" / name).with_suffix(".py")
spec = importlib.util.spec_from_file_location(name, str(module_path))
assert spec is not None and spec.loader is not None, spec
module = importlib.util.module_from_spec(spec)
spec.loader.exec_module(module)
return module
if pytest is not None:
variants = pytest.mark.parametrize("austin", Variant.ALL)
match platform.system():
case "Windows":
requires_sudo = no_sudo = lambda f: f
case _:
requires_sudo = pytest.mark.skipif(
os.geteuid() != 0, reason="Requires superuser privileges"
)
no_sudo = pytest.mark.skipif(
os.geteuid() == 0, reason="Must not have superuser privileges"
)
mojo = pytest.mark.parametrize("mojo", [False, True])
|