Difference between revisions of "Debug generated C code"

(New page: Sometimes you need debug Eiffel generated C codes, this is how to. You should first have Visual Studio installed. ===There are two things you need to do before debugging generated C code...)
 
(Added useful entry for disabling ASLR on Windows)
 
(20 intermediate revisions by 4 users not shown)
Line 1: Line 1:
−
Sometimes you need debug Eiffel generated C codes, this is how to.
+
[[Category:Runtime]]
 +
Sometimes you need debug the Eiffel generated C code. This page will show you how to achieve this. In addition you may also want to compile the runtime in debug mode (see the instructions at the end of this page).
  
−
You should first have Visual Studio installed.
+
To see the mapping between Eiffel classes and features to C files and their methods, the file '''TRANSLAT''' in the '''W_code''' or '''F_code''' directory is very useful.
  
−
===There are two things you need to do before debugging generated C codes===
+
== Runtime ==
  
−
====Tell C compiler to add debug information====
+
If you need to compile the runtime with debug information, follow the steps below. The steps below include a copy operation to the Eiffel installation directory, so make sure to make a backup before overriding the runtime files.
  
−
Change Eiffel C compilation config file "config.eif" (located at $ISE_EIFFEL\studio\config\win64\msc)
+
===Unix===
 +
Edit $EIFFEL_SRC/C/CONFIGS/$ISE_PLATFORM and perform the same substitution as above for Unix. Then type '''./quick_configure''' in the $EIFFEL_SRC/C directory.
  
−
From
+
Once this is done make sure to copy the debugged runtime files located under $EIFFEL_SRC/C/run-time/lib* to the EiffelStudio delivery under $ISE_EIFFEL/studio/spec/$ISE_PLATFORM/lib.
−
    optimize: "-Ox -MT"
+
−
To
+
−
    optimize: "-Od -Zi -MT
+
  
−
Then you can start C compile in Eiffel projects with debugging information.
+
===Windows===
 +
Edit the config file in $EIFFEL_SRC/C/CONFIGS that matches your platform and your C compiler. For example, windows-x86-64-msc is for Windows 64-bit using the Microsoft C++ compiler. Comment out the debug and optimize entry and replace them with their corresponding debugged version (currently commented below). Then in the $EIFFEL_SRC/C directory type '''configure win64 m''' (Windows 64-bit) or '''configure win32 m''' (Windows 32-bit) to compile the runtime for the Microsoft C++ compiler.
  
−
====Tell linker to add debug information====
+
Once this is done make sure to copy the debugged runtime files located under $EIFFEL_SRC/C/run-time/lib/*.lib to the EiffelStudio delivery under $ISE_EIFFEL/studio/spec/$ISE_PLATFORM/lib/$ISE_C_COMPILER.
  
−
After successfully C compilation and link, open command console, change directory to W_code (or F_code, using bottom right two buttons in C Output is easiest way)
+
==Application==
 +
=== Unix ===
 +
There are 2 methods:
 +
* Edit $ISE_EIFFEL/studio/spec/$ISE_PLATFORM/include/config.sh and
 +
*#To the value of '''wkoptimize''' add the '''-g''' option.
 +
*#Replace the value of '''optimize''' to disable the C optimization (usually '''-O0''') and add '''-g'''.
 +
* set the '''CFLAGS''' environment variable with '''-O0 -g'''
  
−
In command console, run
+
Once you have done that, do in your W_code or F_code directory:
 +
<pre>
 +
make clobber
 +
finish_freezing
 +
</pre>
  
−
    link @your_project_name.lnk -DEBUG
+
Now, the generated executable should contain debugger symbols. It can be debugged with gdb or ddd (Data Display Debugger).
  
−
Please change "your_project_name" to your real project name. This will link your execution binary with debugging information. Make sure you are using Microsoft’s link.exe but not Cygwin's link.exe
+
=== Windows ===
 +
After doing the changes below (depending on your C compiler), you can recompile your project from scratch and the debug information will be present.
  
−
===Start debug C codes in Visual Studio===
+
==== MinGW ====
 +
Edit $ISE_EIFFEL\studio\config\$ISE_PLATFORM\$ISE_C_COMPILER\config.eif and perform the following edits:
 +
# Replace the content of ''optimize'' by '''-O0 -g'''.
 +
# Replace the content of ''wkoptimize'' by '''-O0 -g'''.
  
−
Now you can attach the Eiffel process in Visual Studio and debug. Don't forget to catch all exceptions in Visual Studio.
+
==== Visual C++ ====
 +
Edit $ISE_EIFFEL\studio\config\$ISE_PLATFORM\$ISE_C_COMPILER\config.eif and perform the following edits:
 +
# Replace the content of ''optimize' by '''-Od -Zi -MT'''.
 +
# Search and replace all occurrences of '''-NODEFAULTLIB:libc''' by '''-NODEFAULTLIB:libc -DEBUG'''.
 +
# Disable ASLR (Address Space Layout Randomization) would certainly help in having a consistent debugging experience across execution. This can be done by adding '''-DYNAMICBASE:NO''' after -DEBUG.
  
−
If you want to debug Eiffel generated DLL's C codes, when coping the DLL, you must copy the ".pdb" with the DLL together since ".pdb" file contains debugging information for Visual Studio.
+
With Visual C++, you can have access to the Visual Studio C debugger which will let you attach Eiffel running processes. We certainly recommend that you catch all exceptions (Ctrl + Alt + E to get to the dialog).
 +
 
 +
If you have issues with Visual Studio not finding some debugging information, it might be necessary to tell Visual Studio where to find the associated PDB of your Eiffel executable or DLL.
 +
 
 +
=== Mac OS X ===
 +
Follow the same instructions as above for Unix, except that before recompiling the C code you need to modify the Makefile.SH manually for all Cx directories and remove the line <pre>$(RM) $(OBJECTS)</pre>
 +
The following shell script will do the magic for you:
 +
 
 +
<pre>
 +
sed -i -e 's/$(RM) $(OBJECTS)//g' `find -d . | grep "Makefile.SH"`
 +
</pre>
 +
 
 +
You can use Eclipse to debug your application, Xcode can be set up as well ([https://developer.mozilla.org/en/Debugging_on_Mac_OS_X more]).

Latest revision as of 07:52, 17 June 2015

Sometimes you need debug the Eiffel generated C code. This page will show you how to achieve this. In addition you may also want to compile the runtime in debug mode (see the instructions at the end of this page).

To see the mapping between Eiffel classes and features to C files and their methods, the file TRANSLAT in the W_code or F_code directory is very useful.

Runtime

If you need to compile the runtime with debug information, follow the steps below. The steps below include a copy operation to the Eiffel installation directory, so make sure to make a backup before overriding the runtime files.

Unix

Edit $EIFFEL_SRC/C/CONFIGS/$ISE_PLATFORM and perform the same substitution as above for Unix. Then type ./quick_configure in the $EIFFEL_SRC/C directory.

Once this is done make sure to copy the debugged runtime files located under $EIFFEL_SRC/C/run-time/lib* to the EiffelStudio delivery under $ISE_EIFFEL/studio/spec/$ISE_PLATFORM/lib.

Windows

Edit the config file in $EIFFEL_SRC/C/CONFIGS that matches your platform and your C compiler. For example, windows-x86-64-msc is for Windows 64-bit using the Microsoft C++ compiler. Comment out the debug and optimize entry and replace them with their corresponding debugged version (currently commented below). Then in the $EIFFEL_SRC/C directory type configure win64 m (Windows 64-bit) or configure win32 m (Windows 32-bit) to compile the runtime for the Microsoft C++ compiler.

Once this is done make sure to copy the debugged runtime files located under $EIFFEL_SRC/C/run-time/lib/*.lib to the EiffelStudio delivery under $ISE_EIFFEL/studio/spec/$ISE_PLATFORM/lib/$ISE_C_COMPILER.

Application

Unix

There are 2 methods:

  • Edit $ISE_EIFFEL/studio/spec/$ISE_PLATFORM/include/config.sh and
    1. To the value of wkoptimize add the -g option.
    2. Replace the value of optimize to disable the C optimization (usually -O0) and add -g.
  • set the CFLAGS environment variable with -O0 -g

Once you have done that, do in your W_code or F_code directory: 

make clobber
finish_freezing

Now, the generated executable should contain debugger symbols. It can be debugged with gdb or ddd (Data Display Debugger).

Windows

After doing the changes below (depending on your C compiler), you can recompile your project from scratch and the debug information will be present.

MinGW

Edit $ISE_EIFFEL\studio\config\$ISE_PLATFORM\$ISE_C_COMPILER\config.eif and perform the following edits:

  1. Replace the content of optimize by -O0 -g.
  2. Replace the content of wkoptimize by -O0 -g.

Visual C++

Edit $ISE_EIFFEL\studio\config\$ISE_PLATFORM\$ISE_C_COMPILER\config.eif and perform the following edits:

  1. Replace the content of optimize' by -Od -Zi -MT.
  2. Search and replace all occurrences of -NODEFAULTLIB:libc by -NODEFAULTLIB:libc -DEBUG.
  3. Disable ASLR (Address Space Layout Randomization) would certainly help in having a consistent debugging experience across execution. This can be done by adding -DYNAMICBASE:NO after -DEBUG.

With Visual C++, you can have access to the Visual Studio C debugger which will let you attach Eiffel running processes. We certainly recommend that you catch all exceptions (Ctrl + Alt + E to get to the dialog).

If you have issues with Visual Studio not finding some debugging information, it might be necessary to tell Visual Studio where to find the associated PDB of your Eiffel executable or DLL.

Mac OS X

Follow the same instructions as above for Unix, except that before recompiling the C code you need to modify the Makefile.SH manually for all Cx directories and remove the line 
$(RM) $(OBJECTS)

The following shell script will do the magic for you: 

sed -i -e 's/$(RM) $(OBJECTS)//g' `find -d . | grep "Makefile.SH"`

You can use Eclipse to debug your application, Xcode can be set up as well (more).

Retrieved from "https://dev.eiffel.com/index.php?title=Debug_generated_C_code&oldid=15288"