1 //===-- IRInterpreter.h -----------------------------------------*- 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 #ifndef LLDB_EXPRESSION_IRINTERPRETER_H
10 #define LLDB_EXPRESSION_IRINTERPRETER_H
11 
12 #include "lldb/Utility/ConstString.h"
13 #include "lldb/Utility/Stream.h"
14 #include "lldb/Utility/Timeout.h"
15 #include "lldb/lldb-public.h"
16 #include "llvm/ADT/ArrayRef.h"
17 #include "llvm/Pass.h"
18 
19 namespace llvm {
20 class Function;
21 class Module;
22 }
23 
24 namespace lldb_private {
25 
26 class IRMemoryMap;
27 }
28 
29 /// \class IRInterpreter IRInterpreter.h "lldb/Expression/IRInterpreter.h"
30 /// Attempt to interpret the function's code if it does not require
31 ///        running the target.
32 ///
33 /// In some cases, the IR for an expression can be evaluated entirely in the
34 /// debugger, manipulating variables but not executing any code in the target.
35 /// The IRInterpreter attempts to do this.
36 class IRInterpreter {
37 public:
38   static bool CanInterpret(llvm::Module &module, llvm::Function &function,
39                            lldb_private::Status &error,
40                            const bool support_function_calls);
41 
42   static bool Interpret(llvm::Module &module, llvm::Function &function,
43                         llvm::ArrayRef<lldb::addr_t> args,
44                         lldb_private::IRExecutionUnit &execution_unit,
45                         lldb_private::Status &error,
46                         lldb::addr_t stack_frame_bottom,
47                         lldb::addr_t stack_frame_top,
48                         lldb_private::ExecutionContext &exe_ctx,
49                         lldb_private::Timeout<std::micro> timeout);
50 
51 private:
52   static bool supportsFunction(llvm::Function &llvm_function,
53                                lldb_private::Status &err);
54 };
55 
56 #endif
57