Difference between revisions of "Debugging Octave"

From Octave
Jump to navigation Jump to search
Line 19: Line 19:
 
</syntaxhighlight>
 
</syntaxhighlight>
  
start now the GNU debugger with octave
+
start now the GNU debugger with octave.  On most Unixy systems, you can start gdb from within an Octave session by evaluating a command like
  
 
<syntaxhighlight lang="bash">
 
<syntaxhighlight lang="bash">
gdb octave
+
octave> system (sprintf ("gnome-terminal --command 'gdb -p %d'", getpid ()), "async");
 
</syntaxhighlight>
 
</syntaxhighlight>
  
and run it
+
at the Octave prompt.  This command will open a terminal window running gdb attached to the Octave process.  At this point, Octave will be stopped.  To tell Octave to continue, type
  
 
<syntaxhighlight lang="bash">
 
<syntaxhighlight lang="bash">
(gdb) run
+
(gdb) continue
 
</syntaxhighlight>
 
</syntaxhighlight>
  
Octave will start up. To load the symbol table the function needs to be executed, for example by invoking the help function
+
at the gdb prompt.  The symbols from your oct-file will only be available to gdb once the oct-file is loaded in Octave. To do that without executing any functions from the oct-file, you can ask Octave to display the help for the oct-file:
  
<syntaxhighlight lang="octave">
+
<syntaxhighlight lang="bash">
octave:1> help file
+
octave> help file
</syntaxhighlight>  
+
</syntaxhighlight>
  
 
Now halt execution of Octave by typing ctrl+c, you'll see again the gdb prompt. Set now a breakpoint in the line of interest
 
Now halt execution of Octave by typing ctrl+c, you'll see again the gdb prompt. Set now a breakpoint in the line of interest
Line 46: Line 46:
  
 
<syntaxhighlight lang="octave">
 
<syntaxhighlight lang="octave">
octave:1> x = file(y)
+
octave> x = file(y)
 
</syntaxhighlight>  
 
</syntaxhighlight>  
  
 
the debugger will stop on the above defined line and you can start debugging according to the manual of GNU debugger.
 
the debugger will stop on the above defined line and you can start debugging according to the manual of GNU debugger.
 
If you encounter problem with interrupting octave (i.e. "^C" is only
 
printed when you press ctrl+c and control is not transferred to gdb)
 
then you might follow following steps (which should work always).
 
# Start gdb<br/><syntaxhighlight lang="bash">> gdb octave</syntaxhighlight>
 
# Catch loading of your oct-file ("file" below is a regex matching name of your oct-file)<br/><syntaxhighlight lang="bash">(gdb) catch load file</syntaxhighlight>
 
# Run octave<br/><syntaxhighlight lang="bash">(gdb) r</syntaxhighlight>
 
# From octave request loading of your oct-file by calling function<br/><syntaxhighlight lang="octave">octave> x = file(y)</syntaxhighlight>
 
# Control will switch to gdb just after oct-file is loaded and at this point all symbols from oct-file are available so you can either set up a breakpoint at particular line or at function entry.<br/><syntaxhighlight lang="bash">(gdb) b file.cpp:40</syntaxhighlight>
 
# Resume execution of octave by<br/><syntaxhighlight lang="bash">(gdb) c</syntaxhighlight>
 
and debugger will stop at the breakpoint defined.
 
  
 
= Tools for debugging =
 
= Tools for debugging =

Revision as of 08:15, 4 April 2014

Preliminaries

Since compilation of all the source from scratch can take long it is good to have a source folder where most of the source has been compiled. To do this, you can create a parallel build:

mkdir dbg-octave
cd dbg-octave
/path/to/octave/source/configure FFLAGS=-g CFLAGS=-g CXXFLAGS=-g --enable-bounds-check --prefix=/opt/dbg-octave
make # or make -jN where N is the number of CPU cores

This will create a new build of Octave in a different directory without optimisations (no -O2 gcc parameter) and with debug symbols compiled in. This build is useful for debugging Octave itself.

Debugging oct-files

To debug oct-files, avoid making any optimization during compilation. Use export CXXFLAGS="-ggdb -Wall -O0" for C++ code or export CFLAGS="-ggdb -Wall -O0" for C code to suppress optimization. Compile the oct-file with the debug flag -g which enables debug symbols

mkoctfile -g file.cpp

start now the GNU debugger with octave. On most Unixy systems, you can start gdb from within an Octave session by evaluating a command like

octave> system (sprintf ("gnome-terminal --command 'gdb -p %d'", getpid ()), "async");

at the Octave prompt. This command will open a terminal window running gdb attached to the Octave process. At this point, Octave will be stopped. To tell Octave to continue, type

(gdb) continue

at the gdb prompt. The symbols from your oct-file will only be available to gdb once the oct-file is loaded in Octave. To do that without executing any functions from the oct-file, you can ask Octave to display the help for the oct-file:

octave> help file

Now halt execution of Octave by typing ctrl+c, you'll see again the gdb prompt. Set now a breakpoint in the line of interest

(gdb) b file.cpp:40

by typing c the execution of octave will continue and you can run your oct-file directly or via an m-script.

octave> x = file(y)

the debugger will stop on the above defined line and you can start debugging according to the manual of GNU debugger.

Tools for debugging

Producing a stack trace

Sometimes Octave will crash, meaning, it terminates abruptly and returns control to the operating system shell. In these cases, it is very helpful to produce a stack trace to diagnose the problem. To do so, you need to (re)compile Octave with debugging symbols and run the debugger, as explained above. Then, run Octave:

gdb> run

execute whatever commands you think are necessary to produce the crash. When Octave crashes, you will be back in a gdb session. Type bt here to obtain a stack trace.

Most used commands

gdb documentation

Emacs

In short:

To start Octave in debug mode within emacs type

M-x gud-gdb

then change the command in the minibuffer to run gud-gdb (like this):

   /path/to/octave/build/tree/run-octave -gud

For more info use this link to the emacs manual section on debuggers operation

ddd

gui for gdb