Repository navigation
Replace assertion errors on IR assumption violation #7223
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 10 commits
359b5b0
e307287
34dea22
ec01acd
30a4cd2
d67e05d
5463998
9ffdd3d
46a2f9f
edc82f7
d660e36
3d6fb07
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -82,6 +82,20 @@ class NumbaInvalidConfigWarning(NumbaWarning): | |
| Warning category for using an invalid configuration. | ||
| """ | ||
|
|
||
|
|
||
| class NumbaPedanticWarning(NumbaWarning): | ||
| """ | ||
| Warning category for reporting pedantic messages. | ||
| """ | ||
| def __init__(self, msg, **kwargs): | ||
| super().__init__(f"{msg}\n{pedantic_warning_info}") | ||
|
|
||
|
|
||
| class NumbaIRAssumptionWarning(NumbaPedanticWarning): | ||
| """ | ||
| Warning category for reporting an IR assumption violation. | ||
| """ | ||
|
|
||
| # These are needed in the color formatting of errors setup | ||
|
|
||
|
|
||
|
|
@@ -314,6 +328,13 @@ def termcolor(): | |
| _termcolor_inst = HighlightColorScheme(scheme) | ||
| return _termcolor_inst | ||
|
|
||
|
|
||
| pedantic_warning_info = """ | ||
| This warning came from an internal pedantic check. Please report the warning | ||
| message and traceback, along with a minimal reproducer at: | ||
| https://github.com/numba/numba/issues/new | ||
| """ | ||
|
|
||
| feedback_details = """ | ||
| Please report the error message and traceback, along with a minimal reproducer | ||
| at: https://github.com/numba/numba/issues/new | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Do you want to update this URL too, while there?
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Let's do this in a future PR.
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. i've made a task issue for it: #7261 |
||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,25 @@ | ||
| import unittest | ||
| from numba import objmode | ||
| from unittest.case import TestCase | ||
| import warnings | ||
| import numpy as np | ||
|
|
||
| from numba import objmode | ||
| from numba.core import ir, compiler | ||
| from numba.core import errors | ||
| from numba.core.compiler import ( | ||
| CompilerBase, | ||
| ReconstructSSA, | ||
| ) | ||
| from numba.core.compiler_machinery import ( | ||
| FunctionPass, | ||
| PassManager, | ||
| register_pass, | ||
| ) | ||
| from numba.core.untyped_passes import ( | ||
| TranslateByteCode, | ||
| IRProcessing, | ||
| ) | ||
| from numba import njit | ||
|
|
||
|
|
||
| class TestIR(unittest.TestCase): | ||
|
|
@@ -466,5 +484,75 @@ def baz(a, b): | |
| check_diffstr(tmp, ["c + b", "b + c"]) | ||
|
|
||
|
|
||
| class TestIRPedanticChecks(TestCase): | ||
| def test_var_in_scope_assumption(self): | ||
| # Create a pass that clears ir.Scope in ir.Block | ||
| @register_pass(mutates_CFG=False, analysis_only=False) | ||
| class RemoveVarInScope(FunctionPass): | ||
| _name = "_remove_var_in_scope" | ||
|
|
||
| def __init__(self): | ||
| FunctionPass.__init__(self) | ||
|
|
||
| # implement method to do the work, "state" is the internal compiler | ||
| # state from the CompilerBase instance. | ||
| def run_pass(self, state): | ||
| func_ir = state.func_ir | ||
| # walk the blocks | ||
| for blk in func_ir.blocks.values(): | ||
| oldscope = blk.scope | ||
| # put in an empty Scope | ||
| blk.scope = ir.Scope(parent=oldscope.parent, | ||
| loc=oldscope.loc) | ||
| return True | ||
|
|
||
| # Create a pass that always fails, to stop the compiler | ||
| @register_pass(mutates_CFG=False, analysis_only=False) | ||
| class FailPass(FunctionPass): | ||
| _name = "_fail" | ||
|
|
||
| def __init__(self, *args, **kwargs): | ||
| FunctionPass.__init__(self) | ||
|
|
||
| def run_pass(self, state): | ||
| # This is unreachable. SSA pass should have raised before this | ||
| # pass when run with `error.NumbaPedanticWarning`s raised as | ||
| # errors. | ||
| raise AssertionError("unreachable") | ||
|
|
||
| class MyCompiler(CompilerBase): | ||
| def define_pipelines(self): | ||
| pm = PassManager("testing pm") | ||
| pm.add_pass(TranslateByteCode, "analyzing bytecode") | ||
| pm.add_pass(IRProcessing, "processing IR") | ||
| pm.add_pass(RemoveVarInScope, "_remove_var_in_scope") | ||
| pm.add_pass(ReconstructSSA, "ssa") | ||
| pm.add_pass(FailPass, "_fail") | ||
| pm.finalize() | ||
| return [pm] | ||
|
|
||
| @njit(pipeline_class=MyCompiler) | ||
| def dummy(x): | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Perhaps add a comment explaining why this
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. done in 3d6fb07 |
||
| a = 1 | ||
| b = 2 | ||
| if a < b: | ||
| a = 2 | ||
| else: | ||
| b = 3 | ||
| return a, b | ||
|
|
||
| with warnings.catch_warnings(): | ||
| # Make NumbaPedanticWarning an error | ||
| warnings.simplefilter("error", errors.NumbaPedanticWarning) | ||
| # Catch NumbaIRAssumptionWarning | ||
| with self.assertRaises(errors.NumbaIRAssumptionWarning) as raises: | ||
| dummy(1) | ||
| # Verify the error message | ||
| self.assertRegex( | ||
| str(raises.exception), | ||
| r"variable '[a-z]' is not in scope", | ||
| ) | ||
|
|
||
|
|
||
| if __name__ == '__main__': | ||
| unittest.main() | ||
Uh oh!
There was an error while loading. Please reload this page.