1 //===-- ClangExpressionParser.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 "clang/AST/ASTContext.h" 10 #include "clang/AST/ASTDiagnostic.h" 11 #include "clang/AST/ExternalASTSource.h" 12 #include "clang/AST/PrettyPrinter.h" 13 #include "clang/Basic/Builtins.h" 14 #include "clang/Basic/DiagnosticIDs.h" 15 #include "clang/Basic/SourceLocation.h" 16 #include "clang/Basic/TargetInfo.h" 17 #include "clang/Basic/Version.h" 18 #include "clang/CodeGen/CodeGenAction.h" 19 #include "clang/CodeGen/ModuleBuilder.h" 20 #include "clang/Edit/Commit.h" 21 #include "clang/Edit/EditedSource.h" 22 #include "clang/Edit/EditsReceiver.h" 23 #include "clang/Frontend/CompilerInstance.h" 24 #include "clang/Frontend/CompilerInvocation.h" 25 #include "clang/Frontend/FrontendActions.h" 26 #include "clang/Frontend/FrontendDiagnostic.h" 27 #include "clang/Frontend/FrontendPluginRegistry.h" 28 #include "clang/Frontend/TextDiagnosticBuffer.h" 29 #include "clang/Frontend/TextDiagnosticPrinter.h" 30 #include "clang/Lex/Preprocessor.h" 31 #include "clang/Parse/ParseAST.h" 32 #include "clang/Rewrite/Core/Rewriter.h" 33 #include "clang/Rewrite/Frontend/FrontendActions.h" 34 #include "clang/Sema/CodeCompleteConsumer.h" 35 #include "clang/Sema/Sema.h" 36 #include "clang/Sema/SemaConsumer.h" 37 38 #include "llvm/ADT/StringRef.h" 39 #include "llvm/ExecutionEngine/ExecutionEngine.h" 40 #include "llvm/Support/CrashRecoveryContext.h" 41 #include "llvm/Support/Debug.h" 42 #include "llvm/Support/FileSystem.h" 43 #include "llvm/Support/TargetSelect.h" 44 45 #include "llvm/IR/LLVMContext.h" 46 #include "llvm/IR/Module.h" 47 #include "llvm/Support/DynamicLibrary.h" 48 #include "llvm/Support/ErrorHandling.h" 49 #include "llvm/Support/Host.h" 50 #include "llvm/Support/MemoryBuffer.h" 51 #include "llvm/Support/Signals.h" 52 53 #include "ClangDiagnostic.h" 54 #include "ClangExpressionParser.h" 55 #include "ClangUserExpression.h" 56 57 #include "ASTUtils.h" 58 #include "ClangASTSource.h" 59 #include "ClangDiagnostic.h" 60 #include "ClangExpressionDeclMap.h" 61 #include "ClangExpressionHelper.h" 62 #include "ClangExpressionParser.h" 63 #include "ClangHost.h" 64 #include "ClangModulesDeclVendor.h" 65 #include "ClangPersistentVariables.h" 66 #include "IRDynamicChecks.h" 67 #include "IRForTarget.h" 68 #include "ModuleDependencyCollector.h" 69 70 #include "Plugins/TypeSystem/Clang/TypeSystemClang.h" 71 #include "lldb/Core/Debugger.h" 72 #include "lldb/Core/Disassembler.h" 73 #include "lldb/Core/Module.h" 74 #include "lldb/Core/StreamFile.h" 75 #include "lldb/Expression/IRExecutionUnit.h" 76 #include "lldb/Expression/IRInterpreter.h" 77 #include "lldb/Host/File.h" 78 #include "lldb/Host/HostInfo.h" 79 #include "lldb/Symbol/SymbolVendor.h" 80 #include "lldb/Target/ExecutionContext.h" 81 #include "lldb/Target/Language.h" 82 #include "lldb/Target/Process.h" 83 #include "lldb/Target/Target.h" 84 #include "lldb/Target/ThreadPlanCallFunction.h" 85 #include "lldb/Utility/DataBufferHeap.h" 86 #include "lldb/Utility/LLDBAssert.h" 87 #include "lldb/Utility/Log.h" 88 #include "lldb/Utility/Reproducer.h" 89 #include "lldb/Utility/Stream.h" 90 #include "lldb/Utility/StreamString.h" 91 #include "lldb/Utility/StringList.h" 92 93 #include "Plugins/LanguageRuntime/ObjC/ObjCLanguageRuntime.h" 94 #include "Plugins/LanguageRuntime/RenderScript/RenderScriptRuntime/RenderScriptRuntime.h" 95 96 #include <cctype> 97 #include <memory> 98 99 using namespace clang; 100 using namespace llvm; 101 using namespace lldb_private; 102 103 //===----------------------------------------------------------------------===// 104 // Utility Methods for Clang 105 //===----------------------------------------------------------------------===// 106 107 class ClangExpressionParser::LLDBPreprocessorCallbacks : public PPCallbacks { 108 ClangModulesDeclVendor &m_decl_vendor; 109 ClangPersistentVariables &m_persistent_vars; 110 clang::SourceManager &m_source_mgr; 111 StreamString m_error_stream; 112 bool m_has_errors = false; 113 114 public: 115 LLDBPreprocessorCallbacks(ClangModulesDeclVendor &decl_vendor, 116 ClangPersistentVariables &persistent_vars, 117 clang::SourceManager &source_mgr) 118 : m_decl_vendor(decl_vendor), m_persistent_vars(persistent_vars), 119 m_source_mgr(source_mgr) {} 120 121 void moduleImport(SourceLocation import_location, clang::ModuleIdPath path, 122 const clang::Module * /*null*/) override { 123 // Ignore modules that are imported in the wrapper code as these are not 124 // loaded by the user. 125 llvm::StringRef filename = 126 m_source_mgr.getPresumedLoc(import_location).getFilename(); 127 if (filename == ClangExpressionSourceCode::g_prefix_file_name) 128 return; 129 130 SourceModule module; 131 132 for (const std::pair<IdentifierInfo *, SourceLocation> &component : path) 133 module.path.push_back(ConstString(component.first->getName())); 134 135 StreamString error_stream; 136 137 ClangModulesDeclVendor::ModuleVector exported_modules; 138 if (!m_decl_vendor.AddModule(module, &exported_modules, m_error_stream)) 139 m_has_errors = true; 140 141 for (ClangModulesDeclVendor::ModuleID module : exported_modules) 142 m_persistent_vars.AddHandLoadedClangModule(module); 143 } 144 145 bool hasErrors() { return m_has_errors; } 146 147 llvm::StringRef getErrorString() { return m_error_stream.GetString(); } 148 }; 149 150 static void AddAllFixIts(ClangDiagnostic *diag, const clang::Diagnostic &Info) { 151 for (auto &fix_it : Info.getFixItHints()) { 152 if (fix_it.isNull()) 153 continue; 154 diag->AddFixitHint(fix_it); 155 } 156 } 157 158 class ClangDiagnosticManagerAdapter : public clang::DiagnosticConsumer { 159 public: 160 ClangDiagnosticManagerAdapter(DiagnosticOptions &opts) { 161 DiagnosticOptions *m_options = new DiagnosticOptions(opts); 162 m_options->ShowPresumedLoc = true; 163 m_options->ShowLevel = false; 164 m_os.reset(new llvm::raw_string_ostream(m_output)); 165 m_passthrough.reset(new clang::TextDiagnosticPrinter(*m_os, m_options)); 166 } 167 168 void ResetManager(DiagnosticManager *manager = nullptr) { 169 m_manager = manager; 170 } 171 172 /// Returns the last ClangDiagnostic message that the DiagnosticManager 173 /// received or a nullptr if the DiagnosticMangager hasn't seen any 174 /// Clang diagnostics yet. 175 ClangDiagnostic *MaybeGetLastClangDiag() const { 176 if (m_manager->Diagnostics().empty()) 177 return nullptr; 178 lldb_private::Diagnostic *diag = m_manager->Diagnostics().back().get(); 179 ClangDiagnostic *clang_diag = dyn_cast<ClangDiagnostic>(diag); 180 return clang_diag; 181 } 182 183 void HandleDiagnostic(DiagnosticsEngine::Level DiagLevel, 184 const clang::Diagnostic &Info) override { 185 if (!m_manager) { 186 // We have no DiagnosticManager before/after parsing but we still could 187 // receive diagnostics (e.g., by the ASTImporter failing to copy decls 188 // when we move the expression result ot the ScratchASTContext). Let's at 189 // least log these diagnostics until we find a way to properly render 190 // them and display them to the user. 191 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_EXPRESSIONS)); 192 if (log) { 193 llvm::SmallVector<char, 32> diag_str; 194 Info.FormatDiagnostic(diag_str); 195 diag_str.push_back('\0'); 196 const char *plain_diag = diag_str.data(); 197 LLDB_LOG(log, "Received diagnostic outside parsing: {0}", plain_diag); 198 } 199 return; 200 } 201 202 // Render diagnostic message to m_output. 203 m_output.clear(); 204 m_passthrough->HandleDiagnostic(DiagLevel, Info); 205 m_os->flush(); 206 207 lldb_private::DiagnosticSeverity severity; 208 bool make_new_diagnostic = true; 209 210 switch (DiagLevel) { 211 case DiagnosticsEngine::Level::Fatal: 212 case DiagnosticsEngine::Level::Error: 213 severity = eDiagnosticSeverityError; 214 break; 215 case DiagnosticsEngine::Level::Warning: 216 severity = eDiagnosticSeverityWarning; 217 break; 218 case DiagnosticsEngine::Level::Remark: 219 case DiagnosticsEngine::Level::Ignored: 220 severity = eDiagnosticSeverityRemark; 221 break; 222 case DiagnosticsEngine::Level::Note: 223 m_manager->AppendMessageToDiagnostic(m_output); 224 make_new_diagnostic = false; 225 226 // 'note:' diagnostics for errors and warnings can also contain Fix-Its. 227 // We add these Fix-Its to the last error diagnostic to make sure 228 // that we later have all Fix-Its related to an 'error' diagnostic when 229 // we apply them to the user expression. 230 auto *clang_diag = MaybeGetLastClangDiag(); 231 // If we don't have a previous diagnostic there is nothing to do. 232 // If the previous diagnostic already has its own Fix-Its, assume that 233 // the 'note:' Fix-It is just an alternative way to solve the issue and 234 // ignore these Fix-Its. 235 if (!clang_diag || clang_diag->HasFixIts()) 236 break; 237 // Ignore all Fix-Its that are not associated with an error. 238 if (clang_diag->GetSeverity() != eDiagnosticSeverityError) 239 break; 240 AddAllFixIts(clang_diag, Info); 241 break; 242 } 243 if (make_new_diagnostic) { 244 // ClangDiagnostic messages are expected to have no whitespace/newlines 245 // around them. 246 std::string stripped_output = 247 std::string(llvm::StringRef(m_output).trim()); 248 249 auto new_diagnostic = std::make_unique<ClangDiagnostic>( 250 stripped_output, severity, Info.getID()); 251 252 // Don't store away warning fixits, since the compiler doesn't have 253 // enough context in an expression for the warning to be useful. 254 // FIXME: Should we try to filter out FixIts that apply to our generated 255 // code, and not the user's expression? 256 if (severity == eDiagnosticSeverityError) 257 AddAllFixIts(new_diagnostic.get(), Info); 258 259 m_manager->AddDiagnostic(std::move(new_diagnostic)); 260 } 261 } 262 263 clang::TextDiagnosticPrinter *GetPassthrough() { return m_passthrough.get(); } 264 265 private: 266 DiagnosticManager *m_manager = nullptr; 267 std::shared_ptr<clang::TextDiagnosticPrinter> m_passthrough; 268 /// Output stream of m_passthrough. 269 std::shared_ptr<llvm::raw_string_ostream> m_os; 270 /// Output string filled by m_os. 271 std::string m_output; 272 }; 273 274 static void SetupModuleHeaderPaths(CompilerInstance *compiler, 275 std::vector<std::string> include_directories, 276 lldb::TargetSP target_sp) { 277 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_EXPRESSIONS)); 278 279 HeaderSearchOptions &search_opts = compiler->getHeaderSearchOpts(); 280 281 for (const std::string &dir : include_directories) { 282 search_opts.AddPath(dir, frontend::System, false, true); 283 LLDB_LOG(log, "Added user include dir: {0}", dir); 284 } 285 286 llvm::SmallString<128> module_cache; 287 const auto &props = ModuleList::GetGlobalModuleListProperties(); 288 props.GetClangModulesCachePath().GetPath(module_cache); 289 search_opts.ModuleCachePath = std::string(module_cache.str()); 290 LLDB_LOG(log, "Using module cache path: {0}", module_cache.c_str()); 291 292 search_opts.ResourceDir = GetClangResourceDir().GetPath(); 293 294 search_opts.ImplicitModuleMaps = true; 295 } 296 297 //===----------------------------------------------------------------------===// 298 // Implementation of ClangExpressionParser 299 //===----------------------------------------------------------------------===// 300 301 ClangExpressionParser::ClangExpressionParser( 302 ExecutionContextScope *exe_scope, Expression &expr, 303 bool generate_debug_info, std::vector<std::string> include_directories, 304 std::string filename) 305 : ExpressionParser(exe_scope, expr, generate_debug_info), m_compiler(), 306 m_pp_callbacks(nullptr), 307 m_include_directories(std::move(include_directories)), 308 m_filename(std::move(filename)) { 309 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_EXPRESSIONS)); 310 311 // We can't compile expressions without a target. So if the exe_scope is 312 // null or doesn't have a target, then we just need to get out of here. I'll 313 // lldbassert and not make any of the compiler objects since 314 // I can't return errors directly from the constructor. Further calls will 315 // check if the compiler was made and 316 // bag out if it wasn't. 317 318 if (!exe_scope) { 319 lldbassert(exe_scope && 320 "Can't make an expression parser with a null scope."); 321 return; 322 } 323 324 lldb::TargetSP target_sp; 325 target_sp = exe_scope->CalculateTarget(); 326 if (!target_sp) { 327 lldbassert(target_sp.get() && 328 "Can't make an expression parser with a null target."); 329 return; 330 } 331 332 // 1. Create a new compiler instance. 333 m_compiler.reset(new CompilerInstance()); 334 335 // When capturing a reproducer, hook up the file collector with clang to 336 // collector modules and headers. 337 if (repro::Generator *g = repro::Reproducer::Instance().GetGenerator()) { 338 repro::FileProvider &fp = g->GetOrCreate<repro::FileProvider>(); 339 m_compiler->setModuleDepCollector( 340 std::make_shared<ModuleDependencyCollectorAdaptor>( 341 fp.GetFileCollector())); 342 DependencyOutputOptions &opts = m_compiler->getDependencyOutputOpts(); 343 opts.IncludeSystemHeaders = true; 344 opts.IncludeModuleFiles = true; 345 } 346 347 // Make sure clang uses the same VFS as LLDB. 348 m_compiler->createFileManager(FileSystem::Instance().GetVirtualFileSystem()); 349 350 lldb::LanguageType frame_lang = 351 expr.Language(); // defaults to lldb::eLanguageTypeUnknown 352 bool overridden_target_opts = false; 353 lldb_private::LanguageRuntime *lang_rt = nullptr; 354 355 std::string abi; 356 ArchSpec target_arch; 357 target_arch = target_sp->GetArchitecture(); 358 359 const auto target_machine = target_arch.GetMachine(); 360 361 // If the expression is being evaluated in the context of an existing stack 362 // frame, we introspect to see if the language runtime is available. 363 364 lldb::StackFrameSP frame_sp = exe_scope->CalculateStackFrame(); 365 lldb::ProcessSP process_sp = exe_scope->CalculateProcess(); 366 367 // Make sure the user hasn't provided a preferred execution language with 368 // `expression --language X -- ...` 369 if (frame_sp && frame_lang == lldb::eLanguageTypeUnknown) 370 frame_lang = frame_sp->GetLanguage(); 371 372 if (process_sp && frame_lang != lldb::eLanguageTypeUnknown) { 373 lang_rt = process_sp->GetLanguageRuntime(frame_lang); 374 LLDB_LOGF(log, "Frame has language of type %s", 375 Language::GetNameForLanguageType(frame_lang)); 376 } 377 378 // 2. Configure the compiler with a set of default options that are 379 // appropriate for most situations. 380 if (target_arch.IsValid()) { 381 std::string triple = target_arch.GetTriple().str(); 382 m_compiler->getTargetOpts().Triple = triple; 383 LLDB_LOGF(log, "Using %s as the target triple", 384 m_compiler->getTargetOpts().Triple.c_str()); 385 } else { 386 // If we get here we don't have a valid target and just have to guess. 387 // Sometimes this will be ok to just use the host target triple (when we 388 // evaluate say "2+3", but other expressions like breakpoint conditions and 389 // other things that _are_ target specific really shouldn't just be using 390 // the host triple. In such a case the language runtime should expose an 391 // overridden options set (3), below. 392 m_compiler->getTargetOpts().Triple = llvm::sys::getDefaultTargetTriple(); 393 LLDB_LOGF(log, "Using default target triple of %s", 394 m_compiler->getTargetOpts().Triple.c_str()); 395 } 396 // Now add some special fixes for known architectures: Any arm32 iOS 397 // environment, but not on arm64 398 if (m_compiler->getTargetOpts().Triple.find("arm64") == std::string::npos && 399 m_compiler->getTargetOpts().Triple.find("arm") != std::string::npos && 400 m_compiler->getTargetOpts().Triple.find("ios") != std::string::npos) { 401 m_compiler->getTargetOpts().ABI = "apcs-gnu"; 402 } 403 // Supported subsets of x86 404 if (target_machine == llvm::Triple::x86 || 405 target_machine == llvm::Triple::x86_64) { 406 m_compiler->getTargetOpts().Features.push_back("+sse"); 407 m_compiler->getTargetOpts().Features.push_back("+sse2"); 408 } 409 410 // Set the target CPU to generate code for. This will be empty for any CPU 411 // that doesn't really need to make a special 412 // CPU string. 413 m_compiler->getTargetOpts().CPU = target_arch.GetClangTargetCPU(); 414 415 // Set the target ABI 416 abi = GetClangTargetABI(target_arch); 417 if (!abi.empty()) 418 m_compiler->getTargetOpts().ABI = abi; 419 420 // 3. Now allow the runtime to provide custom configuration options for the 421 // target. In this case, a specialized language runtime is available and we 422 // can query it for extra options. For 99% of use cases, this will not be 423 // needed and should be provided when basic platform detection is not enough. 424 // FIXME: Generalize this. Only RenderScriptRuntime currently supports this 425 // currently. Hardcoding this isn't ideal but it's better than LanguageRuntime 426 // having knowledge of clang::TargetOpts. 427 if (auto *renderscript_rt = 428 llvm::dyn_cast_or_null<RenderScriptRuntime>(lang_rt)) 429 overridden_target_opts = 430 renderscript_rt->GetOverrideExprOptions(m_compiler->getTargetOpts()); 431 432 if (overridden_target_opts) 433 if (log && log->GetVerbose()) { 434 LLDB_LOGV( 435 log, "Using overridden target options for the expression evaluation"); 436 437 auto opts = m_compiler->getTargetOpts(); 438 LLDB_LOGV(log, "Triple: '{0}'", opts.Triple); 439 LLDB_LOGV(log, "CPU: '{0}'", opts.CPU); 440 LLDB_LOGV(log, "FPMath: '{0}'", opts.FPMath); 441 LLDB_LOGV(log, "ABI: '{0}'", opts.ABI); 442 LLDB_LOGV(log, "LinkerVersion: '{0}'", opts.LinkerVersion); 443 StringList::LogDump(log, opts.FeaturesAsWritten, "FeaturesAsWritten"); 444 StringList::LogDump(log, opts.Features, "Features"); 445 } 446 447 // 4. Create and install the target on the compiler. 448 m_compiler->createDiagnostics(); 449 auto target_info = TargetInfo::CreateTargetInfo( 450 m_compiler->getDiagnostics(), m_compiler->getInvocation().TargetOpts); 451 if (log) { 452 LLDB_LOGF(log, "Using SIMD alignment: %d", 453 target_info->getSimdDefaultAlign()); 454 LLDB_LOGF(log, "Target datalayout string: '%s'", 455 target_info->getDataLayout().getStringRepresentation().c_str()); 456 LLDB_LOGF(log, "Target ABI: '%s'", target_info->getABI().str().c_str()); 457 LLDB_LOGF(log, "Target vector alignment: %d", 458 target_info->getMaxVectorAlign()); 459 } 460 m_compiler->setTarget(target_info); 461 462 assert(m_compiler->hasTarget()); 463 464 // 5. Set language options. 465 lldb::LanguageType language = expr.Language(); 466 LangOptions &lang_opts = m_compiler->getLangOpts(); 467 468 switch (language) { 469 case lldb::eLanguageTypeC: 470 case lldb::eLanguageTypeC89: 471 case lldb::eLanguageTypeC99: 472 case lldb::eLanguageTypeC11: 473 // FIXME: the following language option is a temporary workaround, 474 // to "ask for C, get C++." 475 // For now, the expression parser must use C++ anytime the language is a C 476 // family language, because the expression parser uses features of C++ to 477 // capture values. 478 lang_opts.CPlusPlus = true; 479 break; 480 case lldb::eLanguageTypeObjC: 481 lang_opts.ObjC = true; 482 // FIXME: the following language option is a temporary workaround, 483 // to "ask for ObjC, get ObjC++" (see comment above). 484 lang_opts.CPlusPlus = true; 485 486 // Clang now sets as default C++14 as the default standard (with 487 // GNU extensions), so we do the same here to avoid mismatches that 488 // cause compiler error when evaluating expressions (e.g. nullptr not found 489 // as it's a C++11 feature). Currently lldb evaluates C++14 as C++11 (see 490 // two lines below) so we decide to be consistent with that, but this could 491 // be re-evaluated in the future. 492 lang_opts.CPlusPlus11 = true; 493 break; 494 case lldb::eLanguageTypeC_plus_plus_14: 495 lang_opts.CPlusPlus14 = true; 496 LLVM_FALLTHROUGH; 497 case lldb::eLanguageTypeC_plus_plus: 498 case lldb::eLanguageTypeC_plus_plus_11: 499 lang_opts.CPlusPlus11 = true; 500 m_compiler->getHeaderSearchOpts().UseLibcxx = true; 501 LLVM_FALLTHROUGH; 502 case lldb::eLanguageTypeC_plus_plus_03: 503 lang_opts.CPlusPlus = true; 504 if (process_sp) 505 lang_opts.ObjC = 506 process_sp->GetLanguageRuntime(lldb::eLanguageTypeObjC) != nullptr; 507 break; 508 case lldb::eLanguageTypeObjC_plus_plus: 509 case lldb::eLanguageTypeUnknown: 510 default: 511 lang_opts.ObjC = true; 512 lang_opts.CPlusPlus = true; 513 lang_opts.CPlusPlus11 = true; 514 m_compiler->getHeaderSearchOpts().UseLibcxx = true; 515 break; 516 } 517 518 lang_opts.Bool = true; 519 lang_opts.WChar = true; 520 lang_opts.Blocks = true; 521 lang_opts.DebuggerSupport = 522 true; // Features specifically for debugger clients 523 if (expr.DesiredResultType() == Expression::eResultTypeId) 524 lang_opts.DebuggerCastResultToId = true; 525 526 lang_opts.CharIsSigned = ArchSpec(m_compiler->getTargetOpts().Triple.c_str()) 527 .CharIsSignedByDefault(); 528 529 // Spell checking is a nice feature, but it ends up completing a lot of types 530 // that we didn't strictly speaking need to complete. As a result, we spend a 531 // long time parsing and importing debug information. 532 lang_opts.SpellChecking = false; 533 534 auto *clang_expr = dyn_cast<ClangUserExpression>(&m_expr); 535 if (clang_expr && clang_expr->DidImportCxxModules()) { 536 LLDB_LOG(log, "Adding lang options for importing C++ modules"); 537 538 lang_opts.Modules = true; 539 // We want to implicitly build modules. 540 lang_opts.ImplicitModules = true; 541 // To automatically import all submodules when we import 'std'. 542 lang_opts.ModulesLocalVisibility = false; 543 544 // We use the @import statements, so we need this: 545 // FIXME: We could use the modules-ts, but that currently doesn't work. 546 lang_opts.ObjC = true; 547 548 // Options we need to parse libc++ code successfully. 549 // FIXME: We should ask the driver for the appropriate default flags. 550 lang_opts.GNUMode = true; 551 lang_opts.GNUKeywords = true; 552 lang_opts.DoubleSquareBracketAttributes = true; 553 lang_opts.CPlusPlus11 = true; 554 555 // The Darwin libc expects this macro to be set. 556 lang_opts.GNUCVersion = 40201; 557 558 SetupModuleHeaderPaths(m_compiler.get(), m_include_directories, 559 target_sp); 560 } 561 562 if (process_sp && lang_opts.ObjC) { 563 if (auto *runtime = ObjCLanguageRuntime::Get(*process_sp)) { 564 if (runtime->GetRuntimeVersion() == 565 ObjCLanguageRuntime::ObjCRuntimeVersions::eAppleObjC_V2) 566 lang_opts.ObjCRuntime.set(ObjCRuntime::MacOSX, VersionTuple(10, 7)); 567 else 568 lang_opts.ObjCRuntime.set(ObjCRuntime::FragileMacOSX, 569 VersionTuple(10, 7)); 570 571 if (runtime->HasNewLiteralsAndIndexing()) 572 lang_opts.DebuggerObjCLiteral = true; 573 } 574 } 575 576 lang_opts.ThreadsafeStatics = false; 577 lang_opts.AccessControl = false; // Debuggers get universal access 578 lang_opts.DollarIdents = true; // $ indicates a persistent variable name 579 // We enable all builtin functions beside the builtins from libc/libm (e.g. 580 // 'fopen'). Those libc functions are already correctly handled by LLDB, and 581 // additionally enabling them as expandable builtins is breaking Clang. 582 lang_opts.NoBuiltin = true; 583 584 // Set CodeGen options 585 m_compiler->getCodeGenOpts().EmitDeclMetadata = true; 586 m_compiler->getCodeGenOpts().InstrumentFunctions = false; 587 m_compiler->getCodeGenOpts().setFramePointer( 588 CodeGenOptions::FramePointerKind::All); 589 if (generate_debug_info) 590 m_compiler->getCodeGenOpts().setDebugInfo(codegenoptions::FullDebugInfo); 591 else 592 m_compiler->getCodeGenOpts().setDebugInfo(codegenoptions::NoDebugInfo); 593 594 // Disable some warnings. 595 m_compiler->getDiagnostics().setSeverityForGroup( 596 clang::diag::Flavor::WarningOrError, "unused-value", 597 clang::diag::Severity::Ignored, SourceLocation()); 598 m_compiler->getDiagnostics().setSeverityForGroup( 599 clang::diag::Flavor::WarningOrError, "odr", 600 clang::diag::Severity::Ignored, SourceLocation()); 601 602 // Inform the target of the language options 603 // 604 // FIXME: We shouldn't need to do this, the target should be immutable once 605 // created. This complexity should be lifted elsewhere. 606 m_compiler->getTarget().adjust(m_compiler->getLangOpts()); 607 608 // 6. Set up the diagnostic buffer for reporting errors 609 610 auto diag_mgr = new ClangDiagnosticManagerAdapter( 611 m_compiler->getDiagnostics().getDiagnosticOptions()); 612 m_compiler->getDiagnostics().setClient(diag_mgr); 613 614 // 7. Set up the source management objects inside the compiler 615 m_compiler->createFileManager(); 616 if (!m_compiler->hasSourceManager()) 617 m_compiler->createSourceManager(m_compiler->getFileManager()); 618 m_compiler->createPreprocessor(TU_Complete); 619 620 if (ClangModulesDeclVendor *decl_vendor = 621 target_sp->GetClangModulesDeclVendor()) { 622 if (auto *clang_persistent_vars = llvm::cast<ClangPersistentVariables>( 623 target_sp->GetPersistentExpressionStateForLanguage( 624 lldb::eLanguageTypeC))) { 625 std::unique_ptr<PPCallbacks> pp_callbacks( 626 new LLDBPreprocessorCallbacks(*decl_vendor, *clang_persistent_vars, 627 m_compiler->getSourceManager())); 628 m_pp_callbacks = 629 static_cast<LLDBPreprocessorCallbacks *>(pp_callbacks.get()); 630 m_compiler->getPreprocessor().addPPCallbacks(std::move(pp_callbacks)); 631 } 632 } 633 634 // 8. Most of this we get from the CompilerInstance, but we also want to give 635 // the context an ExternalASTSource. 636 637 auto &PP = m_compiler->getPreprocessor(); 638 auto &builtin_context = PP.getBuiltinInfo(); 639 builtin_context.initializeBuiltins(PP.getIdentifierTable(), 640 m_compiler->getLangOpts()); 641 642 m_compiler->createASTContext(); 643 clang::ASTContext &ast_context = m_compiler->getASTContext(); 644 645 m_ast_context.reset(new TypeSystemClang( 646 "Expression ASTContext for '" + m_filename + "'", ast_context)); 647 648 std::string module_name("$__lldb_module"); 649 650 m_llvm_context.reset(new LLVMContext()); 651 m_code_generator.reset(CreateLLVMCodeGen( 652 m_compiler->getDiagnostics(), module_name, 653 m_compiler->getHeaderSearchOpts(), m_compiler->getPreprocessorOpts(), 654 m_compiler->getCodeGenOpts(), *m_llvm_context)); 655 } 656 657 ClangExpressionParser::~ClangExpressionParser() {} 658 659 namespace { 660 661 /// \class CodeComplete 662 /// 663 /// A code completion consumer for the clang Sema that is responsible for 664 /// creating the completion suggestions when a user requests completion 665 /// of an incomplete `expr` invocation. 666 class CodeComplete : public CodeCompleteConsumer { 667 CodeCompletionTUInfo m_info; 668 669 std::string m_expr; 670 unsigned m_position = 0; 671 CompletionRequest &m_request; 672 /// The printing policy we use when printing declarations for our completion 673 /// descriptions. 674 clang::PrintingPolicy m_desc_policy; 675 676 /// Returns true if the given character can be used in an identifier. 677 /// This also returns true for numbers because for completion we usually 678 /// just iterate backwards over iterators. 679 /// 680 /// Note: lldb uses '$' in its internal identifiers, so we also allow this. 681 static bool IsIdChar(char c) { 682 return c == '_' || std::isalnum(c) || c == '$'; 683 } 684 685 /// Returns true if the given character is used to separate arguments 686 /// in the command line of lldb. 687 static bool IsTokenSeparator(char c) { return c == ' ' || c == '\t'; } 688 689 /// Drops all tokens in front of the expression that are unrelated for 690 /// the completion of the cmd line. 'unrelated' means here that the token 691 /// is not interested for the lldb completion API result. 692 StringRef dropUnrelatedFrontTokens(StringRef cmd) { 693 if (cmd.empty()) 694 return cmd; 695 696 // If we are at the start of a word, then all tokens are unrelated to 697 // the current completion logic. 698 if (IsTokenSeparator(cmd.back())) 699 return StringRef(); 700 701 // Remove all previous tokens from the string as they are unrelated 702 // to completing the current token. 703 StringRef to_remove = cmd; 704 while (!to_remove.empty() && !IsTokenSeparator(to_remove.back())) { 705 to_remove = to_remove.drop_back(); 706 } 707 cmd = cmd.drop_front(to_remove.size()); 708 709 return cmd; 710 } 711 712 /// Removes the last identifier token from the given cmd line. 713 StringRef removeLastToken(StringRef cmd) { 714 while (!cmd.empty() && IsIdChar(cmd.back())) { 715 cmd = cmd.drop_back(); 716 } 717 return cmd; 718 } 719 720 /// Attempts to merge the given completion from the given position into the 721 /// existing command. Returns the completion string that can be returned to 722 /// the lldb completion API. 723 std::string mergeCompletion(StringRef existing, unsigned pos, 724 StringRef completion) { 725 StringRef existing_command = existing.substr(0, pos); 726 // We rewrite the last token with the completion, so let's drop that 727 // token from the command. 728 existing_command = removeLastToken(existing_command); 729 // We also should remove all previous tokens from the command as they 730 // would otherwise be added to the completion that already has the 731 // completion. 732 existing_command = dropUnrelatedFrontTokens(existing_command); 733 return existing_command.str() + completion.str(); 734 } 735 736 public: 737 /// Constructs a CodeComplete consumer that can be attached to a Sema. 738 /// 739 /// \param[out] expr 740 /// The whole expression string that we are currently parsing. This 741 /// string needs to be equal to the input the user typed, and NOT the 742 /// final code that Clang is parsing. 743 /// \param[out] position 744 /// The character position of the user cursor in the `expr` parameter. 745 /// 746 CodeComplete(CompletionRequest &request, clang::LangOptions ops, 747 std::string expr, unsigned position) 748 : CodeCompleteConsumer(CodeCompleteOptions()), 749 m_info(std::make_shared<GlobalCodeCompletionAllocator>()), m_expr(expr), 750 m_position(position), m_request(request), m_desc_policy(ops) { 751 752 // Ensure that the printing policy is producing a description that is as 753 // short as possible. 754 m_desc_policy.SuppressScope = true; 755 m_desc_policy.SuppressTagKeyword = true; 756 m_desc_policy.FullyQualifiedName = false; 757 m_desc_policy.TerseOutput = true; 758 m_desc_policy.IncludeNewlines = false; 759 m_desc_policy.UseVoidForZeroParams = false; 760 m_desc_policy.Bool = true; 761 } 762 763 /// Deregisters and destroys this code-completion consumer. 764 ~CodeComplete() override {} 765 766 /// \name Code-completion filtering 767 /// Check if the result should be filtered out. 768 bool isResultFilteredOut(StringRef Filter, 769 CodeCompletionResult Result) override { 770 // This code is mostly copied from CodeCompleteConsumer. 771 switch (Result.Kind) { 772 case CodeCompletionResult::RK_Declaration: 773 return !( 774 Result.Declaration->getIdentifier() && 775 Result.Declaration->getIdentifier()->getName().startswith(Filter)); 776 case CodeCompletionResult::RK_Keyword: 777 return !StringRef(Result.Keyword).startswith(Filter); 778 case CodeCompletionResult::RK_Macro: 779 return !Result.Macro->getName().startswith(Filter); 780 case CodeCompletionResult::RK_Pattern: 781 return !StringRef(Result.Pattern->getAsString()).startswith(Filter); 782 } 783 // If we trigger this assert or the above switch yields a warning, then 784 // CodeCompletionResult has been enhanced with more kinds of completion 785 // results. Expand the switch above in this case. 786 assert(false && "Unknown completion result type?"); 787 // If we reach this, then we should just ignore whatever kind of unknown 788 // result we got back. We probably can't turn it into any kind of useful 789 // completion suggestion with the existing code. 790 return true; 791 } 792 793 /// \name Code-completion callbacks 794 /// Process the finalized code-completion results. 795 void ProcessCodeCompleteResults(Sema &SemaRef, CodeCompletionContext Context, 796 CodeCompletionResult *Results, 797 unsigned NumResults) override { 798 799 // The Sema put the incomplete token we try to complete in here during 800 // lexing, so we need to retrieve it here to know what we are completing. 801 StringRef Filter = SemaRef.getPreprocessor().getCodeCompletionFilter(); 802 803 // Iterate over all the results. Filter out results we don't want and 804 // process the rest. 805 for (unsigned I = 0; I != NumResults; ++I) { 806 // Filter the results with the information from the Sema. 807 if (!Filter.empty() && isResultFilteredOut(Filter, Results[I])) 808 continue; 809 810 CodeCompletionResult &R = Results[I]; 811 std::string ToInsert; 812 std::string Description; 813 // Handle the different completion kinds that come from the Sema. 814 switch (R.Kind) { 815 case CodeCompletionResult::RK_Declaration: { 816 const NamedDecl *D = R.Declaration; 817 ToInsert = R.Declaration->getNameAsString(); 818 // If we have a function decl that has no arguments we want to 819 // complete the empty parantheses for the user. If the function has 820 // arguments, we at least complete the opening bracket. 821 if (const FunctionDecl *F = dyn_cast<FunctionDecl>(D)) { 822 if (F->getNumParams() == 0) 823 ToInsert += "()"; 824 else 825 ToInsert += "("; 826 raw_string_ostream OS(Description); 827 F->print(OS, m_desc_policy, false); 828 OS.flush(); 829 } else if (const VarDecl *V = dyn_cast<VarDecl>(D)) { 830 Description = V->getType().getAsString(m_desc_policy); 831 } else if (const FieldDecl *F = dyn_cast<FieldDecl>(D)) { 832 Description = F->getType().getAsString(m_desc_policy); 833 } else if (const NamespaceDecl *N = dyn_cast<NamespaceDecl>(D)) { 834 // If we try to complete a namespace, then we can directly append 835 // the '::'. 836 if (!N->isAnonymousNamespace()) 837 ToInsert += "::"; 838 } 839 break; 840 } 841 case CodeCompletionResult::RK_Keyword: 842 ToInsert = R.Keyword; 843 break; 844 case CodeCompletionResult::RK_Macro: 845 ToInsert = R.Macro->getName().str(); 846 break; 847 case CodeCompletionResult::RK_Pattern: 848 ToInsert = R.Pattern->getTypedText(); 849 break; 850 } 851 // At this point all information is in the ToInsert string. 852 853 // We also filter some internal lldb identifiers here. The user 854 // shouldn't see these. 855 if (StringRef(ToInsert).startswith("$__lldb_")) 856 continue; 857 if (!ToInsert.empty()) { 858 // Merge the suggested Token into the existing command line to comply 859 // with the kind of result the lldb API expects. 860 std::string CompletionSuggestion = 861 mergeCompletion(m_expr, m_position, ToInsert); 862 m_request.AddCompletion(CompletionSuggestion, Description); 863 } 864 } 865 } 866 867 /// \param S the semantic-analyzer object for which code-completion is being 868 /// done. 869 /// 870 /// \param CurrentArg the index of the current argument. 871 /// 872 /// \param Candidates an array of overload candidates. 873 /// 874 /// \param NumCandidates the number of overload candidates 875 void ProcessOverloadCandidates(Sema &S, unsigned CurrentArg, 876 OverloadCandidate *Candidates, 877 unsigned NumCandidates, 878 SourceLocation OpenParLoc) override { 879 // At the moment we don't filter out any overloaded candidates. 880 } 881 882 CodeCompletionAllocator &getAllocator() override { 883 return m_info.getAllocator(); 884 } 885 886 CodeCompletionTUInfo &getCodeCompletionTUInfo() override { return m_info; } 887 }; 888 } // namespace 889 890 bool ClangExpressionParser::Complete(CompletionRequest &request, unsigned line, 891 unsigned pos, unsigned typed_pos) { 892 DiagnosticManager mgr; 893 // We need the raw user expression here because that's what the CodeComplete 894 // class uses to provide completion suggestions. 895 // However, the `Text` method only gives us the transformed expression here. 896 // To actually get the raw user input here, we have to cast our expression to 897 // the LLVMUserExpression which exposes the right API. This should never fail 898 // as we always have a ClangUserExpression whenever we call this. 899 ClangUserExpression *llvm_expr = cast<ClangUserExpression>(&m_expr); 900 CodeComplete CC(request, m_compiler->getLangOpts(), llvm_expr->GetUserText(), 901 typed_pos); 902 // We don't need a code generator for parsing. 903 m_code_generator.reset(); 904 // Start parsing the expression with our custom code completion consumer. 905 ParseInternal(mgr, &CC, line, pos); 906 return true; 907 } 908 909 unsigned ClangExpressionParser::Parse(DiagnosticManager &diagnostic_manager) { 910 return ParseInternal(diagnostic_manager); 911 } 912 913 unsigned 914 ClangExpressionParser::ParseInternal(DiagnosticManager &diagnostic_manager, 915 CodeCompleteConsumer *completion_consumer, 916 unsigned completion_line, 917 unsigned completion_column) { 918 ClangDiagnosticManagerAdapter *adapter = 919 static_cast<ClangDiagnosticManagerAdapter *>( 920 m_compiler->getDiagnostics().getClient()); 921 auto diag_buf = adapter->GetPassthrough(); 922 923 adapter->ResetManager(&diagnostic_manager); 924 925 const char *expr_text = m_expr.Text(); 926 927 clang::SourceManager &source_mgr = m_compiler->getSourceManager(); 928 bool created_main_file = false; 929 930 // Clang wants to do completion on a real file known by Clang's file manager, 931 // so we have to create one to make this work. 932 // TODO: We probably could also simulate to Clang's file manager that there 933 // is a real file that contains our code. 934 bool should_create_file = completion_consumer != nullptr; 935 936 // We also want a real file on disk if we generate full debug info. 937 should_create_file |= m_compiler->getCodeGenOpts().getDebugInfo() == 938 codegenoptions::FullDebugInfo; 939 940 if (should_create_file) { 941 int temp_fd = -1; 942 llvm::SmallString<128> result_path; 943 if (FileSpec tmpdir_file_spec = HostInfo::GetProcessTempDir()) { 944 tmpdir_file_spec.AppendPathComponent("lldb-%%%%%%.expr"); 945 std::string temp_source_path = tmpdir_file_spec.GetPath(); 946 llvm::sys::fs::createUniqueFile(temp_source_path, temp_fd, result_path); 947 } else { 948 llvm::sys::fs::createTemporaryFile("lldb", "expr", temp_fd, result_path); 949 } 950 951 if (temp_fd != -1) { 952 lldb_private::NativeFile file(temp_fd, File::eOpenOptionWrite, true); 953 const size_t expr_text_len = strlen(expr_text); 954 size_t bytes_written = expr_text_len; 955 if (file.Write(expr_text, bytes_written).Success()) { 956 if (bytes_written == expr_text_len) { 957 file.Close(); 958 if (auto fileEntry = 959 m_compiler->getFileManager().getFile(result_path)) { 960 source_mgr.setMainFileID(source_mgr.createFileID( 961 *fileEntry, 962 SourceLocation(), SrcMgr::C_User)); 963 created_main_file = true; 964 } 965 } 966 } 967 } 968 } 969 970 if (!created_main_file) { 971 std::unique_ptr<MemoryBuffer> memory_buffer = 972 MemoryBuffer::getMemBufferCopy(expr_text, m_filename); 973 source_mgr.setMainFileID(source_mgr.createFileID(std::move(memory_buffer))); 974 } 975 976 diag_buf->BeginSourceFile(m_compiler->getLangOpts(), 977 &m_compiler->getPreprocessor()); 978 979 ClangExpressionHelper *type_system_helper = 980 dyn_cast<ClangExpressionHelper>(m_expr.GetTypeSystemHelper()); 981 982 // If we want to parse for code completion, we need to attach our code 983 // completion consumer to the Sema and specify a completion position. 984 // While parsing the Sema will call this consumer with the provided 985 // completion suggestions. 986 if (completion_consumer) { 987 auto main_file = source_mgr.getFileEntryForID(source_mgr.getMainFileID()); 988 auto &PP = m_compiler->getPreprocessor(); 989 // Lines and columns start at 1 in Clang, but code completion positions are 990 // indexed from 0, so we need to add 1 to the line and column here. 991 ++completion_line; 992 ++completion_column; 993 PP.SetCodeCompletionPoint(main_file, completion_line, completion_column); 994 } 995 996 ASTConsumer *ast_transformer = 997 type_system_helper->ASTTransformer(m_code_generator.get()); 998 999 std::unique_ptr<clang::ASTConsumer> Consumer; 1000 if (ast_transformer) { 1001 Consumer.reset(new ASTConsumerForwarder(ast_transformer)); 1002 } else if (m_code_generator) { 1003 Consumer.reset(new ASTConsumerForwarder(m_code_generator.get())); 1004 } else { 1005 Consumer.reset(new ASTConsumer()); 1006 } 1007 1008 clang::ASTContext &ast_context = m_compiler->getASTContext(); 1009 1010 m_compiler->setSema(new Sema(m_compiler->getPreprocessor(), ast_context, 1011 *Consumer, TU_Complete, completion_consumer)); 1012 m_compiler->setASTConsumer(std::move(Consumer)); 1013 1014 if (ast_context.getLangOpts().Modules) { 1015 m_compiler->createASTReader(); 1016 m_ast_context->setSema(&m_compiler->getSema()); 1017 } 1018 1019 ClangExpressionDeclMap *decl_map = type_system_helper->DeclMap(); 1020 if (decl_map) { 1021 decl_map->InstallCodeGenerator(&m_compiler->getASTConsumer()); 1022 1023 clang::ExternalASTSource *ast_source = decl_map->CreateProxy(); 1024 1025 if (ast_context.getExternalSource()) { 1026 auto module_wrapper = 1027 new ExternalASTSourceWrapper(ast_context.getExternalSource()); 1028 1029 auto ast_source_wrapper = new ExternalASTSourceWrapper(ast_source); 1030 1031 auto multiplexer = 1032 new SemaSourceWithPriorities(*module_wrapper, *ast_source_wrapper); 1033 IntrusiveRefCntPtr<ExternalASTSource> Source(multiplexer); 1034 ast_context.setExternalSource(Source); 1035 } else { 1036 ast_context.setExternalSource(ast_source); 1037 } 1038 decl_map->InstallASTContext(*m_ast_context); 1039 } 1040 1041 // Check that the ASTReader is properly attached to ASTContext and Sema. 1042 if (ast_context.getLangOpts().Modules) { 1043 assert(m_compiler->getASTContext().getExternalSource() && 1044 "ASTContext doesn't know about the ASTReader?"); 1045 assert(m_compiler->getSema().getExternalSource() && 1046 "Sema doesn't know about the ASTReader?"); 1047 } 1048 1049 { 1050 llvm::CrashRecoveryContextCleanupRegistrar<Sema> CleanupSema( 1051 &m_compiler->getSema()); 1052 ParseAST(m_compiler->getSema(), false, false); 1053 } 1054 1055 // Make sure we have no pointer to the Sema we are about to destroy. 1056 if (ast_context.getLangOpts().Modules) 1057 m_ast_context->setSema(nullptr); 1058 // Destroy the Sema. This is necessary because we want to emulate the 1059 // original behavior of ParseAST (which also destroys the Sema after parsing). 1060 m_compiler->setSema(nullptr); 1061 1062 diag_buf->EndSourceFile(); 1063 1064 unsigned num_errors = diag_buf->getNumErrors(); 1065 1066 if (m_pp_callbacks && m_pp_callbacks->hasErrors()) { 1067 num_errors++; 1068 diagnostic_manager.PutString(eDiagnosticSeverityError, 1069 "while importing modules:"); 1070 diagnostic_manager.AppendMessageToDiagnostic( 1071 m_pp_callbacks->getErrorString()); 1072 } 1073 1074 if (!num_errors) { 1075 type_system_helper->CommitPersistentDecls(); 1076 } 1077 1078 adapter->ResetManager(); 1079 1080 return num_errors; 1081 } 1082 1083 std::string 1084 ClangExpressionParser::GetClangTargetABI(const ArchSpec &target_arch) { 1085 std::string abi; 1086 1087 if (target_arch.IsMIPS()) { 1088 switch (target_arch.GetFlags() & ArchSpec::eMIPSABI_mask) { 1089 case ArchSpec::eMIPSABI_N64: 1090 abi = "n64"; 1091 break; 1092 case ArchSpec::eMIPSABI_N32: 1093 abi = "n32"; 1094 break; 1095 case ArchSpec::eMIPSABI_O32: 1096 abi = "o32"; 1097 break; 1098 default: 1099 break; 1100 } 1101 } 1102 return abi; 1103 } 1104 1105 /// Applies the given Fix-It hint to the given commit. 1106 static void ApplyFixIt(const FixItHint &fixit, clang::edit::Commit &commit) { 1107 // This is cobbed from clang::Rewrite::FixItRewriter. 1108 if (fixit.CodeToInsert.empty()) { 1109 if (fixit.InsertFromRange.isValid()) { 1110 commit.insertFromRange(fixit.RemoveRange.getBegin(), 1111 fixit.InsertFromRange, /*afterToken=*/false, 1112 fixit.BeforePreviousInsertions); 1113 return; 1114 } 1115 commit.remove(fixit.RemoveRange); 1116 return; 1117 } 1118 if (fixit.RemoveRange.isTokenRange() || 1119 fixit.RemoveRange.getBegin() != fixit.RemoveRange.getEnd()) { 1120 commit.replace(fixit.RemoveRange, fixit.CodeToInsert); 1121 return; 1122 } 1123 commit.insert(fixit.RemoveRange.getBegin(), fixit.CodeToInsert, 1124 /*afterToken=*/false, fixit.BeforePreviousInsertions); 1125 } 1126 1127 bool ClangExpressionParser::RewriteExpression( 1128 DiagnosticManager &diagnostic_manager) { 1129 clang::SourceManager &source_manager = m_compiler->getSourceManager(); 1130 clang::edit::EditedSource editor(source_manager, m_compiler->getLangOpts(), 1131 nullptr); 1132 clang::edit::Commit commit(editor); 1133 clang::Rewriter rewriter(source_manager, m_compiler->getLangOpts()); 1134 1135 class RewritesReceiver : public edit::EditsReceiver { 1136 Rewriter &rewrite; 1137 1138 public: 1139 RewritesReceiver(Rewriter &in_rewrite) : rewrite(in_rewrite) {} 1140 1141 void insert(SourceLocation loc, StringRef text) override { 1142 rewrite.InsertText(loc, text); 1143 } 1144 void replace(CharSourceRange range, StringRef text) override { 1145 rewrite.ReplaceText(range.getBegin(), rewrite.getRangeSize(range), text); 1146 } 1147 }; 1148 1149 RewritesReceiver rewrites_receiver(rewriter); 1150 1151 const DiagnosticList &diagnostics = diagnostic_manager.Diagnostics(); 1152 size_t num_diags = diagnostics.size(); 1153 if (num_diags == 0) 1154 return false; 1155 1156 for (const auto &diag : diagnostic_manager.Diagnostics()) { 1157 const auto *diagnostic = llvm::dyn_cast<ClangDiagnostic>(diag.get()); 1158 if (!diagnostic) 1159 continue; 1160 if (!diagnostic->HasFixIts()) 1161 continue; 1162 for (const FixItHint &fixit : diagnostic->FixIts()) 1163 ApplyFixIt(fixit, commit); 1164 } 1165 1166 // FIXME - do we want to try to propagate specific errors here? 1167 if (!commit.isCommitable()) 1168 return false; 1169 else if (!editor.commit(commit)) 1170 return false; 1171 1172 // Now play all the edits, and stash the result in the diagnostic manager. 1173 editor.applyRewrites(rewrites_receiver); 1174 RewriteBuffer &main_file_buffer = 1175 rewriter.getEditBuffer(source_manager.getMainFileID()); 1176 1177 std::string fixed_expression; 1178 llvm::raw_string_ostream out_stream(fixed_expression); 1179 1180 main_file_buffer.write(out_stream); 1181 out_stream.flush(); 1182 diagnostic_manager.SetFixedExpression(fixed_expression); 1183 1184 return true; 1185 } 1186 1187 static bool FindFunctionInModule(ConstString &mangled_name, 1188 llvm::Module *module, const char *orig_name) { 1189 for (const auto &func : module->getFunctionList()) { 1190 const StringRef &name = func.getName(); 1191 if (name.find(orig_name) != StringRef::npos) { 1192 mangled_name.SetString(name); 1193 return true; 1194 } 1195 } 1196 1197 return false; 1198 } 1199 1200 lldb_private::Status ClangExpressionParser::PrepareForExecution( 1201 lldb::addr_t &func_addr, lldb::addr_t &func_end, 1202 lldb::IRExecutionUnitSP &execution_unit_sp, ExecutionContext &exe_ctx, 1203 bool &can_interpret, ExecutionPolicy execution_policy) { 1204 func_addr = LLDB_INVALID_ADDRESS; 1205 func_end = LLDB_INVALID_ADDRESS; 1206 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_EXPRESSIONS)); 1207 1208 lldb_private::Status err; 1209 1210 std::unique_ptr<llvm::Module> llvm_module_up( 1211 m_code_generator->ReleaseModule()); 1212 1213 if (!llvm_module_up) { 1214 err.SetErrorToGenericError(); 1215 err.SetErrorString("IR doesn't contain a module"); 1216 return err; 1217 } 1218 1219 ConstString function_name; 1220 1221 if (execution_policy != eExecutionPolicyTopLevel) { 1222 // Find the actual name of the function (it's often mangled somehow) 1223 1224 if (!FindFunctionInModule(function_name, llvm_module_up.get(), 1225 m_expr.FunctionName())) { 1226 err.SetErrorToGenericError(); 1227 err.SetErrorStringWithFormat("Couldn't find %s() in the module", 1228 m_expr.FunctionName()); 1229 return err; 1230 } else { 1231 LLDB_LOGF(log, "Found function %s for %s", function_name.AsCString(), 1232 m_expr.FunctionName()); 1233 } 1234 } 1235 1236 SymbolContext sc; 1237 1238 if (lldb::StackFrameSP frame_sp = exe_ctx.GetFrameSP()) { 1239 sc = frame_sp->GetSymbolContext(lldb::eSymbolContextEverything); 1240 } else if (lldb::TargetSP target_sp = exe_ctx.GetTargetSP()) { 1241 sc.target_sp = target_sp; 1242 } 1243 1244 LLVMUserExpression::IRPasses custom_passes; 1245 { 1246 auto lang = m_expr.Language(); 1247 LLDB_LOGF(log, "%s - Current expression language is %s\n", __FUNCTION__, 1248 Language::GetNameForLanguageType(lang)); 1249 lldb::ProcessSP process_sp = exe_ctx.GetProcessSP(); 1250 if (process_sp && lang != lldb::eLanguageTypeUnknown) { 1251 auto runtime = process_sp->GetLanguageRuntime(lang); 1252 if (runtime) 1253 runtime->GetIRPasses(custom_passes); 1254 } 1255 } 1256 1257 if (custom_passes.EarlyPasses) { 1258 LLDB_LOGF(log, 1259 "%s - Running Early IR Passes from LanguageRuntime on " 1260 "expression module '%s'", 1261 __FUNCTION__, m_expr.FunctionName()); 1262 1263 custom_passes.EarlyPasses->run(*llvm_module_up); 1264 } 1265 1266 execution_unit_sp = std::make_shared<IRExecutionUnit>( 1267 m_llvm_context, // handed off here 1268 llvm_module_up, // handed off here 1269 function_name, exe_ctx.GetTargetSP(), sc, 1270 m_compiler->getTargetOpts().Features); 1271 1272 ClangExpressionHelper *type_system_helper = 1273 dyn_cast<ClangExpressionHelper>(m_expr.GetTypeSystemHelper()); 1274 ClangExpressionDeclMap *decl_map = 1275 type_system_helper->DeclMap(); // result can be NULL 1276 1277 if (decl_map) { 1278 Target *target = exe_ctx.GetTargetPtr(); 1279 auto &error_stream = target->GetDebugger().GetErrorStream(); 1280 IRForTarget ir_for_target(decl_map, m_expr.NeedsVariableResolution(), 1281 *execution_unit_sp, error_stream, 1282 function_name.AsCString()); 1283 1284 bool ir_can_run = 1285 ir_for_target.runOnModule(*execution_unit_sp->GetModule()); 1286 1287 if (!ir_can_run) { 1288 err.SetErrorString( 1289 "The expression could not be prepared to run in the target"); 1290 return err; 1291 } 1292 1293 Process *process = exe_ctx.GetProcessPtr(); 1294 1295 if (execution_policy != eExecutionPolicyAlways && 1296 execution_policy != eExecutionPolicyTopLevel) { 1297 lldb_private::Status interpret_error; 1298 1299 bool interpret_function_calls = 1300 !process ? false : process->CanInterpretFunctionCalls(); 1301 can_interpret = IRInterpreter::CanInterpret( 1302 *execution_unit_sp->GetModule(), *execution_unit_sp->GetFunction(), 1303 interpret_error, interpret_function_calls); 1304 1305 if (!can_interpret && execution_policy == eExecutionPolicyNever) { 1306 err.SetErrorStringWithFormat( 1307 "Can't evaluate the expression without a running target due to: %s", 1308 interpret_error.AsCString()); 1309 return err; 1310 } 1311 } 1312 1313 if (!process && execution_policy == eExecutionPolicyAlways) { 1314 err.SetErrorString("Expression needed to run in the target, but the " 1315 "target can't be run"); 1316 return err; 1317 } 1318 1319 if (!process && execution_policy == eExecutionPolicyTopLevel) { 1320 err.SetErrorString("Top-level code needs to be inserted into a runnable " 1321 "target, but the target can't be run"); 1322 return err; 1323 } 1324 1325 if (execution_policy == eExecutionPolicyAlways || 1326 (execution_policy != eExecutionPolicyTopLevel && !can_interpret)) { 1327 if (m_expr.NeedsValidation() && process) { 1328 if (!process->GetDynamicCheckers()) { 1329 ClangDynamicCheckerFunctions *dynamic_checkers = 1330 new ClangDynamicCheckerFunctions(); 1331 1332 DiagnosticManager install_diagnostics; 1333 1334 if (!dynamic_checkers->Install(install_diagnostics, exe_ctx)) { 1335 if (install_diagnostics.Diagnostics().size()) 1336 err.SetErrorString(install_diagnostics.GetString().c_str()); 1337 else 1338 err.SetErrorString("couldn't install checkers, unknown error"); 1339 1340 return err; 1341 } 1342 1343 process->SetDynamicCheckers(dynamic_checkers); 1344 1345 LLDB_LOGF(log, "== [ClangExpressionParser::PrepareForExecution] " 1346 "Finished installing dynamic checkers =="); 1347 } 1348 1349 if (auto *checker_funcs = llvm::dyn_cast<ClangDynamicCheckerFunctions>( 1350 process->GetDynamicCheckers())) { 1351 IRDynamicChecks ir_dynamic_checks(*checker_funcs, 1352 function_name.AsCString()); 1353 1354 llvm::Module *module = execution_unit_sp->GetModule(); 1355 if (!module || !ir_dynamic_checks.runOnModule(*module)) { 1356 err.SetErrorToGenericError(); 1357 err.SetErrorString("Couldn't add dynamic checks to the expression"); 1358 return err; 1359 } 1360 1361 if (custom_passes.LatePasses) { 1362 LLDB_LOGF(log, 1363 "%s - Running Late IR Passes from LanguageRuntime on " 1364 "expression module '%s'", 1365 __FUNCTION__, m_expr.FunctionName()); 1366 1367 custom_passes.LatePasses->run(*module); 1368 } 1369 } 1370 } 1371 } 1372 1373 if (execution_policy == eExecutionPolicyAlways || 1374 execution_policy == eExecutionPolicyTopLevel || !can_interpret) { 1375 execution_unit_sp->GetRunnableInfo(err, func_addr, func_end); 1376 } 1377 } else { 1378 execution_unit_sp->GetRunnableInfo(err, func_addr, func_end); 1379 } 1380 1381 return err; 1382 } 1383 1384 lldb_private::Status ClangExpressionParser::RunStaticInitializers( 1385 lldb::IRExecutionUnitSP &execution_unit_sp, ExecutionContext &exe_ctx) { 1386 lldb_private::Status err; 1387 1388 lldbassert(execution_unit_sp.get()); 1389 lldbassert(exe_ctx.HasThreadScope()); 1390 1391 if (!execution_unit_sp.get()) { 1392 err.SetErrorString( 1393 "can't run static initializers for a NULL execution unit"); 1394 return err; 1395 } 1396 1397 if (!exe_ctx.HasThreadScope()) { 1398 err.SetErrorString("can't run static initializers without a thread"); 1399 return err; 1400 } 1401 1402 std::vector<lldb::addr_t> static_initializers; 1403 1404 execution_unit_sp->GetStaticInitializers(static_initializers); 1405 1406 for (lldb::addr_t static_initializer : static_initializers) { 1407 EvaluateExpressionOptions options; 1408 1409 lldb::ThreadPlanSP call_static_initializer(new ThreadPlanCallFunction( 1410 exe_ctx.GetThreadRef(), Address(static_initializer), CompilerType(), 1411 llvm::ArrayRef<lldb::addr_t>(), options)); 1412 1413 DiagnosticManager execution_errors; 1414 lldb::ExpressionResults results = 1415 exe_ctx.GetThreadRef().GetProcess()->RunThreadPlan( 1416 exe_ctx, call_static_initializer, options, execution_errors); 1417 1418 if (results != lldb::eExpressionCompleted) { 1419 err.SetErrorStringWithFormat("couldn't run static initializer: %s", 1420 execution_errors.GetString().c_str()); 1421 return err; 1422 } 1423 } 1424 1425 return err; 1426 } 1427