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-2021 Free Software Foundation, Inc. 4 5Permission is granted to copy, distribute and/or modify this document 6under the terms of the GNU Free Documentation License, Version 1.3 or 7any later version published by the Free Software Foundation; with the 8Invariant Sections being "Free Software" and "Free Software Needs 9Free Documentation", with the Front-Cover Texts being "A GNU Manual," 10and with the Back-Cover Texts as in (a) below. 11 12(a) The FSF's Back-Cover Text is: "You are free to copy and modify 13this GNU Manual. Buying copies from GNU Press supports the FSF in 14developing GNU and promoting software freedom." --> 15<!-- Created by GNU Texinfo 5.1, http://www.gnu.org/software/texinfo/ --> 16<head> 17<title>Debugging with GDB: Registers In Python</title> 18 19<meta name="description" content="Debugging with GDB: Registers In Python"> 20<meta name="keywords" content="Debugging with GDB: Registers In Python"> 21<meta name="resource-type" content="document"> 22<meta name="distribution" content="global"> 23<meta name="Generator" content="makeinfo"> 24<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> 25<link href="index.html#Top" rel="start" title="Top"> 26<link href="Concept-Index.html#Concept-Index" rel="index" title="Concept Index"> 27<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> 28<link href="Python-API.html#Python-API" rel="up" title="Python API"> 29<link href="TUI-Windows-In-Python.html#TUI-Windows-In-Python" rel="next" title="TUI Windows In Python"> 30<link href="Architectures-In-Python.html#Architectures-In-Python" rel="previous" title="Architectures In Python"> 31<style type="text/css"> 32<!-- 33a.summary-letter {text-decoration: none} 34blockquote.smallquotation {font-size: smaller} 35div.display {margin-left: 3.2em} 36div.example {margin-left: 3.2em} 37div.indentedblock {margin-left: 3.2em} 38div.lisp {margin-left: 3.2em} 39div.smalldisplay {margin-left: 3.2em} 40div.smallexample {margin-left: 3.2em} 41div.smallindentedblock {margin-left: 3.2em; font-size: smaller} 42div.smalllisp {margin-left: 3.2em} 43kbd {font-style:oblique} 44pre.display {font-family: inherit} 45pre.format {font-family: inherit} 46pre.menu-comment {font-family: serif} 47pre.menu-preformatted {font-family: serif} 48pre.smalldisplay {font-family: inherit; font-size: smaller} 49pre.smallexample {font-size: smaller} 50pre.smallformat {font-family: inherit; font-size: smaller} 51pre.smalllisp {font-size: smaller} 52span.nocodebreak {white-space:nowrap} 53span.nolinebreak {white-space:nowrap} 54span.roman {font-family:serif; font-weight:normal} 55span.sansserif {font-family:sans-serif; font-weight:normal} 56ul.no-bullet {list-style: none} 57--> 58</style> 59 60 61</head> 62 63<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000"> 64<a name="Registers-In-Python"></a> 65<div class="header"> 66<p> 67Next: <a href="TUI-Windows-In-Python.html#TUI-Windows-In-Python" accesskey="n" rel="next">TUI Windows In Python</a>, Previous: <a href="Architectures-In-Python.html#Architectures-In-Python" accesskey="p" rel="previous">Architectures In Python</a>, Up: <a href="Python-API.html#Python-API" accesskey="u" rel="up">Python API</a> [<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> 68</div> 69<hr> 70<a name="Registers-In-Python-1"></a> 71<h4 class="subsubsection">23.2.2.34 Registers In Python</h4> 72<a name="index-Registers-In-Python"></a> 73 74<p>Python code can request from a <code>gdb.Architecture</code> information 75about the set of registers available 76(see <a href="Architectures-In-Python.html#gdbpy_005farchitecture_005fregisters"><code>Architecture.registers</code></a>). 77The register information is returned as a 78<code>gdb.RegisterDescriptorIterator</code>, which is an iterator that in 79turn returns <code>gdb.RegisterDescriptor</code> objects. 80</p> 81<p>A <code>gdb.RegisterDescriptor</code> does not provide the value of a 82register (see <a href="Frames-In-Python.html#gdbpy_005fframe_005fread_005fregister"><code>Frame.read_register</code></a> 83for reading a register’s value), instead the <code>RegisterDescriptor</code> 84is a way to discover which registers are available for a particular 85architecture. 86</p> 87<p>A <code>gdb.RegisterDescriptor</code> has the following read-only properties: 88</p> 89<dl> 90<dt><a name="index-RegisterDescriptor_002ename"></a>Variable: <strong>RegisterDescriptor.name</strong></dt> 91<dd><p>The name of this register. 92</p></dd></dl> 93 94<p>It is also possible to lookup a register descriptor based on its name 95using the following <code>gdb.RegisterDescriptorIterator</code> function: 96</p> 97<dl> 98<dt><a name="index-RegisterDescriptorIterator_002efind"></a>Function: <strong>RegisterDescriptorIterator.find</strong> <em>(<var>name</var>)</em></dt> 99<dd><p>Takes <var>name</var> as an argument, which must be a string, and returns a 100<code>gdb.RegisterDescriptor</code> for the register with that name, or 101<code>None</code> if there is no register with that name. 102</p></dd></dl> 103 104<p>Python code can also request from a <code>gdb.Architecture</code> 105information about the set of register groups available on a given 106architecture 107(see <a href="Architectures-In-Python.html#gdbpy_005farchitecture_005freggroups"><code>Architecture.register_groups</code></a>). 108</p> 109<p>Every register can be a member of zero or more register groups. Some 110register groups are used internally within <small>GDB</small> to control 111things like which registers must be saved when calling into the 112program being debugged (see <a href="Calling.html#Calling">Calling Program Functions</a>). 113Other register groups exist to allow users to easily see related sets 114of registers in commands like <code>info registers</code> 115(see <a href="Registers.html#info_005fregisters_005freggroup"><code>info registers 116<var>reggroup</var></code></a>). 117</p> 118<p>The register groups information is returned as a 119<code>gdb.RegisterGroupsIterator</code>, which is an iterator that in turn 120returns <code>gdb.RegisterGroup</code> objects. 121</p> 122<p>A <code>gdb.RegisterGroup</code> object has the following read-only 123properties: 124</p> 125<dl> 126<dt><a name="index-RegisterGroup_002ename"></a>Variable: <strong>RegisterGroup.name</strong></dt> 127<dd><p>A string that is the name of this register group. 128</p></dd></dl> 129 130<hr> 131<div class="header"> 132<p> 133Next: <a href="TUI-Windows-In-Python.html#TUI-Windows-In-Python" accesskey="n" rel="next">TUI Windows In Python</a>, Previous: <a href="Architectures-In-Python.html#Architectures-In-Python" accesskey="p" rel="previous">Architectures In Python</a>, Up: <a href="Python-API.html#Python-API" accesskey="u" rel="up">Python API</a> [<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> 134</div> 135 136 137 138</body> 139</html> 140