LLDB mainline
ClangUserExpression.cpp
Go to the documentation of this file.
1//===-- ClangUserExpression.cpp -------------------------------------------===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8
9#include <cstdio>
10#include <sys/types.h>
11
12#include <cstdlib>
13#include <map>
14#include <string>
15
16#include "ClangUserExpression.h"
17
19#include "ClangASTMetadata.h"
20#include "ClangDiagnostic.h"
26
28#include "lldb/Core/Debugger.h"
29#include "lldb/Core/Module.h"
35#include "lldb/Host/HostInfo.h"
36#include "lldb/Symbol/Block.h"
42#include "lldb/Symbol/Type.h"
45#include "lldb/Target/Process.h"
47#include "lldb/Target/Target.h"
52#include "lldb/Utility/Log.h"
54
55#include "clang/AST/DeclCXX.h"
56#include "clang/AST/DeclObjC.h"
57
58#include "llvm/ADT/ScopeExit.h"
59#include "llvm/BinaryFormat/Dwarf.h"
60
61using namespace lldb_private;
62
64
66 ExecutionContextScope &exe_scope, llvm::StringRef expr,
67 llvm::StringRef prefix, SourceLanguage language, ResultType desired_type,
68 const EvaluateExpressionOptions &options, ValueObject *ctx_obj)
69 : LLVMUserExpression(exe_scope, expr, prefix, language, desired_type,
70 options),
71 m_type_system_helper(*m_target_wp.lock(), options.GetExecutionPolicy() ==
73 m_result_delegate(exe_scope.CalculateTarget()), m_ctx_obj(ctx_obj) {
74 switch (m_language.name) {
75 case llvm::dwarf::DW_LNAME_C_plus_plus:
76 m_allow_cxx = true;
77 break;
78 case llvm::dwarf::DW_LNAME_ObjC:
79 m_allow_objc = true;
80 break;
81 case llvm::dwarf::DW_LNAME_ObjC_plus_plus:
82 default:
83 m_allow_cxx = true;
84 m_allow_objc = true;
85 break;
86 }
87}
88
90
93
94 LLDB_LOGF(log, "ClangUserExpression::ScanContext()");
95
96 m_target = exe_ctx.GetTargetPtr();
97
98 if (!(m_allow_cxx || m_allow_objc)) {
99 LLDB_LOGF(log, " [CUE::SC] Settings inhibit C++ and Objective-C");
100 return;
101 }
102
103 StackFrame *frame = exe_ctx.GetFramePtr();
104 if (frame == nullptr) {
105 LLDB_LOGF(log, " [CUE::SC] Null stack frame");
106 return;
107 }
108
109 SymbolContext sym_ctx = frame->GetSymbolContext(lldb::eSymbolContextFunction |
110 lldb::eSymbolContextBlock);
111
112 if (!sym_ctx.function) {
113 LLDB_LOGF(log, " [CUE::SC] Null function");
114 return;
115 }
116
117 // Find the block that defines the function represented by "sym_ctx"
118 Block *function_block = sym_ctx.GetFunctionBlock();
119
120 if (!function_block) {
121 LLDB_LOGF(log, " [CUE::SC] Null function block");
122 return;
123 }
124
125 CompilerDeclContext decl_context = function_block->GetDeclContext();
126
127 if (!decl_context) {
128 LLDB_LOGF(log, " [CUE::SC] Null decl context");
129 return;
130 }
131
132 if (m_ctx_obj) {
143 break;
147 break;
148 default:
149 break;
150 }
151 m_needs_object_ptr = true;
152 } else if (clang::CXXMethodDecl *method_decl =
154 if (m_allow_cxx && method_decl->isInstance()) {
156 lldb::VariableListSP variable_list_sp(
157 function_block->GetBlockVariableList(true));
158
159 const char *thisErrorString = "Stopped in a C++ method, but 'this' "
160 "isn't available; pretending we are in a "
161 "generic context";
162
163 if (!variable_list_sp) {
164 err.SetErrorString(thisErrorString);
165 return;
166 }
167
168 lldb::VariableSP this_var_sp(
169 variable_list_sp->FindVariable(ConstString("this")));
170
171 if (!this_var_sp || !this_var_sp->IsInScope(frame) ||
172 !this_var_sp->LocationIsValidForFrame(frame)) {
173 err.SetErrorString(thisErrorString);
174 return;
175 }
176 }
177
179 m_needs_object_ptr = true;
180 }
181 } else if (clang::ObjCMethodDecl *method_decl =
183 decl_context)) {
184 if (m_allow_objc) {
186 lldb::VariableListSP variable_list_sp(
187 function_block->GetBlockVariableList(true));
188
189 const char *selfErrorString = "Stopped in an Objective-C method, but "
190 "'self' isn't available; pretending we "
191 "are in a generic context";
192
193 if (!variable_list_sp) {
194 err.SetErrorString(selfErrorString);
195 return;
196 }
197
198 lldb::VariableSP self_variable_sp =
199 variable_list_sp->FindVariable(ConstString("self"));
200
201 if (!self_variable_sp || !self_variable_sp->IsInScope(frame) ||
202 !self_variable_sp->LocationIsValidForFrame(frame)) {
203 err.SetErrorString(selfErrorString);
204 return;
205 }
206 }
207
209 m_needs_object_ptr = true;
210
211 if (!method_decl->isInstanceMethod())
212 m_in_static_method = true;
213 }
214 } else if (clang::FunctionDecl *function_decl =
216 // We might also have a function that said in the debug information that it
217 // captured an object pointer. The best way to deal with getting to the
218 // ivars at present is by pretending that this is a method of a class in
219 // whatever runtime the debug info says the object pointer belongs to. Do
220 // that here.
221
222 ClangASTMetadata *metadata =
223 TypeSystemClang::DeclContextGetMetaData(decl_context, function_decl);
224 if (metadata && metadata->HasObjectPtr()) {
225 lldb::LanguageType language = metadata->GetObjectPtrLanguage();
226 if (language == lldb::eLanguageTypeC_plus_plus) {
228 lldb::VariableListSP variable_list_sp(
229 function_block->GetBlockVariableList(true));
230
231 const char *thisErrorString = "Stopped in a context claiming to "
232 "capture a C++ object pointer, but "
233 "'this' isn't available; pretending we "
234 "are in a generic context";
235
236 if (!variable_list_sp) {
237 err.SetErrorString(thisErrorString);
238 return;
239 }
240
241 lldb::VariableSP this_var_sp(
242 variable_list_sp->FindVariable(ConstString("this")));
243
244 if (!this_var_sp || !this_var_sp->IsInScope(frame) ||
245 !this_var_sp->LocationIsValidForFrame(frame)) {
246 err.SetErrorString(thisErrorString);
247 return;
248 }
249 }
250
252 m_needs_object_ptr = true;
253 } else if (language == lldb::eLanguageTypeObjC) {
255 lldb::VariableListSP variable_list_sp(
256 function_block->GetBlockVariableList(true));
257
258 const char *selfErrorString =
259 "Stopped in a context claiming to capture an Objective-C object "
260 "pointer, but 'self' isn't available; pretending we are in a "
261 "generic context";
262
263 if (!variable_list_sp) {
264 err.SetErrorString(selfErrorString);
265 return;
266 }
267
268 lldb::VariableSP self_variable_sp =
269 variable_list_sp->FindVariable(ConstString("self"));
270
271 if (!self_variable_sp || !self_variable_sp->IsInScope(frame) ||
272 !self_variable_sp->LocationIsValidForFrame(frame)) {
273 err.SetErrorString(selfErrorString);
274 return;
275 }
276
277 Type *self_type = self_variable_sp->GetType();
278
279 if (!self_type) {
280 err.SetErrorString(selfErrorString);
281 return;
282 }
283
284 CompilerType self_clang_type = self_type->GetForwardCompilerType();
285
286 if (!self_clang_type) {
287 err.SetErrorString(selfErrorString);
288 return;
289 }
290
291 if (TypeSystemClang::IsObjCClassType(self_clang_type)) {
292 return;
294 self_clang_type)) {
296 m_needs_object_ptr = true;
297 } else {
298 err.SetErrorString(selfErrorString);
299 return;
300 }
301 } else {
303 m_needs_object_ptr = true;
304 }
305 }
306 }
307 }
308}
309
310// This is a really nasty hack, meant to fix Objective-C expressions of the
311// form (int)[myArray count]. Right now, because the type information for
312// count is not available, [myArray count] returns id, which can't be directly
313// cast to int without causing a clang error.
314static void ApplyObjcCastHack(std::string &expr) {
315 const std::string from = "(int)[";
316 const std::string to = "(int)(long long)[";
317
318 size_t offset;
319
320 while ((offset = expr.find(from)) != expr.npos)
321 expr.replace(offset, from.size(), to);
322}
323
325 ExecutionContext &exe_ctx) {
326 if (Target *target = exe_ctx.GetTargetPtr()) {
327 if (PersistentExpressionState *persistent_state =
328 target->GetPersistentExpressionStateForLanguage(
330 m_clang_state = llvm::cast<ClangPersistentVariables>(persistent_state);
332 } else {
333 diagnostic_manager.PutString(
334 lldb::eSeverityError, "couldn't start parsing (no persistent data)");
335 return false;
336 }
337 } else {
338 diagnostic_manager.PutString(lldb::eSeverityError,
339 "error: couldn't start parsing (no target)");
340 return false;
341 }
342 return true;
343}
344
345static void SetupDeclVendor(ExecutionContext &exe_ctx, Target *target,
346 DiagnosticManager &diagnostic_manager) {
347 if (!target->GetEnableAutoImportClangModules())
348 return;
349
350 auto *persistent_state = llvm::cast<ClangPersistentVariables>(
352 if (!persistent_state)
353 return;
354
355 std::shared_ptr<ClangModulesDeclVendor> decl_vendor =
356 persistent_state->GetClangModulesDeclVendor();
357 if (!decl_vendor)
358 return;
359
360 StackFrame *frame = exe_ctx.GetFramePtr();
361 if (!frame)
362 return;
363
364 Block *block = frame->GetFrameBlock();
365 if (!block)
366 return;
367 SymbolContext sc;
368
369 block->CalculateSymbolContext(&sc);
370
371 if (!sc.comp_unit)
372 return;
373 StreamString error_stream;
374
375 ClangModulesDeclVendor::ModuleVector modules_for_macros =
376 persistent_state->GetHandLoadedClangModules();
377 if (decl_vendor->AddModulesForCompileUnit(*sc.comp_unit, modules_for_macros,
378 error_stream))
379 return;
380
381 // Failed to load some modules, so emit the error stream as a diagnostic.
382 if (!error_stream.Empty()) {
383 // The error stream already contains several Clang diagnostics that might
384 // be either errors or warnings, so just print them all as one remark
385 // diagnostic to prevent that the message starts with "error: error:".
386 diagnostic_manager.PutString(lldb::eSeverityInfo, error_stream.GetString());
387 return;
388 }
389
390 diagnostic_manager.PutString(lldb::eSeverityError,
391 "Unknown error while loading modules needed for "
392 "current compilation unit.");
393}
394
397 "Top level expressions aren't wrapped.");
400 return Kind::CppMemberFunction;
401 else if (m_in_objectivec_method) {
403 return Kind::ObjCStaticMethod;
404 return Kind::ObjCInstanceMethod;
405 }
406 // Not in any kind of 'special' function, so just wrap it in a normal C
407 // function.
408 return Kind::Function;
409}
410
412 DiagnosticManager &diagnostic_manager, ExecutionContext &exe_ctx,
413 std::vector<std::string> modules_to_import, bool for_completion) {
414
415 std::string prefix = m_expr_prefix;
416
419 } else {
421 m_filename, prefix, m_expr_text, GetWrapKind()));
422
423 if (!m_source_code->GetText(m_transformed_text, exe_ctx, !m_ctx_obj,
424 for_completion, modules_to_import)) {
425 diagnostic_manager.PutString(lldb::eSeverityError,
426 "couldn't construct expression body");
427 return;
428 }
429
430 // Find and store the start position of the original code inside the
431 // transformed code. We need this later for the code completion.
432 std::size_t original_start;
433 std::size_t original_end;
434 bool found_bounds = m_source_code->GetOriginalBodyBounds(
435 m_transformed_text, original_start, original_end);
436 if (found_bounds)
437 m_user_expression_start_pos = original_start;
438 }
439}
440
442 switch (language) {
448 return true;
449 default:
450 return false;
451 }
452}
453
454/// Utility method that puts a message into the expression log and
455/// returns an invalid module configuration.
456static CppModuleConfiguration LogConfigError(const std::string &msg) {
458 LLDB_LOG(log, "[C++ module config] {0}", msg);
459 return CppModuleConfiguration();
460}
461
463 ExecutionContext &exe_ctx) {
465
466 // Don't do anything if this is not a C++ module configuration.
467 if (!SupportsCxxModuleImport(language))
468 return LogConfigError("Language doesn't support C++ modules");
469
470 Target *target = exe_ctx.GetTargetPtr();
471 if (!target)
472 return LogConfigError("No target");
473
474 StackFrame *frame = exe_ctx.GetFramePtr();
475 if (!frame)
476 return LogConfigError("No frame");
477
478 Block *block = frame->GetFrameBlock();
479 if (!block)
480 return LogConfigError("No block");
481
482 SymbolContext sc;
483 block->CalculateSymbolContext(&sc);
484 if (!sc.comp_unit)
485 return LogConfigError("Couldn't calculate symbol context");
486
487 // Build a list of files we need to analyze to build the configuration.
488 FileSpecList files;
489 for (auto &f : sc.comp_unit->GetSupportFiles())
490 files.AppendIfUnique(f->Materialize());
491 // We also need to look at external modules in the case of -gmodules as they
492 // contain the support files for libc++ and the C library.
493 llvm::DenseSet<SymbolFile *> visited_symbol_files;
495 visited_symbol_files, [&files](Module &module) {
496 for (std::size_t i = 0; i < module.GetNumCompileUnits(); ++i) {
497 const SupportFileList &support_files =
498 module.GetCompileUnitAtIndex(i)->GetSupportFiles();
499 for (auto &f : support_files) {
500 files.AppendIfUnique(f->Materialize());
501 }
502 }
503 return false;
504 });
505
506 LLDB_LOG(log, "[C++ module config] Found {0} support files to analyze",
507 files.GetSize());
508 if (log && log->GetVerbose()) {
509 for (auto &f : files)
510 LLDB_LOGV(log, "[C++ module config] Analyzing support file: {0}",
511 f.GetPath());
512 }
513
514 // Try to create a configuration from the files. If there is no valid
515 // configuration possible with the files, this just returns an invalid
516 // configuration.
517 return CppModuleConfiguration(files, target->GetArchitecture().GetTriple());
518}
519
521 DiagnosticManager &diagnostic_manager, ExecutionContext &exe_ctx,
522 bool for_completion) {
523 InstallContext(exe_ctx);
524
525 if (!SetupPersistentState(diagnostic_manager, exe_ctx))
526 return false;
527
528 Status err;
529 ScanContext(exe_ctx, err);
530
531 if (!err.Success()) {
532 diagnostic_manager.PutString(lldb::eSeverityWarning, err.AsCString());
533 }
534
535 ////////////////////////////////////
536 // Generate the expression
537 //
538
540
541 SetupDeclVendor(exe_ctx, m_target, diagnostic_manager);
542
544
546 SetupCppModuleImports(exe_ctx);
547
548 CreateSourceCode(diagnostic_manager, exe_ctx, m_imported_cpp_modules,
549 for_completion);
550 return true;
551}
552
554 DiagnosticManager &diagnostic_manager, ExecutionContext &exe_ctx,
555 lldb_private::ExecutionPolicy execution_policy, bool keep_result_in_memory,
556 bool generate_debug_info) {
557 m_materializer_up = std::make_unique<Materializer>();
558
559 ResetDeclMap(exe_ctx, m_result_delegate, keep_result_in_memory);
560
561 auto on_exit = llvm::make_scope_exit([this]() { ResetDeclMap(); });
562
563 if (!DeclMap()->WillParse(exe_ctx, GetMaterializer())) {
564 diagnostic_manager.PutString(
566 "current process state is unsuitable for expression parsing");
567 return false;
568 }
569
571 DeclMap()->SetLookupsEnabled(true);
572 }
573
574 m_parser = std::make_unique<ClangExpressionParser>(
575 exe_ctx.GetBestExecutionContextScope(), *this, generate_debug_info,
577
578 unsigned num_errors = m_parser->Parse(diagnostic_manager);
579
580 // Check here for FixItHints. If there are any try to apply the fixits and
581 // set the fixed text in m_fixed_text before returning an error.
582 if (num_errors) {
583 if (diagnostic_manager.HasFixIts()) {
584 if (m_parser->RewriteExpression(diagnostic_manager)) {
585 size_t fixed_start;
586 size_t fixed_end;
587 m_fixed_text = diagnostic_manager.GetFixedExpression();
588 // Retrieve the original expression in case we don't have a top level
589 // expression (which has no surrounding source code).
590 if (m_source_code && m_source_code->GetOriginalBodyBounds(
591 m_fixed_text, fixed_start, fixed_end))
593 m_fixed_text.substr(fixed_start, fixed_end - fixed_start);
594 }
595 }
596 return false;
597 }
598
599 //////////////////////////////////////////////////////////////////////////////
600 // Prepare the output of the parser for execution, evaluating it statically
601 // if possible
602 //
603
604 {
605 Status jit_error = m_parser->PrepareForExecution(
607 m_can_interpret, execution_policy);
608
609 if (!jit_error.Success()) {
610 const char *error_cstr = jit_error.AsCString();
611 if (error_cstr && error_cstr[0])
612 diagnostic_manager.PutString(lldb::eSeverityError, error_cstr);
613 else
614 diagnostic_manager.PutString(lldb::eSeverityError,
615 "expression can't be interpreted or run");
616 return false;
617 }
618 }
619 return true;
620}
621
624
625 CppModuleConfiguration module_config =
628 m_include_directories = module_config.GetIncludeDirs();
629
630 LLDB_LOG(log, "List of imported modules in expression: {0}",
631 llvm::make_range(m_imported_cpp_modules.begin(),
633 LLDB_LOG(log, "List of include directories gathered for modules: {0}",
634 llvm::make_range(m_include_directories.begin(),
635 m_include_directories.end()));
636}
637
638static bool shouldRetryWithCppModule(Target &target, ExecutionPolicy exe_policy) {
639 // Top-level expression don't yet support importing C++ modules.
641 return false;
643}
644
646 ExecutionContext &exe_ctx,
647 lldb_private::ExecutionPolicy execution_policy,
648 bool keep_result_in_memory,
649 bool generate_debug_info) {
651
652 if (!PrepareForParsing(diagnostic_manager, exe_ctx, /*for_completion*/ false))
653 return false;
654
655 LLDB_LOGF(log, "Parsing the following code:\n%s", m_transformed_text.c_str());
656
657 ////////////////////////////////////
658 // Set up the target and compiler
659 //
660
661 Target *target = exe_ctx.GetTargetPtr();
662
663 if (!target) {
664 diagnostic_manager.PutString(lldb::eSeverityError, "invalid target");
665 return false;
666 }
667
668 //////////////////////////
669 // Parse the expression
670 //
671
672 bool parse_success = TryParse(diagnostic_manager, exe_ctx, execution_policy,
673 keep_result_in_memory, generate_debug_info);
674 // If the expression failed to parse, check if retrying parsing with a loaded
675 // C++ module is possible.
676 if (!parse_success && shouldRetryWithCppModule(*target, execution_policy)) {
677 // Load the loaded C++ modules.
678 SetupCppModuleImports(exe_ctx);
679 // If we did load any modules, then retry parsing.
680 if (!m_imported_cpp_modules.empty()) {
681 // Create a dedicated diagnostic manager for the second parse attempt.
682 // These diagnostics are only returned to the caller if using the fallback
683 // actually succeeded in getting the expression to parse. This prevents
684 // that module-specific issues regress diagnostic quality with the
685 // fallback mode.
686 DiagnosticManager retry_manager;
687 // The module imports are injected into the source code wrapper,
688 // so recreate those.
689 CreateSourceCode(retry_manager, exe_ctx, m_imported_cpp_modules,
690 /*for_completion*/ false);
691 parse_success = TryParse(retry_manager, exe_ctx, execution_policy,
692 keep_result_in_memory, generate_debug_info);
693 // Return the parse diagnostics if we were successful.
694 if (parse_success)
695 diagnostic_manager = std::move(retry_manager);
696 }
697 }
698 if (!parse_success)
699 return false;
700
701 if (exe_ctx.GetProcessPtr() && execution_policy == eExecutionPolicyTopLevel) {
702 Status static_init_error =
703 m_parser->RunStaticInitializers(m_execution_unit_sp, exe_ctx);
704
705 if (!static_init_error.Success()) {
706 const char *error_cstr = static_init_error.AsCString();
707 if (error_cstr && error_cstr[0])
708 diagnostic_manager.Printf(lldb::eSeverityError, "%s\n", error_cstr);
709 else
710 diagnostic_manager.PutString(lldb::eSeverityError,
711 "couldn't run static initializers\n");
712 return false;
713 }
714 }
715
717 bool register_execution_unit = false;
718
720 register_execution_unit = true;
721 }
722
723 // If there is more than one external function in the execution unit, it
724 // needs to keep living even if it's not top level, because the result
725 // could refer to that function.
726
727 if (m_execution_unit_sp->GetJittedFunctions().size() > 1) {
728 register_execution_unit = true;
729 }
730
731 if (register_execution_unit) {
732 if (auto *persistent_state =
735 persistent_state->RegisterExecutionUnit(m_execution_unit_sp);
736 }
737 }
738
739 if (generate_debug_info) {
740 lldb::ModuleSP jit_module_sp(m_execution_unit_sp->GetJITModule());
741
742 if (jit_module_sp) {
743 ConstString const_func_name(FunctionName());
744 FileSpec jit_file;
745 jit_file.SetFilename(const_func_name);
746 jit_module_sp->SetFileSpecAndObjectName(jit_file, ConstString());
747 m_jit_module_wp = jit_module_sp;
748 target->GetImages().Append(jit_module_sp);
749 }
750 }
751
752 Process *process = exe_ctx.GetProcessPtr();
753 if (process && m_jit_start_addr != LLDB_INVALID_ADDRESS)
754 m_jit_process_wp = lldb::ProcessWP(process->shared_from_this());
755 return true;
756}
757
758/// Converts an absolute position inside a given code string into
759/// a column/line pair.
760///
761/// \param[in] abs_pos
762/// A absolute position in the code string that we want to convert
763/// to a column/line pair.
764///
765/// \param[in] code
766/// A multi-line string usually representing source code.
767///
768/// \param[out] line
769/// The line in the code that contains the given absolute position.
770/// The first line in the string is indexed as 1.
771///
772/// \param[out] column
773/// The column in the line that contains the absolute position.
774/// The first character in a line is indexed as 0.
775static void AbsPosToLineColumnPos(size_t abs_pos, llvm::StringRef code,
776 unsigned &line, unsigned &column) {
777 // Reset to code position to beginning of the file.
778 line = 0;
779 column = 0;
780
781 assert(abs_pos <= code.size() && "Absolute position outside code string?");
782
783 // We have to walk up to the position and count lines/columns.
784 for (std::size_t i = 0; i < abs_pos; ++i) {
785 // If we hit a line break, we go back to column 0 and enter a new line.
786 // We only handle \n because that's what we internally use to make new
787 // lines for our temporary code strings.
788 if (code[i] == '\n') {
789 ++line;
790 column = 0;
791 continue;
792 }
793 ++column;
794 }
795}
796
798 CompletionRequest &request,
799 unsigned complete_pos) {
801
802 // We don't want any visible feedback when completing an expression. Mostly
803 // because the results we get from an incomplete invocation are probably not
804 // correct.
805 DiagnosticManager diagnostic_manager;
806
807 if (!PrepareForParsing(diagnostic_manager, exe_ctx, /*for_completion*/ true))
808 return false;
809
810 LLDB_LOGF(log, "Parsing the following code:\n%s", m_transformed_text.c_str());
811
812 //////////////////////////
813 // Parse the expression
814 //
815
816 m_materializer_up = std::make_unique<Materializer>();
817
818 ResetDeclMap(exe_ctx, m_result_delegate, /*keep result in memory*/ true);
819
820 auto on_exit = llvm::make_scope_exit([this]() { ResetDeclMap(); });
821
822 if (!DeclMap()->WillParse(exe_ctx, GetMaterializer())) {
823 diagnostic_manager.PutString(
825 "current process state is unsuitable for expression parsing");
826
827 return false;
828 }
829
831 DeclMap()->SetLookupsEnabled(true);
832 }
833
835 false);
836
837 // We have to find the source code location where the user text is inside
838 // the transformed expression code. When creating the transformed text, we
839 // already stored the absolute position in the m_transformed_text string. The
840 // only thing left to do is to transform it into the line:column format that
841 // Clang expects.
842
843 // The line and column of the user expression inside the transformed source
844 // code.
845 unsigned user_expr_line, user_expr_column;
848 user_expr_line, user_expr_column);
849 else
850 return false;
851
852 // The actual column where we have to complete is the start column of the
853 // user expression + the offset inside the user code that we were given.
854 const unsigned completion_column = user_expr_column + complete_pos;
855 parser.Complete(request, user_expr_line, completion_column, complete_pos);
856
857 return true;
858}
859
861 lldb::StackFrameSP frame_sp, llvm::StringRef object_name, Status &err) {
862 auto valobj_sp =
863 GetObjectPointerValueObject(std::move(frame_sp), object_name, err);
864
865 // We're inside a C++ class method. This could potentially be an unnamed
866 // lambda structure. If the lambda captured a "this", that should be
867 // the object pointer.
868 if (auto thisChildSP = valobj_sp->GetChildMemberWithName("this")) {
869 valobj_sp = thisChildSP;
870 }
871
872 if (!err.Success() || !valobj_sp.get())
874
875 lldb::addr_t ret = valobj_sp->GetValueAsUnsigned(LLDB_INVALID_ADDRESS);
876
877 if (ret == LLDB_INVALID_ADDRESS) {
879 "Couldn't load '{0}' because its value couldn't be evaluated",
880 object_name);
882 }
883
884 return ret;
885}
886
888 std::vector<lldb::addr_t> &args,
889 lldb::addr_t struct_address,
890 DiagnosticManager &diagnostic_manager) {
893
894 if (m_needs_object_ptr) {
895 lldb::StackFrameSP frame_sp = exe_ctx.GetFrameSP();
896 if (!frame_sp)
897 return true;
898
900 diagnostic_manager.PutString(
902 "need object pointer but don't know the language");
903 return false;
904 }
905
906 static constexpr llvm::StringLiteral g_cplusplus_object_name("this");
907 static constexpr llvm::StringLiteral g_objc_object_name("self");
908 llvm::StringRef object_name =
909 m_in_cplusplus_method ? g_cplusplus_object_name : g_objc_object_name;
910
911 Status object_ptr_error;
912
913 if (m_ctx_obj) {
914 AddressType address_type;
915 object_ptr = m_ctx_obj->GetAddressOf(false, &address_type);
916 if (object_ptr == LLDB_INVALID_ADDRESS ||
917 address_type != eAddressTypeLoad)
918 object_ptr_error.SetErrorString("Can't get context object's "
919 "debuggee address");
920 } else {
922 object_ptr =
923 GetCppObjectPointer(frame_sp, object_name, object_ptr_error);
924 } else {
925 object_ptr = GetObjectPointer(frame_sp, object_name, object_ptr_error);
926 }
927 }
928
929 if (!object_ptr_error.Success()) {
930 exe_ctx.GetTargetRef().GetDebugger().GetAsyncOutputStream()->Format(
931 "warning: `{0}' is not accessible (substituting 0). {1}\n",
932 object_name, object_ptr_error.AsCString());
933 object_ptr = 0;
934 }
935
937 static constexpr llvm::StringLiteral cmd_name("_cmd");
938
939 cmd_ptr = GetObjectPointer(frame_sp, cmd_name, object_ptr_error);
940
941 if (!object_ptr_error.Success()) {
942 diagnostic_manager.Printf(
944 "couldn't get cmd pointer (substituting NULL): %s",
945 object_ptr_error.AsCString());
946 cmd_ptr = 0;
947 }
948 }
949
950 args.push_back(object_ptr);
951
953 args.push_back(cmd_ptr);
954
955 args.push_back(struct_address);
956 } else {
957 args.push_back(struct_address);
958 }
959 return true;
960}
961
963 ExecutionContextScope *exe_scope) {
965}
966
968
970 ExecutionContext &exe_ctx,
972 bool keep_result_in_memory,
973 ValueObject *ctx_obj) {
974 std::shared_ptr<ClangASTImporter> ast_importer;
975 auto *state = exe_ctx.GetTargetSP()->GetPersistentExpressionStateForLanguage(
977 if (state) {
978 auto *persistent_vars = llvm::cast<ClangPersistentVariables>(state);
979 ast_importer = persistent_vars->GetClangASTImporter();
980 }
981 m_expr_decl_map_up = std::make_unique<ClangExpressionDeclMap>(
982 keep_result_in_memory, &delegate, exe_ctx.GetTargetSP(), ast_importer,
983 ctx_obj);
984}
985
986clang::ASTConsumer *
988 clang::ASTConsumer *passthrough) {
989 m_result_synthesizer_up = std::make_unique<ASTResultSynthesizer>(
990 passthrough, m_top_level, m_target);
991
992 return m_result_synthesizer_up.get();
993}
994
996 if (m_result_synthesizer_up) {
997 m_result_synthesizer_up->CommitPersistentDecls();
998 }
999}
1000
1002 return m_persistent_state->GetNextPersistentVariableName(false);
1003}
1004
1006 lldb::ExpressionVariableSP &variable) {
1007 m_variable = variable;
1008}
1009
1011 PersistentExpressionState *persistent_state) {
1012 m_persistent_state = persistent_state;
1013}
1014
1016 return m_variable;
1017}
static bool shouldRetryWithCppModule(Target &target, ExecutionPolicy exe_policy)
CppModuleConfiguration GetModuleConfig(lldb::LanguageType language, ExecutionContext &exe_ctx)
static CppModuleConfiguration LogConfigError(const std::string &msg)
Utility method that puts a message into the expression log and returns an invalid module configuratio...
static void AbsPosToLineColumnPos(size_t abs_pos, llvm::StringRef code, unsigned &line, unsigned &column)
Converts an absolute position inside a given code string into a column/line pair.
static void SetupDeclVendor(ExecutionContext &exe_ctx, Target *target, DiagnosticManager &diagnostic_manager)
static bool SupportsCxxModuleImport(lldb::LanguageType language)
static void ApplyObjcCastHack(std::string &expr)
#define LLDB_LOG(log,...)
The LLDB_LOG* macros defined below are the way to emit log messages.
Definition: Log.h:359
#define LLDB_LOGF(log,...)
Definition: Log.h:366
#define LLDB_LOGV(log,...)
Definition: Log.h:373
llvm::Triple & GetTriple()
Architecture triple accessor.
Definition: ArchSpec.h:450
A class that describes a single lexical block.
Definition: Block.h:41
lldb::VariableListSP GetBlockVariableList(bool can_create)
Get the variable list for this block only.
Definition: Block.cpp:415
void CalculateSymbolContext(SymbolContext *sc) override
Reconstruct the object's symbol context into sc.
Definition: Block.cpp:136
CompilerDeclContext GetDeclContext()
Definition: Block.cpp:496
lldb::LanguageType GetObjectPtrLanguage() const
void SetLookupsEnabled(bool lookups_enabled)
bool WillParse(ExecutionContext &exe_ctx, Materializer *materializer)
Enable the state needed for parsing and IR transformation.
"lldb/Expression/ClangExpressionParser.h" Encapsulates an instance of Clang that can parse expression...
bool Complete(CompletionRequest &request, unsigned line, unsigned pos, unsigned typed_pos) override
Attempts to find possible command line completions for the given expression.
WrapKind
The possible ways an expression can be wrapped.
static ClangExpressionSourceCode * CreateWrapped(llvm::StringRef filename, llvm::StringRef prefix, llvm::StringRef body, WrapKind wrap_kind)
std::string GetNextExprFileName()
Returns the next file name that should be used for user expressions.
clang::ASTConsumer * ASTTransformer(clang::ASTConsumer *passthrough) override
Return the object that the parser should allow to access ASTs.
std::unique_ptr< ClangExpressionDeclMap > m_expr_decl_map_up
void RegisterPersistentState(PersistentExpressionState *persistent_state)
void DidDematerialize(lldb::ExpressionVariableSP &variable) override
bool m_enforce_valid_object
True if the expression parser should enforce the presence of a valid class pointer in order to genera...
std::string m_filename
File name used for the expression.
lldb::ExpressionVariableSP GetResultAfterDematerialization(ExecutionContextScope *exe_scope) override
ClangUserExpression(ExecutionContextScope &exe_scope, llvm::StringRef expr, llvm::StringRef prefix, SourceLanguage language, ResultType desired_type, const EvaluateExpressionOptions &options, ValueObject *ctx_obj)
Constructor.
bool m_in_objectivec_method
True if the expression is compiled as an Objective-C method (true if it was parsed when exe_ctx was i...
void CreateSourceCode(DiagnosticManager &diagnostic_manager, ExecutionContext &exe_ctx, std::vector< std::string > modules_to_import, bool for_completion)
bool Complete(ExecutionContext &exe_ctx, CompletionRequest &request, unsigned complete_pos) override
Attempts to find possible command line completions for the given (possible incomplete) user expressio...
ClangExpressionSourceCode::WrapKind GetWrapKind() const
Defines how the current expression should be wrapped.
std::unique_ptr< ClangExpressionParser > m_parser
The parser instance we used to parse the expression.
void SetupCppModuleImports(ExecutionContext &exe_ctx)
bool PrepareForParsing(DiagnosticManager &diagnostic_manager, ExecutionContext &exe_ctx, bool for_completion)
bool m_needs_object_ptr
True if "this" or "self" must be looked up and passed in.
ClangExpressionDeclMap * DeclMap()
bool SetupPersistentState(DiagnosticManager &diagnostic_manager, ExecutionContext &exe_ctx)
bool m_in_static_method
True if the expression is compiled as a static (or class) method (currently true if it was parsed whe...
bool Parse(DiagnosticManager &diagnostic_manager, ExecutionContext &exe_ctx, lldb_private::ExecutionPolicy execution_policy, bool keep_result_in_memory, bool generate_debug_info) override
Parse the expression.
bool TryParse(DiagnosticManager &diagnostic_manager, ExecutionContext &exe_ctx, lldb_private::ExecutionPolicy execution_policy, bool keep_result_in_memory, bool generate_debug_info)
Populate m_in_cplusplus_method and m_in_objectivec_method based on the environment.
std::optional< size_t > m_user_expression_start_pos
The absolute character position in the transformed source code where the user code (as typed by the u...
bool AddArguments(ExecutionContext &exe_ctx, std::vector< lldb::addr_t > &args, lldb::addr_t struct_address, DiagnosticManager &diagnostic_manager) override
lldb::addr_t GetCppObjectPointer(lldb::StackFrameSP frame, llvm::StringRef object_name, Status &err)
std::unique_ptr< ClangExpressionSourceCode > m_source_code
std::vector< std::string > m_imported_cpp_modules
A list of module names that should be imported when parsing.
ClangPersistentVariables * m_clang_state
void ScanContext(ExecutionContext &exe_ctx, lldb_private::Status &err) override
bool m_in_cplusplus_method
True if the expression is compiled as a C++ member function (true if it was parsed when exe_ctx was i...
std::vector< std::string > m_include_directories
The include directories that should be used when parsing the expression.
ValueObject * m_ctx_obj
The object (if any) in which context the expression is evaluated.
const SupportFileList & GetSupportFiles()
Get the compile unit's support file list.
virtual bool ForEachExternalModule(llvm::DenseSet< lldb_private::SymbolFile * > &visited_symbol_files, llvm::function_ref< bool(Module &)> lambda)
Apply a lambda to each external lldb::Module referenced by this compilation unit.
Represents a generic declaration context in a program.
Generic representation of a type in a programming language.
Definition: CompilerType.h:36
"lldb/Utility/ArgCompletionRequest.h"
A uniqued constant string class.
Definition: ConstString.h:40
A Clang configuration when importing C++ modules.
llvm::ArrayRef< std::string > GetIncludeDirs() const
Returns a list of include directories that should be used when using this configuration (e....
llvm::ArrayRef< std::string > GetImportedModules() const
Returns a list of (top level) modules that should be imported when using this configuration (e....
lldb::StreamSP GetAsyncOutputStream()
Definition: Debugger.cpp:1289
size_t void PutString(lldb::Severity severity, llvm::StringRef str)
size_t Printf(lldb::Severity severity, const char *format,...) __attribute__((format(printf
const std::string & GetFixedExpression()
ExecutionPolicy GetExecutionPolicy() const
Definition: Target.h:307
"lldb/Target/ExecutionContextScope.h" Inherit from this if your object can reconstruct its execution ...
"lldb/Target/ExecutionContext.h" A class that contains an execution context.
ExecutionContextScope * GetBestExecutionContextScope() const
const lldb::TargetSP & GetTargetSP() const
Get accessor to get the target shared pointer.
StackFrame * GetFramePtr() const
Returns a pointer to the frame object.
const lldb::StackFrameSP & GetFrameSP() const
Get accessor to get the frame shared pointer.
Target * GetTargetPtr() const
Returns a pointer to the target object.
Target & GetTargetRef() const
Returns a reference to the target object.
Process * GetProcessPtr() const
Returns a pointer to the process object.
lldb::addr_t m_jit_end_addr
The address of the JITted function within the JIT allocation.
Definition: Expression.h:94
lldb::ProcessWP m_jit_process_wp
Expression's always have to have a target...
Definition: Expression.h:88
lldb::addr_t m_jit_start_addr
An expression might have a process, but it doesn't need to (e.g.
Definition: Expression.h:91
A file collection class.
Definition: FileSpecList.h:85
size_t GetSize() const
Get the number of files in the file list.
bool AppendIfUnique(const FileSpec &file)
Append a FileSpec object if unique.
A file utility class.
Definition: FileSpec.h:56
void SetFilename(ConstString filename)
Filename string set accessor.
Definition: FileSpec.cpp:345
"lldb/Expression/LLVMUserExpression.h" Encapsulates a one-time expression for use in lldb.
std::string m_transformed_text
The text of the expression, as send to the parser.
bool m_can_interpret
True if the expression could be evaluated statically; false otherwise.
Materializer * GetMaterializer() override
Return the Materializer that the parser should use when registering external values.
std::unique_ptr< Materializer > m_materializer_up
The materializer to use when running the expression.
bool m_allow_cxx
True if the language allows C++.
Target * m_target
The target for storing persistent data like types and variables.
std::shared_ptr< IRExecutionUnit > m_execution_unit_sp
The execution unit the expression is stored in.
bool m_allow_objc
True if the language allows Objective-C.
bool GetVerbose() const
Definition: Log.cpp:314
void Append(const lldb::ModuleSP &module_sp, bool notify=true)
Append a module to the module list.
Definition: ModuleList.cpp:247
A class that describes an executable image and its associated object and symbol files.
Definition: Module.h:88
lldb::CompUnitSP GetCompileUnitAtIndex(size_t idx)
Definition: Module.cpp:425
size_t GetNumCompileUnits()
Get the number of compile units for this module.
Definition: Module.cpp:418
A plug-in interface definition class for debugging a process.
Definition: Process.h:341
This base class provides an interface to stack frames.
Definition: StackFrame.h:43
const SymbolContext & GetSymbolContext(lldb::SymbolContextItem resolve_scope)
Provide a SymbolContext for this StackFrame's current pc value.
Definition: StackFrame.cpp:300
Block * GetFrameBlock()
Get the current lexical scope block for this StackFrame, if possible.
Definition: StackFrame.cpp:275
An error handling class.
Definition: Status.h:44
void SetErrorStringWithFormatv(const char *format, Args &&... args)
Definition: Status.h:169
const char * AsCString(const char *default_error_str="unknown error") const
Get the error string associated with the current error.
Definition: Status.cpp:129
void SetErrorString(llvm::StringRef err_str)
Set the current error string to err_str.
Definition: Status.cpp:232
bool Success() const
Test for success condition.
Definition: Status.cpp:278
llvm::StringRef GetString() const
A list of support files for a CompileUnit.
Definition: FileSpecList.h:23
Defines a symbol context baton that can be handed other debug core functions.
Definition: SymbolContext.h:34
Function * function
The Function for a given query.
Block * GetFunctionBlock()
Find a block that defines the function represented by this symbol context.
CompileUnit * comp_unit
The CompileUnit for a given query.
ImportStdModule GetImportStdModule() const
Definition: Target.cpp:4497
bool GetEnableAutoImportClangModules() const
Definition: Target.cpp:4491
PersistentExpressionState * GetPersistentExpressionStateForLanguage(lldb::LanguageType language)
Definition: Target.cpp:2484
Debugger & GetDebugger()
Definition: Target.h:1064
const ModuleList & GetImages() const
Get accessor for the images for this process.
Definition: Target.h:981
const ArchSpec & GetArchitecture() const
Definition: Target.h:1023
static clang::CXXMethodDecl * DeclContextGetAsCXXMethodDecl(const CompilerDeclContext &dc)
static clang::ObjCMethodDecl * DeclContextGetAsObjCMethodDecl(const CompilerDeclContext &dc)
static clang::FunctionDecl * DeclContextGetAsFunctionDecl(const CompilerDeclContext &dc)
static bool IsObjCClassType(const CompilerType &type)
static ClangASTMetadata * DeclContextGetMetaData(const CompilerDeclContext &dc, const clang::Decl *object)
static bool IsObjCObjectPointerType(const CompilerType &type, CompilerType *target_type=nullptr)
CompilerType GetForwardCompilerType()
Definition: Type.cpp:771
static lldb::ValueObjectSP GetObjectPointerValueObject(lldb::StackFrameSP frame, llvm::StringRef object_name, Status &err)
Return ValueObject for a given variable name in the current stack frame.
SourceLanguage m_language
The language to use when parsing (unknown means use defaults).
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.
void InstallContext(ExecutionContext &exe_ctx)
Populate m_in_cplusplus_method and m_in_objectivec_method based on the environment.
std::string m_expr_prefix
The text of the translation-level definitions, as provided by the user.
const char * FunctionName() override
Return the function name that should be used for executing the expression.
std::string m_expr_text
The text of the expression, as typed by the user.
EvaluateExpressionOptions m_options
Additional options provided by the user.
static lldb::addr_t GetObjectPointer(lldb::StackFrameSP frame_sp, llvm::StringRef object_name, Status &err)
lldb::LanguageType GetObjectRuntimeLanguage()
Definition: ValueObject.h:373
virtual lldb::addr_t GetAddressOf(bool scalar_is_load_address=true, AddressType *address_type=nullptr)
#define LLDB_INVALID_ADDRESS
Definition: lldb-defines.h:82
A class that represents a running process on the host machine.
Log * GetLog(Cat mask)
Retrieve the Log object for the channel associated with the given log enum.
Definition: Log.h:331
ExecutionPolicy
Expression execution policies.
@ eImportStdModuleFallback
Definition: Target.h:64
@ eImportStdModuleTrue
Definition: Target.h:65
@ eAddressTypeLoad
Address is an address as in the current target inferior process.
std::shared_ptr< lldb_private::StackFrame > StackFrameSP
Definition: lldb-forward.h:415
std::shared_ptr< lldb_private::ExpressionVariable > ExpressionVariableSP
Definition: lldb-forward.h:346
LanguageType
Programming language type.
@ eLanguageTypeC_plus_plus_14
ISO C++:2014.
@ eLanguageTypeC11
ISO C:2011.
@ eLanguageTypeC99
ISO C:1999.
@ eLanguageTypeC_plus_plus_03
ISO C++:2003.
@ eLanguageTypeObjC_plus_plus
Objective-C++.
@ eLanguageTypeC_plus_plus_11
ISO C++:2011.
@ eLanguageTypeC89
ISO C:1989.
@ eLanguageTypeC
Non-standardized C, such as K&R.
@ eLanguageTypeObjC
Objective-C.
@ eLanguageTypeC_plus_plus
ISO C++:1998.
std::shared_ptr< lldb_private::VariableList > VariableListSP
Definition: lldb-forward.h:478
std::weak_ptr< lldb_private::Process > ProcessWP
Definition: lldb-forward.h:387
std::shared_ptr< lldb_private::Variable > VariableSP
Definition: lldb-forward.h:477
uint64_t addr_t
Definition: lldb-types.h:80
std::shared_ptr< lldb_private::Module > ModuleSP
Definition: lldb-forward.h:368
A type-erased pair of llvm::dwarf::SourceLanguageName and version.
lldb::LanguageType AsLanguageType() const
Definition: Language.cpp:546