lldb.llvm.orgLLDB - A Powerful Debugger

Contents Menu Expand Light mode Dark mode Auto light/dark mode Hide navigation sidebar Hide table of contents sidebar Toggle site navigation sidebar Toggle Light / Dark / Auto color theme Toggle table of contents sidebar Using LLDB Tutorial GDB to LLDB command map Frame and Thread Format Variable Formatting Symbolication Symbols on macOS Remote Debugging Testing LLDB using QEMU Tracing with Intel Processor Trace On Demand Symbols Using LLDB On AArch64 Linux Troubleshooting Links Man Page Scripting LLDB Python Scripting Python Reference Python API Toggle navigation of Python API SBBreakpoint_EventIsBreakpointEvent SBBreakpoint_GetBreakpointEventTypeFromEvent SBBreakpoint_GetBreakpointFromEvent SBBreakpoint_GetBreakpointLocationAtIndexFromEvent SBBreakpoint_GetNumBreakpointLocationsFromEvent SBCommandInterpreter_EventIsCommandInterpreterEvent SBCommandInterpreter_GetArgumentDescriptionAsCString SBCommandInterpreter_GetArgumentTypeAsCString SBCommandInterpreter_GetBroadcasterClass SBCommunication_GetBroadcasterClass SBData_CreateDataFromCString SBData_CreateDataFromDoubleArray SBData_CreateDataFromSInt32Array SBData_CreateDataFromSInt64Array SBData_CreateDataFromUInt32Array SBData_CreateDataFromUInt64Array SBDebugger_Create SBDebugger_Destroy SBDebugger_FindDebuggerWithID SBDebugger_GetBroadcasterClass SBDebugger_GetBuildConfiguration SBDebugger_GetDefaultArchitecture SBDebugger_GetDiagnosticFromEvent SBDebugger_GetInternalVariableValue SBDebugger_GetProgressDataFromEvent SBDebugger_GetProgressFromEvent SBDebugger_GetVersionString SBDebugger_Initialize SBDebugger_InitializeWithErrorHandling SBDebugger_MemoryPressureDetected SBDebugger_PrintDiagnosticsOnError SBDebugger_PrintStackTraceOnError SBDebugger_SetDefaultArchitecture SBDebugger_SetInternalVariable SBDebugger_StateAsCString SBDebugger_StateIsRunningState SBDebugger_StateIsStoppedState SBDebugger_Terminate SBEvent_GetCStringFromEvent SBFileSpec_ResolvePath SBFile_MakeBorrowed SBFile_MakeBorrowedForcingIOMethods SBFile_MakeForcingIOMethods SBHostOS_GetLLDBPath SBHostOS_GetLLDBPythonPath SBHostOS_GetProgramFileSpec SBHostOS_GetUserHomeDirectory SBHostOS_ThreadCancel SBHostOS_ThreadCreate SBHostOS_ThreadCreated SBHostOS_ThreadDetach SBHostOS_ThreadJoin SBLanguageRuntime_GetLanguageTypeFromString SBLanguageRuntime_GetNameForLanguageType SBModuleSpecList_GetModuleSpecifications SBModule_GarbageCollectAllocatedModules SBModule_GetNumberAllocatedModules SBPlatform_GetHostPlatform SBProcess_EventIsProcessEvent SBProcess_EventIsStructuredDataEvent SBProcess_GetBroadcasterClass SBProcess_GetBroadcasterClassName SBProcess_GetInterruptedFromEvent SBProcess_GetNumRestartedReasonsFromEvent SBProcess_GetProcessFromEvent SBProcess_GetRestartedFromEvent SBProcess_GetRestartedReasonAtIndexFromEvent SBProcess_GetStateFromEvent SBProcess_GetStructuredDataFromEvent SBReproducer_Capture SBReproducer_PassiveReplay SBReproducer_SetAutoGenerate SBReproducer_SetWorkingDirectory SBTarget_EventIsTargetEvent SBTarget_GetBroadcasterClassName SBTarget_GetModuleAtIndexFromEvent SBTarget_GetNumModulesFromEvent SBTarget_GetTargetFromEvent SBThread_EventIsThreadEvent SBThread_GetBroadcasterClassName SBThread_GetStackFrameFromEvent SBThread_GetThreadFromEvent SBTrace_LoadTraceFromFile SBTypeSummary_CreateWithFunctionName SBTypeSummary_CreateWithScriptCode SBTypeSummary_CreateWithSummaryString SBTypeSynthetic_CreateWithClassName SBTypeSynthetic_CreateWithScriptCode SBWatchpoint_EventIsWatchpointEvent SBWatchpoint_GetWatchpointEventTypeFromEvent SBWatchpoint_GetWatchpointFromEvent SBAddress SBAttachInfo SBBlock SBBreakpoint SBBreakpointList SBBreakpointLocation SBBreakpointName SBBroadcaster SBCommandInterpreter SBCommandInterpreterRunOptions SBCommandReturnObject SBCommunication SBCompileUnit SBData SBDebugger SBDeclaration SBEnvironment SBError SBEvent SBExecutionContext SBExpressionOptions SBFile SBFileSpec SBFileSpecList SBFormat SBFrame SBFunction SBHostOS SBInstruction SBInstructionList SBLanguageRuntime SBLaunchInfo SBLineEntry SBListener SBMemoryRegionInfo SBMemoryRegionInfoList SBModule SBModuleSpec SBModuleSpecList SBPlatform SBPlatformConnectOptions SBPlatformShellCommand SBProcess SBProcessInfo SBProcessInfoList SBQueue SBQueueItem SBReproducer SBScriptObject SBSection SBSourceManager SBStatisticsOptions SBStream SBStringList SBStructuredData SBSymbol SBSymbolContext SBSymbolContextList SBSyntheticValueProvider SBTarget SBThread SBThreadCollection SBThreadPlan SBTrace SBTraceCursor SBType SBTypeCategory SBTypeEnumMember SBTypeEnumMemberList SBTypeFilter SBTypeFormat SBTypeList SBTypeMember SBTypeMemberFunction SBTypeNameSpecifier SBTypeStaticField SBTypeSummary SBTypeSummaryOptions SBTypeSynthetic SBUnixSignals SBValue SBValueList SBVariablesOptions SBWatchpoint SBWatchpointOptions value value_iter Developing LLDB Overview Contributing Building Testing Debugging Fuzzing Scripting Bridge API Data Formatters DWARF Extensions GDB Remote Protocol Extensions LLDB Platform Packets Caveats Open Projects Public C++ API Private C++ API External Links Source Code Releases Discussion Forums Developer Policy Bug Reports Code ReviewsToggle Light / Dark / Auto color theme Toggle table of contents sidebar The LLDB Debugger # Welcome to the LLDB documentation! LLDB is a next generation, high-performance debugger. It is built as a set of reusable components which highly leverage existing libraries in the larger LLVM Project , such as the Clang expression parser and LLVM disassembler. LLDB is the default debugger in Xcode on macOS and supports debugging C, Objective-C and C++ on the desktop and iOS devices and simulator. All of the code in the LLDB project is available under the Apache 2.0 License with LLVM exceptions” . Using LLDB # For an introduction into the LLDB command language, head over to the LLDB Tutorial . For users already familiar with GDB there is a cheat sheet listing common tasks and their LLDB equivalent in the GDB to LLDB command map . There are also multiple resources on how to script LLDB using Python: the Python Reference is a great starting point for that. Compiler Integration Benefits # LLDB converts debug information into Clang types so that it can leverage the Clang compiler infrastructure. This allows LLDB to support the latest C, C++, Objective-C and Objective-C++ language features and runtimes in expressions without having to reimplement any of this functionality. It also leverages the compiler to take care of all ABI details when making functions calls for expressions, when disassembling instructions and extracting instruction details, and much more. The major benefits include: Up to date language support for C, C++, Objective-C Multi-line expressions that can declare local variables and types Utilize the JIT for expressions when supported Evaluate expression Intermediate Representation (IR) when JIT can’t be used Reusability # The LLDB debugger APIs are exposed as a C++ object oriented interface in a shared library. The lldb command line tool links to, and uses this public API. On macOS the shared library is exposed as a framework named LLDB.framework, and Unix systems expose it as lldb.so. The entire API is also then exposed through Python script bindings which allow the API to be used within the LLDB embedded script interpreter, and also in any python script that loads the lldb.py module in standard python script files. See the Python Reference page for more details on how and where Python can be used with the LLDB API. Sharing the LLDB API allows LLDB to not only be used for debugging, but also for symbolication, disassembly, object and symbol file introspection, and much more. Platform Support # LLDB is known to work on the following platforms, but ports to new platforms are welcome: macOS debugging for i386, x86_64 and AArch64 iOS, tvOS, and watchOS simulator debugging on i386, x86_64 and AArch64 iOS, tvOS, and watchOS device debugging on ARM and AArch64 Linux user-space debugging for i386, x86_64,...