Difference between revisions of "Support seamless debugging between JDT and CDT"

From Eclipsepedia

Jump to: navigation, search
m (FAQ)
(FAQ)
 
(13 intermediate revisions by 3 users not shown)
Line 1: Line 1:
Student: Mariot Chauvin (IRC: moksha_anderson)
+
Student: Mariot Chauvin (IRC: mchv)
  
 
Mentors: Philippe Ombredanne (IRC: pombreda), Francois Granade (IRC: farialima)
 
Mentors: Philippe Ombredanne (IRC: pombreda), Francois Granade (IRC: farialima)
Line 37: Line 37:
  
 
* code is available on svn
 
* code is available on svn
** svn co https://eclipse-incub.svn.sourceforge.net/svnroot/eclipse-incub/jni_seamless_debugging jni_seamless_debugging
+
** svn co https://eclipse-incub.svn.sourceforge.net/svnroot/eclipse-incub/org.eclipse.soc.jni org.eclipse.soc.jni
 +
 
 +
===Third step : tests and debugging===
 +
* a first version is available to download (see below):
 +
** creation of JUnit tests
 +
** bugs hunt
 +
** advertisement and feedback from community
 +
 
  
 
==Roadmap==
 
==Roadmap==
* until begin of July :
 
**deal with the error cases.
 
**work on synchronization between CDI and JDI
 
* until mid of August :
 
**proceed with the work on synchronization between CDI and JDI
 
**UI improvement (perspectives ?)
 
* until end :
 
**integration and tests
 
  
 +
* 0.0.4 - not yet planned
 +
** jvm started in native code debugging
 +
** see how to integrate in eclipse CDT ?
 +
 +
* EclipseCon 2008
 +
 +
http://www.eclipsecon.org/2008/index.php?page=sub/&id=105
  
 
==Documentation==
 
==Documentation==
  
===How install the plugin ?===
+
===How to install the plug-in ?===
  
 
The most simple is to use the update manager of Eclipse.
 
The most simple is to use the update manager of Eclipse.
 
Simply add this site as "new remote site" :
 
Simply add this site as "new remote site" :
  
http://eclipse-incub.svn.sourceforge.net/viewvc/*checkout*/eclipse-incub/jni_seamless_debugging/update-site/site.xml
+
http://eclipse-incub.svn.sourceforge.net/viewvc/*checkout*/eclipse-incub/org.eclipse.soc.jni/update-site/site.xml
  
The sources are included in the Jar, but you can get them with subversion with the following command :  
+
The sources are included in the Jar, but you can get them on the subversion repository:  
  
svn co https://eclipse-incub.svn.sourceforge.net/svnroot/eclipse-incub/jni_seamless_debugging
+
https://eclipse-incub.svn.sourceforge.net/svnroot/eclipse-incub/org.eclipse.soc.jni
  
===How use the plug-in ?===
+
( You may have to install the subclipe plug-in )
 +
 
 +
===How to use the plug-in ?===
  
 
You should have some java code which uses JNI and the native code associated. The plug-in should be installed.  
 
You should have some java code which uses JNI and the native code associated. The plug-in should be installed.  
Line 79: Line 87:
 
====Third step====
 
====Third step====
 
Set the correct settings for each tab.
 
Set the correct settings for each tab.
 
* JNI tab
 
*:Nothing for the moment
 
  
 
*C/C++ project tab  
 
*C/C++ project tab  
Line 97: Line 102:
  
 
====Fourth step====
 
====Fourth step====
The debug perspective will be launched, with the 2 debuggers. Ready to debug !
+
The debug perspective will be launched with the 2 debuggers. Ready to debug !
 
[[Image:Soc_jni_Debug_perspective.png|frame|center]]
 
[[Image:Soc_jni_Debug_perspective.png|frame|center]]
  
===How report a bug/ask for an enhancement ?===  
+
===How to report a bug/ask for an enhancement ?===  
  
On the eclipse bugzilla there is a "org.eclipse.soc.jni" component for the "SOC" product in the "Technology" category. Please include the version of the plug-in and the max infos you can obtain.
+
On the eclipse bugzilla there is a "org.eclipse.soc.jni" component for the "SOC" product in the "Technology" category. Please include the version of the plug-in and the maximum infos you can obtain.
  
 
==FAQ==
 
==FAQ==
 +
 +
* What is the supported eclipse version ?
 +
 +
only eclipse 3.3 is supported for the moment.
 +
 +
* Is the project still maintained ?
 +
 +
No, I have currently no time to maintain it. All code and documentation are available on svn, wiki and blog.
 +
Do not hesitate to contact me if you need further information.
  
 
* What is the current version of the plug-in ?
 
* What is the current version of the plug-in ?
  
0.0.1
+
0.0.3
  
 
* What are the known bugs of the plug-in ?
 
* What are the known bugs of the plug-in ?
  
[https://bugs.eclipse.org/bugs/buglist.cgi?cmdtype=runnamed&namedcmd=soc.jni%20bugs all bugs]  
+
[https://bugs.eclipse.org/bugs/buglist.cgi?query_format=advanced&short_desc_type=allwordssubstr&short_desc=&classification=Technology&product=SOC&component=org.eclipse.soc.jni&long_desc_type=allwordssubstr&long_desc=&bug_file_loc_type=allwordssubstr&bug_file_loc=&status_whiteboard_type=allwordssubstr&status_whiteboard=&keywords_type=allwords&keywords=&op_sys=All&emailtype1=substring&email1=&emailtype2=substring&email2=&bugidtype=include&bug_id=&votes=&chfieldfrom=&chfieldto=Now&chfieldvalue=&cmdtype=doit&order=Reuse+same+sort+as+last+time&known_name=soc.jni+bugs&query_based_on=soc.jni+bugs&field0-0-0=noop&type0-0-0=noop&value0-0-0= all bugs]  
 
[https://bugs.eclipse.org/bugs/buglist.cgi?query_format=advanced&short_desc_type=allwordssubstr&short_desc=&classification=Technology&product=SOC&component=org.eclipse.soc.jni&long_desc_type=allwordssubstr&long_desc=&bug_file_loc_type=allwordssubstr&bug_file_loc=&status_whiteboard_type=allwordssubstr&status_whiteboard=&keywords_type=allwords&keywords=&bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=VERIFIED&op_sys=All&emailtype1=substring&email1=&emailtype2=substring&email2=&bugidtype=include&bug_id=&votes=&chfieldfrom=&chfieldto=Now&chfieldvalue=&cmdtype=doit&order=Reuse+same+sort+as+last+time&known_name=soc.jni+bugs&query_based_on=soc.jni+bugs&field0-0-0=noop&type0-0-0=noop&value0-0-0= open bugs]
 
[https://bugs.eclipse.org/bugs/buglist.cgi?query_format=advanced&short_desc_type=allwordssubstr&short_desc=&classification=Technology&product=SOC&component=org.eclipse.soc.jni&long_desc_type=allwordssubstr&long_desc=&bug_file_loc_type=allwordssubstr&bug_file_loc=&status_whiteboard_type=allwordssubstr&status_whiteboard=&keywords_type=allwords&keywords=&bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=VERIFIED&op_sys=All&emailtype1=substring&email1=&emailtype2=substring&email2=&bugidtype=include&bug_id=&votes=&chfieldfrom=&chfieldto=Now&chfieldvalue=&cmdtype=doit&order=Reuse+same+sort+as+last+time&known_name=soc.jni+bugs&query_based_on=soc.jni+bugs&field0-0-0=noop&type0-0-0=noop&value0-0-0= open bugs]
 +
 +
[[Category:SOC]]

Latest revision as of 10:43, 30 December 2008

Student: Mariot Chauvin (IRC: mchv)

Mentors: Philippe Ombredanne (IRC: pombreda), Francois Granade (IRC: farialima)

This project is part of the Google Summer of Code 2007


Contents

[edit] Introduction

Eclipse is an extensible framework to build modular applications, which relies on OSGi component architecture. Originally developed to provide an IDE extensible in terms of functionalities and supported languages with plugins, Eclipse can now be used as a Rich Client Platform (RCP). The success of the Java Development Toolkit (JDT) plugin has lead to the development of numerous plugins. For instance the C/C++ Development Toolkit (CDT) plugin allows developers to use it as IDE for project in C or C++ language. The use of Eclipse as a generic IDE is possible due to the notion of perspective (a perspective corresponds to a certain disposition of the graphical elements) which adapts the user interface to the kind of project.

Java Native Interface (JNI) is a programming interface to call native methods or to embed java virtual machine in native applications. JNI is often used to interact with existing native application, to add platform-specific functions, or to improve time-performance (by supposing native methods faster than java code).

Currently, when users work on a java project using JNI and native code, they have to switch between perspective, which is not practical. Another point to improve is the debugging of this kind of project, by allowing developers to follow native method calls into native code and go back.

[edit] Goals of the project

  • Create new or 'mixed' perspectives to manage project using C/C++ and Java
  • Add the possibility to follow native methods calls into native code

[edit] Work done

[edit] First step : documentation of existing work

[edit] Second step : prototype

  • work on a prototype which
    • launch a Java Debugger
    • attach a C debugger to the JVM
    • allow you to debug C/C++ code and Java code debugging in the same view

[edit] Third step : tests and debugging

  • a first version is available to download (see below):
    • creation of JUnit tests
    • bugs hunt
    • advertisement and feedback from community


[edit] Roadmap

  • 0.0.4 - not yet planned
    • jvm started in native code debugging
    • see how to integrate in eclipse CDT ?
  • EclipseCon 2008

http://www.eclipsecon.org/2008/index.php?page=sub/&id=105

[edit] Documentation

[edit] How to install the plug-in ?

The most simple is to use the update manager of Eclipse. Simply add this site as "new remote site" :

http://eclipse-incub.svn.sourceforge.net/viewvc/*checkout*/eclipse-incub/org.eclipse.soc.jni/update-site/site.xml

The sources are included in the Jar, but you can get them on the subversion repository:

https://eclipse-incub.svn.sourceforge.net/svnroot/eclipse-incub/org.eclipse.soc.jni

( You may have to install the subclipe plug-in )

[edit] How to use the plug-in ?

You should have some java code which uses JNI and the native code associated. The plug-in should be installed.

[edit] First step

Set a breakpoint in the Java code after the code which loads the native library.

Soc jni J breakpoint.png

[edit] Second step

Open the debug dialog and create a new configuration of "Java JNI Application" kind.

Soc jni Config group.png

[edit] Third step

Set the correct settings for each tab.

  • C/C++ project tab
    Set the C/C++ project and specify the javaw path as C/C++ application.
  • Java project tab
    Set the Java project and the main class.
Soc jni Config tab j main.png
  • Environment tab
    On linux machines you could have to add the current directory to the library path environment variable.


[edit] Fourth step

The debug perspective will be launched with the 2 debuggers. Ready to debug !

Soc jni Debug perspective.png

[edit] How to report a bug/ask for an enhancement ?

On the eclipse bugzilla there is a "org.eclipse.soc.jni" component for the "SOC" product in the "Technology" category. Please include the version of the plug-in and the maximum infos you can obtain.

[edit] FAQ

  • What is the supported eclipse version ?

only eclipse 3.3 is supported for the moment.

  • Is the project still maintained ?

No, I have currently no time to maintain it. All code and documentation are available on svn, wiki and blog. Do not hesitate to contact me if you need further information.

  • What is the current version of the plug-in ?

0.0.3

  • What are the known bugs of the plug-in ?

all bugs open bugs