include/lldb/lldb-private-interfaces.h

0001 //===-- lldb-private-interfaces.h -------------------------------*- C++ -*-===//
0002 //
0003 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
0004 // See https://llvm.org/LICENSE.txt for license information.
0005 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
0006 //
0007 //===----------------------------------------------------------------------===//
0008
0009 #ifndef LLDB_LLDB_PRIVATE_INTERFACES_H
0010 #define LLDB_LLDB_PRIVATE_INTERFACES_H
0011
0012 #include "lldb/lldb-enumerations.h"
0013 #include "lldb/lldb-forward.h"
0014 #include "lldb/lldb-private-enumerations.h"
0015 #include "lldb/lldb-types.h"
0016 #include <memory>
0017 #include <set>
0018
0019 namespace llvm {
0020 namespace json {
0021 class Object;
0022 class Value;
0023 }
0024 } // namespace llvm
0025
0026 namespace lldb_private {
0027 class ScriptedInterfaceUsages;
0028 typedef lldb::ABISP (*ABICreateInstance)(lldb::ProcessSP process_sp,
0029                                          const ArchSpec &arch);
0030 typedef std::unique_ptr<Architecture> (*ArchitectureCreateInstance)(
0031     const ArchSpec &arch);
0032 typedef lldb::DisassemblerSP (*DisassemblerCreateInstance)(
0033     const ArchSpec &arch, const char *flavor, const char *cpu,
0034     const char *features);
0035 typedef DynamicLoader *(*DynamicLoaderCreateInstance)(Process *process,
0036                                                       bool force);
0037 typedef lldb::JITLoaderSP (*JITLoaderCreateInstance)(Process *process,
0038                                                      bool force);
0039 typedef ObjectContainer *(*ObjectContainerCreateInstance)(
0040     const lldb::ModuleSP &module_sp, lldb::DataBufferSP &data_sp,
0041     lldb::offset_t data_offset, const FileSpec *file, lldb::offset_t offset,
0042     lldb::offset_t length);
0043 typedef ObjectContainer *(*ObjectContainerCreateMemoryInstance)(
0044     const lldb::ModuleSP &module_sp, lldb::WritableDataBufferSP data_sp,
0045     const lldb::ProcessSP &process_sp, lldb::addr_t offset);
0046 typedef size_t (*ObjectFileGetModuleSpecifications)(
0047     const FileSpec &file, lldb::DataBufferSP &data_sp,
0048     lldb::offset_t data_offset, lldb::offset_t file_offset,
0049     lldb::offset_t length, ModuleSpecList &module_specs);
0050 typedef ObjectFile *(*ObjectFileCreateInstance)(const lldb::ModuleSP &module_sp,
0051                                                 lldb::DataBufferSP data_sp,
0052                                                 lldb::offset_t data_offset,
0053                                                 const FileSpec *file,
0054                                                 lldb::offset_t file_offset,
0055                                                 lldb::offset_t length);
0056 typedef ObjectFile *(*ObjectFileCreateMemoryInstance)(
0057     const lldb::ModuleSP &module_sp, lldb::WritableDataBufferSP data_sp,
0058     const lldb::ProcessSP &process_sp, lldb::addr_t offset);
0059 typedef bool (*ObjectFileSaveCore)(const lldb::ProcessSP &process_sp,
0060                                    lldb_private::SaveCoreOptions &options,
0061                                    Status &error);
0062 typedef EmulateInstruction *(*EmulateInstructionCreateInstance)(
0063     const ArchSpec &arch, InstructionType inst_type);
0064 typedef OperatingSystem *(*OperatingSystemCreateInstance)(Process *process,
0065                                                           bool force);
0066 typedef Language *(*LanguageCreateInstance)(lldb::LanguageType language);
0067 typedef LanguageRuntime *(*LanguageRuntimeCreateInstance)(
0068     Process *process, lldb::LanguageType language);
0069 typedef lldb::CommandObjectSP (*LanguageRuntimeGetCommandObject)(
0070     CommandInterpreter &interpreter);
0071 typedef lldb::BreakpointPreconditionSP (
0072     *LanguageRuntimeGetExceptionPrecondition)(lldb::LanguageType language,
0073                                               bool throw_bp);
0074 typedef lldb::StructuredDataPluginSP (*StructuredDataPluginCreateInstance)(
0075     Process &process);
0076 typedef Status (*StructuredDataFilterLaunchInfo)(ProcessLaunchInfo &launch_info,
0077                                                  Target *target);
0078 typedef SystemRuntime *(*SystemRuntimeCreateInstance)(Process *process);
0079 typedef lldb::PlatformSP (*PlatformCreateInstance)(bool force,
0080                                                    const ArchSpec *arch);
0081 typedef lldb::ProcessSP (*ProcessCreateInstance)(
0082     lldb::TargetSP target_sp, lldb::ListenerSP listener_sp,
0083     const FileSpec *crash_file_path, bool can_connect);
0084 typedef lldb::RegisterTypeBuilderSP (*RegisterTypeBuilderCreateInstance)(
0085     Target &target);
0086 typedef lldb::ScriptInterpreterSP (*ScriptInterpreterCreateInstance)(
0087     Debugger &debugger);
0088 typedef SymbolFile *(*SymbolFileCreateInstance)(lldb::ObjectFileSP objfile_sp);
0089 typedef SymbolVendor *(*SymbolVendorCreateInstance)(
0090     const lldb::ModuleSP &module_sp,
0091     lldb_private::Stream
0092         *feedback_strm); // Module can be NULL for default system symbol vendor
0093 typedef SymbolLocator *(*SymbolLocatorCreateInstance)();
0094 typedef std::optional<ModuleSpec> (*SymbolLocatorLocateExecutableObjectFile)(
0095     const ModuleSpec &module_spec);
0096 typedef std::optional<FileSpec> (*SymbolLocatorFindSymbolFileInBundle)(
0097     const FileSpec &dsym_bundle_fspec, const UUID *uuid, const ArchSpec *arch);
0098 typedef std::optional<FileSpec> (*SymbolLocatorLocateExecutableSymbolFile)(
0099     const ModuleSpec &module_spec, const FileSpecList &default_search_paths);
0100 typedef bool (*SymbolLocatorDownloadObjectAndSymbolFile)(
0101     ModuleSpec &module_spec, Status &error, bool force_lookup,
0102     bool copy_executable);
0103 using BreakpointHitCallback =
0104     std::function<bool(void *baton, StoppointCallbackContext *context,
0105                        lldb::user_id_t break_id, lldb::user_id_t break_loc_id)>;
0106
0107 typedef bool (*WatchpointHitCallback)(void *baton,
0108                                       StoppointCallbackContext *context,
0109                                       lldb::user_id_t watch_id);
0110 typedef bool (*ThreadPlanShouldStopHereCallback)(
0111     ThreadPlan *current_plan, Flags &flags, lldb::FrameComparison operation,
0112     Status &status, void *baton);
0113 typedef lldb::ThreadPlanSP (*ThreadPlanStepFromHereCallback)(
0114     ThreadPlan *current_plan, Flags &flags, lldb::FrameComparison operation,
0115     Status &status, void *baton);
0116 typedef UnwindAssembly *(*UnwindAssemblyCreateInstance)(const ArchSpec &arch);
0117 typedef lldb::MemoryHistorySP (*MemoryHistoryCreateInstance)(
0118     const lldb::ProcessSP &process_sp);
0119 typedef lldb::InstrumentationRuntimeType (*InstrumentationRuntimeGetType)();
0120 typedef lldb::InstrumentationRuntimeSP (*InstrumentationRuntimeCreateInstance)(
0121     const lldb::ProcessSP &process_sp);
0122 typedef lldb::TypeSystemSP (*TypeSystemCreateInstance)(
0123     lldb::LanguageType language, Module *module, Target *target);
0124 typedef lldb::REPLSP (*REPLCreateInstance)(Status &error,
0125                                            lldb::LanguageType language,
0126                                            Debugger *debugger, Target *target,
0127                                            const char *repl_options);
0128 typedef bool (*ScriptedInterfaceCreateInstance)(lldb::ScriptLanguage language,
0129                                                 ScriptedInterfaceUsages usages);
0130 typedef int (*ComparisonFunction)(const void *, const void *);
0131 typedef void (*DebuggerInitializeCallback)(Debugger &debugger);
0132 /// Trace
0133 /// \{
0134 typedef llvm::Expected<lldb::TraceSP> (*TraceCreateInstanceFromBundle)(
0135     const llvm::json::Value &trace_bundle_description,
0136     llvm::StringRef session_file_dir, lldb_private::Debugger &debugger);
0137 typedef llvm::Expected<lldb::TraceSP> (*TraceCreateInstanceForLiveProcess)(
0138     Process &process);
0139 typedef llvm::Expected<lldb::TraceExporterUP> (*TraceExporterCreateInstance)();
0140 typedef lldb::CommandObjectSP (*ThreadTraceExportCommandCreator)(
0141     CommandInterpreter &interpreter);
0142 /// \}
0143 } // namespace lldb_private
0144
0145 #endif // LLDB_LLDB_PRIVATE_INTERFACES_H