Helpful debugging in case of crashes

ondrejmirtes · ondrejmirtes · commit 96c70c518edb · 2025-11-14T17:44:40.000+01:00
diff --git a/build/phpstan.neon b/build/phpstan.neon
@@ -68,6 +68,7 @@ parameters:
 			- 'PHPStan\Reflection\MissingStaticAccessorInstanceException'
 			- 'LogicException'
 			- 'Error'
+			- 'PHPStan\Analyser\Generator\TrampolineException'
 		check:
 			missingCheckedExceptionInThrows: true
 			tooWideThrowType: true
diff --git a/src/Analyser/Generator/ExprAnalysisRequest.php b/src/Analyser/Generator/ExprAnalysisRequest.php
@@ -7,10 +7,16 @@
 use PhpParser\Node\Stmt;
 use PHPStan\Analyser\ExpressionContext;
 use PHPStan\Analyser\Scope;
+use function debug_backtrace;
+use const DEBUG_BACKTRACE_IGNORE_ARGS;
 
 final class ExprAnalysisRequest
 {
 
+	public ?string $originFile = null;
+
+	public ?int $originLine = null;
+
 	/**
 	 * @param (callable(Node, Scope, callable(Node, Scope): void): void)|null $alternativeNodeCallback
 	 */
@@ -22,6 +28,9 @@ public function __construct(
 		public readonly mixed $alternativeNodeCallback = null,
 	)
 	{
+		$trace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 1);
+		$this->originFile = $trace[0]['file'] ?? null;
+		$this->originLine = $trace[0]['line'] ?? null;
 	}
 
 }
diff --git a/src/Analyser/Generator/GeneratorNodeScopeResolver.php b/src/Analyser/Generator/GeneratorNodeScopeResolver.php
@@ -14,13 +14,15 @@
 use PHPStan\NeverException;
 use PHPStan\Node\Printer\ExprPrinter;
 use PHPStan\ShouldNotHappenException;
+use Throwable;
 use function array_map;
 use function array_merge;
 use function array_pop;
 use function count;
 use function get_class;
 use function get_debug_type;
 use function implode;
+use function is_array;
 use function sprintf;
 
 /**
@@ -111,17 +113,68 @@ private function processStmtNodes(
 		StatementContext $context,
 	): StmtAnalysisResult
 	{
+		$gen = new IdentifiedGeneratorInStack($this->analyseStmts($stmts, $scope, $context, null), $stmts, null, null);
+		$gen->generator->current();
+
 		$stack = [];
 
-		$gen = $this->analyseStmts($stmts, $scope, $context, null);
-		$gen->current();
+		try {
+			return $this->runTrampoline(
+				$fibersStorage,
+				$exprAnalysisResultStorage,
+				$gen,
+				$nodeCallback,
+				$stack,
+			);
+		} catch (Throwable $e) {
+			$stackTrace = [];
+			foreach (array_merge($stack, [$gen]) as $identifiedGenerator) {
+				if ($identifiedGenerator->file === null && $identifiedGenerator->line === null) {
+					continue;
+				}
+				if (is_array($identifiedGenerator->node)) {
+					$stackTrace[] = sprintf(
+						"Stmts\n    -> %s on line %d",
+						$identifiedGenerator->file,
+						$identifiedGenerator->line,
+					);
+					continue;
+				}
+
+				$stackTrace[] = sprintf(
+					"%s:%d\n    -> %s on line %d",
+					$identifiedGenerator->file,
+					$identifiedGenerator->line,
+					get_class($identifiedGenerator->node),
+					$identifiedGenerator->node->getStartLine(),
+				);
+			}
+
+			throw new TrampolineException(sprintf(
+				"Error ocurred in GNSR trampoline: %s\n\nAST processor stack trace:\n%s",
+				$e->getMessage(),
+				implode("\n", $stackTrace),
+			), previous: $e);
+		}
+	}
 
-		// Trampoline loop
+	/**
+	 * @param callable(Node, Scope): void $nodeCallback
+	 * @param list<IdentifiedGeneratorInStack> $stack
+	 */
+	private function runTrampoline(
+		PendingFibersStorage $fibersStorage,
+		ExprAnalysisResultStorage $exprAnalysisResultStorage,
+		IdentifiedGeneratorInStack &$gen,
+		callable $nodeCallback,
+		array &$stack,
+	): StmtAnalysisResult
+	{
 		while (true) {
 			$this->processPendingFibers($fibersStorage, $exprAnalysisResultStorage);
 
-			if ($gen->valid()) {
-				$yielded = $gen->current();
+			if ($gen->generator->valid()) {
+				$yielded = $gen->generator->current();
 
 				if ($yielded instanceof NodeCallbackRequest) {
 					$this->invokeNodeCallback(
@@ -132,7 +185,7 @@ private function processStmtNodes(
 						$nodeCallback,
 					);
 
-					$gen->next();
+					$gen->generator->next();
 					continue;
 				} elseif ($yielded instanceof AlternativeNodeCallbackRequest) {
 					$alternativeNodeCallback = $yielded->nodeCallback;
@@ -146,29 +199,44 @@ static function (Node $node, Scope $scope) use ($alternativeNodeCallback, $nodeC
 						},
 					);
 
-					$gen->next();
+					$gen->generator->next();
 					continue;
 				} elseif ($yielded instanceof ExprAnalysisRequest) {
 					$stack[] = $gen;
-					$gen = $this->analyseExpr($exprAnalysisResultStorage, $yielded->stmt, $yielded->expr, $yielded->scope, $yielded->context, $yielded->alternativeNodeCallback);
-					$gen->current();
+					$gen = new IdentifiedGeneratorInStack(
+						$this->analyseExpr($exprAnalysisResultStorage, $yielded->stmt, $yielded->expr, $yielded->scope, $yielded->context, $yielded->alternativeNodeCallback),
+						$yielded->expr,
+						$yielded->originFile,
+						$yielded->originLine,
+					);
+					$gen->generator->current();
 					continue;
 				} elseif ($yielded instanceof StmtAnalysisRequest) {
 					$stack[] = $gen;
-					$gen = $this->analyseStmt($yielded->stmt, $yielded->scope, $yielded->context, $yielded->alternativeNodeCallback);
-					$gen->current();
+					$gen = new IdentifiedGeneratorInStack(
+						$this->analyseStmt($yielded->stmt, $yielded->scope, $yielded->context, $yielded->alternativeNodeCallback),
+						$yielded->stmt,
+						$yielded->originFile,
+						$yielded->originLine,
+					);
+					$gen->generator->current();
 					continue;
 				} elseif ($yielded instanceof StmtsAnalysisRequest) {
 					$stack[] = $gen;
-					$gen = $this->analyseStmts($yielded->stmts, $yielded->scope, $yielded->context, $yielded->alternativeNodeCallback);
-					$gen->current();
+					$gen = new IdentifiedGeneratorInStack(
+						$this->analyseStmts($yielded->stmts, $yielded->scope, $yielded->context, $yielded->alternativeNodeCallback),
+						$yielded->stmts,
+						$yielded->originFile,
+						$yielded->originLine,
+					);
+					$gen->generator->current();
 					continue;
 				} else { // phpcs:ignore
 					throw new NeverException($yielded);
 				}
 			}
 
-			$result = $gen->getReturn();
+			$result = $gen->generator->getReturn();
 			if (count($stack) === 0) {
 				foreach ($fibersStorage->pendingFibers as $pending) {
 					$request = $pending['request'];
@@ -200,7 +268,7 @@ static function () {
 			}
 
 			$gen = array_pop($stack);
-			$gen->send($result);
+			$gen->generator->send($result);
 		}
 	}
 
diff --git a/src/Analyser/Generator/IdentifiedGeneratorInStack.php b/src/Analyser/Generator/IdentifiedGeneratorInStack.php
@@ -0,0 +1,28 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Analyser\Generator;
+
+use Generator;
+use PhpParser\Node;
+
+final class IdentifiedGeneratorInStack
+{
+
+	/**
+	 * @param (
+	 *     Generator<int, StmtAnalysisRequest, StmtAnalysisResult, StmtAnalysisResult>| // analyseStmts
+	 *     Generator<int, ExprAnalysisRequest|StmtAnalysisRequest|StmtsAnalysisRequest|NodeCallbackRequest|AlternativeNodeCallbackRequest, ExprAnalysisResult|StmtAnalysisResult, StmtAnalysisResult>| // analyseStmt
+	 *     Generator<int, ExprAnalysisRequest|NodeCallbackRequest|AlternativeNodeCallbackRequest, ExprAnalysisResult, ExprAnalysisResult> // analyseExpr
+	 * ) $generator
+	 * @param Node|Node[] $node
+	 */
+	public function __construct(
+		public Generator $generator,
+		public Node|array $node,
+		public ?string $file,
+		public ?int $line,
+	)
+	{
+	}
+
+}
diff --git a/src/Analyser/Generator/StmtAnalysisRequest.php b/src/Analyser/Generator/StmtAnalysisRequest.php
@@ -6,10 +6,16 @@
 use PhpParser\Node\Stmt;
 use PHPStan\Analyser\Scope;
 use PHPStan\Analyser\StatementContext;
+use function debug_backtrace;
+use const DEBUG_BACKTRACE_IGNORE_ARGS;
 
 final class StmtAnalysisRequest
 {
 
+	public ?string $originFile = null;
+
+	public ?int $originLine = null;
+
 	/**
 	 * @param (callable(Node, Scope, callable(Node, Scope): void): void)|null $alternativeNodeCallback
 	 */
@@ -20,6 +26,9 @@ public function __construct(
 		public readonly mixed $alternativeNodeCallback = null,
 	)
 	{
+		$trace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 1);
+		$this->originFile = $trace[0]['file'] ?? null;
+		$this->originLine = $trace[0]['line'] ?? null;
 	}
 
 }
diff --git a/src/Analyser/Generator/StmtsAnalysisRequest.php b/src/Analyser/Generator/StmtsAnalysisRequest.php
@@ -6,10 +6,16 @@
 use PhpParser\Node\Stmt;
 use PHPStan\Analyser\Scope;
 use PHPStan\Analyser\StatementContext;
+use function debug_backtrace;
+use const DEBUG_BACKTRACE_IGNORE_ARGS;
 
 final class StmtsAnalysisRequest
 {
 
+	public ?string $originFile = null;
+
+	public ?int $originLine = null;
+
 	/**
 	 * @param Stmt[] $stmts
 	 * @param (callable(Node, Scope, callable(Node, Scope): void): void)|null $alternativeNodeCallback
@@ -21,6 +27,9 @@ public function __construct(
 		public readonly mixed $alternativeNodeCallback = null,
 	)
 	{
+		$trace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 1);
+		$this->originFile = $trace[0]['file'] ?? null;
+		$this->originLine = $trace[0]['line'] ?? null;
 	}
 
 }
diff --git a/src/Analyser/Generator/TrampolineException.php b/src/Analyser/Generator/TrampolineException.php
@@ -0,0 +1,10 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Analyser\Generator;
+
+use Exception;
+
+final class TrampolineException extends Exception
+{
+
+}

Original file line number	Diff line number	Diff line change
`@@ -7,10 +7,16 @@`
`7`	`7`	`use PhpParser\Node\Stmt;`
`8`	`8`	`use PHPStan\Analyser\ExpressionContext;`
`9`	`9`	`use PHPStan\Analyser\Scope;`
	`10`	`+use function debug_backtrace;`
	`11`	`+use const DEBUG_BACKTRACE_IGNORE_ARGS;`
`10`	`12`
`11`	`13`	`final class ExprAnalysisRequest`
`12`	`14`	`{`
`13`	`15`
	`16`	`+ public ?string $originFile = null;`
	`17`	`+`
	`18`	`+ public ?int $originLine = null;`
	`19`	`+`
`14`	`20`	`/**`
`15`	`21`	`* @param (callable(Node, Scope, callable(Node, Scope): void): void)\|null $alternativeNodeCallback`
`16`	`22`	`*/`
`@@ -22,6 +28,9 @@ public function __construct(`
`22`	`28`	`public readonly mixed $alternativeNodeCallback = null,`
`23`	`29`	`)`
`24`	`30`	`{`
	`31`	`+ $trace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 1);`
	`32`	`+ $this->originFile = $trace[0]['file'] ?? null;`
	`33`	`+ $this->originLine = $trace[0]['line'] ?? null;`
`25`	`34`	`}`
`26`	`35`
`27`	`36`	`}`
Original file line number	Diff line number	Diff line change
`@@ -6,10 +6,16 @@`
`6`	`6`	`use PhpParser\Node\Stmt;`
`7`	`7`	`use PHPStan\Analyser\Scope;`
`8`	`8`	`use PHPStan\Analyser\StatementContext;`
	`9`	`+use function debug_backtrace;`
	`10`	`+use const DEBUG_BACKTRACE_IGNORE_ARGS;`
`9`	`11`
`10`	`12`	`final class StmtAnalysisRequest`
`11`	`13`	`{`
`12`	`14`
	`15`	`+ public ?string $originFile = null;`
	`16`	`+`
	`17`	`+ public ?int $originLine = null;`
	`18`	`+`
`13`	`19`	`/**`
`14`	`20`	`* @param (callable(Node, Scope, callable(Node, Scope): void): void)\|null $alternativeNodeCallback`
`15`	`21`	`*/`
`@@ -20,6 +26,9 @@ public function __construct(`
`20`	`26`	`public readonly mixed $alternativeNodeCallback = null,`
`21`	`27`	`)`
`22`	`28`	`{`
	`29`	`+ $trace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 1);`
	`30`	`+ $this->originFile = $trace[0]['file'] ?? null;`
	`31`	`+ $this->originLine = $trace[0]['line'] ?? null;`
`23`	`32`	`}`
`24`	`33`
`25`	`34`	`}`