Skip to content

[lldb][ExpressionParser][NFCI] Add new DoPrepareForExecution interface to be implemented by language plugins #96290

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

Merged
merged 3 commits into from
Jun 22, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 23 additions & 2 deletions lldb/include/lldb/Expression/ExpressionParser.h
Original file line number Diff line number Diff line change
Expand Up @@ -119,14 +119,35 @@ class ExpressionParser {
/// \return
/// An error code indicating the success or failure of the operation.
/// Test with Success().
virtual Status
Status
PrepareForExecution(lldb::addr_t &func_addr, lldb::addr_t &func_end,
std::shared_ptr<IRExecutionUnit> &execution_unit_sp,
ExecutionContext &exe_ctx, bool &can_interpret,
lldb_private::ExecutionPolicy execution_policy) = 0;
lldb_private::ExecutionPolicy execution_policy);

bool GetGenerateDebugInfo() const { return m_generate_debug_info; }

protected:
virtual Status
DoPrepareForExecution(lldb::addr_t &func_addr, lldb::addr_t &func_end,
std::shared_ptr<IRExecutionUnit> &execution_unit_sp,
ExecutionContext &exe_ctx, bool &can_interpret,
lldb_private::ExecutionPolicy execution_policy) = 0;

private:
/// Run all static initializers for an execution unit.
///
/// \param[in] execution_unit_sp
/// The execution unit.
///
/// \param[in] exe_ctx
/// The execution context to use when running them. Thread can't be null.
///
/// \return
/// The error code indicating the
Status RunStaticInitializers(lldb::IRExecutionUnitSP &execution_unit_sp,
ExecutionContext &exe_ctx);

protected:
Expression &m_expr; ///< The expression to be parsed
bool m_generate_debug_info;
Expand Down
1 change: 1 addition & 0 deletions lldb/source/Expression/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ add_lldb_library(lldbExpression NO_PLUGIN_DEPENDENCIES
DWARFExpression.cpp
DWARFExpressionList.cpp
Expression.cpp
ExpressionParser.cpp
ExpressionTypeSystemHelper.cpp
ExpressionVariable.cpp
FunctionCaller.cpp
Expand Down
72 changes: 72 additions & 0 deletions lldb/source/Expression/ExpressionParser.cpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
//===-- ExpressionParser.cpp ----------------------------------------------===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//

#include "lldb/Expression/ExpressionParser.h"
#include "lldb/Expression/DiagnosticManager.h"
#include "lldb/Expression/IRExecutionUnit.h"
#include "lldb/Target/ExecutionContext.h"
#include "lldb/Target/ThreadPlanCallFunction.h"

using namespace lldb;
using namespace lldb_private;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you add using namespace lldb you could drop some lldb:: prefixes.


Status ExpressionParser::PrepareForExecution(
addr_t &func_addr, addr_t &func_end,
std::shared_ptr<IRExecutionUnit> &execution_unit_sp,
ExecutionContext &exe_ctx, bool &can_interpret,
ExecutionPolicy execution_policy) {
Status status =
DoPrepareForExecution(func_addr, func_end, execution_unit_sp, exe_ctx,
can_interpret, execution_policy);
if (status.Success() && exe_ctx.GetProcessPtr() && exe_ctx.HasThreadScope())
status = RunStaticInitializers(execution_unit_sp, exe_ctx);

return status;
}

Status
ExpressionParser::RunStaticInitializers(IRExecutionUnitSP &execution_unit_sp,
ExecutionContext &exe_ctx) {
Status err;

if (!execution_unit_sp.get()) {
err.SetErrorString(
"can't run static initializers for a NULL execution unit");
return err;
}

if (!exe_ctx.HasThreadScope()) {
err.SetErrorString("can't run static initializers without a thread");
return err;
}

std::vector<addr_t> static_initializers;

execution_unit_sp->GetStaticInitializers(static_initializers);

for (addr_t static_initializer : static_initializers) {
EvaluateExpressionOptions options;

ThreadPlanSP call_static_initializer(new ThreadPlanCallFunction(
exe_ctx.GetThreadRef(), Address(static_initializer), CompilerType(),
llvm::ArrayRef<addr_t>(), options));

DiagnosticManager execution_errors;
ExpressionResults results =
exe_ctx.GetThreadRef().GetProcess()->RunThreadPlan(
exe_ctx, call_static_initializer, options, execution_errors);

if (results != eExpressionCompleted) {
err.SetErrorStringWithFormat("couldn't run static initializer: %s",
execution_errors.GetString().c_str());
return err;
}
}

return err;
}
Original file line number Diff line number Diff line change
Expand Up @@ -1296,7 +1296,7 @@ static bool FindFunctionInModule(ConstString &mangled_name,
return false;
}

lldb_private::Status ClangExpressionParser::PrepareForExecution(
lldb_private::Status ClangExpressionParser::DoPrepareForExecution(
lldb::addr_t &func_addr, lldb::addr_t &func_end,
lldb::IRExecutionUnitSP &execution_unit_sp, ExecutionContext &exe_ctx,
bool &can_interpret, ExecutionPolicy execution_policy) {
Expand Down Expand Up @@ -1472,47 +1472,3 @@ lldb_private::Status ClangExpressionParser::PrepareForExecution(

return err;
}

lldb_private::Status ClangExpressionParser::RunStaticInitializers(
lldb::IRExecutionUnitSP &execution_unit_sp, ExecutionContext &exe_ctx) {
lldb_private::Status err;

lldbassert(execution_unit_sp.get());
lldbassert(exe_ctx.HasThreadScope());

if (!execution_unit_sp.get()) {
err.SetErrorString(
"can't run static initializers for a NULL execution unit");
return err;
}

if (!exe_ctx.HasThreadScope()) {
err.SetErrorString("can't run static initializers without a thread");
return err;
}

std::vector<lldb::addr_t> static_initializers;

execution_unit_sp->GetStaticInitializers(static_initializers);

for (lldb::addr_t static_initializer : static_initializers) {
EvaluateExpressionOptions options;

lldb::ThreadPlanSP call_static_initializer(new ThreadPlanCallFunction(
exe_ctx.GetThreadRef(), Address(static_initializer), CompilerType(),
llvm::ArrayRef<lldb::addr_t>(), options));

DiagnosticManager execution_errors;
lldb::ExpressionResults results =
exe_ctx.GetThreadRef().GetProcess()->RunThreadPlan(
exe_ctx, call_static_initializer, options, execution_errors);

if (results != lldb::eExpressionCompleted) {
err.SetErrorStringWithFormat("couldn't run static initializer: %s",
execution_errors.GetString().c_str());
return err;
}
}

return err;
}
Original file line number Diff line number Diff line change
Expand Up @@ -113,24 +113,11 @@ class ClangExpressionParser : public ExpressionParser {
/// \return
/// An error code indicating the success or failure of the operation.
/// Test with Success().
Status
PrepareForExecution(lldb::addr_t &func_addr, lldb::addr_t &func_end,
lldb::IRExecutionUnitSP &execution_unit_sp,
ExecutionContext &exe_ctx, bool &can_interpret,
lldb_private::ExecutionPolicy execution_policy) override;

/// Run all static initializers for an execution unit.
///
/// \param[in] execution_unit_sp
/// The execution unit.
///
/// \param[in] exe_ctx
/// The execution context to use when running them. Thread can't be null.
///
/// \return
/// The error code indicating the
Status RunStaticInitializers(lldb::IRExecutionUnitSP &execution_unit_sp,
ExecutionContext &exe_ctx);
Status DoPrepareForExecution(
lldb::addr_t &func_addr, lldb::addr_t &func_end,
lldb::IRExecutionUnitSP &execution_unit_sp, ExecutionContext &exe_ctx,
bool &can_interpret,
lldb_private::ExecutionPolicy execution_policy) override;

/// Returns a string representing current ABI.
///
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -698,21 +698,6 @@ bool ClangUserExpression::Parse(DiagnosticManager &diagnostic_manager,
if (!parse_success)
return false;

if (exe_ctx.GetProcessPtr() && execution_policy == eExecutionPolicyTopLevel) {
Status static_init_error =
m_parser->RunStaticInitializers(m_execution_unit_sp, exe_ctx);

if (!static_init_error.Success()) {
const char *error_cstr = static_init_error.AsCString();
if (error_cstr && error_cstr[0])
diagnostic_manager.Printf(lldb::eSeverityError, "%s\n", error_cstr);
else
diagnostic_manager.PutString(lldb::eSeverityError,
"couldn't run static initializers\n");
return false;
}
}

if (m_execution_unit_sp) {
bool register_execution_unit = false;

Expand Down
Loading