Architectures-In-Python.html 7.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146
  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: Architectures In Python</title>
  16. <meta name="description" content="Debugging with GDB: Architectures In Python">
  17. <meta name="keywords" content="Debugging with GDB: Architectures In Python">
  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="Python-API.html#Python-API" rel="up" title="Python API">
  26. <link href="Registers-In-Python.html#Registers-In-Python" rel="next" title="Registers In Python">
  27. <link href="Lazy-Strings-In-Python.html#Lazy-Strings-In-Python" rel="previous" title="Lazy Strings In Python">
  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="Architectures-In-Python"></a>
  59. <div class="header">
  60. <p>
  61. Next: <a href="Registers-In-Python.html#Registers-In-Python" accesskey="n" rel="next">Registers In Python</a>, Previous: <a href="Lazy-Strings-In-Python.html#Lazy-Strings-In-Python" accesskey="p" rel="previous">Lazy Strings In Python</a>, Up: <a href="Python-API.html#Python-API" accesskey="u" rel="up">Python API</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="Python-representation-of-architectures"></a>
  65. <h4 class="subsubsection">23.2.2.33 Python representation of architectures</h4>
  66. <a name="index-Python-architectures"></a>
  67. <p><small>GDB</small> uses architecture specific parameters and artifacts in a
  68. number of its various computations. An architecture is represented
  69. by an instance of the <code>gdb.Architecture</code> class.
  70. </p>
  71. <p>A <code>gdb.Architecture</code> class has the following methods:
  72. </p>
  73. <dl>
  74. <dt><a name="index-Architecture_002ename"></a>Function: <strong>Architecture.name</strong> <em>()</em></dt>
  75. <dd><p>Return the name (string value) of the architecture.
  76. </p></dd></dl>
  77. <dl>
  78. <dt><a name="index-Architecture_002edisassemble"></a>Function: <strong>Architecture.disassemble</strong> <em>(<var>start_pc</var> <span class="roman">[</span>, <var>end_pc</var> <span class="roman">[</span>, <var>count</var><span class="roman">]]</span>)</em></dt>
  79. <dd><p>Return a list of disassembled instructions starting from the memory
  80. address <var>start_pc</var>. The optional arguments <var>end_pc</var> and
  81. <var>count</var> determine the number of instructions in the returned list.
  82. If both the optional arguments <var>end_pc</var> and <var>count</var> are
  83. specified, then a list of at most <var>count</var> disassembled instructions
  84. whose start address falls in the closed memory address interval from
  85. <var>start_pc</var> to <var>end_pc</var> are returned. If <var>end_pc</var> is not
  86. specified, but <var>count</var> is specified, then <var>count</var> number of
  87. instructions starting from the address <var>start_pc</var> are returned. If
  88. <var>count</var> is not specified but <var>end_pc</var> is specified, then all
  89. instructions whose start address falls in the closed memory address
  90. interval from <var>start_pc</var> to <var>end_pc</var> are returned. If neither
  91. <var>end_pc</var> nor <var>count</var> are specified, then a single instruction at
  92. <var>start_pc</var> is returned. For all of these cases, each element of the
  93. returned list is a Python <code>dict</code> with the following string keys:
  94. </p>
  95. <dl compact="compact">
  96. <dt><code>addr</code></dt>
  97. <dd><p>The value corresponding to this key is a Python long integer capturing
  98. the memory address of the instruction.
  99. </p>
  100. </dd>
  101. <dt><code>asm</code></dt>
  102. <dd><p>The value corresponding to this key is a string value which represents
  103. the instruction with assembly language mnemonics. The assembly
  104. language flavor used is the same as that specified by the current CLI
  105. variable <code>disassembly-flavor</code>. See <a href="Machine-Code.html#Machine-Code">Machine Code</a>.
  106. </p>
  107. </dd>
  108. <dt><code>length</code></dt>
  109. <dd><p>The value corresponding to this key is the length (integer value) of the
  110. instruction in bytes.
  111. </p>
  112. </dd>
  113. </dl>
  114. </dd></dl>
  115. <a name="gdbpy_005farchitecture_005fregisters"></a><dl>
  116. <dt><a name="index-Architecture_002eregisters"></a>Function: <strong>Architecture.registers</strong> <em>(<span class="roman">[</span> <var>reggroup</var> <span class="roman">]</span>)</em></dt>
  117. <dd><p>Return a <code>gdb.RegisterDescriptorIterator</code> (see <a href="Registers-In-Python.html#Registers-In-Python">Registers In Python</a>) for all of the registers in <var>reggroup</var>, a string that is
  118. the name of a register group. If <var>reggroup</var> is omitted, or is the
  119. empty string, then the register group &lsquo;<samp>all</samp>&rsquo; is assumed.
  120. </p></dd></dl>
  121. <a name="gdbpy_005farchitecture_005freggroups"></a><dl>
  122. <dt><a name="index-Architecture_002eregister_005fgroups"></a>Function: <strong>Architecture.register_groups</strong> <em>()</em></dt>
  123. <dd><p>Return a <code>gdb.RegisterGroupsIterator</code> (see <a href="Registers-In-Python.html#Registers-In-Python">Registers In Python</a>) for all of the register groups available for the
  124. <code>gdb.Architecture</code>.
  125. </p></dd></dl>
  126. <hr>
  127. <div class="header">
  128. <p>
  129. Next: <a href="Registers-In-Python.html#Registers-In-Python" accesskey="n" rel="next">Registers In Python</a>, Previous: <a href="Lazy-Strings-In-Python.html#Lazy-Strings-In-Python" accesskey="p" rel="previous">Lazy Strings In Python</a>, Up: <a href="Python-API.html#Python-API" accesskey="u" rel="up">Python API</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>
  130. </div>
  131. </body>
  132. </html>