-
Notifications
You must be signed in to change notification settings - Fork 15.3k
[LLDB] Add type casting to DIL, part 1 of 3. #165199
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
base: main
Are you sure you want to change the base?
Changes from 2 commits
44cf7ad
3e53e25
9b3d261
f6c7946
eb27812
215160a
e682895
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 |
|---|---|---|
|
|
@@ -21,6 +21,7 @@ enum class NodeKind { | |
| eArraySubscriptNode, | ||
| eBitExtractionNode, | ||
| eBooleanLiteralNode, | ||
| eCastNode, | ||
| eErrorNode, | ||
| eFloatLiteralNode, | ||
| eIdentifierNode, | ||
|
|
@@ -35,6 +36,14 @@ enum class UnaryOpKind { | |
| Deref, // "*" | ||
| }; | ||
|
|
||
| /// The type casts allowed by DIL. | ||
| enum class CastKind { | ||
| eEnumeration, /// Casting from a scalar to an enumeration type | ||
|
||
| eNullptr, /// Casting to a nullptr type | ||
| eReference, /// Casting to a reference type | ||
| eNone, /// Type promotion casting | ||
| }; | ||
|
|
||
| /// Forward declaration, for use in DIL AST nodes. Definition is at the very | ||
| /// end of this file. | ||
| class Visitor; | ||
|
|
@@ -244,6 +253,29 @@ class BooleanLiteralNode : public ASTNode { | |
| bool m_value; | ||
| }; | ||
|
|
||
| class CastNode : public ASTNode { | ||
| public: | ||
| CastNode(uint32_t location, CompilerType type, ASTNodeUP operand, | ||
| CastKind kind) | ||
| : ASTNode(location, NodeKind::eCastNode), m_type(type), | ||
| m_operand(std::move(operand)), m_cast_kind(kind) {} | ||
|
|
||
| llvm::Expected<lldb::ValueObjectSP> Accept(Visitor *v) const override; | ||
|
|
||
| CompilerType GetType() const { return m_type; } | ||
| ASTNode *GetOperand() const { return m_operand.get(); } | ||
| CastKind GetCastKind() const { return m_cast_kind; } | ||
|
|
||
| static bool classof(const ASTNode *node) { | ||
| return node->GetKind() == NodeKind::eCastNode; | ||
| } | ||
|
|
||
| private: | ||
| CompilerType m_type; | ||
| ASTNodeUP m_operand; | ||
| CastKind m_cast_kind; | ||
| }; | ||
|
|
||
| /// This class contains one Visit method for each specialized type of | ||
| /// DIL AST node. The Visit methods are used to dispatch a DIL AST node to | ||
| /// the correct function in the DIL expression evaluator for evaluating that | ||
|
|
@@ -267,6 +299,8 @@ class Visitor { | |
| Visit(const FloatLiteralNode *node) = 0; | ||
| virtual llvm::Expected<lldb::ValueObjectSP> | ||
| Visit(const BooleanLiteralNode *node) = 0; | ||
| virtual llvm::Expected<lldb::ValueObjectSP> | ||
| Visit(const CastNode *node) = 0; | ||
| }; | ||
|
|
||
| } // namespace lldb_private::dil | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -608,4 +608,16 @@ Interpreter::Visit(const BooleanLiteralNode *node) { | |
| return ValueObject::CreateValueObjectFromBool(m_target, value, "result"); | ||
| } | ||
|
|
||
| llvm::Expected<lldb::ValueObjectSP> | ||
| Interpreter::Visit(const CastNode *node) { | ||
| auto operand_or_err = Evaluate(node->GetOperand()); | ||
| if (!operand_or_err) | ||
| return operand_or_err; | ||
|
|
||
| lldb::ValueObjectSP operand = *operand_or_err; | ||
| // Don't actually do the cast for now -- that code will be added later. | ||
| // For now just return the original operand, unchanged. | ||
| return operand; | ||
|
||
| } | ||
|
|
||
| } // namespace lldb_private::dil | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -12,7 +12,9 @@ | |
| //===----------------------------------------------------------------------===// | ||
|
|
||
| #include "lldb/ValueObject/DILParser.h" | ||
| #include "lldb/Symbol/CompileUnit.h" | ||
| #include "lldb/Target/ExecutionContextScope.h" | ||
| #include "lldb/Target/LanguageRuntime.h" | ||
| #include "lldb/Utility/DiagnosticsRendering.h" | ||
| #include "lldb/ValueObject/DILAST.h" | ||
| #include "lldb/ValueObject/DILEval.h" | ||
|
|
@@ -80,15 +82,63 @@ ASTNodeUP DILParser::Run() { | |
| // Parse an expression. | ||
| // | ||
| // expression: | ||
| // unary_expression | ||
| // cast_expression | ||
| // | ||
| ASTNodeUP DILParser::ParseExpression() { return ParseUnaryExpression(); } | ||
| ASTNodeUP DILParser::ParseExpression() { return ParseCastExpression(); } | ||
|
|
||
| // Parse a cast_expression. | ||
| // | ||
| // cast_expression: | ||
| // unary_expression | ||
| // "(" type_id ")" cast_expression | ||
|
|
||
| ASTNodeUP DILParser::ParseCastExpression() { | ||
| if (!CurToken().Is(Token::l_paren)) | ||
| return ParseUnaryExpression(); | ||
|
|
||
| // This could be a type cast, try parsing the contents as a type declaration. | ||
| Token token = CurToken(); | ||
| uint32_t loc = token.GetLocation(); | ||
|
|
||
| // Enable lexer backtracking, so that we can rollback in case it's not | ||
| // actually a type declaration. | ||
|
|
||
| // Start tentative parsing (save token location/idx, for possible rollback). | ||
| uint32_t save_token_idx = m_dil_lexer.GetCurrentTokenIdx(); | ||
|
|
||
| // Consume the token only after enabling the backtracking. | ||
| m_dil_lexer.Advance(); | ||
|
|
||
| // Try parsing the type declaration. If the returned value is not valid, | ||
| // then we should rollback and try parsing the expression. | ||
| auto type_id = ParseTypeId(); | ||
| if (type_id) { | ||
| // Successfully parsed the type declaration. Commit the backtracked | ||
| // tokens and parse the cast_expression. | ||
|
|
||
| if (!type_id.value().IsValid()) | ||
| return std::make_unique<ErrorNode>(); | ||
|
|
||
| Expect(Token::r_paren); | ||
| m_dil_lexer.Advance(); | ||
| auto rhs = ParseCastExpression(); | ||
|
|
||
| return std::make_unique<CastNode>( | ||
| loc, type_id.value(), std::move(rhs), CastKind::eNone); | ||
| } | ||
|
|
||
| // Failed to parse the contents of the parentheses as a type declaration. | ||
| // Rollback the lexer and try parsing it as unary_expression. | ||
| TentativeParsingRollback(save_token_idx); | ||
|
|
||
| return ParseUnaryExpression(); | ||
| } | ||
|
|
||
| // Parse an unary_expression. | ||
| // | ||
| // unary_expression: | ||
| // postfix_expression | ||
| // unary_operator expression | ||
| // unary_operator cast_expression | ||
| // | ||
| // unary_operator: | ||
| // "&" | ||
|
|
@@ -99,7 +149,7 @@ ASTNodeUP DILParser::ParseUnaryExpression() { | |
| Token token = CurToken(); | ||
| uint32_t loc = token.GetLocation(); | ||
| m_dil_lexer.Advance(); | ||
| auto rhs = ParseExpression(); | ||
| auto rhs = ParseCastExpression(); | ||
| switch (token.GetKind()) { | ||
| case Token::star: | ||
| return std::make_unique<UnaryOpNode>(loc, UnaryOpKind::Deref, | ||
|
|
@@ -274,6 +324,81 @@ std::string DILParser::ParseNestedNameSpecifier() { | |
| } | ||
| } | ||
|
|
||
| // Parse a type_id. | ||
| // | ||
| // type_id: | ||
| // type_specifier_seq [abstract_declarator] | ||
| // | ||
| // type_specifier_seq: | ||
| // type_specifier [type_specifier] | ||
| // | ||
| // type_specifier: | ||
| // ["::"] [nested_name_specifier] type_name // not handled for now! | ||
| // builtin_typename | ||
| // | ||
| std::optional<CompilerType> DILParser::ParseTypeId() { | ||
| CompilerType type; | ||
| // For now only allow builtin types -- will expand add to this later. | ||
| auto maybe_builtin_type = ParseBuiltinType(); | ||
| if (maybe_builtin_type) { | ||
| type = *maybe_builtin_type; | ||
| } else | ||
| return {}; | ||
|
|
||
| // | ||
| // abstract_declarator: | ||
| // ptr_operator [abstract_declarator] | ||
| // | ||
| std::vector<Token> ptr_operators; | ||
| while (CurToken().IsOneOf({Token::star, Token::amp})) { | ||
| Token tok = CurToken(); | ||
| ptr_operators.push_back(std::move(tok)); | ||
| m_dil_lexer.Advance(); | ||
| } | ||
| type = ResolveTypeDeclarators(type, ptr_operators); | ||
|
|
||
| return type; | ||
| } | ||
|
|
||
| // Parse a built-in type | ||
| // | ||
| // builtin_typename: | ||
| // identifer_seq | ||
| // | ||
| // identifier_seq | ||
| // identifer [identifier_seq] | ||
| // | ||
| // A built-in type can be a single identifier or a space-separated | ||
| // list of identifiers (e.g. "short" or "long long"). | ||
| std::optional<CompilerType> DILParser::ParseBuiltinType() { | ||
| std::string type_name = ""; | ||
| uint32_t save_token_idx = m_dil_lexer.GetCurrentTokenIdx(); | ||
| bool first_word = true; | ||
| while (CurToken().GetKind() == Token::identifier) { | ||
| if (CurToken().GetSpelling() == "const" || | ||
| CurToken().GetSpelling() == "volatile") | ||
Michael137 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| continue; | ||
| if (!first_word) | ||
| type_name.push_back(' '); | ||
| else | ||
| first_word = false; | ||
| type_name.append(CurToken().GetSpelling()); | ||
| m_dil_lexer.Advance(); | ||
| } | ||
|
|
||
| if (type_name.size() > 0) { | ||
| lldb::TargetSP target_sp = m_ctx_scope->CalculateTarget(); | ||
| ConstString const_type_name(type_name.c_str()); | ||
| for (auto type_system_sp : target_sp->GetScratchTypeSystems()) | ||
| if (auto compiler_type = | ||
| type_system_sp->GetBuiltinTypeByName(const_type_name)) | ||
| return compiler_type; | ||
| } | ||
|
|
||
| TentativeParsingRollback(save_token_idx); | ||
| return {}; | ||
| } | ||
|
|
||
| // Parse an id_expression. | ||
| // | ||
| // id_expression: | ||
|
|
@@ -339,6 +464,40 @@ std::string DILParser::ParseUnqualifiedId() { | |
| return identifier; | ||
| } | ||
|
|
||
| CompilerType | ||
| DILParser::ResolveTypeDeclarators(CompilerType type, | ||
| const std::vector<Token> &ptr_operators) { | ||
| CompilerType bad_type; | ||
|
||
| // Resolve pointers/references. | ||
| for (Token tk : ptr_operators) { | ||
| uint32_t loc = tk.GetLocation(); | ||
| if (tk.GetKind() == Token::star) { | ||
| // Pointers to reference types are forbidden. | ||
| if (type.IsReferenceType()) { | ||
| BailOut(llvm::formatv("'type name' declared as a pointer to a " | ||
| "reference of type {0}", | ||
| type.TypeDescription()), | ||
| loc, CurToken().GetSpelling().length()); | ||
| return bad_type; | ||
| } | ||
|
Comment on lines
482
to
489
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. Is this too C++ specific? Maybe this should live in TypeSystem?
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. Makes me think, should we support references at all for now? Might be wrong, but I'd think casting to a reference type is not a super common use-case. Once we add Again, if this has already been discussed elsewhere, feel free to ignore
Contributor
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 guess we could drop cast to &, we don't have an assignment operator yet anyway. The check should stay regardless though, because if DIL cannot handle something, it must return an error rather then an incorrect value. But in general, this is a C-style cast with C-style syntax, I think it should be expected to be used only with C/C++ code, since DIL will be mostly used automatically without the programmer knowing that DIL will try to evaluate the expression before the compiler.
Contributor
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. Is it hurting anything to leave this in for now?
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.
But isn't DIL supposed to be the de-facto inspection language? Regardless of what language you're debugging. Yes it follows mostly C/C++ syntax but here you are checking explicitly C++ language semantics, not just syntax. Maybe I'm incorrectly delineating DIL and the language plugins. E.g., an alternative would be to say: And the language plugin decide whether it can create a pointer to a reference type. Wdyt?
Collaborator
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. It is the intention of the DIL to be the general introspection language. We should try to make it useable to people who aren't just debugging C but the overall idea is that most people are familiar with C so making the syntax look C-ish is a good way to achieve that goal. Remember that this is not the expression parser, whose job it is to capture all the subtleties of any given language. This is primarily a way to examine data values.
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. My concern was that if we have something like: Why is the DIL parser deciding that this is an invalid cast for all languages? Shouldn't that be the TypeSystem's job? In my mind the DIL parser just consumes tokens and dispatches to the relevant type system to conjure up the types that it thinks it needs to create. And if the TypeSystem doesn't allow making a pointer type to a reference type, then so be it. Am I being overly pedantic here? I don't mind keeping this here, just wanted to make sure I understand the interaction between TypeSystem and DIL.
Collaborator
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. Since the DIL is interpreting:
Contributor
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.
@Michael137 @jimingham So, on the one hand, what's the point going out of the way supporting C-style cast on languages with different reference symbol, or no explicit references at all (like Swift, if I understand correctly)? For someone to do this, they would need to know about DIL and to know that it is allowed to replace a reference symbol But for now it's probably a good idea anyway to check pointer/reference operators during evaluation, although disallowing reference to pointer and reference to reference is exclusive to this cast. Normally, we can do that, so existing type system functions like
Collaborator
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. The DIL implements the inspection of values in memory. The operations it supports aren't intended to be "language accurate", for instance we aren't calling overloaded operators, etc. And because of the ways you can name the children provided by synthetic child providers, it may even not describe the objects as they might appear in the source language. |
||
| // Get pointer type for the base type: e.g. int* -> int**. | ||
| type = type.GetPointerType(); | ||
|
|
||
| } else if (tk.GetKind() == Token::amp) { | ||
| // References to references are forbidden. | ||
| if (type.IsReferenceType()) { | ||
|
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. Should we add a FIXME for rvalue references (i.e.,
Contributor
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. |
||
| BailOut("type name declared as a reference to a reference", loc, | ||
| CurToken().GetSpelling().length()); | ||
| return bad_type; | ||
| } | ||
| // Get reference type for the base type: e.g. int -> int&. | ||
| type = type.GetLValueReferenceType(); | ||
| } | ||
| } | ||
|
|
||
| return type; | ||
| } | ||
|
|
||
| // Parse an boolean_literal. | ||
| // | ||
| // boolean_literal: | ||
|
|
||
Uh oh!
There was an error while loading. Please reload this page.