You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

169 lines
7.5KB

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <html>
  3. <!-- Copyright (C) 1988-2020 Free Software Foundation, Inc.
  4. Permission is granted to copy, distribute and/or modify this document
  5. under the terms of the GNU Free Documentation License, Version 1.3 or
  6. any later version published by the Free Software Foundation; with the
  7. Invariant Sections being "Free Software" and "Free Software Needs
  8. Free Documentation", with the Front-Cover Texts being "A GNU Manual,"
  9. and with the Back-Cover Texts as in (a) below.
  10. (a) The FSF's Back-Cover Text is: "You are free to copy and modify
  11. this GNU Manual. Buying copies from GNU Press supports the FSF in
  12. developing GNU and promoting software freedom." -->
  13. <!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
  14. <head>
  15. <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
  16. <title>Trace File Format (Debugging with GDB)</title>
  17. <meta name="description" content="Trace File Format (Debugging with GDB)">
  18. <meta name="keywords" content="Trace File Format (Debugging with GDB)">
  19. <meta name="resource-type" content="document">
  20. <meta name="distribution" content="global">
  21. <meta name="Generator" content="makeinfo">
  22. <link href="index.html#Top" rel="start" title="Top">
  23. <link href="Concept-Index.html#Concept-Index" rel="index" title="Concept Index">
  24. <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
  25. <link href="index.html#Top" rel="up" title="Top">
  26. <link href="Index-Section-Format.html#Index-Section-Format" rel="next" title="Index Section Format">
  27. <link href="Process-list.html#Process-list" rel="prev" title="Process list">
  28. <style type="text/css">
  29. <!--
  30. a.summary-letter {text-decoration: none}
  31. blockquote.indentedblock {margin-right: 0em}
  32. blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
  33. blockquote.smallquotation {font-size: smaller}
  34. div.display {margin-left: 3.2em}
  35. div.example {margin-left: 3.2em}
  36. div.lisp {margin-left: 3.2em}
  37. div.smalldisplay {margin-left: 3.2em}
  38. div.smallexample {margin-left: 3.2em}
  39. div.smalllisp {margin-left: 3.2em}
  40. kbd {font-style: oblique}
  41. pre.display {font-family: inherit}
  42. pre.format {font-family: inherit}
  43. pre.menu-comment {font-family: serif}
  44. pre.menu-preformatted {font-family: serif}
  45. pre.smalldisplay {font-family: inherit; font-size: smaller}
  46. pre.smallexample {font-size: smaller}
  47. pre.smallformat {font-family: inherit; font-size: smaller}
  48. pre.smalllisp {font-size: smaller}
  49. span.nolinebreak {white-space: nowrap}
  50. span.roman {font-family: initial; font-weight: normal}
  51. span.sansserif {font-family: sans-serif; font-weight: normal}
  52. ul.no-bullet {list-style: none}
  53. -->
  54. </style>
  55. </head>
  56. <body lang="en">
  57. <a name="Trace-File-Format"></a>
  58. <div class="header">
  59. <p>
  60. Next: <a href="Index-Section-Format.html#Index-Section-Format" accesskey="n" rel="next">Index Section Format</a>, Previous: <a href="Operating-System-Information.html#Operating-System-Information" accesskey="p" rel="prev">Operating System Information</a>, Up: <a href="index.html#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html#Concept-Index" title="Index" rel="index">Index</a>]</p>
  61. </div>
  62. <hr>
  63. <a name="Trace-File-Format-1"></a>
  64. <h2 class="appendix">Appendix I Trace File Format</h2>
  65. <a name="index-trace-file-format"></a>
  66. <p>The trace file comes in three parts: a header, a textual description
  67. section, and a trace frame section with binary data.
  68. </p>
  69. <p>The header has the form <code>\x7fTRACE0\n</code>. The first byte is
  70. <code>0x7f</code> so as to indicate that the file contains binary data,
  71. while the <code>0</code> is a version number that may have different values
  72. in the future.
  73. </p>
  74. <p>The description section consists of multiple lines of <small>ASCII</small> text
  75. separated by newline characters (<code>0xa</code>). The lines may include a
  76. variety of optional descriptive or context-setting information, such
  77. as tracepoint definitions or register set size. <small>GDB</small> will
  78. ignore any line that it does not recognize. An empty line marks the end
  79. of this section.
  80. </p>
  81. <dl compact="compact">
  82. <dt><code>R <var>size</var></code></dt>
  83. <dd><p>Specifies the size of a register block in bytes. This is equal to the
  84. size of a <code>g</code> packet payload in the remote protocol. <var>size</var>
  85. is an ascii decimal number. There should be only one such line in
  86. a single trace file.
  87. </p>
  88. </dd>
  89. <dt><code>status <var>status</var></code></dt>
  90. <dd><p>Trace status. <var>status</var> has the same format as a <code>qTStatus</code>
  91. remote packet reply. There should be only one such line in a single trace
  92. file.
  93. </p>
  94. </dd>
  95. <dt><code>tp <var>payload</var></code></dt>
  96. <dd><p>Tracepoint definition. The <var>payload</var> has the same format as
  97. <code>qTfP</code>/<code>qTsP</code> remote packet reply payload. A single tracepoint
  98. may take multiple lines of definition, corresponding to the multiple
  99. reply packets.
  100. </p>
  101. </dd>
  102. <dt><code>tsv <var>payload</var></code></dt>
  103. <dd><p>Trace state variable definition. The <var>payload</var> has the same format as
  104. <code>qTfV</code>/<code>qTsV</code> remote packet reply payload. A single variable
  105. may take multiple lines of definition, corresponding to the multiple
  106. reply packets.
  107. </p>
  108. </dd>
  109. <dt><code>tdesc <var>payload</var></code></dt>
  110. <dd><p>Target description in XML format. The <var>payload</var> is a single line of
  111. the XML file. All such lines should be concatenated together to get
  112. the original XML file. This file is in the same format as <code>qXfer</code>
  113. <code>features</code> payload, and corresponds to the main <code>target.xml</code>
  114. file. Includes are not allowed.
  115. </p>
  116. </dd>
  117. </dl>
  118. <p>The trace frame section consists of a number of consecutive frames.
  119. Each frame begins with a two-byte tracepoint number, followed by a
  120. four-byte size giving the amount of data in the frame. The data in
  121. the frame consists of a number of blocks, each introduced by a
  122. character indicating its type (at least register, memory, and trace
  123. state variable). The data in this section is raw binary, not a
  124. hexadecimal or other encoding; its endianness matches the target&rsquo;s
  125. endianness.
  126. </p>
  127. <dl compact="compact">
  128. <dt><code>R <var>bytes</var></code></dt>
  129. <dd><p>Register block. The number and ordering of bytes matches that of a
  130. <code>g</code> packet in the remote protocol. Note that these are the
  131. actual bytes, in target order, not a hexadecimal encoding.
  132. </p>
  133. </dd>
  134. <dt><code>M <var>address</var> <var>length</var> <var>bytes</var>...</code></dt>
  135. <dd><p>Memory block. This is a contiguous block of memory, at the 8-byte
  136. address <var>address</var>, with a 2-byte length <var>length</var>, followed by
  137. <var>length</var> bytes.
  138. </p>
  139. </dd>
  140. <dt><code>V <var>number</var> <var>value</var></code></dt>
  141. <dd><p>Trace state variable block. This records the 8-byte signed value
  142. <var>value</var> of trace state variable numbered <var>number</var>.
  143. </p>
  144. </dd>
  145. </dl>
  146. <p>Future enhancements of the trace file format may include additional types
  147. of blocks.
  148. </p>
  149. <hr>
  150. <div class="header">
  151. <p>
  152. Next: <a href="Index-Section-Format.html#Index-Section-Format" accesskey="n" rel="next">Index Section Format</a>, Previous: <a href="Operating-System-Information.html#Operating-System-Information" accesskey="p" rel="prev">Operating System Information</a>, Up: <a href="index.html#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html#Concept-Index" title="Index" rel="index">Index</a>]</p>
  153. </div>
  154. </body>
  155. </html>