[Lldb-commits] [lldb] Add a new SBExpressionOptions::SetLanguage() API (NFCI) (PR #89981)
via lldb-commits
lldb-commits at lists.llvm.org
Wed Apr 24 12:57:56 PDT 2024
llvmbot wrote:
<!--LLVM PR SUMMARY COMMENT-->
@llvm/pr-subscribers-lldb
Author: Adrian Prantl (adrian-prantl)
<details>
<summary>Changes</summary>
that separates out language and version. To avoid reinventing the wheel and introducing subtle incompatibilities, this API uses the table of languages and versiond defined by the upcoming DWARF 6 standard (https://dwarfstd.org/languages-v6.html). While the DWARF 6 spec is not finialized, the list of languages is broadly considered stable.
The primary motivation for this is to allow the Swift language plugin to switch between language dialects between, e.g., Swift 5.9 and 6.0 with out introducing a ton of new language codes. On the main branch this change is considered NFC.
Depends on https://github.com/llvm/llvm-project/pull/89980
---
Patch is 34.69 KiB, truncated to 20.00 KiB below, full version: https://github.com/llvm/llvm-project/pull/89981.diff
24 Files Affected:
- (modified) lldb/include/lldb/API/SBExpressionOptions.h (+4)
- (modified) lldb/include/lldb/Expression/Expression.h (+2-5)
- (modified) lldb/include/lldb/Expression/LLVMUserExpression.h (+1-1)
- (modified) lldb/include/lldb/Expression/UserExpression.h (+18-15)
- (modified) lldb/include/lldb/Symbol/TypeSystem.h (+4-6)
- (modified) lldb/include/lldb/Target/StackFrame.h (+5-6)
- (modified) lldb/include/lldb/Target/Target.h (+14-5)
- (modified) lldb/include/lldb/lldb-private-types.h (+19)
- (modified) lldb/source/API/SBExpressionOptions.cpp (+7)
- (modified) lldb/source/API/SBFrame.cpp (+17-13)
- (modified) lldb/source/Breakpoint/Watchpoint.cpp (+2-3)
- (modified) lldb/source/Commands/CommandObjectDWIMPrint.cpp (+1-1)
- (modified) lldb/source/Commands/CommandObjectType.cpp (+1-1)
- (modified) lldb/source/Expression/LLVMUserExpression.cpp (+1-1)
- (modified) lldb/source/Expression/UserExpression.cpp (+8-6)
- (modified) lldb/source/Expression/UtilityFunction.cpp (+2-2)
- (modified) lldb/source/Plugins/ExpressionParser/Clang/ClangExpressionParser.cpp (+6-6)
- (modified) lldb/source/Plugins/ExpressionParser/Clang/ClangUserExpression.cpp (+10-9)
- (modified) lldb/source/Plugins/ExpressionParser/Clang/ClangUserExpression.h (+3-3)
- (modified) lldb/source/Plugins/TypeSystem/Clang/TypeSystemClang.cpp (+1-1)
- (modified) lldb/source/Plugins/TypeSystem/Clang/TypeSystemClang.h (+6-6)
- (modified) lldb/source/Target/Language.cpp (+34)
- (modified) lldb/source/Target/StackFrame.cpp (+10-13)
- (modified) lldb/source/Target/Target.cpp (+11-10)
``````````diff
diff --git a/lldb/include/lldb/API/SBExpressionOptions.h b/lldb/include/lldb/API/SBExpressionOptions.h
index e0ddfda5ba37a2..0f2d298d7513fe 100644
--- a/lldb/include/lldb/API/SBExpressionOptions.h
+++ b/lldb/include/lldb/API/SBExpressionOptions.h
@@ -67,6 +67,10 @@ class LLDB_API SBExpressionOptions {
void SetTrapExceptions(bool trap_exceptions = true);
void SetLanguage(lldb::LanguageType language);
+ /// Set the language using a pair of language code and version as
+ /// defined by the DWARF 6 specification.
+ /// WARNING: These codes may change until DWARF 6 is finalized.
+ void SetLanguage(uint16_t dwarf_lname_code, uint32_t dwarf_lversion);
#ifndef SWIG
void SetCancelCallback(lldb::ExpressionCancelCallback callback, void *baton);
diff --git a/lldb/include/lldb/Expression/Expression.h b/lldb/include/lldb/Expression/Expression.h
index 3e61d78828bbbf..356fe4b82ae43a 100644
--- a/lldb/include/lldb/Expression/Expression.h
+++ b/lldb/include/lldb/Expression/Expression.h
@@ -47,11 +47,8 @@ class Expression {
/// expression. Text() should contain the definition of this function.
virtual const char *FunctionName() = 0;
- /// Return the language that should be used when parsing. To use the
- /// default, return eLanguageTypeUnknown.
- virtual lldb::LanguageType Language() const {
- return lldb::eLanguageTypeUnknown;
- }
+ /// Return the language that should be used when parsing.
+ virtual SourceLanguage Language() const { return {}; }
/// Return the Materializer that the parser should use when registering
/// external values.
diff --git a/lldb/include/lldb/Expression/LLVMUserExpression.h b/lldb/include/lldb/Expression/LLVMUserExpression.h
index 7d32d17dbf544c..40b463933c07e8 100644
--- a/lldb/include/lldb/Expression/LLVMUserExpression.h
+++ b/lldb/include/lldb/Expression/LLVMUserExpression.h
@@ -52,7 +52,7 @@ class LLVMUserExpression : public UserExpression {
};
LLVMUserExpression(ExecutionContextScope &exe_scope, llvm::StringRef expr,
- llvm::StringRef prefix, lldb::LanguageType language,
+ llvm::StringRef prefix, SourceLanguage language,
ResultType desired_type,
const EvaluateExpressionOptions &options);
~LLVMUserExpression() override;
diff --git a/lldb/include/lldb/Expression/UserExpression.h b/lldb/include/lldb/Expression/UserExpression.h
index b6cfeec7e89933..b04d00b72e8faa 100644
--- a/lldb/include/lldb/Expression/UserExpression.h
+++ b/lldb/include/lldb/Expression/UserExpression.h
@@ -56,7 +56,7 @@ class UserExpression : public Expression {
/// If not eResultTypeAny, the type to use for the expression
/// result.
UserExpression(ExecutionContextScope &exe_scope, llvm::StringRef expr,
- llvm::StringRef prefix, lldb::LanguageType language,
+ llvm::StringRef prefix, SourceLanguage language,
ResultType desired_type,
const EvaluateExpressionOptions &options);
@@ -202,7 +202,7 @@ class UserExpression : public Expression {
virtual bool IsParseCacheable() { return true; }
/// Return the language that should be used when parsing. To use the
/// default, return eLanguageTypeUnknown.
- lldb::LanguageType Language() const override { return m_language; }
+ SourceLanguage Language() const override { return m_language; }
/// Return the desired result type of the function, or eResultTypeAny if
/// indifferent.
@@ -315,19 +315,22 @@ class UserExpression : public Expression {
lldb::ProcessSP &process_sp,
lldb::StackFrameSP &frame_sp);
- Address m_address; ///< The address the process is stopped in.
- std::string m_expr_text; ///< The text of the expression, as typed by the user
- std::string m_expr_prefix; ///< The text of the translation-level definitions,
- ///as provided by the user
- std::string m_fixed_text; ///< The text of the expression with fix-its applied
- ///- this won't be set if the fixed text doesn't
- ///parse.
- lldb::LanguageType m_language; ///< The language to use when parsing
- ///(eLanguageTypeUnknown means use defaults)
- ResultType m_desired_type; ///< The type to coerce the expression's result to.
- ///If eResultTypeAny, inferred from the expression.
- EvaluateExpressionOptions
- m_options; ///< Additional options provided by the user.
+ /// The address the process is stopped in.
+ Address m_address;
+ /// The text of the expression, as typed by the user.
+ std::string m_expr_text;
+ /// The text of the translation-level definitions, as provided by the user.
+ std::string m_expr_prefix;
+ /// The text of the expression with fix-its applied this won't be set if the
+ /// fixed text doesn't parse.
+ std::string m_fixed_text;
+ /// The language to use when parsing (unknown means use defaults).
+ SourceLanguage m_language;
+ /// The type to coerce the expression's result to. If eResultTypeAny, inferred
+ /// from the expression.
+ ResultType m_desired_type;
+ /// Additional options provided by the user.
+ EvaluateExpressionOptions m_options;
};
} // namespace lldb_private
diff --git a/lldb/include/lldb/Symbol/TypeSystem.h b/lldb/include/lldb/Symbol/TypeSystem.h
index 3a927d313b823d..6221e6d2e5d834 100644
--- a/lldb/include/lldb/Symbol/TypeSystem.h
+++ b/lldb/include/lldb/Symbol/TypeSystem.h
@@ -474,12 +474,10 @@ class TypeSystem : public PluginInterface,
return IsPointerOrReferenceType(type, nullptr);
}
- virtual UserExpression *
- GetUserExpression(llvm::StringRef expr, llvm::StringRef prefix,
- lldb::LanguageType language,
- Expression::ResultType desired_type,
- const EvaluateExpressionOptions &options,
- ValueObject *ctx_obj) {
+ virtual UserExpression *GetUserExpression(
+ llvm::StringRef expr, llvm::StringRef prefix, SourceLanguage language,
+ Expression::ResultType desired_type,
+ const EvaluateExpressionOptions &options, ValueObject *ctx_obj) {
return nullptr;
}
diff --git a/lldb/include/lldb/Target/StackFrame.h b/lldb/include/lldb/Target/StackFrame.h
index 6c18511c6e1ac3..259f8f9da0d1c7 100644
--- a/lldb/include/lldb/Target/StackFrame.h
+++ b/lldb/include/lldb/Target/StackFrame.h
@@ -446,13 +446,12 @@ class StackFrame : public ExecutionContextScope,
/// Query this frame to determine what the default language should be when
/// parsing expressions given the execution context.
///
- /// \return
- /// The language of the frame if known, else lldb::eLanguageTypeUnknown.
- lldb::LanguageType GetLanguage();
+ /// \return The language of the frame if known.
+ SourceLanguage GetLanguage();
- // similar to GetLanguage(), but is allowed to take a potentially incorrect
- // guess if exact information is not available
- lldb::LanguageType GuessLanguage();
+ /// Similar to GetLanguage(), but is allowed to take a potentially incorrect
+ /// guess if exact information is not available
+ SourceLanguage GuessLanguage();
/// Attempt to econstruct the ValueObject for a given raw address touched by
/// the current instruction. The ExpressionPath should indicate how to get
diff --git a/lldb/include/lldb/Target/Target.h b/lldb/include/lldb/Target/Target.h
index 2c2e6b2831ccee..e7b1f5ca78592e 100644
--- a/lldb/include/lldb/Target/Target.h
+++ b/lldb/include/lldb/Target/Target.h
@@ -200,7 +200,7 @@ class TargetProperties : public Properties {
bool GetBreakpointsConsultPlatformAvoidList();
- lldb::LanguageType GetLanguage() const;
+ SourceLanguage GetLanguage() const;
llvm::StringRef GetExpressionPrefixContents();
@@ -310,9 +310,18 @@ class EvaluateExpressionOptions {
m_execution_policy = policy;
}
- lldb::LanguageType GetLanguage() const { return m_language; }
+ SourceLanguage GetLanguage() const { return m_language; }
- void SetLanguage(lldb::LanguageType language) { m_language = language; }
+ void SetLanguage(lldb::LanguageType language_type) {
+ m_language = SourceLanguage(language_type);
+ }
+
+ /// Set the language using a pair of language code and version as
+ /// defined by the DWARF 6 specification.
+ /// WARNING: These codes may change until DWARF 6 is finalized.
+ void SetLanguage(uint16_t dwarf_lname_code, uint32_t dwarf_lversion) {
+ m_language = SourceLanguage(dwarf_lname_code, dwarf_lversion);
+ }
bool DoesCoerceToId() const { return m_coerce_to_id; }
@@ -445,7 +454,7 @@ class EvaluateExpressionOptions {
private:
ExecutionPolicy m_execution_policy = default_execution_policy;
- lldb::LanguageType m_language = lldb::eLanguageTypeUnknown;
+ SourceLanguage m_language;
std::string m_prefix;
bool m_coerce_to_id = false;
bool m_unwind_on_error = true;
@@ -1160,7 +1169,7 @@ class Target : public std::enable_shared_from_this<Target>,
UserExpression *
GetUserExpressionForLanguage(llvm::StringRef expr, llvm::StringRef prefix,
- lldb::LanguageType language,
+ SourceLanguage language,
Expression::ResultType desired_type,
const EvaluateExpressionOptions &options,
ValueObject *ctx_obj, Status &error);
diff --git a/lldb/include/lldb/lldb-private-types.h b/lldb/include/lldb/lldb-private-types.h
index 7d301666df1a17..b8779fce28f5a4 100644
--- a/lldb/include/lldb/lldb-private-types.h
+++ b/lldb/include/lldb/lldb-private-types.h
@@ -96,6 +96,25 @@ struct RegisterSet {
const uint32_t *registers;
};
+/// A type-erased pair of llvm::dwarf::SourceLanguageName and version.
+struct SourceLanguage {
+ SourceLanguage() = default;
+ SourceLanguage(lldb::LanguageType language_type);
+ SourceLanguage(uint32_t name, uint16_t version)
+ : name(name), version(version) {}
+ SourceLanguage(std::optional<std::pair<uint32_t, uint16_t>> name_vers)
+ : name(name_vers ? name_vers->first : 0),
+ version(name_vers ? name_vers->second : 0) {}
+ operator bool() const { return name > 0; }
+ lldb::LanguageType AsLanguageType() const;
+ llvm::StringRef GetDescription() const;
+ bool IsC() const;
+ bool IsObjC() const;
+ bool IsCPlusPlus() const;
+ uint16_t name = 0;
+ uint32_t version = 0;
+};
+
struct OptionEnumValueElement {
int64_t value;
const char *string_value;
diff --git a/lldb/source/API/SBExpressionOptions.cpp b/lldb/source/API/SBExpressionOptions.cpp
index bd81a04596b10d..3aea121f7323d4 100644
--- a/lldb/source/API/SBExpressionOptions.cpp
+++ b/lldb/source/API/SBExpressionOptions.cpp
@@ -156,6 +156,13 @@ void SBExpressionOptions::SetLanguage(lldb::LanguageType language) {
m_opaque_up->SetLanguage(language);
}
+void SBExpressionOptions::SetLanguage(uint16_t dwarf_lname_code,
+ uint32_t dwarf_lversion) {
+ LLDB_INSTRUMENT_VA(this, dwarf_lname_code, dwarf_lversion);
+
+ m_opaque_up->SetLanguage(dwarf_lname_code, dwarf_lversion);
+}
+
void SBExpressionOptions::SetCancelCallback(
lldb::ExpressionCancelCallback callback, void *baton) {
LLDB_INSTRUMENT_VA(this, callback, baton);
diff --git a/lldb/source/API/SBFrame.cpp b/lldb/source/API/SBFrame.cpp
index a16bbc2ae7562d..2de1f803aefe4a 100644
--- a/lldb/source/API/SBFrame.cpp
+++ b/lldb/source/API/SBFrame.cpp
@@ -1024,10 +1024,10 @@ SBValue SBFrame::EvaluateExpression(const char *expr) {
options.SetFetchDynamicValue(fetch_dynamic_value);
options.SetUnwindOnError(true);
options.SetIgnoreBreakpoints(true);
- if (target->GetLanguage() != eLanguageTypeUnknown)
- options.SetLanguage(target->GetLanguage());
- else
- options.SetLanguage(frame->GetLanguage());
+ SourceLanguage lang = target->GetLanguage();
+ if (!lang)
+ lang = frame->GetLanguage();
+ options.SetLanguage(lang.name, lang.version);
return EvaluateExpression(expr, options);
} else {
Status error;
@@ -1053,10 +1053,12 @@ SBFrame::EvaluateExpression(const char *expr,
StackFrame *frame = exe_ctx.GetFramePtr();
Target *target = exe_ctx.GetTargetPtr();
- if (target && target->GetLanguage() != eLanguageTypeUnknown)
- options.SetLanguage(target->GetLanguage());
- else if (frame)
- options.SetLanguage(frame->GetLanguage());
+ SourceLanguage language;
+ if (target)
+ language = target->GetLanguage();
+ if (!language && frame)
+ language = frame->GetLanguage();
+ options.SetLanguage(language.name, language.version);
return EvaluateExpression(expr, options);
}
@@ -1074,10 +1076,12 @@ SBValue SBFrame::EvaluateExpression(const char *expr,
options.SetIgnoreBreakpoints(true);
StackFrame *frame = exe_ctx.GetFramePtr();
Target *target = exe_ctx.GetTargetPtr();
- if (target && target->GetLanguage() != eLanguageTypeUnknown)
- options.SetLanguage(target->GetLanguage());
- else if (frame)
- options.SetLanguage(frame->GetLanguage());
+ SourceLanguage language;
+ if (target)
+ language = target->GetLanguage();
+ if (!language && frame)
+ language = frame->GetLanguage();
+ options.SetLanguage(language.name, language.version);
return EvaluateExpression(expr, options);
}
@@ -1218,7 +1222,7 @@ lldb::LanguageType SBFrame::GuessLanguage() const {
if (stop_locker.TryLock(&process->GetRunLock())) {
frame = exe_ctx.GetFramePtr();
if (frame) {
- return frame->GuessLanguage();
+ return frame->GuessLanguage().AsLanguageType();
}
}
}
diff --git a/lldb/source/Breakpoint/Watchpoint.cpp b/lldb/source/Breakpoint/Watchpoint.cpp
index a128ced5750449..edb1a0e93460c4 100644
--- a/lldb/source/Breakpoint/Watchpoint.cpp
+++ b/lldb/source/Breakpoint/Watchpoint.cpp
@@ -460,9 +460,8 @@ void Watchpoint::SetCondition(const char *condition) {
// Pass nullptr for expr_prefix (no translation-unit level definitions).
Status error;
m_condition_up.reset(m_target.GetUserExpressionForLanguage(
- condition, llvm::StringRef(), lldb::eLanguageTypeUnknown,
- UserExpression::eResultTypeAny, EvaluateExpressionOptions(), nullptr,
- error));
+ condition, {}, {}, UserExpression::eResultTypeAny,
+ EvaluateExpressionOptions(), nullptr, error));
if (error.Fail()) {
// FIXME: Log something...
m_condition_up.reset();
diff --git a/lldb/source/Commands/CommandObjectDWIMPrint.cpp b/lldb/source/Commands/CommandObjectDWIMPrint.cpp
index e1255f37d9bc58..f0b37e6832eab0 100644
--- a/lldb/source/Commands/CommandObjectDWIMPrint.cpp
+++ b/lldb/source/Commands/CommandObjectDWIMPrint.cpp
@@ -96,7 +96,7 @@ void CommandObjectDWIMPrint::DoExecute(StringRef command,
// Either Swift was explicitly specified, or the frame is Swift.
lldb::LanguageType language = m_expr_options.language;
if (language == lldb::eLanguageTypeUnknown && frame)
- language = frame->GuessLanguage();
+ language = frame->GuessLanguage().AsLanguageType();
// Add a hint if object description was requested, but no description
// function was implemented.
diff --git a/lldb/source/Commands/CommandObjectType.cpp b/lldb/source/Commands/CommandObjectType.cpp
index 97489bdc2d9c28..46537dd1b98aaf 100644
--- a/lldb/source/Commands/CommandObjectType.cpp
+++ b/lldb/source/Commands/CommandObjectType.cpp
@@ -2509,7 +2509,7 @@ class CommandObjectTypeLookup : public CommandObjectRaw {
if (!frame)
return lang_type;
- lang_type = frame->GuessLanguage();
+ lang_type = frame->GuessLanguage().AsLanguageType();
if (lang_type != lldb::eLanguageTypeUnknown)
return lang_type;
diff --git a/lldb/source/Expression/LLVMUserExpression.cpp b/lldb/source/Expression/LLVMUserExpression.cpp
index 9c31cc84bf8f8b..1434011c80ad81 100644
--- a/lldb/source/Expression/LLVMUserExpression.cpp
+++ b/lldb/source/Expression/LLVMUserExpression.cpp
@@ -42,7 +42,7 @@ char LLVMUserExpression::ID;
LLVMUserExpression::LLVMUserExpression(ExecutionContextScope &exe_scope,
llvm::StringRef expr,
llvm::StringRef prefix,
- lldb::LanguageType language,
+ SourceLanguage language,
ResultType desired_type,
const EvaluateExpressionOptions &options)
: UserExpression(exe_scope, expr, prefix, language, desired_type, options),
diff --git a/lldb/source/Expression/UserExpression.cpp b/lldb/source/Expression/UserExpression.cpp
index c181712a2f0b24..84578c7f9ad272 100644
--- a/lldb/source/Expression/UserExpression.cpp
+++ b/lldb/source/Expression/UserExpression.cpp
@@ -39,6 +39,7 @@
#include "lldb/Utility/Log.h"
#include "lldb/Utility/State.h"
#include "lldb/Utility/StreamString.h"
+#include "llvm/BinaryFormat/Dwarf.h"
using namespace lldb_private;
@@ -46,8 +47,7 @@ char UserExpression::ID;
UserExpression::UserExpression(ExecutionContextScope &exe_scope,
llvm::StringRef expr, llvm::StringRef prefix,
- lldb::LanguageType language,
- ResultType desired_type,
+ SourceLanguage language, ResultType desired_type,
const EvaluateExpressionOptions &options)
: Expression(exe_scope), m_expr_text(std::string(expr)),
m_expr_prefix(std::string(prefix)), m_language(language),
@@ -176,7 +176,7 @@ UserExpression::Evaluate(ExecutionContext &exe_ctx,
}
lldb_private::ExecutionPolicy execution_policy = options.GetExecutionPolicy();
- lldb::LanguageType language = options.GetLanguage();
+ SourceLanguage language = options.GetLanguage();
const ResultType desired_type = options.DoesCoerceToId()
? UserExpression::eResultTypeId
: UserExpression::eResultTypeAny;
@@ -242,7 +242,7 @@ UserExpression::Evaluate(ExecutionContext &exe_ctx,
// If the language was not specified in the expression command, set it to the
// language in the target's properties if specified, else default to the
// langage for the frame.
- if (language == lldb::eLanguageTypeUnknown) {
+ if (!language.name) {
if (target->GetLanguage() != lldb::eLanguageTypeUnknown)
language = target->GetLanguage();
else if (StackFrame *frame = exe_ctx.GetFramePtr())
@@ -384,7 +384,8 @@ UserExpression::Evaluate(ExecutionContext &exe_ctx,
} else {
if (expr_result) {
result_valobj_sp = expr_result->GetValueObject();
- result_valobj_sp->SetPreferredDisplayLanguage(language);
+ result_valobj_sp->SetPreferredDisplayLanguage(
+ language.AsLanguageType());
LLDB_LOG(log,
"== [UserExpression::Evaluate] Execution completed "
@@ -426,7 +427,8 @@ UserExpression::Execute(DiagnosticManager &diagnostic_manager,
Target *target = exe_ctx.GetTargetPtr();
if (options.GetSuppressPersistentResult() && result_var && target) {
if (auto *persistent_state =
- target->GetPersistentExpressionStateForLanguage(m_language))
+ target->GetPersistentExpressionStateForLanguage(
+ m_language.AsLanguageType()))
persistent_state->RemovePersistentVariable(result_var);
}
return expr_result;
diff --git a/lldb/source/Expression/UtilityFunction.cpp b/lldb/source/Expression/UtilityFunction.cpp
index d7a3c9d41d0484..7b34c2c2ff76d5 100644
--- a/lldb/source/Expression/UtilityFunction.cpp
+++ b/lldb/source/Expression/UtilityFunction.cpp
@@ -80,8 +80,8 @@ FunctionCaller *UtilityFunction::MakeFunctionCaller(
name.append("-caller");
m_caller_up.reset(process_sp->GetTarget().GetFunctionCallerForLanguage(
- Language(), return_type, impl_code_address, arg_value_list, name.c_str(),
- error));
+ Language().AsLanguageType(), return_type, impl_code_address,
+ arg_value_list, name.c_str(), error));
if (error.Fail()) {
return nullptr;
diff --git a/lldb/source/Plugins/ExpressionParser/Clang/ClangExpressionParser.cpp b/lldb/source/Plugins/ExpressionParser/Clang/ClangExpressionParser.cpp
index f48bd...
[truncated]
``````````
</details>
https://github.com/llvm/llvm-project/pull/89981
More information about the lldb-commits
mailing list