Files
clang-p2996/lldb/test/API/commands/expression/dont_allow_jit/TestAllowJIT.py
Raphael Isemann d616a6bd10 [lldb] Fix that the expression commands --top-level flag overwrites --allow-jit false
The `--allow-jit` flag allows the user to force the IR interpreter to run the
provided expression.

The `--top-level` flag parses and injects the code as if its in the top level
scope of a source file.

Both flags just change the ExecutionPolicy of the expression:
* `--allow-jit true` -> doesn't change anything (its the default)
* `--allow-jit false` -> ExecutionPolicyNever
* `--top-level` -> ExecutionPolicyTopLevel

Passing `--allow-jit false` and `--top-level` currently causes the `--top-level`
to silently overwrite the ExecutionPolicy value that was set by `--allow-jit
false`. There isn't any ExecutionPolicy value that says "top-level but only
interpret", so I would say we reject this combination of flags until someone
finds time to refactor top-level feature out of the ExecutionPolicy enum.

The SBExpressionOptions suffer from a similar symptom as `SetTopLevel` and
`SetAllowJIT` just silently disable each other. But those functions don't have
any error handling, so not a lot we can do about this in the meantime.

Reviewed By: labath, kastiglione

Differential Revision: https://reviews.llvm.org/D91780
2021-04-22 18:51:03 +02:00

96 lines
4.0 KiB
Python

"""
Test that --allow-jit=false does disallow JITting:
"""
import lldb
import lldbsuite.test.lldbutil as lldbutil
from lldbsuite.test.lldbtest import *
from lldbsuite.test.decorators import *
class TestAllowJIT(TestBase):
mydir = TestBase.compute_mydir(__file__)
# If your test case doesn't stress debug info, the
# set this to true. That way it won't be run once for
# each debug info format.
NO_DEBUG_INFO_TESTCASE = True
def test_allow_jit_expr_command(self):
"""Test the --allow-jit command line flag"""
self.build()
self.main_source_file = lldb.SBFileSpec("main.c")
self.expr_cmd_test()
def test_allow_jit_options(self):
"""Test the SetAllowJIT SBExpressionOption setting"""
self.build()
self.main_source_file = lldb.SBFileSpec("main.c")
self.expr_options_test()
def expr_cmd_test(self):
(target, process, thread, bkpt) = lldbutil.run_to_source_breakpoint(self,
"Set a breakpoint here", self.main_source_file)
frame = thread.GetFrameAtIndex(0)
# First make sure we can call the function with
interp = self.dbg.GetCommandInterpreter()
self.expect("expr --allow-jit 1 -- call_me(10)",
substrs = ["(int) $", "= 18"])
# Now make sure it fails with the "can't IR interpret message" if allow-jit is false:
self.expect("expr --allow-jit 0 -- call_me(10)",
error=True,
substrs = ["Can't evaluate the expression without a running target"])
def expr_options_test(self):
(target, process, thread, bkpt) = lldbutil.run_to_source_breakpoint(self,
"Set a breakpoint here", self.main_source_file)
frame = thread.GetFrameAtIndex(0)
# First make sure we can call the function with the default option set.
options = lldb.SBExpressionOptions()
# Check that the default is to allow JIT:
self.assertEqual(options.GetAllowJIT(), True, "Default is true")
# Now use the options:
result = frame.EvaluateExpression("call_me(10)", options)
self.assertSuccess(result.GetError())
self.assertEqual(result.GetValueAsSigned(), 18, "got the right value.")
# Now disallow JIT and make sure it fails:
options.SetAllowJIT(False)
# Check that we got the right value:
self.assertEqual(options.GetAllowJIT(), False, "Got False after setting to False")
# Again use it and ensure we fail:
result = frame.EvaluateExpression("call_me(10)", options)
self.assertTrue(result.GetError().Fail(), "expression failed with no JIT")
self.assertIn("Can't evaluate the expression without a running target", result.GetError().GetCString(), "Got right error")
# Finally set the allow JIT value back to true and make sure that works:
options.SetAllowJIT(True)
self.assertEqual(options.GetAllowJIT(), True, "Set back to True correctly")
# And again, make sure this works:
result = frame.EvaluateExpression("call_me(10)", options)
self.assertSuccess(result.GetError())
self.assertEqual(result.GetValueAsSigned(), 18, "got the right value.")
def test_allow_jit_with_top_level(self):
"""Test combined --allow-jit and --top-level flags"""
# Can't force interpreting for top-level expressions which are always
# injected.
self.expect("expr --allow-jit false --top-level -- int i;", error=True,
substrs=["Can't disable JIT compilation for top-level expressions."])
self.build()
lldbutil.run_to_source_breakpoint(self, "Set a breakpoint here", lldb.SBFileSpec("main.c"))
# Allowing JITing for top-level expressions is redundant but should work.
self.expect("expr --allow-jit true --top-level -- int top_level_f() { return 2; }")
# Make sure we actually declared a working top-level function.
self.expect_expr("top_level_f()", result_value="2")