dwarf5/latexdoc/sectionversionnumbers.tex

   1
   2 \chapter[Section Version Numbers (Informative)]{DWARF Section Version Numbers (Informative)}
   3 \label{app:dwarfsectionversionnumbersinformative}
   4 \addtoindexx{version number!summary by section}
   5
   6 % The table format looks rather different that V4 and earlier
   7 % as latex took up too much space and left no room for V5
   8 % or later.  The new format uses space more efficiently.
   9
  10 Most DWARF sections have a version number in the section
  11 header. This version number is not tied to the DWARF standard
  12 revision numbers, but instead is incremented when incompatible
  13 changes to that section are made. The DWARF standard that
  14 a producer is following is not explicitly encoded in the
  15 file. Version numbers in the section headers are represented
  16 as two byte unsigned integers.
  17
  18 Table \refersec{tab:sectionversionnumbers}
  19 shows what version
  20 numbers are in use for each section. In that table:
  21 \begin{itemize}
  22 \setlength{\itemsep}{0em}
  23 \item  \doublequote{V2} means \addtoindex{DWARF Version 2}, published July 27, 1993.
  24 \item  \doublequote{V3} means \addtoindex{DWARF Version 3}, published December 20, 2005.
  25 \item  \doublequote{V4} means \addtoindex{DWARF Version 4}, published June 10, 2010.
  26 \item  \doublequote{V5} means \addtoindex{DWARF Version 5}\footnote{Higher numbers are reserved for future use.}, published
  27                         \ifthenelse{\boolean{isdraft}}{\textit{<to be determined>}}{\docdate}.
  28 \end{itemize}
  29
  30 There are sections with no version number encoded in them;
  31 they are only accessed via the
  32 \dotdebuginfo{}
  33 sections and so an incompatible change in those sections'
  34 format would be represented by a change in the
  35 \dotdebuginfo{} section version number.
  36
  37 \needlines{10}
  38 \begin{centering}
  39 \setlength{\extrarowheight}{0.1cm}
  40 \begin{longtable}{lcccc}
  41   \caption{Section version numbers} \label{tab:sectionversionnumbers} \\
  42   \hline
  43   \bfseries Section Name &\bfseries V2 &\bfseries V3 &\bfseries V4
  44                          &\bfseries V5 \\
  45   \hline
  46 \endfirsthead
  47    \bfseries Section Name &\bfseries V2 &\bfseries V3 &\bfseries V4 &\bfseries V5 \\ \hline
  48 \endhead
  49   \hline \emph{Continued on next page}
  50 \endfoot
  51   \hline
  52 \endlastfoot
  53 \dotdebugabbrev{}   & * & * & * & * \\
  54 \dotdebugaddr{}     & - & - & - & 5 \\
  55 \dotdebugaranges{}  & 2 & 2 & 2 & 2 \\
  56 \dotdebugframe{}\footnote{\textit{For the \dotdebugframe{} section, version 2 is unused.}}
  57                     & 1 & 3 & 4 & 4 \\
  58 \dotdebuginfo{}     & 2 & 3 & 4 & 5 \\
  59 \dotdebugline{}     & 2 & 3 & 4 & 5 \\
  60 \dotdebuglinestr{}  & - & - & - & 5 \\
  61 \bb
  62 \addtoindexi{\texttt{.debug\_loc}}{\texttt{.debug\_loc} (Version 4)}
  63                     & * & * & * & - \\
  64 \dotdebugloclists{} & - & - & - & 5
  65 \eb \\
  66 \dotdebugmacinfo{}  & * & * & * & - \\*
  67 \dotdebugmacro{}    & - & - & - & 5 \\
  68 \dotdebugnames{}    & - & - & - & 5 \\
  69 \dotdebugpubnames{} & 2 & 2 & 2 & - \\
  70 \dotdebugpubtypes{} & - & 2 & 2 & - \\
  71 \bb
  72 \addtoindexi{\texttt{.debug\_ranges}}{\texttt{.debug\_ranges} (Version 4)}
  73                     & - & * & * & - \\
  74 \dotdebugrnglists{} & - & - & - & 5
  75 \eb \\
  76 \dotdebugstr{}      & * & * & * & * \\
  77 \dotdebugstroffsets & - & - & - & 5 \\
  78 \dotdebugsup        & - & - & - & 5 \\
  79 \addtoindexi{\texttt{.debug\_types}}{\texttt{.debug\_types} (Version 4)}
  80                     & - & - & 4 & - \\
  81 \\
  82 \hspace{3.5cm}\textit{(split object sections)}
  83 \\
  84 \dotdebugabbrevdwo  & - & - & - & * \\
  85 \dotdebuginfodwo    & - & - & - & 5 \\
  86 \dotdebuglinedwo    & - & - & - & 5 \\
  87 \bb
  88 \dotdebugloclistsdwo& - & - & - & 5
  89 \eb \\
  90 \dotdebugmacrodwo   & - & - & - & 5 \\
  91 \bb
  92 \dotdebugrnglistsdwo& - & - & - & 5
  93 \eb \\
  94
  95 \dotdebugstrdwo     & - & - & - & * \\
  96 \dotdebugstroffsetsdwo
  97                     & - & - & - & 5 \\
  98
  99 \hspace{3.5cm}\textit{(package file sections)}
 100 \\
 101 \dotdebugcuindex{}  & - & - & - & 5 \\
 102 \dotdebugtuindex{}  & - & - & - & 5 \\
 103 \end{longtable}
 104 \end{centering}
 105
 106 \needlines{8}
 107 Notes:
 108 \begin{itemize}
 109 \item  \doublequote{*} means that a version number is not applicable
 110 (the section does not include a header or the section's header does not include a version).
 111 \item  \doublequote{-} means that the section was not defined in that
 112 version of the DWARF standard.
 113 \item  The version numbers for corresponding .debug\_<kind> and .debug\_<kind>.dwo
 114 sections are the same.
 115 \end{itemize}
 116
 117