contrib/llvm-project/lldb/source/Plugins/ExpressionParser/Clang/ClangExpressionParser.cpp

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