Editing Documentation/Maemo 5 Developer Guide/Kernel and Debugging Guide/Maemo Debugging Guide
Warning: You are not logged in.
Your IP address will be recorded in this page's edit history.
Warning: This page is 62 kilobytes long; some browsers may have problems editing pages approaching or longer than 32kb. Please consider breaking the page into smaller sections.
The edit can be undone.
Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.
Latest revision | Your text | ||
Line 1: | Line 1: | ||
- | = Debugging = | + | = 15. Debugging = |
- | = Introduction = | + | = 15.1 Introduction = |
The following code examples are used in this chapter: | The following code examples are used in this chapter: | ||
- | * [https:// | + | * [https://garage.maemo.org/svn/maemoexamples/tags/maemo_4.1/gdb_example gdb_example] |
- | * [https:// | + | * [https://garage.maemo.org/svn/maemoexamples/tags/maemo_4.1/ MaemoPad] |
- | * [https:// | + | * [https://garage.maemo.org/svn/maemoexamples/trunk/hello-world-app/ hello-world-app] |
- | * [https:// | + | * [https://garage.maemo.org/svn/maemoexamples/tags/maemo_4.1/valgrind_example/ valgrind_example] |
- | = Maemo Debugging Guide = | + | = 15.2 Maemo Debugging Guide = |
- | This section is targeted at beginner-level | + | This section is targeted at beginner-level maemo developers needing to know how to perform debugging in the maemo environment. |
- | This section covers the two basic debugging tools available in the | + | This section covers the two basic debugging tools available in the maemo environment, and shows how to use them. The tools are: |
- | * | + | * gdb - The Gnu Project Debugger. General tool for various debugging needs. |
- | * | + | * valgrind - Debugger and profiler. Valgrind works only in the X86 environment under Scratchbox, so this tool cannot be used in the device itself. |
This section assumes that the developer already knows how to: | This section assumes that the developer already knows how to: | ||
Line 23: | Line 23: | ||
* develop software in the Linux environment using the C language | * develop software in the Linux environment using the C language | ||
* install software to the tablet device | * install software to the tablet device | ||
- | * | + | * gain root access to the device |
* install ssh to the device | * install ssh to the device | ||
- | * configure repositories in the | + | * configure repositories in the /etc/apt/sources.list file |
* set up USB networking between a Linux PC and the Tablet (the device can also be used over a local WLAN connection instead) | * set up USB networking between a Linux PC and the Tablet (the device can also be used over a local WLAN connection instead) | ||
* work with the Scratchbox environment and Scratchbox targets | * work with the Scratchbox environment and Scratchbox targets | ||
- | == Pre-Requisites == | + | == 15.2.1 Pre-Requisites == |
- | To follow the debugging examples | + | To follow the debugging examples the following is needed: |
- | * | + | * maemo SDK installed in a Linux PC |
- | * Nokia Internet Tablet device running | + | * Nokia Internet Tablet device running OS 2009. |
* USB cable to connect the device with the Linux PC | * USB cable to connect the device with the Linux PC | ||
* Internet access both for the tablet and for the Linux PC | * Internet access both for the tablet and for the Linux PC | ||
* USB networking (or WLAN) set up between the Linux PC and the device | * USB networking (or WLAN) set up between the Linux PC and the device | ||
- | * root login access to the device over | + | * root login access to the device over ssh |
- | * package | + | * package maemo-sdk-debug installed |
- | * | + | * xterm installed in the device |
- | * | + | * ssh software installed in the device |
- | == General Notes on Debugging == | + | == 15.2.2 General Notes on Debugging == |
- | + | '''Debugging Issues on ARM Architecture''' | |
- | + | There are some issues one needs to be aware of when debugging on the ARM architecture. | |
- | * To make backtraces work properly | + | * To make backtraces work properly in ARM side, the dbg packages need to be installed for the libraries the application is using. Profiling and debugging (gdb) tools require code to have either framepointers or debugging symbols to unwind stack. This is needed for showing backtraces or call graphs. |
- | * C language functions with the <code>__attribute__((__noreturn__))</code> statement need to be compiled with the gcc option: <code>-mapcs-frame</code> otherwise | + | * C language functions with the <code>__attribute__((__noreturn__))</code> statement need to be compiled with the gcc option: <code>-mapcs-frame</code> otherwise compiler excludes their function frame. Maemo Glib and C-library noreturn functions like <code>abort()</code> already have this. Without a function frame, Gdb cannot backtrace through "noreturn" functions. |
- | * In addition, for gdb to be able to display the correct function names during debugging, it also needs to have access to the debug symbols. Without them, | + | * In addition, for the gdb to be able to display the correct function names during debugging, it also needs to have access to the debug symbols. Without them, it shows preceding exported function name for a given address. |
- | + | '''Debugging Issues in Scratchbox''' | |
- | It is recommended to use the native gdb in the target, not the Scratchbox host gdb. | + | It is recommended to use the native gdb in the target, not the Scratchbox host-gdb. |
- | When debugging threads in an application, gdb needs to be linked against the same thread library that the application is using. For this reason, the | + | When debugging threads in an application, gdb needs to be linked against the same thread library that the application is using. For this reason, the Scratchbox-provided gdb is not suitable for threads debugging, but the native gdb needs to be used instead. See instructions in the next section on how to start using the native gdb. |
- | + | <br /><br /><div style="border: 2px solid rgb(255, 215, 0); background-color: rgb(252, 233, 79); margin-left: 25px; margin-right: 25px; padding: 2px"> N.B. <br /><br /> The above-mentioned problem can produce "warning: Cannot initialize thread debugging library: unknown thread_db error '22'" messages in gdb output, and info threads command in gdb will show nothing.</div> | |
- | + | == 15.2.3 Using Gdb Debugger == | |
- | + | ||
- | == Using Gdb Debugger == | + | |
The Gnu Project Debugger, or gdb for short, is a general purpose debugger that can be used for various debugging purposes. | The Gnu Project Debugger, or gdb for short, is a general purpose debugger that can be used for various debugging purposes. | ||
- | This section does not explain how to use the gdb debugger itself, | + | This section does not explain how to use the gdb debugger itself, i.e. it does not explain the specific commands in gdb to perform some specific actions. There are other tutorials and documentation readily available in the [http://www.gnu.org/software/gdb/documentation/ Internet] for that purpose. This section focuses on explaining how to set up and perform the basic debugging steps with the gdb in the maemo environment. |
+ | |||
+ | For additional gdb documentation, take a look at the maemo tools documentation for [http://maemo.org/development/tools/doc/gdb gdb]. | ||
+ | |||
+ | '''Setting up Environment''' | ||
- | + | Both the Internet Tablet device, described in section [[../../Development Environment/Maemo PC Connectivity|Maemo PC Connectivity]], and the Scratchbox environment, described in section [[../../Development Environment/Maemo SDK|Maemo SDK]], need to be set up. | |
- | + | '''Preparing Scratchbox Environment for Debugging''' | |
- | + | If the maemo SDK is not yet installed, it must be installed before continuing. | |
- | + | After installing maemo SDK, the default target names are FREMANTLE_ARMEL and FREMANTLE_X86. These will be used in this example. | |
- | Scratchbox provides a | + | <br /><br /><div style="border: 2px solid rgb(255, 215, 0); background-color: rgb(252, 233, 79); margin-left: 25px; margin-right: 25px; padding: 2px"> N.B. <br /><br /> The Scratchbox provides a gdb debugger. If just <code>[sbox-FREMANTLE_x86: ~] > gdb ...</code> is run, then that gdb debugger is used. In this material, the native-gdb (i.e. non-Scratchbox version of gdb) is used.</div><br /><br /> |
- | Next, install gdb to Scratchbox from the | + | Next, install gdb to the Scratchbox from the maemo repositories. |
- | [sbox-FREMANTLE_x86: ~] | + | [sbox-FREMANTLE_x86: ~] > fakeroot apt-get install maemo-sdk-debug |
+ | <br /><br /> | ||
- | Now two gdb programs are installed. The one used can be checked with | + | Now two gdb programs are installed. The one used can be checked with: |
- | [sbox-FREMANTLE_x86: ~] | + | [sbox-FREMANTLE_x86: ~] > which gdb |
/targets/links/arch_tools/bin/gdb | /targets/links/arch_tools/bin/gdb | ||
+ | |||
+ | <br /><br /> | ||
+ | |||
+ | If only using the command gdb, then the gdb used is the one provided by Scratchbox. | ||
Start briefly both gdb debuggers to see that they start properly in the Scratchbox environment. First just run gdb: | Start briefly both gdb debuggers to see that they start properly in the Scratchbox environment. First just run gdb: | ||
- | [sbox-FREMANTLE_x86: ~] | + | [sbox-FREMANTLE_x86: ~] > gdb |
GNU gdb 6.8 | GNU gdb 6.8 | ||
Copyright (C) 2008 Free Software Foundation, Inc. | Copyright (C) 2008 Free Software Foundation, Inc. | ||
Line 100: | Line 107: | ||
This GDB was configured as "i686-pc-linux-gnu". | This GDB was configured as "i686-pc-linux-gnu". | ||
(gdb) q | (gdb) q | ||
- | [sbox-FREMANTLE_x86: ~] | + | [sbox-FREMANTLE_x86: ~] > |
+ | <br /><br /> | ||
- | Then run the | + | Then run the maemo version of gdb: |
- | [sbox-FREMANTLE_x86: ~] | + | [sbox-FREMANTLE_x86: ~] > native-gdb |
GNU gdb (GDB) 6.8.50.20090417-debian | GNU gdb (GDB) 6.8.50.20090417-debian | ||
Copyright (C) 2009 Free Software Foundation, Inc. | Copyright (C) 2009 Free Software Foundation, Inc. | ||
Line 116: | Line 124: | ||
<http://www.gnu.org/software/gdb/bugs/>. | <http://www.gnu.org/software/gdb/bugs/>. | ||
(gdb) q | (gdb) q | ||
- | [sbox-FREMANTLE_x86: ~] | + | [sbox-FREMANTLE_x86: ~] > |
+ | <br /><br /> | ||
- | To quit from gdb, type 'q' and | + | To quit from gdb, type 'q' and hit ENTER. |
- | The native-gdb is used here | + | The native-gdb is used here, since it allows also threads to be debugged. |
- | + | Both gdb versions are available in the Scratchbox X86 environment. The native-gdb should always be run instead of the Scratchbox version. | |
- | + | '''Preparing Internet Tablet for Debugging''' <code></code><br /> | |
+ | <br /><div style="border: 2px solid rgb(255, 215, 0); background-color: rgb(252, 233, 79); margin-left: 25px; margin-right: 25px; padding: 2px"> N.B. <br /><br /> Because additional software is going to be installed, and debugging will be performed in the real device that is running the official Sales Image, it is recommended that a full back-up of the device and any important files is made before continuing.</div><br /><br /> | ||
- | + | The gdb needs to be installed in the Internet Tablet device. It is recommended that first xterm (xterm should be installed by default) and then ssh are installed in the device before continuing. | |
- | # | + | # Start xterm. |
- | # Gain | + | # Gain root access to the device while running xterm. |
- | # Edit the | + | # Edit the /etc/apt/sources.list file in the device so that it contains the lines: |
deb http://repository.maemo.org/ fremantle/sdk free non-free | deb http://repository.maemo.org/ fremantle/sdk free non-free | ||
deb http://repository.maemo.org/ fremantle/tools free non-free | deb http://repository.maemo.org/ fremantle/tools free non-free | ||
+ | <br /><br /> | ||
+ | The /etc/apt/sources.list file can be edited with a text editor (e.g. vi), but the following commands given from the xterm are also valid: | ||
+ | |||
+ | # echo "deb http://repository.maemo.org/ fremantle/sdk free non-free" \ | ||
+ | >> /etc/apt/sources.list | ||
+ | # echo "deb http://repository.maemo.org/ fremantle/tools free non-free" \ | ||
+ | >> /etc/apt/sources.list | ||
+ | |||
+ | <br /><br /> | ||
+ | Important: it is not recommended to perform device software updates from the maemo sdk repositories (for example, 'apt-get upgrade' is not recommended for the device). The reason for this is that there might be some software packages in the SDK repositories that are so-called ''sdk variants'' . They might create a problem, if directly installed in the actual device. In this example, only gdb software is used from the repository. | ||
+ | # Perform an apt-get update in the device. The update command will refresh the package list database in the device. | ||
+ | # Perform an <code>apt-get install gdb</code> | ||
+ | You should now have the gdb and gdbserver (included in the gdb package) installed in the device. | ||
- | + | <br /><br /><div style="border: 2px solid rgb(255, 215, 0); background-color: rgb(252, 233, 79); margin-left: 25px; margin-right: 25px; padding: 2px"> N.B. <br /><br /> After using the maemo sdk repositories in the device /etc/apt/sources.list file, remove or comment the line out. This way, you will not accidentally get programs from the wrong repository to the device. See notes above.</div> | |
- | + | ||
- | + | ||
- | + | ||
- | + | '''Debugging Use Cases with Gdb''' | |
- | + | '''Debugging Command Line Application in Scratchbox X86 Environment with Gdb''' | |
- | + | ||
- | + | ||
One of the most common debugging case is performing debugging in the Scratchbox X86 environment. | One of the most common debugging case is performing debugging in the Scratchbox X86 environment. | ||
- | By now, the gdb is installed in the FREMANTLE_X86 target. Next, download the [https:// | + | By now, the gdb is installed in the FREMANTLE_X86 target. Next, download the [https://garage.maemo.org/svn/maemoexamples/tags/maemo_4.1/gdb_example/ gdb_example] sources. |
The example apps are: | The example apps are: | ||
- | * <code>gdb_example.c</code> is a very simple C application that has some functions that call each other in a row. This is used here to demonstrate how to get backtraces. | + | * the <code>gdb_example.c</code> is a very simple C application that has some functions that call each other in a row. This is used here to demonstrate how to get backtraces. |
- | * <code>gdb_example2.c</code> is a simple variant of the <code>gdb_example.c</code> that has some additional <code>sleep()</code> calls. This | + | * the <code>gdb_example2.c</code> is a simple variant of the <code>gdb_example.c</code> that has some additional <code>sleep()</code> calls. This will be used to demonstrate simple core dump debugging. |
- | Next, | + | Next, the small <code>gdb_example.c</code> file should be compiled as shown below, and the gdb debugger should be started. This simple example shows how to set breakpoints, and how to get a backtrace from the program. Backtrace tells what functions have been called and what parameters have been used. |
- | + | Compile the <code>gdb_example.c</code> application with the <code>-g</code> option like this: | |
- | + | ||
+ | [sbox-FREMANTLE_x86: ~/src/gdb_example] > gcc gdb_example.c -o gdb_example -g | ||
- | < | + | <br /><br /> |
- | + | ||
- | </ | + | |
- | + | Next, start the gdb with the <code>gdb_example</code> application as a parameter. | |
- | + | ||
+ | [sbox-FREMANTLE_x86: ~/src/gdb_example] > native-gdb gdb_example | ||
+ | GNU gdb (GDB) 6.8.50.20090417-debian | ||
+ | Copyright (C) 2009 Free Software Foundation, Inc. | ||
+ | License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html> | ||
+ | This is free software: you are free to change and redistribute it. | ||
+ | There is NO WARRANTY, to the extent permitted by law. Type "show copying" | ||
+ | and "show warranty" for details. | ||
+ | This GDB was configured as "i486-linux-gnu". | ||
+ | For bug reporting instructions, please see: | ||
+ | <http://www.gnu.org/software/gdb/bugs/>... | ||
+ | <br /><br /> | ||
- | + | Set the breakpoint (br) to function <code>example_3</code> | |
+ | |||
+ | (gdb) br example_3 | ||
+ | Breakpoint 1 at 0x8048424: file gdb_example.c, line 50. | ||
- | < | + | <br /><br /> |
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
Run the application under gdb giving a command line parameter foobar to the application. | Run the application under gdb giving a command line parameter foobar to the application. | ||
+ | |||
+ | (gdb) run foobar | ||
+ | Starting program: /home/user/src/gdb_example/gdb_example foobar | ||
+ | Now in main(). | ||
+ | Now in example_1(2) function. | ||
+ | Now in example_2(parameter here) function. | ||
+ | |||
+ | Breakpoint 1, example_3 () at gdb_example.c:50 | ||
+ | 50 printf("Now in example_3()\n"); | ||
- | < | + | <br /><br /> |
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | </ | + | |
- | The above shows that the running of the application stopped in function <code>example_3</code>. This happened because the breakpoint (<code>br example_3</code>) was set | + | The above shows that the running of the application stopped in function <code>example_3</code>. This happened, because the breakpoint (<code>br example_3</code>) was set. |
Now the backtrace (bt) can be listed from application to see what functions have been called. The list goes from recent to older. The oldest function was naturally the <code>main()</code> function at the end of the list. It shows also the parameters to the called functions. | Now the backtrace (bt) can be listed from application to see what functions have been called. The list goes from recent to older. The oldest function was naturally the <code>main()</code> function at the end of the list. It shows also the parameters to the called functions. | ||
+ | <nowiki> | ||
(gdb) bt | (gdb) bt | ||
#0 example_3 () at gdb_example.c:50 | #0 example_3 () at gdb_example.c:50 | ||
Line 221: | Line 230: | ||
#3 0x080483b3 in main (argc=2, argv=0xbffff5d4) at gdb_example.c:20 | #3 0x080483b3 in main (argc=2, argv=0xbffff5d4) at gdb_example.c:20 | ||
(gdb) | (gdb) | ||
+ | </nowiki> | ||
+ | <br /><br /> | ||
It can be convenient to see what the source code is for a line mentioned in the output: | It can be convenient to see what the source code is for a line mentioned in the output: | ||
Line 238: | Line 249: | ||
(gdb) | (gdb) | ||
+ | <br /><br /> | ||
Also the values of the variables can be inspected: | Also the values of the variables can be inspected: | ||
Line 253: | Line 265: | ||
40 printf("Now in example_2(%s) function.\n",a); | 40 printf("Now in example_2(%s) function.\n",a); | ||
+ | <br /><br /> | ||
- | To see the value of variable 'a' | + | To see the value of variable 'a' just type: |
(gdb) print a | (gdb) print a | ||
Line 260: | Line 273: | ||
(gdb) | (gdb) | ||
+ | <br /><br /> | ||
Essentially, debugging with gdb in the Scratchbox X86 target is similar to debugging with gdb in any Linux host. In this example, only a small subset of gdb's functionality has been used. | Essentially, debugging with gdb in the Scratchbox X86 target is similar to debugging with gdb in any Linux host. In this example, only a small subset of gdb's functionality has been used. | ||
- | + | '''Debugging Command Line Application in Internet Tablet Device''' | |
- | It is possible to debug an application in the Internet tablet device itself using gdb. Before starting, log in | + | It is possible to debug an application in the Internet tablet device itself using gdb. Before starting, log in on the device and install (if you have not done so yet) the gdb debugger to the device: |
/home/user # apt-get install gdb | /home/user # apt-get install gdb | ||
Line 271: | Line 285: | ||
/home/user # | /home/user # | ||
+ | <br /><br /> | ||
Here it is assumed that <code>ssh</code> and <code>xterm</code> are already installed in the tablet and that it is possible to log in on the device using ssh from a Linux PC. In addition, the maemo repository entries should be set in the <code>/etc/apt/sources.list</code> file as explained previously. | Here it is assumed that <code>ssh</code> and <code>xterm</code> are already installed in the tablet and that it is possible to log in on the device using ssh from a Linux PC. In addition, the maemo repository entries should be set in the <code>/etc/apt/sources.list</code> file as explained previously. | ||
- | Debugging with the gdb debugger in the device is similar to using gdb in a normal Linux PC environment. The limitations are mostly related to the available free RAM, meaning that in the worst case, memory might run out while trying to debug an application in the device. | + | Debugging with the gdb debugger in the device is similar to using gdb in a normal Linux PC environment. The limitations are mostly related to the available free RAM memory, meaning that in the worst case, memory might run out while trying to debug an application in the device. |
This example follows the basic logic of the first example, but this time is performed in the device. | This example follows the basic logic of the first example, but this time is performed in the device. | ||
- | |||
<ol> | <ol> | ||
<li> Compile the <code>gdb_example.c</code> application in the Scratchbox for armel architecture. | <li> Compile the <code>gdb_example.c</code> application in the Scratchbox for armel architecture. | ||
<pre> | <pre> | ||
- | [sbox-FREMANTLE_X86: ~] | + | [sbox-FREMANTLE_X86: ~] > sb-conf select FREMANTLE_ARMEL |
Hangup | Hangup | ||
Shell restarting... | Shell restarting... | ||
- | [sbox-FREMANTLE_ARMEL: ~] | + | [sbox-FREMANTLE_ARMEL: ~] > pwd |
/home/user | /home/user | ||
- | [sbox-FREMANTLE_ARMEL: ~] | + | [sbox-FREMANTLE_ARMEL: ~] > cd src/gdb_example |
- | [sbox-FREMANTLE_ARMEL: ~/src/gdb_example] | + | [sbox-FREMANTLE_ARMEL: ~/src/gdb_example] > gcc gdb_example.c -o gdb_example -g |
- | [sbox-FREMANTLE_ARMEL: ~/src/gdb_example] | + | [sbox-FREMANTLE_ARMEL: ~/src/gdb_example] > file gdb_example |
gdb_example: ELF 32-bit LSB executable, ARM, version 1 (SYSV), for GNU/Linux 2.6.14, | gdb_example: ELF 32-bit LSB executable, ARM, version 1 (SYSV), for GNU/Linux 2.6.14, | ||
dynamically linked (uses shared libs), not stripped | dynamically linked (uses shared libs), not stripped | ||
- | [sbox-FREMANTLE_ARMEL: ~/src/gdb_example] | + | [sbox-FREMANTLE_ARMEL: ~/src/gdb_example] > |
</pre></li> | </pre></li> | ||
- | + | <li> Copy the armel version of the <code>gdb_example</code> to the tablet. You need to have the <code>sshd</code> daemon up and running in the device before you can copy files with <code>scp</code>. The IP address is an example, and your device IP address can be different. <br /><br /> | |
- | + | ||
- | <li> Copy the armel version of the <code>gdb_example</code> to the tablet. You need to have the <code>sshd</code> daemon up and running in the device before you can copy files with <code>scp</code>. The IP address is an example, and your device IP address can be different. | + | |
- | + | ||
<pre> | <pre> | ||
- | [sbox-FREMANTLE_ARMEL: ~/src/gdb_example] | + | [sbox-FREMANTLE_ARMEL: ~/src/gdb_example] > scp gdb_example.c \ |
gdb_example user@192.168.2.15: | gdb_example user@192.168.2.15: | ||
user@192.168.2.15's password: ........... | user@192.168.2.15's password: ........... | ||
Line 304: | Line 315: | ||
gdb_example 100% 7118 7.0KB/s 00:00 | gdb_example 100% 7118 7.0KB/s 00:00 | ||
</pre></li> | </pre></li> | ||
- | + | <li> Log in on the device with ssh with username user. <br /><br /> | |
- | + | ||
- | <li> Log in on the device with ssh with username user. | + | |
- | + | ||
<pre> | <pre> | ||
- | [sbox-FREMANTLE_ARMEL: ~/src/gdb_example] | + | [sbox-FREMANTLE_ARMEL: ~/src/gdb_example] > ssh root@192.168.2.15 |
root@192.168.2.15's password: .......... | root@192.168.2.15's password: .......... | ||
Line 317: | Line 325: | ||
~# cd ~user | ~# cd ~user | ||
</pre></li> | </pre></li> | ||
- | + | <li> Start the gdb debugger with the <code>gdb_example</code> application. <br /><br /> | |
- | + | ||
- | <li> Start the gdb debugger with the <code>gdb_example</code> application. | + | |
- | + | ||
<pre> | <pre> | ||
/home/user# gdb ./gdb_example | /home/user# gdb ./gdb_example | ||
Line 328: | Line 333: | ||
</pre></li> | </pre></li> | ||
</ol> | </ol> | ||
- | |||
- | |||
You should now be able to debug this small example application in a similar way as in the previous example. | You should now be able to debug this small example application in a similar way as in the previous example. | ||
- | + | '''Debugging Core Files in Device''' | |
- | This section explains how to debug core files in the Internet Tablet. The default location for core dumps is <code>/home/user/MyDocs/core-dumps</code>. There | + | This section explains how to debug core files in the Internet Tablet. The default location for core dumps is <code>/home/user/MyDocs/core-dumps</code>. There could be a limit for core dump size. You can check this by executing |
Nokia-NXX-31-10:/home/user# ulimit -c | Nokia-NXX-31-10:/home/user# ulimit -c | ||
unlimited | unlimited | ||
+ | <br /><br /> If the limit is too low, set it bigger, for example: | ||
- | + | ||
- | + | ||
Nokia-NXX-31-10:/home/user# ulimit -c unlimited | Nokia-NXX-31-10:/home/user# ulimit -c unlimited | ||
unlimited | unlimited | ||
- | + | <br /><br /> Next, the small example application <code>gdb_example2</code> will be used to demonstrate how to debug the core file. | |
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | Next, the small example application <code>gdb_example2</code> will be used to demonstrate how to debug the core file. | + | |
<ol> | <ol> | ||
- | <li> Compile the <code>gdb_example2</code> in the Scratchbox armel target, and just copy the file to the device using <code>scp</code>. Then start the <code>gdb_example2</code> in the device like this: | + | <li> Compile the <code>gdb_example2</code> in the Scratchbox armel target, and just copy the file to the device using <code>scp</code>. Then start the <code>gdb_example2</code> in the device like this: <br /><br /> |
- | + | ||
<pre> | <pre> | ||
Nokia-NXX-31-10:/home/user # ./gdb_example2 & | Nokia-NXX-31-10:/home/user # ./gdb_example2 & | ||
Line 365: | Line 357: | ||
</pre></li> | </pre></li> | ||
- | + | <li> The <code>gdb_example2</code> is now running in the background, and it starts to dump its output to the screen. There are some <code>sleep()</code> calls in the <code>gdb_example2</code>, so that you have time to kill it with the SIGSEGV signal. Now just make it to generate a core dump. Assuming that the process is referred to as %1, just use the kill command as below and press the ENTER key a couple of times: <br /><br /> | |
- | <li> The <code>gdb_example2</code> is now running in the background, and it starts to dump its output to the screen. There are some <code>sleep()</code> calls in <code>gdb_example2</code>, so that you have time to kill it with the SIGSEGV signal. Now just make it to generate a core dump. Assuming that the process is referred to as %1, use the kill command as below and press the ENTER key a couple of times: | + | |
- | + | ||
<pre> | <pre> | ||
Nokia-NXX-31-10:/home/user # kill -SIGSEGV %1 | Nokia-NXX-31-10:/home/user # kill -SIGSEGV %1 | ||
Line 373: | Line 363: | ||
[1] + Segmentation fault (core dumped) ./gdb_example2 | [1] + Segmentation fault (core dumped) ./gdb_example2 | ||
</pre></li> | </pre></li> | ||
- | + | <li> You should now have a compressed core dump data file under the <code>/media/mmc1/core-dumps</code> directory. Its name should include the name of the file and end with the PID number of the <code>gdb_example2</code> program. Check that you got it (the number shown below, 1581, will naturally be different in your environment): <br /><br /> | |
- | + | ||
- | <li> You now have a compressed core dump data file under the <code>/ | + | |
- | + | ||
<pre> | <pre> | ||
/home/user # ls -l MyDocs/core-dumps/ | /home/user # ls -l MyDocs/core-dumps/ | ||
Line 383: | Line 370: | ||
</pre></li> | </pre></li> | ||
- | + | <li> You have to extract the compressed data before you can use it with gdb. You need to install sp-rich-core-postproc package and run the extract command which creates a new directory (given as a second parameter) where to extract data: <br /><br /> | |
- | <li> | + | |
- | + | ||
<pre> | <pre> | ||
Nokia-NXX-31-10:/home/user # apt-get install sp-rich-core-postproc | Nokia-NXX-31-10:/home/user # apt-get install sp-rich-core-postproc | ||
Line 392: | Line 377: | ||
/media/mmc1/core-dumps/gdb_example2-7829-11-1581.rcore.lzo coredir | /media/mmc1/core-dumps/gdb_example2-7829-11-1581.rcore.lzo coredir | ||
</pre> | </pre> | ||
+ | The newly-created coredir includes lots of information in different files about the system. The file to pass for the gdb is named <code>coredump</code>.</li> | ||
- | + | <li> The <code>gdb_example2</code> is linked against the <code>libc</code> library. If you want to be able to resolve symbols also for the library during debugging, you need to install <code>libc6-dbg</code> package in the device. ''The same rule applies to other libraries that your application might be linked against.'' See the further notes about the DBG packages in this material. | |
- | + | Now install the <code>libc6-dbg</code> package to get symbols for the library. | |
- | + | <br /><br /> | |
- | <li> The <code>gdb_example2</code> is linked against the <code>libc</code> library. If you want to be able to resolve symbols also for the library during debugging, install <code>libc6-dbg</code> package in the device. ''The same rule applies to other libraries that your application might be linked against.'' See the further notes about the DBG packages in this material. Now install the <code>libc6-dbg</code> package to get symbols for the library. | + | |
- | + | ||
- | + | ||
<pre> | <pre> | ||
Nokia-NXX-31-10:/home/user # apt-get install libc6-dbg | Nokia-NXX-31-10:/home/user # apt-get install libc6-dbg | ||
Line 410: | Line 393: | ||
/home/user # | /home/user # | ||
</pre></li> | </pre></li> | ||
- | + | <li> Now you can debug the core file together with the <code>gdb_example2</code> binary that you compiled with the -g flag. Try and see where the execution of the <code>gdb_example2</code> was when you used the <code>-SIGSEGV</code> signal. Start the gdb and give the <code>gdb_example2</code> as the first parameter, and the core file as the second parameter: <br /><br /> | |
- | + | ||
- | <li> Now you can debug the core file together with the <code>gdb_example2</code> binary that you compiled with the -g flag. Try and see where the execution of the <code>gdb_example2</code> was when you used the <code>-SIGSEGV</code> signal. Start gdb and give <code>gdb_example2</code> as the first parameter, and the core file as the second parameter: | + | |
- | + | ||
<pre> | <pre> | ||
Nokia-NXX-31-10:/home/user # gdb ./gdb_example2 MyDocs/core-dumps/coredir/coredump | Nokia-NXX-31-10:/home/user # gdb ./gdb_example2 MyDocs/core-dumps/coredir/coredump | ||
Line 439: | Line 419: | ||
(gdb) | (gdb) | ||
</pre> | </pre> | ||
- | + | <br /><br /> | |
- | + | The example above shows that now gdb is using debug symbols from <code>/usr/lib/debug/lib/libc-2.5.so</code>. Had the libc6-dbg package not been installed, the gdb would not have information available about the libraries' debug symbols. | |
- | The example above shows that now gdb is using debug symbols from <code>/usr/lib/debug/lib/libc-2.5.so</code>. Had the libc6-dbg package not been installed, gdb would not have information available about the libraries' debug symbols. Now, gdb is waiting for a command, so just give the bt (backtrace) command. You should see something similar to this: | + | Now, the gdb is waiting for a command, so just give the bt (backtrace) command. You should see something similar to this: |
- | + | <br /><br /> | |
- | + | ||
<pre> | <pre> | ||
(gdb) bt | (gdb) bt | ||
Line 451: | Line 430: | ||
#3 0x00008408 in main (argc=1, argv=0xbe8b2674) at gdb_example2.c:21 | #3 0x00008408 in main (argc=1, argv=0xbe8b2674) at gdb_example2.c:21 | ||
</pre> | </pre> | ||
- | + | <br /><br /><div style="border: 2px solid rgb(255, 215, 0); background-color: rgb(252, 233, 79); margin-left: 25px; margin-right: 25px; padding: 2px"> N.B. <br /><br /> For this simple example, the available <code>libc6-dbg</code> package was installed before starting to debug the <code>gdb_example2</code> application. Backtraces work only if debug packages are installed also for the libraries through which the backtrace goes.</div><br /><br /> | |
- | + | ||
- | + | ||
- | + | ||
- | + | ||
Depending on at what point the <code>kill -SIGSEGV</code> command was given, the output may be different. In this example, the process was hit when it was calling the sleep function inside the <code>example_1</code> function in file <code>gdb_example2.c</code>. It can also be seen that the <code>sleep()</code> function has further called the <code>nanosleep()</code> function, and that is when it got the <code>-SIGSEGV</code> signal (see the note above). | Depending on at what point the <code>kill -SIGSEGV</code> command was given, the output may be different. In this example, the process was hit when it was calling the sleep function inside the <code>example_1</code> function in file <code>gdb_example2.c</code>. It can also be seen that the <code>sleep()</code> function has further called the <code>nanosleep()</code> function, and that is when it got the <code>-SIGSEGV</code> signal (see the note above). | ||
</li> | </li> | ||
</ol> | </ol> | ||
- | + | '''Debugging Core File from Device Inside Scratchbox''' | |
Because the binaries and libraries in the device are prelinked, successful debugging inside the Scratchbox environment using the programs core file (from the device) would require that: | Because the binaries and libraries in the device are prelinked, successful debugging inside the Scratchbox environment using the programs core file (from the device) would require that: | ||
- | * you copy the relevant libraries (the ones | + | * you copy the relevant libraries (i.e. the ones the application is using) from the device to the Scratchbox. Otherwise addresses in the prelinked and unprelinked libraries would not match, and gdb backtraces would not load the library. |
- | + | ||
* If the core file debugging is performed in the Scratchbox ARMEL environment, the native gdb program needs to be used instead of the one provided by Scratchbox. See the previous section on how to set the native gdb as the default one. | * If the core file debugging is performed in the Scratchbox ARMEL environment, the native gdb program needs to be used instead of the one provided by Scratchbox. See the previous section on how to set the native gdb as the default one. | ||
- | After copying the <code>/lib/libc6</code> library from the device and setting the native gdb to be used, the application can be debugged normally | + | After copying the <code>/lib/libc6</code> library from the device and setting the native gdb to be used, the application can be debugged normally. |
+ | <br /><br /><div style="border: 2px solid rgb(255, 215, 0); background-color: rgb(252, 233, 79); margin-left: 25px; margin-right: 25px; padding: 2px"> N.B. <br /><br /> Keep in mind that generally the Scratchbox tools override the target tools.</div> | ||
- | + | '''Debugging UI Applications in Scratchbox X86''' | |
Many maemo applications use the graphical UI, and debugging these applications differs slightly from debugging simple command line applications. | Many maemo applications use the graphical UI, and debugging these applications differs slightly from debugging simple command line applications. | ||
- | Here maemopad will be used as an example application to debug in the X86 target with gdb. | + | Here the maemopad will be used as an example application to debug in the X86 target with gdb. |
- | If the Scratchbox environment is set up correctly as explained above, these steps should be easy to follow to perform UI debugging with | + | If the Scratchbox environment is set up correctly as explained above, these steps should be easy to follow to perform UI debugging with maemopad application. |
<ol> | <ol> | ||
- | <li> Activate the X86 target, go to the testing directory and download the source package of maemopad. | + | <li> Activate the X86 target, go to the testing directory and download the source package of maemopad application. <br /><br /> |
- | + | ||
- | + | ||
<pre> | <pre> | ||
- | [sbox-FREMANTLE_ARMEL] | + | [sbox-FREMANTLE_ARMEL] sb-conf select FREMANTLE_X86 |
- | [sbox-FREMANTLE_X86] | + | [sbox-FREMANTLE_X86] cd ~/src/ |
- | [sbox-FREMANTLE_X86 ~/src] | + | [sbox-FREMANTLE_X86 ~/src] mkdir maemopad |
- | [sbox-FREMANTLE_X86 ~/src/maemopad] | + | [sbox-FREMANTLE_X86 ~/src/maemopad] cd maemopad |
- | [sbox-FREMANTLE_X86 ~/src/maemopad] | + | [sbox-FREMANTLE_X86 ~/src/maemopad] apt-get source maemopad |
Reading package lists... Done | Reading package lists... Done | ||
Building dependency tree... Done | Building dependency tree... Done | ||
Line 498: | Line 471: | ||
dpkg-source: unpacking maemopad_2.5.tar.gz | dpkg-source: unpacking maemopad_2.5.tar.gz | ||
</pre></li> | </pre></li> | ||
- | + | <li> Check that you have the correct files. <br /><br /> | |
- | + | ||
- | <li> Check that you have the correct files. | + | |
- | + | ||
<pre> | <pre> | ||
- | [sbox-FREMANTLE_X86: ~/src/maemopad] | + | [sbox-FREMANTLE_X86: ~/src/maemopad] > ls -l |
total 352 | total 352 | ||
drwxrwxr-x 6 maemo maemo 4096 Jul 28 14:09 maemopad-2.5 | drwxrwxr-x 6 maemo maemo 4096 Jul 28 14:09 maemopad-2.5 | ||
Line 509: | Line 479: | ||
-rw-rw-r-- 1 maemo maemo 346129 Jul 6 16:02 maemopad_2.5.tar.gz | -rw-rw-r-- 1 maemo maemo 346129 Jul 6 16:02 maemopad_2.5.tar.gz | ||
</pre></li> | </pre></li> | ||
- | + | <li> Go to the <code>maemopad-2.5</code> source directory, and set the <code>DEB_BUILD_OPTIONS</code> environment variable, so that the generated binaries are not stripped. Then build the maemopad package with <code>dpkg-buildpackage</code> command as shown here: <br /><br /> | |
- | + | ||
- | <li> Go to the <code>maemopad-2.5</code> source directory, and set the <code>DEB_BUILD_OPTIONS</code> environment variable, so that the generated binaries are not stripped. Then build the maemopad package with <code>dpkg-buildpackage</code> command as shown here: | + | |
- | + | ||
<pre> | <pre> | ||
- | [sbox-FREMANTLE_X86: ~/src/maemopad] | + | [sbox-FREMANTLE_X86: ~/src/maemopad] > cd maemopad-2.5 |
- | [sbox-FREMANTLE_X86: ~/src/maemopad/maemopad-2.5] | + | [sbox-FREMANTLE_X86: ~/src/maemopad/maemopad-2.5] > export DEB_BUILD_OPTIONS=debug,\ |
nostrip | nostrip | ||
- | [sbox-FREMANTLE_X86: ~/src/maemopad/maemopad-2.5] | + | [sbox-FREMANTLE_X86: ~/src/maemopad/maemopad-2.5] > dpkg-buildpackage -rfakeroot -d |
dpkg-buildpackage: source package is maemopad | dpkg-buildpackage: source package is maemopad | ||
dpkg-buildpackage: source version is 2.5 | dpkg-buildpackage: source version is 2.5 | ||
Line 525: | Line 492: | ||
.... etc .... | .... etc .... | ||
</pre> | </pre> | ||
- | + | <br /><br /><div style="border: 2px solid rgb(255, 215, 0); background-color: rgb(252, 233, 79); margin-left: 25px; margin-right: 25px; padding: 2px"> N.B. <br /><br /> In this example, the standard export DEB_BUILD_OPTIONS=debug,nostrip environment variable is used, but there might be source packages that do not support these debug,nostrip options. In that case, one must make sure that the source is compiled with <code>-g</code> flag (usually this option can be added to the <code>CFLAGS</code> variable in the <code>debian/rules</code> file), and that the produced binaries will not be stripped. In the long run, it is better to modify the source package to generate a separate debug symbol (<code>-dbg</code>) package. This requires modifying both the <code>debian/rules</code> and <code>debian/control</code> files. In fact, maemopad already builds a separate debug package, but this example makes no use of it to demonstrate the simpler case. </div></li> | |
- | In this example, the standard | + | <li> You should now have maemopad binaries generated so that they have the debug symbols in them. Check that you get a <code>not stripped</code> flag from the maemopad binary: <br /><br /> |
- | + | ||
- | + | ||
- | <li> You should now have maemopad binaries generated so that they have the debug symbols in them. Check that you get a <code>not stripped</code> flag from the maemopad binary: | + | |
- | + | ||
- | + | ||
<pre> | <pre> | ||
- | [sbox-FREMANTLE_X86: ~/src/maemopad/maemopad-2.5] | + | [sbox-FREMANTLE_X86: ~/src/maemopad/maemopad-2.5] > file debian/maemopad/usr/bin/\ |
maemopad | maemopad | ||
debian/tmp/usr/bin/maemopad: ELF 32-bit LSB executable, Intel 80386, version 1 (SYSV), | debian/tmp/usr/bin/maemopad: ELF 32-bit LSB executable, Intel 80386, version 1 (SYSV), | ||
for GNU/Linux 2.0.0, dynamically linked (uses shared libs), not stripped | for GNU/Linux 2.0.0, dynamically linked (uses shared libs), not stripped | ||
</pre></li> | </pre></li> | ||
- | + | <li> You should now have a <code>maemopad_2.5_i386.deb</code> file in the <code>~/src/maemopad</code> directory. Check that you have it: <br /><br /> | |
- | + | ||
- | <li> You should now have a <code>maemopad_2.5_i386.deb</code> file in the <code>~/src/maemopad</code> directory. Check that you have it: | + | |
- | + | ||
<pre> | <pre> | ||
- | [sbox-FREMANTLE_X86: ~/src/maemopad] | + | [sbox-FREMANTLE_X86: ~/src/maemopad] > ls -l |
total 420 | total 420 | ||
drwxrwxr-x 6 maemo maemo 4096 Jul 28 14:18 maemopad-2.5 | drwxrwxr-x 6 maemo maemo 4096 Jul 28 14:18 maemopad-2.5 | ||
Line 552: | Line 511: | ||
-rw-r--r-- 1 maemo maemo 50242 Jul 28 14:18 maemopad_2.5_i386.deb | -rw-r--r-- 1 maemo maemo 50242 Jul 28 14:18 maemopad_2.5_i386.deb | ||
</pre></li> | </pre></li> | ||
- | + | <li> Install the newly compiled <code>maemopad_2.5_i386.deb</code> file inside the Scratchbox environment: <br /><br /> | |
- | + | ||
- | <li> Install the newly compiled <code>maemopad_2.5_i386.deb</code> file inside the Scratchbox environment: | + | |
- | + | ||
<pre> | <pre> | ||
- | [sbox-FREMANTLE_X86: ~/src/maemopad] | + | [sbox-FREMANTLE_X86: ~/src/maemopad] > dpkg -i maemopad_2.5_i386.deb |
... output from dpkg ... | ... output from dpkg ... | ||
</pre></li> | </pre></li> | ||
- | + | <li> Start the <code>Xephyr</code> server outside the Scratchbox: <br /><br /> | |
- | + | ||
- | <li> Start the <code>Xephyr</code> server outside the Scratchbox: | + | |
- | + | ||
<pre> | <pre> | ||
Linux-PC$ Xephyr :2 -host-cursor -screen 800x480x16 -dpi 96 -ac -kb & | Linux-PC$ Xephyr :2 -host-cursor -screen 800x480x16 -dpi 96 -ac -kb & | ||
</pre></li> | </pre></li> | ||
- | + | <li> Start the Application Framework from inside the Scratchbox X86 target: <br /><br /> | |
- | + | ||
- | <li> Start the Application Framework from inside the Scratchbox X86 target: | + | |
- | + | ||
<pre> | <pre> | ||
- | [sbox-FREMANTLE_X86: ~/src/maemopad/maemopad-2.1] | + | [sbox-FREMANTLE_X86: ~/src/maemopad/maemopad-2.1] > export DISPLAY=:2 |
- | [sbox-FREMANTLE_X86: ~/src/maemopad/maemopad-2.1] | + | [sbox-FREMANTLE_X86: ~/src/maemopad/maemopad-2.1] > af-sb-init.sh start |
... lots of output from various programs ... | ... lots of output from various programs ... | ||
</pre> | </pre> | ||
- | + | <br /><br /> | |
- | You should now have the application framework up and running and the <code>Xephyr</code> window should contain the SDK UI.</li> | + | You should now have the application framework up and running and the <code>Xephyr</code> window should contain the normal SDK UI.</li> |
- | + | <li> Move to the source directory: <br /><br /> | |
- | + | ||
- | <li> Move to the source directory: | + | |
- | + | ||
<pre> | <pre> | ||
- | [sbox-FREMANTLE_X86: ~/src/maemopad/maemopad-2.5] | + | [sbox-FREMANTLE_X86: ~/src/maemopad/maemopad-2.5] > cd src |
</pre></li> | </pre></li> | ||
- | + | <li> In the src directory, you should have the files: <br /><br /> | |
- | + | ||
- | <li> In the src directory, you should have the files: | + | |
- | + | ||
<pre> | <pre> | ||
- | [sbox-FREMANTLE_X86: ~/src/maemopad/maemopad-2.5/src] | + | [sbox-FREMANTLE_X86: ~/src/maemopad/maemopad-2.5/src] ls -l |
total 280 | total 280 | ||
-rw-rw-r-- 1 maemo maemo 25491 Jul 28 14:18 Makefile | -rw-rw-r-- 1 maemo maemo 25491 Jul 28 14:18 Makefile | ||
Line 602: | Line 546: | ||
-rw-rw-r-- 1 maemo maemo 2193 Jul 28 14:09 main.c | -rw-rw-r-- 1 maemo maemo 2193 Jul 28 14:09 main.c | ||
</pre></li> | </pre></li> | ||
- | + | <li> In this example, a debugging breakpoint will be set at the callback function <code>maemopad_window_on_menu_file_new()</code> located in the <code>maemopad-window.c</code> file. This function is called when the user clicks the New button from the maemopad menu. Set the debugging breakpoint like this: <br /><br /> | |
- | + | ||
- | <li> In this example, a debugging breakpoint will be set at the callback function <code>maemopad_window_on_menu_file_new()</code> located in the <code>maemopad-window.c</code> file. This function is called when the user clicks the New button from the maemopad menu. Set the debugging breakpoint like this: | + | |
- | + | ||
<pre> | <pre> | ||
- | [sbox-FREMANTLE_X86: ~/src/maemopad/maemopad-2.5/src] | + | [sbox-FREMANTLE_X86: ~/src/maemopad/maemopad-2.5/src] > run-standalone.sh \ |
gdb maemopad | gdb maemopad | ||
(gdb) br maemopad_window_on_menu_file_new | (gdb) br maemopad_window_on_menu_file_new | ||
Breakpoint 1 at 0x804b457: file maemopad-window.c, line 283. | Breakpoint 1 at 0x804b457: file maemopad-window.c, line 283. | ||
</pre></li> | </pre></li> | ||
- | + | <li> Start the maemopad application from the <code>gdb</code>. <br /><br /> | |
- | + | ||
- | <li> Start the maemopad application from <code>gdb</code>. | + | |
- | + | ||
<pre> | <pre> | ||
(gdb) run | (gdb) run | ||
Line 621: | Line 559: | ||
[Thread debugging using libthread_db enabled] | [Thread debugging using libthread_db enabled] | ||
</pre> | </pre> | ||
- | + | <br /><br /><div style="border: 2px solid rgb(255, 215, 0); background-color: rgb(252, 233, 79); margin-left: 25px; margin-right: 25px; padding: 2px"> N.B. <br /><br /> Thread-debugging: Now the native gdb program is used. If you need to debug threads in the application, you need to use the native gdb linked against the same thread library that your application is using. Remember that the Scratchbox <code>gdb</code> is not suitable for this purpose. To use the native <code>gdb</code>, <code>native-gdb</code> needs to be used, as mentioned earlier in this material.</div></li> | |
- | + | <li> Now you should be able to see the maemopad application inside the Xephyr window, and you should be able to use it normally. Next, click the upper menu and select the item HELP. In your gdb terminal window you should now see : <br /><br /> | |
- | + | ||
- | </li> | + | |
- | + | ||
- | + | ||
- | <li> Now you should be able to see the maemopad application inside the Xephyr window, and you should be able to use it normally. Next, click the upper menu and select the item HELP. In your gdb terminal window you should now see : | + | |
- | + | ||
<pre> | <pre> | ||
Breakpoint 1, maemopad_window_on_menu_file_new (button=0x80cf0a8, | Breakpoint 1, maemopad_window_on_menu_file_new (button=0x80cf0a8, | ||
Line 634: | Line 566: | ||
283 MaemopadWindow *self = MAEMOPAD_WINDOW (data); | 283 MaemopadWindow *self = MAEMOPAD_WINDOW (data); | ||
</pre></li> | </pre></li> | ||
- | + | <li> The breakpoint that you set above is now reached, and execution of maemopad application is stopped. The gdb debugger waits for your command now. Try something simple, like using the list command to see where the execution of the application is going. You should get: <br /><br /> | |
- | + | <pre> | |
- | <li> The breakpoint that you set above is now reached, and execution of maemopad is stopped. The debugger waits for your command now. Try something simple, like using the list command to see where the execution of the application is going. You should get: | + | |
- | + | ||
- | <pre> | + | |
(gdb) list | (gdb) list | ||
278 } | 278 } | ||
Line 649: | Line 578: | ||
285 | 285 | ||
286 /* save changes note if file is edited */ | 286 /* save changes note if file is edited */ | ||
- | 287 if (self- | + | 287 if (self->file_edited) { |
</pre></li> | </pre></li> | ||
- | + | <li> You can now debug the maemopad normally. Try and see, if you can execute the maemopad step by step so that you can get the new writing area on screen. Enter the s command like this: <br /><br /> | |
- | + | ||
- | <li> You can now debug maemopad normally. Try and see, if you can execute the maemopad step by step so that you can get the new writing area on screen. Enter the s command like this: | + | |
- | + | ||
<pre> | <pre> | ||
(gdb) s | (gdb) s | ||
Line 663: | Line 589: | ||
(gdb) | (gdb) | ||
</pre></li> | </pre></li> | ||
- | + | <li> You can also try the bt (backtrace) command to see what functions were called. You should see a list of functions that have been called, similar to the following: <br /><br /> | |
- | + | ||
- | <li> You can also try the bt (backtrace) command to see what functions were called. You should see a list of functions that have been called, similar to the following: | + | |
- | + | ||
<pre> | <pre> | ||
(gdb) bt | (gdb) bt | ||
Line 678: | Line 601: | ||
.1/gobject/gmarshal.c:77 | .1/gobject/gmarshal.c:77 | ||
.... | .... | ||
- | + | <snip> | |
.... | .... | ||
#30 0xb76136f8 in IA__g_main_loop_run (loop=0x80be058) | #30 0xb76136f8 in IA__g_main_loop_run (loop=0x80be058) | ||
Line 686: | Line 609: | ||
#32 0x0804a0f7 in main (argc=0, argv=0x60203006) at main.c:78 | #32 0x0804a0f7 in main (argc=0, argv=0x60203006) at main.c:78 | ||
</pre> | </pre> | ||
- | + | <br /><br /> | |
At the top of the backtrace list are functions that were called last, and at the bottom of the list are the applications <code>main()</code> function and then the <code>gtk_main()</code>, etc.</li> | At the top of the backtrace list are functions that were called last, and at the bottom of the list are the applications <code>main()</code> function and then the <code>gtk_main()</code>, etc.</li> | ||
- | + | <li> If you now continued debugging with <code>s</code> (step) command, you would end up looping the gtk main event loop. However, it is better to just give the <code>c</code> (continue) command: <br /><br /> | |
- | + | ||
- | <li> If you now continued debugging with | + | |
- | + | ||
<pre> | <pre> | ||
(gdb) c | (gdb) c | ||
Continuing. | Continuing. | ||
</pre></li> | </pre></li> | ||
- | + | <li> Now the maemopad application is running. If you select the New menu item again, the breakpoint is still set. So if you click New you would get again: <br /><br /> | |
- | + | ||
- | <li> Now the maemopad application is running. If you select the New menu item again, the breakpoint is still set. So if you click New you would get again: | + | |
- | + | ||
<pre> | <pre> | ||
Breakpoint 1, maemopad_window_on_menu_file_new (button=0x80cf0a8, | Breakpoint 1, maemopad_window_on_menu_file_new (button=0x80cf0a8, | ||
Line 706: | Line 623: | ||
(gdb) | (gdb) | ||
</pre></li> | </pre></li> | ||
- | + | <li> You can clear a specific breakpoint using the clear command. Remove the breakpoint in <code>maemopad_window_on_menu_file_new</code> function: <br /><br /> | |
- | + | ||
- | <li> You can clear a specific breakpoint using the clear command. Remove the breakpoint in <code>maemopad_window_on_menu_file_new</code> function: | + | |
- | + | ||
<pre> | <pre> | ||
(gdb) clear maemopad_window_on_menu_file_new | (gdb) clear maemopad_window_on_menu_file_new | ||
Line 716: | Line 630: | ||
Continuing. | Continuing. | ||
</pre></li> | </pre></li> | ||
+ | <li> Because the breakpoint is now cleared, you can use the application normally under the <code>Xephyr</code>.</li> | ||
</ol> | </ol> | ||
- | + | == 15.2.4 Debugging Hildon Desktop Plug-ins == | |
- | + | ||
- | == | + | |
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
This section explains how to debug Hildon Desktop plug-ins in maemo environment. | This section explains how to debug Hildon Desktop plug-ins in maemo environment. | ||
Line 732: | Line 639: | ||
Desktop and Control Panel applications are both launched by the maemo-launcher daemon. Their plug-ins are all shared libraries (i.e. .so files). Writing these plug-ins is explained in maemo.org documentation. | Desktop and Control Panel applications are both launched by the maemo-launcher daemon. Their plug-ins are all shared libraries (i.e. .so files). Writing these plug-ins is explained in maemo.org documentation. | ||
- | + | '''Downloading and Compiling the Example Apps''' | |
For this example, you need to first download, compile, and install the hello-world-app package. | For this example, you need to first download, compile, and install the hello-world-app package. | ||
<ol> | <ol> | ||
- | <li> Download the source code of hello-world-app: | + | <li> Download the source code of hello-world-app: <br /><br /> |
- | + | ||
<pre> | <pre> | ||
- | [sbox-FREMANTLE_X86: ~/src] | + | [sbox-FREMANTLE_X86: ~/src] svn export https://garage.maemo.org/svn/\ |
- | maemoexamples/ | + | maemoexamples/trunk/hello-world-app/ |
</pre></li> | </pre></li> | ||
- | + | <li> Build the package like this: <br /><br /> | |
- | + | ||
- | <li> Build the package like this: | + | |
- | + | ||
<pre> | <pre> | ||
- | [sbox-FREMANTLE_X86: ~/src] | + | [sbox-FREMANTLE_X86: ~/src] > cd hello-world-app |
- | [sbox-FREMANTLE_X86: ~/src/hello-world-app] | + | [sbox-FREMANTLE_X86: ~/src/hello-world-app] > |
- | [sbox-FREMANTLE_X86: ~/src/hello-world-app] | + | [sbox-FREMANTLE_X86: ~/src/hello-world-app] > export DEB_BUILD_OPTIONS=debug,nostrip |
- | [sbox-FREMANTLE_X86: ~/src/hello-world-app] | + | [sbox-FREMANTLE_X86: ~/src/hello-world-app] > ./autogen.sh |
... etc ... | ... etc ... | ||
- | [sbox-FREMANTLE_X86: ~/src/hello-world-app] | + | [sbox-FREMANTLE_X86: ~/src/hello-world-app] > dpkg-buildpackage -rfakeroot |
dpkg-buildpackage: source package is hello-world-app | dpkg-buildpackage: source package is hello-world-app | ||
dpkg-buildpackage: source version is 2.2 | dpkg-buildpackage: source version is 2.2 | ||
Line 772: | Line 675: | ||
cluded) | cluded) | ||
- | [sbox-FREMANTLE_X86: ~/src/hello-world-app] | + | [sbox-FREMANTLE_X86: ~/src/hello-world-app] > |
</pre></li> | </pre></li> | ||
- | + | <li> You should now have: <br /><br /> | |
- | <li> You should now have: | + | <pre> |
- | + | [sbox-FREMANTLE_X86: ~/src/hello-world-app] > cd .. | |
- | <pre> | + | [sbox-FREMANTLE_X86: ~/src] > ls -lt |
- | [sbox-FREMANTLE_X86: ~/src/hello-world-app] | + | |
- | [sbox-FREMANTLE_X86: ~/src] | + | |
total 348 | total 348 | ||
-rw-rw-r-- 1 maemo maemo 1001 Aug 17 14:30 hello-world-app_2.2_i386.changes | -rw-rw-r-- 1 maemo maemo 1001 Aug 17 14:30 hello-world-app_2.2_i386.changes | ||
Line 788: | Line 689: | ||
-rw-rw-r-- 1 maemo maemo 240773 Aug 17 14:29 hello-world-app_2.2.tar.gz | -rw-rw-r-- 1 maemo maemo 240773 Aug 17 14:29 hello-world-app_2.2.tar.gz | ||
</pre></li> | </pre></li> | ||
- | + | <li> Install the newly compiled debug version of the package hello-world-app_2.2_i386.deb: <br /><br /> | |
- | + | <pre> | |
- | <li> Install the newly | + | [sbox-FREMANTLE_X86: ~/src] > fakeroot dpkg -i hello-world-app_2.2_i386.deb |
- | + | ||
- | <pre> | + | |
- | [sbox-FREMANTLE_X86: ~/src] | + | |
(Reading database ... 24822 files and directories currently installed.) | (Reading database ... 24822 files and directories currently installed.) | ||
Unpacking hello-world-app (from hello-world-app_2.2_i386.deb) ... | Unpacking hello-world-app (from hello-world-app_2.2_i386.deb) ... | ||
Line 799: | Line 697: | ||
</pre></li> | </pre></li> | ||
</ol> | </ol> | ||
- | |||
- | |||
Now the Hildon desktop plug-ins example applications should be installed in the Scratchbox X86 target. | Now the Hildon desktop plug-ins example applications should be installed in the Scratchbox X86 target. | ||
- | + | '''How to Debug Applications Started by Maemo-Launcher''' | |
Basically, these applications can be debugged by: | Basically, these applications can be debugged by: | ||
Line 810: | Line 706: | ||
* starting the application using maemo-summoner | * starting the application using maemo-summoner | ||
- | + | '''Attaching to Maemo-Launched Application with Gdb''' | |
- | With maemo-launched applications, it is necessary to give | + | With maemo-launched applications, it is necessary to give maemo-launcher binary to <code>gdb</code> and attach to the already running process. |
- | [sbox-FREMANTLE_X86: ~/ ] | + | <nowiki> |
- | [sbox-FREMANTLE_X86: ~/ ] | + | [sbox-FREMANTLE_X86: ~/ ] > export DISPLAY=:2 |
+ | [sbox-FREMANTLE_X86: ~/ ] > af-sb-init.sh start | ||
... snip ... | ... snip ... | ||
- | [sbox-FREMANTLE_X86: ~/ ] | + | [sbox-FREMANTLE_X86: ~/ ] > pidof hildon-desktop | cut -d' ' -f1 |
22961 | 22961 | ||
# | # | ||
Line 825: | Line 722: | ||
# start hildon-desktop. | # start hildon-desktop. | ||
# | # | ||
- | [sbox-FREMANTLE_X86: ~/ ] | + | [sbox-FREMANTLE_X86: ~/ ] > native-gdb maemo-launcher |
... snip ... | ... snip ... | ||
(gdb) attach 22961 | (gdb) attach 22961 | ||
Line 832: | Line 729: | ||
... snip... | ... snip... | ||
(gdb) | (gdb) | ||
+ | </nowiki> | ||
- | Now it should be possible to debug the application normally with gdb. | + | <br /><br /> Now it should be possible to debug the application normally with the gdb. |
- | + | '''Starting Maemo-Launched Application with Maemo-Summoner''' | |
- | + | ||
The following will start the Control Panel under (native) gdb, and the newly installed Control Panel applet called <code>hello-world-app</code> will be debugged. The breakpoint will be set to function <code>hello_world_dialog_show()</code>. Pay attention to the question about the "pending shared library load". | The following will start the Control Panel under (native) gdb, and the newly installed Control Panel applet called <code>hello-world-app</code> will be debugged. The breakpoint will be set to function <code>hello_world_dialog_show()</code>. Pay attention to the question about the "pending shared library load". | ||
- | [sbox-FREMANTLE_X86: ~/ ] | + | [sbox-FREMANTLE_X86: ~/ ] > export DISPLAY=:2 |
- | [sbox-FREMANTLE_X86: ~/ ] | + | [sbox-FREMANTLE_X86: ~/ ] > af-sb-init.sh start |
... snip ... | ... snip ... | ||
- | [sbox-FREMANTLE_X86: ~/ ] | + | [sbox-FREMANTLE_X86: ~/ ] > run-standalone.sh native-gdb maemo-summoner |
... snip ... | ... snip ... | ||
(gdb) br hello_world_dialog_show | (gdb) br hello_world_dialog_show | ||
Line 853: | Line 750: | ||
... snip ... | ... snip ... | ||
+ | <br /><br /> | ||
This should start the Control Panel in the Xephyr screen. When clicking the hello world plug-in in the Control Panel, the execution should stop at the given breakpoint. Try, for example, to get a backtrace: | This should start the Control Panel in the Xephyr screen. When clicking the hello world plug-in in the Control Panel, the execution should stop at the given breakpoint. Try, for example, to get a backtrace: | ||
+ | <nowiki> | ||
Breakpoint 2, hello_world_dialog_show () at libhelloworld.c:68 | Breakpoint 2, hello_world_dialog_show () at libhelloworld.c:68 | ||
68 GtkWidget *dialog = hello_world_dialog_new (); | 68 GtkWidget *dialog = hello_world_dialog_new (); | ||
Line 876: | Line 775: | ||
(gdb) c | (gdb) c | ||
Continuing. | Continuing. | ||
+ | </nowiki> | ||
+ | <br /><br /> | ||
- | The backtrace | + | The backtrace tells what functions were called before the breakpoint was reached at <code>hello_world_dialog_show()</code>. Now the plug-in can be debugged normally with gdb. |
Because the hello world plug-in was compiled with the <code>-g</code> option, the source code listing can be viewed with the <code>list</code> command. | Because the hello world plug-in was compiled with the <code>-g</code> option, the source code listing can be viewed with the <code>list</code> command. | ||
Line 884: | Line 785: | ||
To do this same for desktop, the <code>hildon-desktop</code> process needs to be killed first. The desktop can be killed with the command: | To do this same for desktop, the <code>hildon-desktop</code> process needs to be killed first. The desktop can be killed with the command: | ||
- | [sbox-FREMANTLE_X86: ~] | + | <nowiki> |
+ | [sbox-FREMANTLE_X86: ~] > kill $(pidof hildon-desktop) | ||
# | # | ||
# after this you could start the hildon-desktop under gdb like this: | # after this you could start the hildon-desktop under gdb like this: | ||
# | # | ||
- | [sbox-FREMANTLE_X86: ~] | + | [sbox-FREMANTLE_X86: ~] > run-standalone.sh native-gdb maemo-summoner |
... snip ... | ... snip ... | ||
(gdb) run /usr/bin/hildon-desktop.launch | (gdb) run /usr/bin/hildon-desktop.launch | ||
... snip ... | ... snip ... | ||
+ | </nowiki> | ||
+ | <br /><br /><div style="border: 2px solid rgb(255, 215, 0); background-color: rgb(252, 233, 79); margin-left: 25px; margin-right: 25px; padding: 2px"> N.B. <br /><br /> Doing this on the device would require first disabling the software lifeguard with the flasher tool. If this is not done, the device will reboot. The flag is: <br /><code>--set-rd-flags=no-lifeguard-reset</code></div> | ||
- | + | == 15.2.5 Running Out of Memory During Debugging in Device == | |
- | + | If running out of RAM memory during debugging in the device, there are a couple of options: | |
- | + | <ol> | |
- | + | ||
- | + | ||
- | If running out of RAM during debugging | + | |
- | + | ||
- | < | + | |
<li> Add (more) swap to the device by increasing the size of the swap partition. | <li> Add (more) swap to the device by increasing the size of the swap partition. | ||
- | If there is enough memory, but gdb is still abruptly terminated, you can try setting it OOM-protected as | + | If there is enough memory, but gdb is still abruptly terminated, you can try setting it OOM-protected as <code>root</code><nowiki>: </nowiki> |
<pre> | <pre> | ||
- | /home/user # echo -17 | + | /home/user # echo -17 > /proc/[PID of your gdb]/oom_adj |
</pre> | </pre> | ||
- | By default, processes have | + | By default, processes have OOM (i.e. Out-of-Memory) adjustment value of zero. The value <code>-17</code> disables the kernel OOM killing for the given process. '''N.B.''' As a result of this, some other processes might be killed by the kernel.</li> |
- | + | ||
- | + | ||
<li> Use <code>gdbserver</code> to debug.</li> | <li> Use <code>gdbserver</code> to debug.</li> | ||
- | </ | + | </ol> |
- | + | '''Notes on Using Gdbserver''' | |
- | <code>gdbserver</code> is a debugging tool that can be started and run in the Internet Tablet device. Then a connection can be made to this running instance of gdbserver program from a Linux PC with a gdb program. Gdbserver uses a lot less memory than a full scale gdb program, thus making it possible to perform debugging in devices that have limited RAM, such as PDAs. | + | <code>gdbserver</code> is a debugging tool that can be started and run in the Internet Tablet device. Then a connection can be made to this running instance of gdbserver program from a Linux PC with a gdb program. Gdbserver uses a lot less memory than a full scale gdb program, thus making it possible to perform debugging in devices that have a limited RAM memory, such as PDAs. |
- | The gdbserver does not care about symbols in the binary, but instead the Linux PC side gdb expects to have a local copy of the binary being debugged so that the binaries in the device can be stripped. | + | The gdbserver does not care about symbols in the binary, but instead the Linux PC side gdb expects to have a local copy of the binary being debugged so that the binaries in the device can be stripped. <br /> |
+ | <br /><div style="border: 2px solid rgb(255, 215, 0); background-color: rgb(252, 233, 79); margin-left: 25px; margin-right: 25px; padding: 2px"> N.B. <br /><br /> Debugging core files from the device in Scratchbox with <code>gdbserver</code> has the same issues. In practice, it is easier to perform the debugging in the device itself. See the section above about prelinked binaries and libraries. </div> | ||
For further information about using <code>gdbserver</code>, <code>gdb</code> and <code>DDD</code>, see: | For further information about using <code>gdbserver</code>, <code>gdb</code> and <code>DDD</code>, see: | ||
Line 927: | Line 825: | ||
* [http://www.scratchbox.org/documentation/user/scratchbox-1.0/html/debugging.html scratchbox.org: Debugging in Scratchbox] | * [http://www.scratchbox.org/documentation/user/scratchbox-1.0/html/debugging.html scratchbox.org: Debugging in Scratchbox] | ||
- | == Valgrind Debugger == | + | == 15.2.6 Valgrind Debugger == |
- | + | Valgrind is a CPU simulator with different debugging and analyzing plug-ins. The Valgrind plug-ins are: | |
- | * | + | * <code>memcheck</code> |
- | + | This plug-in tool is used to debug memory leaks and deallocation errors in applications. The following example will mainly focus on this. | |
- | * | + | * <code>massif</code> |
- | + | This plug-in produces PostScript graph of process memory usage as a function of time. This also produces an ASCII or HTML report of allocation backtraces. | |
- | * | + | * <code>callgrind</code> |
- | + | This can be used for profiling performance and getting call traces from programs. These can be further visualized with the <code>Kcachegrind</code> tool. | |
- | * | + | * <code>helgrind drd</code> |
- | + | These help in finding race conditions in threaded programs. | |
- | + | ||
- | + | ||
+ | <div style="border: 2px solid rgb(255, 215, 0); background-color: rgb(252, 233, 79); margin-left: 25px; margin-right: 25px; padding: 2px"> N.B. <br /><br /> In the maemo environment, you can use the Valgrind debugger only in the Scratchbox X86 target.</div><br /><br /> | ||
Valgrind has many options, but only the basic ones are covered here with examples. The link to the full Valgrind manual is given at the end of this section. | Valgrind has many options, but only the basic ones are covered here with examples. The link to the full Valgrind manual is given at the end of this section. | ||
- | + | '''Installing Valgrind Tool''' | |
- | Installing Valgrind is simple. Log in | + | Installing Valgrind is simple. Log in on Scratchbox and run the following commands: |
<ol> | <ol> | ||
<li> Get Valgrind from the repository: | <li> Get Valgrind from the repository: | ||
<pre> | <pre> | ||
- | [sbox-FREMANTLE_ARMEL: ~] | + | [sbox-FREMANTLE_ARMEL: ~] > sb-conf select FREMANTLE_X86 |
- | [sbox-FREMANTLE_X86: ~] | + | [sbox-FREMANTLE_X86: ~] > apt-get install valgrind |
... | ... | ||
Line 958: | Line 855: | ||
Setting up valgrind (3.4.1-0maemo1+0m5) ... | Setting up valgrind (3.4.1-0maemo1+0m5) ... | ||
- | [sbox-FREMANTLE_X86: ~] | + | [sbox-FREMANTLE_X86: ~] > |
</pre> | </pre> | ||
- | + | <br /><br /><div style="border: 2px solid rgb(255, 215, 0); background-color: rgb(252, 233, 79); margin-left: 25px; margin-right: 25px; padding: 2px"> N.B. <br /><br /> The maemo Valgrind version depends on the libc6-dbg. On the desktop Linux, some of the debug symbols are included in the libc6 library itself. If the debug symbols are missing from the libraries, Valgrind cannot match the error suppressions to the internal library functions. In the maemo <code>libc6</code> case, it would show lots of errors for the dynamic linker. <br /> If using a non-maemo version of Valgrind, the following environment variable needs to be set before valgrinding programs using Glib: | |
- | The | + | <pre> |
- | + | [sbox-FREMANTLE_X86: ~] > export \ | |
- | If using a non- | + | G_SLICE="always-malloc" |
- | + | </pre> | |
- | + | Without this, Valgrind will report bogus leaks from Glib.</div></li> | |
- | + | <li> Get the two small example applications written in C language to demonstrate the basic usage of valgrind tool. You can download these from maemo.org: [https://stage.maemo.org/svn/maemo/projects/tools/trunk/maemo_testing/maemo-examples/debug_guide/valgrind_example.tar.gz valgrind_example.tar.gz]. <br /><br /> | |
- | Without this, | + | |
- | </li> | + | |
- | + | ||
- | + | ||
- | <li> Get the two small example applications written in | + | |
- | + | ||
<pre> | <pre> | ||
- | [sbox-FREMANTLE_X86: ~ | + | [sbox-FREMANTLE_X86: ~] > mkdir src |
- | + | [sbox-FREMANTLE_X86: ~] > cd src | |
- | [sbox-FREMANTLE_X86: ~ | + | [sbox-FREMANTLE_X86: ~/src] > |
- | [sbox-FREMANTLE_X86: ~/src | + | |
</pre> | </pre> | ||
+ | <br /><br /> | ||
+ | After downloading, just copy the <code>valgrind_example.tar.gz</code> file to the <code>~/src/</code> directory and perform the following: | ||
+ | <pre> | ||
+ | [sbox-FREMANTLE_X86: ~/src] > tar xvzf valgrind_example.tar.gz | ||
+ | valgrind_example/ | ||
+ | valgrind_example/valgrind_example.c | ||
+ | valgrind_example/valgrind_example2.c | ||
- | </li> | + | [sbox-FREMANTLE_X86: ~/src] > cd valgrind_example |
- | + | [sbox-FREMANTLE_X86: ~/src/valgrind_example] > | |
- | + | </pre></li> | |
<li> Compile the two small example applications in the following way: | <li> Compile the two small example applications in the following way: | ||
<pre> | <pre> | ||
- | [sbox-FREMANTLE_X86: ~/src/valgrind_example] | + | [sbox-FREMANTLE_X86: ~/src/valgrind_example] > gcc valgrind_example.c \ |
- | -o valgrind_example -g | + | -o valgrind_example -g |
- | [sbox-FREMANTLE_X86: ~/src/valgrind_example] | + | [sbox-FREMANTLE_X86: ~/src/valgrind_example] > gcc valgrind_example2.c \ |
- | -o valgrind_example2 -g | + | -o valgrind_example2 -g |
</pre></li> | </pre></li> | ||
</ol> | </ol> | ||
- | + | '''Using Valgrind Memory Debugger Tool''' | |
- | + | ||
After compiling the small example application, it can be run under valgrind with the command: | After compiling the small example application, it can be run under valgrind with the command: | ||
Line 1,000: | Line 896: | ||
./valgrind_example | ./valgrind_example | ||
+ | <br /><br /> | ||
Explanation of the parameters and their meanings: | Explanation of the parameters and their meanings: | ||
- | * | + | * <code>--tool=memcheck</code> |
- | + | Defines which tool Valgrind should use. In this example, the memory checker tool is used. | |
- | * | + | * <code>--leak-check=yes</code> |
- | + | With this option, Valgrind checks the code for potential memory leaks. | |
- | * | + | * <code>--show-reachable=yes</code> |
- | + | This option creates a stack trace of the creation of the reachable but unfreed memory when the program exits. | |
- | * | + | * <code>--num-callers=20</code> |
- | + | With this option, the number of function call levels that Valgrind displays can be changed. The default value is 12. Giving higher number takes a bit more memory. It is advisable to tune this option, because for example the gtk callstack can consist of more than 100 items. | |
- | * | + | * <code>--track-fds=yes</code> |
+ | <code>Track-fds</code> means <code>Track FileDescriptors</code>. If the application is opening and closing files with <code>fopen()</code> or <code>open()</code>, this will report which files are not closed. | ||
The output of the example application should look like: | The output of the example application should look like: | ||
+ | <nowiki> | ||
==6526== Memcheck, a memory error detector. | ==6526== Memcheck, a memory error detector. | ||
==6526== Copyright (C) 2002-2008, and GNU GPL'd, by Julian Seward et al. | ==6526== Copyright (C) 2002-2008, and GNU GPL'd, by Julian Seward et al. | ||
Line 1,058: | Line 957: | ||
==6526== still reachable: 0 bytes in 0 blocks. | ==6526== still reachable: 0 bytes in 0 blocks. | ||
==6526== suppressed: 0 bytes in 0 blocks. | ==6526== suppressed: 0 bytes in 0 blocks. | ||
- | [sbox-FREMANTLE_X86: ~/src/valgrind_example] > | + | [sbox-FREMANTLE_X86: ~/src/valgrind_example] > |
+ | </nowiki> | ||
+ | <br /><br /> | ||
The output of the Valgrind tells that there were 40 unallocated bytes for the application ("definitely lost"). This means that the example application is leaking memory, and cannot free it anymore. This means that the code should be studied closely. | The output of the Valgrind tells that there were 40 unallocated bytes for the application ("definitely lost"). This means that the example application is leaking memory, and cannot free it anymore. This means that the code should be studied closely. | ||
Line 1,065: | Line 966: | ||
Valgrind also tells the lines in the code where these allocations that are not freed are performed. In this example, the lines in question are 48 and 26. | Valgrind also tells the lines in the code where these allocations that are not freed are performed. In this example, the lines in question are 48 and 26. | ||
- | + | '''Official Valgrind Manual''' | |
- | + | Valgrind.org has an official Valgrind manual available in the Internet, explaining the many options and debugging practices that Valgrind can support. For full coverage of Valgrind see [http://valgrind.org/docs/manual/manual.html Valgrind User Manual] [[/node19.html#valgrindusermanual 93]]. | |
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | For | + | |
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | == Other Debugging Tools == | + | == 15.2.7 Other Debugging Tools == |
The SDK provides a number of other tools that are useful in debugging. See the linked documentation pages to learn more about them. | The SDK provides a number of other tools that are useful in debugging. See the linked documentation pages to learn more about them. | ||
* ''strace'' - a system call tracer. Prints out all the system calls made by the traced process. | * ''strace'' - a system call tracer. Prints out all the system calls made by the traced process. | ||
- | ** | + | ** http://maemo.org/development/tools/doc/diablo/strace |
* ''ltrace'' - a library call tracer. Prints out all library calls made by the traced process. | * ''ltrace'' - a library call tracer. Prints out all library calls made by the traced process. | ||
- | ** | + | ** http://maemo.org/development/tools/doc/diablo/ltrace |
- | + | ||
- | + | ||
* ''sp-rich-core'' - produce ''rich cores'' that will provide a snapshot of the system's state at the time of the crash in addition to the core dump file. | * ''sp-rich-core'' - produce ''rich cores'' that will provide a snapshot of the system's state at the time of the crash in addition to the core dump file. | ||
- | ** | + | ** http://maemo.org/development/tools/doc/diablo/sp-rich-core |
* ''syslog'' - a logging system that can collect logs in a centralized way. | * ''syslog'' - a logging system that can collect logs in a centralized way. | ||
- | ** | + | ** http://maemo.org/development/tools/doc/diablo/syslog |
- | Please also have a look at the tools main page [ | + | Please also have a look at the tools main page [http://maemo.org/development/tools/ Maemo SDK tools] [[/node19.html#maemotools 66]] for even more tools that could be useful for you. |
- | = Making a Debian Debug Package = | + | = 15.3 Making a Debian Debug Package = |
Application developers should provide debug packages corresponding to their application packages. This section shows how to do that. | Application developers should provide debug packages corresponding to their application packages. This section shows how to do that. | ||
Line 1,108: | Line 991: | ||
Debian debug packages contain ''debug symbol'' files that debuggers (like <code>gdb</code>) will automatically load when the application is debugged. | Debian debug packages contain ''debug symbol'' files that debuggers (like <code>gdb</code>) will automatically load when the application is debugged. | ||
- | + | On ARM environment, the debugger cannot do backtracing or show correct function names without debugging symbols making it thus impossible to debug optimized binaries or libraries. All libraries in the device are optimized. | |
- | In | + | In X86 target, debugging can be done without debug symbols. |
- | If the package maintainer provides no debug package, then the other developers in the community need to spend extra time and effort to recompile the application (or the library) with debugging symbols. This extra (time-consuming) step can be simply eliminated | + | If the package maintainer provides no debug package, then the other developers in the community need to spend extra time and effort to recompile the application (or the library) with the debugging symbols. This extra (time-consuming) step can be simply eliminated by the package maintainer by providing a ready compiled debug package. |
- | This section covers creating a Debian debug package from the | + | This section covers creating a Debian debug package from the <br /> maemo/Scratchbox point of view. |
It is the package maintainers role and decision to create and provide a debug package for their application or library. This means that you as the package owner are responsible to modify the debian package configurations, so that the <code>dpkg-buildpackage</code> tool will produce the additional <code>dbg</code>-package. | It is the package maintainers role and decision to create and provide a debug package for their application or library. This means that you as the package owner are responsible to modify the debian package configurations, so that the <code>dpkg-buildpackage</code> tool will produce the additional <code>dbg</code>-package. | ||
Line 1,120: | Line 1,003: | ||
If you are a maintainer of a library or binary package, it is strongly recommended to create a corresponding debug package. This is needed by anybody wanting to either debug or profile your software or something using it. | If you are a maintainer of a library or binary package, it is strongly recommended to create a corresponding debug package. This is needed by anybody wanting to either debug or profile your software or something using it. | ||
- | If the package is otherwise fine (and | + | If the package is otherwise fine (and debian/rules uses debhelper <code>dh_* scripts</code>), creating debug packages is easy, just: |
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
+ | * Add <code><nowiki>*-dbg</nowiki></code> package descriptions to debian/control file | ||
+ | * Make sure "<code>-g</code>" is included into compiler flags and Makefiles don't strip binaries (e.g. give "<code>-s</code>" to "<code>install</code>" command) | ||
+ | * Add "<code>--dbg-package=<package name></code>" argument to "<code>dh_strip</code>" invocation in debian/rules for each package containing binaries (<code>dh_strip</code> will then extract the debug symbols from the given binary package to a separate debug package) | ||
* Rebuild/test source package | * Rebuild/test source package | ||
More detailed instructions are below. | More detailed instructions are below. | ||
- | == Creating DBG Packages == | + | == 15.3.1 Creating DBG Packages == |
Steps to create a debian DBG package are: | Steps to create a debian DBG package are: | ||
Line 1,157: | Line 1,037: | ||
Description: Debug symbols for the Gtk library | Description: Debug symbols for the Gtk library | ||
</pre> | </pre> | ||
- | + | <br /><br /><div style="border: 2px solid rgb(255, 215, 0); background-color: rgb(252, 233, 79); margin-left: 25px; margin-right: 25px; padding: 2px"> N.B. <br /><br /> If the package contains binaries instead of libraries, the <code>Section</code> should be <code>devel</code>. N.B. The new <code>-dbg</code> package may have a different name from the old style debug package (for example <code>libgtk2.0-0-dbg</code>, not <code>libgtk2.0-dbg</code>). If there are earlier (old style) debug packages in the repositories the new debug package should replace/conflict with the old one.</div></li> | |
- | If the package contains binaries instead of libraries, the <code>Section</code> should be <code>devel</code> | + | |
- | + | ||
- | + | ||
<li> '''Add option -g to CFLAGS''' | <li> '''Add option -g to CFLAGS''' | ||
Make sure you have set option <code>-g</code> in <code>CFLAGS</code> in the <code>debian/rules</code> file, and that this option is effective and always enabled. Otherwise the debug package will not contain the required debug symbols. | Make sure you have set option <code>-g</code> in <code>CFLAGS</code> in the <code>debian/rules</code> file, and that this option is effective and always enabled. Otherwise the debug package will not contain the required debug symbols. | ||
For example, use a line like this for <code>CFLAGS</code> | For example, use a line like this for <code>CFLAGS</code> | ||
- | + | <br /><br /> | |
<pre> | <pre> | ||
- | CFLAGS = -Wall -g | + | CFLAGS = -Wall -g |
</pre></li> | </pre></li> | ||
<li> '''Use dh_strip''' | <li> '''Use dh_strip''' | ||
Line 1,172: | Line 1,049: | ||
You want to select the latter option only if you want to reveal as little of your code as possible (for example) for contract reasons. | You want to select the latter option only if you want to reveal as little of your code as possible (for example) for contract reasons. | ||
<ol><li> '''Providing all debug information in your dbg package.''' | <ol><li> '''Providing all debug information in your dbg package.''' | ||
- | + | Debian/compat levels smaller than 3 should not be used (1 is default!). If your package sets debian/compat level '''below''' 5, give the following arguments to dh_strip in debian/rules file: | |
- | <pre> | + | <pre> |
dh_strip --dbg-package=<package1> [--dbg-package=<package2> ...] | dh_strip --dbg-package=<package1> [--dbg-package=<package2> ...] | ||
</pre> | </pre> | ||
- | + | <br /><br /> For example: | |
- | For example: | + | <pre> |
- | + | ||
- | <pre> | + | |
dh_strip --dbg-package=libgtk2.0-0 | dh_strip --dbg-package=libgtk2.0-0 | ||
</pre> | </pre> | ||
- | + | <br /><br /> | |
- | + | ||
If compat level is 5 or higher, use syntax: | If compat level is 5 or higher, use syntax: | ||
- | + | <pre> | |
- | <pre> | + | |
dh_strip --dbg-package=<package1>-dbg\ | dh_strip --dbg-package=<package1>-dbg\ | ||
[--dbg-package=<package2>-dbg ...] | [--dbg-package=<package2>-dbg ...] | ||
</pre> | </pre> | ||
- | + | <br /><br /> For example: | |
- | For example: | + | <pre> |
- | + | ||
- | <pre> | + | |
dh_strip --dbg-package=libgtk2.0-0-dbg | dh_strip --dbg-package=libgtk2.0-0-dbg | ||
</pre> | </pre> | ||
- | + | <br /><br /> | |
- | + | If you're using cdbs instead of debhelper (i.e. dh_* commands) in your debian/rules file, use this instead: | |
- | If you | + | <pre> |
- | + | ||
- | <pre> | + | |
DEB_DH_STRIP_ARGS := <dh_strip arguments> | DEB_DH_STRIP_ARGS := <dh_strip arguments> | ||
</pre> | </pre> | ||
- | + | <br /><br /> For example (for compat levels below 5): | |
- | + | <pre> | |
- | For example (for compat levels below 5): | + | DEB_DH_STRIP_ARGS := --dbg-package=<package1> ... |
- | + | ||
- | <pre> | + | |
- | DEB_DH_STRIP_ARGS := --dbg-package=<package1> ... | + | |
</pre> | </pre> | ||
- | + | <br /><br /></li> | |
- | </li> | + | |
- | + | ||
- | + | ||
<li> '''Providing just minimal debug information''' | <li> '''Providing just minimal debug information''' | ||
- | In case you do not want to reveal all information about your binary (for | + | In case you do not want to reveal all information about your binary (e.g. for contract reasons), you can provide a debug symbol file just with the <code>.debug_frame</code> section (which is the minimal information needed by <code>gdb</code> to show working backtraces in ARM environment). In addition to information provided by the binary file, it will reveal only static function names and the number of function arguments. |
+ | To do this, replace the above <code>dh_strip</code> line in <code>debian/rules</code> file <code>binary-arch</code> target with: | ||
- | <pre> | + | <pre> |
chmod +x $(shell pwd)/debian/wrapper | chmod +x $(shell pwd)/debian/wrapper | ||
export PATH=$(shell pwd)/debian/wrapper:$$PATH; \ | export PATH=$(shell pwd)/debian/wrapper:$$PATH; \ | ||
dh_strip --dbg-package=<package1> [--dbg-package=<package2> ...] | dh_strip --dbg-package=<package1> [--dbg-package=<package2> ...] | ||
</pre> | </pre> | ||
+ | <br /><br /> | ||
+ | Notice that the wrapper script is set executable because the <code>dpkg-source</code> does not preserve the exec permissions. | ||
+ | Store the following wrapper script as <code>debian/wrapper/objcopy</code><nowiki>: </nowiki> | ||
+ | <pre> | ||
+ | #!/bin/sh | ||
+ | # | ||
- | + | case " $* " in | |
- | + | *" --only-keep-debug "*) | |
- | + | exec /usr/bin/objcopy -R .debug_info -R .debug_aranges \ | |
- | + | -R .debug_pubnames -R .debug_abbrev -R .debug_line \ | |
- | + | -R .debug_str -R .debug_ranges -R .comment -R .note "$@" | |
- | + | ;; | |
- | + | esac | |
- | + | exec /usr/bin/objcopy "$@" | |
- | + | </pre> | |
- | + | <br /><br /> | |
- | + | With this <code>dh_strip</code> will use <code>objcopy</code> through this wrapper (i.e. remove the other debug sections).</li></ol> | |
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | With this <code>dh_strip</code> will use <code>objcopy</code> through this wrapper ( | + | |
<li> Verify the package(s) | <li> Verify the package(s) | ||
Update the Debian changelog with <code>dch -i</code> and build the package with <code>dpkg-buildpackage -rfakeroot</code>. This will create new Debian source package (dsc + diff) and binary package(s) which you can install on the target for additional testing.</li> | Update the Debian changelog with <code>dch -i</code> and build the package with <code>dpkg-buildpackage -rfakeroot</code>. This will create new Debian source package (dsc + diff) and binary package(s) which you can install on the target for additional testing.</li> | ||
</ol> | </ol> | ||
- | See also <code>dh_strip (1)</code> and <code>debhelper (7)</code> manual pages for details about the helper scripts. | + | See also <code>dh_strip (1)</code> and <code>debhelper (7)</code> manual pages for details about the helper scripts. <br /><br /><div style="border: 2px solid rgb(255, 215, 0); background-color: rgb(252, 233, 79); margin-left: 25px; margin-right: 25px; padding: 2px"> N.B. <br /><br /> If the package has any function(s) that have the <code>noreturn</code> GCC attribute, you need to make sure that the object(s) containing those are compiled with <code>-mapcs-frame</code> (or remove the noreturn attribute). This is needed for backtraces containing them to be debuggable when the binaries are optimized, the debug symbols are not enough for them. By default GCC omits frame pointer when code is optimized.</div> |
- | == Using and Installing DBG Packages == | + | == 15.3.2 Using and Installing DBG Packages == |
- | The debug packages are easy to use, just <code>apt-get install</code> them and on target gdb load the new style debug symbol files (installed to subdirectories under <code>/usr/lib/debug/</code>) automatically. | + | The debug packages are easy to use, just <code>apt-get install</code> them and on target gdb will load the new style debug symbol files (installed to subdirectories under <code>/usr/lib/debug/</code>) automatically. |
- | Inside Scratchbox, debuggers and profilers search for the debug symbol files under scratchbox target directory under <code>/usr/lib/debug</code>, so | + | Inside Scratchbox, debuggers and profilers will search for the debug symbol files under scratchbox target directory under <code>/usr/lib/debug</code>, so a target directory needs to be linked under it. |
mkdir /usr/lib/debug | mkdir /usr/lib/debug | ||
Line 1,264: | Line 1,128: | ||
Installing the <code>maemo-debug-scripts</code> package does this link automatically. | Installing the <code>maemo-debug-scripts</code> package does this link automatically. | ||
- | And for thread debugging to work, install <code>libc6-dbg</code> package and <code>gdb</code> package, the Scratchbox provided host <code>gdb</code> doesn't work with threads (or ARM core dumps). To use the native gdb in Scratchbox, you need to start gdb the following way: | + | And for thread debugging to work, you need to install <code>libc6-dbg</code> package and <code>gdb</code> package, the Scratchbox provided host <code>gdb</code> doesn't work with threads (or ARM core dumps). To use the native gdb in Scratchbox, you need to start gdb the following way: |
SBOX_REDIRECT_IGNORE=/usr/bin/gdb /usr/bin/gdb /usr/bin/my-binary | SBOX_REDIRECT_IGNORE=/usr/bin/gdb /usr/bin/gdb /usr/bin/my-binary | ||
- | + | <code>maemo-debug-scripts</code> package provides <code>native-gdb</code> script for this. | |
- | For gdb to find old style debug symbol files (installed directly into <code>/usr/lib/debug/</code>) | + | For gdb to find old style debug symbol files (installed directly into <code>/usr/lib/debug/</code>) you need to use <code>LD_LIBRARY_PATH</code> or load them manually in <code>gdb</code>. |
Files in these old style debug symbol files contain both the binary and debug symbol sections, so they are also larger than the new style debug symbols that <code>dh_strip</code> instructions above will create. | Files in these old style debug symbol files contain both the binary and debug symbol sections, so they are also larger than the new style debug symbols that <code>dh_strip</code> instructions above will create. | ||
- | == For Further Reading == | + | == 15.3.3 For Further Reading == |
* [http://www.debian.org/doc/manuals/maint-guide/index.en.html Debian New Maintainers' Guide] | * [http://www.debian.org/doc/manuals/maint-guide/index.en.html Debian New Maintainers' Guide] | ||
* [http://www.debian.org/doc/developers-reference/best-pkging-practices.html Debian Developer's Reference, Chapter 6 - Best Packaging Practices] | * [http://www.debian.org/doc/developers-reference/best-pkging-practices.html Debian Developer's Reference, Chapter 6 - Best Packaging Practices] | ||
- | |||
- | |||
- | |||
- |
Learn more about Contributing to the wiki.