Features/DebugTypesSections

From FedoraProject

< Features(Difference between revisions)
Jump to: navigation, search
(first draft)
 
(obsolete)
 
(3 intermediate revisions by one user not shown)
Line 8: Line 8:
 
== Summary ==
 
== Summary ==
  
DWARF 4 added a new ".debug_types" section -- a relatively simple and cheap way to compress DWARF debugging information.  This feature changes Fedora to take advantage of this compression.
+
DWARF 4 added a new ".debug_types" section.  This section enables a relatively simple and cheap way to compress DWARF debugging information.  This feature changes Fedora to take advantage of this compression.
  
 
== Owner ==
 
== Owner ==
Line 16: Line 16:
  
 
== Current status ==
 
== Current status ==
* Targeted release: [[Releases/18 | Fedora 18 ]]  
+
* Obsoleted by [[Features/DwarfCompressor]]
* Last updated: 2012-03-21
+
* Percentage of completion: 50%
+
  
  
 
== Detailed Description ==
 
== Detailed Description ==
  
This feature was implemented in GCC and GDB quite a while ago, but until now Fedora has not taken advantage of it.  The compression is quite good; building gdb with this option reduces the size of the final executable from 17M to 11M.
+
This feature works by enabling a compiler option that instructs GCC to put "large" types into comdat sections in the object files.  Then, the linker automatically merges all such shared types when linking.  Since types occupy a reasonable proportion of the DWARF data, and because types are often identically across compliation units, this results in space savings.
 +
 
 +
The .debug_types feature was implemented in GCC and GDB quite a while ago, but until now Fedora has not taken advantage of it.  The compression is quite good.  For exmaple, building gdb with this option reduces the size of the final executable from 17M to 11M.  A stripped gdb is 6.7M; meaning that this flag removes around 60% of the debuginfo.
  
 
== Benefit to Fedora ==
 
== Benefit to Fedora ==
Line 35: Line 35:
 
* Either change GCC to enable <code>-fdebug-types-section</code> by default, or add this to the default compiler flags used when building RPMs.
 
* Either change GCC to enable <code>-fdebug-types-section</code> by default, or add this to the default compiler flags used when building RPMs.
  
* Update SystemTap to handle the new section properly.  (Done)
+
* Update SystemTap to handle the new section properly.  (In stap git repository now; must ensure it is in the stap that is shipped in F18.)
  
* Update the dwarves package to handle the new section properly.
+
* Update the dwarves package to handle the new section properly. ([[https://github.com/acmel/dwarves/pulls Patch submitted]])
  
* Update valgrind to handle the new section properly.
+
* Update valgrind to handle the new section properly. The patch is in but must be backported to the Fedora valgrind; see https://bugzilla.redhat.com/show_bug.cgi?id=810286
  
 
* Disable the new flag for kernel builds.  This is needed because libdw cannot handle the multiple .debug_types sections that can appear in ET_REL files -- which includes kernel modules.
 
* Disable the new flag for kernel builds.  This is needed because libdw cannot handle the multiple .debug_types sections that can appear in ET_REL files -- which includes kernel modules.
Line 69: Line 69:
 
== Release Notes ==
 
== Release Notes ==
  
TBD.
+
Packages built in Fedora 18 are compiled with -fdebug-types-section, yielding much smaller debuginfo packages.  The new debuginfo is specified by the DWARF 4 standard; some debuginfo-reading packages may need updates in order to understand the new data.  All DWARF-reading packages in Fedora 18 have been updated.
  
 
== Comments and Discussion ==
 
== Comments and Discussion ==

Latest revision as of 15:13, 11 May 2012


Contents

[edit] Debug Types Sections

[edit] Summary

DWARF 4 added a new ".debug_types" section. This section enables a relatively simple and cheap way to compress DWARF debugging information. This feature changes Fedora to take advantage of this compression.

[edit] Owner

  • Email: tromey@redhat.com

[edit] Current status


[edit] Detailed Description

This feature works by enabling a compiler option that instructs GCC to put "large" types into comdat sections in the object files. Then, the linker automatically merges all such shared types when linking. Since types occupy a reasonable proportion of the DWARF data, and because types are often identically across compliation units, this results in space savings.

The .debug_types feature was implemented in GCC and GDB quite a while ago, but until now Fedora has not taken advantage of it. The compression is quite good. For exmaple, building gdb with this option reduces the size of the final executable from 17M to 11M. A stripped gdb is 6.7M; meaning that this flag removes around 60% of the debuginfo.

[edit] Benefit to Fedora

This reduces the size of debuginfo by quite a bit, just by enabling a compiler flag.

[edit] Scope

Several changes are needed to integrate this change into Fedora:

  • Either change GCC to enable -fdebug-types-section by default, or add this to the default compiler flags used when building RPMs.
  • Update SystemTap to handle the new section properly. (In stap git repository now; must ensure it is in the stap that is shipped in F18.)
  • Update the dwarves package to handle the new section properly. ([Patch submitted])
  • Disable the new flag for kernel builds. This is needed because libdw cannot handle the multiple .debug_types sections that can appear in ET_REL files -- which includes kernel modules.

[edit] How To Test

You can easily verify whether the new section is in use using something like:

  • readelf -WS some-executable-or-library | fgrep .debug_types

Another test is whether the various tools that read debuginfo continue to work. This is best done by running their respective test suites.

[edit] User Experience

Users may notice faster download times, less disk space used, or faster startup for tools that read debuginfo.

[edit] Dependencies

The main dependency is upstream approval of the patches for the various affected projects.

[edit] Contingency Plan

No plan needed; we can continue with the current setup.

[edit] Documentation

[edit] Release Notes

Packages built in Fedora 18 are compiled with -fdebug-types-section, yielding much smaller debuginfo packages. The new debuginfo is specified by the DWARF 4 standard; some debuginfo-reading packages may need updates in order to understand the new data. All DWARF-reading packages in Fedora 18 have been updated.

[edit] Comments and Discussion