Traceframe-Info-Format.html 5.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133
  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 5.1, http://www.gnu.org/software/texinfo/ -->
  14. <head>
  15. <title>Debugging with GDB: Traceframe Info Format</title>
  16. <meta name="description" content="Debugging with GDB: Traceframe Info Format">
  17. <meta name="keywords" content="Debugging with GDB: Traceframe Info Format">
  18. <meta name="resource-type" content="document">
  19. <meta name="distribution" content="global">
  20. <meta name="Generator" content="makeinfo">
  21. <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
  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="Remote-Protocol.html#Remote-Protocol" rel="up" title="Remote Protocol">
  26. <link href="Branch-Trace-Format.html#Branch-Trace-Format" rel="next" title="Branch Trace Format">
  27. <link href="Thread-List-Format.html#Thread-List-Format" rel="previous" title="Thread List Format">
  28. <style type="text/css">
  29. <!--
  30. a.summary-letter {text-decoration: none}
  31. blockquote.smallquotation {font-size: smaller}
  32. div.display {margin-left: 3.2em}
  33. div.example {margin-left: 3.2em}
  34. div.indentedblock {margin-left: 3.2em}
  35. div.lisp {margin-left: 3.2em}
  36. div.smalldisplay {margin-left: 3.2em}
  37. div.smallexample {margin-left: 3.2em}
  38. div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
  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.nocodebreak {white-space:nowrap}
  50. span.nolinebreak {white-space:nowrap}
  51. span.roman {font-family:serif; font-weight:normal}
  52. span.sansserif {font-family:sans-serif; font-weight:normal}
  53. ul.no-bullet {list-style: none}
  54. -->
  55. </style>
  56. </head>
  57. <body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
  58. <a name="Traceframe-Info-Format"></a>
  59. <div class="header">
  60. <p>
  61. Next: <a href="Branch-Trace-Format.html#Branch-Trace-Format" accesskey="n" rel="next">Branch Trace Format</a>, Previous: <a href="Thread-List-Format.html#Thread-List-Format" accesskey="p" rel="previous">Thread List Format</a>, Up: <a href="Remote-Protocol.html#Remote-Protocol" accesskey="u" rel="up">Remote Protocol</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>
  62. </div>
  63. <hr>
  64. <a name="Traceframe-Info-Format-1"></a>
  65. <h3 class="section">E.18 Traceframe Info Format</h3>
  66. <a name="index-traceframe-info-format"></a>
  67. <p>To be able to know which objects in the inferior can be examined when
  68. inspecting a tracepoint hit, <small>GDB</small> needs to obtain the list of
  69. memory ranges, registers and trace state variables that have been
  70. collected in a traceframe.
  71. </p>
  72. <p>This list is obtained using the &lsquo;<samp>qXfer:traceframe-info:read</samp>&rsquo;
  73. (see <a href="General-Query-Packets.html#qXfer-traceframe-info-read">qXfer traceframe info read</a>) packet and is an XML document.
  74. </p>
  75. <p><small>GDB</small> must be linked with the Expat library to support XML
  76. traceframe info discovery. See <a href="Requirements.html#Expat">Expat</a>.
  77. </p>
  78. <p>The top-level structure of the document is shown below:
  79. </p>
  80. <div class="smallexample">
  81. <pre class="smallexample">&lt;?xml version=&quot;1.0&quot;?&gt;
  82. &lt;!DOCTYPE traceframe-info
  83. PUBLIC &quot;+//IDN gnu.org//DTD GDB Memory Map V1.0//EN&quot;
  84. &quot;http://sourceware.org/gdb/gdb-traceframe-info.dtd&quot;&gt;
  85. &lt;traceframe-info&gt;
  86. block...
  87. &lt;/traceframe-info&gt;
  88. </pre></div>
  89. <p>Each traceframe block can be either:
  90. </p>
  91. <ul>
  92. <li> A region of collected memory starting at <var>addr</var> and extending for
  93. <var>length</var> bytes from there:
  94. <div class="smallexample">
  95. <pre class="smallexample">&lt;memory start=&quot;<var>addr</var>&quot; length=&quot;<var>length</var>&quot;/&gt;
  96. </pre></div>
  97. </li><li> A block indicating trace state variable numbered <var>number</var> has been
  98. collected:
  99. <div class="smallexample">
  100. <pre class="smallexample">&lt;tvar id=&quot;<var>number</var>&quot;/&gt;
  101. </pre></div>
  102. </li></ul>
  103. <p>The formal DTD for the traceframe info format is given below:
  104. </p>
  105. <div class="smallexample">
  106. <pre class="smallexample">&lt;!ELEMENT traceframe-info (memory | tvar)* &gt;
  107. &lt;!ATTLIST traceframe-info version CDATA #FIXED &quot;1.0&quot;&gt;
  108. &lt;!ELEMENT memory EMPTY&gt;
  109. &lt;!ATTLIST memory start CDATA #REQUIRED
  110. length CDATA #REQUIRED&gt;
  111. &lt;!ELEMENT tvar&gt;
  112. &lt;!ATTLIST tvar id CDATA #REQUIRED&gt;
  113. </pre></div>
  114. </body>
  115. </html>