Files
paddlepaddle--paddle/python/paddle/jit/sot/utils/exceptions.py
T
2026-07-13 12:40:42 +08:00

489 lines
13 KiB
Python

# Copyright (c) 2023 PaddlePaddle Authors. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
from __future__ import annotations
import traceback
from typing import TYPE_CHECKING
from .info_collector import BreakGraphReasonInfo
if TYPE_CHECKING:
from ..opcode_translator.executor.variables.base import VariableBase
class BreakGraphReasonBase:
"""Base class for representing reasons why graph execution was interrupted.
Attributes:
reason_str (str): Description of the break reason
file_path (str): Path to the file where break occurred
line_number (int): Line number where break occurred
"""
def __init__(
self,
reason_str,
file_path="",
line_number=-1,
):
self.reason_str = reason_str
self.file_path = file_path
self.line_number = line_number
def __repr__(self) -> str:
return f"{self.reason_str}"
class DataDependencyBreak(BreakGraphReasonBase):
pass
class DataDependencyControlFlowBreak(DataDependencyBreak):
"""Break reason for control flow execution."""
def __init__(self, reason_str=None, file_path="", line_number=-1):
if reason_str is None:
reason_str = "OpcodeInlineExecutor want break graph when simulate control flow."
super().__init__(
reason_str,
file_path,
line_number,
)
class DataDependencyDynamicShapeBreak(DataDependencyBreak):
pass
class DataDependencyOperationBreak(DataDependencyBreak):
pass
class UnsupportedOperationBreak(BreakGraphReasonBase):
def __init__(
self,
*,
left_type=None,
right_type=None,
operator=None,
reason_str=None,
file_path="",
line_number=-1,
):
if reason_str is None:
reason_str = f"Unsupported operator '{operator}' between {left_type} and {right_type}"
super().__init__(reason_str, file_path, line_number)
class UnsupportedPaddleAPIBreak(UnsupportedOperationBreak):
def __init__(
self,
*,
fn_name=None,
reason_str=None,
file_path="",
line_number=-1,
):
if reason_str is None:
reason_str = f"Not support Paddlepaddle API: {fn_name}"
super().__init__(
reason_str=reason_str,
file_path=file_path,
line_number=line_number,
)
class UnsupportedNumPyAPIBreak(UnsupportedOperationBreak):
def __init__(
self,
*,
fn_name=None,
reason_str=None,
file_path="",
line_number=-1,
):
if reason_str is None:
reason_str = f"Not support NumPy API: {fn_name}"
super().__init__(
reason_str=reason_str,
file_path=file_path,
line_number=line_number,
)
class UnsupportedRandomAPIBreak(UnsupportedOperationBreak):
def __init__(
self,
*,
fn_name=None,
reason_str=None,
file_path="",
line_number=-1,
):
if reason_str is None:
reason_str = f"Random function {fn_name} is not supported."
super().__init__(
reason_str=reason_str,
file_path=file_path,
line_number=line_number,
)
class ForceBreak(UnsupportedOperationBreak):
def __init__(
self,
*,
reason_str=None,
file_path="",
line_number=-1,
):
if reason_str is None:
reason_str = "Force break graph execution"
super().__init__(
reason_str=reason_str,
file_path=file_path,
line_number=line_number,
)
class BuiltinFunctionBreak(UnsupportedOperationBreak):
"""Break reason for unsupported built-in function calls.
Args:
fn_name (str): Name of the builtin function
arg_types (list): Types of the arguments passed to the function
file_path (str): Path to the file where break occurred
line_number (int): Line number where break occurred
"""
def __init__(
self,
*,
fn_name=None,
arg_types=None,
reason_str=None,
file_path="",
line_number=-1,
):
if reason_str is None:
reason_str = f"Not support builtin function: {fn_name} with args: Args({arg_types})"
super().__init__(
reason_str=reason_str,
file_path=file_path,
line_number=line_number,
)
class SideEffectBreak(BreakGraphReasonBase):
pass
class UnsupportedIteratorBreak(SideEffectBreak):
pass
class InlineCallBreak(BreakGraphReasonBase):
pass
class FallbackInlineCallBreak(InlineCallBreak):
pass
class BreakGraphInlineCallBreak(InlineCallBreak):
pass
class OtherInlineCallBreak(InlineCallBreak):
pass
class DygraphInconsistentWithStaticBreak(BreakGraphReasonBase):
pass
class PsdbBreakReason(BreakGraphReasonBase):
pass
class InferMetaBreak(BreakGraphReasonBase):
"""Break reason during meta information inference phase."""
pass
class NullMetaBreak(BreakGraphReasonBase):
def __init__(
self,
*,
file_path="",
line_number=-1,
):
super().__init__(
"Access attribute from null meta", file_path, line_number
)
class SotErrorBase(Exception):
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
from ..opcode_translator.breakpoint import BreakpointManager
BreakpointManager().on_event(f"{self.__class__.__name__}")
def print(self):
lines = traceback.format_tb(self.__traceback__)
print("".join(lines))
class InnerError(SotErrorBase):
pass
class HasNoAttributeError(InnerError):
pass
class FallbackError(SotErrorBase):
def __init__(self, msg, disable_eval_frame=False):
super().__init__(msg)
self.disable_eval_frame = disable_eval_frame
class ConditionalFallbackError(FallbackError): ...
# raise in inline function call strategy.
class BreakGraphError(SotErrorBase):
def __init__(self, reason: BreakGraphReasonBase = None):
super().__init__(str(reason))
if not isinstance(reason, BreakGraphReasonBase):
raise ValueError(
"reason must be a subclass of BreakGraphReasonBase"
)
self.reason = reason
BreakGraphReasonInfo.collect_break_graph_reason(reason)
def inner_error_default_handler(func, message_fn):
"""Wrap function and an error handling function and throw an InnerError."""
def impl(*args, **kwargs):
try:
return func(*args, **kwargs)
except SotErrorBase as e:
raise e
except Exception as e:
message = message_fn(*args, **kwargs)
origin_exception_message = "\n".join(
traceback.format_exception(type(e), e, e.__traceback__)
)
raise InnerError(
f"{message}\nOrigin Exception is: \n {origin_exception_message}"
) from e
return impl
class ExportError(SotErrorBase):
pass
class SotExtraInfo:
SOT_EXTRA_INFO_ATTR_NAME = "__SOT_EXTRA_INFO__"
def __init__(self, *, need_breakgraph: bool = False):
self.need_breakgraph = need_breakgraph
def set_need_breakgraph(self, need_breakgraph: bool):
self.need_breakgraph = need_breakgraph
def attach(self, err: BaseException):
setattr(err, SotExtraInfo.SOT_EXTRA_INFO_ATTR_NAME, self)
@staticmethod
def default() -> SotExtraInfo:
return SotExtraInfo()
@staticmethod
def from_exception(err: BaseException) -> SotExtraInfo:
info = getattr(
err, SotExtraInfo.SOT_EXTRA_INFO_ATTR_NAME, SotExtraInfo.default()
)
setattr(err, SotExtraInfo.SOT_EXTRA_INFO_ATTR_NAME, info)
return info
class SotCapturedException(SotErrorBase):
# Represents an exception encountered during bytecode execution simulation.
# This exception is used by SOT to handle Python exceptions by mapping them to
# SotCapturedException for consistent exception handling in the simulation process.
...
class SotCapturedLookupError(SotCapturedException): ...
class SotCapturedIndexError(SotCapturedLookupError): ...
class SotCapturedKeyError(SotCapturedLookupError): ...
class SotCapturedArithmeticError(SotCapturedException): ...
class SotCapturedFloatingPointError(SotCapturedArithmeticError): ...
class SotCapturedOverflowError(SotCapturedArithmeticError): ...
class SotCapturedZeroDivisionError(SotCapturedArithmeticError): ...
class SotCapturedImportError(SotCapturedException): ...
class SotCapturedModuleNotFoundError(SotCapturedImportError): ...
class SotCapturedRuntimeError(SotCapturedException): ...
class SotCapturedNotImplementedError(SotCapturedRuntimeError): ...
class SotCapturedRecursionError(SotCapturedRuntimeError): ...
class SotCapturedNameError(SotCapturedException): ...
class SotCapturedUnboundLocalError(SotCapturedNameError): ...
class SotCapturedSyntaxError(SotCapturedException): ...
class SotCapturedIndentationError(SotCapturedSyntaxError): ...
class SotCapturedTabError(SotCapturedIndentationError): ...
class SotCapturedOSError(SotCapturedException): ...
class SotCapturedFileExistsError(SotCapturedOSError): ...
class SotCapturedFileNotFoundError(SotCapturedOSError): ...
class SotCapturedIsADirectoryError(SotCapturedOSError): ...
class SotCapturedNotADirectoryError(SotCapturedOSError): ...
class SotCapturedPermissionError(SotCapturedOSError): ...
class SotCapturedTimeoutError(SotCapturedOSError): ...
class SotCapturedStopIteration(SotCapturedOSError): ...
class SotCapturedExceptionFactory:
# This dictionary maps common built-in Python Exception types to their corresponding SotCapturedException
# types, preserving the original exception hierarchy for proper inheritance behavior.
# Reference: https://docs.python.org/3/library/exceptions.html#exception-hierarchy
MAPPING = {
Exception: SotCapturedException,
LookupError: SotCapturedLookupError,
IndexError: SotCapturedIndexError,
KeyError: SotCapturedKeyError,
ArithmeticError: SotCapturedArithmeticError,
FloatingPointError: SotCapturedFloatingPointError,
OverflowError: SotCapturedOverflowError,
ZeroDivisionError: SotCapturedZeroDivisionError,
ImportError: SotCapturedImportError,
ModuleNotFoundError: SotCapturedModuleNotFoundError,
RuntimeError: SotCapturedRuntimeError,
NotImplementedError: SotCapturedNotImplementedError,
NameError: SotCapturedNameError,
UnboundLocalError: SotCapturedUnboundLocalError,
SyntaxError: SotCapturedSyntaxError,
IndentationError: SotCapturedIndentationError,
TabError: SotCapturedTabError,
OSError: SotCapturedOSError,
FileExistsError: SotCapturedFileExistsError,
FileNotFoundError: SotCapturedFileNotFoundError,
IsADirectoryError: SotCapturedIsADirectoryError,
NotADirectoryError: SotCapturedNotADirectoryError,
PermissionError: SotCapturedPermissionError,
TimeoutError: SotCapturedTimeoutError,
StopIteration: SotCapturedStopIteration,
}
@classmethod
def get(
cls,
exc_type: type[Exception],
) -> type[SotCapturedException]:
if isinstance(exc_type, type) and issubclass(
exc_type, SotCapturedException
):
return exc_type
if exc_type not in cls.MAPPING:
name = getattr(exc_type, "__name__", str(exc_type))
cls.MAPPING[exc_type] = type(
f"SotCaptured{name}", (SotCapturedException,), {}
)
return cls.MAPPING[exc_type]
@classmethod
def create(
cls,
origin_exc: Exception,
tracked_args: list[VariableBase] | None = None,
) -> SotCapturedException:
# transform an Exception to SotCapturedException
exc_type = origin_exc.__class__
new_exc_type = cls.get(exc_type)
new_exc = new_exc_type(*origin_exc.args)
new_exc.__cause__ = origin_exc.__cause__
new_exc.__context__ = origin_exc.__context__
new_exc.__suppress_context__ = origin_exc.__suppress_context__
new_exc.__traceback__ = origin_exc.__traceback__
# Propagating Exception Parameters through SotCapturedException
if tracked_args is None:
tracked_args = []
new_exc.tracked_args = tracked_args
return new_exc