Debugger is a graphical user interface for the Erlang interpreter, which can be used for debugging and testing of Erlang programs. For example, breakpoints can be set, code can be single stepped and variable values can be displayed and changed.
The Erlang interpreter can also be accessed via the interface
module
Warning: Note that the Debugger at some point might start tracing on the processes which execute the interpreted code. This means that a conflict will occur if tracing by other means is started on any of these processes.
Start Debugger by calling
Initially there are normally no debugged processes. First, it
must be specified which modules should be debugged, or
interpreted as it is also called. This is done by
choosing Module->Interpret... in the Monitor window and
then selecting the appropriate modules from the
Only modules compiled with the option
When a module is interpreted, it can be viewed in a
Now the program that should be debugged can be started. This is done the normal way from the Erlang shell. All processes executing code in interpreted modules will be displayed in the Monitor window. It is possible to attach to one of these processes, by double-clicking it, or by selecting the process and then choosing Process->Attach.
Attaching to a process will result in a
Once the appropriate modules are interpreted, breakpoints can be set at relevant locations in the source code. Breakpoints are specified on a line basis. When a process reaches a breakpoint, it stops and waits for commands (step, skip, continue,...) from the user.
When a process reaches a breakpoint, only that process is stopped. Other processes are not affected.
Breakpoints are created and deleted using the Break menu of the Monitor window, View Module window and Attach Process window.
To have effect, a breakpoint must be set at an
executable line, which is a line of code containing an
executable expression such as a matching or a function call.
A blank line or a line containing a comment, function head or
pattern in a
In the example below, lines number 2, 4, 6, 8 and 11 are executable lines:
1: is_loaded(Module,Compiled) -> 2: case get_file(Module,Compiled) of 3: {ok,File} -> 4: case code:which(Module) of 5: ?TAG -> 6: {loaded,File}; 7: _ -> 8: unloaded 9: end; 10: false -> 11: false 12: end.
A breakpoint can be either active or inactive. Inactive breakpoints are ignored.
Each breakpoint has a trigger action which specifies what should happen when a process has reached it (and stopped):
A line breakpoint is created at a certain line in a module.
Right-clicking the Module entry will open a popup menu from which the appropriate module can be selected.
A line breakpoint can also be created (and deleted) by double-clicking the line when the module is displayed in the View Module or Attach Process window.
A conditional breakpoint is created at a certain line in the module, but a process reaching the breakpoint will stop only if a given condition is true.
The condition is specified by the user as a module name
Right-clicking the Module entry will open a popup menu from which the appropriate module can be selected.
Example: A conditional breakpoint calling
Extract from
5. fac(0) -> 1; 6. fac(N) when N > 0, is_integer(N) -> N * fac(N-1).
Definition of
-module(c_test). -export([c_break/1]). c_break(Bindings) -> case int:get_binding('N', Bindings) of {value, 3} -> true; _ -> false end.
A function breakpoint is a set of line breakpoints, one at the first line of each clause in the given function.
Right-clicking the Module entry will open a popup menu from which the appropriate module can be selected.
Clicking the Ok button (or 'Return' or 'Tab') when a module name has been given, will bring up all functions of the module in the listbox.
The Erlang emulator keeps track of a stack trace, information about recent function calls. This information is used, for example, if an error occurs:
1> catch a+1. {'EXIT',{badarith,[{erlang,'+',[a,1],[]}, {erl_eval,do_apply,6,[{file,"erl_eval.erl"},{line,573}]}, {erl_eval,expr,5,[{file,"erl_eval.erl"},{line,357}]}, {shell,exprs,7,[{file,"shell.erl"},{line,674}]}, {shell,eval_exprs,7,[{file,"shell.erl"},{line,629}]}, {shell,eval_loop,3,[{file,"shell.erl"},{line,614}]}]}}
See the Erlang Reference Manual,
The Debugger emulates the stack trace by keeping track of recently called interpreted functions. (The real stack trace cannot be used, as it shows which functions of the Debugger have been called, rather than which interpreted functions).
This information can be used to traverse the chain of function
calls, using the 'Up' and 'Down' buttons of
By default, the Debugger only saves information about recursive function calls, that is, function calls that have not yet returned a value (option 'Stack On, No Tail').
Sometimes, however, it can be useful to save all calls, even tail-recursive calls. That can be done with the 'Stack On, Tail' option. Note that this option will consume more memory and slow down execution of interpreted functions when there are many tail-recursive calls.
It is also possible to turn off the Debugger stack trace facility ('Stack Off'). Note: If an error occurs, in this case the stack trace will be empty.
See the section about
The Monitor window is the main window of Debugger and shows a listbox containing the names of all interpreted modules (double-clicking a module brings up the View Module window), which options are selected, and information about all debugged processes, that is all processes which have been/are executing code in interpreted modules.
The Auto Attach buttons, Stack Trace label, Back Trace Size
label, and Strings button show some options set, see
The process identifier.
The first call to an interpreted function by this
process. (
The registered name, if any. If a registered name does not show up, it may be that the Debugger received information about the process before the name had been registered. Try selecting Edit->Refresh.
The current status, one of the following:
The interpreted function call has returned a value, and the process is no longer executing interpreted code.
The process is running.
The process is waiting in a
The process is stopped at a breakpoint.
The process has terminated.
There is no connection to the node where the process is located.
Additional information, if any. If the process is
stopped at a breakpoint, the field contains information
about the location
Try to load and restore Debugger settings from a file previously saved using Save Settings..., see below. Any errors are silently ignored. Note: Settings saved by Erlang R16B01 or later cannot be read by Erlang R16B or earlier.
Save Debugger settings to a file. The settings include the set of interpreted files, breakpoints, and the selected options. The settings can be restored in a later Debugger session using Load Settings..., see above. Any errors are silently ignored.
Stop Debugger.
Update information about debugged processes. Removes information about all terminated processes from the window, and also closes all Attach Process windows for terminated processes.
Terminate all processes listed in the window using
Open the
Stop interpreting all modules. Processes executing in interpreted modules will terminate.
For each interpreted module, a corresponding entry is added to the Module menu, with the following submenu:
Stop interpreting the selected module. Processes executing in this module will terminate.
Open a
The following menu items apply to the currently selected
process, provided it is stopped at a breakpoint. See the chapter
about the
The following menu items apply to the currently selected process.
Attach to the process and open a
Terminate the process using
The items in this menu are used to create and delete
breakpoints.
See the
Set a line breakpoint.
Set a conditional breakpoint.
Set a function breakpoint.
Enable all breakpoints.
Disable all breakpoints.
Remove all breakpoints.
For each breakpoint, a corresponding entry is added to the Break menu, from which it is possible to disable/enable or delete the breakpoint, and to change its trigger action.
Set which areas should be visible in
an
Set at which events a debugged process should be automatically attached to. Affects existing debugged processes.
Set stack trace option, see section
Set which integer lists should be printed as strings. Does not affect already existing debugged processes.
Set how many call frames should be fetched when inspecting the call stack from the Attach Process window. Does not affect already existing Attach Process windows.
Contains a menu item for each open Debugger window. Selecting one of the items will raise the corresponding window.
View the Debugger documentation. Currently this function requires a web browser to be up and running.
The interpret dialog module is used for selecting which modules
to interpret. Initially, the window shows the modules (
Interpretable modules are modules for which a BEAM file, compiled
with the option
Modules, for which the above requirements are not fulfilled, are not interpretable and are therefore displayed within parentheses.
The
An example of how to compile code with debug information using
An example of how to compile code with debug information from
the Erlang shell:
Browse the file hierarchy and interpret the appropriate modules
by selecting a module name and pressing Choose (or
carriage return), or by double clicking the module name.
Interpreted modules have the type
Pressing All will interpret all displayed modules in the chosen directory.
Pressing Done will close the window.
When the Debugger is started in global mode (which is
the default, see
From an Attach Process window the user can interact with a debugged process. One window is opened for each process that has been attached to. Note that when attaching to a process, its execution is automatically stopped.
The window is divided into five parts:
The Code area, showing the code being executed. The code
is indented and each line is prefixed with its line number.
If the process execution is stopped, the current line is
marked with -->. An existing break point at a line
is marked with a stop symbol. In the example above,
the execution has been stopped at line 6, before
the execution of
Active breakpoints are shown in red, while inactive breakpoints are shown in blue.
The Trace area, showing a trace output for the process.
Also the back trace, a summary of the current function calls on the stack, is displayed in the Trace area.
It is configurable using the Options menu which areas should be shown or hidden. By default, all areas except the Trace area are shown.
Close this window and detach from the process.
Go to a specified line number.
Search for a specified string.
Execute the current line of code, stepping into any (interpreted) function calls.
Execute the current line of code and stop at the next line.
Continue the execution.
Continue the execution until the current function returns.
Skip the current line of code and stop at the next
line. If used on the last line in a function body,
the function will return
Simulate a timeout when executing a
Stop the execution of a running process, that is, make the process stop as at a breakpoint. The command will take effect (visibly) the next time the process receives a message.
Make sure the current location of the execution is visible in the code area.
Terminate the process using
Inspect the message queue of the process. The queue is printed in the evaluator area.
Display the back trace of the process, a summary of the current function calls on the stack, in the trace area. Requires that the Trace area is visible and that the stack trace option is 'Stack On, Tail' or 'Stack On, No Tail'.
Inspect the previous function call on the stack, showing the location and variable bindings.
Inspect the next function call on the stack, showing the location and variable bindings.
Set which areas should be visible. Does not affect other Attach Process windows.
Same as in
Same as in
Set how many call frames should be fetched when inspecting the call stack. Does not affect other Attach Process windows.
The Break, Windows and Help menus look the same as in
the Monitor window, see the chapter
The View Module window shows the contents of an interpreted module and makes it possible to set breakpoints.
The source code is indented and each line is prefixed with its line number.
Clicking a line will highlight it and select it to be the target of the breakpoint functions available from the Break menu. Doubleclicking a line will set a line breakpoint on that line. Doubleclicking a line with an existing breakpoint will remove the breakpoint.
Breakpoints are marked with a stop symbol.
The File and Edit menus look the same as in the Attach Process
window, see the chapter
The Break, Windows and Help menus look the same as in
the Monitor window, see the chapter
Execution of interpreted code is naturally slower than for regularly compiled modules. Using the Debugger also increases the number of processes in the system, as for each debugged process another process (the meta process) is created.
It is also worth to keep in mind that programs with timers may behave differently when debugged. This is especially true when stopping the execution of a process, for example at a breakpoint. Timeouts can then occur in other processes that continue execution as normal.
Code loading works almost as usual, except that interpreted modules are also stored in a database and debugged processes uses only this stored code. Re-interpreting an interpreted module will result in the new version being stored as well, but does not affect existing processes executing an older version of the code. This means that the code replacement mechanism of Erlang does not work for debugged processes.
By using
debugger:start(local | global)
If no argument is provided, Debugger is started in global mode.
In local mode, code is interpreted only at the current node. In global mode, code is interpreted at all known nodes. Processes at other nodes executing interpreted code will automatically be shown in the Monitor window and can be attached to like any other debugged process.
It is possible, but definitely not recommended to start Debugger in global mode on more than one node in a network, as they will interfere with each other leading to inconsistent behaviour.