View source for Koneki/LDT/User Guide/Concepts/Debugger

{{Warning|This page is obsolete|This page is not relevant anymore for LDT since the 0.9 version, instead please refer to the user guide: [[Koneki/LDT/Developer_Area/User_Guides]]}} 

= Lua Development Tools Debugger  =

== Remote Debug  ==

The Debugger of Lua Development Tools is based on the DBGp protocol.<br> The IDE contains a DBGp server. To connect to this server, and begin remote/attach debugging, you need to get our [[Media:Debugger_lua.zip|DBGp Lua client]]. 

=== DBGp Client  ===

The DBGp Lua client is composed of two Lua files ([http://git.eclipse.org/c/koneki/org.eclipse.koneki.ldt.git/plain/libraries/luadbgpclient/debugger.lua debugger.lua] and [http://git.eclipse.org/c/koneki/org.eclipse.koneki.ldt.git/plain/libraries/luadbgpclient/debugintrospection.lua debugintrospection.lua]).<br> It runs on Unix-like OS and Windows (XP and later). It is written in '''Lua 5.1''' and '''depends on lua-socket'''.<br> ''You can get Lua on http://www.lua.org/download.html and install lua-socket thanks to [http://luarocks.org/en/Download luarocks], or via your official OS repositories.''<br> 

To use it, you must have these two files in your lua path.<br> To begin the connection, you must execute this Lua code&nbsp;: 

 &gt; local initconnection = require("debugger")
 &gt; initconnection(host, port, idekey)

or shortly 

 &gt; require("debugger")(host, port, idekey)

*'''host''': the host name or the IP address of the DBGp server (thus, of your IDE). 
**if host is nil, the DBGP_IDEHOST environment variable is used. 
**if the environment variable is nil, the default value '127.0.0.1' is used. 
*'''port''': the port of the DBGp server (must be configured in the IDE). 
**if port is nil, the DBGP_IDEPORT environment variable is used. 
**if the environment variable is nil, the default value '10000' is used. 
*'''idekey''': a string which is used as session key (must be configured in the IDE). 
**if IDEKEY is nil, the DBGP_IDEKEY environment variable is used. 
**if the environment variable is nil, the default value 'luaidekey' is used.

So, To debug your application you could do&nbsp;: 

 lua -e "require('debugger')("idehost","ideport");" MyApp.lua

=== DBGp Server  ===

The DBGp Server is integrated in LDT.<br> In order to accept incoming debug sessions, you must create a new '''Remote Lua Application''' launch configuration, then launch it. 

Go in '''Run/Debug Configurations...'''. [[Image:LaunchConfiguration.png|center]]<br> 

*'''Project'''&nbsp;: Set the LDT project in your workspace which includes the Lua source file(s) of the application you want to debug. <br> 
*'''IdeKey'''&nbsp;: Default value is luaidekey, if you need to debug more than one application at the same time, you should change it to associate a launch configuration with only one application to debug.<br> 
*'''Source Mapping'''&nbsp;: Define a common way for DBGp Server (IDE) and DBGp Client (running application) to identify source file. There are several strategy, each more or less adapted to a specific used case. To better understand it, see the [[#Source Mapping |advanced documentation]] on it. 

<br> Now you can start your debug session by clicking '''Debug'''. IDE will wait for an incoming connection from the debugger client, on the port you can see in the debug view.<br> [[Image:DebugView.png|center]] 

If needed, you can change the server port, in ''Window &gt; Preferences &gt; Dynamic Languages &gt; Debug''. [[Image:DebugUI.png|center]] 

== Debug features  ==

=== Supported features  ===

==== Breakpoints, code navigation  ====

You can set breakpoints at a particular file/line, you can do it with the regular double-click on margin: 

[[Image:Dbg-setbreakpoint.png|center]] 

You can then specify some conditions to stop execution only under certain circumstances: 

[[Image:Dbg-openproperties.png|center]] 

[[Image:Dbg-properties.png|center]] 

#Enable or disable breakpoint globally<br> 
#Condition on hit count (stop only after 3rd hit, each 4 reaches, ...) 
#Conditional breakpoint: you can put any expression, it will be evaluated in the local scope each time breakpoint is reached and break only when expression is evaluated to true.

Once a breakpoint has been reached and breaks, you can use usual step into, step over and step out commands. 

{{tip|Coroutine handling|When the current instruction is a <tt>coroutine.yield</tt> or a <tt>coroutine.resume</tt> step over will jump over the coroutine until the next resume or yield whereas step into will go into the coroutine and re-break as soon as possible.}} 

==== Environment inspection  ====

When a breakpoint is reached, you can see any variable visible from any stack frame (local, upvalue and global variables). You can also change values to another.<br> 

[[Image:Dbg-variables.png|center]] 

{{Tip|New values are expressions|When you set a new value, it is evaluated as expression, so <tt>math.sqrt</tt> will be evaluated to a function, if you want to put a literal string, use Lua syntax: <tt>"math.sqrt"</tt>. In particular you can change an entire table by another table expression. This is sometimes powerful and sometimes dangerous, be careful with that.}} 

Some ''special'' values can also be displayed such as metatables or function environments (if it is different from global environment). You can also change these values. 

==== Interactive console and expressions  ====

In addition to variable view, you have two other useful tools to evaluate some code snippets: expressions view and interactive console.<br> 

[[Image:Dbg-expressions.png|frame|center|The expressions view allows you to re-evaluate complex expressions at each step]] 

[[Image:Dbg-repl.png|frame|center|The interactive console allows you to type statements under the local scope]] 

{{Warning|Always on top level|Due to a limitation from DBGp protocol, the interactive console and expressions are always mapped to the top stack frame !}} 

==== Source Mapping  ====
The DBGp Server (IDE) and the DBGp client (running application) need to communicate about source files.<br/>
''E.g. When you set a breakpoint, the IDE need to say to the running application on which file the breakpoint must be added.''<br/>
''E.g. When the running application stops on a breakpoint of a file, the IDE must retrieve the file and open it.''<br/>

The problem is that the file executed in your Lua VM could be physically different than the source file in your IDE (in your workspace).
For example, in the case where your code is executed on a different host or just if your executed code is duplicated in another folder.

To resolve this problem, LDT proposes to you different strategies, each with advantages and drawbacks :
 
* '''Local Resolution'''
This way to resolve the source mapping is the more simple and the more reliable. Both client and server works with absolute path. The IDE will search first in its buildpath, then in the whole workspace, a file that has the given absolute path. This means that executed file should be in your workspace. So you can not use it to debug code on a remote host.

* '''Module Resolution'''
Both IDE and application have their own way to retrieve a module from its name. So we could use the module name has file ID instead of path.
With this mode, you could do remote debugging without settin a list of path mapping.
The limitation is that you should use the standard lua_path way to load module. 
Another problem is that we could not really retrieve the module name at client side, because the Lua debug api uses source path. The module name is retrieved from the path (from debug.getinfo) and the lua_path (package.path). so with ambiguous lua_path you could have insolvable conflict.<br/>
''E.g: with <code>package.path = "/foo/bar/?.lua, /foo/?.lua"</code> and <code>debug.getinfo="@/foo/bar/baz.lua"</code> the possible module name is bar.baz or baz ''<br/>
There are no way to know the real module name, in this case the debugger will use the shorter one, but the ideal is to avoid ambiguous lua_path with this mode.

* '''Replace path Resolution'''
This mode is a fallback. If the two previous one don't fit your needs, you could try it.
In this mode, client talks with absolute path and server (IDE) uses relative path (relative to the buildpath).
A path must be set in launchconfiguration to move from one world to another.<br/>

''e.g: You set path with "/foo/bar/".<br/>
when file path is sent from client (/foo/bar/baz/qux.lua), path will be removed (baz/qux.lua) and a file with this relative path will be searched in your buildpath.<br/>
when file path is sent from server (baz/qux.lua), path will be add (/foo/bar/baz/qux.lua) and the absolute path will be sent to the client ''

The problem is that you could set only one path.<br/>
The path comparison is case sensitive (even on windows).<br/>
On windows, you should prefix your path with "/" (e.g. /C:/foo/bar/)

'''In all case, if file is not found in the workspace, the source code is sent via the DBGp protocol'''

=== Unsupported features  ===

The '''dynamic code''' is not supported, it means that any code that is loaded with <tt>load</tt>, <tt>loadstring</tt> will not be supported. The debugger will step over it just like a C function. 

The only well tested virtual machine is Lua 5.1. Any other implementation (Lua 5.2, LuaJIT<ref>http://lua-users.org/lists/lua-l/2011-11/msg00583.html</ref>, ...) is not guaranteed to work at this time.

References: <references/>