Coverage Report

Created: 2022-01-18 06:27

/Users/buildslave/jenkins/workspace/coverage/llvm-project/lldb/source/Plugins/ExpressionParser/Clang/ClangUserExpression.cpp
Line
Count
Source (jump to first uncovered line)
1
//===-- ClangUserExpression.cpp -------------------------------------------===//
2
//
3
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4
// See https://llvm.org/LICENSE.txt for license information.
5
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6
//
7
//===----------------------------------------------------------------------===//
8
9
#include <cstdio>
10
#include <sys/types.h>
11
12
#include <cstdlib>
13
#include <map>
14
#include <string>
15
16
#include "ClangUserExpression.h"
17
18
#include "ASTResultSynthesizer.h"
19
#include "ClangASTMetadata.h"
20
#include "ClangDiagnostic.h"
21
#include "ClangExpressionDeclMap.h"
22
#include "ClangExpressionParser.h"
23
#include "ClangModulesDeclVendor.h"
24
#include "ClangPersistentVariables.h"
25
#include "CppModuleConfiguration.h"
26
27
#include "Plugins/TypeSystem/Clang/TypeSystemClang.h"
28
#include "lldb/Core/Debugger.h"
29
#include "lldb/Core/Module.h"
30
#include "lldb/Core/StreamFile.h"
31
#include "lldb/Core/ValueObjectConstResult.h"
32
#include "lldb/Expression/ExpressionSourceCode.h"
33
#include "lldb/Expression/IRExecutionUnit.h"
34
#include "lldb/Expression/IRInterpreter.h"
35
#include "lldb/Expression/Materializer.h"
36
#include "lldb/Host/HostInfo.h"
37
#include "lldb/Symbol/Block.h"
38
#include "lldb/Symbol/CompileUnit.h"
39
#include "lldb/Symbol/Function.h"
40
#include "lldb/Symbol/ObjectFile.h"
41
#include "lldb/Symbol/SymbolFile.h"
42
#include "lldb/Symbol/SymbolVendor.h"
43
#include "lldb/Symbol/Type.h"
44
#include "lldb/Symbol/VariableList.h"
45
#include "lldb/Target/ExecutionContext.h"
46
#include "lldb/Target/Process.h"
47
#include "lldb/Target/StackFrame.h"
48
#include "lldb/Target/Target.h"
49
#include "lldb/Target/ThreadPlan.h"
50
#include "lldb/Target/ThreadPlanCallUserExpression.h"
51
#include "lldb/Utility/ConstString.h"
52
#include "lldb/Utility/Log.h"
53
#include "lldb/Utility/StreamString.h"
54
55
#include "clang/AST/DeclCXX.h"
56
#include "clang/AST/DeclObjC.h"
57
58
#include "llvm/ADT/ScopeExit.h"
59
60
using namespace lldb_private;
61
62
char ClangUserExpression::ID;
63
64
ClangUserExpression::ClangUserExpression(
65
    ExecutionContextScope &exe_scope, llvm::StringRef expr,
66
    llvm::StringRef prefix, lldb::LanguageType language,
67
    ResultType desired_type, const EvaluateExpressionOptions &options,
68
    ValueObject *ctx_obj)
69
    : LLVMUserExpression(exe_scope, expr, prefix, language, desired_type,
70
                         options),
71
      m_type_system_helper(*m_target_wp.lock(), options.GetExecutionPolicy() ==
72
                                                    eExecutionPolicyTopLevel),
73
9.35k
      m_result_delegate(exe_scope.CalculateTarget()), m_ctx_obj(ctx_obj) {
74
9.35k
  switch (m_language) {
75
56
  case lldb::eLanguageTypeC_plus_plus:
76
56
    m_allow_cxx = true;
77
56
    break;
78
659
  case lldb::eLanguageTypeObjC:
79
659
    m_allow_objc = true;
80
659
    break;
81
94
  case lldb::eLanguageTypeObjC_plus_plus:
82
8.63k
  default:
83
8.63k
    m_allow_cxx = true;
84
8.63k
    m_allow_objc = true;
85
8.63k
    break;
86
9.35k
  }
87
9.35k
}
88
89
9.35k
ClangUserExpression::~ClangUserExpression() = default;
90
91
9.35k
void ClangUserExpression::ScanContext(ExecutionContext &exe_ctx, Status &err) {
92
9.35k
  Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_EXPRESSIONS));
93
94
9.35k
  LLDB_LOGF(log, "ClangUserExpression::ScanContext()");
95
96
9.35k
  m_target = exe_ctx.GetTargetPtr();
97
98
9.35k
  if (!(m_allow_cxx || 
m_allow_objc659
)) {
99
0
    LLDB_LOGF(log, "  [CUE::SC] Settings inhibit C++ and Objective-C");
100
0
    return;
101
0
  }
102
103
9.35k
  StackFrame *frame = exe_ctx.GetFramePtr();
104
9.35k
  if (frame == nullptr) {
105
378
    LLDB_LOGF(log, "  [CUE::SC] Null stack frame");
106
378
    return;
107
378
  }
108
109
8.97k
  SymbolContext sym_ctx = frame->GetSymbolContext(lldb::eSymbolContextFunction |
110
8.97k
                                                  lldb::eSymbolContextBlock);
111
112
8.97k
  if (!sym_ctx.function) {
113
24
    LLDB_LOGF(log, "  [CUE::SC] Null function");
114
24
    return;
115
24
  }
116
117
  // Find the block that defines the function represented by "sym_ctx"
118
8.94k
  Block *function_block = sym_ctx.GetFunctionBlock();
119
120
8.94k
  if (!function_block) {
121
0
    LLDB_LOGF(log, "  [CUE::SC] Null function block");
122
0
    return;
123
0
  }
124
125
8.94k
  CompilerDeclContext decl_context = function_block->GetDeclContext();
126
127
8.94k
  if (!decl_context) {
128
0
    LLDB_LOGF(log, "  [CUE::SC] Null decl context");
129
0
    return;
130
0
  }
131
132
8.94k
  if (m_ctx_obj) {
133
39
    switch (m_ctx_obj->GetObjectRuntimeLanguage()) {
134
0
    case lldb::eLanguageTypeC:
135
0
    case lldb::eLanguageTypeC89:
136
0
    case lldb::eLanguageTypeC99:
137
0
    case lldb::eLanguageTypeC11:
138
24
    case lldb::eLanguageTypeC_plus_plus:
139
24
    case lldb::eLanguageTypeC_plus_plus_03:
140
24
    case lldb::eLanguageTypeC_plus_plus_11:
141
24
    case lldb::eLanguageTypeC_plus_plus_14:
142
24
      m_in_cplusplus_method = true;
143
24
      break;
144
15
    case lldb::eLanguageTypeObjC:
145
15
    case lldb::eLanguageTypeObjC_plus_plus:
146
15
      m_in_objectivec_method = true;
147
15
      break;
148
0
    default:
149
0
      break;
150
39
    }
151
39
    m_needs_object_ptr = true;
152
8.91k
  } else if (clang::CXXMethodDecl *method_decl =
153
8.91k
          TypeSystemClang::DeclContextGetAsCXXMethodDecl(decl_context)) {
154
116
    if (m_allow_cxx && method_decl->isInstance()) {
155
113
      if (m_enforce_valid_object) {
156
113
        lldb::VariableListSP variable_list_sp(
157
113
            function_block->GetBlockVariableList(true));
158
159
113
        const char *thisErrorString = "Stopped in a C++ method, but 'this' "
160
113
                                      "isn't available; pretending we are in a "
161
113
                                      "generic context";
162
163
113
        if (!variable_list_sp) {
164
0
          err.SetErrorString(thisErrorString);
165
0
          return;
166
0
        }
167
168
113
        lldb::VariableSP this_var_sp(
169
113
            variable_list_sp->FindVariable(ConstString("this")));
170
171
113
        if (!this_var_sp || !this_var_sp->IsInScope(frame) ||
172
113
            !this_var_sp->LocationIsValidForFrame(frame)) {
173
0
          err.SetErrorString(thisErrorString);
174
0
          return;
175
0
        }
176
113
      }
177
178
113
      m_in_cplusplus_method = true;
179
113
      m_needs_object_ptr = true;
180
113
    }
181
8.79k
  } else if (clang::ObjCMethodDecl *method_decl =
182
8.79k
                 TypeSystemClang::DeclContextGetAsObjCMethodDecl(
183
8.79k
                     decl_context)) {
184
95
    if (m_allow_objc) {
185
95
      if (m_enforce_valid_object) {
186
95
        lldb::VariableListSP variable_list_sp(
187
95
            function_block->GetBlockVariableList(true));
188
189
95
        const char *selfErrorString = "Stopped in an Objective-C method, but "
190
95
                                      "'self' isn't available; pretending we "
191
95
                                      "are in a generic context";
192
193
95
        if (!variable_list_sp) {
194
0
          err.SetErrorString(selfErrorString);
195
0
          return;
196
0
        }
197
198
95
        lldb::VariableSP self_variable_sp =
199
95
            variable_list_sp->FindVariable(ConstString("self"));
200
201
95
        if (!self_variable_sp || !self_variable_sp->IsInScope(frame) ||
202
95
            !self_variable_sp->LocationIsValidForFrame(frame)) {
203
0
          err.SetErrorString(selfErrorString);
204
0
          return;
205
0
        }
206
95
      }
207
208
95
      m_in_objectivec_method = true;
209
95
      m_needs_object_ptr = true;
210
211
95
      if (!method_decl->isInstanceMethod())
212
15
        m_in_static_method = true;
213
95
    }
214
8.69k
  } else if (clang::FunctionDecl *function_decl =
215
8.69k
                 TypeSystemClang::DeclContextGetAsFunctionDecl(decl_context)) {
216
    // We might also have a function that said in the debug information that it
217
    // captured an object pointer.  The best way to deal with getting to the
218
    // ivars at present is by pretending that this is a method of a class in
219
    // whatever runtime the debug info says the object pointer belongs to.  Do
220
    // that here.
221
222
8.69k
    ClangASTMetadata *metadata =
223
8.69k
        TypeSystemClang::DeclContextGetMetaData(decl_context, function_decl);
224
8.69k
    if (metadata && metadata->HasObjectPtr()) {
225
15
      lldb::LanguageType language = metadata->GetObjectPtrLanguage();
226
15
      if (language == lldb::eLanguageTypeC_plus_plus) {
227
6
        if (m_enforce_valid_object) {
228
6
          lldb::VariableListSP variable_list_sp(
229
6
              function_block->GetBlockVariableList(true));
230
231
6
          const char *thisErrorString = "Stopped in a context claiming to "
232
6
                                        "capture a C++ object pointer, but "
233
6
                                        "'this' isn't available; pretending we "
234
6
                                        "are in a generic context";
235
236
6
          if (!variable_list_sp) {
237
0
            err.SetErrorString(thisErrorString);
238
0
            return;
239
0
          }
240
241
6
          lldb::VariableSP this_var_sp(
242
6
              variable_list_sp->FindVariable(ConstString("this")));
243
244
6
          if (!this_var_sp || !this_var_sp->IsInScope(frame) ||
245
6
              !this_var_sp->LocationIsValidForFrame(frame)) {
246
0
            err.SetErrorString(thisErrorString);
247
0
            return;
248
0
          }
249
6
        }
250
251
6
        m_in_cplusplus_method = true;
252
6
        m_needs_object_ptr = true;
253
9
      } else if (language == lldb::eLanguageTypeObjC) {
254
9
        if (m_enforce_valid_object) {
255
9
          lldb::VariableListSP variable_list_sp(
256
9
              function_block->GetBlockVariableList(true));
257
258
9
          const char *selfErrorString =
259
9
              "Stopped in a context claiming to capture an Objective-C object "
260
9
              "pointer, but 'self' isn't available; pretending we are in a "
261
9
              "generic context";
262
263
9
          if (!variable_list_sp) {
264
0
            err.SetErrorString(selfErrorString);
265
0
            return;
266
0
          }
267
268
9
          lldb::VariableSP self_variable_sp =
269
9
              variable_list_sp->FindVariable(ConstString("self"));
270
271
9
          if (!self_variable_sp || !self_variable_sp->IsInScope(frame) ||
272
9
              !self_variable_sp->LocationIsValidForFrame(frame)) {
273
0
            err.SetErrorString(selfErrorString);
274
0
            return;
275
0
          }
276
277
9
          Type *self_type = self_variable_sp->GetType();
278
279
9
          if (!self_type) {
280
0
            err.SetErrorString(selfErrorString);
281
0
            return;
282
0
          }
283
284
9
          CompilerType self_clang_type = self_type->GetForwardCompilerType();
285
286
9
          if (!self_clang_type) {
287
0
            err.SetErrorString(selfErrorString);
288
0
            return;
289
0
          }
290
291
9
          if (TypeSystemClang::IsObjCClassType(self_clang_type)) {
292
3
            return;
293
6
          } else if (TypeSystemClang::IsObjCObjectPointerType(
294
6
                         self_clang_type)) {
295
6
            m_in_objectivec_method = true;
296
6
            m_needs_object_ptr = true;
297
6
          } else {
298
0
            err.SetErrorString(selfErrorString);
299
0
            return;
300
0
          }
301
9
        } else {
302
0
          m_in_objectivec_method = true;
303
0
          m_needs_object_ptr = true;
304
0
        }
305
9
      }
306
15
    }
307
8.69k
  }
308
8.94k
}
309
310
// This is a really nasty hack, meant to fix Objective-C expressions of the
311
// form (int)[myArray count].  Right now, because the type information for
312
// count is not available, [myArray count] returns id, which can't be directly
313
// cast to int without causing a clang error.
314
9.35k
static void ApplyObjcCastHack(std::string &expr) {
315
9.35k
  const std::string from = "(int)[";
316
9.35k
  const std::string to = "(int)(long long)[";
317
318
9.35k
  size_t offset;
319
320
9.38k
  while ((offset = expr.find(from)) != expr.npos)
321
33
    expr.replace(offset, from.size(), to);
322
9.35k
}
323
324
bool ClangUserExpression::SetupPersistentState(DiagnosticManager &diagnostic_manager,
325
9.35k
                                 ExecutionContext &exe_ctx) {
326
9.35k
  if (Target *target = exe_ctx.GetTargetPtr()) {
327
9.35k
    if (PersistentExpressionState *persistent_state =
328
9.35k
            target->GetPersistentExpressionStateForLanguage(
329
9.35k
                lldb::eLanguageTypeC)) {
330
9.35k
      m_clang_state = llvm::cast<ClangPersistentVariables>(persistent_state);
331
9.35k
      m_result_delegate.RegisterPersistentState(persistent_state);
332
9.35k
    } else {
333
0
      diagnostic_manager.PutString(
334
0
          eDiagnosticSeverityError,
335
0
          "couldn't start parsing (no persistent data)");
336
0
      return false;
337
0
    }
338
9.35k
  } else {
339
0
    diagnostic_manager.PutString(eDiagnosticSeverityError,
340
0
                                 "error: couldn't start parsing (no target)");
341
0
    return false;
342
0
  }
343
9.35k
  return true;
344
9.35k
}
345
346
static void SetupDeclVendor(ExecutionContext &exe_ctx, Target *target,
347
9.35k
                            DiagnosticManager &diagnostic_manager) {
348
9.35k
  if (!target->GetEnableAutoImportClangModules())
349
0
    return;
350
351
9.35k
  auto *persistent_state = llvm::cast<ClangPersistentVariables>(
352
9.35k
      target->GetPersistentExpressionStateForLanguage(lldb::eLanguageTypeC));
353
9.35k
  if (!persistent_state)
354
0
    return;
355
356
9.35k
  std::shared_ptr<ClangModulesDeclVendor> decl_vendor =
357
9.35k
      persistent_state->GetClangModulesDeclVendor();
358
9.35k
  if (!decl_vendor)
359
8
    return;
360
361
9.34k
  StackFrame *frame = exe_ctx.GetFramePtr();
362
9.34k
  if (!frame)
363
371
    return;
364
365
8.97k
  Block *block = frame->GetFrameBlock();
366
8.97k
  if (!block)
367
24
    return;
368
8.94k
  SymbolContext sc;
369
370
8.94k
  block->CalculateSymbolContext(&sc);
371
372
8.94k
  if (!sc.comp_unit)
373
0
    return;
374
8.94k
  StreamString error_stream;
375
376
8.94k
  ClangModulesDeclVendor::ModuleVector modules_for_macros =
377
8.94k
      persistent_state->GetHandLoadedClangModules();
378
8.94k
  if (decl_vendor->AddModulesForCompileUnit(*sc.comp_unit, modules_for_macros,
379
8.94k
                                            error_stream))
380
6.91k
    return;
381
382
  // Failed to load some modules, so emit the error stream as a diagnostic.
383
2.03k
  if (!error_stream.Empty()) {
384
    // The error stream already contains several Clang diagnostics that might
385
    // be either errors or warnings, so just print them all as one remark
386
    // diagnostic to prevent that the message starts with "error: error:".
387
2.03k
    diagnostic_manager.PutString(eDiagnosticSeverityRemark,
388
2.03k
                                 error_stream.GetString());
389
2.03k
    return;
390
2.03k
  }
391
392
0
  diagnostic_manager.PutString(eDiagnosticSeverityError,
393
0
                               "Unknown error while loading modules needed for "
394
0
                               "current compilation unit.");
395
0
}
396
397
9.27k
ClangExpressionSourceCode::WrapKind ClangUserExpression::GetWrapKind() const {
398
9.27k
  assert(m_options.GetExecutionPolicy() != eExecutionPolicyTopLevel &&
399
9.27k
         "Top level expressions aren't wrapped.");
400
0
  using Kind = ClangExpressionSourceCode::WrapKind;
401
9.27k
  if (m_in_cplusplus_method)
402
143
    return Kind::CppMemberFunction;
403
9.13k
  else if (m_in_objectivec_method) {
404
116
    if (m_in_static_method)
405
15
      return Kind::ObjCStaticMethod;
406
101
    return Kind::ObjCInstanceMethod;
407
116
  }
408
  // Not in any kind of 'special' function, so just wrap it in a normal C
409
  // function.
410
9.01k
  return Kind::Function;
411
9.27k
}
412
413
void ClangUserExpression::CreateSourceCode(
414
    DiagnosticManager &diagnostic_manager, ExecutionContext &exe_ctx,
415
9.36k
    std::vector<std::string> modules_to_import, bool for_completion) {
416
417
9.36k
  std::string prefix = m_expr_prefix;
418
419
9.36k
  if (m_options.GetExecutionPolicy() == eExecutionPolicyTopLevel) {
420
91
    m_transformed_text = m_expr_text;
421
9.27k
  } else {
422
9.27k
    m_source_code.reset(ClangExpressionSourceCode::CreateWrapped(
423
9.27k
        m_filename, prefix, m_expr_text, GetWrapKind()));
424
425
9.27k
    if (!m_source_code->GetText(m_transformed_text, exe_ctx, !m_ctx_obj,
426
9.27k
                                for_completion, modules_to_import)) {
427
0
      diagnostic_manager.PutString(eDiagnosticSeverityError,
428
0
                                   "couldn't construct expression body");
429
0
      return;
430
0
    }
431
432
    // Find and store the start position of the original code inside the
433
    // transformed code. We need this later for the code completion.
434
9.27k
    std::size_t original_start;
435
9.27k
    std::size_t original_end;
436
9.27k
    bool found_bounds = m_source_code->GetOriginalBodyBounds(
437
9.27k
        m_transformed_text, original_start, original_end);
438
9.27k
    if (found_bounds)
439
9.27k
      m_user_expression_start_pos = original_start;
440
9.27k
  }
441
9.36k
}
442
443
825
static bool SupportsCxxModuleImport(lldb::LanguageType language) {
444
825
  switch (language) {
445
0
  case lldb::eLanguageTypeC_plus_plus:
446
0
  case lldb::eLanguageTypeC_plus_plus_03:
447
813
  case lldb::eLanguageTypeC_plus_plus_11:
448
813
  case lldb::eLanguageTypeC_plus_plus_14:
449
813
  case lldb::eLanguageTypeObjC_plus_plus:
450
813
    return true;
451
12
  default:
452
12
    return false;
453
825
  }
454
825
}
455
456
/// Utility method that puts a message into the expression log and
457
/// returns an invalid module configuration.
458
12
static CppModuleConfiguration LogConfigError(const std::string &msg) {
459
12
  Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_EXPRESSIONS));
460
12
  LLDB_LOG(log, "[C++ module config] {0}", msg);
461
12
  return CppModuleConfiguration();
462
12
}
463
464
CppModuleConfiguration GetModuleConfig(lldb::LanguageType language,
465
825
                                       ExecutionContext &exe_ctx) {
466
825
  Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_EXPRESSIONS));
467
468
  // Don't do anything if this is not a C++ module configuration.
469
825
  if (!SupportsCxxModuleImport(language))
470
12
    return LogConfigError("Language doesn't support C++ modules");
471
472
813
  Target *target = exe_ctx.GetTargetPtr();
473
813
  if (!target)
474
0
    return LogConfigError("No target");
475
476
813
  StackFrame *frame = exe_ctx.GetFramePtr();
477
813
  if (!frame)
478
0
    return LogConfigError("No frame");
479
480
813
  Block *block = frame->GetFrameBlock();
481
813
  if (!block)
482
0
    return LogConfigError("No block");
483
484
813
  SymbolContext sc;
485
813
  block->CalculateSymbolContext(&sc);
486
813
  if (!sc.comp_unit)
487
0
    return LogConfigError("Couldn't calculate symbol context");
488
489
  // Build a list of files we need to analyze to build the configuration.
490
813
  FileSpecList files;
491
813
  for (const FileSpec &f : sc.comp_unit->GetSupportFiles())
492
33.2k
    files.AppendIfUnique(f);
493
  // We also need to look at external modules in the case of -gmodules as they
494
  // contain the support files for libc++ and the C library.
495
813
  llvm::DenseSet<SymbolFile *> visited_symbol_files;
496
813
  sc.comp_unit->ForEachExternalModule(
497
1.54k
      visited_symbol_files, [&files](Module &module) {
498
4.37k
        for (std::size_t i = 0; i < module.GetNumCompileUnits(); 
++i2.82k
) {
499
2.82k
          const FileSpecList &support_files =
500
2.82k
              module.GetCompileUnitAtIndex(i)->GetSupportFiles();
501
253k
          for (const FileSpec &f : support_files) {
502
253k
            files.AppendIfUnique(f);
503
253k
          }
504
2.82k
        }
505
1.54k
        return false;
506
1.54k
      });
507
508
813
  LLDB_LOG(log, "[C++ module config] Found {0} support files to analyze",
509
813
           files.GetSize());
510
813
  if (log && 
log->GetVerbose()0
) {
511
0
    for (const FileSpec &f : files)
512
0
      LLDB_LOGV(log, "[C++ module config] Analyzing support file: {0}",
513
0
                f.GetPath());
514
0
  }
515
516
  // Try to create a configuration from the files. If there is no valid
517
  // configuration possible with the files, this just returns an invalid
518
  // configuration.
519
813
  return CppModuleConfiguration(files, target->GetArchitecture().GetTriple());
520
813
}
521
522
bool ClangUserExpression::PrepareForParsing(
523
    DiagnosticManager &diagnostic_manager, ExecutionContext &exe_ctx,
524
9.35k
    bool for_completion) {
525
9.35k
  InstallContext(exe_ctx);
526
527
9.35k
  if (!SetupPersistentState(diagnostic_manager, exe_ctx))
528
0
    return false;
529
530
9.35k
  Status err;
531
9.35k
  ScanContext(exe_ctx, err);
532
533
9.35k
  if (!err.Success()) {
534
0
    diagnostic_manager.PutString(eDiagnosticSeverityWarning, err.AsCString());
535
0
  }
536
537
  ////////////////////////////////////
538
  // Generate the expression
539
  //
540
541
9.35k
  ApplyObjcCastHack(m_expr_text);
542
543
9.35k
  SetupDeclVendor(exe_ctx, m_target, diagnostic_manager);
544
545
9.35k
  m_filename = m_clang_state->GetNextExprFileName();
546
547
9.35k
  if (m_target->GetImportStdModule() == eImportStdModuleTrue)
548
804
    SetupCppModuleImports(exe_ctx);
549
550
9.35k
  CreateSourceCode(diagnostic_manager, exe_ctx, m_imported_cpp_modules,
551
9.35k
                   for_completion);
552
9.35k
  return true;
553
9.35k
}
554
555
bool ClangUserExpression::TryParse(
556
    DiagnosticManager &diagnostic_manager, ExecutionContextScope *exe_scope,
557
    ExecutionContext &exe_ctx, lldb_private::ExecutionPolicy execution_policy,
558
9.29k
    bool keep_result_in_memory, bool generate_debug_info) {
559
9.29k
  m_materializer_up = std::make_unique<Materializer>();
560
561
9.29k
  ResetDeclMap(exe_ctx, m_result_delegate, keep_result_in_memory);
562
563
9.29k
  auto on_exit = llvm::make_scope_exit([this]() { ResetDeclMap(); });
564
565
9.29k
  if (!DeclMap()->WillParse(exe_ctx, GetMaterializer())) {
566
0
    diagnostic_manager.PutString(
567
0
        eDiagnosticSeverityError,
568
0
        "current process state is unsuitable for expression parsing");
569
0
    return false;
570
0
  }
571
572
9.29k
  if (m_options.GetExecutionPolicy() == eExecutionPolicyTopLevel) {
573
91
    DeclMap()->SetLookupsEnabled(true);
574
91
  }
575
576
9.29k
  m_parser = std::make_unique<ClangExpressionParser>(
577
9.29k
      exe_scope, *this, generate_debug_info, m_include_directories, m_filename);
578
579
9.29k
  unsigned num_errors = m_parser->Parse(diagnostic_manager);
580
581
  // Check here for FixItHints.  If there are any try to apply the fixits and
582
  // set the fixed text in m_fixed_text before returning an error.
583
9.29k
  if (num_errors) {
584
294
    if (diagnostic_manager.HasFixIts()) {
585
36
      if (m_parser->RewriteExpression(diagnostic_manager)) {
586
36
        size_t fixed_start;
587
36
        size_t fixed_end;
588
36
        m_fixed_text = diagnostic_manager.GetFixedExpression();
589
        // Retrieve the original expression in case we don't have a top level
590
        // expression (which has no surrounding source code).
591
36
        if (m_source_code && m_source_code->GetOriginalBodyBounds(
592
18
                                 m_fixed_text, fixed_start, fixed_end))
593
18
          m_fixed_text =
594
18
              m_fixed_text.substr(fixed_start, fixed_end - fixed_start);
595
36
      }
596
36
    }
597
294
    return false;
598
294
  }
599
600
  //////////////////////////////////////////////////////////////////////////////
601
  // Prepare the output of the parser for execution, evaluating it statically
602
  // if possible
603
  //
604
605
8.99k
  {
606
8.99k
    Status jit_error = m_parser->PrepareForExecution(
607
8.99k
        m_jit_start_addr, m_jit_end_addr, m_execution_unit_sp, exe_ctx,
608
8.99k
        m_can_interpret, execution_policy);
609
610
8.99k
    if (!jit_error.Success()) {
611
49
      const char *error_cstr = jit_error.AsCString();
612
49
      if (error_cstr && error_cstr[0])
613
49
        diagnostic_manager.PutString(eDiagnosticSeverityError, error_cstr);
614
0
      else
615
0
        diagnostic_manager.PutString(eDiagnosticSeverityError,
616
0
                                     "expression can't be interpreted or run");
617
49
      return false;
618
49
    }
619
8.99k
  }
620
8.94k
  return true;
621
8.99k
}
622
623
825
void ClangUserExpression::SetupCppModuleImports(ExecutionContext &exe_ctx) {
624
825
  Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_EXPRESSIONS));
625
626
825
  CppModuleConfiguration module_config = GetModuleConfig(m_language, exe_ctx);
627
825
  m_imported_cpp_modules = module_config.GetImportedModules();
628
825
  m_include_directories = module_config.GetIncludeDirs();
629
630
825
  LLDB_LOG(log, "List of imported modules in expression: {0}",
631
825
           llvm::make_range(m_imported_cpp_modules.begin(),
632
825
                            m_imported_cpp_modules.end()));
633
825
  LLDB_LOG(log, "List of include directories gathered for modules: {0}",
634
825
           llvm::make_range(m_include_directories.begin(),
635
825
                            m_include_directories.end()));
636
825
}
637
638
334
static bool shouldRetryWithCppModule(Target &target, ExecutionPolicy exe_policy) {
639
  // Top-level expression don't yet support importing C++ modules.
640
334
  if (exe_policy == ExecutionPolicy::eExecutionPolicyTopLevel)
641
52
    return false;
642
282
  return target.GetImportStdModule() == eImportStdModuleFallback;
643
334
}
644
645
bool ClangUserExpression::Parse(DiagnosticManager &diagnostic_manager,
646
                                ExecutionContext &exe_ctx,
647
                                lldb_private::ExecutionPolicy execution_policy,
648
                                bool keep_result_in_memory,
649
9.27k
                                bool generate_debug_info) {
650
9.27k
  Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_EXPRESSIONS));
651
652
9.27k
  if (!PrepareForParsing(diagnostic_manager, exe_ctx, /*for_completion*/ false))
653
0
    return false;
654
655
9.27k
  LLDB_LOGF(log, "Parsing the following code:\n%s", m_transformed_text.c_str());
656
657
  ////////////////////////////////////
658
  // Set up the target and compiler
659
  //
660
661
9.27k
  Target *target = exe_ctx.GetTargetPtr();
662
663
9.27k
  if (!target) {
664
0
    diagnostic_manager.PutString(eDiagnosticSeverityError, "invalid target");
665
0
    return false;
666
0
  }
667
668
  //////////////////////////
669
  // Parse the expression
670
  //
671
672
9.27k
  Process *process = exe_ctx.GetProcessPtr();
673
9.27k
  ExecutionContextScope *exe_scope = process;
674
675
9.27k
  if (!exe_scope)
676
364
    exe_scope = exe_ctx.GetTargetPtr();
677
678
9.27k
  bool parse_success = TryParse(diagnostic_manager, exe_scope, exe_ctx,
679
9.27k
                                execution_policy, keep_result_in_memory,
680
9.27k
                                generate_debug_info);
681
  // If the expression failed to parse, check if retrying parsing with a loaded
682
  // C++ module is possible.
683
9.27k
  if (!parse_success && 
shouldRetryWithCppModule(*target, execution_policy)334
) {
684
    // Load the loaded C++ modules.
685
21
    SetupCppModuleImports(exe_ctx);
686
    // If we did load any modules, then retry parsing.
687
21
    if (!m_imported_cpp_modules.empty()) {
688
      // Create a dedicated diagnostic manager for the second parse attempt.
689
      // These diagnostics are only returned to the caller if using the fallback
690
      // actually succeeded in getting the expression to parse. This prevents
691
      // that module-specific issues regress diagnostic quality with the
692
      // fallback mode.
693
15
      DiagnosticManager retry_manager;
694
      // The module imports are injected into the source code wrapper,
695
      // so recreate those.
696
15
      CreateSourceCode(retry_manager, exe_ctx, m_imported_cpp_modules,
697
15
                       /*for_completion*/ false);
698
15
      parse_success = TryParse(retry_manager, exe_scope, exe_ctx,
699
15
                               execution_policy, keep_result_in_memory,
700
15
                               generate_debug_info);
701
      // Return the parse diagnostics if we were successful.
702
15
      if (parse_success)
703
6
        diagnostic_manager = std::move(retry_manager);
704
15
    }
705
21
  }
706
9.27k
  if (!parse_success)
707
328
    return false;
708
709
8.94k
  if (exe_ctx.GetProcessPtr() && 
execution_policy == eExecutionPolicyTopLevel8.61k
) {
710
39
    Status static_init_error =
711
39
        m_parser->RunStaticInitializers(m_execution_unit_sp, exe_ctx);
712
713
39
    if (!static_init_error.Success()) {
714
3
      const char *error_cstr = static_init_error.AsCString();
715
3
      if (error_cstr && error_cstr[0])
716
3
        diagnostic_manager.Printf(eDiagnosticSeverityError,
717
3
                                  "%s\n",
718
3
                                  error_cstr);
719
0
      else
720
0
        diagnostic_manager.PutString(eDiagnosticSeverityError,
721
0
                                     "couldn't run static initializers\n");
722
3
      return false;
723
3
    }
724
39
  }
725
726
8.94k
  if (m_execution_unit_sp) {
727
8.94k
    bool register_execution_unit = false;
728
729
8.94k
    if (m_options.GetExecutionPolicy() == eExecutionPolicyTopLevel) {
730
36
      register_execution_unit = true;
731
36
    }
732
733
    // If there is more than one external function in the execution unit, it
734
    // needs to keep living even if it's not top level, because the result
735
    // could refer to that function.
736
737
8.94k
    if (m_execution_unit_sp->GetJittedFunctions().size() > 1) {
738
686
      register_execution_unit = true;
739
686
    }
740
741
8.94k
    if (register_execution_unit) {
742
711
      if (auto *persistent_state =
743
711
              exe_ctx.GetTargetPtr()->GetPersistentExpressionStateForLanguage(
744
711
                  m_language))
745
711
        persistent_state->RegisterExecutionUnit(m_execution_unit_sp);
746
711
    }
747
8.94k
  }
748
749
8.94k
  if (generate_debug_info) {
750
3
    lldb::ModuleSP jit_module_sp(m_execution_unit_sp->GetJITModule());
751
752
3
    if (jit_module_sp) {
753
3
      ConstString const_func_name(FunctionName());
754
3
      FileSpec jit_file;
755
3
      jit_file.GetFilename() = const_func_name;
756
3
      jit_module_sp->SetFileSpecAndObjectName(jit_file, ConstString());
757
3
      m_jit_module_wp = jit_module_sp;
758
3
      target->GetImages().Append(jit_module_sp);
759
3
    }
760
3
  }
761
762
8.94k
  if (process && 
m_jit_start_addr != 8.60k
LLDB_INVALID_ADDRESS8.60k
)
763
1.85k
    m_jit_process_wp = lldb::ProcessWP(process->shared_from_this());
764
8.94k
  return true;
765
8.94k
}
766
767
/// Converts an absolute position inside a given code string into
768
/// a column/line pair.
769
///
770
/// \param[in] abs_pos
771
///     A absolute position in the code string that we want to convert
772
///     to a column/line pair.
773
///
774
/// \param[in] code
775
///     A multi-line string usually representing source code.
776
///
777
/// \param[out] line
778
///     The line in the code that contains the given absolute position.
779
///     The first line in the string is indexed as 1.
780
///
781
/// \param[out] column
782
///     The column in the line that contains the absolute position.
783
///     The first character in a line is indexed as 0.
784
static void AbsPosToLineColumnPos(size_t abs_pos, llvm::StringRef code,
785
74
                                  unsigned &line, unsigned &column) {
786
  // Reset to code position to beginning of the file.
787
74
  line = 0;
788
74
  column = 0;
789
790
74
  assert(abs_pos <= code.size() && "Absolute position outside code string?");
791
792
  // We have to walk up to the position and count lines/columns.
793
86.6k
  for (std::size_t i = 0; i < abs_pos; 
++i86.6k
) {
794
    // If we hit a line break, we go back to column 0 and enter a new line.
795
    // We only handle \n because that's what we internally use to make new
796
    // lines for our temporary code strings.
797
86.6k
    if (code[i] == '\n') {
798
3.80k
      ++line;
799
3.80k
      column = 0;
800
3.80k
      continue;
801
3.80k
    }
802
82.8k
    ++column;
803
82.8k
  }
804
74
}
805
806
bool ClangUserExpression::Complete(ExecutionContext &exe_ctx,
807
                                   CompletionRequest &request,
808
74
                                   unsigned complete_pos) {
809
74
  Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_EXPRESSIONS));
810
811
  // We don't want any visible feedback when completing an expression. Mostly
812
  // because the results we get from an incomplete invocation are probably not
813
  // correct.
814
74
  DiagnosticManager diagnostic_manager;
815
816
74
  if (!PrepareForParsing(diagnostic_manager, exe_ctx, /*for_completion*/ true))
817
0
    return false;
818
819
74
  LLDB_LOGF(log, "Parsing the following code:\n%s", m_transformed_text.c_str());
820
821
  //////////////////////////
822
  // Parse the expression
823
  //
824
825
74
  m_materializer_up = std::make_unique<Materializer>();
826
827
74
  ResetDeclMap(exe_ctx, m_result_delegate, /*keep result in memory*/ true);
828
829
74
  auto on_exit = llvm::make_scope_exit([this]() { ResetDeclMap(); });
830
831
74
  if (!DeclMap()->WillParse(exe_ctx, GetMaterializer())) {
832
0
    diagnostic_manager.PutString(
833
0
        eDiagnosticSeverityError,
834
0
        "current process state is unsuitable for expression parsing");
835
836
0
    return false;
837
0
  }
838
839
74
  if (m_options.GetExecutionPolicy() == eExecutionPolicyTopLevel) {
840
0
    DeclMap()->SetLookupsEnabled(true);
841
0
  }
842
843
74
  Process *process = exe_ctx.GetProcessPtr();
844
74
  ExecutionContextScope *exe_scope = process;
845
846
74
  if (!exe_scope)
847
0
    exe_scope = exe_ctx.GetTargetPtr();
848
849
74
  ClangExpressionParser parser(exe_scope, *this, false);
850
851
  // We have to find the source code location where the user text is inside
852
  // the transformed expression code. When creating the transformed text, we
853
  // already stored the absolute position in the m_transformed_text string. The
854
  // only thing left to do is to transform it into the line:column format that
855
  // Clang expects.
856
857
  // The line and column of the user expression inside the transformed source
858
  // code.
859
74
  unsigned user_expr_line, user_expr_column;
860
74
  if (m_user_expression_start_pos.hasValue())
861
74
    AbsPosToLineColumnPos(*m_user_expression_start_pos, m_transformed_text,
862
74
                          user_expr_line, user_expr_column);
863
0
  else
864
0
    return false;
865
866
  // The actual column where we have to complete is the start column of the
867
  // user expression + the offset inside the user code that we were given.
868
74
  const unsigned completion_column = user_expr_column + complete_pos;
869
74
  parser.Complete(request, user_expr_line, completion_column, complete_pos);
870
871
74
  return true;
872
74
}
873
874
bool ClangUserExpression::AddArguments(ExecutionContext &exe_ctx,
875
                                       std::vector<lldb::addr_t> &args,
876
                                       lldb::addr_t struct_address,
877
8.94k
                                       DiagnosticManager &diagnostic_manager) {
878
8.94k
  lldb::addr_t object_ptr = LLDB_INVALID_ADDRESS;
879
8.94k
  lldb::addr_t cmd_ptr = LLDB_INVALID_ADDRESS;
880
881
8.94k
  if (m_needs_object_ptr) {
882
232
    lldb::StackFrameSP frame_sp = exe_ctx.GetFrameSP();
883
232
    if (!frame_sp)
884
0
      return true;
885
886
232
    ConstString object_name;
887
888
232
    if (m_in_cplusplus_method) {
889
125
      object_name.SetCString("this");
890
125
    } else 
if (107
m_in_objectivec_method107
) {
891
107
      object_name.SetCString("self");
892
107
    } else {
893
0
      diagnostic_manager.PutString(
894
0
          eDiagnosticSeverityError,
895
0
          "need object pointer but don't know the language");
896
0
      return false;
897
0
    }
898
899
232
    Status object_ptr_error;
900
901
232
    if (m_ctx_obj) {
902
36
      AddressType address_type;
903
36
      object_ptr = m_ctx_obj->GetAddressOf(false, &address_type);
904
36
      if (object_ptr == LLDB_INVALID_ADDRESS ||
905
36
          address_type != eAddressTypeLoad)
906
0
        object_ptr_error.SetErrorString("Can't get context object's "
907
0
                                        "debuggee address");
908
36
    } else
909
196
      object_ptr = GetObjectPointer(frame_sp, object_name, object_ptr_error);
910
911
232
    if (!object_ptr_error.Success()) {
912
0
      exe_ctx.GetTargetRef().GetDebugger().GetAsyncOutputStream()->Printf(
913
0
          "warning: `%s' is not accessible (substituting 0). %s\n",
914
0
          object_name.AsCString(), object_ptr_error.AsCString());
915
0
      object_ptr = 0;
916
0
    }
917
918
232
    if (m_in_objectivec_method) {
919
107
      ConstString cmd_name("_cmd");
920
921
107
      cmd_ptr = GetObjectPointer(frame_sp, cmd_name, object_ptr_error);
922
923
107
      if (!object_ptr_error.Success()) {
924
21
        diagnostic_manager.Printf(
925
21
            eDiagnosticSeverityWarning,
926
21
            "couldn't get cmd pointer (substituting NULL): %s",
927
21
            object_ptr_error.AsCString());
928
21
        cmd_ptr = 0;
929
21
      }
930
107
    }
931
932
232
    args.push_back(object_ptr);
933
934
232
    if (m_in_objectivec_method)
935
107
      args.push_back(cmd_ptr);
936
937
232
    args.push_back(struct_address);
938
8.71k
  } else {
939
8.71k
    args.push_back(struct_address);
940
8.71k
  }
941
8.94k
  return true;
942
8.94k
}
943
944
lldb::ExpressionVariableSP ClangUserExpression::GetResultAfterDematerialization(
945
8.89k
    ExecutionContextScope *exe_scope) {
946
8.89k
  return m_result_delegate.GetVariable();
947
8.89k
}
948
949
void ClangUserExpression::ClangUserExpressionHelper::ResetDeclMap(
950
    ExecutionContext &exe_ctx,
951
    Materializer::PersistentVariableDelegate &delegate,
952
    bool keep_result_in_memory,
953
9.36k
    ValueObject *ctx_obj) {
954
9.36k
  std::shared_ptr<ClangASTImporter> ast_importer;
955
9.36k
  auto *state = exe_ctx.GetTargetSP()->GetPersistentExpressionStateForLanguage(
956
9.36k
      lldb::eLanguageTypeC);
957
9.36k
  if (state) {
958
9.36k
    auto *persistent_vars = llvm::cast<ClangPersistentVariables>(state);
959
9.36k
    ast_importer = persistent_vars->GetClangASTImporter();
960
9.36k
  }
961
9.36k
  m_expr_decl_map_up = std::make_unique<ClangExpressionDeclMap>(
962
9.36k
      keep_result_in_memory, &delegate, exe_ctx.GetTargetSP(), ast_importer,
963
9.36k
      ctx_obj);
964
9.36k
}
965
966
clang::ASTConsumer *
967
ClangUserExpression::ClangUserExpressionHelper::ASTTransformer(
968
9.36k
    clang::ASTConsumer *passthrough) {
969
9.36k
  m_result_synthesizer_up = std::make_unique<ASTResultSynthesizer>(
970
9.36k
      passthrough, m_top_level, m_target);
971
972
9.36k
  return m_result_synthesizer_up.get();
973
9.36k
}
974
975
9.07k
void ClangUserExpression::ClangUserExpressionHelper::CommitPersistentDecls() {
976
9.07k
  if (m_result_synthesizer_up) {
977
9.07k
    m_result_synthesizer_up->CommitPersistentDecls();
978
9.07k
  }
979
9.07k
}
980
981
8.73k
ConstString ClangUserExpression::ResultDelegate::GetName() {
982
8.73k
  return m_persistent_state->GetNextPersistentVariableName(false);
983
8.73k
}
984
985
void ClangUserExpression::ResultDelegate::DidDematerialize(
986
8.73k
    lldb::ExpressionVariableSP &variable) {
987
8.73k
  m_variable = variable;
988
8.73k
}
989
990
void ClangUserExpression::ResultDelegate::RegisterPersistentState(
991
9.35k
    PersistentExpressionState *persistent_state) {
992
9.35k
  m_persistent_state = persistent_state;
993
9.35k
}
994
995
8.89k
lldb::ExpressionVariableSP &ClangUserExpression::ResultDelegate::GetVariable() {
996
8.89k
  return m_variable;
997
8.89k
}