Features/DragonEgg

From FedoraProject

< Features(Difference between revisions)
Jump to: navigation, search
(Created page with "<!-- All fields on this form are required to be accepted by FESCo. We also request that you maintain the same order of sections so that all of the feature pages are uniform. --...")
 
(Feature DragonEgg has been accepted for F18 by FESCo on the Jun 18 meeting (ticket #865))
 
(11 intermediate revisions by 2 users not shown)
Line 8: Line 8:
 
== Summary ==
 
== Summary ==
 
<!-- A sentence or two summarizing what this feature is and what it will do.  This information is used for the overall feature summary page for each release. -->
 
<!-- A sentence or two summarizing what this feature is and what it will do.  This information is used for the overall feature summary page for each release. -->
 +
DragonEgg is a gcc plugin that replaces GCC's optimizers and code generators with those from the LLVM project.
  
 
== Owner ==
 
== Owner ==
Line 17: Line 18:
  
 
== Current status ==
 
== Current status ==
* Targeted release: [[Releases/<number> | Fedora <number> ]]  
+
* Targeted release: [[Releases/18 | Fedora 18 ]]  
* Last updated: (DATE)
+
* Last updated: 2012-06-10
 
* Percentage of completion: 100%
 
* Percentage of completion: 100%
  
Line 25: Line 26:
 
== Detailed Description ==
 
== Detailed Description ==
 
<!-- Expand on the summary, if appropriate.  A couple sentences suffices to explain the goal, but the more details you can provide the better. -->
 
<!-- Expand on the summary, if appropriate.  A couple sentences suffices to explain the goal, but the more details you can provide the better. -->
 +
DragonEgg is a GCC plugin that replaces GCC's optimizers and code generators with those from the LLVM project. It can target the x86-32/x86-64 and ARM processor families. It fully supports C, C++ and Fortran. It has partial support for Ada, Go, Java, Obj-C and Obj-C++.
  
 
== Benefit to Fedora ==
 
== Benefit to Fedora ==
 
<!-- What is the benefit to the platform?  If this is a major capability update, what has changed?  If this is a new feature, what capabilities does it bring? Why will Fedora become a better distribution or project because of this feature?-->
 
<!-- What is the benefit to the platform?  If this is a major capability update, what has changed?  If this is a new feature, what capabilities does it bring? Why will Fedora become a better distribution or project because of this feature?-->
 +
Inclusion of DragonEgg in Fedora Linux provides software developers with more optimization and code generation options for use of the GCC compilers with most of languages supported by GCC.  DragonEgg also allows GCC to be used for cross-compilation to target architectures supported by LLVM without requiring any special cross-compilation compiler packages.
  
 
== Scope ==
 
== Scope ==
 
<!-- What work do the developers have to accomplish to complete the feature in time for release?  Is it a large change affecting many parts of the distribution or is it a very isolated change? What are those changes?-->
 
<!-- What work do the developers have to accomplish to complete the feature in time for release?  Is it a large change affecting many parts of the distribution or is it a very isolated change? What are those changes?-->
 +
Each DragonEgg release is dependent on the corresponding release of LLVM, and also supports specific releases of GCC.  The package maintainer will have to track these releases.  The DragonEgg feature does not affect other parts of the distribution.
  
 
== How To Test ==
 
== How To Test ==
<!-- This does not need to be a full-fledged document.  Describe the dimensions of tests that this feature is expected to pass when it is done.  If it needs to be tested with different hardware or software configurations, indicate them.  The more specific you can be, the better the community testing can be.
+
* No special hardware/data/etc. is needed.
 
+
* There should not be any special preparation needed beyond installation of the dragonegg package.
Remember that you are writing this how to for interested testers to use to check out your feature - documenting what you do for testing is OK, but it's much better to document what *I* can do to test your feature.
+
* Compile a few C (or Fortran, etc.) programs using GCC with dragonegg. This is done by invoking GCC in the normal way, but with the addition of a "-fplugin=dragonegg" command line argument.
 
+
* Programs compiled using GCC with dragonegg should produce the same results as those compiled with normal GCC, though the performance may vary since different optimizers and code generators are used.
A good "how to test" should answer these four questions:
+
 
+
0. What special hardware / data / etc. is needed (if any)?
+
1. How do I prepare my system to test this feature? What packages
+
need to be installed, config files edited, etc.?
+
2. What specific actions do I perform to check that the feature is
+
working like it's supposed to?
+
3. What are the expected results of those actions?
+
-->
+
  
 
== User Experience ==
 
== User Experience ==
 
<!-- If this feature is noticeable by its target audience, how will their experiences change as a result?  Describe what they will see or notice. -->
 
<!-- If this feature is noticeable by its target audience, how will their experiences change as a result?  Describe what they will see or notice. -->
 +
* This package is only applicable to developers, and will not directly affect user experience.
  
 
== Dependencies ==
 
== Dependencies ==
 
<!-- What other packages (RPMs) depend on this package?  Are there changes outside the developers' control on which completion of this feature depends?  In other words, completion of another feature owned by someone else and might cause you to not be able to finish on time or that you would need to coordinate?  Other upstream projects like the kernel (if this is not a kernel feature)? -->
 
<!-- What other packages (RPMs) depend on this package?  Are there changes outside the developers' control on which completion of this feature depends?  In other words, completion of another feature owned by someone else and might cause you to not be able to finish on time or that you would need to coordinate?  Other upstream projects like the kernel (if this is not a kernel feature)? -->
 +
* No other packages presently depend on this feature.
  
 
== Contingency Plan ==
 
== Contingency Plan ==
 
<!-- If you cannot complete your feature by the final development freeze, what is the backup plan?  This might be as simple as "None necessary, revert to previous release behaviour."  Or it might not.  If you feature is not completed in time we want to assure others that other parts of Fedora will not be in jeopardy.  -->
 
<!-- If you cannot complete your feature by the final development freeze, what is the backup plan?  This might be as simple as "None necessary, revert to previous release behaviour."  Or it might not.  If you feature is not completed in time we want to assure others that other parts of Fedora will not be in jeopardy.  -->
None necessary.  DragonEgg can be omitted if there are problems.
+
* None necessary.  DragonEgg can be omitted if there are problems.
  
 
== Documentation ==
 
== Documentation ==
 
<!-- Is there upstream documentation on this feature, or notes you have written yourself?  Link to that material here so other interested developers can get involved. -->
 
<!-- Is there upstream documentation on this feature, or notes you have written yourself?  Link to that material here so other interested developers can get involved. -->
*
+
* [http://dragonegg.llvm.org/ DragonEgg web site]
  
 
== Release Notes ==
 
== Release Notes ==
 
<!-- The Fedora Release Notes inform end-users about what is new in the release.  Examples of past release notes are here: http://docs.fedoraproject.org/release-notes/ -->
 
<!-- The Fedora Release Notes inform end-users about what is new in the release.  Examples of past release notes are here: http://docs.fedoraproject.org/release-notes/ -->
 
<!-- The release notes also help users know how to deal with platform changes such as ABIs/APIs, configuration or data file formats, or upgrade concerns.  If there are any such changes involved in this feature, indicate them here.  You can also link to upstream documentation if it satisfies this need.  This information forms the basis of the release notes edited by the documentation team and shipped with the release. -->
 
<!-- The release notes also help users know how to deal with platform changes such as ABIs/APIs, configuration or data file formats, or upgrade concerns.  If there are any such changes involved in this feature, indicate them here.  You can also link to upstream documentation if it satisfies this need.  This information forms the basis of the release notes edited by the documentation team and shipped with the release. -->
*
+
* DragonEgg is a plugin for the GCC compilers to allow use of the LLVM optimization and code generation framework.  DragonEgg provides software developers with more optimization and code generation options for use with the GCC compilers.  DragonEgg also allows GCC to be used for cross-compilation to target architectures supported by LLVM without requiring any special cross-compilation compiler packages.
  
 
== Comments and Discussion ==
 
== Comments and Discussion ==
* See [[Talk:Features/Your_Feature_Name]]  <!-- This adds a link to the "discussion" tab associated with your page.  This provides the ability to have ongoing comments or conversation without bogging down the main feature page -->
+
* See [[Talk:Features/DragonEgg]]  <!-- This adds a link to the "discussion" tab associated with your page.  This provides the ability to have ongoing comments or conversation without bogging down the main feature page -->
  
  
[[Category:FeaturePageIncomplete]]
+
[[Category:FeatureAcceptedF18]]
 
<!-- When your feature page is completed and ready for review -->
 
<!-- When your feature page is completed and ready for review -->
 
<!-- remove Category:FeaturePageIncomplete and change it to Category:FeatureReadyForWrangler -->
 
<!-- remove Category:FeaturePageIncomplete and change it to Category:FeatureReadyForWrangler -->
 
<!-- After review, the feature wrangler will move your page to Category:FeatureReadyForFesco... if it still needs more work it will move back to Category:FeaturePageIncomplete-->
 
<!-- After review, the feature wrangler will move your page to Category:FeatureReadyForFesco... if it still needs more work it will move back to Category:FeaturePageIncomplete-->
 
<!-- A pretty picture of the page category usage is at: https://fedoraproject.org/wiki/Features/Policy/Process -->
 
<!-- A pretty picture of the page category usage is at: https://fedoraproject.org/wiki/Features/Policy/Process -->

Latest revision as of 11:40, 12 July 2012


Contents

[edit] DragonEgg

[edit] Summary

DragonEgg is a gcc plugin that replaces GCC's optimizers and code generators with those from the LLVM project.

[edit] Owner

  • Email: eric@brouhaha.com

[edit] Current status

  • Targeted release: Fedora 18
  • Last updated: 2012-06-10
  • Percentage of completion: 100%


[edit] Detailed Description

DragonEgg is a GCC plugin that replaces GCC's optimizers and code generators with those from the LLVM project. It can target the x86-32/x86-64 and ARM processor families. It fully supports C, C++ and Fortran. It has partial support for Ada, Go, Java, Obj-C and Obj-C++.

[edit] Benefit to Fedora

Inclusion of DragonEgg in Fedora Linux provides software developers with more optimization and code generation options for use of the GCC compilers with most of languages supported by GCC. DragonEgg also allows GCC to be used for cross-compilation to target architectures supported by LLVM without requiring any special cross-compilation compiler packages.

[edit] Scope

Each DragonEgg release is dependent on the corresponding release of LLVM, and also supports specific releases of GCC. The package maintainer will have to track these releases. The DragonEgg feature does not affect other parts of the distribution.

[edit] How To Test

  • No special hardware/data/etc. is needed.
  • There should not be any special preparation needed beyond installation of the dragonegg package.
  • Compile a few C (or Fortran, etc.) programs using GCC with dragonegg. This is done by invoking GCC in the normal way, but with the addition of a "-fplugin=dragonegg" command line argument.
  • Programs compiled using GCC with dragonegg should produce the same results as those compiled with normal GCC, though the performance may vary since different optimizers and code generators are used.

[edit] User Experience

  • This package is only applicable to developers, and will not directly affect user experience.

[edit] Dependencies

  • No other packages presently depend on this feature.

[edit] Contingency Plan

  • None necessary. DragonEgg can be omitted if there are problems.

[edit] Documentation

[edit] Release Notes

  • DragonEgg is a plugin for the GCC compilers to allow use of the LLVM optimization and code generation framework. DragonEgg provides software developers with more optimization and code generation options for use with the GCC compilers. DragonEgg also allows GCC to be used for cross-compilation to target architectures supported by LLVM without requiring any special cross-compilation compiler packages.

[edit] Comments and Discussion