View source for Debugger Status

[[Category:Debugging]]
This is based on Lazarus 2.2.

==== Available Debuggers ====

{{Debugger_Backend_List}}

{{Note|
* For the [[GDB]] and [[LLDB]] based debugger, support is indicated based on the assumption that your version of GDB supports this. Support indication is generally based on current GDB/LLDB for mainstream OS.
* [[FpDebug]]ger currently only works for Windows and Linux (AVR support is in progress)
* The "LLDB Debugger (Alpha)" is not included below. It is a by-product of the "LLDB+FpDebug". It is not actively developed/maintained, other than what is needed for "LLDB+FpDebug".
}}

==== Availability (OS/Platform) ====
{| class="wikitable "
! OS/Platform
! GdbMi !! GdbMi+Ssh !! GdbServer !! GdbMi+FpDebug 
! Lldb+FpDebug 
! Fp-Debugger 
! Comments

|---- class="working" 
| style="text-align:left" | Linux
| Y || Y || Y || Y 
| class="partial" | Depends on availability<br/>of a stable LLDB
| Y <br> (Intel/AMD)
|
|---- class="working" 
| style="text-align:left" | Mac (Intel)
| class="partial" | Depends on availability<br/>of a stable<br/>and codesigned GDB || class="unknown" | ? || class="unknown" | ? || class="unknown" | ?
| Y 
| class="not" | N
|
|---- class="partial" 
| style="text-align:left" | Mac (M1)
| class="partial" | Depends on availability<br/>of a stable<br/>and codesigned GDB || class="unknown" | ? || class="unknown" | ? || class="unknown" | ?
| class="partial" | Beta <br/> Lazarus 2.2 and higher
| class="not" | N
| class="partial" | The "LLDB Debugger (Alpha)" (without FpDebug) can (be attempted to) be used. Features (such as watches) will be limited to "c style"
|---- class="working" 
| style="text-align:left" | Windows
| Y || Y || Y || Y 
| class="partial" | Depends on availability<br/>of a stable LLDB
| Y <br> (Intel/AMD) 
| class="partial" | For Windows 32 bit: FpDebug does not support SEH exceptions (used by default since FPC 3.2). Stepping over/after such exceptions may not work properly. 
|---- class="working" 
| style="text-align:left" class="partial" | AVR
| class="not" | N || class="not" | N || class="ok" | Y || class="not" | N 
| class="not" | N
| class="partial" | Beta <br/>(via a remote connection to a gdbserver stub)<br/>Package "LazDebuggerFpRspRemote"
| class="partial" | The features for AVR remote debugging (using FpDebug+gdbserver) may differ from the Fp-Debugger features listed below.
|}

==== Start/Stop ====
{| class="wikitable "
! Feature !! Key 
! GdbMi !! GdbMi+Ssh !! GdbServer !! GdbMi+FpDebug 
! Lldb+FpDebug 
! Fp-Debugger 
! Comments

|---- class="working" 
| style="text-align:left" | Run || {{keypress|F9}}
| Y || Y || Y || Y 
| Y 
| Y 
|
|---- class="working" 
| style="text-align:left" | Run to first line (Step) || {{keypress|F7}} / {{keypress|F8}}
| Y || Y || Y || Y 
| class="unknown" | ?
| class="not" | N 
| For GUI apps the first line is in the code generated by the IDE
|---- class="working"     
| style="text-align:left" | Run to line at cursor ||
| Y || Y || Y || Y 
| class="not" | N 
| Y 
| Lazarus 2.2 and higher

|---- class="working" 
| style="text-align:left" | Attach || 
| Y || Y || Y || Y 
| class="unknown" | ? 
| Lazarus 2.2 and higher 
|
|---- class="working" 
| style="text-align:left" | Detach ||
| Y || Y || Y || Y 
| class="unknown" | ?
| Lazarus 2.2 and higher 
|
|---- class="working" 
| style="text-align:left" | Stop || {{keypress|Ctrl}}+{{keypress|F2}}
| Y || Y || Y || Y 
| Y 
| Y 
|
|---- class="working" 
| style="text-align:left" | Reset Debugger || 
| Y || Y || Y || Y 
| Y 
| Y 
| Kill/Stop<br>Restart the external debugger (gdb/lldb)
|---- class="working" 
| style="text-align:left" | Debugger stopped dialog when app exits ||
| Y || Y || Y || Y 
| Y 
| Y 
| Configurable
|---- class="unknown" style="font-style:italic"
| style="text-align:left" | Run without debugging || {{keypress|Ctrl}}+{{keypress|Shift}}+{{keypress|F9}} || colspan="6" | Y || Not debugger specific
|}

==== Execution Control (Run, Step, ...)  ====
{| class="wikitable "
! Feature !! Key 
! GdbMi !! GdbMi+Ssh !! GdbServer !! GdbMi+FpDebug 
! Lldb+FpDebug 
! Fp-Debugger 
! Comments
|---- class="working" 
| style="text-align:left" | Continue (Run) || {{keypress|F9}}
| Y || Y || Y || Y 
| Y 
| Y 
|
|---- class="working" 
| style="text-align:left" | Step over line || {{keypress|F8}}
| Y || Y || Y || Y 
| Y 
| Y 
|
|---- class="working" 
| style="text-align:left" | Step into line || {{keypress|F7}}
| Y || Y || Y || Y 
| Y 
| Y 
|
|---- class="working" 
| style="text-align:left" | Step (over) to line at cursor || {{keypress|F4}}
| Y || Y || Y || Y 
| class="not" | N 
| Y
| "STEP OVER" - This works only within the current procedure.
It will go to the selected line, or stop if the current procedure is left.
<br>It will *step* *over* any recursive calls of the procedure, therefore not stopping at the line during recursion.
|---- class="working"     
| style="text-align:left" | Run to line at cursor ||
| Y || Y || Y || Y 
| class="not" | N 
| Y 
| Only Lazarus 2.2 and higher

|---- class="working" 
| style="text-align:left" | Step out (of current function) ||  {{keypress|Shift}}+{{keypress|F8}}
| Y || Y || Y || Y 
| Y 
| Y 
|
|---- class="working" 
| style="text-align:left" | Step over asm || {{keypress|Alt}}+{{keypress|F8}}
| Y || Y || Y || Y 
| Y 
| Y 
|
|---- class="working" 
| style="text-align:left" | Step into asm || {{keypress|Alt}}+{{keypress|F7}}
| Y || Y || Y || Y 
| Y 
| Y 
|
|---- class="working" 
| style="text-align:left" | Smart source or asm stepping (over/into) || 
| Y || Y || Y || Y 
| Y 
| Y 
| Assign one key (one for "over", one for "into") that acts as source-line or asm stepping, depending on window focus

|---- class="working" 
| style="text-align:left" | Pause ||
| Y || class="partial" | depends on gdb, mostly "No" || Y || Y 
| Y 
| Y 
|

|---- class="working" 
| style="text-align:left" | Suspend individual threads ||
| class="not" | N || class="not" | N || class="not" | N || class="not" | N 
| class="not" | N 
| class="working" | Y 
| While the app is paused threads can be suspended/resumed for upcoming stepping/running

|---- class="working" 
| style="text-align:left" | Step: steps over "none breaking" breakpoint ||
| Y || Y || Y || Y 
| class="unknown" | ?
| Lazarus 2.0 or 2.2 ?
| Any "step" command will continue to its step-end after a "none breaking" Breakpoints. This is a Breakpoint that has its break property turned off. It may record a snapshot, log a message, or enable/disable other breakpoints.
<br>{{Warning|The "auto-continue" (time based) function may not return to stepping, but instead "run/continue" execution.}}
|---- class="working" 
| style="text-align:left" | Step: steps over ignored exceptions ||
| Y || Y || Y || Y 
| class="unknown" | ?
| Lazarus 2.2 
| Only for standard fpc exception handling. And (Lazarus 2.2) SEH on Win64. <br>
Win32 and other OS structured exception handling are not supported (Ignored exceptions will turn Stepping into Running). 
|---- class="working" 
| style="text-align:left" | Source-Step: steps from except to finally or except ||
| Y || Y || Y || Y 
| class="unknown" | ? 
| Lazarus 2.2 
| Only for standard fpc exception handling. And (Lazarus 2.2) SEH on Win64. <br>
Win32 and other OS structured exception handling are not supported (Ignored exceptions will turn Stepping into Running). 

|---- class="working" 
| style="text-align:left" | Executable/Code line indicators || 
| Y || Y || Y || Y 
| Y 
| Y 
| Blue dots in the gutter indicate lines with debug info. 
|}

;Breakpoints / None-breaking breakpoints / Auto-continue breakpoints / Disabled breakpoints: A breakpoint usually pauses your app, in addition it can perform tasks like logging a message (debugger event log), dumping data to the log, taking a snapshot (debugger history). <br>A none-breaking breakpoint will perform those extra tasks, but not pause your app. <br>An auto-continue breakpoint will pause your app (and perform any other action) for a given amount of milliseconds (during which you can use the pause button, to pause permanently), after that it will continue your app. It usually continues using "Run", therefore loosing any current single-step action<br>A disabled breakpoint will do nothing. It is as if it does not exist.
;Stepping and breakpoints / exceptions: If any debugger pauses the target-app at a breakpoint or exception while single stepping, then the single-step is lost. The breakpoint/exception may be in a deeply nested called function, and you cannot continue the single-step. I.e. there is no build in way to get back to the function where you started your step, and finish this step. For this you need to go through the callstack yourself and find the start location and use breakpoints
;Stepping and none-breaking-breakpoints / Ignored-exceptions: Most/All? debugger backends can in this case continue to the position where the single-step would have ended. (This may be limited for asm stepping). In case of an exception the single step will end at the next finally or except. "Next" from the point of view of the step-command. I.e., any finally inside a "stepped over function" will be stepped over, but any finally on the same level as the step began will be used as end point. If there is none on the same level, then the next outer will be used.<br>This feature relies heavily on FPC implementation details. Thus it may not work with newer FPC versions.

==== Breakpoints / Exceptions ====
{| class="wikitable "
! Feature !! Key 
! GdbMi !! GdbMi+Ssh !! GdbServer !! GdbMi+FpDebug 
! Lldb+FpDebug 
! Fp-Debugger 
! Comments

|---- class="working" 
| style="text-align:left" | Breakpoint on Source Line || {{keypress|F5}}
| Y || Y || Y || Y 
| Y
| Y 
|
|---- class="working" 
| style="text-align:left" | Breakpoint on Assembler Line ||
| Y || Y || Y || Y 
| Y
| Y 
|
|---- class="working" 
| style="text-align:left" | Watchpoint / Breakpoint Data ||
| Y || Y || Y || Y 
| class="unknown" | ? 
| class="partial" | Partial 
| Amount/Size is limited by architecture
Intel based systems usually have 4 Watchpoints, each with a max size of 32 bit (64 bit on 64bit CPU)

|---- class="working" 
| style="text-align:left" | Conditional Break/Watch-point ||
| (Y) || (Y) || (Y) || (Y)
| ? 
| Y
| GDB based debuggers are limited to GDB's understanding of the conditional expression 
|---- class="working" 
| style="text-align:left" | Enable/Disable Break/Watch-point according to program flow ||
| Y || Y || Y || Y 
| Y 
| Y
| Enable/Disable a breakpoint (or a group of) when execution passes through a pre-defined point in your code.
So you can setup that the debugger will only break/skip-breaking, when the code is called in a specific order, or from a specific outer subroutine.
|---- class="working" 
| style="text-align:left" | Ignore exception by class ||
| Y || Y || Y || Y 
| Y
| Y 
| Configurable for each project
|---- class="working" 
| style="text-align:left" | Break/Watch-point overview Window || {{keypress|Ctrl}}+{{keypress|Alt}}+{{keypress|B}}
| Y || Y || Y || Y 
| Y
| Y 
|

|---- class="unknown" 
| style="text-align:left" | TODO: .... Document Breakpoint properties ||
| . || . || . || . 
| .
| .
|
|---- class="unknown" 
| style="text-align:left" | TODO: .... Document Breakpoint actions ||
| . || . || . || . 
| .
| .
|

|}

;GdbMi+Ssh: Some functionality depends on the ability to use "Pause". If "Pause" does not work, break/watch-points can not be changed/added/removed while the target app is running. Only when the target app pauses at a breakpoint (or for other reasons), then can changes be made.

==== Data (Watches, Locals, ...) ====
{| class="wikitable "
! Feature !! Key 
! GdbMi !! GdbMi+Ssh !! GdbServer !! GdbMi+FpDebug 
! Lldb+FpDebug 
! Fp-Debugger 
! Comments

|---- class="working" 
| style="text-align:left" | Watches || {{keypress|Ctrl}}+{{keypress|Alt}}+{{keypress|W}}
| Y || Y || Y || Y 
| Y
| Y 
|
|---- class="working" 
| style="text-align:left" | Locals || {{keypress|Ctrl}}+{{keypress|Alt}}+{{keypress|L}}
| Y || Y || Y || Y 
| Y
| Y 
|
|---- class="working" 
| style="text-align:left" | Stack || {{keypress|Ctrl}}+{{keypress|Alt}}+{{keypress|S}}
| Y || Y || Y || Y 
| Y
| Y 
|
|---- class="working" 
| style="text-align:left" | Threads || {{keypress|Ctrl}}+{{keypress|Alt}}+{{keypress|T}}
| Y || Y || Y || Y 
| Y
| Y 
| Running State indicator may not be accurate
|---- class="working" 
| style="text-align:left" | Inspect || {{keypress|Alt}}+{{keypress|F5}}
| Y || Y || Y || Y 
| Y
| Y 
| View members in property Grid. Double-click to inspect members
|---- class="working" 
| style="text-align:left" | Evaluate / Modify ||  {{keypress|Ctrl}}+{{keypress|F7}}
| Y || Y || Y || Y 
| class="unknown" | ? 
| class="working" | Y <br> Modify only in Lazarus 2.2 and higher
| See notes below
|---- class="working" 
| style="text-align:left" | Disassembler || {{keypress|Ctrl}}+{{keypress|Alt}}+{{keypress|D}}
| Y || Y || Y || Y 
| class="unknown" | ? 
| class="partial" | Partial 
|

|---- class="not"     
| style="text-align:left" | Watch/Inspect Class Properties || 
| N || N || N || N 
| N
| N <br> Work in progress <br> Will at least require a new major FPC release: 3.4.0 or up
| Using "DWARF" properties that refer directly to a field (no getter method) are shown.

|---- class="partial"     
| style="text-align:left" | Watch/Inspect Function calls ||  | 
| class="not" | N || class="not" | N || class="not" | N || class="not" | N 
| class="not" | N
| class="partial" | Partial <br> BETA: Lazarus 2.2 and higher can call certain functions in watches <br> Please see [[FpDebug-Watches-FunctionEval]]
|  | 

|---- class="working"     
| style="text-align:left" | Watch/Inspect Intrinsic helper functions ||  | 
| class="not" | N || class="not" | N || class="not" | N || class="not" | N 
| class="not" | N
| class="working" | Lazarus 2.3 and higher <br> Please see [[FpDebug-Watches-Intrinsic-Functions]]
|  | 

|---- class="working" 
| style="text-align:left" | Use Instance type/class ||
| Y || Y || Y || Y 
| Y
| Y 
| By default the debugger shows variables according to their declared type/class.
"Sender: TObject" will only show as TObject.
<br>The debugger can detect the real class of the instance (e.g. a TButton) and show all details
|---- class="working" 
| style="text-align:left" | Tooltip / Hint ||
| Y || Y || Y || Y 
| Y
| Y 
|
|---- class="working" 
| style="text-align:left" | Tooltip / Hint => Auto-deref pointer ||
| Y || Y || Y || Y 
| Y
| Y 
|
|---- class="working" 
| style="text-align:left" | Tooltip / Hint => Use Instance Class ||
| Y || Y || Y || Y 
| Y
| Y 
|
|---- class="working" 
| style="text-align:left" | Paste value into Watches window  ||
| Y || Y || Y || Y 
| Y
| Y
| Paste directly into watches window, no need to press "Add new watch"
|---- class="working" 
| style="text-align:left" | Drag/Draw value from source-editor to Watches window  ||
| Y || Y || Y || Y 
| Y
| Y
|
|---- class="unknown" 
| style="text-align:left" | TODO: .... Document Watches properties ||
| . || . || . || . 
| .
| .
|


|}

;Modify: All debuggers have restriction towards what type of data they can modify (modify target variables during a debug session).<br> Managed types (ansistring, dyn array) can not be modified by any debugger. Structured types can only be modified field by field.<br> For other types support depends on the debugger backend.<br> - For Gdb/Lldb this is currently not documented.<br> - For FpDebug the following do not NOT work: floating, currency, all strings incl shortstring, packed/bitpacked types.

==== Other ====
{| class="wikitable "
! Feature !! Key 
! GdbMi !! GdbMi+Ssh !! GdbServer !! GdbMi+FpDebug 
! Lldb+FpDebug 
! Fp-Debugger 
! Comments

|---- class="working" 
| style="text-align:left" | History ||{{keypress|Ctrl}}+{{keypress|Alt}}+{{keypress|H}}
| Y || Y || Y || Y
| Y 
| Y 
| Allow to review Watches/Locals/Stack from when your app was previously paused.
This does not restore the state of the application. It only allows to view the value that the debugger evaluated previously.
|---- class="working" 
| style="text-align:left" | History - Import / Export ||
| Y || Y || Y || Y
| Y 
| Y 
| 
*Save your debug results for later review.
*Or send them to a co-worker for feedback
*Combined with "snapshot" taking breakpoints, you can send a prepared project (watches/breakpoints set) to a co-worker, have them run the project in the debugger, and return the result to you.
|---- class="working" 
| style="text-align:left" | Event log ||{{keypress|Ctrl}}+{{keypress|Alt}}+{{keypress|V}}
| Y || Y || Y || Y
| Y 
| Y 
| 
|---- class="working" 
| style="text-align:left" | View internal debug output ||
| Y || Y || Y || Y<br>partly
| class="unknown" | ? 
| class="not" | Not applicable 
| View communication with the external debugger. For troubleshooting

|---- class="working" 
| style="text-align:left" | Debugging libraries <br> Stepping and Watches ||
| Y || Y || Y || Y
| class="unknown" | ? 
| class="working" | Lazarus 2.4 and up
| rowspan="3" |This pertains to debugging libraries compiled by FPC with debug info

|---- class="working" 
| style="text-align:left" | Debugging libraries <br> Breakpoint ||
| class="partial" | Depend on various factors || class="partial" | Depend on various factors || class="partial" | Depend on various factors || class="partial" | Depend on various factors
| class="unknown" | ? 
| class="partial" | Lazarus 2.4 and up <br/> Only when set after debugger was started <b>and</b> library was loaded.


|---- class="working" 
| style="text-align:left" | Debugging libraries <br> Exceptions ||
| class="partial" | Depend on various factors || class="partial" | Depend on various factors || class="partial" | Depend on various factors || class="partial" | Depend on various factors
| class="unknown" | ? 
| class="not" | N


|---- class="working" 
| style="text-align:left" | Cross debugging 32<>64bit ||
| Y || Y || Y || class="partial" | Y <br>Win-64bit IDE can debug 32 bit target
| class="unknown" | ? 
| class="partial" | Lazarus 2.2 <br>Win-64bit IDE can debug 32 bit target 
| 
*Gdb-based: Requires Gdb for target-bitness to be installed, and the "LazGDeBugControl.exe" (included in Lazarus)
*Fp-Debugger: Not tested on Linux / For Windows, requires Lazarus 2.2
|---- class="working" 
| style="text-align:left" | Remote debugging ||
| class="not" | N || Y || Y || class="not" | N 
| class="not" | N 
| class="not" | N* 
| *Remote debugging of simple targets (only AVR currently) via gdb's remote serial protocol using package LazDebuggerFpRspRemote

|---- class="working" 
| style="text-align:left" | Edit source code while debugging ||
| Y || Y || Y || Y
| Y 
| Y 
| 
* Fully working source editor (with code completion), while debugging
* Editor keeps track of inserted/deleted lines, so breakpoints can be set to correct location
|}

==== Debug Info Support (DWARF, Stabs) ====
{| class="wikitable "
! -
! GdbMi !! GdbMi+Ssh !! GdbServer !! GdbMi+FpDebug 
! Lldb+FpDebug 
! Fp-Debugger 

|---- class="working" 
| style="text-align:left" | Recommended 
| colspan=3 | DWARF-2 (with sets)<br />-gw -godwarfsets ||  DWARF-3 <br />-gw3
| DWARF-3 <br />-gw3 
| DWARF-3 <br />-gw3 
|---- class="working" 
| style="text-align:left" | Supported 
| colspan=3 | All DWARF versions and "Stabs" <br /> Stability of DWARF 3 and higher depends on FPC and GDB version <br />(older FPC produced incorrect DWARF-3 which caused troubles in GDB, but GDB has some issues too) || Only DWARF <br /> All DWARF versions
| Only DWARF <br /> All DWARF versions 
| Only DWARF <br /> All DWARF versions
 
|}
:See also: [[DWARF]]