| 1 | @c Copyright (C) 2008--2021 Free Software Foundation, Inc. |
| 2 | @c Permission is granted to copy, distribute and/or modify this document |
| 3 | @c under the terms of the GNU Free Documentation License, Version 1.3 or |
| 4 | @c any later version published by the Free Software Foundation; with the |
| 5 | @c Invariant Sections being ``Free Software'' and ``Free Software Needs |
| 6 | @c Free Documentation'', with the Front-Cover Texts being ``A GNU Manual,'' |
| 7 | @c and with the Back-Cover Texts as in (a) below. |
| 8 | @c |
| 9 | @c (a) The FSF's Back-Cover Text is: ``You are free to copy and modify |
| 10 | @c this GNU Manual. Buying copies from GNU Press supports the FSF in |
| 11 | @c developing GNU and promoting software freedom.'' |
| 12 | |
| 13 | @node Python |
| 14 | @section Extending @value{GDBN} using Python |
| 15 | @cindex python scripting |
| 16 | @cindex scripting with python |
| 17 | |
| 18 | You can extend @value{GDBN} using the @uref{http://www.python.org/, |
| 19 | Python programming language}. This feature is available only if |
| 20 | @value{GDBN} was configured using @option{--with-python}. |
| 21 | @value{GDBN} can be built against either Python 2 or Python 3; which |
| 22 | one you have depends on this configure-time option. |
| 23 | |
| 24 | @cindex python directory |
| 25 | Python scripts used by @value{GDBN} should be installed in |
| 26 | @file{@var{data-directory}/python}, where @var{data-directory} is |
| 27 | the data directory as determined at @value{GDBN} startup (@pxref{Data Files}). |
| 28 | This directory, known as the @dfn{python directory}, |
| 29 | is automatically added to the Python Search Path in order to allow |
| 30 | the Python interpreter to locate all scripts installed at this location. |
| 31 | |
| 32 | Additionally, @value{GDBN} commands and convenience functions which |
| 33 | are written in Python and are located in the |
| 34 | @file{@var{data-directory}/python/gdb/command} or |
| 35 | @file{@var{data-directory}/python/gdb/function} directories are |
| 36 | automatically imported when @value{GDBN} starts. |
| 37 | |
| 38 | @menu |
| 39 | * Python Commands:: Accessing Python from @value{GDBN}. |
| 40 | * Python API:: Accessing @value{GDBN} from Python. |
| 41 | * Python Auto-loading:: Automatically loading Python code. |
| 42 | * Python modules:: Python modules provided by @value{GDBN}. |
| 43 | @end menu |
| 44 | |
| 45 | @node Python Commands |
| 46 | @subsection Python Commands |
| 47 | @cindex python commands |
| 48 | @cindex commands to access python |
| 49 | |
| 50 | @value{GDBN} provides two commands for accessing the Python interpreter, |
| 51 | and one related setting: |
| 52 | |
| 53 | @table @code |
| 54 | @kindex python-interactive |
| 55 | @kindex pi |
| 56 | @item python-interactive @r{[}@var{command}@r{]} |
| 57 | @itemx pi @r{[}@var{command}@r{]} |
| 58 | Without an argument, the @code{python-interactive} command can be used |
| 59 | to start an interactive Python prompt. To return to @value{GDBN}, |
| 60 | type the @code{EOF} character (e.g., @kbd{Ctrl-D} on an empty prompt). |
| 61 | |
| 62 | Alternatively, a single-line Python command can be given as an |
| 63 | argument and evaluated. If the command is an expression, the result |
| 64 | will be printed; otherwise, nothing will be printed. For example: |
| 65 | |
| 66 | @smallexample |
| 67 | (@value{GDBP}) python-interactive 2 + 3 |
| 68 | 5 |
| 69 | @end smallexample |
| 70 | |
| 71 | @kindex python |
| 72 | @kindex py |
| 73 | @item python @r{[}@var{command}@r{]} |
| 74 | @itemx py @r{[}@var{command}@r{]} |
| 75 | The @code{python} command can be used to evaluate Python code. |
| 76 | |
| 77 | If given an argument, the @code{python} command will evaluate the |
| 78 | argument as a Python command. For example: |
| 79 | |
| 80 | @smallexample |
| 81 | (@value{GDBP}) python print 23 |
| 82 | 23 |
| 83 | @end smallexample |
| 84 | |
| 85 | If you do not provide an argument to @code{python}, it will act as a |
| 86 | multi-line command, like @code{define}. In this case, the Python |
| 87 | script is made up of subsequent command lines, given after the |
| 88 | @code{python} command. This command list is terminated using a line |
| 89 | containing @code{end}. For example: |
| 90 | |
| 91 | @smallexample |
| 92 | (@value{GDBP}) python |
| 93 | >print 23 |
| 94 | >end |
| 95 | 23 |
| 96 | @end smallexample |
| 97 | |
| 98 | @kindex set python print-stack |
| 99 | @item set python print-stack |
| 100 | By default, @value{GDBN} will print only the message component of a |
| 101 | Python exception when an error occurs in a Python script. This can be |
| 102 | controlled using @code{set python print-stack}: if @code{full}, then |
| 103 | full Python stack printing is enabled; if @code{none}, then Python stack |
| 104 | and message printing is disabled; if @code{message}, the default, only |
| 105 | the message component of the error is printed. |
| 106 | @end table |
| 107 | |
| 108 | It is also possible to execute a Python script from the @value{GDBN} |
| 109 | interpreter: |
| 110 | |
| 111 | @table @code |
| 112 | @item source @file{script-name} |
| 113 | The script name must end with @samp{.py} and @value{GDBN} must be configured |
| 114 | to recognize the script language based on filename extension using |
| 115 | the @code{script-extension} setting. @xref{Extending GDB, ,Extending GDB}. |
| 116 | @end table |
| 117 | |
| 118 | @node Python API |
| 119 | @subsection Python API |
| 120 | @cindex python api |
| 121 | @cindex programming in python |
| 122 | |
| 123 | You can get quick online help for @value{GDBN}'s Python API by issuing |
| 124 | the command @w{@kbd{python help (gdb)}}. |
| 125 | |
| 126 | Functions and methods which have two or more optional arguments allow |
| 127 | them to be specified using keyword syntax. This allows passing some |
| 128 | optional arguments while skipping others. Example: |
| 129 | @w{@code{gdb.some_function ('foo', bar = 1, baz = 2)}}. |
| 130 | |
| 131 | @menu |
| 132 | * Basic Python:: Basic Python Functions. |
| 133 | * Exception Handling:: How Python exceptions are translated. |
| 134 | * Values From Inferior:: Python representation of values. |
| 135 | * Types In Python:: Python representation of types. |
| 136 | * Pretty Printing API:: Pretty-printing values. |
| 137 | * Selecting Pretty-Printers:: How GDB chooses a pretty-printer. |
| 138 | * Writing a Pretty-Printer:: Writing a Pretty-Printer. |
| 139 | * Type Printing API:: Pretty-printing types. |
| 140 | * Frame Filter API:: Filtering Frames. |
| 141 | * Frame Decorator API:: Decorating Frames. |
| 142 | * Writing a Frame Filter:: Writing a Frame Filter. |
| 143 | * Unwinding Frames in Python:: Writing frame unwinder. |
| 144 | * Xmethods In Python:: Adding and replacing methods of C++ classes. |
| 145 | * Xmethod API:: Xmethod types. |
| 146 | * Writing an Xmethod:: Writing an xmethod. |
| 147 | * Inferiors In Python:: Python representation of inferiors (processes) |
| 148 | * Events In Python:: Listening for events from @value{GDBN}. |
| 149 | * Threads In Python:: Accessing inferior threads from Python. |
| 150 | * Recordings In Python:: Accessing recordings from Python. |
| 151 | * Commands In Python:: Implementing new commands in Python. |
| 152 | * Parameters In Python:: Adding new @value{GDBN} parameters. |
| 153 | * Functions In Python:: Writing new convenience functions. |
| 154 | * Progspaces In Python:: Program spaces. |
| 155 | * Objfiles In Python:: Object files. |
| 156 | * Frames In Python:: Accessing inferior stack frames from Python. |
| 157 | * Blocks In Python:: Accessing blocks from Python. |
| 158 | * Symbols In Python:: Python representation of symbols. |
| 159 | * Symbol Tables In Python:: Python representation of symbol tables. |
| 160 | * Line Tables In Python:: Python representation of line tables. |
| 161 | * Breakpoints In Python:: Manipulating breakpoints using Python. |
| 162 | * Finish Breakpoints in Python:: Setting Breakpoints on function return |
| 163 | using Python. |
| 164 | * Lazy Strings In Python:: Python representation of lazy strings. |
| 165 | * Architectures In Python:: Python representation of architectures. |
| 166 | * Registers In Python:: Python representation of registers. |
| 167 | * TUI Windows In Python:: Implementing new TUI windows. |
| 168 | @end menu |
| 169 | |
| 170 | @node Basic Python |
| 171 | @subsubsection Basic Python |
| 172 | |
| 173 | @cindex python stdout |
| 174 | @cindex python pagination |
| 175 | At startup, @value{GDBN} overrides Python's @code{sys.stdout} and |
| 176 | @code{sys.stderr} to print using @value{GDBN}'s output-paging streams. |
| 177 | A Python program which outputs to one of these streams may have its |
| 178 | output interrupted by the user (@pxref{Screen Size}). In this |
| 179 | situation, a Python @code{KeyboardInterrupt} exception is thrown. |
| 180 | |
| 181 | Some care must be taken when writing Python code to run in |
| 182 | @value{GDBN}. Two things worth noting in particular: |
| 183 | |
| 184 | @itemize @bullet |
| 185 | @item |
| 186 | @value{GDBN} install handlers for @code{SIGCHLD} and @code{SIGINT}. |
| 187 | Python code must not override these, or even change the options using |
| 188 | @code{sigaction}. If your program changes the handling of these |
| 189 | signals, @value{GDBN} will most likely stop working correctly. Note |
| 190 | that it is unfortunately common for GUI toolkits to install a |
| 191 | @code{SIGCHLD} handler. |
| 192 | |
| 193 | @item |
| 194 | @value{GDBN} takes care to mark its internal file descriptors as |
| 195 | close-on-exec. However, this cannot be done in a thread-safe way on |
| 196 | all platforms. Your Python programs should be aware of this and |
| 197 | should both create new file descriptors with the close-on-exec flag |
| 198 | set and arrange to close unneeded file descriptors before starting a |
| 199 | child process. |
| 200 | @end itemize |
| 201 | |
| 202 | @cindex python functions |
| 203 | @cindex python module |
| 204 | @cindex gdb module |
| 205 | @value{GDBN} introduces a new Python module, named @code{gdb}. All |
| 206 | methods and classes added by @value{GDBN} are placed in this module. |
| 207 | @value{GDBN} automatically @code{import}s the @code{gdb} module for |
| 208 | use in all scripts evaluated by the @code{python} command. |
| 209 | |
| 210 | Some types of the @code{gdb} module come with a textual representation |
| 211 | (accessible through the @code{repr} or @code{str} functions). These are |
| 212 | offered for debugging purposes only, expect them to change over time. |
| 213 | |
| 214 | @findex gdb.PYTHONDIR |
| 215 | @defvar gdb.PYTHONDIR |
| 216 | A string containing the python directory (@pxref{Python}). |
| 217 | @end defvar |
| 218 | |
| 219 | @findex gdb.execute |
| 220 | @defun gdb.execute (command @r{[}, from_tty @r{[}, to_string@r{]]}) |
| 221 | Evaluate @var{command}, a string, as a @value{GDBN} CLI command. |
| 222 | If a GDB exception happens while @var{command} runs, it is |
| 223 | translated as described in @ref{Exception Handling,,Exception Handling}. |
| 224 | |
| 225 | The @var{from_tty} flag specifies whether @value{GDBN} ought to consider this |
| 226 | command as having originated from the user invoking it interactively. |
| 227 | It must be a boolean value. If omitted, it defaults to @code{False}. |
| 228 | |
| 229 | By default, any output produced by @var{command} is sent to |
| 230 | @value{GDBN}'s standard output (and to the log output if logging is |
| 231 | turned on). If the @var{to_string} parameter is |
| 232 | @code{True}, then output will be collected by @code{gdb.execute} and |
| 233 | returned as a string. The default is @code{False}, in which case the |
| 234 | return value is @code{None}. If @var{to_string} is @code{True}, the |
| 235 | @value{GDBN} virtual terminal will be temporarily set to unlimited width |
| 236 | and height, and its pagination will be disabled; @pxref{Screen Size}. |
| 237 | @end defun |
| 238 | |
| 239 | @findex gdb.breakpoints |
| 240 | @defun gdb.breakpoints () |
| 241 | Return a sequence holding all of @value{GDBN}'s breakpoints. |
| 242 | @xref{Breakpoints In Python}, for more information. In @value{GDBN} |
| 243 | version 7.11 and earlier, this function returned @code{None} if there |
| 244 | were no breakpoints. This peculiarity was subsequently fixed, and now |
| 245 | @code{gdb.breakpoints} returns an empty sequence in this case. |
| 246 | @end defun |
| 247 | |
| 248 | @defun gdb.rbreak (regex @r{[}, minsyms @r{[}, throttle, @r{[}, symtabs @r{]]]}) |
| 249 | Return a Python list holding a collection of newly set |
| 250 | @code{gdb.Breakpoint} objects matching function names defined by the |
| 251 | @var{regex} pattern. If the @var{minsyms} keyword is @code{True}, all |
| 252 | system functions (those not explicitly defined in the inferior) will |
| 253 | also be included in the match. The @var{throttle} keyword takes an |
| 254 | integer that defines the maximum number of pattern matches for |
| 255 | functions matched by the @var{regex} pattern. If the number of |
| 256 | matches exceeds the integer value of @var{throttle}, a |
| 257 | @code{RuntimeError} will be raised and no breakpoints will be created. |
| 258 | If @var{throttle} is not defined then there is no imposed limit on the |
| 259 | maximum number of matches and breakpoints to be created. The |
| 260 | @var{symtabs} keyword takes a Python iterable that yields a collection |
| 261 | of @code{gdb.Symtab} objects and will restrict the search to those |
| 262 | functions only contained within the @code{gdb.Symtab} objects. |
| 263 | @end defun |
| 264 | |
| 265 | @findex gdb.parameter |
| 266 | @defun gdb.parameter (parameter) |
| 267 | Return the value of a @value{GDBN} @var{parameter} given by its name, |
| 268 | a string; the parameter name string may contain spaces if the parameter has a |
| 269 | multi-part name. For example, @samp{print object} is a valid |
| 270 | parameter name. |
| 271 | |
| 272 | If the named parameter does not exist, this function throws a |
| 273 | @code{gdb.error} (@pxref{Exception Handling}). Otherwise, the |
| 274 | parameter's value is converted to a Python value of the appropriate |
| 275 | type, and returned. |
| 276 | @end defun |
| 277 | |
| 278 | @findex gdb.history |
| 279 | @defun gdb.history (number) |
| 280 | Return a value from @value{GDBN}'s value history (@pxref{Value |
| 281 | History}). The @var{number} argument indicates which history element to return. |
| 282 | If @var{number} is negative, then @value{GDBN} will take its absolute value |
| 283 | and count backward from the last element (i.e., the most recent element) to |
| 284 | find the value to return. If @var{number} is zero, then @value{GDBN} will |
| 285 | return the most recent element. If the element specified by @var{number} |
| 286 | doesn't exist in the value history, a @code{gdb.error} exception will be |
| 287 | raised. |
| 288 | |
| 289 | If no exception is raised, the return value is always an instance of |
| 290 | @code{gdb.Value} (@pxref{Values From Inferior}). |
| 291 | @end defun |
| 292 | |
| 293 | @findex gdb.convenience_variable |
| 294 | @defun gdb.convenience_variable (name) |
| 295 | Return the value of the convenience variable (@pxref{Convenience |
| 296 | Vars}) named @var{name}. @var{name} must be a string. The name |
| 297 | should not include the @samp{$} that is used to mark a convenience |
| 298 | variable in an expression. If the convenience variable does not |
| 299 | exist, then @code{None} is returned. |
| 300 | @end defun |
| 301 | |
| 302 | @findex gdb.set_convenience_variable |
| 303 | @defun gdb.set_convenience_variable (name, value) |
| 304 | Set the value of the convenience variable (@pxref{Convenience Vars}) |
| 305 | named @var{name}. @var{name} must be a string. The name should not |
| 306 | include the @samp{$} that is used to mark a convenience variable in an |
| 307 | expression. If @var{value} is @code{None}, then the convenience |
| 308 | variable is removed. Otherwise, if @var{value} is not a |
| 309 | @code{gdb.Value} (@pxref{Values From Inferior}), it is is converted |
| 310 | using the @code{gdb.Value} constructor. |
| 311 | @end defun |
| 312 | |
| 313 | @findex gdb.parse_and_eval |
| 314 | @defun gdb.parse_and_eval (expression) |
| 315 | Parse @var{expression}, which must be a string, as an expression in |
| 316 | the current language, evaluate it, and return the result as a |
| 317 | @code{gdb.Value}. |
| 318 | |
| 319 | This function can be useful when implementing a new command |
| 320 | (@pxref{Commands In Python}), as it provides a way to parse the |
| 321 | command's argument as an expression. It is also useful simply to |
| 322 | compute values. |
| 323 | @end defun |
| 324 | |
| 325 | @findex gdb.find_pc_line |
| 326 | @defun gdb.find_pc_line (pc) |
| 327 | Return the @code{gdb.Symtab_and_line} object corresponding to the |
| 328 | @var{pc} value. @xref{Symbol Tables In Python}. If an invalid |
| 329 | value of @var{pc} is passed as an argument, then the @code{symtab} and |
| 330 | @code{line} attributes of the returned @code{gdb.Symtab_and_line} object |
| 331 | will be @code{None} and 0 respectively. This is identical to |
| 332 | @code{gdb.current_progspace().find_pc_line(pc)} and is included for |
| 333 | historical compatibility. |
| 334 | @end defun |
| 335 | |
| 336 | @findex gdb.post_event |
| 337 | @defun gdb.post_event (event) |
| 338 | Put @var{event}, a callable object taking no arguments, into |
| 339 | @value{GDBN}'s internal event queue. This callable will be invoked at |
| 340 | some later point, during @value{GDBN}'s event processing. Events |
| 341 | posted using @code{post_event} will be run in the order in which they |
| 342 | were posted; however, there is no way to know when they will be |
| 343 | processed relative to other events inside @value{GDBN}. |
| 344 | |
| 345 | @value{GDBN} is not thread-safe. If your Python program uses multiple |
| 346 | threads, you must be careful to only call @value{GDBN}-specific |
| 347 | functions in the @value{GDBN} thread. @code{post_event} ensures |
| 348 | this. For example: |
| 349 | |
| 350 | @smallexample |
| 351 | (@value{GDBP}) python |
| 352 | >import threading |
| 353 | > |
| 354 | >class Writer(): |
| 355 | > def __init__(self, message): |
| 356 | > self.message = message; |
| 357 | > def __call__(self): |
| 358 | > gdb.write(self.message) |
| 359 | > |
| 360 | >class MyThread1 (threading.Thread): |
| 361 | > def run (self): |
| 362 | > gdb.post_event(Writer("Hello ")) |
| 363 | > |
| 364 | >class MyThread2 (threading.Thread): |
| 365 | > def run (self): |
| 366 | > gdb.post_event(Writer("World\n")) |
| 367 | > |
| 368 | >MyThread1().start() |
| 369 | >MyThread2().start() |
| 370 | >end |
| 371 | (@value{GDBP}) Hello World |
| 372 | @end smallexample |
| 373 | @end defun |
| 374 | |
| 375 | @findex gdb.write |
| 376 | @defun gdb.write (string @r{[}, stream{]}) |
| 377 | Print a string to @value{GDBN}'s paginated output stream. The |
| 378 | optional @var{stream} determines the stream to print to. The default |
| 379 | stream is @value{GDBN}'s standard output stream. Possible stream |
| 380 | values are: |
| 381 | |
| 382 | @table @code |
| 383 | @findex STDOUT |
| 384 | @findex gdb.STDOUT |
| 385 | @item gdb.STDOUT |
| 386 | @value{GDBN}'s standard output stream. |
| 387 | |
| 388 | @findex STDERR |
| 389 | @findex gdb.STDERR |
| 390 | @item gdb.STDERR |
| 391 | @value{GDBN}'s standard error stream. |
| 392 | |
| 393 | @findex STDLOG |
| 394 | @findex gdb.STDLOG |
| 395 | @item gdb.STDLOG |
| 396 | @value{GDBN}'s log stream (@pxref{Logging Output}). |
| 397 | @end table |
| 398 | |
| 399 | Writing to @code{sys.stdout} or @code{sys.stderr} will automatically |
| 400 | call this function and will automatically direct the output to the |
| 401 | relevant stream. |
| 402 | @end defun |
| 403 | |
| 404 | @findex gdb.flush |
| 405 | @defun gdb.flush () |
| 406 | Flush the buffer of a @value{GDBN} paginated stream so that the |
| 407 | contents are displayed immediately. @value{GDBN} will flush the |
| 408 | contents of a stream automatically when it encounters a newline in the |
| 409 | buffer. The optional @var{stream} determines the stream to flush. The |
| 410 | default stream is @value{GDBN}'s standard output stream. Possible |
| 411 | stream values are: |
| 412 | |
| 413 | @table @code |
| 414 | @findex STDOUT |
| 415 | @findex gdb.STDOUT |
| 416 | @item gdb.STDOUT |
| 417 | @value{GDBN}'s standard output stream. |
| 418 | |
| 419 | @findex STDERR |
| 420 | @findex gdb.STDERR |
| 421 | @item gdb.STDERR |
| 422 | @value{GDBN}'s standard error stream. |
| 423 | |
| 424 | @findex STDLOG |
| 425 | @findex gdb.STDLOG |
| 426 | @item gdb.STDLOG |
| 427 | @value{GDBN}'s log stream (@pxref{Logging Output}). |
| 428 | |
| 429 | @end table |
| 430 | |
| 431 | Flushing @code{sys.stdout} or @code{sys.stderr} will automatically |
| 432 | call this function for the relevant stream. |
| 433 | @end defun |
| 434 | |
| 435 | @findex gdb.target_charset |
| 436 | @defun gdb.target_charset () |
| 437 | Return the name of the current target character set (@pxref{Character |
| 438 | Sets}). This differs from @code{gdb.parameter('target-charset')} in |
| 439 | that @samp{auto} is never returned. |
| 440 | @end defun |
| 441 | |
| 442 | @findex gdb.target_wide_charset |
| 443 | @defun gdb.target_wide_charset () |
| 444 | Return the name of the current target wide character set |
| 445 | (@pxref{Character Sets}). This differs from |
| 446 | @code{gdb.parameter('target-wide-charset')} in that @samp{auto} is |
| 447 | never returned. |
| 448 | @end defun |
| 449 | |
| 450 | @findex gdb.solib_name |
| 451 | @defun gdb.solib_name (address) |
| 452 | Return the name of the shared library holding the given @var{address} |
| 453 | as a string, or @code{None}. This is identical to |
| 454 | @code{gdb.current_progspace().solib_name(address)} and is included for |
| 455 | historical compatibility. |
| 456 | @end defun |
| 457 | |
| 458 | @findex gdb.decode_line |
| 459 | @defun gdb.decode_line (@r{[}expression@r{]}) |
| 460 | Return locations of the line specified by @var{expression}, or of the |
| 461 | current line if no argument was given. This function returns a Python |
| 462 | tuple containing two elements. The first element contains a string |
| 463 | holding any unparsed section of @var{expression} (or @code{None} if |
| 464 | the expression has been fully parsed). The second element contains |
| 465 | either @code{None} or another tuple that contains all the locations |
| 466 | that match the expression represented as @code{gdb.Symtab_and_line} |
| 467 | objects (@pxref{Symbol Tables In Python}). If @var{expression} is |
| 468 | provided, it is decoded the way that @value{GDBN}'s inbuilt |
| 469 | @code{break} or @code{edit} commands do (@pxref{Specify Location}). |
| 470 | @end defun |
| 471 | |
| 472 | @defun gdb.prompt_hook (current_prompt) |
| 473 | @anchor{prompt_hook} |
| 474 | |
| 475 | If @var{prompt_hook} is callable, @value{GDBN} will call the method |
| 476 | assigned to this operation before a prompt is displayed by |
| 477 | @value{GDBN}. |
| 478 | |
| 479 | The parameter @code{current_prompt} contains the current @value{GDBN} |
| 480 | prompt. This method must return a Python string, or @code{None}. If |
| 481 | a string is returned, the @value{GDBN} prompt will be set to that |
| 482 | string. If @code{None} is returned, @value{GDBN} will continue to use |
| 483 | the current prompt. |
| 484 | |
| 485 | Some prompts cannot be substituted in @value{GDBN}. Secondary prompts |
| 486 | such as those used by readline for command input, and annotation |
| 487 | related prompts are prohibited from being changed. |
| 488 | @end defun |
| 489 | |
| 490 | @node Exception Handling |
| 491 | @subsubsection Exception Handling |
| 492 | @cindex python exceptions |
| 493 | @cindex exceptions, python |
| 494 | |
| 495 | When executing the @code{python} command, Python exceptions |
| 496 | uncaught within the Python code are translated to calls to |
| 497 | @value{GDBN} error-reporting mechanism. If the command that called |
| 498 | @code{python} does not handle the error, @value{GDBN} will |
| 499 | terminate it and print an error message containing the Python |
| 500 | exception name, the associated value, and the Python call stack |
| 501 | backtrace at the point where the exception was raised. Example: |
| 502 | |
| 503 | @smallexample |
| 504 | (@value{GDBP}) python print foo |
| 505 | Traceback (most recent call last): |
| 506 | File "<string>", line 1, in <module> |
| 507 | NameError: name 'foo' is not defined |
| 508 | @end smallexample |
| 509 | |
| 510 | @value{GDBN} errors that happen in @value{GDBN} commands invoked by |
| 511 | Python code are converted to Python exceptions. The type of the |
| 512 | Python exception depends on the error. |
| 513 | |
| 514 | @ftable @code |
| 515 | @item gdb.error |
| 516 | This is the base class for most exceptions generated by @value{GDBN}. |
| 517 | It is derived from @code{RuntimeError}, for compatibility with earlier |
| 518 | versions of @value{GDBN}. |
| 519 | |
| 520 | If an error occurring in @value{GDBN} does not fit into some more |
| 521 | specific category, then the generated exception will have this type. |
| 522 | |
| 523 | @item gdb.MemoryError |
| 524 | This is a subclass of @code{gdb.error} which is thrown when an |
| 525 | operation tried to access invalid memory in the inferior. |
| 526 | |
| 527 | @item KeyboardInterrupt |
| 528 | User interrupt (via @kbd{C-c} or by typing @kbd{q} at a pagination |
| 529 | prompt) is translated to a Python @code{KeyboardInterrupt} exception. |
| 530 | @end ftable |
| 531 | |
| 532 | In all cases, your exception handler will see the @value{GDBN} error |
| 533 | message as its value and the Python call stack backtrace at the Python |
| 534 | statement closest to where the @value{GDBN} error occured as the |
| 535 | traceback. |
| 536 | |
| 537 | |
| 538 | When implementing @value{GDBN} commands in Python via |
| 539 | @code{gdb.Command}, or functions via @code{gdb.Function}, it is useful |
| 540 | to be able to throw an exception that doesn't cause a traceback to be |
| 541 | printed. For example, the user may have invoked the command |
| 542 | incorrectly. @value{GDBN} provides a special exception class that can |
| 543 | be used for this purpose. |
| 544 | |
| 545 | @ftable @code |
| 546 | @item gdb.GdbError |
| 547 | When thrown from a command or function, this exception will cause the |
| 548 | command or function to fail, but the Python stack will not be |
| 549 | displayed. @value{GDBN} does not throw this exception itself, but |
| 550 | rather recognizes it when thrown from user Python code. Example: |
| 551 | |
| 552 | @smallexample |
| 553 | (gdb) python |
| 554 | >class HelloWorld (gdb.Command): |
| 555 | > """Greet the whole world.""" |
| 556 | > def __init__ (self): |
| 557 | > super (HelloWorld, self).__init__ ("hello-world", gdb.COMMAND_USER) |
| 558 | > def invoke (self, args, from_tty): |
| 559 | > argv = gdb.string_to_argv (args) |
| 560 | > if len (argv) != 0: |
| 561 | > raise gdb.GdbError ("hello-world takes no arguments") |
| 562 | > print ("Hello, World!") |
| 563 | >HelloWorld () |
| 564 | >end |
| 565 | (gdb) hello-world 42 |
| 566 | hello-world takes no arguments |
| 567 | @end smallexample |
| 568 | @end ftable |
| 569 | |
| 570 | @node Values From Inferior |
| 571 | @subsubsection Values From Inferior |
| 572 | @cindex values from inferior, with Python |
| 573 | @cindex python, working with values from inferior |
| 574 | |
| 575 | @cindex @code{gdb.Value} |
| 576 | @value{GDBN} provides values it obtains from the inferior program in |
| 577 | an object of type @code{gdb.Value}. @value{GDBN} uses this object |
| 578 | for its internal bookkeeping of the inferior's values, and for |
| 579 | fetching values when necessary. |
| 580 | |
| 581 | Inferior values that are simple scalars can be used directly in |
| 582 | Python expressions that are valid for the value's data type. Here's |
| 583 | an example for an integer or floating-point value @code{some_val}: |
| 584 | |
| 585 | @smallexample |
| 586 | bar = some_val + 2 |
| 587 | @end smallexample |
| 588 | |
| 589 | @noindent |
| 590 | As result of this, @code{bar} will also be a @code{gdb.Value} object |
| 591 | whose values are of the same type as those of @code{some_val}. Valid |
| 592 | Python operations can also be performed on @code{gdb.Value} objects |
| 593 | representing a @code{struct} or @code{class} object. For such cases, |
| 594 | the overloaded operator (if present), is used to perform the operation. |
| 595 | For example, if @code{val1} and @code{val2} are @code{gdb.Value} objects |
| 596 | representing instances of a @code{class} which overloads the @code{+} |
| 597 | operator, then one can use the @code{+} operator in their Python script |
| 598 | as follows: |
| 599 | |
| 600 | @smallexample |
| 601 | val3 = val1 + val2 |
| 602 | @end smallexample |
| 603 | |
| 604 | @noindent |
| 605 | The result of the operation @code{val3} is also a @code{gdb.Value} |
| 606 | object corresponding to the value returned by the overloaded @code{+} |
| 607 | operator. In general, overloaded operators are invoked for the |
| 608 | following operations: @code{+} (binary addition), @code{-} (binary |
| 609 | subtraction), @code{*} (multiplication), @code{/}, @code{%}, @code{<<}, |
| 610 | @code{>>}, @code{|}, @code{&}, @code{^}. |
| 611 | |
| 612 | Inferior values that are structures or instances of some class can |
| 613 | be accessed using the Python @dfn{dictionary syntax}. For example, if |
| 614 | @code{some_val} is a @code{gdb.Value} instance holding a structure, you |
| 615 | can access its @code{foo} element with: |
| 616 | |
| 617 | @smallexample |
| 618 | bar = some_val['foo'] |
| 619 | @end smallexample |
| 620 | |
| 621 | @cindex getting structure elements using gdb.Field objects as subscripts |
| 622 | Again, @code{bar} will also be a @code{gdb.Value} object. Structure |
| 623 | elements can also be accessed by using @code{gdb.Field} objects as |
| 624 | subscripts (@pxref{Types In Python}, for more information on |
| 625 | @code{gdb.Field} objects). For example, if @code{foo_field} is a |
| 626 | @code{gdb.Field} object corresponding to element @code{foo} of the above |
| 627 | structure, then @code{bar} can also be accessed as follows: |
| 628 | |
| 629 | @smallexample |
| 630 | bar = some_val[foo_field] |
| 631 | @end smallexample |
| 632 | |
| 633 | A @code{gdb.Value} that represents a function can be executed via |
| 634 | inferior function call. Any arguments provided to the call must match |
| 635 | the function's prototype, and must be provided in the order specified |
| 636 | by that prototype. |
| 637 | |
| 638 | For example, @code{some_val} is a @code{gdb.Value} instance |
| 639 | representing a function that takes two integers as arguments. To |
| 640 | execute this function, call it like so: |
| 641 | |
| 642 | @smallexample |
| 643 | result = some_val (10,20) |
| 644 | @end smallexample |
| 645 | |
| 646 | Any values returned from a function call will be stored as a |
| 647 | @code{gdb.Value}. |
| 648 | |
| 649 | The following attributes are provided: |
| 650 | |
| 651 | @defvar Value.address |
| 652 | If this object is addressable, this read-only attribute holds a |
| 653 | @code{gdb.Value} object representing the address. Otherwise, |
| 654 | this attribute holds @code{None}. |
| 655 | @end defvar |
| 656 | |
| 657 | @cindex optimized out value in Python |
| 658 | @defvar Value.is_optimized_out |
| 659 | This read-only boolean attribute is true if the compiler optimized out |
| 660 | this value, thus it is not available for fetching from the inferior. |
| 661 | @end defvar |
| 662 | |
| 663 | @defvar Value.type |
| 664 | The type of this @code{gdb.Value}. The value of this attribute is a |
| 665 | @code{gdb.Type} object (@pxref{Types In Python}). |
| 666 | @end defvar |
| 667 | |
| 668 | @defvar Value.dynamic_type |
| 669 | The dynamic type of this @code{gdb.Value}. This uses the object's |
| 670 | virtual table and the C@t{++} run-time type information |
| 671 | (@acronym{RTTI}) to determine the dynamic type of the value. If this |
| 672 | value is of class type, it will return the class in which the value is |
| 673 | embedded, if any. If this value is of pointer or reference to a class |
| 674 | type, it will compute the dynamic type of the referenced object, and |
| 675 | return a pointer or reference to that type, respectively. In all |
| 676 | other cases, it will return the value's static type. |
| 677 | |
| 678 | Note that this feature will only work when debugging a C@t{++} program |
| 679 | that includes @acronym{RTTI} for the object in question. Otherwise, |
| 680 | it will just return the static type of the value as in @kbd{ptype foo} |
| 681 | (@pxref{Symbols, ptype}). |
| 682 | @end defvar |
| 683 | |
| 684 | @defvar Value.is_lazy |
| 685 | The value of this read-only boolean attribute is @code{True} if this |
| 686 | @code{gdb.Value} has not yet been fetched from the inferior. |
| 687 | @value{GDBN} does not fetch values until necessary, for efficiency. |
| 688 | For example: |
| 689 | |
| 690 | @smallexample |
| 691 | myval = gdb.parse_and_eval ('somevar') |
| 692 | @end smallexample |
| 693 | |
| 694 | The value of @code{somevar} is not fetched at this time. It will be |
| 695 | fetched when the value is needed, or when the @code{fetch_lazy} |
| 696 | method is invoked. |
| 697 | @end defvar |
| 698 | |
| 699 | The following methods are provided: |
| 700 | |
| 701 | @defun Value.__init__ (@var{val}) |
| 702 | Many Python values can be converted directly to a @code{gdb.Value} via |
| 703 | this object initializer. Specifically: |
| 704 | |
| 705 | @table @asis |
| 706 | @item Python boolean |
| 707 | A Python boolean is converted to the boolean type from the current |
| 708 | language. |
| 709 | |
| 710 | @item Python integer |
| 711 | A Python integer is converted to the C @code{long} type for the |
| 712 | current architecture. |
| 713 | |
| 714 | @item Python long |
| 715 | A Python long is converted to the C @code{long long} type for the |
| 716 | current architecture. |
| 717 | |
| 718 | @item Python float |
| 719 | A Python float is converted to the C @code{double} type for the |
| 720 | current architecture. |
| 721 | |
| 722 | @item Python string |
| 723 | A Python string is converted to a target string in the current target |
| 724 | language using the current target encoding. |
| 725 | If a character cannot be represented in the current target encoding, |
| 726 | then an exception is thrown. |
| 727 | |
| 728 | @item @code{gdb.Value} |
| 729 | If @code{val} is a @code{gdb.Value}, then a copy of the value is made. |
| 730 | |
| 731 | @item @code{gdb.LazyString} |
| 732 | If @code{val} is a @code{gdb.LazyString} (@pxref{Lazy Strings In |
| 733 | Python}), then the lazy string's @code{value} method is called, and |
| 734 | its result is used. |
| 735 | @end table |
| 736 | @end defun |
| 737 | |
| 738 | @defun Value.__init__ (@var{val}, @var{type}) |
| 739 | This second form of the @code{gdb.Value} constructor returns a |
| 740 | @code{gdb.Value} of type @var{type} where the value contents are taken |
| 741 | from the Python buffer object specified by @var{val}. The number of |
| 742 | bytes in the Python buffer object must be greater than or equal to the |
| 743 | size of @var{type}. |
| 744 | @end defun |
| 745 | |
| 746 | @defun Value.cast (type) |
| 747 | Return a new instance of @code{gdb.Value} that is the result of |
| 748 | casting this instance to the type described by @var{type}, which must |
| 749 | be a @code{gdb.Type} object. If the cast cannot be performed for some |
| 750 | reason, this method throws an exception. |
| 751 | @end defun |
| 752 | |
| 753 | @defun Value.dereference () |
| 754 | For pointer data types, this method returns a new @code{gdb.Value} object |
| 755 | whose contents is the object pointed to by the pointer. For example, if |
| 756 | @code{foo} is a C pointer to an @code{int}, declared in your C program as |
| 757 | |
| 758 | @smallexample |
| 759 | int *foo; |
| 760 | @end smallexample |
| 761 | |
| 762 | @noindent |
| 763 | then you can use the corresponding @code{gdb.Value} to access what |
| 764 | @code{foo} points to like this: |
| 765 | |
| 766 | @smallexample |
| 767 | bar = foo.dereference () |
| 768 | @end smallexample |
| 769 | |
| 770 | The result @code{bar} will be a @code{gdb.Value} object holding the |
| 771 | value pointed to by @code{foo}. |
| 772 | |
| 773 | A similar function @code{Value.referenced_value} exists which also |
| 774 | returns @code{gdb.Value} objects corresponding to the values pointed to |
| 775 | by pointer values (and additionally, values referenced by reference |
| 776 | values). However, the behavior of @code{Value.dereference} |
| 777 | differs from @code{Value.referenced_value} by the fact that the |
| 778 | behavior of @code{Value.dereference} is identical to applying the C |
| 779 | unary operator @code{*} on a given value. For example, consider a |
| 780 | reference to a pointer @code{ptrref}, declared in your C@t{++} program |
| 781 | as |
| 782 | |
| 783 | @smallexample |
| 784 | typedef int *intptr; |
| 785 | ... |
| 786 | int val = 10; |
| 787 | intptr ptr = &val; |
| 788 | intptr &ptrref = ptr; |
| 789 | @end smallexample |
| 790 | |
| 791 | Though @code{ptrref} is a reference value, one can apply the method |
| 792 | @code{Value.dereference} to the @code{gdb.Value} object corresponding |
| 793 | to it and obtain a @code{gdb.Value} which is identical to that |
| 794 | corresponding to @code{val}. However, if you apply the method |
| 795 | @code{Value.referenced_value}, the result would be a @code{gdb.Value} |
| 796 | object identical to that corresponding to @code{ptr}. |
| 797 | |
| 798 | @smallexample |
| 799 | py_ptrref = gdb.parse_and_eval ("ptrref") |
| 800 | py_val = py_ptrref.dereference () |
| 801 | py_ptr = py_ptrref.referenced_value () |
| 802 | @end smallexample |
| 803 | |
| 804 | The @code{gdb.Value} object @code{py_val} is identical to that |
| 805 | corresponding to @code{val}, and @code{py_ptr} is identical to that |
| 806 | corresponding to @code{ptr}. In general, @code{Value.dereference} can |
| 807 | be applied whenever the C unary operator @code{*} can be applied |
| 808 | to the corresponding C value. For those cases where applying both |
| 809 | @code{Value.dereference} and @code{Value.referenced_value} is allowed, |
| 810 | the results obtained need not be identical (as we have seen in the above |
| 811 | example). The results are however identical when applied on |
| 812 | @code{gdb.Value} objects corresponding to pointers (@code{gdb.Value} |
| 813 | objects with type code @code{TYPE_CODE_PTR}) in a C/C@t{++} program. |
| 814 | @end defun |
| 815 | |
| 816 | @defun Value.referenced_value () |
| 817 | For pointer or reference data types, this method returns a new |
| 818 | @code{gdb.Value} object corresponding to the value referenced by the |
| 819 | pointer/reference value. For pointer data types, |
| 820 | @code{Value.dereference} and @code{Value.referenced_value} produce |
| 821 | identical results. The difference between these methods is that |
| 822 | @code{Value.dereference} cannot get the values referenced by reference |
| 823 | values. For example, consider a reference to an @code{int}, declared |
| 824 | in your C@t{++} program as |
| 825 | |
| 826 | @smallexample |
| 827 | int val = 10; |
| 828 | int &ref = val; |
| 829 | @end smallexample |
| 830 | |
| 831 | @noindent |
| 832 | then applying @code{Value.dereference} to the @code{gdb.Value} object |
| 833 | corresponding to @code{ref} will result in an error, while applying |
| 834 | @code{Value.referenced_value} will result in a @code{gdb.Value} object |
| 835 | identical to that corresponding to @code{val}. |
| 836 | |
| 837 | @smallexample |
| 838 | py_ref = gdb.parse_and_eval ("ref") |
| 839 | er_ref = py_ref.dereference () # Results in error |
| 840 | py_val = py_ref.referenced_value () # Returns the referenced value |
| 841 | @end smallexample |
| 842 | |
| 843 | The @code{gdb.Value} object @code{py_val} is identical to that |
| 844 | corresponding to @code{val}. |
| 845 | @end defun |
| 846 | |
| 847 | @defun Value.reference_value () |
| 848 | Return a @code{gdb.Value} object which is a reference to the value |
| 849 | encapsulated by this instance. |
| 850 | @end defun |
| 851 | |
| 852 | @defun Value.const_value () |
| 853 | Return a @code{gdb.Value} object which is a @code{const} version of the |
| 854 | value encapsulated by this instance. |
| 855 | @end defun |
| 856 | |
| 857 | @defun Value.dynamic_cast (type) |
| 858 | Like @code{Value.cast}, but works as if the C@t{++} @code{dynamic_cast} |
| 859 | operator were used. Consult a C@t{++} reference for details. |
| 860 | @end defun |
| 861 | |
| 862 | @defun Value.reinterpret_cast (type) |
| 863 | Like @code{Value.cast}, but works as if the C@t{++} @code{reinterpret_cast} |
| 864 | operator were used. Consult a C@t{++} reference for details. |
| 865 | @end defun |
| 866 | |
| 867 | @defun Value.format_string (...) |
| 868 | Convert a @code{gdb.Value} to a string, similarly to what the @code{print} |
| 869 | command does. Invoked with no arguments, this is equivalent to calling |
| 870 | the @code{str} function on the @code{gdb.Value}. The representation of |
| 871 | the same value may change across different versions of @value{GDBN}, so |
| 872 | you shouldn't, for instance, parse the strings returned by this method. |
| 873 | |
| 874 | All the arguments are keyword only. If an argument is not specified, the |
| 875 | current global default setting is used. |
| 876 | |
| 877 | @table @code |
| 878 | @item raw |
| 879 | @code{True} if pretty-printers (@pxref{Pretty Printing}) should not be |
| 880 | used to format the value. @code{False} if enabled pretty-printers |
| 881 | matching the type represented by the @code{gdb.Value} should be used to |
| 882 | format it. |
| 883 | |
| 884 | @item pretty_arrays |
| 885 | @code{True} if arrays should be pretty printed to be more convenient to |
| 886 | read, @code{False} if they shouldn't (see @code{set print array} in |
| 887 | @ref{Print Settings}). |
| 888 | |
| 889 | @item pretty_structs |
| 890 | @code{True} if structs should be pretty printed to be more convenient to |
| 891 | read, @code{False} if they shouldn't (see @code{set print pretty} in |
| 892 | @ref{Print Settings}). |
| 893 | |
| 894 | @item array_indexes |
| 895 | @code{True} if array indexes should be included in the string |
| 896 | representation of arrays, @code{False} if they shouldn't (see @code{set |
| 897 | print array-indexes} in @ref{Print Settings}). |
| 898 | |
| 899 | @item symbols |
| 900 | @code{True} if the string representation of a pointer should include the |
| 901 | corresponding symbol name (if one exists), @code{False} if it shouldn't |
| 902 | (see @code{set print symbol} in @ref{Print Settings}). |
| 903 | |
| 904 | @item unions |
| 905 | @code{True} if unions which are contained in other structures or unions |
| 906 | should be expanded, @code{False} if they shouldn't (see @code{set print |
| 907 | union} in @ref{Print Settings}). |
| 908 | |
| 909 | @item address |
| 910 | @code{True} if the string representation of a pointer should include the |
| 911 | address, @code{False} if it shouldn't (see @code{set print address} in |
| 912 | @ref{Print Settings}). |
| 913 | |
| 914 | @item deref_refs |
| 915 | @code{True} if C@t{++} references should be resolved to the value they |
| 916 | refer to, @code{False} (the default) if they shouldn't. Note that, unlike |
| 917 | for the @code{print} command, references are not automatically expanded |
| 918 | when using the @code{format_string} method or the @code{str} |
| 919 | function. There is no global @code{print} setting to change the default |
| 920 | behaviour. |
| 921 | |
| 922 | @item actual_objects |
| 923 | @code{True} if the representation of a pointer to an object should |
| 924 | identify the @emph{actual} (derived) type of the object rather than the |
| 925 | @emph{declared} type, using the virtual function table. @code{False} if |
| 926 | the @emph{declared} type should be used. (See @code{set print object} in |
| 927 | @ref{Print Settings}). |
| 928 | |
| 929 | @item static_members |
| 930 | @code{True} if static members should be included in the string |
| 931 | representation of a C@t{++} object, @code{False} if they shouldn't (see |
| 932 | @code{set print static-members} in @ref{Print Settings}). |
| 933 | |
| 934 | @item max_elements |
| 935 | Number of array elements to print, or @code{0} to print an unlimited |
| 936 | number of elements (see @code{set print elements} in @ref{Print |
| 937 | Settings}). |
| 938 | |
| 939 | @item max_depth |
| 940 | The maximum depth to print for nested structs and unions, or @code{-1} |
| 941 | to print an unlimited number of elements (see @code{set print |
| 942 | max-depth} in @ref{Print Settings}). |
| 943 | |
| 944 | @item repeat_threshold |
| 945 | Set the threshold for suppressing display of repeated array elements, or |
| 946 | @code{0} to represent all elements, even if repeated. (See @code{set |
| 947 | print repeats} in @ref{Print Settings}). |
| 948 | |
| 949 | @item format |
| 950 | A string containing a single character representing the format to use for |
| 951 | the returned string. For instance, @code{'x'} is equivalent to using the |
| 952 | @value{GDBN} command @code{print} with the @code{/x} option and formats |
| 953 | the value as a hexadecimal number. |
| 954 | @end table |
| 955 | @end defun |
| 956 | |
| 957 | @defun Value.string (@r{[}encoding@r{[}, errors@r{[}, length@r{]]]}) |
| 958 | If this @code{gdb.Value} represents a string, then this method |
| 959 | converts the contents to a Python string. Otherwise, this method will |
| 960 | throw an exception. |
| 961 | |
| 962 | Values are interpreted as strings according to the rules of the |
| 963 | current language. If the optional length argument is given, the |
| 964 | string will be converted to that length, and will include any embedded |
| 965 | zeroes that the string may contain. Otherwise, for languages |
| 966 | where the string is zero-terminated, the entire string will be |
| 967 | converted. |
| 968 | |
| 969 | For example, in C-like languages, a value is a string if it is a pointer |
| 970 | to or an array of characters or ints of type @code{wchar_t}, @code{char16_t}, |
| 971 | or @code{char32_t}. |
| 972 | |
| 973 | If the optional @var{encoding} argument is given, it must be a string |
| 974 | naming the encoding of the string in the @code{gdb.Value}, such as |
| 975 | @code{"ascii"}, @code{"iso-8859-6"} or @code{"utf-8"}. It accepts |
| 976 | the same encodings as the corresponding argument to Python's |
| 977 | @code{string.decode} method, and the Python codec machinery will be used |
| 978 | to convert the string. If @var{encoding} is not given, or if |
| 979 | @var{encoding} is the empty string, then either the @code{target-charset} |
| 980 | (@pxref{Character Sets}) will be used, or a language-specific encoding |
| 981 | will be used, if the current language is able to supply one. |
| 982 | |
| 983 | The optional @var{errors} argument is the same as the corresponding |
| 984 | argument to Python's @code{string.decode} method. |
| 985 | |
| 986 | If the optional @var{length} argument is given, the string will be |
| 987 | fetched and converted to the given length. |
| 988 | @end defun |
| 989 | |
| 990 | @defun Value.lazy_string (@r{[}encoding @r{[}, length@r{]]}) |
| 991 | If this @code{gdb.Value} represents a string, then this method |
| 992 | converts the contents to a @code{gdb.LazyString} (@pxref{Lazy Strings |
| 993 | In Python}). Otherwise, this method will throw an exception. |
| 994 | |
| 995 | If the optional @var{encoding} argument is given, it must be a string |
| 996 | naming the encoding of the @code{gdb.LazyString}. Some examples are: |
| 997 | @samp{ascii}, @samp{iso-8859-6} or @samp{utf-8}. If the |
| 998 | @var{encoding} argument is an encoding that @value{GDBN} does |
| 999 | recognize, @value{GDBN} will raise an error. |
| 1000 | |
| 1001 | When a lazy string is printed, the @value{GDBN} encoding machinery is |
| 1002 | used to convert the string during printing. If the optional |
| 1003 | @var{encoding} argument is not provided, or is an empty string, |
| 1004 | @value{GDBN} will automatically select the encoding most suitable for |
| 1005 | the string type. For further information on encoding in @value{GDBN} |
| 1006 | please see @ref{Character Sets}. |
| 1007 | |
| 1008 | If the optional @var{length} argument is given, the string will be |
| 1009 | fetched and encoded to the length of characters specified. If |
| 1010 | the @var{length} argument is not provided, the string will be fetched |
| 1011 | and encoded until a null of appropriate width is found. |
| 1012 | @end defun |
| 1013 | |
| 1014 | @defun Value.fetch_lazy () |
| 1015 | If the @code{gdb.Value} object is currently a lazy value |
| 1016 | (@code{gdb.Value.is_lazy} is @code{True}), then the value is |
| 1017 | fetched from the inferior. Any errors that occur in the process |
| 1018 | will produce a Python exception. |
| 1019 | |
| 1020 | If the @code{gdb.Value} object is not a lazy value, this method |
| 1021 | has no effect. |
| 1022 | |
| 1023 | This method does not return a value. |
| 1024 | @end defun |
| 1025 | |
| 1026 | |
| 1027 | @node Types In Python |
| 1028 | @subsubsection Types In Python |
| 1029 | @cindex types in Python |
| 1030 | @cindex Python, working with types |
| 1031 | |
| 1032 | @tindex gdb.Type |
| 1033 | @value{GDBN} represents types from the inferior using the class |
| 1034 | @code{gdb.Type}. |
| 1035 | |
| 1036 | The following type-related functions are available in the @code{gdb} |
| 1037 | module: |
| 1038 | |
| 1039 | @findex gdb.lookup_type |
| 1040 | @defun gdb.lookup_type (name @r{[}, block@r{]}) |
| 1041 | This function looks up a type by its @var{name}, which must be a string. |
| 1042 | |
| 1043 | If @var{block} is given, then @var{name} is looked up in that scope. |
| 1044 | Otherwise, it is searched for globally. |
| 1045 | |
| 1046 | Ordinarily, this function will return an instance of @code{gdb.Type}. |
| 1047 | If the named type cannot be found, it will throw an exception. |
| 1048 | @end defun |
| 1049 | |
| 1050 | If the type is a structure or class type, or an enum type, the fields |
| 1051 | of that type can be accessed using the Python @dfn{dictionary syntax}. |
| 1052 | For example, if @code{some_type} is a @code{gdb.Type} instance holding |
| 1053 | a structure type, you can access its @code{foo} field with: |
| 1054 | |
| 1055 | @smallexample |
| 1056 | bar = some_type['foo'] |
| 1057 | @end smallexample |
| 1058 | |
| 1059 | @code{bar} will be a @code{gdb.Field} object; see below under the |
| 1060 | description of the @code{Type.fields} method for a description of the |
| 1061 | @code{gdb.Field} class. |
| 1062 | |
| 1063 | An instance of @code{Type} has the following attributes: |
| 1064 | |
| 1065 | @defvar Type.alignof |
| 1066 | The alignment of this type, in bytes. Type alignment comes from the |
| 1067 | debugging information; if it was not specified, then @value{GDBN} will |
| 1068 | use the relevant ABI to try to determine the alignment. In some |
| 1069 | cases, even this is not possible, and zero will be returned. |
| 1070 | @end defvar |
| 1071 | |
| 1072 | @defvar Type.code |
| 1073 | The type code for this type. The type code will be one of the |
| 1074 | @code{TYPE_CODE_} constants defined below. |
| 1075 | @end defvar |
| 1076 | |
| 1077 | @defvar Type.dynamic |
| 1078 | A boolean indicating whether this type is dynamic. In some |
| 1079 | situations, such as Rust @code{enum} types or Ada variant records, the |
| 1080 | concrete type of a value may vary depending on its contents. That is, |
| 1081 | the declared type of a variable, or the type returned by |
| 1082 | @code{gdb.lookup_type} may be dynamic; while the type of the |
| 1083 | variable's value will be a concrete instance of that dynamic type. |
| 1084 | |
| 1085 | For example, consider this code: |
| 1086 | @smallexample |
| 1087 | int n; |
| 1088 | int array[n]; |
| 1089 | @end smallexample |
| 1090 | |
| 1091 | Here, at least conceptually (whether your compiler actually does this |
| 1092 | is a separate issue), examining @w{@code{gdb.lookup_symbol("array", ...).type}} |
| 1093 | could yield a @code{gdb.Type} which reports a size of @code{None}. |
| 1094 | This is the dynamic type. |
| 1095 | |
| 1096 | However, examining @code{gdb.parse_and_eval("array").type} would yield |
| 1097 | a concrete type, whose length would be known. |
| 1098 | @end defvar |
| 1099 | |
| 1100 | @defvar Type.name |
| 1101 | The name of this type. If this type has no name, then @code{None} |
| 1102 | is returned. |
| 1103 | @end defvar |
| 1104 | |
| 1105 | @defvar Type.sizeof |
| 1106 | The size of this type, in target @code{char} units. Usually, a |
| 1107 | target's @code{char} type will be an 8-bit byte. However, on some |
| 1108 | unusual platforms, this type may have a different size. A dynamic |
| 1109 | type may not have a fixed size; in this case, this attribute's value |
| 1110 | will be @code{None}. |
| 1111 | @end defvar |
| 1112 | |
| 1113 | @defvar Type.tag |
| 1114 | The tag name for this type. The tag name is the name after |
| 1115 | @code{struct}, @code{union}, or @code{enum} in C and C@t{++}; not all |
| 1116 | languages have this concept. If this type has no tag name, then |
| 1117 | @code{None} is returned. |
| 1118 | @end defvar |
| 1119 | |
| 1120 | @defvar Type.objfile |
| 1121 | The @code{gdb.Objfile} that this type was defined in, or @code{None} if |
| 1122 | there is no associated objfile. |
| 1123 | @end defvar |
| 1124 | |
| 1125 | The following methods are provided: |
| 1126 | |
| 1127 | @defun Type.fields () |
| 1128 | For structure and union types, this method returns the fields. Range |
| 1129 | types have two fields, the minimum and maximum values. Enum types |
| 1130 | have one field per enum constant. Function and method types have one |
| 1131 | field per parameter. The base types of C@t{++} classes are also |
| 1132 | represented as fields. If the type has no fields, or does not fit |
| 1133 | into one of these categories, an empty sequence will be returned. |
| 1134 | |
| 1135 | Each field is a @code{gdb.Field} object, with some pre-defined attributes: |
| 1136 | @table @code |
| 1137 | @item bitpos |
| 1138 | This attribute is not available for @code{enum} or @code{static} |
| 1139 | (as in C@t{++}) fields. The value is the position, counting |
| 1140 | in bits, from the start of the containing type. Note that, in a |
| 1141 | dynamic type, the position of a field may not be constant. In this |
| 1142 | case, the value will be @code{None}. Also, a dynamic type may have |
| 1143 | fields that do not appear in a corresponding concrete type. |
| 1144 | |
| 1145 | @item enumval |
| 1146 | This attribute is only available for @code{enum} fields, and its value |
| 1147 | is the enumeration member's integer representation. |
| 1148 | |
| 1149 | @item name |
| 1150 | The name of the field, or @code{None} for anonymous fields. |
| 1151 | |
| 1152 | @item artificial |
| 1153 | This is @code{True} if the field is artificial, usually meaning that |
| 1154 | it was provided by the compiler and not the user. This attribute is |
| 1155 | always provided, and is @code{False} if the field is not artificial. |
| 1156 | |
| 1157 | @item is_base_class |
| 1158 | This is @code{True} if the field represents a base class of a C@t{++} |
| 1159 | structure. This attribute is always provided, and is @code{False} |
| 1160 | if the field is not a base class of the type that is the argument of |
| 1161 | @code{fields}, or if that type was not a C@t{++} class. |
| 1162 | |
| 1163 | @item bitsize |
| 1164 | If the field is packed, or is a bitfield, then this will have a |
| 1165 | non-zero value, which is the size of the field in bits. Otherwise, |
| 1166 | this will be zero; in this case the field's size is given by its type. |
| 1167 | |
| 1168 | @item type |
| 1169 | The type of the field. This is usually an instance of @code{Type}, |
| 1170 | but it can be @code{None} in some situations. |
| 1171 | |
| 1172 | @item parent_type |
| 1173 | The type which contains this field. This is an instance of |
| 1174 | @code{gdb.Type}. |
| 1175 | @end table |
| 1176 | @end defun |
| 1177 | |
| 1178 | @defun Type.array (@var{n1} @r{[}, @var{n2}@r{]}) |
| 1179 | Return a new @code{gdb.Type} object which represents an array of this |
| 1180 | type. If one argument is given, it is the inclusive upper bound of |
| 1181 | the array; in this case the lower bound is zero. If two arguments are |
| 1182 | given, the first argument is the lower bound of the array, and the |
| 1183 | second argument is the upper bound of the array. An array's length |
| 1184 | must not be negative, but the bounds can be. |
| 1185 | @end defun |
| 1186 | |
| 1187 | @defun Type.vector (@var{n1} @r{[}, @var{n2}@r{]}) |
| 1188 | Return a new @code{gdb.Type} object which represents a vector of this |
| 1189 | type. If one argument is given, it is the inclusive upper bound of |
| 1190 | the vector; in this case the lower bound is zero. If two arguments are |
| 1191 | given, the first argument is the lower bound of the vector, and the |
| 1192 | second argument is the upper bound of the vector. A vector's length |
| 1193 | must not be negative, but the bounds can be. |
| 1194 | |
| 1195 | The difference between an @code{array} and a @code{vector} is that |
| 1196 | arrays behave like in C: when used in expressions they decay to a pointer |
| 1197 | to the first element whereas vectors are treated as first class values. |
| 1198 | @end defun |
| 1199 | |
| 1200 | @defun Type.const () |
| 1201 | Return a new @code{gdb.Type} object which represents a |
| 1202 | @code{const}-qualified variant of this type. |
| 1203 | @end defun |
| 1204 | |
| 1205 | @defun Type.volatile () |
| 1206 | Return a new @code{gdb.Type} object which represents a |
| 1207 | @code{volatile}-qualified variant of this type. |
| 1208 | @end defun |
| 1209 | |
| 1210 | @defun Type.unqualified () |
| 1211 | Return a new @code{gdb.Type} object which represents an unqualified |
| 1212 | variant of this type. That is, the result is neither @code{const} nor |
| 1213 | @code{volatile}. |
| 1214 | @end defun |
| 1215 | |
| 1216 | @defun Type.range () |
| 1217 | Return a Python @code{Tuple} object that contains two elements: the |
| 1218 | low bound of the argument type and the high bound of that type. If |
| 1219 | the type does not have a range, @value{GDBN} will raise a |
| 1220 | @code{gdb.error} exception (@pxref{Exception Handling}). |
| 1221 | @end defun |
| 1222 | |
| 1223 | @defun Type.reference () |
| 1224 | Return a new @code{gdb.Type} object which represents a reference to this |
| 1225 | type. |
| 1226 | @end defun |
| 1227 | |
| 1228 | @defun Type.pointer () |
| 1229 | Return a new @code{gdb.Type} object which represents a pointer to this |
| 1230 | type. |
| 1231 | @end defun |
| 1232 | |
| 1233 | @defun Type.strip_typedefs () |
| 1234 | Return a new @code{gdb.Type} that represents the real type, |
| 1235 | after removing all layers of typedefs. |
| 1236 | @end defun |
| 1237 | |
| 1238 | @defun Type.target () |
| 1239 | Return a new @code{gdb.Type} object which represents the target type |
| 1240 | of this type. |
| 1241 | |
| 1242 | For a pointer type, the target type is the type of the pointed-to |
| 1243 | object. For an array type (meaning C-like arrays), the target type is |
| 1244 | the type of the elements of the array. For a function or method type, |
| 1245 | the target type is the type of the return value. For a complex type, |
| 1246 | the target type is the type of the elements. For a typedef, the |
| 1247 | target type is the aliased type. |
| 1248 | |
| 1249 | If the type does not have a target, this method will throw an |
| 1250 | exception. |
| 1251 | @end defun |
| 1252 | |
| 1253 | @defun Type.template_argument (n @r{[}, block@r{]}) |
| 1254 | If this @code{gdb.Type} is an instantiation of a template, this will |
| 1255 | return a new @code{gdb.Value} or @code{gdb.Type} which represents the |
| 1256 | value of the @var{n}th template argument (indexed starting at 0). |
| 1257 | |
| 1258 | If this @code{gdb.Type} is not a template type, or if the type has fewer |
| 1259 | than @var{n} template arguments, this will throw an exception. |
| 1260 | Ordinarily, only C@t{++} code will have template types. |
| 1261 | |
| 1262 | If @var{block} is given, then @var{name} is looked up in that scope. |
| 1263 | Otherwise, it is searched for globally. |
| 1264 | @end defun |
| 1265 | |
| 1266 | @defun Type.optimized_out () |
| 1267 | Return @code{gdb.Value} instance of this type whose value is optimized |
| 1268 | out. This allows a frame decorator to indicate that the value of an |
| 1269 | argument or a local variable is not known. |
| 1270 | @end defun |
| 1271 | |
| 1272 | Each type has a code, which indicates what category this type falls |
| 1273 | into. The available type categories are represented by constants |
| 1274 | defined in the @code{gdb} module: |
| 1275 | |
| 1276 | @vtable @code |
| 1277 | @vindex TYPE_CODE_PTR |
| 1278 | @item gdb.TYPE_CODE_PTR |
| 1279 | The type is a pointer. |
| 1280 | |
| 1281 | @vindex TYPE_CODE_ARRAY |
| 1282 | @item gdb.TYPE_CODE_ARRAY |
| 1283 | The type is an array. |
| 1284 | |
| 1285 | @vindex TYPE_CODE_STRUCT |
| 1286 | @item gdb.TYPE_CODE_STRUCT |
| 1287 | The type is a structure. |
| 1288 | |
| 1289 | @vindex TYPE_CODE_UNION |
| 1290 | @item gdb.TYPE_CODE_UNION |
| 1291 | The type is a union. |
| 1292 | |
| 1293 | @vindex TYPE_CODE_ENUM |
| 1294 | @item gdb.TYPE_CODE_ENUM |
| 1295 | The type is an enum. |
| 1296 | |
| 1297 | @vindex TYPE_CODE_FLAGS |
| 1298 | @item gdb.TYPE_CODE_FLAGS |
| 1299 | A bit flags type, used for things such as status registers. |
| 1300 | |
| 1301 | @vindex TYPE_CODE_FUNC |
| 1302 | @item gdb.TYPE_CODE_FUNC |
| 1303 | The type is a function. |
| 1304 | |
| 1305 | @vindex TYPE_CODE_INT |
| 1306 | @item gdb.TYPE_CODE_INT |
| 1307 | The type is an integer type. |
| 1308 | |
| 1309 | @vindex TYPE_CODE_FLT |
| 1310 | @item gdb.TYPE_CODE_FLT |
| 1311 | A floating point type. |
| 1312 | |
| 1313 | @vindex TYPE_CODE_VOID |
| 1314 | @item gdb.TYPE_CODE_VOID |
| 1315 | The special type @code{void}. |
| 1316 | |
| 1317 | @vindex TYPE_CODE_SET |
| 1318 | @item gdb.TYPE_CODE_SET |
| 1319 | A Pascal set type. |
| 1320 | |
| 1321 | @vindex TYPE_CODE_RANGE |
| 1322 | @item gdb.TYPE_CODE_RANGE |
| 1323 | A range type, that is, an integer type with bounds. |
| 1324 | |
| 1325 | @vindex TYPE_CODE_STRING |
| 1326 | @item gdb.TYPE_CODE_STRING |
| 1327 | A string type. Note that this is only used for certain languages with |
| 1328 | language-defined string types; C strings are not represented this way. |
| 1329 | |
| 1330 | @vindex TYPE_CODE_BITSTRING |
| 1331 | @item gdb.TYPE_CODE_BITSTRING |
| 1332 | A string of bits. It is deprecated. |
| 1333 | |
| 1334 | @vindex TYPE_CODE_ERROR |
| 1335 | @item gdb.TYPE_CODE_ERROR |
| 1336 | An unknown or erroneous type. |
| 1337 | |
| 1338 | @vindex TYPE_CODE_METHOD |
| 1339 | @item gdb.TYPE_CODE_METHOD |
| 1340 | A method type, as found in C@t{++}. |
| 1341 | |
| 1342 | @vindex TYPE_CODE_METHODPTR |
| 1343 | @item gdb.TYPE_CODE_METHODPTR |
| 1344 | A pointer-to-member-function. |
| 1345 | |
| 1346 | @vindex TYPE_CODE_MEMBERPTR |
| 1347 | @item gdb.TYPE_CODE_MEMBERPTR |
| 1348 | A pointer-to-member. |
| 1349 | |
| 1350 | @vindex TYPE_CODE_REF |
| 1351 | @item gdb.TYPE_CODE_REF |
| 1352 | A reference type. |
| 1353 | |
| 1354 | @vindex TYPE_CODE_RVALUE_REF |
| 1355 | @item gdb.TYPE_CODE_RVALUE_REF |
| 1356 | A C@t{++}11 rvalue reference type. |
| 1357 | |
| 1358 | @vindex TYPE_CODE_CHAR |
| 1359 | @item gdb.TYPE_CODE_CHAR |
| 1360 | A character type. |
| 1361 | |
| 1362 | @vindex TYPE_CODE_BOOL |
| 1363 | @item gdb.TYPE_CODE_BOOL |
| 1364 | A boolean type. |
| 1365 | |
| 1366 | @vindex TYPE_CODE_COMPLEX |
| 1367 | @item gdb.TYPE_CODE_COMPLEX |
| 1368 | A complex float type. |
| 1369 | |
| 1370 | @vindex TYPE_CODE_TYPEDEF |
| 1371 | @item gdb.TYPE_CODE_TYPEDEF |
| 1372 | A typedef to some other type. |
| 1373 | |
| 1374 | @vindex TYPE_CODE_NAMESPACE |
| 1375 | @item gdb.TYPE_CODE_NAMESPACE |
| 1376 | A C@t{++} namespace. |
| 1377 | |
| 1378 | @vindex TYPE_CODE_DECFLOAT |
| 1379 | @item gdb.TYPE_CODE_DECFLOAT |
| 1380 | A decimal floating point type. |
| 1381 | |
| 1382 | @vindex TYPE_CODE_INTERNAL_FUNCTION |
| 1383 | @item gdb.TYPE_CODE_INTERNAL_FUNCTION |
| 1384 | A function internal to @value{GDBN}. This is the type used to represent |
| 1385 | convenience functions. |
| 1386 | @end vtable |
| 1387 | |
| 1388 | Further support for types is provided in the @code{gdb.types} |
| 1389 | Python module (@pxref{gdb.types}). |
| 1390 | |
| 1391 | @node Pretty Printing API |
| 1392 | @subsubsection Pretty Printing API |
| 1393 | @cindex python pretty printing api |
| 1394 | |
| 1395 | A pretty-printer is just an object that holds a value and implements a |
| 1396 | specific interface, defined here. An example output is provided |
| 1397 | (@pxref{Pretty Printing}). |
| 1398 | |
| 1399 | @defun pretty_printer.children (self) |
| 1400 | @value{GDBN} will call this method on a pretty-printer to compute the |
| 1401 | children of the pretty-printer's value. |
| 1402 | |
| 1403 | This method must return an object conforming to the Python iterator |
| 1404 | protocol. Each item returned by the iterator must be a tuple holding |
| 1405 | two elements. The first element is the ``name'' of the child; the |
| 1406 | second element is the child's value. The value can be any Python |
| 1407 | object which is convertible to a @value{GDBN} value. |
| 1408 | |
| 1409 | This method is optional. If it does not exist, @value{GDBN} will act |
| 1410 | as though the value has no children. |
| 1411 | |
| 1412 | For efficiency, the @code{children} method should lazily compute its |
| 1413 | results. This will let @value{GDBN} read as few elements as |
| 1414 | necessary, for example when various print settings (@pxref{Print |
| 1415 | Settings}) or @code{-var-list-children} (@pxref{GDB/MI Variable |
| 1416 | Objects}) limit the number of elements to be displayed. |
| 1417 | |
| 1418 | Children may be hidden from display based on the value of @samp{set |
| 1419 | print max-depth} (@pxref{Print Settings}). |
| 1420 | @end defun |
| 1421 | |
| 1422 | @defun pretty_printer.display_hint (self) |
| 1423 | The CLI may call this method and use its result to change the |
| 1424 | formatting of a value. The result will also be supplied to an MI |
| 1425 | consumer as a @samp{displayhint} attribute of the variable being |
| 1426 | printed. |
| 1427 | |
| 1428 | This method is optional. If it does exist, this method must return a |
| 1429 | string or the special value @code{None}. |
| 1430 | |
| 1431 | Some display hints are predefined by @value{GDBN}: |
| 1432 | |
| 1433 | @table @samp |
| 1434 | @item array |
| 1435 | Indicate that the object being printed is ``array-like''. The CLI |
| 1436 | uses this to respect parameters such as @code{set print elements} and |
| 1437 | @code{set print array}. |
| 1438 | |
| 1439 | @item map |
| 1440 | Indicate that the object being printed is ``map-like'', and that the |
| 1441 | children of this value can be assumed to alternate between keys and |
| 1442 | values. |
| 1443 | |
| 1444 | @item string |
| 1445 | Indicate that the object being printed is ``string-like''. If the |
| 1446 | printer's @code{to_string} method returns a Python string of some |
| 1447 | kind, then @value{GDBN} will call its internal language-specific |
| 1448 | string-printing function to format the string. For the CLI this means |
| 1449 | adding quotation marks, possibly escaping some characters, respecting |
| 1450 | @code{set print elements}, and the like. |
| 1451 | @end table |
| 1452 | |
| 1453 | The special value @code{None} causes @value{GDBN} to apply the default |
| 1454 | display rules. |
| 1455 | @end defun |
| 1456 | |
| 1457 | @defun pretty_printer.to_string (self) |
| 1458 | @value{GDBN} will call this method to display the string |
| 1459 | representation of the value passed to the object's constructor. |
| 1460 | |
| 1461 | When printing from the CLI, if the @code{to_string} method exists, |
| 1462 | then @value{GDBN} will prepend its result to the values returned by |
| 1463 | @code{children}. Exactly how this formatting is done is dependent on |
| 1464 | the display hint, and may change as more hints are added. Also, |
| 1465 | depending on the print settings (@pxref{Print Settings}), the CLI may |
| 1466 | print just the result of @code{to_string} in a stack trace, omitting |
| 1467 | the result of @code{children}. |
| 1468 | |
| 1469 | If this method returns a string, it is printed verbatim. |
| 1470 | |
| 1471 | Otherwise, if this method returns an instance of @code{gdb.Value}, |
| 1472 | then @value{GDBN} prints this value. This may result in a call to |
| 1473 | another pretty-printer. |
| 1474 | |
| 1475 | If instead the method returns a Python value which is convertible to a |
| 1476 | @code{gdb.Value}, then @value{GDBN} performs the conversion and prints |
| 1477 | the resulting value. Again, this may result in a call to another |
| 1478 | pretty-printer. Python scalars (integers, floats, and booleans) and |
| 1479 | strings are convertible to @code{gdb.Value}; other types are not. |
| 1480 | |
| 1481 | Finally, if this method returns @code{None} then no further operations |
| 1482 | are peformed in this method and nothing is printed. |
| 1483 | |
| 1484 | If the result is not one of these types, an exception is raised. |
| 1485 | @end defun |
| 1486 | |
| 1487 | @value{GDBN} provides a function which can be used to look up the |
| 1488 | default pretty-printer for a @code{gdb.Value}: |
| 1489 | |
| 1490 | @findex gdb.default_visualizer |
| 1491 | @defun gdb.default_visualizer (value) |
| 1492 | This function takes a @code{gdb.Value} object as an argument. If a |
| 1493 | pretty-printer for this value exists, then it is returned. If no such |
| 1494 | printer exists, then this returns @code{None}. |
| 1495 | @end defun |
| 1496 | |
| 1497 | @node Selecting Pretty-Printers |
| 1498 | @subsubsection Selecting Pretty-Printers |
| 1499 | @cindex selecting python pretty-printers |
| 1500 | |
| 1501 | @value{GDBN} provides several ways to register a pretty-printer: |
| 1502 | globally, per program space, and per objfile. When choosing how to |
| 1503 | register your pretty-printer, a good rule is to register it with the |
| 1504 | smallest scope possible: that is prefer a specific objfile first, then |
| 1505 | a program space, and only register a printer globally as a last |
| 1506 | resort. |
| 1507 | |
| 1508 | @findex gdb.pretty_printers |
| 1509 | @defvar gdb.pretty_printers |
| 1510 | The Python list @code{gdb.pretty_printers} contains an array of |
| 1511 | functions or callable objects that have been registered via addition |
| 1512 | as a pretty-printer. Printers in this list are called @code{global} |
| 1513 | printers, they're available when debugging all inferiors. |
| 1514 | @end defvar |
| 1515 | |
| 1516 | Each @code{gdb.Progspace} contains a @code{pretty_printers} attribute. |
| 1517 | Each @code{gdb.Objfile} also contains a @code{pretty_printers} |
| 1518 | attribute. |
| 1519 | |
| 1520 | Each function on these lists is passed a single @code{gdb.Value} |
| 1521 | argument and should return a pretty-printer object conforming to the |
| 1522 | interface definition above (@pxref{Pretty Printing API}). If a function |
| 1523 | cannot create a pretty-printer for the value, it should return |
| 1524 | @code{None}. |
| 1525 | |
| 1526 | @value{GDBN} first checks the @code{pretty_printers} attribute of each |
| 1527 | @code{gdb.Objfile} in the current program space and iteratively calls |
| 1528 | each enabled lookup routine in the list for that @code{gdb.Objfile} |
| 1529 | until it receives a pretty-printer object. |
| 1530 | If no pretty-printer is found in the objfile lists, @value{GDBN} then |
| 1531 | searches the pretty-printer list of the current program space, |
| 1532 | calling each enabled function until an object is returned. |
| 1533 | After these lists have been exhausted, it tries the global |
| 1534 | @code{gdb.pretty_printers} list, again calling each enabled function until an |
| 1535 | object is returned. |
| 1536 | |
| 1537 | The order in which the objfiles are searched is not specified. For a |
| 1538 | given list, functions are always invoked from the head of the list, |
| 1539 | and iterated over sequentially until the end of the list, or a printer |
| 1540 | object is returned. |
| 1541 | |
| 1542 | For various reasons a pretty-printer may not work. |
| 1543 | For example, the underlying data structure may have changed and |
| 1544 | the pretty-printer is out of date. |
| 1545 | |
| 1546 | The consequences of a broken pretty-printer are severe enough that |
| 1547 | @value{GDBN} provides support for enabling and disabling individual |
| 1548 | printers. For example, if @code{print frame-arguments} is on, |
| 1549 | a backtrace can become highly illegible if any argument is printed |
| 1550 | with a broken printer. |
| 1551 | |
| 1552 | Pretty-printers are enabled and disabled by attaching an @code{enabled} |
| 1553 | attribute to the registered function or callable object. If this attribute |
| 1554 | is present and its value is @code{False}, the printer is disabled, otherwise |
| 1555 | the printer is enabled. |
| 1556 | |
| 1557 | @node Writing a Pretty-Printer |
| 1558 | @subsubsection Writing a Pretty-Printer |
| 1559 | @cindex writing a pretty-printer |
| 1560 | |
| 1561 | A pretty-printer consists of two parts: a lookup function to detect |
| 1562 | if the type is supported, and the printer itself. |
| 1563 | |
| 1564 | Here is an example showing how a @code{std::string} printer might be |
| 1565 | written. @xref{Pretty Printing API}, for details on the API this class |
| 1566 | must provide. |
| 1567 | |
| 1568 | @smallexample |
| 1569 | class StdStringPrinter(object): |
| 1570 | "Print a std::string" |
| 1571 | |
| 1572 | def __init__(self, val): |
| 1573 | self.val = val |
| 1574 | |
| 1575 | def to_string(self): |
| 1576 | return self.val['_M_dataplus']['_M_p'] |
| 1577 | |
| 1578 | def display_hint(self): |
| 1579 | return 'string' |
| 1580 | @end smallexample |
| 1581 | |
| 1582 | And here is an example showing how a lookup function for the printer |
| 1583 | example above might be written. |
| 1584 | |
| 1585 | @smallexample |
| 1586 | def str_lookup_function(val): |
| 1587 | lookup_tag = val.type.tag |
| 1588 | if lookup_tag == None: |
| 1589 | return None |
| 1590 | regex = re.compile("^std::basic_string<char,.*>$") |
| 1591 | if regex.match(lookup_tag): |
| 1592 | return StdStringPrinter(val) |
| 1593 | return None |
| 1594 | @end smallexample |
| 1595 | |
| 1596 | The example lookup function extracts the value's type, and attempts to |
| 1597 | match it to a type that it can pretty-print. If it is a type the |
| 1598 | printer can pretty-print, it will return a printer object. If not, it |
| 1599 | returns @code{None}. |
| 1600 | |
| 1601 | We recommend that you put your core pretty-printers into a Python |
| 1602 | package. If your pretty-printers are for use with a library, we |
| 1603 | further recommend embedding a version number into the package name. |
| 1604 | This practice will enable @value{GDBN} to load multiple versions of |
| 1605 | your pretty-printers at the same time, because they will have |
| 1606 | different names. |
| 1607 | |
| 1608 | You should write auto-loaded code (@pxref{Python Auto-loading}) such that it |
| 1609 | can be evaluated multiple times without changing its meaning. An |
| 1610 | ideal auto-load file will consist solely of @code{import}s of your |
| 1611 | printer modules, followed by a call to a register pretty-printers with |
| 1612 | the current objfile. |
| 1613 | |
| 1614 | Taken as a whole, this approach will scale nicely to multiple |
| 1615 | inferiors, each potentially using a different library version. |
| 1616 | Embedding a version number in the Python package name will ensure that |
| 1617 | @value{GDBN} is able to load both sets of printers simultaneously. |
| 1618 | Then, because the search for pretty-printers is done by objfile, and |
| 1619 | because your auto-loaded code took care to register your library's |
| 1620 | printers with a specific objfile, @value{GDBN} will find the correct |
| 1621 | printers for the specific version of the library used by each |
| 1622 | inferior. |
| 1623 | |
| 1624 | To continue the @code{std::string} example (@pxref{Pretty Printing API}), |
| 1625 | this code might appear in @code{gdb.libstdcxx.v6}: |
| 1626 | |
| 1627 | @smallexample |
| 1628 | def register_printers(objfile): |
| 1629 | objfile.pretty_printers.append(str_lookup_function) |
| 1630 | @end smallexample |
| 1631 | |
| 1632 | @noindent |
| 1633 | And then the corresponding contents of the auto-load file would be: |
| 1634 | |
| 1635 | @smallexample |
| 1636 | import gdb.libstdcxx.v6 |
| 1637 | gdb.libstdcxx.v6.register_printers(gdb.current_objfile()) |
| 1638 | @end smallexample |
| 1639 | |
| 1640 | The previous example illustrates a basic pretty-printer. |
| 1641 | There are a few things that can be improved on. |
| 1642 | The printer doesn't have a name, making it hard to identify in a |
| 1643 | list of installed printers. The lookup function has a name, but |
| 1644 | lookup functions can have arbitrary, even identical, names. |
| 1645 | |
| 1646 | Second, the printer only handles one type, whereas a library typically has |
| 1647 | several types. One could install a lookup function for each desired type |
| 1648 | in the library, but one could also have a single lookup function recognize |
| 1649 | several types. The latter is the conventional way this is handled. |
| 1650 | If a pretty-printer can handle multiple data types, then its |
| 1651 | @dfn{subprinters} are the printers for the individual data types. |
| 1652 | |
| 1653 | The @code{gdb.printing} module provides a formal way of solving these |
| 1654 | problems (@pxref{gdb.printing}). |
| 1655 | Here is another example that handles multiple types. |
| 1656 | |
| 1657 | These are the types we are going to pretty-print: |
| 1658 | |
| 1659 | @smallexample |
| 1660 | struct foo @{ int a, b; @}; |
| 1661 | struct bar @{ struct foo x, y; @}; |
| 1662 | @end smallexample |
| 1663 | |
| 1664 | Here are the printers: |
| 1665 | |
| 1666 | @smallexample |
| 1667 | class fooPrinter: |
| 1668 | """Print a foo object.""" |
| 1669 | |
| 1670 | def __init__(self, val): |
| 1671 | self.val = val |
| 1672 | |
| 1673 | def to_string(self): |
| 1674 | return ("a=<" + str(self.val["a"]) + |
| 1675 | "> b=<" + str(self.val["b"]) + ">") |
| 1676 | |
| 1677 | class barPrinter: |
| 1678 | """Print a bar object.""" |
| 1679 | |
| 1680 | def __init__(self, val): |
| 1681 | self.val = val |
| 1682 | |
| 1683 | def to_string(self): |
| 1684 | return ("x=<" + str(self.val["x"]) + |
| 1685 | "> y=<" + str(self.val["y"]) + ">") |
| 1686 | @end smallexample |
| 1687 | |
| 1688 | This example doesn't need a lookup function, that is handled by the |
| 1689 | @code{gdb.printing} module. Instead a function is provided to build up |
| 1690 | the object that handles the lookup. |
| 1691 | |
| 1692 | @smallexample |
| 1693 | import gdb.printing |
| 1694 | |
| 1695 | def build_pretty_printer(): |
| 1696 | pp = gdb.printing.RegexpCollectionPrettyPrinter( |
| 1697 | "my_library") |
| 1698 | pp.add_printer('foo', '^foo$', fooPrinter) |
| 1699 | pp.add_printer('bar', '^bar$', barPrinter) |
| 1700 | return pp |
| 1701 | @end smallexample |
| 1702 | |
| 1703 | And here is the autoload support: |
| 1704 | |
| 1705 | @smallexample |
| 1706 | import gdb.printing |
| 1707 | import my_library |
| 1708 | gdb.printing.register_pretty_printer( |
| 1709 | gdb.current_objfile(), |
| 1710 | my_library.build_pretty_printer()) |
| 1711 | @end smallexample |
| 1712 | |
| 1713 | Finally, when this printer is loaded into @value{GDBN}, here is the |
| 1714 | corresponding output of @samp{info pretty-printer}: |
| 1715 | |
| 1716 | @smallexample |
| 1717 | (gdb) info pretty-printer |
| 1718 | my_library.so: |
| 1719 | my_library |
| 1720 | foo |
| 1721 | bar |
| 1722 | @end smallexample |
| 1723 | |
| 1724 | @node Type Printing API |
| 1725 | @subsubsection Type Printing API |
| 1726 | @cindex type printing API for Python |
| 1727 | |
| 1728 | @value{GDBN} provides a way for Python code to customize type display. |
| 1729 | This is mainly useful for substituting canonical typedef names for |
| 1730 | types. |
| 1731 | |
| 1732 | @cindex type printer |
| 1733 | A @dfn{type printer} is just a Python object conforming to a certain |
| 1734 | protocol. A simple base class implementing the protocol is provided; |
| 1735 | see @ref{gdb.types}. A type printer must supply at least: |
| 1736 | |
| 1737 | @defivar type_printer enabled |
| 1738 | A boolean which is True if the printer is enabled, and False |
| 1739 | otherwise. This is manipulated by the @code{enable type-printer} |
| 1740 | and @code{disable type-printer} commands. |
| 1741 | @end defivar |
| 1742 | |
| 1743 | @defivar type_printer name |
| 1744 | The name of the type printer. This must be a string. This is used by |
| 1745 | the @code{enable type-printer} and @code{disable type-printer} |
| 1746 | commands. |
| 1747 | @end defivar |
| 1748 | |
| 1749 | @defmethod type_printer instantiate (self) |
| 1750 | This is called by @value{GDBN} at the start of type-printing. It is |
| 1751 | only called if the type printer is enabled. This method must return a |
| 1752 | new object that supplies a @code{recognize} method, as described below. |
| 1753 | @end defmethod |
| 1754 | |
| 1755 | |
| 1756 | When displaying a type, say via the @code{ptype} command, @value{GDBN} |
| 1757 | will compute a list of type recognizers. This is done by iterating |
| 1758 | first over the per-objfile type printers (@pxref{Objfiles In Python}), |
| 1759 | followed by the per-progspace type printers (@pxref{Progspaces In |
| 1760 | Python}), and finally the global type printers. |
| 1761 | |
| 1762 | @value{GDBN} will call the @code{instantiate} method of each enabled |
| 1763 | type printer. If this method returns @code{None}, then the result is |
| 1764 | ignored; otherwise, it is appended to the list of recognizers. |
| 1765 | |
| 1766 | Then, when @value{GDBN} is going to display a type name, it iterates |
| 1767 | over the list of recognizers. For each one, it calls the recognition |
| 1768 | function, stopping if the function returns a non-@code{None} value. |
| 1769 | The recognition function is defined as: |
| 1770 | |
| 1771 | @defmethod type_recognizer recognize (self, type) |
| 1772 | If @var{type} is not recognized, return @code{None}. Otherwise, |
| 1773 | return a string which is to be printed as the name of @var{type}. |
| 1774 | The @var{type} argument will be an instance of @code{gdb.Type} |
| 1775 | (@pxref{Types In Python}). |
| 1776 | @end defmethod |
| 1777 | |
| 1778 | @value{GDBN} uses this two-pass approach so that type printers can |
| 1779 | efficiently cache information without holding on to it too long. For |
| 1780 | example, it can be convenient to look up type information in a type |
| 1781 | printer and hold it for a recognizer's lifetime; if a single pass were |
| 1782 | done then type printers would have to make use of the event system in |
| 1783 | order to avoid holding information that could become stale as the |
| 1784 | inferior changed. |
| 1785 | |
| 1786 | @node Frame Filter API |
| 1787 | @subsubsection Filtering Frames |
| 1788 | @cindex frame filters api |
| 1789 | |
| 1790 | Frame filters are Python objects that manipulate the visibility of a |
| 1791 | frame or frames when a backtrace (@pxref{Backtrace}) is printed by |
| 1792 | @value{GDBN}. |
| 1793 | |
| 1794 | Only commands that print a backtrace, or, in the case of @sc{gdb/mi} |
| 1795 | commands (@pxref{GDB/MI}), those that return a collection of frames |
| 1796 | are affected. The commands that work with frame filters are: |
| 1797 | |
| 1798 | @code{backtrace} (@pxref{backtrace-command,, The backtrace command}), |
| 1799 | @code{-stack-list-frames} |
| 1800 | (@pxref{-stack-list-frames,, The -stack-list-frames command}), |
| 1801 | @code{-stack-list-variables} (@pxref{-stack-list-variables,, The |
| 1802 | -stack-list-variables command}), @code{-stack-list-arguments} |
| 1803 | @pxref{-stack-list-arguments,, The -stack-list-arguments command}) and |
| 1804 | @code{-stack-list-locals} (@pxref{-stack-list-locals,, The |
| 1805 | -stack-list-locals command}). |
| 1806 | |
| 1807 | A frame filter works by taking an iterator as an argument, applying |
| 1808 | actions to the contents of that iterator, and returning another |
| 1809 | iterator (or, possibly, the same iterator it was provided in the case |
| 1810 | where the filter does not perform any operations). Typically, frame |
| 1811 | filters utilize tools such as the Python's @code{itertools} module to |
| 1812 | work with and create new iterators from the source iterator. |
| 1813 | Regardless of how a filter chooses to apply actions, it must not alter |
| 1814 | the underlying @value{GDBN} frame or frames, or attempt to alter the |
| 1815 | call-stack within @value{GDBN}. This preserves data integrity within |
| 1816 | @value{GDBN}. Frame filters are executed on a priority basis and care |
| 1817 | should be taken that some frame filters may have been executed before, |
| 1818 | and that some frame filters will be executed after. |
| 1819 | |
| 1820 | An important consideration when designing frame filters, and well |
| 1821 | worth reflecting upon, is that frame filters should avoid unwinding |
| 1822 | the call stack if possible. Some stacks can run very deep, into the |
| 1823 | tens of thousands in some cases. To search every frame when a frame |
| 1824 | filter executes may be too expensive at that step. The frame filter |
| 1825 | cannot know how many frames it has to iterate over, and it may have to |
| 1826 | iterate through them all. This ends up duplicating effort as |
| 1827 | @value{GDBN} performs this iteration when it prints the frames. If |
| 1828 | the filter can defer unwinding frames until frame decorators are |
| 1829 | executed, after the last filter has executed, it should. @xref{Frame |
| 1830 | Decorator API}, for more information on decorators. Also, there are |
| 1831 | examples for both frame decorators and filters in later chapters. |
| 1832 | @xref{Writing a Frame Filter}, for more information. |
| 1833 | |
| 1834 | The Python dictionary @code{gdb.frame_filters} contains key/object |
| 1835 | pairings that comprise a frame filter. Frame filters in this |
| 1836 | dictionary are called @code{global} frame filters, and they are |
| 1837 | available when debugging all inferiors. These frame filters must |
| 1838 | register with the dictionary directly. In addition to the |
| 1839 | @code{global} dictionary, there are other dictionaries that are loaded |
| 1840 | with different inferiors via auto-loading (@pxref{Python |
| 1841 | Auto-loading}). The two other areas where frame filter dictionaries |
| 1842 | can be found are: @code{gdb.Progspace} which contains a |
| 1843 | @code{frame_filters} dictionary attribute, and each @code{gdb.Objfile} |
| 1844 | object which also contains a @code{frame_filters} dictionary |
| 1845 | attribute. |
| 1846 | |
| 1847 | When a command is executed from @value{GDBN} that is compatible with |
| 1848 | frame filters, @value{GDBN} combines the @code{global}, |
| 1849 | @code{gdb.Progspace} and all @code{gdb.Objfile} dictionaries currently |
| 1850 | loaded. All of the @code{gdb.Objfile} dictionaries are combined, as |
| 1851 | several frames, and thus several object files, might be in use. |
| 1852 | @value{GDBN} then prunes any frame filter whose @code{enabled} |
| 1853 | attribute is @code{False}. This pruned list is then sorted according |
| 1854 | to the @code{priority} attribute in each filter. |
| 1855 | |
| 1856 | Once the dictionaries are combined, pruned and sorted, @value{GDBN} |
| 1857 | creates an iterator which wraps each frame in the call stack in a |
| 1858 | @code{FrameDecorator} object, and calls each filter in order. The |
| 1859 | output from the previous filter will always be the input to the next |
| 1860 | filter, and so on. |
| 1861 | |
| 1862 | Frame filters have a mandatory interface which each frame filter must |
| 1863 | implement, defined here: |
| 1864 | |
| 1865 | @defun FrameFilter.filter (iterator) |
| 1866 | @value{GDBN} will call this method on a frame filter when it has |
| 1867 | reached the order in the priority list for that filter. |
| 1868 | |
| 1869 | For example, if there are four frame filters: |
| 1870 | |
| 1871 | @smallexample |
| 1872 | Name Priority |
| 1873 | |
| 1874 | Filter1 5 |
| 1875 | Filter2 10 |
| 1876 | Filter3 100 |
| 1877 | Filter4 1 |
| 1878 | @end smallexample |
| 1879 | |
| 1880 | The order that the frame filters will be called is: |
| 1881 | |
| 1882 | @smallexample |
| 1883 | Filter3 -> Filter2 -> Filter1 -> Filter4 |
| 1884 | @end smallexample |
| 1885 | |
| 1886 | Note that the output from @code{Filter3} is passed to the input of |
| 1887 | @code{Filter2}, and so on. |
| 1888 | |
| 1889 | This @code{filter} method is passed a Python iterator. This iterator |
| 1890 | contains a sequence of frame decorators that wrap each |
| 1891 | @code{gdb.Frame}, or a frame decorator that wraps another frame |
| 1892 | decorator. The first filter that is executed in the sequence of frame |
| 1893 | filters will receive an iterator entirely comprised of default |
| 1894 | @code{FrameDecorator} objects. However, after each frame filter is |
| 1895 | executed, the previous frame filter may have wrapped some or all of |
| 1896 | the frame decorators with their own frame decorator. As frame |
| 1897 | decorators must also conform to a mandatory interface, these |
| 1898 | decorators can be assumed to act in a uniform manner (@pxref{Frame |
| 1899 | Decorator API}). |
| 1900 | |
| 1901 | This method must return an object conforming to the Python iterator |
| 1902 | protocol. Each item in the iterator must be an object conforming to |
| 1903 | the frame decorator interface. If a frame filter does not wish to |
| 1904 | perform any operations on this iterator, it should return that |
| 1905 | iterator untouched. |
| 1906 | |
| 1907 | This method is not optional. If it does not exist, @value{GDBN} will |
| 1908 | raise and print an error. |
| 1909 | @end defun |
| 1910 | |
| 1911 | @defvar FrameFilter.name |
| 1912 | The @code{name} attribute must be Python string which contains the |
| 1913 | name of the filter displayed by @value{GDBN} (@pxref{Frame Filter |
| 1914 | Management}). This attribute may contain any combination of letters |
| 1915 | or numbers. Care should be taken to ensure that it is unique. This |
| 1916 | attribute is mandatory. |
| 1917 | @end defvar |
| 1918 | |
| 1919 | @defvar FrameFilter.enabled |
| 1920 | The @code{enabled} attribute must be Python boolean. This attribute |
| 1921 | indicates to @value{GDBN} whether the frame filter is enabled, and |
| 1922 | should be considered when frame filters are executed. If |
| 1923 | @code{enabled} is @code{True}, then the frame filter will be executed |
| 1924 | when any of the backtrace commands detailed earlier in this chapter |
| 1925 | are executed. If @code{enabled} is @code{False}, then the frame |
| 1926 | filter will not be executed. This attribute is mandatory. |
| 1927 | @end defvar |
| 1928 | |
| 1929 | @defvar FrameFilter.priority |
| 1930 | The @code{priority} attribute must be Python integer. This attribute |
| 1931 | controls the order of execution in relation to other frame filters. |
| 1932 | There are no imposed limits on the range of @code{priority} other than |
| 1933 | it must be a valid integer. The higher the @code{priority} attribute, |
| 1934 | the sooner the frame filter will be executed in relation to other |
| 1935 | frame filters. Although @code{priority} can be negative, it is |
| 1936 | recommended practice to assume zero is the lowest priority that a |
| 1937 | frame filter can be assigned. Frame filters that have the same |
| 1938 | priority are executed in unsorted order in that priority slot. This |
| 1939 | attribute is mandatory. 100 is a good default priority. |
| 1940 | @end defvar |
| 1941 | |
| 1942 | @node Frame Decorator API |
| 1943 | @subsubsection Decorating Frames |
| 1944 | @cindex frame decorator api |
| 1945 | |
| 1946 | Frame decorators are sister objects to frame filters (@pxref{Frame |
| 1947 | Filter API}). Frame decorators are applied by a frame filter and can |
| 1948 | only be used in conjunction with frame filters. |
| 1949 | |
| 1950 | The purpose of a frame decorator is to customize the printed content |
| 1951 | of each @code{gdb.Frame} in commands where frame filters are executed. |
| 1952 | This concept is called decorating a frame. Frame decorators decorate |
| 1953 | a @code{gdb.Frame} with Python code contained within each API call. |
| 1954 | This separates the actual data contained in a @code{gdb.Frame} from |
| 1955 | the decorated data produced by a frame decorator. This abstraction is |
| 1956 | necessary to maintain integrity of the data contained in each |
| 1957 | @code{gdb.Frame}. |
| 1958 | |
| 1959 | Frame decorators have a mandatory interface, defined below. |
| 1960 | |
| 1961 | @value{GDBN} already contains a frame decorator called |
| 1962 | @code{FrameDecorator}. This contains substantial amounts of |
| 1963 | boilerplate code to decorate the content of a @code{gdb.Frame}. It is |
| 1964 | recommended that other frame decorators inherit and extend this |
| 1965 | object, and only to override the methods needed. |
| 1966 | |
| 1967 | @tindex gdb.FrameDecorator |
| 1968 | @code{FrameDecorator} is defined in the Python module |
| 1969 | @code{gdb.FrameDecorator}, so your code can import it like: |
| 1970 | @smallexample |
| 1971 | from gdb.FrameDecorator import FrameDecorator |
| 1972 | @end smallexample |
| 1973 | |
| 1974 | @defun FrameDecorator.elided (self) |
| 1975 | |
| 1976 | The @code{elided} method groups frames together in a hierarchical |
| 1977 | system. An example would be an interpreter, where multiple low-level |
| 1978 | frames make up a single call in the interpreted language. In this |
| 1979 | example, the frame filter would elide the low-level frames and present |
| 1980 | a single high-level frame, representing the call in the interpreted |
| 1981 | language, to the user. |
| 1982 | |
| 1983 | The @code{elided} function must return an iterable and this iterable |
| 1984 | must contain the frames that are being elided wrapped in a suitable |
| 1985 | frame decorator. If no frames are being elided this function may |
| 1986 | return an empty iterable, or @code{None}. Elided frames are indented |
| 1987 | from normal frames in a @code{CLI} backtrace, or in the case of |
| 1988 | @code{GDB/MI}, are placed in the @code{children} field of the eliding |
| 1989 | frame. |
| 1990 | |
| 1991 | It is the frame filter's task to also filter out the elided frames from |
| 1992 | the source iterator. This will avoid printing the frame twice. |
| 1993 | @end defun |
| 1994 | |
| 1995 | @defun FrameDecorator.function (self) |
| 1996 | |
| 1997 | This method returns the name of the function in the frame that is to |
| 1998 | be printed. |
| 1999 | |
| 2000 | This method must return a Python string describing the function, or |
| 2001 | @code{None}. |
| 2002 | |
| 2003 | If this function returns @code{None}, @value{GDBN} will not print any |
| 2004 | data for this field. |
| 2005 | @end defun |
| 2006 | |
| 2007 | @defun FrameDecorator.address (self) |
| 2008 | |
| 2009 | This method returns the address of the frame that is to be printed. |
| 2010 | |
| 2011 | This method must return a Python numeric integer type of sufficient |
| 2012 | size to describe the address of the frame, or @code{None}. |
| 2013 | |
| 2014 | If this function returns a @code{None}, @value{GDBN} will not print |
| 2015 | any data for this field. |
| 2016 | @end defun |
| 2017 | |
| 2018 | @defun FrameDecorator.filename (self) |
| 2019 | |
| 2020 | This method returns the filename and path associated with this frame. |
| 2021 | |
| 2022 | This method must return a Python string containing the filename and |
| 2023 | the path to the object file backing the frame, or @code{None}. |
| 2024 | |
| 2025 | If this function returns a @code{None}, @value{GDBN} will not print |
| 2026 | any data for this field. |
| 2027 | @end defun |
| 2028 | |
| 2029 | @defun FrameDecorator.line (self): |
| 2030 | |
| 2031 | This method returns the line number associated with the current |
| 2032 | position within the function addressed by this frame. |
| 2033 | |
| 2034 | This method must return a Python integer type, or @code{None}. |
| 2035 | |
| 2036 | If this function returns a @code{None}, @value{GDBN} will not print |
| 2037 | any data for this field. |
| 2038 | @end defun |
| 2039 | |
| 2040 | @defun FrameDecorator.frame_args (self) |
| 2041 | @anchor{frame_args} |
| 2042 | |
| 2043 | This method must return an iterable, or @code{None}. Returning an |
| 2044 | empty iterable, or @code{None} means frame arguments will not be |
| 2045 | printed for this frame. This iterable must contain objects that |
| 2046 | implement two methods, described here. |
| 2047 | |
| 2048 | This object must implement a @code{symbol} method which takes a |
| 2049 | single @code{self} parameter and must return a @code{gdb.Symbol} |
| 2050 | (@pxref{Symbols In Python}), or a Python string. The object must also |
| 2051 | implement a @code{value} method which takes a single @code{self} |
| 2052 | parameter and must return a @code{gdb.Value} (@pxref{Values From |
| 2053 | Inferior}), a Python value, or @code{None}. If the @code{value} |
| 2054 | method returns @code{None}, and the @code{argument} method returns a |
| 2055 | @code{gdb.Symbol}, @value{GDBN} will look-up and print the value of |
| 2056 | the @code{gdb.Symbol} automatically. |
| 2057 | |
| 2058 | A brief example: |
| 2059 | |
| 2060 | @smallexample |
| 2061 | class SymValueWrapper(): |
| 2062 | |
| 2063 | def __init__(self, symbol, value): |
| 2064 | self.sym = symbol |
| 2065 | self.val = value |
| 2066 | |
| 2067 | def value(self): |
| 2068 | return self.val |
| 2069 | |
| 2070 | def symbol(self): |
| 2071 | return self.sym |
| 2072 | |
| 2073 | class SomeFrameDecorator() |
| 2074 | ... |
| 2075 | ... |
| 2076 | def frame_args(self): |
| 2077 | args = [] |
| 2078 | try: |
| 2079 | block = self.inferior_frame.block() |
| 2080 | except: |
| 2081 | return None |
| 2082 | |
| 2083 | # Iterate over all symbols in a block. Only add |
| 2084 | # symbols that are arguments. |
| 2085 | for sym in block: |
| 2086 | if not sym.is_argument: |
| 2087 | continue |
| 2088 | args.append(SymValueWrapper(sym,None)) |
| 2089 | |
| 2090 | # Add example synthetic argument. |
| 2091 | args.append(SymValueWrapper(``foo'', 42)) |
| 2092 | |
| 2093 | return args |
| 2094 | @end smallexample |
| 2095 | @end defun |
| 2096 | |
| 2097 | @defun FrameDecorator.frame_locals (self) |
| 2098 | |
| 2099 | This method must return an iterable or @code{None}. Returning an |
| 2100 | empty iterable, or @code{None} means frame local arguments will not be |
| 2101 | printed for this frame. |
| 2102 | |
| 2103 | The object interface, the description of the various strategies for |
| 2104 | reading frame locals, and the example are largely similar to those |
| 2105 | described in the @code{frame_args} function, (@pxref{frame_args,,The |
| 2106 | frame filter frame_args function}). Below is a modified example: |
| 2107 | |
| 2108 | @smallexample |
| 2109 | class SomeFrameDecorator() |
| 2110 | ... |
| 2111 | ... |
| 2112 | def frame_locals(self): |
| 2113 | vars = [] |
| 2114 | try: |
| 2115 | block = self.inferior_frame.block() |
| 2116 | except: |
| 2117 | return None |
| 2118 | |
| 2119 | # Iterate over all symbols in a block. Add all |
| 2120 | # symbols, except arguments. |
| 2121 | for sym in block: |
| 2122 | if sym.is_argument: |
| 2123 | continue |
| 2124 | vars.append(SymValueWrapper(sym,None)) |
| 2125 | |
| 2126 | # Add an example of a synthetic local variable. |
| 2127 | vars.append(SymValueWrapper(``bar'', 99)) |
| 2128 | |
| 2129 | return vars |
| 2130 | @end smallexample |
| 2131 | @end defun |
| 2132 | |
| 2133 | @defun FrameDecorator.inferior_frame (self): |
| 2134 | |
| 2135 | This method must return the underlying @code{gdb.Frame} that this |
| 2136 | frame decorator is decorating. @value{GDBN} requires the underlying |
| 2137 | frame for internal frame information to determine how to print certain |
| 2138 | values when printing a frame. |
| 2139 | @end defun |
| 2140 | |
| 2141 | @node Writing a Frame Filter |
| 2142 | @subsubsection Writing a Frame Filter |
| 2143 | @cindex writing a frame filter |
| 2144 | |
| 2145 | There are three basic elements that a frame filter must implement: it |
| 2146 | must correctly implement the documented interface (@pxref{Frame Filter |
| 2147 | API}), it must register itself with @value{GDBN}, and finally, it must |
| 2148 | decide if it is to work on the data provided by @value{GDBN}. In all |
| 2149 | cases, whether it works on the iterator or not, each frame filter must |
| 2150 | return an iterator. A bare-bones frame filter follows the pattern in |
| 2151 | the following example. |
| 2152 | |
| 2153 | @smallexample |
| 2154 | import gdb |
| 2155 | |
| 2156 | class FrameFilter(): |
| 2157 | |
| 2158 | def __init__(self): |
| 2159 | # Frame filter attribute creation. |
| 2160 | # |
| 2161 | # 'name' is the name of the filter that GDB will display. |
| 2162 | # |
| 2163 | # 'priority' is the priority of the filter relative to other |
| 2164 | # filters. |
| 2165 | # |
| 2166 | # 'enabled' is a boolean that indicates whether this filter is |
| 2167 | # enabled and should be executed. |
| 2168 | |
| 2169 | self.name = "Foo" |
| 2170 | self.priority = 100 |
| 2171 | self.enabled = True |
| 2172 | |
| 2173 | # Register this frame filter with the global frame_filters |
| 2174 | # dictionary. |
| 2175 | gdb.frame_filters[self.name] = self |
| 2176 | |
| 2177 | def filter(self, frame_iter): |
| 2178 | # Just return the iterator. |
| 2179 | return frame_iter |
| 2180 | @end smallexample |
| 2181 | |
| 2182 | The frame filter in the example above implements the three |
| 2183 | requirements for all frame filters. It implements the API, self |
| 2184 | registers, and makes a decision on the iterator (in this case, it just |
| 2185 | returns the iterator untouched). |
| 2186 | |
| 2187 | The first step is attribute creation and assignment, and as shown in |
| 2188 | the comments the filter assigns the following attributes: @code{name}, |
| 2189 | @code{priority} and whether the filter should be enabled with the |
| 2190 | @code{enabled} attribute. |
| 2191 | |
| 2192 | The second step is registering the frame filter with the dictionary or |
| 2193 | dictionaries that the frame filter has interest in. As shown in the |
| 2194 | comments, this filter just registers itself with the global dictionary |
| 2195 | @code{gdb.frame_filters}. As noted earlier, @code{gdb.frame_filters} |
| 2196 | is a dictionary that is initialized in the @code{gdb} module when |
| 2197 | @value{GDBN} starts. What dictionary a filter registers with is an |
| 2198 | important consideration. Generally, if a filter is specific to a set |
| 2199 | of code, it should be registered either in the @code{objfile} or |
| 2200 | @code{progspace} dictionaries as they are specific to the program |
| 2201 | currently loaded in @value{GDBN}. The global dictionary is always |
| 2202 | present in @value{GDBN} and is never unloaded. Any filters registered |
| 2203 | with the global dictionary will exist until @value{GDBN} exits. To |
| 2204 | avoid filters that may conflict, it is generally better to register |
| 2205 | frame filters against the dictionaries that more closely align with |
| 2206 | the usage of the filter currently in question. @xref{Python |
| 2207 | Auto-loading}, for further information on auto-loading Python scripts. |
| 2208 | |
| 2209 | @value{GDBN} takes a hands-off approach to frame filter registration, |
| 2210 | therefore it is the frame filter's responsibility to ensure |
| 2211 | registration has occurred, and that any exceptions are handled |
| 2212 | appropriately. In particular, you may wish to handle exceptions |
| 2213 | relating to Python dictionary key uniqueness. It is mandatory that |
| 2214 | the dictionary key is the same as frame filter's @code{name} |
| 2215 | attribute. When a user manages frame filters (@pxref{Frame Filter |
| 2216 | Management}), the names @value{GDBN} will display are those contained |
| 2217 | in the @code{name} attribute. |
| 2218 | |
| 2219 | The final step of this example is the implementation of the |
| 2220 | @code{filter} method. As shown in the example comments, we define the |
| 2221 | @code{filter} method and note that the method must take an iterator, |
| 2222 | and also must return an iterator. In this bare-bones example, the |
| 2223 | frame filter is not very useful as it just returns the iterator |
| 2224 | untouched. However this is a valid operation for frame filters that |
| 2225 | have the @code{enabled} attribute set, but decide not to operate on |
| 2226 | any frames. |
| 2227 | |
| 2228 | In the next example, the frame filter operates on all frames and |
| 2229 | utilizes a frame decorator to perform some work on the frames. |
| 2230 | @xref{Frame Decorator API}, for further information on the frame |
| 2231 | decorator interface. |
| 2232 | |
| 2233 | This example works on inlined frames. It highlights frames which are |
| 2234 | inlined by tagging them with an ``[inlined]'' tag. By applying a |
| 2235 | frame decorator to all frames with the Python @code{itertools imap} |
| 2236 | method, the example defers actions to the frame decorator. Frame |
| 2237 | decorators are only processed when @value{GDBN} prints the backtrace. |
| 2238 | |
| 2239 | This introduces a new decision making topic: whether to perform |
| 2240 | decision making operations at the filtering step, or at the printing |
| 2241 | step. In this example's approach, it does not perform any filtering |
| 2242 | decisions at the filtering step beyond mapping a frame decorator to |
| 2243 | each frame. This allows the actual decision making to be performed |
| 2244 | when each frame is printed. This is an important consideration, and |
| 2245 | well worth reflecting upon when designing a frame filter. An issue |
| 2246 | that frame filters should avoid is unwinding the stack if possible. |
| 2247 | Some stacks can run very deep, into the tens of thousands in some |
| 2248 | cases. To search every frame to determine if it is inlined ahead of |
| 2249 | time may be too expensive at the filtering step. The frame filter |
| 2250 | cannot know how many frames it has to iterate over, and it would have |
| 2251 | to iterate through them all. This ends up duplicating effort as |
| 2252 | @value{GDBN} performs this iteration when it prints the frames. |
| 2253 | |
| 2254 | In this example decision making can be deferred to the printing step. |
| 2255 | As each frame is printed, the frame decorator can examine each frame |
| 2256 | in turn when @value{GDBN} iterates. From a performance viewpoint, |
| 2257 | this is the most appropriate decision to make as it avoids duplicating |
| 2258 | the effort that the printing step would undertake anyway. Also, if |
| 2259 | there are many frame filters unwinding the stack during filtering, it |
| 2260 | can substantially delay the printing of the backtrace which will |
| 2261 | result in large memory usage, and a poor user experience. |
| 2262 | |
| 2263 | @smallexample |
| 2264 | class InlineFilter(): |
| 2265 | |
| 2266 | def __init__(self): |
| 2267 | self.name = "InlinedFrameFilter" |
| 2268 | self.priority = 100 |
| 2269 | self.enabled = True |
| 2270 | gdb.frame_filters[self.name] = self |
| 2271 | |
| 2272 | def filter(self, frame_iter): |
| 2273 | frame_iter = itertools.imap(InlinedFrameDecorator, |
| 2274 | frame_iter) |
| 2275 | return frame_iter |
| 2276 | @end smallexample |
| 2277 | |
| 2278 | This frame filter is somewhat similar to the earlier example, except |
| 2279 | that the @code{filter} method applies a frame decorator object called |
| 2280 | @code{InlinedFrameDecorator} to each element in the iterator. The |
| 2281 | @code{imap} Python method is light-weight. It does not proactively |
| 2282 | iterate over the iterator, but rather creates a new iterator which |
| 2283 | wraps the existing one. |
| 2284 | |
| 2285 | Below is the frame decorator for this example. |
| 2286 | |
| 2287 | @smallexample |
| 2288 | class InlinedFrameDecorator(FrameDecorator): |
| 2289 | |
| 2290 | def __init__(self, fobj): |
| 2291 | super(InlinedFrameDecorator, self).__init__(fobj) |
| 2292 | |
| 2293 | def function(self): |
| 2294 | frame = fobj.inferior_frame() |
| 2295 | name = str(frame.name()) |
| 2296 | |
| 2297 | if frame.type() == gdb.INLINE_FRAME: |
| 2298 | name = name + " [inlined]" |
| 2299 | |
| 2300 | return name |
| 2301 | @end smallexample |
| 2302 | |
| 2303 | This frame decorator only defines and overrides the @code{function} |
| 2304 | method. It lets the supplied @code{FrameDecorator}, which is shipped |
| 2305 | with @value{GDBN}, perform the other work associated with printing |
| 2306 | this frame. |
| 2307 | |
| 2308 | The combination of these two objects create this output from a |
| 2309 | backtrace: |
| 2310 | |
| 2311 | @smallexample |
| 2312 | #0 0x004004e0 in bar () at inline.c:11 |
| 2313 | #1 0x00400566 in max [inlined] (b=6, a=12) at inline.c:21 |
| 2314 | #2 0x00400566 in main () at inline.c:31 |
| 2315 | @end smallexample |
| 2316 | |
| 2317 | So in the case of this example, a frame decorator is applied to all |
| 2318 | frames, regardless of whether they may be inlined or not. As |
| 2319 | @value{GDBN} iterates over the iterator produced by the frame filters, |
| 2320 | @value{GDBN} executes each frame decorator which then makes a decision |
| 2321 | on what to print in the @code{function} callback. Using a strategy |
| 2322 | like this is a way to defer decisions on the frame content to printing |
| 2323 | time. |
| 2324 | |
| 2325 | @subheading Eliding Frames |
| 2326 | |
| 2327 | It might be that the above example is not desirable for representing |
| 2328 | inlined frames, and a hierarchical approach may be preferred. If we |
| 2329 | want to hierarchically represent frames, the @code{elided} frame |
| 2330 | decorator interface might be preferable. |
| 2331 | |
| 2332 | This example approaches the issue with the @code{elided} method. This |
| 2333 | example is quite long, but very simplistic. It is out-of-scope for |
| 2334 | this section to write a complete example that comprehensively covers |
| 2335 | all approaches of finding and printing inlined frames. However, this |
| 2336 | example illustrates the approach an author might use. |
| 2337 | |
| 2338 | This example comprises of three sections. |
| 2339 | |
| 2340 | @smallexample |
| 2341 | class InlineFrameFilter(): |
| 2342 | |
| 2343 | def __init__(self): |
| 2344 | self.name = "InlinedFrameFilter" |
| 2345 | self.priority = 100 |
| 2346 | self.enabled = True |
| 2347 | gdb.frame_filters[self.name] = self |
| 2348 | |
| 2349 | def filter(self, frame_iter): |
| 2350 | return ElidingInlineIterator(frame_iter) |
| 2351 | @end smallexample |
| 2352 | |
| 2353 | This frame filter is very similar to the other examples. The only |
| 2354 | difference is this frame filter is wrapping the iterator provided to |
| 2355 | it (@code{frame_iter}) with a custom iterator called |
| 2356 | @code{ElidingInlineIterator}. This again defers actions to when |
| 2357 | @value{GDBN} prints the backtrace, as the iterator is not traversed |
| 2358 | until printing. |
| 2359 | |
| 2360 | The iterator for this example is as follows. It is in this section of |
| 2361 | the example where decisions are made on the content of the backtrace. |
| 2362 | |
| 2363 | @smallexample |
| 2364 | class ElidingInlineIterator: |
| 2365 | def __init__(self, ii): |
| 2366 | self.input_iterator = ii |
| 2367 | |
| 2368 | def __iter__(self): |
| 2369 | return self |
| 2370 | |
| 2371 | def next(self): |
| 2372 | frame = next(self.input_iterator) |
| 2373 | |
| 2374 | if frame.inferior_frame().type() != gdb.INLINE_FRAME: |
| 2375 | return frame |
| 2376 | |
| 2377 | try: |
| 2378 | eliding_frame = next(self.input_iterator) |
| 2379 | except StopIteration: |
| 2380 | return frame |
| 2381 | return ElidingFrameDecorator(eliding_frame, [frame]) |
| 2382 | @end smallexample |
| 2383 | |
| 2384 | This iterator implements the Python iterator protocol. When the |
| 2385 | @code{next} function is called (when @value{GDBN} prints each frame), |
| 2386 | the iterator checks if this frame decorator, @code{frame}, is wrapping |
| 2387 | an inlined frame. If it is not, it returns the existing frame decorator |
| 2388 | untouched. If it is wrapping an inlined frame, it assumes that the |
| 2389 | inlined frame was contained within the next oldest frame, |
| 2390 | @code{eliding_frame}, which it fetches. It then creates and returns a |
| 2391 | frame decorator, @code{ElidingFrameDecorator}, which contains both the |
| 2392 | elided frame, and the eliding frame. |
| 2393 | |
| 2394 | @smallexample |
| 2395 | class ElidingInlineDecorator(FrameDecorator): |
| 2396 | |
| 2397 | def __init__(self, frame, elided_frames): |
| 2398 | super(ElidingInlineDecorator, self).__init__(frame) |
| 2399 | self.frame = frame |
| 2400 | self.elided_frames = elided_frames |
| 2401 | |
| 2402 | def elided(self): |
| 2403 | return iter(self.elided_frames) |
| 2404 | @end smallexample |
| 2405 | |
| 2406 | This frame decorator overrides one function and returns the inlined |
| 2407 | frame in the @code{elided} method. As before it lets |
| 2408 | @code{FrameDecorator} do the rest of the work involved in printing |
| 2409 | this frame. This produces the following output. |
| 2410 | |
| 2411 | @smallexample |
| 2412 | #0 0x004004e0 in bar () at inline.c:11 |
| 2413 | #2 0x00400529 in main () at inline.c:25 |
| 2414 | #1 0x00400529 in max (b=6, a=12) at inline.c:15 |
| 2415 | @end smallexample |
| 2416 | |
| 2417 | In that output, @code{max} which has been inlined into @code{main} is |
| 2418 | printed hierarchically. Another approach would be to combine the |
| 2419 | @code{function} method, and the @code{elided} method to both print a |
| 2420 | marker in the inlined frame, and also show the hierarchical |
| 2421 | relationship. |
| 2422 | |
| 2423 | @node Unwinding Frames in Python |
| 2424 | @subsubsection Unwinding Frames in Python |
| 2425 | @cindex unwinding frames in Python |
| 2426 | |
| 2427 | In @value{GDBN} terminology ``unwinding'' is the process of finding |
| 2428 | the previous frame (that is, caller's) from the current one. An |
| 2429 | unwinder has three methods. The first one checks if it can handle |
| 2430 | given frame (``sniff'' it). For the frames it can sniff an unwinder |
| 2431 | provides two additional methods: it can return frame's ID, and it can |
| 2432 | fetch registers from the previous frame. A running @value{GDBN} |
| 2433 | mantains a list of the unwinders and calls each unwinder's sniffer in |
| 2434 | turn until it finds the one that recognizes the current frame. There |
| 2435 | is an API to register an unwinder. |
| 2436 | |
| 2437 | The unwinders that come with @value{GDBN} handle standard frames. |
| 2438 | However, mixed language applications (for example, an application |
| 2439 | running Java Virtual Machine) sometimes use frame layouts that cannot |
| 2440 | be handled by the @value{GDBN} unwinders. You can write Python code |
| 2441 | that can handle such custom frames. |
| 2442 | |
| 2443 | You implement a frame unwinder in Python as a class with which has two |
| 2444 | attributes, @code{name} and @code{enabled}, with obvious meanings, and |
| 2445 | a single method @code{__call__}, which examines a given frame and |
| 2446 | returns an object (an instance of @code{gdb.UnwindInfo class)} |
| 2447 | describing it. If an unwinder does not recognize a frame, it should |
| 2448 | return @code{None}. The code in @value{GDBN} that enables writing |
| 2449 | unwinders in Python uses this object to return frame's ID and previous |
| 2450 | frame registers when @value{GDBN} core asks for them. |
| 2451 | |
| 2452 | An unwinder should do as little work as possible. Some otherwise |
| 2453 | innocuous operations can cause problems (even crashes, as this code is |
| 2454 | not not well-hardened yet). For example, making an inferior call from |
| 2455 | an unwinder is unadvisable, as an inferior call will reset |
| 2456 | @value{GDBN}'s stack unwinding process, potentially causing re-entrant |
| 2457 | unwinding. |
| 2458 | |
| 2459 | @subheading Unwinder Input |
| 2460 | |
| 2461 | An object passed to an unwinder (a @code{gdb.PendingFrame} instance) |
| 2462 | provides a method to read frame's registers: |
| 2463 | |
| 2464 | @defun PendingFrame.read_register (reg) |
| 2465 | This method returns the contents of the register @var{reg} in the |
| 2466 | frame as a @code{gdb.Value} object. For a description of the |
| 2467 | acceptable values of @var{reg} see |
| 2468 | @ref{gdbpy_frame_read_register,,Frame.read_register}. If @var{reg} |
| 2469 | does not name a register for the current architecture, this method |
| 2470 | will throw an exception. |
| 2471 | |
| 2472 | Note that this method will always return a @code{gdb.Value} for a |
| 2473 | valid register name. This does not mean that the value will be valid. |
| 2474 | For example, you may request a register that an earlier unwinder could |
| 2475 | not unwind---the value will be unavailable. Instead, the |
| 2476 | @code{gdb.Value} returned from this method will be lazy; that is, its |
| 2477 | underlying bits will not be fetched until it is first used. So, |
| 2478 | attempting to use such a value will cause an exception at the point of |
| 2479 | use. |
| 2480 | |
| 2481 | The type of the returned @code{gdb.Value} depends on the register and |
| 2482 | the architecture. It is common for registers to have a scalar type, |
| 2483 | like @code{long long}; but many other types are possible, such as |
| 2484 | pointer, pointer-to-function, floating point or vector types. |
| 2485 | @end defun |
| 2486 | |
| 2487 | It also provides a factory method to create a @code{gdb.UnwindInfo} |
| 2488 | instance to be returned to @value{GDBN}: |
| 2489 | |
| 2490 | @defun PendingFrame.create_unwind_info (frame_id) |
| 2491 | Returns a new @code{gdb.UnwindInfo} instance identified by given |
| 2492 | @var{frame_id}. The argument is used to build @value{GDBN}'s frame ID |
| 2493 | using one of functions provided by @value{GDBN}. @var{frame_id}'s attributes |
| 2494 | determine which function will be used, as follows: |
| 2495 | |
| 2496 | @table @code |
| 2497 | @item sp, pc |
| 2498 | The frame is identified by the given stack address and PC. The stack |
| 2499 | address must be chosen so that it is constant throughout the lifetime |
| 2500 | of the frame, so a typical choice is the value of the stack pointer at |
| 2501 | the start of the function---in the DWARF standard, this would be the |
| 2502 | ``Call Frame Address''. |
| 2503 | |
| 2504 | This is the most common case by far. The other cases are documented |
| 2505 | for completeness but are only useful in specialized situations. |
| 2506 | |
| 2507 | @item sp, pc, special |
| 2508 | The frame is identified by the stack address, the PC, and a |
| 2509 | ``special'' address. The special address is used on architectures |
| 2510 | that can have frames that do not change the stack, but which are still |
| 2511 | distinct, for example the IA-64, which has a second stack for |
| 2512 | registers. Both @var{sp} and @var{special} must be constant |
| 2513 | throughout the lifetime of the frame. |
| 2514 | |
| 2515 | @item sp |
| 2516 | The frame is identified by the stack address only. Any other stack |
| 2517 | frame with a matching @var{sp} will be considered to match this frame. |
| 2518 | Inside gdb, this is called a ``wild frame''. You will never need |
| 2519 | this. |
| 2520 | @end table |
| 2521 | |
| 2522 | Each attribute value should be an instance of @code{gdb.Value}. |
| 2523 | |
| 2524 | @end defun |
| 2525 | |
| 2526 | @defun PendingFrame.architecture () |
| 2527 | Return the @code{gdb.Architecture} (@pxref{Architectures In Python}) |
| 2528 | for this @code{gdb.PendingFrame}. This represents the architecture of |
| 2529 | the particular frame being unwound. |
| 2530 | @end defun |
| 2531 | |
| 2532 | @subheading Unwinder Output: UnwindInfo |
| 2533 | |
| 2534 | Use @code{PendingFrame.create_unwind_info} method described above to |
| 2535 | create a @code{gdb.UnwindInfo} instance. Use the following method to |
| 2536 | specify caller registers that have been saved in this frame: |
| 2537 | |
| 2538 | @defun gdb.UnwindInfo.add_saved_register (reg, value) |
| 2539 | @var{reg} identifies the register, for a description of the acceptable |
| 2540 | values see @ref{gdbpy_frame_read_register,,Frame.read_register}. |
| 2541 | @var{value} is a register value (a @code{gdb.Value} object). |
| 2542 | @end defun |
| 2543 | |
| 2544 | @subheading Unwinder Skeleton Code |
| 2545 | |
| 2546 | @value{GDBN} comes with the module containing the base @code{Unwinder} |
| 2547 | class. Derive your unwinder class from it and structure the code as |
| 2548 | follows: |
| 2549 | |
| 2550 | @smallexample |
| 2551 | from gdb.unwinders import Unwinder |
| 2552 | |
| 2553 | class FrameId(object): |
| 2554 | def __init__(self, sp, pc): |
| 2555 | self.sp = sp |
| 2556 | self.pc = pc |
| 2557 | |
| 2558 | |
| 2559 | class MyUnwinder(Unwinder): |
| 2560 | def __init__(....): |
| 2561 | super(MyUnwinder, self).__init___(<expects unwinder name argument>) |
| 2562 | |
| 2563 | def __call__(pending_frame): |
| 2564 | if not <we recognize frame>: |
| 2565 | return None |
| 2566 | # Create UnwindInfo. Usually the frame is identified by the stack |
| 2567 | # pointer and the program counter. |
| 2568 | sp = pending_frame.read_register(<SP number>) |
| 2569 | pc = pending_frame.read_register(<PC number>) |
| 2570 | unwind_info = pending_frame.create_unwind_info(FrameId(sp, pc)) |
| 2571 | |
| 2572 | # Find the values of the registers in the caller's frame and |
| 2573 | # save them in the result: |
| 2574 | unwind_info.add_saved_register(<register>, <value>) |
| 2575 | .... |
| 2576 | |
| 2577 | # Return the result: |
| 2578 | return unwind_info |
| 2579 | |
| 2580 | @end smallexample |
| 2581 | |
| 2582 | @subheading Registering a Unwinder |
| 2583 | |
| 2584 | An object file, a program space, and the @value{GDBN} proper can have |
| 2585 | unwinders registered with it. |
| 2586 | |
| 2587 | The @code{gdb.unwinders} module provides the function to register a |
| 2588 | unwinder: |
| 2589 | |
| 2590 | @defun gdb.unwinder.register_unwinder (locus, unwinder, replace=False) |
| 2591 | @var{locus} is specifies an object file or a program space to which |
| 2592 | @var{unwinder} is added. Passing @code{None} or @code{gdb} adds |
| 2593 | @var{unwinder} to the @value{GDBN}'s global unwinder list. The newly |
| 2594 | added @var{unwinder} will be called before any other unwinder from the |
| 2595 | same locus. Two unwinders in the same locus cannot have the same |
| 2596 | name. An attempt to add a unwinder with already existing name raises |
| 2597 | an exception unless @var{replace} is @code{True}, in which case the |
| 2598 | old unwinder is deleted. |
| 2599 | @end defun |
| 2600 | |
| 2601 | @subheading Unwinder Precedence |
| 2602 | |
| 2603 | @value{GDBN} first calls the unwinders from all the object files in no |
| 2604 | particular order, then the unwinders from the current program space, |
| 2605 | and finally the unwinders from @value{GDBN}. |
| 2606 | |
| 2607 | @node Xmethods In Python |
| 2608 | @subsubsection Xmethods In Python |
| 2609 | @cindex xmethods in Python |
| 2610 | |
| 2611 | @dfn{Xmethods} are additional methods or replacements for existing |
| 2612 | methods of a C@t{++} class. This feature is useful for those cases |
| 2613 | where a method defined in C@t{++} source code could be inlined or |
| 2614 | optimized out by the compiler, making it unavailable to @value{GDBN}. |
| 2615 | For such cases, one can define an xmethod to serve as a replacement |
| 2616 | for the method defined in the C@t{++} source code. @value{GDBN} will |
| 2617 | then invoke the xmethod, instead of the C@t{++} method, to |
| 2618 | evaluate expressions. One can also use xmethods when debugging |
| 2619 | with core files. Moreover, when debugging live programs, invoking an |
| 2620 | xmethod need not involve running the inferior (which can potentially |
| 2621 | perturb its state). Hence, even if the C@t{++} method is available, it |
| 2622 | is better to use its replacement xmethod if one is defined. |
| 2623 | |
| 2624 | The xmethods feature in Python is available via the concepts of an |
| 2625 | @dfn{xmethod matcher} and an @dfn{xmethod worker}. To |
| 2626 | implement an xmethod, one has to implement a matcher and a |
| 2627 | corresponding worker for it (more than one worker can be |
| 2628 | implemented, each catering to a different overloaded instance of the |
| 2629 | method). Internally, @value{GDBN} invokes the @code{match} method of a |
| 2630 | matcher to match the class type and method name. On a match, the |
| 2631 | @code{match} method returns a list of matching @emph{worker} objects. |
| 2632 | Each worker object typically corresponds to an overloaded instance of |
| 2633 | the xmethod. They implement a @code{get_arg_types} method which |
| 2634 | returns a sequence of types corresponding to the arguments the xmethod |
| 2635 | requires. @value{GDBN} uses this sequence of types to perform |
| 2636 | overload resolution and picks a winning xmethod worker. A winner |
| 2637 | is also selected from among the methods @value{GDBN} finds in the |
| 2638 | C@t{++} source code. Next, the winning xmethod worker and the |
| 2639 | winning C@t{++} method are compared to select an overall winner. In |
| 2640 | case of a tie between a xmethod worker and a C@t{++} method, the |
| 2641 | xmethod worker is selected as the winner. That is, if a winning |
| 2642 | xmethod worker is found to be equivalent to the winning C@t{++} |
| 2643 | method, then the xmethod worker is treated as a replacement for |
| 2644 | the C@t{++} method. @value{GDBN} uses the overall winner to invoke the |
| 2645 | method. If the winning xmethod worker is the overall winner, then |
| 2646 | the corresponding xmethod is invoked via the @code{__call__} method |
| 2647 | of the worker object. |
| 2648 | |
| 2649 | If one wants to implement an xmethod as a replacement for an |
| 2650 | existing C@t{++} method, then they have to implement an equivalent |
| 2651 | xmethod which has exactly the same name and takes arguments of |
| 2652 | exactly the same type as the C@t{++} method. If the user wants to |
| 2653 | invoke the C@t{++} method even though a replacement xmethod is |
| 2654 | available for that method, then they can disable the xmethod. |
| 2655 | |
| 2656 | @xref{Xmethod API}, for API to implement xmethods in Python. |
| 2657 | @xref{Writing an Xmethod}, for implementing xmethods in Python. |
| 2658 | |
| 2659 | @node Xmethod API |
| 2660 | @subsubsection Xmethod API |
| 2661 | @cindex xmethod API |
| 2662 | |
| 2663 | The @value{GDBN} Python API provides classes, interfaces and functions |
| 2664 | to implement, register and manipulate xmethods. |
| 2665 | @xref{Xmethods In Python}. |
| 2666 | |
| 2667 | An xmethod matcher should be an instance of a class derived from |
| 2668 | @code{XMethodMatcher} defined in the module @code{gdb.xmethod}, or an |
| 2669 | object with similar interface and attributes. An instance of |
| 2670 | @code{XMethodMatcher} has the following attributes: |
| 2671 | |
| 2672 | @defvar name |
| 2673 | The name of the matcher. |
| 2674 | @end defvar |
| 2675 | |
| 2676 | @defvar enabled |
| 2677 | A boolean value indicating whether the matcher is enabled or disabled. |
| 2678 | @end defvar |
| 2679 | |
| 2680 | @defvar methods |
| 2681 | A list of named methods managed by the matcher. Each object in the list |
| 2682 | is an instance of the class @code{XMethod} defined in the module |
| 2683 | @code{gdb.xmethod}, or any object with the following attributes: |
| 2684 | |
| 2685 | @table @code |
| 2686 | |
| 2687 | @item name |
| 2688 | Name of the xmethod which should be unique for each xmethod |
| 2689 | managed by the matcher. |
| 2690 | |
| 2691 | @item enabled |
| 2692 | A boolean value indicating whether the xmethod is enabled or |
| 2693 | disabled. |
| 2694 | |
| 2695 | @end table |
| 2696 | |
| 2697 | The class @code{XMethod} is a convenience class with same |
| 2698 | attributes as above along with the following constructor: |
| 2699 | |
| 2700 | @defun XMethod.__init__ (self, name) |
| 2701 | Constructs an enabled xmethod with name @var{name}. |
| 2702 | @end defun |
| 2703 | @end defvar |
| 2704 | |
| 2705 | @noindent |
| 2706 | The @code{XMethodMatcher} class has the following methods: |
| 2707 | |
| 2708 | @defun XMethodMatcher.__init__ (self, name) |
| 2709 | Constructs an enabled xmethod matcher with name @var{name}. The |
| 2710 | @code{methods} attribute is initialized to @code{None}. |
| 2711 | @end defun |
| 2712 | |
| 2713 | @defun XMethodMatcher.match (self, class_type, method_name) |
| 2714 | Derived classes should override this method. It should return a |
| 2715 | xmethod worker object (or a sequence of xmethod worker |
| 2716 | objects) matching the @var{class_type} and @var{method_name}. |
| 2717 | @var{class_type} is a @code{gdb.Type} object, and @var{method_name} |
| 2718 | is a string value. If the matcher manages named methods as listed in |
| 2719 | its @code{methods} attribute, then only those worker objects whose |
| 2720 | corresponding entries in the @code{methods} list are enabled should be |
| 2721 | returned. |
| 2722 | @end defun |
| 2723 | |
| 2724 | An xmethod worker should be an instance of a class derived from |
| 2725 | @code{XMethodWorker} defined in the module @code{gdb.xmethod}, |
| 2726 | or support the following interface: |
| 2727 | |
| 2728 | @defun XMethodWorker.get_arg_types (self) |
| 2729 | This method returns a sequence of @code{gdb.Type} objects corresponding |
| 2730 | to the arguments that the xmethod takes. It can return an empty |
| 2731 | sequence or @code{None} if the xmethod does not take any arguments. |
| 2732 | If the xmethod takes a single argument, then a single |
| 2733 | @code{gdb.Type} object corresponding to it can be returned. |
| 2734 | @end defun |
| 2735 | |
| 2736 | @defun XMethodWorker.get_result_type (self, *args) |
| 2737 | This method returns a @code{gdb.Type} object representing the type |
| 2738 | of the result of invoking this xmethod. |
| 2739 | The @var{args} argument is the same tuple of arguments that would be |
| 2740 | passed to the @code{__call__} method of this worker. |
| 2741 | @end defun |
| 2742 | |
| 2743 | @defun XMethodWorker.__call__ (self, *args) |
| 2744 | This is the method which does the @emph{work} of the xmethod. The |
| 2745 | @var{args} arguments is the tuple of arguments to the xmethod. Each |
| 2746 | element in this tuple is a gdb.Value object. The first element is |
| 2747 | always the @code{this} pointer value. |
| 2748 | @end defun |
| 2749 | |
| 2750 | For @value{GDBN} to lookup xmethods, the xmethod matchers |
| 2751 | should be registered using the following function defined in the module |
| 2752 | @code{gdb.xmethod}: |
| 2753 | |
| 2754 | @defun register_xmethod_matcher (locus, matcher, replace=False) |
| 2755 | The @code{matcher} is registered with @code{locus}, replacing an |
| 2756 | existing matcher with the same name as @code{matcher} if |
| 2757 | @code{replace} is @code{True}. @code{locus} can be a |
| 2758 | @code{gdb.Objfile} object (@pxref{Objfiles In Python}), or a |
| 2759 | @code{gdb.Progspace} object (@pxref{Progspaces In Python}), or |
| 2760 | @code{None}. If it is @code{None}, then @code{matcher} is registered |
| 2761 | globally. |
| 2762 | @end defun |
| 2763 | |
| 2764 | @node Writing an Xmethod |
| 2765 | @subsubsection Writing an Xmethod |
| 2766 | @cindex writing xmethods in Python |
| 2767 | |
| 2768 | Implementing xmethods in Python will require implementing xmethod |
| 2769 | matchers and xmethod workers (@pxref{Xmethods In Python}). Consider |
| 2770 | the following C@t{++} class: |
| 2771 | |
| 2772 | @smallexample |
| 2773 | class MyClass |
| 2774 | @{ |
| 2775 | public: |
| 2776 | MyClass (int a) : a_(a) @{ @} |
| 2777 | |
| 2778 | int geta (void) @{ return a_; @} |
| 2779 | int operator+ (int b); |
| 2780 | |
| 2781 | private: |
| 2782 | int a_; |
| 2783 | @}; |
| 2784 | |
| 2785 | int |
| 2786 | MyClass::operator+ (int b) |
| 2787 | @{ |
| 2788 | return a_ + b; |
| 2789 | @} |
| 2790 | @end smallexample |
| 2791 | |
| 2792 | @noindent |
| 2793 | Let us define two xmethods for the class @code{MyClass}, one |
| 2794 | replacing the method @code{geta}, and another adding an overloaded |
| 2795 | flavor of @code{operator+} which takes a @code{MyClass} argument (the |
| 2796 | C@t{++} code above already has an overloaded @code{operator+} |
| 2797 | which takes an @code{int} argument). The xmethod matcher can be |
| 2798 | defined as follows: |
| 2799 | |
| 2800 | @smallexample |
| 2801 | class MyClass_geta(gdb.xmethod.XMethod): |
| 2802 | def __init__(self): |
| 2803 | gdb.xmethod.XMethod.__init__(self, 'geta') |
| 2804 | |
| 2805 | def get_worker(self, method_name): |
| 2806 | if method_name == 'geta': |
| 2807 | return MyClassWorker_geta() |
| 2808 | |
| 2809 | |
| 2810 | class MyClass_sum(gdb.xmethod.XMethod): |
| 2811 | def __init__(self): |
| 2812 | gdb.xmethod.XMethod.__init__(self, 'sum') |
| 2813 | |
| 2814 | def get_worker(self, method_name): |
| 2815 | if method_name == 'operator+': |
| 2816 | return MyClassWorker_plus() |
| 2817 | |
| 2818 | |
| 2819 | class MyClassMatcher(gdb.xmethod.XMethodMatcher): |
| 2820 | def __init__(self): |
| 2821 | gdb.xmethod.XMethodMatcher.__init__(self, 'MyClassMatcher') |
| 2822 | # List of methods 'managed' by this matcher |
| 2823 | self.methods = [MyClass_geta(), MyClass_sum()] |
| 2824 | |
| 2825 | def match(self, class_type, method_name): |
| 2826 | if class_type.tag != 'MyClass': |
| 2827 | return None |
| 2828 | workers = [] |
| 2829 | for method in self.methods: |
| 2830 | if method.enabled: |
| 2831 | worker = method.get_worker(method_name) |
| 2832 | if worker: |
| 2833 | workers.append(worker) |
| 2834 | |
| 2835 | return workers |
| 2836 | @end smallexample |
| 2837 | |
| 2838 | @noindent |
| 2839 | Notice that the @code{match} method of @code{MyClassMatcher} returns |
| 2840 | a worker object of type @code{MyClassWorker_geta} for the @code{geta} |
| 2841 | method, and a worker object of type @code{MyClassWorker_plus} for the |
| 2842 | @code{operator+} method. This is done indirectly via helper classes |
| 2843 | derived from @code{gdb.xmethod.XMethod}. One does not need to use the |
| 2844 | @code{methods} attribute in a matcher as it is optional. However, if a |
| 2845 | matcher manages more than one xmethod, it is a good practice to list the |
| 2846 | xmethods in the @code{methods} attribute of the matcher. This will then |
| 2847 | facilitate enabling and disabling individual xmethods via the |
| 2848 | @code{enable/disable} commands. Notice also that a worker object is |
| 2849 | returned only if the corresponding entry in the @code{methods} attribute |
| 2850 | of the matcher is enabled. |
| 2851 | |
| 2852 | The implementation of the worker classes returned by the matcher setup |
| 2853 | above is as follows: |
| 2854 | |
| 2855 | @smallexample |
| 2856 | class MyClassWorker_geta(gdb.xmethod.XMethodWorker): |
| 2857 | def get_arg_types(self): |
| 2858 | return None |
| 2859 | |
| 2860 | def get_result_type(self, obj): |
| 2861 | return gdb.lookup_type('int') |
| 2862 | |
| 2863 | def __call__(self, obj): |
| 2864 | return obj['a_'] |
| 2865 | |
| 2866 | |
| 2867 | class MyClassWorker_plus(gdb.xmethod.XMethodWorker): |
| 2868 | def get_arg_types(self): |
| 2869 | return gdb.lookup_type('MyClass') |
| 2870 | |
| 2871 | def get_result_type(self, obj): |
| 2872 | return gdb.lookup_type('int') |
| 2873 | |
| 2874 | def __call__(self, obj, other): |
| 2875 | return obj['a_'] + other['a_'] |
| 2876 | @end smallexample |
| 2877 | |
| 2878 | For @value{GDBN} to actually lookup a xmethod, it has to be |
| 2879 | registered with it. The matcher defined above is registered with |
| 2880 | @value{GDBN} globally as follows: |
| 2881 | |
| 2882 | @smallexample |
| 2883 | gdb.xmethod.register_xmethod_matcher(None, MyClassMatcher()) |
| 2884 | @end smallexample |
| 2885 | |
| 2886 | If an object @code{obj} of type @code{MyClass} is initialized in C@t{++} |
| 2887 | code as follows: |
| 2888 | |
| 2889 | @smallexample |
| 2890 | MyClass obj(5); |
| 2891 | @end smallexample |
| 2892 | |
| 2893 | @noindent |
| 2894 | then, after loading the Python script defining the xmethod matchers |
| 2895 | and workers into @code{GDBN}, invoking the method @code{geta} or using |
| 2896 | the operator @code{+} on @code{obj} will invoke the xmethods |
| 2897 | defined above: |
| 2898 | |
| 2899 | @smallexample |
| 2900 | (gdb) p obj.geta() |
| 2901 | $1 = 5 |
| 2902 | |
| 2903 | (gdb) p obj + obj |
| 2904 | $2 = 10 |
| 2905 | @end smallexample |
| 2906 | |
| 2907 | Consider another example with a C++ template class: |
| 2908 | |
| 2909 | @smallexample |
| 2910 | template <class T> |
| 2911 | class MyTemplate |
| 2912 | @{ |
| 2913 | public: |
| 2914 | MyTemplate () : dsize_(10), data_ (new T [10]) @{ @} |
| 2915 | ~MyTemplate () @{ delete [] data_; @} |
| 2916 | |
| 2917 | int footprint (void) |
| 2918 | @{ |
| 2919 | return sizeof (T) * dsize_ + sizeof (MyTemplate<T>); |
| 2920 | @} |
| 2921 | |
| 2922 | private: |
| 2923 | int dsize_; |
| 2924 | T *data_; |
| 2925 | @}; |
| 2926 | @end smallexample |
| 2927 | |
| 2928 | Let us implement an xmethod for the above class which serves as a |
| 2929 | replacement for the @code{footprint} method. The full code listing |
| 2930 | of the xmethod workers and xmethod matchers is as follows: |
| 2931 | |
| 2932 | @smallexample |
| 2933 | class MyTemplateWorker_footprint(gdb.xmethod.XMethodWorker): |
| 2934 | def __init__(self, class_type): |
| 2935 | self.class_type = class_type |
| 2936 | |
| 2937 | def get_arg_types(self): |
| 2938 | return None |
| 2939 | |
| 2940 | def get_result_type(self): |
| 2941 | return gdb.lookup_type('int') |
| 2942 | |
| 2943 | def __call__(self, obj): |
| 2944 | return (self.class_type.sizeof + |
| 2945 | obj['dsize_'] * |
| 2946 | self.class_type.template_argument(0).sizeof) |
| 2947 | |
| 2948 | |
| 2949 | class MyTemplateMatcher_footprint(gdb.xmethod.XMethodMatcher): |
| 2950 | def __init__(self): |
| 2951 | gdb.xmethod.XMethodMatcher.__init__(self, 'MyTemplateMatcher') |
| 2952 | |
| 2953 | def match(self, class_type, method_name): |
| 2954 | if (re.match('MyTemplate<[ \t\n]*[_a-zA-Z][ _a-zA-Z0-9]*>', |
| 2955 | class_type.tag) and |
| 2956 | method_name == 'footprint'): |
| 2957 | return MyTemplateWorker_footprint(class_type) |
| 2958 | @end smallexample |
| 2959 | |
| 2960 | Notice that, in this example, we have not used the @code{methods} |
| 2961 | attribute of the matcher as the matcher manages only one xmethod. The |
| 2962 | user can enable/disable this xmethod by enabling/disabling the matcher |
| 2963 | itself. |
| 2964 | |
| 2965 | @node Inferiors In Python |
| 2966 | @subsubsection Inferiors In Python |
| 2967 | @cindex inferiors in Python |
| 2968 | |
| 2969 | @findex gdb.Inferior |
| 2970 | Programs which are being run under @value{GDBN} are called inferiors |
| 2971 | (@pxref{Inferiors Connections and Programs}). Python scripts can access |
| 2972 | information about and manipulate inferiors controlled by @value{GDBN} |
| 2973 | via objects of the @code{gdb.Inferior} class. |
| 2974 | |
| 2975 | The following inferior-related functions are available in the @code{gdb} |
| 2976 | module: |
| 2977 | |
| 2978 | @defun gdb.inferiors () |
| 2979 | Return a tuple containing all inferior objects. |
| 2980 | @end defun |
| 2981 | |
| 2982 | @defun gdb.selected_inferior () |
| 2983 | Return an object representing the current inferior. |
| 2984 | @end defun |
| 2985 | |
| 2986 | A @code{gdb.Inferior} object has the following attributes: |
| 2987 | |
| 2988 | @defvar Inferior.num |
| 2989 | ID of inferior, as assigned by GDB. |
| 2990 | @end defvar |
| 2991 | |
| 2992 | @defvar Inferior.pid |
| 2993 | Process ID of the inferior, as assigned by the underlying operating |
| 2994 | system. |
| 2995 | @end defvar |
| 2996 | |
| 2997 | @defvar Inferior.was_attached |
| 2998 | Boolean signaling whether the inferior was created using `attach', or |
| 2999 | started by @value{GDBN} itself. |
| 3000 | @end defvar |
| 3001 | |
| 3002 | @defvar Inferior.progspace |
| 3003 | The inferior's program space. @xref{Progspaces In Python}. |
| 3004 | @end defvar |
| 3005 | |
| 3006 | A @code{gdb.Inferior} object has the following methods: |
| 3007 | |
| 3008 | @defun Inferior.is_valid () |
| 3009 | Returns @code{True} if the @code{gdb.Inferior} object is valid, |
| 3010 | @code{False} if not. A @code{gdb.Inferior} object will become invalid |
| 3011 | if the inferior no longer exists within @value{GDBN}. All other |
| 3012 | @code{gdb.Inferior} methods will throw an exception if it is invalid |
| 3013 | at the time the method is called. |
| 3014 | @end defun |
| 3015 | |
| 3016 | @defun Inferior.threads () |
| 3017 | This method returns a tuple holding all the threads which are valid |
| 3018 | when it is called. If there are no valid threads, the method will |
| 3019 | return an empty tuple. |
| 3020 | @end defun |
| 3021 | |
| 3022 | @defun Inferior.architecture () |
| 3023 | Return the @code{gdb.Architecture} (@pxref{Architectures In Python}) |
| 3024 | for this inferior. This represents the architecture of the inferior |
| 3025 | as a whole. Some platforms can have multiple architectures in a |
| 3026 | single address space, so this may not match the architecture of a |
| 3027 | particular frame (@pxref{Frames In Python}). |
| 3028 | @end defun |
| 3029 | |
| 3030 | @findex Inferior.read_memory |
| 3031 | @defun Inferior.read_memory (address, length) |
| 3032 | Read @var{length} addressable memory units from the inferior, starting at |
| 3033 | @var{address}. Returns a buffer object, which behaves much like an array |
| 3034 | or a string. It can be modified and given to the |
| 3035 | @code{Inferior.write_memory} function. In Python 3, the return |
| 3036 | value is a @code{memoryview} object. |
| 3037 | @end defun |
| 3038 | |
| 3039 | @findex Inferior.write_memory |
| 3040 | @defun Inferior.write_memory (address, buffer @r{[}, length@r{]}) |
| 3041 | Write the contents of @var{buffer} to the inferior, starting at |
| 3042 | @var{address}. The @var{buffer} parameter must be a Python object |
| 3043 | which supports the buffer protocol, i.e., a string, an array or the |
| 3044 | object returned from @code{Inferior.read_memory}. If given, @var{length} |
| 3045 | determines the number of addressable memory units from @var{buffer} to be |
| 3046 | written. |
| 3047 | @end defun |
| 3048 | |
| 3049 | @findex gdb.search_memory |
| 3050 | @defun Inferior.search_memory (address, length, pattern) |
| 3051 | Search a region of the inferior memory starting at @var{address} with |
| 3052 | the given @var{length} using the search pattern supplied in |
| 3053 | @var{pattern}. The @var{pattern} parameter must be a Python object |
| 3054 | which supports the buffer protocol, i.e., a string, an array or the |
| 3055 | object returned from @code{gdb.read_memory}. Returns a Python @code{Long} |
| 3056 | containing the address where the pattern was found, or @code{None} if |
| 3057 | the pattern could not be found. |
| 3058 | @end defun |
| 3059 | |
| 3060 | @findex Inferior.thread_from_handle |
| 3061 | @findex Inferior.thread_from_thread_handle |
| 3062 | @defun Inferior.thread_from_handle (handle) |
| 3063 | Return the thread object corresponding to @var{handle}, a thread |
| 3064 | library specific data structure such as @code{pthread_t} for pthreads |
| 3065 | library implementations. |
| 3066 | |
| 3067 | The function @code{Inferior.thread_from_thread_handle} provides |
| 3068 | the same functionality, but use of @code{Inferior.thread_from_thread_handle} |
| 3069 | is deprecated. |
| 3070 | @end defun |
| 3071 | |
| 3072 | @node Events In Python |
| 3073 | @subsubsection Events In Python |
| 3074 | @cindex inferior events in Python |
| 3075 | |
| 3076 | @value{GDBN} provides a general event facility so that Python code can be |
| 3077 | notified of various state changes, particularly changes that occur in |
| 3078 | the inferior. |
| 3079 | |
| 3080 | An @dfn{event} is just an object that describes some state change. The |
| 3081 | type of the object and its attributes will vary depending on the details |
| 3082 | of the change. All the existing events are described below. |
| 3083 | |
| 3084 | In order to be notified of an event, you must register an event handler |
| 3085 | with an @dfn{event registry}. An event registry is an object in the |
| 3086 | @code{gdb.events} module which dispatches particular events. A registry |
| 3087 | provides methods to register and unregister event handlers: |
| 3088 | |
| 3089 | @defun EventRegistry.connect (object) |
| 3090 | Add the given callable @var{object} to the registry. This object will be |
| 3091 | called when an event corresponding to this registry occurs. |
| 3092 | @end defun |
| 3093 | |
| 3094 | @defun EventRegistry.disconnect (object) |
| 3095 | Remove the given @var{object} from the registry. Once removed, the object |
| 3096 | will no longer receive notifications of events. |
| 3097 | @end defun |
| 3098 | |
| 3099 | Here is an example: |
| 3100 | |
| 3101 | @smallexample |
| 3102 | def exit_handler (event): |
| 3103 | print ("event type: exit") |
| 3104 | print ("exit code: %d" % (event.exit_code)) |
| 3105 | |
| 3106 | gdb.events.exited.connect (exit_handler) |
| 3107 | @end smallexample |
| 3108 | |
| 3109 | In the above example we connect our handler @code{exit_handler} to the |
| 3110 | registry @code{events.exited}. Once connected, @code{exit_handler} gets |
| 3111 | called when the inferior exits. The argument @dfn{event} in this example is |
| 3112 | of type @code{gdb.ExitedEvent}. As you can see in the example the |
| 3113 | @code{ExitedEvent} object has an attribute which indicates the exit code of |
| 3114 | the inferior. |
| 3115 | |
| 3116 | The following is a listing of the event registries that are available and |
| 3117 | details of the events they emit: |
| 3118 | |
| 3119 | @table @code |
| 3120 | |
| 3121 | @item events.cont |
| 3122 | Emits @code{gdb.ThreadEvent}. |
| 3123 | |
| 3124 | Some events can be thread specific when @value{GDBN} is running in non-stop |
| 3125 | mode. When represented in Python, these events all extend |
| 3126 | @code{gdb.ThreadEvent}. Note, this event is not emitted directly; instead, |
| 3127 | events which are emitted by this or other modules might extend this event. |
| 3128 | Examples of these events are @code{gdb.BreakpointEvent} and |
| 3129 | @code{gdb.ContinueEvent}. |
| 3130 | |
| 3131 | @defvar ThreadEvent.inferior_thread |
| 3132 | In non-stop mode this attribute will be set to the specific thread which was |
| 3133 | involved in the emitted event. Otherwise, it will be set to @code{None}. |
| 3134 | @end defvar |
| 3135 | |
| 3136 | Emits @code{gdb.ContinueEvent} which extends @code{gdb.ThreadEvent}. |
| 3137 | |
| 3138 | This event indicates that the inferior has been continued after a stop. For |
| 3139 | inherited attribute refer to @code{gdb.ThreadEvent} above. |
| 3140 | |
| 3141 | @item events.exited |
| 3142 | Emits @code{events.ExitedEvent} which indicates that the inferior has exited. |
| 3143 | @code{events.ExitedEvent} has two attributes: |
| 3144 | @defvar ExitedEvent.exit_code |
| 3145 | An integer representing the exit code, if available, which the inferior |
| 3146 | has returned. (The exit code could be unavailable if, for example, |
| 3147 | @value{GDBN} detaches from the inferior.) If the exit code is unavailable, |
| 3148 | the attribute does not exist. |
| 3149 | @end defvar |
| 3150 | @defvar ExitedEvent.inferior |
| 3151 | A reference to the inferior which triggered the @code{exited} event. |
| 3152 | @end defvar |
| 3153 | |
| 3154 | @item events.stop |
| 3155 | Emits @code{gdb.StopEvent} which extends @code{gdb.ThreadEvent}. |
| 3156 | |
| 3157 | Indicates that the inferior has stopped. All events emitted by this registry |
| 3158 | extend StopEvent. As a child of @code{gdb.ThreadEvent}, @code{gdb.StopEvent} |
| 3159 | will indicate the stopped thread when @value{GDBN} is running in non-stop |
| 3160 | mode. Refer to @code{gdb.ThreadEvent} above for more details. |
| 3161 | |
| 3162 | Emits @code{gdb.SignalEvent} which extends @code{gdb.StopEvent}. |
| 3163 | |
| 3164 | This event indicates that the inferior or one of its threads has received as |
| 3165 | signal. @code{gdb.SignalEvent} has the following attributes: |
| 3166 | |
| 3167 | @defvar SignalEvent.stop_signal |
| 3168 | A string representing the signal received by the inferior. A list of possible |
| 3169 | signal values can be obtained by running the command @code{info signals} in |
| 3170 | the @value{GDBN} command prompt. |
| 3171 | @end defvar |
| 3172 | |
| 3173 | Also emits @code{gdb.BreakpointEvent} which extends @code{gdb.StopEvent}. |
| 3174 | |
| 3175 | @code{gdb.BreakpointEvent} event indicates that one or more breakpoints have |
| 3176 | been hit, and has the following attributes: |
| 3177 | |
| 3178 | @defvar BreakpointEvent.breakpoints |
| 3179 | A sequence containing references to all the breakpoints (type |
| 3180 | @code{gdb.Breakpoint}) that were hit. |
| 3181 | @xref{Breakpoints In Python}, for details of the @code{gdb.Breakpoint} object. |
| 3182 | @end defvar |
| 3183 | @defvar BreakpointEvent.breakpoint |
| 3184 | A reference to the first breakpoint that was hit. |
| 3185 | This function is maintained for backward compatibility and is now deprecated |
| 3186 | in favor of the @code{gdb.BreakpointEvent.breakpoints} attribute. |
| 3187 | @end defvar |
| 3188 | |
| 3189 | @item events.new_objfile |
| 3190 | Emits @code{gdb.NewObjFileEvent} which indicates that a new object file has |
| 3191 | been loaded by @value{GDBN}. @code{gdb.NewObjFileEvent} has one attribute: |
| 3192 | |
| 3193 | @defvar NewObjFileEvent.new_objfile |
| 3194 | A reference to the object file (@code{gdb.Objfile}) which has been loaded. |
| 3195 | @xref{Objfiles In Python}, for details of the @code{gdb.Objfile} object. |
| 3196 | @end defvar |
| 3197 | |
| 3198 | @item events.clear_objfiles |
| 3199 | Emits @code{gdb.ClearObjFilesEvent} which indicates that the list of object |
| 3200 | files for a program space has been reset. |
| 3201 | @code{gdb.ClearObjFilesEvent} has one attribute: |
| 3202 | |
| 3203 | @defvar ClearObjFilesEvent.progspace |
| 3204 | A reference to the program space (@code{gdb.Progspace}) whose objfile list has |
| 3205 | been cleared. @xref{Progspaces In Python}. |
| 3206 | @end defvar |
| 3207 | |
| 3208 | @item events.inferior_call |
| 3209 | Emits events just before and after a function in the inferior is |
| 3210 | called by @value{GDBN}. Before an inferior call, this emits an event |
| 3211 | of type @code{gdb.InferiorCallPreEvent}, and after an inferior call, |
| 3212 | this emits an event of type @code{gdb.InferiorCallPostEvent}. |
| 3213 | |
| 3214 | @table @code |
| 3215 | @tindex gdb.InferiorCallPreEvent |
| 3216 | @item @code{gdb.InferiorCallPreEvent} |
| 3217 | Indicates that a function in the inferior is about to be called. |
| 3218 | |
| 3219 | @defvar InferiorCallPreEvent.ptid |
| 3220 | The thread in which the call will be run. |
| 3221 | @end defvar |
| 3222 | |
| 3223 | @defvar InferiorCallPreEvent.address |
| 3224 | The location of the function to be called. |
| 3225 | @end defvar |
| 3226 | |
| 3227 | @tindex gdb.InferiorCallPostEvent |
| 3228 | @item @code{gdb.InferiorCallPostEvent} |
| 3229 | Indicates that a function in the inferior has just been called. |
| 3230 | |
| 3231 | @defvar InferiorCallPostEvent.ptid |
| 3232 | The thread in which the call was run. |
| 3233 | @end defvar |
| 3234 | |
| 3235 | @defvar InferiorCallPostEvent.address |
| 3236 | The location of the function that was called. |
| 3237 | @end defvar |
| 3238 | @end table |
| 3239 | |
| 3240 | @item events.memory_changed |
| 3241 | Emits @code{gdb.MemoryChangedEvent} which indicates that the memory of the |
| 3242 | inferior has been modified by the @value{GDBN} user, for instance via a |
| 3243 | command like @w{@code{set *addr = value}}. The event has the following |
| 3244 | attributes: |
| 3245 | |
| 3246 | @defvar MemoryChangedEvent.address |
| 3247 | The start address of the changed region. |
| 3248 | @end defvar |
| 3249 | |
| 3250 | @defvar MemoryChangedEvent.length |
| 3251 | Length in bytes of the changed region. |
| 3252 | @end defvar |
| 3253 | |
| 3254 | @item events.register_changed |
| 3255 | Emits @code{gdb.RegisterChangedEvent} which indicates that a register in the |
| 3256 | inferior has been modified by the @value{GDBN} user. |
| 3257 | |
| 3258 | @defvar RegisterChangedEvent.frame |
| 3259 | A gdb.Frame object representing the frame in which the register was modified. |
| 3260 | @end defvar |
| 3261 | @defvar RegisterChangedEvent.regnum |
| 3262 | Denotes which register was modified. |
| 3263 | @end defvar |
| 3264 | |
| 3265 | @item events.breakpoint_created |
| 3266 | This is emitted when a new breakpoint has been created. The argument |
| 3267 | that is passed is the new @code{gdb.Breakpoint} object. |
| 3268 | |
| 3269 | @item events.breakpoint_modified |
| 3270 | This is emitted when a breakpoint has been modified in some way. The |
| 3271 | argument that is passed is the new @code{gdb.Breakpoint} object. |
| 3272 | |
| 3273 | @item events.breakpoint_deleted |
| 3274 | This is emitted when a breakpoint has been deleted. The argument that |
| 3275 | is passed is the @code{gdb.Breakpoint} object. When this event is |
| 3276 | emitted, the @code{gdb.Breakpoint} object will already be in its |
| 3277 | invalid state; that is, the @code{is_valid} method will return |
| 3278 | @code{False}. |
| 3279 | |
| 3280 | @item events.before_prompt |
| 3281 | This event carries no payload. It is emitted each time @value{GDBN} |
| 3282 | presents a prompt to the user. |
| 3283 | |
| 3284 | @item events.new_inferior |
| 3285 | This is emitted when a new inferior is created. Note that the |
| 3286 | inferior is not necessarily running; in fact, it may not even have an |
| 3287 | associated executable. |
| 3288 | |
| 3289 | The event is of type @code{gdb.NewInferiorEvent}. This has a single |
| 3290 | attribute: |
| 3291 | |
| 3292 | @defvar NewInferiorEvent.inferior |
| 3293 | The new inferior, a @code{gdb.Inferior} object. |
| 3294 | @end defvar |
| 3295 | |
| 3296 | @item events.inferior_deleted |
| 3297 | This is emitted when an inferior has been deleted. Note that this is |
| 3298 | not the same as process exit; it is notified when the inferior itself |
| 3299 | is removed, say via @code{remove-inferiors}. |
| 3300 | |
| 3301 | The event is of type @code{gdb.InferiorDeletedEvent}. This has a single |
| 3302 | attribute: |
| 3303 | |
| 3304 | @defvar NewInferiorEvent.inferior |
| 3305 | The inferior that is being removed, a @code{gdb.Inferior} object. |
| 3306 | @end defvar |
| 3307 | |
| 3308 | @item events.new_thread |
| 3309 | This is emitted when @value{GDBN} notices a new thread. The event is of |
| 3310 | type @code{gdb.NewThreadEvent}, which extends @code{gdb.ThreadEvent}. |
| 3311 | This has a single attribute: |
| 3312 | |
| 3313 | @defvar NewThreadEvent.inferior_thread |
| 3314 | The new thread. |
| 3315 | @end defvar |
| 3316 | |
| 3317 | @end table |
| 3318 | |
| 3319 | @node Threads In Python |
| 3320 | @subsubsection Threads In Python |
| 3321 | @cindex threads in python |
| 3322 | |
| 3323 | @findex gdb.InferiorThread |
| 3324 | Python scripts can access information about, and manipulate inferior threads |
| 3325 | controlled by @value{GDBN}, via objects of the @code{gdb.InferiorThread} class. |
| 3326 | |
| 3327 | The following thread-related functions are available in the @code{gdb} |
| 3328 | module: |
| 3329 | |
| 3330 | @findex gdb.selected_thread |
| 3331 | @defun gdb.selected_thread () |
| 3332 | This function returns the thread object for the selected thread. If there |
| 3333 | is no selected thread, this will return @code{None}. |
| 3334 | @end defun |
| 3335 | |
| 3336 | To get the list of threads for an inferior, use the @code{Inferior.threads()} |
| 3337 | method. @xref{Inferiors In Python}. |
| 3338 | |
| 3339 | A @code{gdb.InferiorThread} object has the following attributes: |
| 3340 | |
| 3341 | @defvar InferiorThread.name |
| 3342 | The name of the thread. If the user specified a name using |
| 3343 | @code{thread name}, then this returns that name. Otherwise, if an |
| 3344 | OS-supplied name is available, then it is returned. Otherwise, this |
| 3345 | returns @code{None}. |
| 3346 | |
| 3347 | This attribute can be assigned to. The new value must be a string |
| 3348 | object, which sets the new name, or @code{None}, which removes any |
| 3349 | user-specified thread name. |
| 3350 | @end defvar |
| 3351 | |
| 3352 | @defvar InferiorThread.num |
| 3353 | The per-inferior number of the thread, as assigned by GDB. |
| 3354 | @end defvar |
| 3355 | |
| 3356 | @defvar InferiorThread.global_num |
| 3357 | The global ID of the thread, as assigned by GDB. You can use this to |
| 3358 | make Python breakpoints thread-specific, for example |
| 3359 | (@pxref{python_breakpoint_thread,,The Breakpoint.thread attribute}). |
| 3360 | @end defvar |
| 3361 | |
| 3362 | @defvar InferiorThread.ptid |
| 3363 | ID of the thread, as assigned by the operating system. This attribute is a |
| 3364 | tuple containing three integers. The first is the Process ID (PID); the second |
| 3365 | is the Lightweight Process ID (LWPID), and the third is the Thread ID (TID). |
| 3366 | Either the LWPID or TID may be 0, which indicates that the operating system |
| 3367 | does not use that identifier. |
| 3368 | @end defvar |
| 3369 | |
| 3370 | @defvar InferiorThread.inferior |
| 3371 | The inferior this thread belongs to. This attribute is represented as |
| 3372 | a @code{gdb.Inferior} object. This attribute is not writable. |
| 3373 | @end defvar |
| 3374 | |
| 3375 | A @code{gdb.InferiorThread} object has the following methods: |
| 3376 | |
| 3377 | @defun InferiorThread.is_valid () |
| 3378 | Returns @code{True} if the @code{gdb.InferiorThread} object is valid, |
| 3379 | @code{False} if not. A @code{gdb.InferiorThread} object will become |
| 3380 | invalid if the thread exits, or the inferior that the thread belongs |
| 3381 | is deleted. All other @code{gdb.InferiorThread} methods will throw an |
| 3382 | exception if it is invalid at the time the method is called. |
| 3383 | @end defun |
| 3384 | |
| 3385 | @defun InferiorThread.switch () |
| 3386 | This changes @value{GDBN}'s currently selected thread to the one represented |
| 3387 | by this object. |
| 3388 | @end defun |
| 3389 | |
| 3390 | @defun InferiorThread.is_stopped () |
| 3391 | Return a Boolean indicating whether the thread is stopped. |
| 3392 | @end defun |
| 3393 | |
| 3394 | @defun InferiorThread.is_running () |
| 3395 | Return a Boolean indicating whether the thread is running. |
| 3396 | @end defun |
| 3397 | |
| 3398 | @defun InferiorThread.is_exited () |
| 3399 | Return a Boolean indicating whether the thread is exited. |
| 3400 | @end defun |
| 3401 | |
| 3402 | @defun InferiorThread.handle () |
| 3403 | Return the thread object's handle, represented as a Python @code{bytes} |
| 3404 | object. A @code{gdb.Value} representation of the handle may be |
| 3405 | constructed via @code{gdb.Value(bufobj, type)} where @var{bufobj} is |
| 3406 | the Python @code{bytes} representation of the handle and @var{type} is |
| 3407 | a @code{gdb.Type} for the handle type. |
| 3408 | @end defun |
| 3409 | |
| 3410 | @node Recordings In Python |
| 3411 | @subsubsection Recordings In Python |
| 3412 | @cindex recordings in python |
| 3413 | |
| 3414 | The following recordings-related functions |
| 3415 | (@pxref{Process Record and Replay}) are available in the @code{gdb} |
| 3416 | module: |
| 3417 | |
| 3418 | @defun gdb.start_recording (@r{[}method@r{]}, @r{[}format@r{]}) |
| 3419 | Start a recording using the given @var{method} and @var{format}. If |
| 3420 | no @var{format} is given, the default format for the recording method |
| 3421 | is used. If no @var{method} is given, the default method will be used. |
| 3422 | Returns a @code{gdb.Record} object on success. Throw an exception on |
| 3423 | failure. |
| 3424 | |
| 3425 | The following strings can be passed as @var{method}: |
| 3426 | |
| 3427 | @itemize @bullet |
| 3428 | @item |
| 3429 | @code{"full"} |
| 3430 | @item |
| 3431 | @code{"btrace"}: Possible values for @var{format}: @code{"pt"}, |
| 3432 | @code{"bts"} or leave out for default format. |
| 3433 | @end itemize |
| 3434 | @end defun |
| 3435 | |
| 3436 | @defun gdb.current_recording () |
| 3437 | Access a currently running recording. Return a @code{gdb.Record} |
| 3438 | object on success. Return @code{None} if no recording is currently |
| 3439 | active. |
| 3440 | @end defun |
| 3441 | |
| 3442 | @defun gdb.stop_recording () |
| 3443 | Stop the current recording. Throw an exception if no recording is |
| 3444 | currently active. All record objects become invalid after this call. |
| 3445 | @end defun |
| 3446 | |
| 3447 | A @code{gdb.Record} object has the following attributes: |
| 3448 | |
| 3449 | @defvar Record.method |
| 3450 | A string with the current recording method, e.g.@: @code{full} or |
| 3451 | @code{btrace}. |
| 3452 | @end defvar |
| 3453 | |
| 3454 | @defvar Record.format |
| 3455 | A string with the current recording format, e.g.@: @code{bt}, @code{pts} or |
| 3456 | @code{None}. |
| 3457 | @end defvar |
| 3458 | |
| 3459 | @defvar Record.begin |
| 3460 | A method specific instruction object representing the first instruction |
| 3461 | in this recording. |
| 3462 | @end defvar |
| 3463 | |
| 3464 | @defvar Record.end |
| 3465 | A method specific instruction object representing the current |
| 3466 | instruction, that is not actually part of the recording. |
| 3467 | @end defvar |
| 3468 | |
| 3469 | @defvar Record.replay_position |
| 3470 | The instruction representing the current replay position. If there is |
| 3471 | no replay active, this will be @code{None}. |
| 3472 | @end defvar |
| 3473 | |
| 3474 | @defvar Record.instruction_history |
| 3475 | A list with all recorded instructions. |
| 3476 | @end defvar |
| 3477 | |
| 3478 | @defvar Record.function_call_history |
| 3479 | A list with all recorded function call segments. |
| 3480 | @end defvar |
| 3481 | |
| 3482 | A @code{gdb.Record} object has the following methods: |
| 3483 | |
| 3484 | @defun Record.goto (instruction) |
| 3485 | Move the replay position to the given @var{instruction}. |
| 3486 | @end defun |
| 3487 | |
| 3488 | The common @code{gdb.Instruction} class that recording method specific |
| 3489 | instruction objects inherit from, has the following attributes: |
| 3490 | |
| 3491 | @defvar Instruction.pc |
| 3492 | An integer representing this instruction's address. |
| 3493 | @end defvar |
| 3494 | |
| 3495 | @defvar Instruction.data |
| 3496 | A buffer with the raw instruction data. In Python 3, the return value is a |
| 3497 | @code{memoryview} object. |
| 3498 | @end defvar |
| 3499 | |
| 3500 | @defvar Instruction.decoded |
| 3501 | A human readable string with the disassembled instruction. |
| 3502 | @end defvar |
| 3503 | |
| 3504 | @defvar Instruction.size |
| 3505 | The size of the instruction in bytes. |
| 3506 | @end defvar |
| 3507 | |
| 3508 | Additionally @code{gdb.RecordInstruction} has the following attributes: |
| 3509 | |
| 3510 | @defvar RecordInstruction.number |
| 3511 | An integer identifying this instruction. @code{number} corresponds to |
| 3512 | the numbers seen in @code{record instruction-history} |
| 3513 | (@pxref{Process Record and Replay}). |
| 3514 | @end defvar |
| 3515 | |
| 3516 | @defvar RecordInstruction.sal |
| 3517 | A @code{gdb.Symtab_and_line} object representing the associated symtab |
| 3518 | and line of this instruction. May be @code{None} if no debug information is |
| 3519 | available. |
| 3520 | @end defvar |
| 3521 | |
| 3522 | @defvar RecordInstruction.is_speculative |
| 3523 | A boolean indicating whether the instruction was executed speculatively. |
| 3524 | @end defvar |
| 3525 | |
| 3526 | If an error occured during recording or decoding a recording, this error is |
| 3527 | represented by a @code{gdb.RecordGap} object in the instruction list. It has |
| 3528 | the following attributes: |
| 3529 | |
| 3530 | @defvar RecordGap.number |
| 3531 | An integer identifying this gap. @code{number} corresponds to the numbers seen |
| 3532 | in @code{record instruction-history} (@pxref{Process Record and Replay}). |
| 3533 | @end defvar |
| 3534 | |
| 3535 | @defvar RecordGap.error_code |
| 3536 | A numerical representation of the reason for the gap. The value is specific to |
| 3537 | the current recording method. |
| 3538 | @end defvar |
| 3539 | |
| 3540 | @defvar RecordGap.error_string |
| 3541 | A human readable string with the reason for the gap. |
| 3542 | @end defvar |
| 3543 | |
| 3544 | A @code{gdb.RecordFunctionSegment} object has the following attributes: |
| 3545 | |
| 3546 | @defvar RecordFunctionSegment.number |
| 3547 | An integer identifying this function segment. @code{number} corresponds to |
| 3548 | the numbers seen in @code{record function-call-history} |
| 3549 | (@pxref{Process Record and Replay}). |
| 3550 | @end defvar |
| 3551 | |
| 3552 | @defvar RecordFunctionSegment.symbol |
| 3553 | A @code{gdb.Symbol} object representing the associated symbol. May be |
| 3554 | @code{None} if no debug information is available. |
| 3555 | @end defvar |
| 3556 | |
| 3557 | @defvar RecordFunctionSegment.level |
| 3558 | An integer representing the function call's stack level. May be |
| 3559 | @code{None} if the function call is a gap. |
| 3560 | @end defvar |
| 3561 | |
| 3562 | @defvar RecordFunctionSegment.instructions |
| 3563 | A list of @code{gdb.RecordInstruction} or @code{gdb.RecordGap} objects |
| 3564 | associated with this function call. |
| 3565 | @end defvar |
| 3566 | |
| 3567 | @defvar RecordFunctionSegment.up |
| 3568 | A @code{gdb.RecordFunctionSegment} object representing the caller's |
| 3569 | function segment. If the call has not been recorded, this will be the |
| 3570 | function segment to which control returns. If neither the call nor the |
| 3571 | return have been recorded, this will be @code{None}. |
| 3572 | @end defvar |
| 3573 | |
| 3574 | @defvar RecordFunctionSegment.prev |
| 3575 | A @code{gdb.RecordFunctionSegment} object representing the previous |
| 3576 | segment of this function call. May be @code{None}. |
| 3577 | @end defvar |
| 3578 | |
| 3579 | @defvar RecordFunctionSegment.next |
| 3580 | A @code{gdb.RecordFunctionSegment} object representing the next segment of |
| 3581 | this function call. May be @code{None}. |
| 3582 | @end defvar |
| 3583 | |
| 3584 | The following example demonstrates the usage of these objects and |
| 3585 | functions to create a function that will rewind a record to the last |
| 3586 | time a function in a different file was executed. This would typically |
| 3587 | be used to track the execution of user provided callback functions in a |
| 3588 | library which typically are not visible in a back trace. |
| 3589 | |
| 3590 | @smallexample |
| 3591 | def bringback (): |
| 3592 | rec = gdb.current_recording () |
| 3593 | if not rec: |
| 3594 | return |
| 3595 | |
| 3596 | insn = rec.instruction_history |
| 3597 | if len (insn) == 0: |
| 3598 | return |
| 3599 | |
| 3600 | try: |
| 3601 | position = insn.index (rec.replay_position) |
| 3602 | except: |
| 3603 | position = -1 |
| 3604 | try: |
| 3605 | filename = insn[position].sal.symtab.fullname () |
| 3606 | except: |
| 3607 | filename = None |
| 3608 | |
| 3609 | for i in reversed (insn[:position]): |
| 3610 | try: |
| 3611 | current = i.sal.symtab.fullname () |
| 3612 | except: |
| 3613 | current = None |
| 3614 | |
| 3615 | if filename == current: |
| 3616 | continue |
| 3617 | |
| 3618 | rec.goto (i) |
| 3619 | return |
| 3620 | @end smallexample |
| 3621 | |
| 3622 | Another possible application is to write a function that counts the |
| 3623 | number of code executions in a given line range. This line range can |
| 3624 | contain parts of functions or span across several functions and is not |
| 3625 | limited to be contiguous. |
| 3626 | |
| 3627 | @smallexample |
| 3628 | def countrange (filename, linerange): |
| 3629 | count = 0 |
| 3630 | |
| 3631 | def filter_only (file_name): |
| 3632 | for call in gdb.current_recording ().function_call_history: |
| 3633 | try: |
| 3634 | if file_name in call.symbol.symtab.fullname (): |
| 3635 | yield call |
| 3636 | except: |
| 3637 | pass |
| 3638 | |
| 3639 | for c in filter_only (filename): |
| 3640 | for i in c.instructions: |
| 3641 | try: |
| 3642 | if i.sal.line in linerange: |
| 3643 | count += 1 |
| 3644 | break; |
| 3645 | except: |
| 3646 | pass |
| 3647 | |
| 3648 | return count |
| 3649 | @end smallexample |
| 3650 | |
| 3651 | @node Commands In Python |
| 3652 | @subsubsection Commands In Python |
| 3653 | |
| 3654 | @cindex commands in python |
| 3655 | @cindex python commands |
| 3656 | You can implement new @value{GDBN} CLI commands in Python. A CLI |
| 3657 | command is implemented using an instance of the @code{gdb.Command} |
| 3658 | class, most commonly using a subclass. |
| 3659 | |
| 3660 | @defun Command.__init__ (name, @var{command_class} @r{[}, @var{completer_class} @r{[}, @var{prefix}@r{]]}) |
| 3661 | The object initializer for @code{Command} registers the new command |
| 3662 | with @value{GDBN}. This initializer is normally invoked from the |
| 3663 | subclass' own @code{__init__} method. |
| 3664 | |
| 3665 | @var{name} is the name of the command. If @var{name} consists of |
| 3666 | multiple words, then the initial words are looked for as prefix |
| 3667 | commands. In this case, if one of the prefix commands does not exist, |
| 3668 | an exception is raised. |
| 3669 | |
| 3670 | There is no support for multi-line commands. |
| 3671 | |
| 3672 | @var{command_class} should be one of the @samp{COMMAND_} constants |
| 3673 | defined below. This argument tells @value{GDBN} how to categorize the |
| 3674 | new command in the help system. |
| 3675 | |
| 3676 | @var{completer_class} is an optional argument. If given, it should be |
| 3677 | one of the @samp{COMPLETE_} constants defined below. This argument |
| 3678 | tells @value{GDBN} how to perform completion for this command. If not |
| 3679 | given, @value{GDBN} will attempt to complete using the object's |
| 3680 | @code{complete} method (see below); if no such method is found, an |
| 3681 | error will occur when completion is attempted. |
| 3682 | |
| 3683 | @var{prefix} is an optional argument. If @code{True}, then the new |
| 3684 | command is a prefix command; sub-commands of this command may be |
| 3685 | registered. |
| 3686 | |
| 3687 | The help text for the new command is taken from the Python |
| 3688 | documentation string for the command's class, if there is one. If no |
| 3689 | documentation string is provided, the default value ``This command is |
| 3690 | not documented.'' is used. |
| 3691 | @end defun |
| 3692 | |
| 3693 | @cindex don't repeat Python command |
| 3694 | @defun Command.dont_repeat () |
| 3695 | By default, a @value{GDBN} command is repeated when the user enters a |
| 3696 | blank line at the command prompt. A command can suppress this |
| 3697 | behavior by invoking the @code{dont_repeat} method. This is similar |
| 3698 | to the user command @code{dont-repeat}, see @ref{Define, dont-repeat}. |
| 3699 | @end defun |
| 3700 | |
| 3701 | @defun Command.invoke (argument, from_tty) |
| 3702 | This method is called by @value{GDBN} when this command is invoked. |
| 3703 | |
| 3704 | @var{argument} is a string. It is the argument to the command, after |
| 3705 | leading and trailing whitespace has been stripped. |
| 3706 | |
| 3707 | @var{from_tty} is a boolean argument. When true, this means that the |
| 3708 | command was entered by the user at the terminal; when false it means |
| 3709 | that the command came from elsewhere. |
| 3710 | |
| 3711 | If this method throws an exception, it is turned into a @value{GDBN} |
| 3712 | @code{error} call. Otherwise, the return value is ignored. |
| 3713 | |
| 3714 | @findex gdb.string_to_argv |
| 3715 | To break @var{argument} up into an argv-like string use |
| 3716 | @code{gdb.string_to_argv}. This function behaves identically to |
| 3717 | @value{GDBN}'s internal argument lexer @code{buildargv}. |
| 3718 | It is recommended to use this for consistency. |
| 3719 | Arguments are separated by spaces and may be quoted. |
| 3720 | Example: |
| 3721 | |
| 3722 | @smallexample |
| 3723 | print gdb.string_to_argv ("1 2\ \\\"3 '4 \"5' \"6 '7\"") |
| 3724 | ['1', '2 "3', '4 "5', "6 '7"] |
| 3725 | @end smallexample |
| 3726 | |
| 3727 | @end defun |
| 3728 | |
| 3729 | @cindex completion of Python commands |
| 3730 | @defun Command.complete (text, word) |
| 3731 | This method is called by @value{GDBN} when the user attempts |
| 3732 | completion on this command. All forms of completion are handled by |
| 3733 | this method, that is, the @key{TAB} and @key{M-?} key bindings |
| 3734 | (@pxref{Completion}), and the @code{complete} command (@pxref{Help, |
| 3735 | complete}). |
| 3736 | |
| 3737 | The arguments @var{text} and @var{word} are both strings; @var{text} |
| 3738 | holds the complete command line up to the cursor's location, while |
| 3739 | @var{word} holds the last word of the command line; this is computed |
| 3740 | using a word-breaking heuristic. |
| 3741 | |
| 3742 | The @code{complete} method can return several values: |
| 3743 | @itemize @bullet |
| 3744 | @item |
| 3745 | If the return value is a sequence, the contents of the sequence are |
| 3746 | used as the completions. It is up to @code{complete} to ensure that the |
| 3747 | contents actually do complete the word. A zero-length sequence is |
| 3748 | allowed, it means that there were no completions available. Only |
| 3749 | string elements of the sequence are used; other elements in the |
| 3750 | sequence are ignored. |
| 3751 | |
| 3752 | @item |
| 3753 | If the return value is one of the @samp{COMPLETE_} constants defined |
| 3754 | below, then the corresponding @value{GDBN}-internal completion |
| 3755 | function is invoked, and its result is used. |
| 3756 | |
| 3757 | @item |
| 3758 | All other results are treated as though there were no available |
| 3759 | completions. |
| 3760 | @end itemize |
| 3761 | @end defun |
| 3762 | |
| 3763 | When a new command is registered, it must be declared as a member of |
| 3764 | some general class of commands. This is used to classify top-level |
| 3765 | commands in the on-line help system; note that prefix commands are not |
| 3766 | listed under their own category but rather that of their top-level |
| 3767 | command. The available classifications are represented by constants |
| 3768 | defined in the @code{gdb} module: |
| 3769 | |
| 3770 | @table @code |
| 3771 | @findex COMMAND_NONE |
| 3772 | @findex gdb.COMMAND_NONE |
| 3773 | @item gdb.COMMAND_NONE |
| 3774 | The command does not belong to any particular class. A command in |
| 3775 | this category will not be displayed in any of the help categories. |
| 3776 | |
| 3777 | @findex COMMAND_RUNNING |
| 3778 | @findex gdb.COMMAND_RUNNING |
| 3779 | @item gdb.COMMAND_RUNNING |
| 3780 | The command is related to running the inferior. For example, |
| 3781 | @code{start}, @code{step}, and @code{continue} are in this category. |
| 3782 | Type @kbd{help running} at the @value{GDBN} prompt to see a list of |
| 3783 | commands in this category. |
| 3784 | |
| 3785 | @findex COMMAND_DATA |
| 3786 | @findex gdb.COMMAND_DATA |
| 3787 | @item gdb.COMMAND_DATA |
| 3788 | The command is related to data or variables. For example, |
| 3789 | @code{call}, @code{find}, and @code{print} are in this category. Type |
| 3790 | @kbd{help data} at the @value{GDBN} prompt to see a list of commands |
| 3791 | in this category. |
| 3792 | |
| 3793 | @findex COMMAND_STACK |
| 3794 | @findex gdb.COMMAND_STACK |
| 3795 | @item gdb.COMMAND_STACK |
| 3796 | The command has to do with manipulation of the stack. For example, |
| 3797 | @code{backtrace}, @code{frame}, and @code{return} are in this |
| 3798 | category. Type @kbd{help stack} at the @value{GDBN} prompt to see a |
| 3799 | list of commands in this category. |
| 3800 | |
| 3801 | @findex COMMAND_FILES |
| 3802 | @findex gdb.COMMAND_FILES |
| 3803 | @item gdb.COMMAND_FILES |
| 3804 | This class is used for file-related commands. For example, |
| 3805 | @code{file}, @code{list} and @code{section} are in this category. |
| 3806 | Type @kbd{help files} at the @value{GDBN} prompt to see a list of |
| 3807 | commands in this category. |
| 3808 | |
| 3809 | @findex COMMAND_SUPPORT |
| 3810 | @findex gdb.COMMAND_SUPPORT |
| 3811 | @item gdb.COMMAND_SUPPORT |
| 3812 | This should be used for ``support facilities'', generally meaning |
| 3813 | things that are useful to the user when interacting with @value{GDBN}, |
| 3814 | but not related to the state of the inferior. For example, |
| 3815 | @code{help}, @code{make}, and @code{shell} are in this category. Type |
| 3816 | @kbd{help support} at the @value{GDBN} prompt to see a list of |
| 3817 | commands in this category. |
| 3818 | |
| 3819 | @findex COMMAND_STATUS |
| 3820 | @findex gdb.COMMAND_STATUS |
| 3821 | @item gdb.COMMAND_STATUS |
| 3822 | The command is an @samp{info}-related command, that is, related to the |
| 3823 | state of @value{GDBN} itself. For example, @code{info}, @code{macro}, |
| 3824 | and @code{show} are in this category. Type @kbd{help status} at the |
| 3825 | @value{GDBN} prompt to see a list of commands in this category. |
| 3826 | |
| 3827 | @findex COMMAND_BREAKPOINTS |
| 3828 | @findex gdb.COMMAND_BREAKPOINTS |
| 3829 | @item gdb.COMMAND_BREAKPOINTS |
| 3830 | The command has to do with breakpoints. For example, @code{break}, |
| 3831 | @code{clear}, and @code{delete} are in this category. Type @kbd{help |
| 3832 | breakpoints} at the @value{GDBN} prompt to see a list of commands in |
| 3833 | this category. |
| 3834 | |
| 3835 | @findex COMMAND_TRACEPOINTS |
| 3836 | @findex gdb.COMMAND_TRACEPOINTS |
| 3837 | @item gdb.COMMAND_TRACEPOINTS |
| 3838 | The command has to do with tracepoints. For example, @code{trace}, |
| 3839 | @code{actions}, and @code{tfind} are in this category. Type |
| 3840 | @kbd{help tracepoints} at the @value{GDBN} prompt to see a list of |
| 3841 | commands in this category. |
| 3842 | |
| 3843 | @findex COMMAND_TUI |
| 3844 | @findex gdb.COMMAND_TUI |
| 3845 | @item gdb.COMMAND_TUI |
| 3846 | The command has to do with the text user interface (@pxref{TUI}). |
| 3847 | Type @kbd{help tui} at the @value{GDBN} prompt to see a list of |
| 3848 | commands in this category. |
| 3849 | |
| 3850 | @findex COMMAND_USER |
| 3851 | @findex gdb.COMMAND_USER |
| 3852 | @item gdb.COMMAND_USER |
| 3853 | The command is a general purpose command for the user, and typically |
| 3854 | does not fit in one of the other categories. |
| 3855 | Type @kbd{help user-defined} at the @value{GDBN} prompt to see |
| 3856 | a list of commands in this category, as well as the list of gdb macros |
| 3857 | (@pxref{Sequences}). |
| 3858 | |
| 3859 | @findex COMMAND_OBSCURE |
| 3860 | @findex gdb.COMMAND_OBSCURE |
| 3861 | @item gdb.COMMAND_OBSCURE |
| 3862 | The command is only used in unusual circumstances, or is not of |
| 3863 | general interest to users. For example, @code{checkpoint}, |
| 3864 | @code{fork}, and @code{stop} are in this category. Type @kbd{help |
| 3865 | obscure} at the @value{GDBN} prompt to see a list of commands in this |
| 3866 | category. |
| 3867 | |
| 3868 | @findex COMMAND_MAINTENANCE |
| 3869 | @findex gdb.COMMAND_MAINTENANCE |
| 3870 | @item gdb.COMMAND_MAINTENANCE |
| 3871 | The command is only useful to @value{GDBN} maintainers. The |
| 3872 | @code{maintenance} and @code{flushregs} commands are in this category. |
| 3873 | Type @kbd{help internals} at the @value{GDBN} prompt to see a list of |
| 3874 | commands in this category. |
| 3875 | @end table |
| 3876 | |
| 3877 | A new command can use a predefined completion function, either by |
| 3878 | specifying it via an argument at initialization, or by returning it |
| 3879 | from the @code{complete} method. These predefined completion |
| 3880 | constants are all defined in the @code{gdb} module: |
| 3881 | |
| 3882 | @vtable @code |
| 3883 | @vindex COMPLETE_NONE |
| 3884 | @item gdb.COMPLETE_NONE |
| 3885 | This constant means that no completion should be done. |
| 3886 | |
| 3887 | @vindex COMPLETE_FILENAME |
| 3888 | @item gdb.COMPLETE_FILENAME |
| 3889 | This constant means that filename completion should be performed. |
| 3890 | |
| 3891 | @vindex COMPLETE_LOCATION |
| 3892 | @item gdb.COMPLETE_LOCATION |
| 3893 | This constant means that location completion should be done. |
| 3894 | @xref{Specify Location}. |
| 3895 | |
| 3896 | @vindex COMPLETE_COMMAND |
| 3897 | @item gdb.COMPLETE_COMMAND |
| 3898 | This constant means that completion should examine @value{GDBN} |
| 3899 | command names. |
| 3900 | |
| 3901 | @vindex COMPLETE_SYMBOL |
| 3902 | @item gdb.COMPLETE_SYMBOL |
| 3903 | This constant means that completion should be done using symbol names |
| 3904 | as the source. |
| 3905 | |
| 3906 | @vindex COMPLETE_EXPRESSION |
| 3907 | @item gdb.COMPLETE_EXPRESSION |
| 3908 | This constant means that completion should be done on expressions. |
| 3909 | Often this means completing on symbol names, but some language |
| 3910 | parsers also have support for completing on field names. |
| 3911 | @end vtable |
| 3912 | |
| 3913 | The following code snippet shows how a trivial CLI command can be |
| 3914 | implemented in Python: |
| 3915 | |
| 3916 | @smallexample |
| 3917 | class HelloWorld (gdb.Command): |
| 3918 | """Greet the whole world.""" |
| 3919 | |
| 3920 | def __init__ (self): |
| 3921 | super (HelloWorld, self).__init__ ("hello-world", gdb.COMMAND_USER) |
| 3922 | |
| 3923 | def invoke (self, arg, from_tty): |
| 3924 | print ("Hello, World!") |
| 3925 | |
| 3926 | HelloWorld () |
| 3927 | @end smallexample |
| 3928 | |
| 3929 | The last line instantiates the class, and is necessary to trigger the |
| 3930 | registration of the command with @value{GDBN}. Depending on how the |
| 3931 | Python code is read into @value{GDBN}, you may need to import the |
| 3932 | @code{gdb} module explicitly. |
| 3933 | |
| 3934 | @node Parameters In Python |
| 3935 | @subsubsection Parameters In Python |
| 3936 | |
| 3937 | @cindex parameters in python |
| 3938 | @cindex python parameters |
| 3939 | @tindex gdb.Parameter |
| 3940 | @tindex Parameter |
| 3941 | You can implement new @value{GDBN} parameters using Python. A new |
| 3942 | parameter is implemented as an instance of the @code{gdb.Parameter} |
| 3943 | class. |
| 3944 | |
| 3945 | Parameters are exposed to the user via the @code{set} and |
| 3946 | @code{show} commands. @xref{Help}. |
| 3947 | |
| 3948 | There are many parameters that already exist and can be set in |
| 3949 | @value{GDBN}. Two examples are: @code{set follow fork} and |
| 3950 | @code{set charset}. Setting these parameters influences certain |
| 3951 | behavior in @value{GDBN}. Similarly, you can define parameters that |
| 3952 | can be used to influence behavior in custom Python scripts and commands. |
| 3953 | |
| 3954 | @defun Parameter.__init__ (name, @var{command-class}, @var{parameter-class} @r{[}, @var{enum-sequence}@r{]}) |
| 3955 | The object initializer for @code{Parameter} registers the new |
| 3956 | parameter with @value{GDBN}. This initializer is normally invoked |
| 3957 | from the subclass' own @code{__init__} method. |
| 3958 | |
| 3959 | @var{name} is the name of the new parameter. If @var{name} consists |
| 3960 | of multiple words, then the initial words are looked for as prefix |
| 3961 | parameters. An example of this can be illustrated with the |
| 3962 | @code{set print} set of parameters. If @var{name} is |
| 3963 | @code{print foo}, then @code{print} will be searched as the prefix |
| 3964 | parameter. In this case the parameter can subsequently be accessed in |
| 3965 | @value{GDBN} as @code{set print foo}. |
| 3966 | |
| 3967 | If @var{name} consists of multiple words, and no prefix parameter group |
| 3968 | can be found, an exception is raised. |
| 3969 | |
| 3970 | @var{command-class} should be one of the @samp{COMMAND_} constants |
| 3971 | (@pxref{Commands In Python}). This argument tells @value{GDBN} how to |
| 3972 | categorize the new parameter in the help system. |
| 3973 | |
| 3974 | @var{parameter-class} should be one of the @samp{PARAM_} constants |
| 3975 | defined below. This argument tells @value{GDBN} the type of the new |
| 3976 | parameter; this information is used for input validation and |
| 3977 | completion. |
| 3978 | |
| 3979 | If @var{parameter-class} is @code{PARAM_ENUM}, then |
| 3980 | @var{enum-sequence} must be a sequence of strings. These strings |
| 3981 | represent the possible values for the parameter. |
| 3982 | |
| 3983 | If @var{parameter-class} is not @code{PARAM_ENUM}, then the presence |
| 3984 | of a fourth argument will cause an exception to be thrown. |
| 3985 | |
| 3986 | The help text for the new parameter is taken from the Python |
| 3987 | documentation string for the parameter's class, if there is one. If |
| 3988 | there is no documentation string, a default value is used. |
| 3989 | @end defun |
| 3990 | |
| 3991 | @defvar Parameter.set_doc |
| 3992 | If this attribute exists, and is a string, then its value is used as |
| 3993 | the help text for this parameter's @code{set} command. The value is |
| 3994 | examined when @code{Parameter.__init__} is invoked; subsequent changes |
| 3995 | have no effect. |
| 3996 | @end defvar |
| 3997 | |
| 3998 | @defvar Parameter.show_doc |
| 3999 | If this attribute exists, and is a string, then its value is used as |
| 4000 | the help text for this parameter's @code{show} command. The value is |
| 4001 | examined when @code{Parameter.__init__} is invoked; subsequent changes |
| 4002 | have no effect. |
| 4003 | @end defvar |
| 4004 | |
| 4005 | @defvar Parameter.value |
| 4006 | The @code{value} attribute holds the underlying value of the |
| 4007 | parameter. It can be read and assigned to just as any other |
| 4008 | attribute. @value{GDBN} does validation when assignments are made. |
| 4009 | @end defvar |
| 4010 | |
| 4011 | There are two methods that may be implemented in any @code{Parameter} |
| 4012 | class. These are: |
| 4013 | |
| 4014 | @defun Parameter.get_set_string (self) |
| 4015 | If this method exists, @value{GDBN} will call it when a |
| 4016 | @var{parameter}'s value has been changed via the @code{set} API (for |
| 4017 | example, @kbd{set foo off}). The @code{value} attribute has already |
| 4018 | been populated with the new value and may be used in output. This |
| 4019 | method must return a string. If the returned string is not empty, |
| 4020 | @value{GDBN} will present it to the user. |
| 4021 | |
| 4022 | If this method raises the @code{gdb.GdbError} exception |
| 4023 | (@pxref{Exception Handling}), then @value{GDBN} will print the |
| 4024 | exception's string and the @code{set} command will fail. Note, |
| 4025 | however, that the @code{value} attribute will not be reset in this |
| 4026 | case. So, if your parameter must validate values, it should store the |
| 4027 | old value internally and reset the exposed value, like so: |
| 4028 | |
| 4029 | @smallexample |
| 4030 | class ExampleParam (gdb.Parameter): |
| 4031 | def __init__ (self, name): |
| 4032 | super (ExampleParam, self).__init__ (name, |
| 4033 | gdb.COMMAND_DATA, |
| 4034 | gdb.PARAM_BOOLEAN) |
| 4035 | self.value = True |
| 4036 | self.saved_value = True |
| 4037 | def validate(self): |
| 4038 | return False |
| 4039 | def get_set_string (self): |
| 4040 | if not self.validate(): |
| 4041 | self.value = self.saved_value |
| 4042 | raise gdb.GdbError('Failed to validate') |
| 4043 | self.saved_value = self.value |
| 4044 | @end smallexample |
| 4045 | @end defun |
| 4046 | |
| 4047 | @defun Parameter.get_show_string (self, svalue) |
| 4048 | @value{GDBN} will call this method when a @var{parameter}'s |
| 4049 | @code{show} API has been invoked (for example, @kbd{show foo}). The |
| 4050 | argument @code{svalue} receives the string representation of the |
| 4051 | current value. This method must return a string. |
| 4052 | @end defun |
| 4053 | |
| 4054 | When a new parameter is defined, its type must be specified. The |
| 4055 | available types are represented by constants defined in the @code{gdb} |
| 4056 | module: |
| 4057 | |
| 4058 | @table @code |
| 4059 | @findex PARAM_BOOLEAN |
| 4060 | @findex gdb.PARAM_BOOLEAN |
| 4061 | @item gdb.PARAM_BOOLEAN |
| 4062 | The value is a plain boolean. The Python boolean values, @code{True} |
| 4063 | and @code{False} are the only valid values. |
| 4064 | |
| 4065 | @findex PARAM_AUTO_BOOLEAN |
| 4066 | @findex gdb.PARAM_AUTO_BOOLEAN |
| 4067 | @item gdb.PARAM_AUTO_BOOLEAN |
| 4068 | The value has three possible states: true, false, and @samp{auto}. In |
| 4069 | Python, true and false are represented using boolean constants, and |
| 4070 | @samp{auto} is represented using @code{None}. |
| 4071 | |
| 4072 | @findex PARAM_UINTEGER |
| 4073 | @findex gdb.PARAM_UINTEGER |
| 4074 | @item gdb.PARAM_UINTEGER |
| 4075 | The value is an unsigned integer. The value of 0 should be |
| 4076 | interpreted to mean ``unlimited''. |
| 4077 | |
| 4078 | @findex PARAM_INTEGER |
| 4079 | @findex gdb.PARAM_INTEGER |
| 4080 | @item gdb.PARAM_INTEGER |
| 4081 | The value is a signed integer. The value of 0 should be interpreted |
| 4082 | to mean ``unlimited''. |
| 4083 | |
| 4084 | @findex PARAM_STRING |
| 4085 | @findex gdb.PARAM_STRING |
| 4086 | @item gdb.PARAM_STRING |
| 4087 | The value is a string. When the user modifies the string, any escape |
| 4088 | sequences, such as @samp{\t}, @samp{\f}, and octal escapes, are |
| 4089 | translated into corresponding characters and encoded into the current |
| 4090 | host charset. |
| 4091 | |
| 4092 | @findex PARAM_STRING_NOESCAPE |
| 4093 | @findex gdb.PARAM_STRING_NOESCAPE |
| 4094 | @item gdb.PARAM_STRING_NOESCAPE |
| 4095 | The value is a string. When the user modifies the string, escapes are |
| 4096 | passed through untranslated. |
| 4097 | |
| 4098 | @findex PARAM_OPTIONAL_FILENAME |
| 4099 | @findex gdb.PARAM_OPTIONAL_FILENAME |
| 4100 | @item gdb.PARAM_OPTIONAL_FILENAME |
| 4101 | The value is a either a filename (a string), or @code{None}. |
| 4102 | |
| 4103 | @findex PARAM_FILENAME |
| 4104 | @findex gdb.PARAM_FILENAME |
| 4105 | @item gdb.PARAM_FILENAME |
| 4106 | The value is a filename. This is just like |
| 4107 | @code{PARAM_STRING_NOESCAPE}, but uses file names for completion. |
| 4108 | |
| 4109 | @findex PARAM_ZINTEGER |
| 4110 | @findex gdb.PARAM_ZINTEGER |
| 4111 | @item gdb.PARAM_ZINTEGER |
| 4112 | The value is an integer. This is like @code{PARAM_INTEGER}, except 0 |
| 4113 | is interpreted as itself. |
| 4114 | |
| 4115 | @findex PARAM_ZUINTEGER |
| 4116 | @findex gdb.PARAM_ZUINTEGER |
| 4117 | @item gdb.PARAM_ZUINTEGER |
| 4118 | The value is an unsigned integer. This is like @code{PARAM_INTEGER}, |
| 4119 | except 0 is interpreted as itself, and the value cannot be negative. |
| 4120 | |
| 4121 | @findex PARAM_ZUINTEGER_UNLIMITED |
| 4122 | @findex gdb.PARAM_ZUINTEGER_UNLIMITED |
| 4123 | @item gdb.PARAM_ZUINTEGER_UNLIMITED |
| 4124 | The value is a signed integer. This is like @code{PARAM_ZUINTEGER}, |
| 4125 | except the special value -1 should be interpreted to mean |
| 4126 | ``unlimited''. Other negative values are not allowed. |
| 4127 | |
| 4128 | @findex PARAM_ENUM |
| 4129 | @findex gdb.PARAM_ENUM |
| 4130 | @item gdb.PARAM_ENUM |
| 4131 | The value is a string, which must be one of a collection string |
| 4132 | constants provided when the parameter is created. |
| 4133 | @end table |
| 4134 | |
| 4135 | @node Functions In Python |
| 4136 | @subsubsection Writing new convenience functions |
| 4137 | |
| 4138 | @cindex writing convenience functions |
| 4139 | @cindex convenience functions in python |
| 4140 | @cindex python convenience functions |
| 4141 | @tindex gdb.Function |
| 4142 | @tindex Function |
| 4143 | You can implement new convenience functions (@pxref{Convenience Vars}) |
| 4144 | in Python. A convenience function is an instance of a subclass of the |
| 4145 | class @code{gdb.Function}. |
| 4146 | |
| 4147 | @defun Function.__init__ (name) |
| 4148 | The initializer for @code{Function} registers the new function with |
| 4149 | @value{GDBN}. The argument @var{name} is the name of the function, |
| 4150 | a string. The function will be visible to the user as a convenience |
| 4151 | variable of type @code{internal function}, whose name is the same as |
| 4152 | the given @var{name}. |
| 4153 | |
| 4154 | The documentation for the new function is taken from the documentation |
| 4155 | string for the new class. |
| 4156 | @end defun |
| 4157 | |
| 4158 | @defun Function.invoke (@var{*args}) |
| 4159 | When a convenience function is evaluated, its arguments are converted |
| 4160 | to instances of @code{gdb.Value}, and then the function's |
| 4161 | @code{invoke} method is called. Note that @value{GDBN} does not |
| 4162 | predetermine the arity of convenience functions. Instead, all |
| 4163 | available arguments are passed to @code{invoke}, following the |
| 4164 | standard Python calling convention. In particular, a convenience |
| 4165 | function can have default values for parameters without ill effect. |
| 4166 | |
| 4167 | The return value of this method is used as its value in the enclosing |
| 4168 | expression. If an ordinary Python value is returned, it is converted |
| 4169 | to a @code{gdb.Value} following the usual rules. |
| 4170 | @end defun |
| 4171 | |
| 4172 | The following code snippet shows how a trivial convenience function can |
| 4173 | be implemented in Python: |
| 4174 | |
| 4175 | @smallexample |
| 4176 | class Greet (gdb.Function): |
| 4177 | """Return string to greet someone. |
| 4178 | Takes a name as argument.""" |
| 4179 | |
| 4180 | def __init__ (self): |
| 4181 | super (Greet, self).__init__ ("greet") |
| 4182 | |
| 4183 | def invoke (self, name): |
| 4184 | return "Hello, %s!" % name.string () |
| 4185 | |
| 4186 | Greet () |
| 4187 | @end smallexample |
| 4188 | |
| 4189 | The last line instantiates the class, and is necessary to trigger the |
| 4190 | registration of the function with @value{GDBN}. Depending on how the |
| 4191 | Python code is read into @value{GDBN}, you may need to import the |
| 4192 | @code{gdb} module explicitly. |
| 4193 | |
| 4194 | Now you can use the function in an expression: |
| 4195 | |
| 4196 | @smallexample |
| 4197 | (gdb) print $greet("Bob") |
| 4198 | $1 = "Hello, Bob!" |
| 4199 | @end smallexample |
| 4200 | |
| 4201 | @node Progspaces In Python |
| 4202 | @subsubsection Program Spaces In Python |
| 4203 | |
| 4204 | @cindex progspaces in python |
| 4205 | @tindex gdb.Progspace |
| 4206 | @tindex Progspace |
| 4207 | A program space, or @dfn{progspace}, represents a symbolic view |
| 4208 | of an address space. |
| 4209 | It consists of all of the objfiles of the program. |
| 4210 | @xref{Objfiles In Python}. |
| 4211 | @xref{Inferiors Connections and Programs, program spaces}, for more details |
| 4212 | about program spaces. |
| 4213 | |
| 4214 | The following progspace-related functions are available in the |
| 4215 | @code{gdb} module: |
| 4216 | |
| 4217 | @findex gdb.current_progspace |
| 4218 | @defun gdb.current_progspace () |
| 4219 | This function returns the program space of the currently selected inferior. |
| 4220 | @xref{Inferiors Connections and Programs}. This is identical to |
| 4221 | @code{gdb.selected_inferior().progspace} (@pxref{Inferiors In Python}) and is |
| 4222 | included for historical compatibility. |
| 4223 | @end defun |
| 4224 | |
| 4225 | @findex gdb.progspaces |
| 4226 | @defun gdb.progspaces () |
| 4227 | Return a sequence of all the progspaces currently known to @value{GDBN}. |
| 4228 | @end defun |
| 4229 | |
| 4230 | Each progspace is represented by an instance of the @code{gdb.Progspace} |
| 4231 | class. |
| 4232 | |
| 4233 | @defvar Progspace.filename |
| 4234 | The file name of the progspace as a string. |
| 4235 | @end defvar |
| 4236 | |
| 4237 | @defvar Progspace.pretty_printers |
| 4238 | The @code{pretty_printers} attribute is a list of functions. It is |
| 4239 | used to look up pretty-printers. A @code{Value} is passed to each |
| 4240 | function in order; if the function returns @code{None}, then the |
| 4241 | search continues. Otherwise, the return value should be an object |
| 4242 | which is used to format the value. @xref{Pretty Printing API}, for more |
| 4243 | information. |
| 4244 | @end defvar |
| 4245 | |
| 4246 | @defvar Progspace.type_printers |
| 4247 | The @code{type_printers} attribute is a list of type printer objects. |
| 4248 | @xref{Type Printing API}, for more information. |
| 4249 | @end defvar |
| 4250 | |
| 4251 | @defvar Progspace.frame_filters |
| 4252 | The @code{frame_filters} attribute is a dictionary of frame filter |
| 4253 | objects. @xref{Frame Filter API}, for more information. |
| 4254 | @end defvar |
| 4255 | |
| 4256 | A program space has the following methods: |
| 4257 | |
| 4258 | @findex Progspace.block_for_pc |
| 4259 | @defun Progspace.block_for_pc (pc) |
| 4260 | Return the innermost @code{gdb.Block} containing the given @var{pc} |
| 4261 | value. If the block cannot be found for the @var{pc} value specified, |
| 4262 | the function will return @code{None}. |
| 4263 | @end defun |
| 4264 | |
| 4265 | @findex Progspace.find_pc_line |
| 4266 | @defun Progspace.find_pc_line (pc) |
| 4267 | Return the @code{gdb.Symtab_and_line} object corresponding to the |
| 4268 | @var{pc} value. @xref{Symbol Tables In Python}. If an invalid value |
| 4269 | of @var{pc} is passed as an argument, then the @code{symtab} and |
| 4270 | @code{line} attributes of the returned @code{gdb.Symtab_and_line} |
| 4271 | object will be @code{None} and 0 respectively. |
| 4272 | @end defun |
| 4273 | |
| 4274 | @findex Progspace.is_valid |
| 4275 | @defun Progspace.is_valid () |
| 4276 | Returns @code{True} if the @code{gdb.Progspace} object is valid, |
| 4277 | @code{False} if not. A @code{gdb.Progspace} object can become invalid |
| 4278 | if the program space file it refers to is not referenced by any |
| 4279 | inferior. All other @code{gdb.Progspace} methods will throw an |
| 4280 | exception if it is invalid at the time the method is called. |
| 4281 | @end defun |
| 4282 | |
| 4283 | @findex Progspace.objfiles |
| 4284 | @defun Progspace.objfiles () |
| 4285 | Return a sequence of all the objfiles referenced by this program |
| 4286 | space. @xref{Objfiles In Python}. |
| 4287 | @end defun |
| 4288 | |
| 4289 | @findex Progspace.solib_name |
| 4290 | @defun Progspace.solib_name (address) |
| 4291 | Return the name of the shared library holding the given @var{address} |
| 4292 | as a string, or @code{None}. |
| 4293 | @end defun |
| 4294 | |
| 4295 | One may add arbitrary attributes to @code{gdb.Progspace} objects |
| 4296 | in the usual Python way. |
| 4297 | This is useful if, for example, one needs to do some extra record keeping |
| 4298 | associated with the program space. |
| 4299 | |
| 4300 | In this contrived example, we want to perform some processing when |
| 4301 | an objfile with a certain symbol is loaded, but we only want to do |
| 4302 | this once because it is expensive. To achieve this we record the results |
| 4303 | with the program space because we can't predict when the desired objfile |
| 4304 | will be loaded. |
| 4305 | |
| 4306 | @smallexample |
| 4307 | (gdb) python |
| 4308 | def clear_objfiles_handler(event): |
| 4309 | event.progspace.expensive_computation = None |
| 4310 | def expensive(symbol): |
| 4311 | """A mock routine to perform an "expensive" computation on symbol.""" |
| 4312 | print ("Computing the answer to the ultimate question ...") |
| 4313 | return 42 |
| 4314 | def new_objfile_handler(event): |
| 4315 | objfile = event.new_objfile |
| 4316 | progspace = objfile.progspace |
| 4317 | if not hasattr(progspace, 'expensive_computation') or \ |
| 4318 | progspace.expensive_computation is None: |
| 4319 | # We use 'main' for the symbol to keep the example simple. |
| 4320 | # Note: There's no current way to constrain the lookup |
| 4321 | # to one objfile. |
| 4322 | symbol = gdb.lookup_global_symbol('main') |
| 4323 | if symbol is not None: |
| 4324 | progspace.expensive_computation = expensive(symbol) |
| 4325 | gdb.events.clear_objfiles.connect(clear_objfiles_handler) |
| 4326 | gdb.events.new_objfile.connect(new_objfile_handler) |
| 4327 | end |
| 4328 | (gdb) file /tmp/hello |
| 4329 | Reading symbols from /tmp/hello... |
| 4330 | Computing the answer to the ultimate question ... |
| 4331 | (gdb) python print gdb.current_progspace().expensive_computation |
| 4332 | 42 |
| 4333 | (gdb) run |
| 4334 | Starting program: /tmp/hello |
| 4335 | Hello. |
| 4336 | [Inferior 1 (process 4242) exited normally] |
| 4337 | @end smallexample |
| 4338 | |
| 4339 | @node Objfiles In Python |
| 4340 | @subsubsection Objfiles In Python |
| 4341 | |
| 4342 | @cindex objfiles in python |
| 4343 | @tindex gdb.Objfile |
| 4344 | @tindex Objfile |
| 4345 | @value{GDBN} loads symbols for an inferior from various |
| 4346 | symbol-containing files (@pxref{Files}). These include the primary |
| 4347 | executable file, any shared libraries used by the inferior, and any |
| 4348 | separate debug info files (@pxref{Separate Debug Files}). |
| 4349 | @value{GDBN} calls these symbol-containing files @dfn{objfiles}. |
| 4350 | |
| 4351 | The following objfile-related functions are available in the |
| 4352 | @code{gdb} module: |
| 4353 | |
| 4354 | @findex gdb.current_objfile |
| 4355 | @defun gdb.current_objfile () |
| 4356 | When auto-loading a Python script (@pxref{Python Auto-loading}), @value{GDBN} |
| 4357 | sets the ``current objfile'' to the corresponding objfile. This |
| 4358 | function returns the current objfile. If there is no current objfile, |
| 4359 | this function returns @code{None}. |
| 4360 | @end defun |
| 4361 | |
| 4362 | @findex gdb.objfiles |
| 4363 | @defun gdb.objfiles () |
| 4364 | Return a sequence of objfiles referenced by the current program space. |
| 4365 | @xref{Objfiles In Python}, and @ref{Progspaces In Python}. This is identical |
| 4366 | to @code{gdb.selected_inferior().progspace.objfiles()} and is included for |
| 4367 | historical compatibility. |
| 4368 | @end defun |
| 4369 | |
| 4370 | @findex gdb.lookup_objfile |
| 4371 | @defun gdb.lookup_objfile (name @r{[}, by_build_id{]}) |
| 4372 | Look up @var{name}, a file name or build ID, in the list of objfiles |
| 4373 | for the current program space (@pxref{Progspaces In Python}). |
| 4374 | If the objfile is not found throw the Python @code{ValueError} exception. |
| 4375 | |
| 4376 | If @var{name} is a relative file name, then it will match any |
| 4377 | source file name with the same trailing components. For example, if |
| 4378 | @var{name} is @samp{gcc/expr.c}, then it will match source file |
| 4379 | name of @file{/build/trunk/gcc/expr.c}, but not |
| 4380 | @file{/build/trunk/libcpp/expr.c} or @file{/build/trunk/gcc/x-expr.c}. |
| 4381 | |
| 4382 | If @var{by_build_id} is provided and is @code{True} then @var{name} |
| 4383 | is the build ID of the objfile. Otherwise, @var{name} is a file name. |
| 4384 | This is supported only on some operating systems, notably those which use |
| 4385 | the ELF format for binary files and the @sc{gnu} Binutils. For more details |
| 4386 | about this feature, see the description of the @option{--build-id} |
| 4387 | command-line option in @ref{Options, , Command Line Options, ld, |
| 4388 | The GNU Linker}. |
| 4389 | @end defun |
| 4390 | |
| 4391 | Each objfile is represented by an instance of the @code{gdb.Objfile} |
| 4392 | class. |
| 4393 | |
| 4394 | @defvar Objfile.filename |
| 4395 | The file name of the objfile as a string, with symbolic links resolved. |
| 4396 | |
| 4397 | The value is @code{None} if the objfile is no longer valid. |
| 4398 | See the @code{gdb.Objfile.is_valid} method, described below. |
| 4399 | @end defvar |
| 4400 | |
| 4401 | @defvar Objfile.username |
| 4402 | The file name of the objfile as specified by the user as a string. |
| 4403 | |
| 4404 | The value is @code{None} if the objfile is no longer valid. |
| 4405 | See the @code{gdb.Objfile.is_valid} method, described below. |
| 4406 | @end defvar |
| 4407 | |
| 4408 | @defvar Objfile.owner |
| 4409 | For separate debug info objfiles this is the corresponding @code{gdb.Objfile} |
| 4410 | object that debug info is being provided for. |
| 4411 | Otherwise this is @code{None}. |
| 4412 | Separate debug info objfiles are added with the |
| 4413 | @code{gdb.Objfile.add_separate_debug_file} method, described below. |
| 4414 | @end defvar |
| 4415 | |
| 4416 | @defvar Objfile.build_id |
| 4417 | The build ID of the objfile as a string. |
| 4418 | If the objfile does not have a build ID then the value is @code{None}. |
| 4419 | |
| 4420 | This is supported only on some operating systems, notably those which use |
| 4421 | the ELF format for binary files and the @sc{gnu} Binutils. For more details |
| 4422 | about this feature, see the description of the @option{--build-id} |
| 4423 | command-line option in @ref{Options, , Command Line Options, ld, |
| 4424 | The GNU Linker}. |
| 4425 | @end defvar |
| 4426 | |
| 4427 | @defvar Objfile.progspace |
| 4428 | The containing program space of the objfile as a @code{gdb.Progspace} |
| 4429 | object. @xref{Progspaces In Python}. |
| 4430 | @end defvar |
| 4431 | |
| 4432 | @defvar Objfile.pretty_printers |
| 4433 | The @code{pretty_printers} attribute is a list of functions. It is |
| 4434 | used to look up pretty-printers. A @code{Value} is passed to each |
| 4435 | function in order; if the function returns @code{None}, then the |
| 4436 | search continues. Otherwise, the return value should be an object |
| 4437 | which is used to format the value. @xref{Pretty Printing API}, for more |
| 4438 | information. |
| 4439 | @end defvar |
| 4440 | |
| 4441 | @defvar Objfile.type_printers |
| 4442 | The @code{type_printers} attribute is a list of type printer objects. |
| 4443 | @xref{Type Printing API}, for more information. |
| 4444 | @end defvar |
| 4445 | |
| 4446 | @defvar Objfile.frame_filters |
| 4447 | The @code{frame_filters} attribute is a dictionary of frame filter |
| 4448 | objects. @xref{Frame Filter API}, for more information. |
| 4449 | @end defvar |
| 4450 | |
| 4451 | One may add arbitrary attributes to @code{gdb.Objfile} objects |
| 4452 | in the usual Python way. |
| 4453 | This is useful if, for example, one needs to do some extra record keeping |
| 4454 | associated with the objfile. |
| 4455 | |
| 4456 | In this contrived example we record the time when @value{GDBN} |
| 4457 | loaded the objfile. |
| 4458 | |
| 4459 | @smallexample |
| 4460 | (gdb) python |
| 4461 | import datetime |
| 4462 | def new_objfile_handler(event): |
| 4463 | # Set the time_loaded attribute of the new objfile. |
| 4464 | event.new_objfile.time_loaded = datetime.datetime.today() |
| 4465 | gdb.events.new_objfile.connect(new_objfile_handler) |
| 4466 | end |
| 4467 | (gdb) file ./hello |
| 4468 | Reading symbols from ./hello... |
| 4469 | (gdb) python print gdb.objfiles()[0].time_loaded |
| 4470 | 2014-10-09 11:41:36.770345 |
| 4471 | @end smallexample |
| 4472 | |
| 4473 | A @code{gdb.Objfile} object has the following methods: |
| 4474 | |
| 4475 | @defun Objfile.is_valid () |
| 4476 | Returns @code{True} if the @code{gdb.Objfile} object is valid, |
| 4477 | @code{False} if not. A @code{gdb.Objfile} object can become invalid |
| 4478 | if the object file it refers to is not loaded in @value{GDBN} any |
| 4479 | longer. All other @code{gdb.Objfile} methods will throw an exception |
| 4480 | if it is invalid at the time the method is called. |
| 4481 | @end defun |
| 4482 | |
| 4483 | @defun Objfile.add_separate_debug_file (file) |
| 4484 | Add @var{file} to the list of files that @value{GDBN} will search for |
| 4485 | debug information for the objfile. |
| 4486 | This is useful when the debug info has been removed from the program |
| 4487 | and stored in a separate file. @value{GDBN} has built-in support for |
| 4488 | finding separate debug info files (@pxref{Separate Debug Files}), but if |
| 4489 | the file doesn't live in one of the standard places that @value{GDBN} |
| 4490 | searches then this function can be used to add a debug info file |
| 4491 | from a different place. |
| 4492 | @end defun |
| 4493 | |
| 4494 | @defun Objfile.lookup_global_symbol (name @r{[}, domain@r{]}) |
| 4495 | Search for a global symbol named @var{name} in this objfile. Optionally, the |
| 4496 | search scope can be restricted with the @var{domain} argument. |
| 4497 | The @var{domain} argument must be a domain constant defined in the @code{gdb} |
| 4498 | module and described in @ref{Symbols In Python}. This function is similar to |
| 4499 | @code{gdb.lookup_global_symbol}, except that the search is limited to this |
| 4500 | objfile. |
| 4501 | |
| 4502 | The result is a @code{gdb.Symbol} object or @code{None} if the symbol |
| 4503 | is not found. |
| 4504 | @end defun |
| 4505 | |
| 4506 | @defun Objfile.lookup_static_symbol (name @r{[}, domain@r{]}) |
| 4507 | Like @code{Objfile.lookup_global_symbol}, but searches for a global |
| 4508 | symbol with static linkage named @var{name} in this objfile. |
| 4509 | @end defun |
| 4510 | |
| 4511 | @node Frames In Python |
| 4512 | @subsubsection Accessing inferior stack frames from Python |
| 4513 | |
| 4514 | @cindex frames in python |
| 4515 | When the debugged program stops, @value{GDBN} is able to analyze its call |
| 4516 | stack (@pxref{Frames,,Stack frames}). The @code{gdb.Frame} class |
| 4517 | represents a frame in the stack. A @code{gdb.Frame} object is only valid |
| 4518 | while its corresponding frame exists in the inferior's stack. If you try |
| 4519 | to use an invalid frame object, @value{GDBN} will throw a @code{gdb.error} |
| 4520 | exception (@pxref{Exception Handling}). |
| 4521 | |
| 4522 | Two @code{gdb.Frame} objects can be compared for equality with the @code{==} |
| 4523 | operator, like: |
| 4524 | |
| 4525 | @smallexample |
| 4526 | (@value{GDBP}) python print gdb.newest_frame() == gdb.selected_frame () |
| 4527 | True |
| 4528 | @end smallexample |
| 4529 | |
| 4530 | The following frame-related functions are available in the @code{gdb} module: |
| 4531 | |
| 4532 | @findex gdb.selected_frame |
| 4533 | @defun gdb.selected_frame () |
| 4534 | Return the selected frame object. (@pxref{Selection,,Selecting a Frame}). |
| 4535 | @end defun |
| 4536 | |
| 4537 | @findex gdb.newest_frame |
| 4538 | @defun gdb.newest_frame () |
| 4539 | Return the newest frame object for the selected thread. |
| 4540 | @end defun |
| 4541 | |
| 4542 | @defun gdb.frame_stop_reason_string (reason) |
| 4543 | Return a string explaining the reason why @value{GDBN} stopped unwinding |
| 4544 | frames, as expressed by the given @var{reason} code (an integer, see the |
| 4545 | @code{unwind_stop_reason} method further down in this section). |
| 4546 | @end defun |
| 4547 | |
| 4548 | @findex gdb.invalidate_cached_frames |
| 4549 | @defun gdb.invalidate_cached_frames |
| 4550 | @value{GDBN} internally keeps a cache of the frames that have been |
| 4551 | unwound. This function invalidates this cache. |
| 4552 | |
| 4553 | This function should not generally be called by ordinary Python code. |
| 4554 | It is documented for the sake of completeness. |
| 4555 | @end defun |
| 4556 | |
| 4557 | A @code{gdb.Frame} object has the following methods: |
| 4558 | |
| 4559 | @defun Frame.is_valid () |
| 4560 | Returns true if the @code{gdb.Frame} object is valid, false if not. |
| 4561 | A frame object can become invalid if the frame it refers to doesn't |
| 4562 | exist anymore in the inferior. All @code{gdb.Frame} methods will throw |
| 4563 | an exception if it is invalid at the time the method is called. |
| 4564 | @end defun |
| 4565 | |
| 4566 | @defun Frame.name () |
| 4567 | Returns the function name of the frame, or @code{None} if it can't be |
| 4568 | obtained. |
| 4569 | @end defun |
| 4570 | |
| 4571 | @defun Frame.architecture () |
| 4572 | Returns the @code{gdb.Architecture} object corresponding to the frame's |
| 4573 | architecture. @xref{Architectures In Python}. |
| 4574 | @end defun |
| 4575 | |
| 4576 | @defun Frame.type () |
| 4577 | Returns the type of the frame. The value can be one of: |
| 4578 | @table @code |
| 4579 | @item gdb.NORMAL_FRAME |
| 4580 | An ordinary stack frame. |
| 4581 | |
| 4582 | @item gdb.DUMMY_FRAME |
| 4583 | A fake stack frame that was created by @value{GDBN} when performing an |
| 4584 | inferior function call. |
| 4585 | |
| 4586 | @item gdb.INLINE_FRAME |
| 4587 | A frame representing an inlined function. The function was inlined |
| 4588 | into a @code{gdb.NORMAL_FRAME} that is older than this one. |
| 4589 | |
| 4590 | @item gdb.TAILCALL_FRAME |
| 4591 | A frame representing a tail call. @xref{Tail Call Frames}. |
| 4592 | |
| 4593 | @item gdb.SIGTRAMP_FRAME |
| 4594 | A signal trampoline frame. This is the frame created by the OS when |
| 4595 | it calls into a signal handler. |
| 4596 | |
| 4597 | @item gdb.ARCH_FRAME |
| 4598 | A fake stack frame representing a cross-architecture call. |
| 4599 | |
| 4600 | @item gdb.SENTINEL_FRAME |
| 4601 | This is like @code{gdb.NORMAL_FRAME}, but it is only used for the |
| 4602 | newest frame. |
| 4603 | @end table |
| 4604 | @end defun |
| 4605 | |
| 4606 | @defun Frame.unwind_stop_reason () |
| 4607 | Return an integer representing the reason why it's not possible to find |
| 4608 | more frames toward the outermost frame. Use |
| 4609 | @code{gdb.frame_stop_reason_string} to convert the value returned by this |
| 4610 | function to a string. The value can be one of: |
| 4611 | |
| 4612 | @table @code |
| 4613 | @item gdb.FRAME_UNWIND_NO_REASON |
| 4614 | No particular reason (older frames should be available). |
| 4615 | |
| 4616 | @item gdb.FRAME_UNWIND_NULL_ID |
| 4617 | The previous frame's analyzer returns an invalid result. This is no |
| 4618 | longer used by @value{GDBN}, and is kept only for backward |
| 4619 | compatibility. |
| 4620 | |
| 4621 | @item gdb.FRAME_UNWIND_OUTERMOST |
| 4622 | This frame is the outermost. |
| 4623 | |
| 4624 | @item gdb.FRAME_UNWIND_UNAVAILABLE |
| 4625 | Cannot unwind further, because that would require knowing the |
| 4626 | values of registers or memory that have not been collected. |
| 4627 | |
| 4628 | @item gdb.FRAME_UNWIND_INNER_ID |
| 4629 | This frame ID looks like it ought to belong to a NEXT frame, |
| 4630 | but we got it for a PREV frame. Normally, this is a sign of |
| 4631 | unwinder failure. It could also indicate stack corruption. |
| 4632 | |
| 4633 | @item gdb.FRAME_UNWIND_SAME_ID |
| 4634 | This frame has the same ID as the previous one. That means |
| 4635 | that unwinding further would almost certainly give us another |
| 4636 | frame with exactly the same ID, so break the chain. Normally, |
| 4637 | this is a sign of unwinder failure. It could also indicate |
| 4638 | stack corruption. |
| 4639 | |
| 4640 | @item gdb.FRAME_UNWIND_NO_SAVED_PC |
| 4641 | The frame unwinder did not find any saved PC, but we needed |
| 4642 | one to unwind further. |
| 4643 | |
| 4644 | @item gdb.FRAME_UNWIND_MEMORY_ERROR |
| 4645 | The frame unwinder caused an error while trying to access memory. |
| 4646 | |
| 4647 | @item gdb.FRAME_UNWIND_FIRST_ERROR |
| 4648 | Any stop reason greater or equal to this value indicates some kind |
| 4649 | of error. This special value facilitates writing code that tests |
| 4650 | for errors in unwinding in a way that will work correctly even if |
| 4651 | the list of the other values is modified in future @value{GDBN} |
| 4652 | versions. Using it, you could write: |
| 4653 | @smallexample |
| 4654 | reason = gdb.selected_frame().unwind_stop_reason () |
| 4655 | reason_str = gdb.frame_stop_reason_string (reason) |
| 4656 | if reason >= gdb.FRAME_UNWIND_FIRST_ERROR: |
| 4657 | print ("An error occured: %s" % reason_str) |
| 4658 | @end smallexample |
| 4659 | @end table |
| 4660 | |
| 4661 | @end defun |
| 4662 | |
| 4663 | @defun Frame.pc () |
| 4664 | Returns the frame's resume address. |
| 4665 | @end defun |
| 4666 | |
| 4667 | @defun Frame.block () |
| 4668 | Return the frame's code block. @xref{Blocks In Python}. If the frame |
| 4669 | does not have a block -- for example, if there is no debugging |
| 4670 | information for the code in question -- then this will throw an |
| 4671 | exception. |
| 4672 | @end defun |
| 4673 | |
| 4674 | @defun Frame.function () |
| 4675 | Return the symbol for the function corresponding to this frame. |
| 4676 | @xref{Symbols In Python}. |
| 4677 | @end defun |
| 4678 | |
| 4679 | @defun Frame.older () |
| 4680 | Return the frame that called this frame. |
| 4681 | @end defun |
| 4682 | |
| 4683 | @defun Frame.newer () |
| 4684 | Return the frame called by this frame. |
| 4685 | @end defun |
| 4686 | |
| 4687 | @defun Frame.find_sal () |
| 4688 | Return the frame's symtab and line object. |
| 4689 | @xref{Symbol Tables In Python}. |
| 4690 | @end defun |
| 4691 | |
| 4692 | @anchor{gdbpy_frame_read_register} |
| 4693 | @defun Frame.read_register (register) |
| 4694 | Return the value of @var{register} in this frame. Returns a |
| 4695 | @code{Gdb.Value} object. Throws an exception if @var{register} does |
| 4696 | not exist. The @var{register} argument must be one of the following: |
| 4697 | @enumerate |
| 4698 | @item |
| 4699 | A string that is the name of a valid register (e.g., @code{'sp'} or |
| 4700 | @code{'rax'}). |
| 4701 | @item |
| 4702 | A @code{gdb.RegisterDescriptor} object (@pxref{Registers In Python}). |
| 4703 | @item |
| 4704 | A @value{GDBN} internal, platform specific number. Using these |
| 4705 | numbers is supported for historic reasons, but is not recommended as |
| 4706 | future changes to @value{GDBN} could change the mapping between |
| 4707 | numbers and the registers they represent, breaking any Python code |
| 4708 | that uses the platform-specific numbers. The numbers are usually |
| 4709 | found in the corresponding @file{@var{platform}-tdep.h} file in the |
| 4710 | @value{GDBN} source tree. |
| 4711 | @end enumerate |
| 4712 | Using a string to access registers will be slightly slower than the |
| 4713 | other two methods as @value{GDBN} must look up the mapping between |
| 4714 | name and internal register number. If performance is critical |
| 4715 | consider looking up and caching a @code{gdb.RegisterDescriptor} |
| 4716 | object. |
| 4717 | @end defun |
| 4718 | |
| 4719 | @defun Frame.read_var (variable @r{[}, block@r{]}) |
| 4720 | Return the value of @var{variable} in this frame. If the optional |
| 4721 | argument @var{block} is provided, search for the variable from that |
| 4722 | block; otherwise start at the frame's current block (which is |
| 4723 | determined by the frame's current program counter). The @var{variable} |
| 4724 | argument must be a string or a @code{gdb.Symbol} object; @var{block} must be a |
| 4725 | @code{gdb.Block} object. |
| 4726 | @end defun |
| 4727 | |
| 4728 | @defun Frame.select () |
| 4729 | Set this frame to be the selected frame. @xref{Stack, ,Examining the |
| 4730 | Stack}. |
| 4731 | @end defun |
| 4732 | |
| 4733 | @node Blocks In Python |
| 4734 | @subsubsection Accessing blocks from Python |
| 4735 | |
| 4736 | @cindex blocks in python |
| 4737 | @tindex gdb.Block |
| 4738 | |
| 4739 | In @value{GDBN}, symbols are stored in blocks. A block corresponds |
| 4740 | roughly to a scope in the source code. Blocks are organized |
| 4741 | hierarchically, and are represented individually in Python as a |
| 4742 | @code{gdb.Block}. Blocks rely on debugging information being |
| 4743 | available. |
| 4744 | |
| 4745 | A frame has a block. Please see @ref{Frames In Python}, for a more |
| 4746 | in-depth discussion of frames. |
| 4747 | |
| 4748 | The outermost block is known as the @dfn{global block}. The global |
| 4749 | block typically holds public global variables and functions. |
| 4750 | |
| 4751 | The block nested just inside the global block is the @dfn{static |
| 4752 | block}. The static block typically holds file-scoped variables and |
| 4753 | functions. |
| 4754 | |
| 4755 | @value{GDBN} provides a method to get a block's superblock, but there |
| 4756 | is currently no way to examine the sub-blocks of a block, or to |
| 4757 | iterate over all the blocks in a symbol table (@pxref{Symbol Tables In |
| 4758 | Python}). |
| 4759 | |
| 4760 | Here is a short example that should help explain blocks: |
| 4761 | |
| 4762 | @smallexample |
| 4763 | /* This is in the global block. */ |
| 4764 | int global; |
| 4765 | |
| 4766 | /* This is in the static block. */ |
| 4767 | static int file_scope; |
| 4768 | |
| 4769 | /* 'function' is in the global block, and 'argument' is |
| 4770 | in a block nested inside of 'function'. */ |
| 4771 | int function (int argument) |
| 4772 | @{ |
| 4773 | /* 'local' is in a block inside 'function'. It may or may |
| 4774 | not be in the same block as 'argument'. */ |
| 4775 | int local; |
| 4776 | |
| 4777 | @{ |
| 4778 | /* 'inner' is in a block whose superblock is the one holding |
| 4779 | 'local'. */ |
| 4780 | int inner; |
| 4781 | |
| 4782 | /* If this call is expanded by the compiler, you may see |
| 4783 | a nested block here whose function is 'inline_function' |
| 4784 | and whose superblock is the one holding 'inner'. */ |
| 4785 | inline_function (); |
| 4786 | @} |
| 4787 | @} |
| 4788 | @end smallexample |
| 4789 | |
| 4790 | A @code{gdb.Block} is iterable. The iterator returns the symbols |
| 4791 | (@pxref{Symbols In Python}) local to the block. Python programs |
| 4792 | should not assume that a specific block object will always contain a |
| 4793 | given symbol, since changes in @value{GDBN} features and |
| 4794 | infrastructure may cause symbols move across blocks in a symbol |
| 4795 | table. You can also use Python's @dfn{dictionary syntax} to access |
| 4796 | variables in this block, e.g.: |
| 4797 | |
| 4798 | @smallexample |
| 4799 | symbol = some_block['variable'] # symbol is of type gdb.Symbol |
| 4800 | @end smallexample |
| 4801 | |
| 4802 | The following block-related functions are available in the @code{gdb} |
| 4803 | module: |
| 4804 | |
| 4805 | @findex gdb.block_for_pc |
| 4806 | @defun gdb.block_for_pc (pc) |
| 4807 | Return the innermost @code{gdb.Block} containing the given @var{pc} |
| 4808 | value. If the block cannot be found for the @var{pc} value specified, |
| 4809 | the function will return @code{None}. This is identical to |
| 4810 | @code{gdb.current_progspace().block_for_pc(pc)} and is included for |
| 4811 | historical compatibility. |
| 4812 | @end defun |
| 4813 | |
| 4814 | A @code{gdb.Block} object has the following methods: |
| 4815 | |
| 4816 | @defun Block.is_valid () |
| 4817 | Returns @code{True} if the @code{gdb.Block} object is valid, |
| 4818 | @code{False} if not. A block object can become invalid if the block it |
| 4819 | refers to doesn't exist anymore in the inferior. All other |
| 4820 | @code{gdb.Block} methods will throw an exception if it is invalid at |
| 4821 | the time the method is called. The block's validity is also checked |
| 4822 | during iteration over symbols of the block. |
| 4823 | @end defun |
| 4824 | |
| 4825 | A @code{gdb.Block} object has the following attributes: |
| 4826 | |
| 4827 | @defvar Block.start |
| 4828 | The start address of the block. This attribute is not writable. |
| 4829 | @end defvar |
| 4830 | |
| 4831 | @defvar Block.end |
| 4832 | One past the last address that appears in the block. This attribute |
| 4833 | is not writable. |
| 4834 | @end defvar |
| 4835 | |
| 4836 | @defvar Block.function |
| 4837 | The name of the block represented as a @code{gdb.Symbol}. If the |
| 4838 | block is not named, then this attribute holds @code{None}. This |
| 4839 | attribute is not writable. |
| 4840 | |
| 4841 | For ordinary function blocks, the superblock is the static block. |
| 4842 | However, you should note that it is possible for a function block to |
| 4843 | have a superblock that is not the static block -- for instance this |
| 4844 | happens for an inlined function. |
| 4845 | @end defvar |
| 4846 | |
| 4847 | @defvar Block.superblock |
| 4848 | The block containing this block. If this parent block does not exist, |
| 4849 | this attribute holds @code{None}. This attribute is not writable. |
| 4850 | @end defvar |
| 4851 | |
| 4852 | @defvar Block.global_block |
| 4853 | The global block associated with this block. This attribute is not |
| 4854 | writable. |
| 4855 | @end defvar |
| 4856 | |
| 4857 | @defvar Block.static_block |
| 4858 | The static block associated with this block. This attribute is not |
| 4859 | writable. |
| 4860 | @end defvar |
| 4861 | |
| 4862 | @defvar Block.is_global |
| 4863 | @code{True} if the @code{gdb.Block} object is a global block, |
| 4864 | @code{False} if not. This attribute is not |
| 4865 | writable. |
| 4866 | @end defvar |
| 4867 | |
| 4868 | @defvar Block.is_static |
| 4869 | @code{True} if the @code{gdb.Block} object is a static block, |
| 4870 | @code{False} if not. This attribute is not writable. |
| 4871 | @end defvar |
| 4872 | |
| 4873 | @node Symbols In Python |
| 4874 | @subsubsection Python representation of Symbols |
| 4875 | |
| 4876 | @cindex symbols in python |
| 4877 | @tindex gdb.Symbol |
| 4878 | |
| 4879 | @value{GDBN} represents every variable, function and type as an |
| 4880 | entry in a symbol table. @xref{Symbols, ,Examining the Symbol Table}. |
| 4881 | Similarly, Python represents these symbols in @value{GDBN} with the |
| 4882 | @code{gdb.Symbol} object. |
| 4883 | |
| 4884 | The following symbol-related functions are available in the @code{gdb} |
| 4885 | module: |
| 4886 | |
| 4887 | @findex gdb.lookup_symbol |
| 4888 | @defun gdb.lookup_symbol (name @r{[}, block @r{[}, domain@r{]]}) |
| 4889 | This function searches for a symbol by name. The search scope can be |
| 4890 | restricted to the parameters defined in the optional domain and block |
| 4891 | arguments. |
| 4892 | |
| 4893 | @var{name} is the name of the symbol. It must be a string. The |
| 4894 | optional @var{block} argument restricts the search to symbols visible |
| 4895 | in that @var{block}. The @var{block} argument must be a |
| 4896 | @code{gdb.Block} object. If omitted, the block for the current frame |
| 4897 | is used. The optional @var{domain} argument restricts |
| 4898 | the search to the domain type. The @var{domain} argument must be a |
| 4899 | domain constant defined in the @code{gdb} module and described later |
| 4900 | in this chapter. |
| 4901 | |
| 4902 | The result is a tuple of two elements. |
| 4903 | The first element is a @code{gdb.Symbol} object or @code{None} if the symbol |
| 4904 | is not found. |
| 4905 | If the symbol is found, the second element is @code{True} if the symbol |
| 4906 | is a field of a method's object (e.g., @code{this} in C@t{++}), |
| 4907 | otherwise it is @code{False}. |
| 4908 | If the symbol is not found, the second element is @code{False}. |
| 4909 | @end defun |
| 4910 | |
| 4911 | @findex gdb.lookup_global_symbol |
| 4912 | @defun gdb.lookup_global_symbol (name @r{[}, domain@r{]}) |
| 4913 | This function searches for a global symbol by name. |
| 4914 | The search scope can be restricted to by the domain argument. |
| 4915 | |
| 4916 | @var{name} is the name of the symbol. It must be a string. |
| 4917 | The optional @var{domain} argument restricts the search to the domain type. |
| 4918 | The @var{domain} argument must be a domain constant defined in the @code{gdb} |
| 4919 | module and described later in this chapter. |
| 4920 | |
| 4921 | The result is a @code{gdb.Symbol} object or @code{None} if the symbol |
| 4922 | is not found. |
| 4923 | @end defun |
| 4924 | |
| 4925 | @findex gdb.lookup_static_symbol |
| 4926 | @defun gdb.lookup_static_symbol (name @r{[}, domain@r{]}) |
| 4927 | This function searches for a global symbol with static linkage by name. |
| 4928 | The search scope can be restricted to by the domain argument. |
| 4929 | |
| 4930 | @var{name} is the name of the symbol. It must be a string. |
| 4931 | The optional @var{domain} argument restricts the search to the domain type. |
| 4932 | The @var{domain} argument must be a domain constant defined in the @code{gdb} |
| 4933 | module and described later in this chapter. |
| 4934 | |
| 4935 | The result is a @code{gdb.Symbol} object or @code{None} if the symbol |
| 4936 | is not found. |
| 4937 | |
| 4938 | Note that this function will not find function-scoped static variables. To look |
| 4939 | up such variables, iterate over the variables of the function's |
| 4940 | @code{gdb.Block} and check that @code{block.addr_class} is |
| 4941 | @code{gdb.SYMBOL_LOC_STATIC}. |
| 4942 | |
| 4943 | There can be multiple global symbols with static linkage with the same |
| 4944 | name. This function will only return the first matching symbol that |
| 4945 | it finds. Which symbol is found depends on where @value{GDBN} is |
| 4946 | currently stopped, as @value{GDBN} will first search for matching |
| 4947 | symbols in the current object file, and then search all other object |
| 4948 | files. If the application is not yet running then @value{GDBN} will |
| 4949 | search all object files in the order they appear in the debug |
| 4950 | information. |
| 4951 | @end defun |
| 4952 | |
| 4953 | @findex gdb.lookup_static_symbols |
| 4954 | @defun gdb.lookup_static_symbols (name @r{[}, domain@r{]}) |
| 4955 | Similar to @code{gdb.lookup_static_symbol}, this function searches for |
| 4956 | global symbols with static linkage by name, and optionally restricted |
| 4957 | by the domain argument. However, this function returns a list of all |
| 4958 | matching symbols found, not just the first one. |
| 4959 | |
| 4960 | @var{name} is the name of the symbol. It must be a string. |
| 4961 | The optional @var{domain} argument restricts the search to the domain type. |
| 4962 | The @var{domain} argument must be a domain constant defined in the @code{gdb} |
| 4963 | module and described later in this chapter. |
| 4964 | |
| 4965 | The result is a list of @code{gdb.Symbol} objects which could be empty |
| 4966 | if no matching symbols were found. |
| 4967 | |
| 4968 | Note that this function will not find function-scoped static variables. To look |
| 4969 | up such variables, iterate over the variables of the function's |
| 4970 | @code{gdb.Block} and check that @code{block.addr_class} is |
| 4971 | @code{gdb.SYMBOL_LOC_STATIC}. |
| 4972 | @end defun |
| 4973 | |
| 4974 | A @code{gdb.Symbol} object has the following attributes: |
| 4975 | |
| 4976 | @defvar Symbol.type |
| 4977 | The type of the symbol or @code{None} if no type is recorded. |
| 4978 | This attribute is represented as a @code{gdb.Type} object. |
| 4979 | @xref{Types In Python}. This attribute is not writable. |
| 4980 | @end defvar |
| 4981 | |
| 4982 | @defvar Symbol.symtab |
| 4983 | The symbol table in which the symbol appears. This attribute is |
| 4984 | represented as a @code{gdb.Symtab} object. @xref{Symbol Tables In |
| 4985 | Python}. This attribute is not writable. |
| 4986 | @end defvar |
| 4987 | |
| 4988 | @defvar Symbol.line |
| 4989 | The line number in the source code at which the symbol was defined. |
| 4990 | This is an integer. |
| 4991 | @end defvar |
| 4992 | |
| 4993 | @defvar Symbol.name |
| 4994 | The name of the symbol as a string. This attribute is not writable. |
| 4995 | @end defvar |
| 4996 | |
| 4997 | @defvar Symbol.linkage_name |
| 4998 | The name of the symbol, as used by the linker (i.e., may be mangled). |
| 4999 | This attribute is not writable. |
| 5000 | @end defvar |
| 5001 | |
| 5002 | @defvar Symbol.print_name |
| 5003 | The name of the symbol in a form suitable for output. This is either |
| 5004 | @code{name} or @code{linkage_name}, depending on whether the user |
| 5005 | asked @value{GDBN} to display demangled or mangled names. |
| 5006 | @end defvar |
| 5007 | |
| 5008 | @defvar Symbol.addr_class |
| 5009 | The address class of the symbol. This classifies how to find the value |
| 5010 | of a symbol. Each address class is a constant defined in the |
| 5011 | @code{gdb} module and described later in this chapter. |
| 5012 | @end defvar |
| 5013 | |
| 5014 | @defvar Symbol.needs_frame |
| 5015 | This is @code{True} if evaluating this symbol's value requires a frame |
| 5016 | (@pxref{Frames In Python}) and @code{False} otherwise. Typically, |
| 5017 | local variables will require a frame, but other symbols will not. |
| 5018 | @end defvar |
| 5019 | |
| 5020 | @defvar Symbol.is_argument |
| 5021 | @code{True} if the symbol is an argument of a function. |
| 5022 | @end defvar |
| 5023 | |
| 5024 | @defvar Symbol.is_constant |
| 5025 | @code{True} if the symbol is a constant. |
| 5026 | @end defvar |
| 5027 | |
| 5028 | @defvar Symbol.is_function |
| 5029 | @code{True} if the symbol is a function or a method. |
| 5030 | @end defvar |
| 5031 | |
| 5032 | @defvar Symbol.is_variable |
| 5033 | @code{True} if the symbol is a variable. |
| 5034 | @end defvar |
| 5035 | |
| 5036 | A @code{gdb.Symbol} object has the following methods: |
| 5037 | |
| 5038 | @defun Symbol.is_valid () |
| 5039 | Returns @code{True} if the @code{gdb.Symbol} object is valid, |
| 5040 | @code{False} if not. A @code{gdb.Symbol} object can become invalid if |
| 5041 | the symbol it refers to does not exist in @value{GDBN} any longer. |
| 5042 | All other @code{gdb.Symbol} methods will throw an exception if it is |
| 5043 | invalid at the time the method is called. |
| 5044 | @end defun |
| 5045 | |
| 5046 | @defun Symbol.value (@r{[}frame@r{]}) |
| 5047 | Compute the value of the symbol, as a @code{gdb.Value}. For |
| 5048 | functions, this computes the address of the function, cast to the |
| 5049 | appropriate type. If the symbol requires a frame in order to compute |
| 5050 | its value, then @var{frame} must be given. If @var{frame} is not |
| 5051 | given, or if @var{frame} is invalid, then this method will throw an |
| 5052 | exception. |
| 5053 | @end defun |
| 5054 | |
| 5055 | The available domain categories in @code{gdb.Symbol} are represented |
| 5056 | as constants in the @code{gdb} module: |
| 5057 | |
| 5058 | @vtable @code |
| 5059 | @vindex SYMBOL_UNDEF_DOMAIN |
| 5060 | @item gdb.SYMBOL_UNDEF_DOMAIN |
| 5061 | This is used when a domain has not been discovered or none of the |
| 5062 | following domains apply. This usually indicates an error either |
| 5063 | in the symbol information or in @value{GDBN}'s handling of symbols. |
| 5064 | |
| 5065 | @vindex SYMBOL_VAR_DOMAIN |
| 5066 | @item gdb.SYMBOL_VAR_DOMAIN |
| 5067 | This domain contains variables, function names, typedef names and enum |
| 5068 | type values. |
| 5069 | |
| 5070 | @vindex SYMBOL_STRUCT_DOMAIN |
| 5071 | @item gdb.SYMBOL_STRUCT_DOMAIN |
| 5072 | This domain holds struct, union and enum type names. |
| 5073 | |
| 5074 | @vindex SYMBOL_LABEL_DOMAIN |
| 5075 | @item gdb.SYMBOL_LABEL_DOMAIN |
| 5076 | This domain contains names of labels (for gotos). |
| 5077 | |
| 5078 | @vindex SYMBOL_MODULE_DOMAIN |
| 5079 | @item gdb.SYMBOL_MODULE_DOMAIN |
| 5080 | This domain contains names of Fortran module types. |
| 5081 | |
| 5082 | @vindex SYMBOL_COMMON_BLOCK_DOMAIN |
| 5083 | @item gdb.SYMBOL_COMMON_BLOCK_DOMAIN |
| 5084 | This domain contains names of Fortran common blocks. |
| 5085 | @end vtable |
| 5086 | |
| 5087 | The available address class categories in @code{gdb.Symbol} are represented |
| 5088 | as constants in the @code{gdb} module: |
| 5089 | |
| 5090 | @vtable @code |
| 5091 | @vindex SYMBOL_LOC_UNDEF |
| 5092 | @item gdb.SYMBOL_LOC_UNDEF |
| 5093 | If this is returned by address class, it indicates an error either in |
| 5094 | the symbol information or in @value{GDBN}'s handling of symbols. |
| 5095 | |
| 5096 | @vindex SYMBOL_LOC_CONST |
| 5097 | @item gdb.SYMBOL_LOC_CONST |
| 5098 | Value is constant int. |
| 5099 | |
| 5100 | @vindex SYMBOL_LOC_STATIC |
| 5101 | @item gdb.SYMBOL_LOC_STATIC |
| 5102 | Value is at a fixed address. |
| 5103 | |
| 5104 | @vindex SYMBOL_LOC_REGISTER |
| 5105 | @item gdb.SYMBOL_LOC_REGISTER |
| 5106 | Value is in a register. |
| 5107 | |
| 5108 | @vindex SYMBOL_LOC_ARG |
| 5109 | @item gdb.SYMBOL_LOC_ARG |
| 5110 | Value is an argument. This value is at the offset stored within the |
| 5111 | symbol inside the frame's argument list. |
| 5112 | |
| 5113 | @vindex SYMBOL_LOC_REF_ARG |
| 5114 | @item gdb.SYMBOL_LOC_REF_ARG |
| 5115 | Value address is stored in the frame's argument list. Just like |
| 5116 | @code{LOC_ARG} except that the value's address is stored at the |
| 5117 | offset, not the value itself. |
| 5118 | |
| 5119 | @vindex SYMBOL_LOC_REGPARM_ADDR |
| 5120 | @item gdb.SYMBOL_LOC_REGPARM_ADDR |
| 5121 | Value is a specified register. Just like @code{LOC_REGISTER} except |
| 5122 | the register holds the address of the argument instead of the argument |
| 5123 | itself. |
| 5124 | |
| 5125 | @vindex SYMBOL_LOC_LOCAL |
| 5126 | @item gdb.SYMBOL_LOC_LOCAL |
| 5127 | Value is a local variable. |
| 5128 | |
| 5129 | @vindex SYMBOL_LOC_TYPEDEF |
| 5130 | @item gdb.SYMBOL_LOC_TYPEDEF |
| 5131 | Value not used. Symbols in the domain @code{SYMBOL_STRUCT_DOMAIN} all |
| 5132 | have this class. |
| 5133 | |
| 5134 | @vindex SYMBOL_LOC_BLOCK |
| 5135 | @item gdb.SYMBOL_LOC_BLOCK |
| 5136 | Value is a block. |
| 5137 | |
| 5138 | @vindex SYMBOL_LOC_CONST_BYTES |
| 5139 | @item gdb.SYMBOL_LOC_CONST_BYTES |
| 5140 | Value is a byte-sequence. |
| 5141 | |
| 5142 | @vindex SYMBOL_LOC_UNRESOLVED |
| 5143 | @item gdb.SYMBOL_LOC_UNRESOLVED |
| 5144 | Value is at a fixed address, but the address of the variable has to be |
| 5145 | determined from the minimal symbol table whenever the variable is |
| 5146 | referenced. |
| 5147 | |
| 5148 | @vindex SYMBOL_LOC_OPTIMIZED_OUT |
| 5149 | @item gdb.SYMBOL_LOC_OPTIMIZED_OUT |
| 5150 | The value does not actually exist in the program. |
| 5151 | |
| 5152 | @vindex SYMBOL_LOC_COMPUTED |
| 5153 | @item gdb.SYMBOL_LOC_COMPUTED |
| 5154 | The value's address is a computed location. |
| 5155 | |
| 5156 | @vindex SYMBOL_LOC_COMPUTED |
| 5157 | @item gdb.SYMBOL_LOC_COMPUTED |
| 5158 | The value's address is a symbol. This is only used for Fortran common |
| 5159 | blocks. |
| 5160 | @end vtable |
| 5161 | |
| 5162 | @node Symbol Tables In Python |
| 5163 | @subsubsection Symbol table representation in Python |
| 5164 | |
| 5165 | @cindex symbol tables in python |
| 5166 | @tindex gdb.Symtab |
| 5167 | @tindex gdb.Symtab_and_line |
| 5168 | |
| 5169 | Access to symbol table data maintained by @value{GDBN} on the inferior |
| 5170 | is exposed to Python via two objects: @code{gdb.Symtab_and_line} and |
| 5171 | @code{gdb.Symtab}. Symbol table and line data for a frame is returned |
| 5172 | from the @code{find_sal} method in @code{gdb.Frame} object. |
| 5173 | @xref{Frames In Python}. |
| 5174 | |
| 5175 | For more information on @value{GDBN}'s symbol table management, see |
| 5176 | @ref{Symbols, ,Examining the Symbol Table}, for more information. |
| 5177 | |
| 5178 | A @code{gdb.Symtab_and_line} object has the following attributes: |
| 5179 | |
| 5180 | @defvar Symtab_and_line.symtab |
| 5181 | The symbol table object (@code{gdb.Symtab}) for this frame. |
| 5182 | This attribute is not writable. |
| 5183 | @end defvar |
| 5184 | |
| 5185 | @defvar Symtab_and_line.pc |
| 5186 | Indicates the start of the address range occupied by code for the |
| 5187 | current source line. This attribute is not writable. |
| 5188 | @end defvar |
| 5189 | |
| 5190 | @defvar Symtab_and_line.last |
| 5191 | Indicates the end of the address range occupied by code for the current |
| 5192 | source line. This attribute is not writable. |
| 5193 | @end defvar |
| 5194 | |
| 5195 | @defvar Symtab_and_line.line |
| 5196 | Indicates the current line number for this object. This |
| 5197 | attribute is not writable. |
| 5198 | @end defvar |
| 5199 | |
| 5200 | A @code{gdb.Symtab_and_line} object has the following methods: |
| 5201 | |
| 5202 | @defun Symtab_and_line.is_valid () |
| 5203 | Returns @code{True} if the @code{gdb.Symtab_and_line} object is valid, |
| 5204 | @code{False} if not. A @code{gdb.Symtab_and_line} object can become |
| 5205 | invalid if the Symbol table and line object it refers to does not |
| 5206 | exist in @value{GDBN} any longer. All other |
| 5207 | @code{gdb.Symtab_and_line} methods will throw an exception if it is |
| 5208 | invalid at the time the method is called. |
| 5209 | @end defun |
| 5210 | |
| 5211 | A @code{gdb.Symtab} object has the following attributes: |
| 5212 | |
| 5213 | @defvar Symtab.filename |
| 5214 | The symbol table's source filename. This attribute is not writable. |
| 5215 | @end defvar |
| 5216 | |
| 5217 | @defvar Symtab.objfile |
| 5218 | The symbol table's backing object file. @xref{Objfiles In Python}. |
| 5219 | This attribute is not writable. |
| 5220 | @end defvar |
| 5221 | |
| 5222 | @defvar Symtab.producer |
| 5223 | The name and possibly version number of the program that |
| 5224 | compiled the code in the symbol table. |
| 5225 | The contents of this string is up to the compiler. |
| 5226 | If no producer information is available then @code{None} is returned. |
| 5227 | This attribute is not writable. |
| 5228 | @end defvar |
| 5229 | |
| 5230 | A @code{gdb.Symtab} object has the following methods: |
| 5231 | |
| 5232 | @defun Symtab.is_valid () |
| 5233 | Returns @code{True} if the @code{gdb.Symtab} object is valid, |
| 5234 | @code{False} if not. A @code{gdb.Symtab} object can become invalid if |
| 5235 | the symbol table it refers to does not exist in @value{GDBN} any |
| 5236 | longer. All other @code{gdb.Symtab} methods will throw an exception |
| 5237 | if it is invalid at the time the method is called. |
| 5238 | @end defun |
| 5239 | |
| 5240 | @defun Symtab.fullname () |
| 5241 | Return the symbol table's source absolute file name. |
| 5242 | @end defun |
| 5243 | |
| 5244 | @defun Symtab.global_block () |
| 5245 | Return the global block of the underlying symbol table. |
| 5246 | @xref{Blocks In Python}. |
| 5247 | @end defun |
| 5248 | |
| 5249 | @defun Symtab.static_block () |
| 5250 | Return the static block of the underlying symbol table. |
| 5251 | @xref{Blocks In Python}. |
| 5252 | @end defun |
| 5253 | |
| 5254 | @defun Symtab.linetable () |
| 5255 | Return the line table associated with the symbol table. |
| 5256 | @xref{Line Tables In Python}. |
| 5257 | @end defun |
| 5258 | |
| 5259 | @node Line Tables In Python |
| 5260 | @subsubsection Manipulating line tables using Python |
| 5261 | |
| 5262 | @cindex line tables in python |
| 5263 | @tindex gdb.LineTable |
| 5264 | |
| 5265 | Python code can request and inspect line table information from a |
| 5266 | symbol table that is loaded in @value{GDBN}. A line table is a |
| 5267 | mapping of source lines to their executable locations in memory. To |
| 5268 | acquire the line table information for a particular symbol table, use |
| 5269 | the @code{linetable} function (@pxref{Symbol Tables In Python}). |
| 5270 | |
| 5271 | A @code{gdb.LineTable} is iterable. The iterator returns |
| 5272 | @code{LineTableEntry} objects that correspond to the source line and |
| 5273 | address for each line table entry. @code{LineTableEntry} objects have |
| 5274 | the following attributes: |
| 5275 | |
| 5276 | @defvar LineTableEntry.line |
| 5277 | The source line number for this line table entry. This number |
| 5278 | corresponds to the actual line of source. This attribute is not |
| 5279 | writable. |
| 5280 | @end defvar |
| 5281 | |
| 5282 | @defvar LineTableEntry.pc |
| 5283 | The address that is associated with the line table entry where the |
| 5284 | executable code for that source line resides in memory. This |
| 5285 | attribute is not writable. |
| 5286 | @end defvar |
| 5287 | |
| 5288 | As there can be multiple addresses for a single source line, you may |
| 5289 | receive multiple @code{LineTableEntry} objects with matching |
| 5290 | @code{line} attributes, but with different @code{pc} attributes. The |
| 5291 | iterator is sorted in ascending @code{pc} order. Here is a small |
| 5292 | example illustrating iterating over a line table. |
| 5293 | |
| 5294 | @smallexample |
| 5295 | symtab = gdb.selected_frame().find_sal().symtab |
| 5296 | linetable = symtab.linetable() |
| 5297 | for line in linetable: |
| 5298 | print ("Line: "+str(line.line)+" Address: "+hex(line.pc)) |
| 5299 | @end smallexample |
| 5300 | |
| 5301 | This will have the following output: |
| 5302 | |
| 5303 | @smallexample |
| 5304 | Line: 33 Address: 0x4005c8L |
| 5305 | Line: 37 Address: 0x4005caL |
| 5306 | Line: 39 Address: 0x4005d2L |
| 5307 | Line: 40 Address: 0x4005f8L |
| 5308 | Line: 42 Address: 0x4005ffL |
| 5309 | Line: 44 Address: 0x400608L |
| 5310 | Line: 42 Address: 0x40060cL |
| 5311 | Line: 45 Address: 0x400615L |
| 5312 | @end smallexample |
| 5313 | |
| 5314 | In addition to being able to iterate over a @code{LineTable}, it also |
| 5315 | has the following direct access methods: |
| 5316 | |
| 5317 | @defun LineTable.line (line) |
| 5318 | Return a Python @code{Tuple} of @code{LineTableEntry} objects for any |
| 5319 | entries in the line table for the given @var{line}, which specifies |
| 5320 | the source code line. If there are no entries for that source code |
| 5321 | @var{line}, the Python @code{None} is returned. |
| 5322 | @end defun |
| 5323 | |
| 5324 | @defun LineTable.has_line (line) |
| 5325 | Return a Python @code{Boolean} indicating whether there is an entry in |
| 5326 | the line table for this source line. Return @code{True} if an entry |
| 5327 | is found, or @code{False} if not. |
| 5328 | @end defun |
| 5329 | |
| 5330 | @defun LineTable.source_lines () |
| 5331 | Return a Python @code{List} of the source line numbers in the symbol |
| 5332 | table. Only lines with executable code locations are returned. The |
| 5333 | contents of the @code{List} will just be the source line entries |
| 5334 | represented as Python @code{Long} values. |
| 5335 | @end defun |
| 5336 | |
| 5337 | @node Breakpoints In Python |
| 5338 | @subsubsection Manipulating breakpoints using Python |
| 5339 | |
| 5340 | @cindex breakpoints in python |
| 5341 | @tindex gdb.Breakpoint |
| 5342 | |
| 5343 | Python code can manipulate breakpoints via the @code{gdb.Breakpoint} |
| 5344 | class. |
| 5345 | |
| 5346 | A breakpoint can be created using one of the two forms of the |
| 5347 | @code{gdb.Breakpoint} constructor. The first one accepts a string |
| 5348 | like one would pass to the @code{break} |
| 5349 | (@pxref{Set Breaks,,Setting Breakpoints}) and @code{watch} |
| 5350 | (@pxref{Set Watchpoints, , Setting Watchpoints}) commands, and can be used to |
| 5351 | create both breakpoints and watchpoints. The second accepts separate Python |
| 5352 | arguments similar to @ref{Explicit Locations}, and can only be used to create |
| 5353 | breakpoints. |
| 5354 | |
| 5355 | @defun Breakpoint.__init__ (spec @r{[}, type @r{][}, wp_class @r{][}, internal @r{][}, temporary @r{][}, qualified @r{]}) |
| 5356 | Create a new breakpoint according to @var{spec}, which is a string naming the |
| 5357 | location of a breakpoint, or an expression that defines a watchpoint. The |
| 5358 | string should describe a location in a format recognized by the @code{break} |
| 5359 | command (@pxref{Set Breaks,,Setting Breakpoints}) or, in the case of a |
| 5360 | watchpoint, by the @code{watch} command |
| 5361 | (@pxref{Set Watchpoints, , Setting Watchpoints}). |
| 5362 | |
| 5363 | The optional @var{type} argument specifies the type of the breakpoint to create, |
| 5364 | as defined below. |
| 5365 | |
| 5366 | The optional @var{wp_class} argument defines the class of watchpoint to create, |
| 5367 | if @var{type} is @code{gdb.BP_WATCHPOINT}. If @var{wp_class} is omitted, it |
| 5368 | defaults to @code{gdb.WP_WRITE}. |
| 5369 | |
| 5370 | The optional @var{internal} argument allows the breakpoint to become invisible |
| 5371 | to the user. The breakpoint will neither be reported when created, nor will it |
| 5372 | be listed in the output from @code{info breakpoints} (but will be listed with |
| 5373 | the @code{maint info breakpoints} command). |
| 5374 | |
| 5375 | The optional @var{temporary} argument makes the breakpoint a temporary |
| 5376 | breakpoint. Temporary breakpoints are deleted after they have been hit. Any |
| 5377 | further access to the Python breakpoint after it has been hit will result in a |
| 5378 | runtime error (as that breakpoint has now been automatically deleted). |
| 5379 | |
| 5380 | The optional @var{qualified} argument is a boolean that allows interpreting |
| 5381 | the function passed in @code{spec} as a fully-qualified name. It is equivalent |
| 5382 | to @code{break}'s @code{-qualified} flag (@pxref{Linespec Locations} and |
| 5383 | @ref{Explicit Locations}). |
| 5384 | |
| 5385 | @end defun |
| 5386 | |
| 5387 | @defun Breakpoint.__init__ (@r{[} source @r{][}, function @r{][}, label @r{][}, line @r{]}, @r{][} internal @r{][}, temporary @r{][}, qualified @r{]}) |
| 5388 | This second form of creating a new breakpoint specifies the explicit |
| 5389 | location (@pxref{Explicit Locations}) using keywords. The new breakpoint will |
| 5390 | be created in the specified source file @var{source}, at the specified |
| 5391 | @var{function}, @var{label} and @var{line}. |
| 5392 | |
| 5393 | @var{internal}, @var{temporary} and @var{qualified} have the same usage as |
| 5394 | explained previously. |
| 5395 | @end defun |
| 5396 | |
| 5397 | The available types are represented by constants defined in the @code{gdb} |
| 5398 | module: |
| 5399 | |
| 5400 | @vtable @code |
| 5401 | @vindex BP_BREAKPOINT |
| 5402 | @item gdb.BP_BREAKPOINT |
| 5403 | Normal code breakpoint. |
| 5404 | |
| 5405 | @vindex BP_HARDWARE_BREAKPOINT |
| 5406 | @item gdb.BP_HARDWARE_BREAKPOINT |
| 5407 | Hardware assisted code breakpoint. |
| 5408 | |
| 5409 | @vindex BP_WATCHPOINT |
| 5410 | @item gdb.BP_WATCHPOINT |
| 5411 | Watchpoint breakpoint. |
| 5412 | |
| 5413 | @vindex BP_HARDWARE_WATCHPOINT |
| 5414 | @item gdb.BP_HARDWARE_WATCHPOINT |
| 5415 | Hardware assisted watchpoint. |
| 5416 | |
| 5417 | @vindex BP_READ_WATCHPOINT |
| 5418 | @item gdb.BP_READ_WATCHPOINT |
| 5419 | Hardware assisted read watchpoint. |
| 5420 | |
| 5421 | @vindex BP_ACCESS_WATCHPOINT |
| 5422 | @item gdb.BP_ACCESS_WATCHPOINT |
| 5423 | Hardware assisted access watchpoint. |
| 5424 | @end vtable |
| 5425 | |
| 5426 | The available watchpoint types represented by constants are defined in the |
| 5427 | @code{gdb} module: |
| 5428 | |
| 5429 | @vtable @code |
| 5430 | @vindex WP_READ |
| 5431 | @item gdb.WP_READ |
| 5432 | Read only watchpoint. |
| 5433 | |
| 5434 | @vindex WP_WRITE |
| 5435 | @item gdb.WP_WRITE |
| 5436 | Write only watchpoint. |
| 5437 | |
| 5438 | @vindex WP_ACCESS |
| 5439 | @item gdb.WP_ACCESS |
| 5440 | Read/Write watchpoint. |
| 5441 | @end vtable |
| 5442 | |
| 5443 | @defun Breakpoint.stop (self) |
| 5444 | The @code{gdb.Breakpoint} class can be sub-classed and, in |
| 5445 | particular, you may choose to implement the @code{stop} method. |
| 5446 | If this method is defined in a sub-class of @code{gdb.Breakpoint}, |
| 5447 | it will be called when the inferior reaches any location of a |
| 5448 | breakpoint which instantiates that sub-class. If the method returns |
| 5449 | @code{True}, the inferior will be stopped at the location of the |
| 5450 | breakpoint, otherwise the inferior will continue. |
| 5451 | |
| 5452 | If there are multiple breakpoints at the same location with a |
| 5453 | @code{stop} method, each one will be called regardless of the |
| 5454 | return status of the previous. This ensures that all @code{stop} |
| 5455 | methods have a chance to execute at that location. In this scenario |
| 5456 | if one of the methods returns @code{True} but the others return |
| 5457 | @code{False}, the inferior will still be stopped. |
| 5458 | |
| 5459 | You should not alter the execution state of the inferior (i.e.@:, step, |
| 5460 | next, etc.), alter the current frame context (i.e.@:, change the current |
| 5461 | active frame), or alter, add or delete any breakpoint. As a general |
| 5462 | rule, you should not alter any data within @value{GDBN} or the inferior |
| 5463 | at this time. |
| 5464 | |
| 5465 | Example @code{stop} implementation: |
| 5466 | |
| 5467 | @smallexample |
| 5468 | class MyBreakpoint (gdb.Breakpoint): |
| 5469 | def stop (self): |
| 5470 | inf_val = gdb.parse_and_eval("foo") |
| 5471 | if inf_val == 3: |
| 5472 | return True |
| 5473 | return False |
| 5474 | @end smallexample |
| 5475 | @end defun |
| 5476 | |
| 5477 | @defun Breakpoint.is_valid () |
| 5478 | Return @code{True} if this @code{Breakpoint} object is valid, |
| 5479 | @code{False} otherwise. A @code{Breakpoint} object can become invalid |
| 5480 | if the user deletes the breakpoint. In this case, the object still |
| 5481 | exists, but the underlying breakpoint does not. In the cases of |
| 5482 | watchpoint scope, the watchpoint remains valid even if execution of the |
| 5483 | inferior leaves the scope of that watchpoint. |
| 5484 | @end defun |
| 5485 | |
| 5486 | @defun Breakpoint.delete () |
| 5487 | Permanently deletes the @value{GDBN} breakpoint. This also |
| 5488 | invalidates the Python @code{Breakpoint} object. Any further access |
| 5489 | to this object's attributes or methods will raise an error. |
| 5490 | @end defun |
| 5491 | |
| 5492 | @defvar Breakpoint.enabled |
| 5493 | This attribute is @code{True} if the breakpoint is enabled, and |
| 5494 | @code{False} otherwise. This attribute is writable. You can use it to enable |
| 5495 | or disable the breakpoint. |
| 5496 | @end defvar |
| 5497 | |
| 5498 | @defvar Breakpoint.silent |
| 5499 | This attribute is @code{True} if the breakpoint is silent, and |
| 5500 | @code{False} otherwise. This attribute is writable. |
| 5501 | |
| 5502 | Note that a breakpoint can also be silent if it has commands and the |
| 5503 | first command is @code{silent}. This is not reported by the |
| 5504 | @code{silent} attribute. |
| 5505 | @end defvar |
| 5506 | |
| 5507 | @defvar Breakpoint.pending |
| 5508 | This attribute is @code{True} if the breakpoint is pending, and |
| 5509 | @code{False} otherwise. @xref{Set Breaks}. This attribute is |
| 5510 | read-only. |
| 5511 | @end defvar |
| 5512 | |
| 5513 | @anchor{python_breakpoint_thread} |
| 5514 | @defvar Breakpoint.thread |
| 5515 | If the breakpoint is thread-specific, this attribute holds the |
| 5516 | thread's global id. If the breakpoint is not thread-specific, this |
| 5517 | attribute is @code{None}. This attribute is writable. |
| 5518 | @end defvar |
| 5519 | |
| 5520 | @defvar Breakpoint.task |
| 5521 | If the breakpoint is Ada task-specific, this attribute holds the Ada task |
| 5522 | id. If the breakpoint is not task-specific (or the underlying |
| 5523 | language is not Ada), this attribute is @code{None}. This attribute |
| 5524 | is writable. |
| 5525 | @end defvar |
| 5526 | |
| 5527 | @defvar Breakpoint.ignore_count |
| 5528 | This attribute holds the ignore count for the breakpoint, an integer. |
| 5529 | This attribute is writable. |
| 5530 | @end defvar |
| 5531 | |
| 5532 | @defvar Breakpoint.number |
| 5533 | This attribute holds the breakpoint's number --- the identifier used by |
| 5534 | the user to manipulate the breakpoint. This attribute is not writable. |
| 5535 | @end defvar |
| 5536 | |
| 5537 | @defvar Breakpoint.type |
| 5538 | This attribute holds the breakpoint's type --- the identifier used to |
| 5539 | determine the actual breakpoint type or use-case. This attribute is not |
| 5540 | writable. |
| 5541 | @end defvar |
| 5542 | |
| 5543 | @defvar Breakpoint.visible |
| 5544 | This attribute tells whether the breakpoint is visible to the user |
| 5545 | when set, or when the @samp{info breakpoints} command is run. This |
| 5546 | attribute is not writable. |
| 5547 | @end defvar |
| 5548 | |
| 5549 | @defvar Breakpoint.temporary |
| 5550 | This attribute indicates whether the breakpoint was created as a |
| 5551 | temporary breakpoint. Temporary breakpoints are automatically deleted |
| 5552 | after that breakpoint has been hit. Access to this attribute, and all |
| 5553 | other attributes and functions other than the @code{is_valid} |
| 5554 | function, will result in an error after the breakpoint has been hit |
| 5555 | (as it has been automatically deleted). This attribute is not |
| 5556 | writable. |
| 5557 | @end defvar |
| 5558 | |
| 5559 | @defvar Breakpoint.hit_count |
| 5560 | This attribute holds the hit count for the breakpoint, an integer. |
| 5561 | This attribute is writable, but currently it can only be set to zero. |
| 5562 | @end defvar |
| 5563 | |
| 5564 | @defvar Breakpoint.location |
| 5565 | This attribute holds the location of the breakpoint, as specified by |
| 5566 | the user. It is a string. If the breakpoint does not have a location |
| 5567 | (that is, it is a watchpoint) the attribute's value is @code{None}. This |
| 5568 | attribute is not writable. |
| 5569 | @end defvar |
| 5570 | |
| 5571 | @defvar Breakpoint.expression |
| 5572 | This attribute holds a breakpoint expression, as specified by |
| 5573 | the user. It is a string. If the breakpoint does not have an |
| 5574 | expression (the breakpoint is not a watchpoint) the attribute's value |
| 5575 | is @code{None}. This attribute is not writable. |
| 5576 | @end defvar |
| 5577 | |
| 5578 | @defvar Breakpoint.condition |
| 5579 | This attribute holds the condition of the breakpoint, as specified by |
| 5580 | the user. It is a string. If there is no condition, this attribute's |
| 5581 | value is @code{None}. This attribute is writable. |
| 5582 | @end defvar |
| 5583 | |
| 5584 | @defvar Breakpoint.commands |
| 5585 | This attribute holds the commands attached to the breakpoint. If |
| 5586 | there are commands, this attribute's value is a string holding all the |
| 5587 | commands, separated by newlines. If there are no commands, this |
| 5588 | attribute is @code{None}. This attribute is writable. |
| 5589 | @end defvar |
| 5590 | |
| 5591 | @node Finish Breakpoints in Python |
| 5592 | @subsubsection Finish Breakpoints |
| 5593 | |
| 5594 | @cindex python finish breakpoints |
| 5595 | @tindex gdb.FinishBreakpoint |
| 5596 | |
| 5597 | A finish breakpoint is a temporary breakpoint set at the return address of |
| 5598 | a frame, based on the @code{finish} command. @code{gdb.FinishBreakpoint} |
| 5599 | extends @code{gdb.Breakpoint}. The underlying breakpoint will be disabled |
| 5600 | and deleted when the execution will run out of the breakpoint scope (i.e.@: |
| 5601 | @code{Breakpoint.stop} or @code{FinishBreakpoint.out_of_scope} triggered). |
| 5602 | Finish breakpoints are thread specific and must be create with the right |
| 5603 | thread selected. |
| 5604 | |
| 5605 | @defun FinishBreakpoint.__init__ (@r{[}frame@r{]} @r{[}, internal@r{]}) |
| 5606 | Create a finish breakpoint at the return address of the @code{gdb.Frame} |
| 5607 | object @var{frame}. If @var{frame} is not provided, this defaults to the |
| 5608 | newest frame. The optional @var{internal} argument allows the breakpoint to |
| 5609 | become invisible to the user. @xref{Breakpoints In Python}, for further |
| 5610 | details about this argument. |
| 5611 | @end defun |
| 5612 | |
| 5613 | @defun FinishBreakpoint.out_of_scope (self) |
| 5614 | In some circumstances (e.g.@: @code{longjmp}, C@t{++} exceptions, @value{GDBN} |
| 5615 | @code{return} command, @dots{}), a function may not properly terminate, and |
| 5616 | thus never hit the finish breakpoint. When @value{GDBN} notices such a |
| 5617 | situation, the @code{out_of_scope} callback will be triggered. |
| 5618 | |
| 5619 | You may want to sub-class @code{gdb.FinishBreakpoint} and override this |
| 5620 | method: |
| 5621 | |
| 5622 | @smallexample |
| 5623 | class MyFinishBreakpoint (gdb.FinishBreakpoint) |
| 5624 | def stop (self): |
| 5625 | print ("normal finish") |
| 5626 | return True |
| 5627 | |
| 5628 | def out_of_scope (): |
| 5629 | print ("abnormal finish") |
| 5630 | @end smallexample |
| 5631 | @end defun |
| 5632 | |
| 5633 | @defvar FinishBreakpoint.return_value |
| 5634 | When @value{GDBN} is stopped at a finish breakpoint and the frame |
| 5635 | used to build the @code{gdb.FinishBreakpoint} object had debug symbols, this |
| 5636 | attribute will contain a @code{gdb.Value} object corresponding to the return |
| 5637 | value of the function. The value will be @code{None} if the function return |
| 5638 | type is @code{void} or if the return value was not computable. This attribute |
| 5639 | is not writable. |
| 5640 | @end defvar |
| 5641 | |
| 5642 | @node Lazy Strings In Python |
| 5643 | @subsubsection Python representation of lazy strings |
| 5644 | |
| 5645 | @cindex lazy strings in python |
| 5646 | @tindex gdb.LazyString |
| 5647 | |
| 5648 | A @dfn{lazy string} is a string whose contents is not retrieved or |
| 5649 | encoded until it is needed. |
| 5650 | |
| 5651 | A @code{gdb.LazyString} is represented in @value{GDBN} as an |
| 5652 | @code{address} that points to a region of memory, an @code{encoding} |
| 5653 | that will be used to encode that region of memory, and a @code{length} |
| 5654 | to delimit the region of memory that represents the string. The |
| 5655 | difference between a @code{gdb.LazyString} and a string wrapped within |
| 5656 | a @code{gdb.Value} is that a @code{gdb.LazyString} will be treated |
| 5657 | differently by @value{GDBN} when printing. A @code{gdb.LazyString} is |
| 5658 | retrieved and encoded during printing, while a @code{gdb.Value} |
| 5659 | wrapping a string is immediately retrieved and encoded on creation. |
| 5660 | |
| 5661 | A @code{gdb.LazyString} object has the following functions: |
| 5662 | |
| 5663 | @defun LazyString.value () |
| 5664 | Convert the @code{gdb.LazyString} to a @code{gdb.Value}. This value |
| 5665 | will point to the string in memory, but will lose all the delayed |
| 5666 | retrieval, encoding and handling that @value{GDBN} applies to a |
| 5667 | @code{gdb.LazyString}. |
| 5668 | @end defun |
| 5669 | |
| 5670 | @defvar LazyString.address |
| 5671 | This attribute holds the address of the string. This attribute is not |
| 5672 | writable. |
| 5673 | @end defvar |
| 5674 | |
| 5675 | @defvar LazyString.length |
| 5676 | This attribute holds the length of the string in characters. If the |
| 5677 | length is -1, then the string will be fetched and encoded up to the |
| 5678 | first null of appropriate width. This attribute is not writable. |
| 5679 | @end defvar |
| 5680 | |
| 5681 | @defvar LazyString.encoding |
| 5682 | This attribute holds the encoding that will be applied to the string |
| 5683 | when the string is printed by @value{GDBN}. If the encoding is not |
| 5684 | set, or contains an empty string, then @value{GDBN} will select the |
| 5685 | most appropriate encoding when the string is printed. This attribute |
| 5686 | is not writable. |
| 5687 | @end defvar |
| 5688 | |
| 5689 | @defvar LazyString.type |
| 5690 | This attribute holds the type that is represented by the lazy string's |
| 5691 | type. For a lazy string this is a pointer or array type. To |
| 5692 | resolve this to the lazy string's character type, use the type's |
| 5693 | @code{target} method. @xref{Types In Python}. This attribute is not |
| 5694 | writable. |
| 5695 | @end defvar |
| 5696 | |
| 5697 | @node Architectures In Python |
| 5698 | @subsubsection Python representation of architectures |
| 5699 | @cindex Python architectures |
| 5700 | |
| 5701 | @value{GDBN} uses architecture specific parameters and artifacts in a |
| 5702 | number of its various computations. An architecture is represented |
| 5703 | by an instance of the @code{gdb.Architecture} class. |
| 5704 | |
| 5705 | A @code{gdb.Architecture} class has the following methods: |
| 5706 | |
| 5707 | @defun Architecture.name () |
| 5708 | Return the name (string value) of the architecture. |
| 5709 | @end defun |
| 5710 | |
| 5711 | @defun Architecture.disassemble (@var{start_pc} @r{[}, @var{end_pc} @r{[}, @var{count}@r{]]}) |
| 5712 | Return a list of disassembled instructions starting from the memory |
| 5713 | address @var{start_pc}. The optional arguments @var{end_pc} and |
| 5714 | @var{count} determine the number of instructions in the returned list. |
| 5715 | If both the optional arguments @var{end_pc} and @var{count} are |
| 5716 | specified, then a list of at most @var{count} disassembled instructions |
| 5717 | whose start address falls in the closed memory address interval from |
| 5718 | @var{start_pc} to @var{end_pc} are returned. If @var{end_pc} is not |
| 5719 | specified, but @var{count} is specified, then @var{count} number of |
| 5720 | instructions starting from the address @var{start_pc} are returned. If |
| 5721 | @var{count} is not specified but @var{end_pc} is specified, then all |
| 5722 | instructions whose start address falls in the closed memory address |
| 5723 | interval from @var{start_pc} to @var{end_pc} are returned. If neither |
| 5724 | @var{end_pc} nor @var{count} are specified, then a single instruction at |
| 5725 | @var{start_pc} is returned. For all of these cases, each element of the |
| 5726 | returned list is a Python @code{dict} with the following string keys: |
| 5727 | |
| 5728 | @table @code |
| 5729 | |
| 5730 | @item addr |
| 5731 | The value corresponding to this key is a Python long integer capturing |
| 5732 | the memory address of the instruction. |
| 5733 | |
| 5734 | @item asm |
| 5735 | The value corresponding to this key is a string value which represents |
| 5736 | the instruction with assembly language mnemonics. The assembly |
| 5737 | language flavor used is the same as that specified by the current CLI |
| 5738 | variable @code{disassembly-flavor}. @xref{Machine Code}. |
| 5739 | |
| 5740 | @item length |
| 5741 | The value corresponding to this key is the length (integer value) of the |
| 5742 | instruction in bytes. |
| 5743 | |
| 5744 | @end table |
| 5745 | @end defun |
| 5746 | |
| 5747 | @anchor{gdbpy_architecture_registers} |
| 5748 | @defun Architecture.registers (@r{[} @var{reggroup} @r{]}) |
| 5749 | Return a @code{gdb.RegisterDescriptorIterator} (@pxref{Registers In |
| 5750 | Python}) for all of the registers in @var{reggroup}, a string that is |
| 5751 | the name of a register group. If @var{reggroup} is omitted, or is the |
| 5752 | empty string, then the register group @samp{all} is assumed. |
| 5753 | @end defun |
| 5754 | |
| 5755 | @anchor{gdbpy_architecture_reggroups} |
| 5756 | @defun Architecture.register_groups () |
| 5757 | Return a @code{gdb.RegisterGroupsIterator} (@pxref{Registers In |
| 5758 | Python}) for all of the register groups available for the |
| 5759 | @code{gdb.Architecture}. |
| 5760 | @end defun |
| 5761 | |
| 5762 | @node Registers In Python |
| 5763 | @subsubsection Registers In Python |
| 5764 | @cindex Registers In Python |
| 5765 | |
| 5766 | Python code can request from a @code{gdb.Architecture} information |
| 5767 | about the set of registers available |
| 5768 | (@pxref{gdbpy_architecture_registers,,@code{Architecture.registers}}). |
| 5769 | The register information is returned as a |
| 5770 | @code{gdb.RegisterDescriptorIterator}, which is an iterator that in |
| 5771 | turn returns @code{gdb.RegisterDescriptor} objects. |
| 5772 | |
| 5773 | A @code{gdb.RegisterDescriptor} does not provide the value of a |
| 5774 | register (@pxref{gdbpy_frame_read_register,,@code{Frame.read_register}} |
| 5775 | for reading a register's value), instead the @code{RegisterDescriptor} |
| 5776 | is a way to discover which registers are available for a particular |
| 5777 | architecture. |
| 5778 | |
| 5779 | A @code{gdb.RegisterDescriptor} has the following read-only properties: |
| 5780 | |
| 5781 | @defvar RegisterDescriptor.name |
| 5782 | The name of this register. |
| 5783 | @end defvar |
| 5784 | |
| 5785 | It is also possible to lookup a register descriptor based on its name |
| 5786 | using the following @code{gdb.RegisterDescriptorIterator} function: |
| 5787 | |
| 5788 | @defun RegisterDescriptorIterator.find (@var{name}) |
| 5789 | Takes @var{name} as an argument, which must be a string, and returns a |
| 5790 | @code{gdb.RegisterDescriptor} for the register with that name, or |
| 5791 | @code{None} if there is no register with that name. |
| 5792 | @end defun |
| 5793 | |
| 5794 | Python code can also request from a @code{gdb.Architecture} |
| 5795 | information about the set of register groups available on a given |
| 5796 | architecture |
| 5797 | (@pxref{gdbpy_architecture_reggroups,,@code{Architecture.register_groups}}). |
| 5798 | |
| 5799 | Every register can be a member of zero or more register groups. Some |
| 5800 | register groups are used internally within @value{GDBN} to control |
| 5801 | things like which registers must be saved when calling into the |
| 5802 | program being debugged (@pxref{Calling,,Calling Program Functions}). |
| 5803 | Other register groups exist to allow users to easily see related sets |
| 5804 | of registers in commands like @code{info registers} |
| 5805 | (@pxref{info_registers_reggroup,,@code{info registers |
| 5806 | @var{reggroup}}}). |
| 5807 | |
| 5808 | The register groups information is returned as a |
| 5809 | @code{gdb.RegisterGroupsIterator}, which is an iterator that in turn |
| 5810 | returns @code{gdb.RegisterGroup} objects. |
| 5811 | |
| 5812 | A @code{gdb.RegisterGroup} object has the following read-only |
| 5813 | properties: |
| 5814 | |
| 5815 | @defvar RegisterGroup.name |
| 5816 | A string that is the name of this register group. |
| 5817 | @end defvar |
| 5818 | |
| 5819 | @node TUI Windows In Python |
| 5820 | @subsubsection Implementing new TUI windows |
| 5821 | @cindex Python TUI Windows |
| 5822 | |
| 5823 | New TUI (@pxref{TUI}) windows can be implemented in Python. |
| 5824 | |
| 5825 | @findex gdb.register_window_type |
| 5826 | @defun gdb.register_window_type (@var{name}, @var{factory}) |
| 5827 | Because TUI windows are created and destroyed depending on the layout |
| 5828 | the user chooses, new window types are implemented by registering a |
| 5829 | factory function with @value{GDBN}. |
| 5830 | |
| 5831 | @var{name} is the name of the new window. It's an error to try to |
| 5832 | replace one of the built-in windows, but other window types can be |
| 5833 | replaced. |
| 5834 | |
| 5835 | @var{function} is a factory function that is called to create the TUI |
| 5836 | window. This is called with a single argument of type |
| 5837 | @code{gdb.TuiWindow}, described below. It should return an object |
| 5838 | that implements the TUI window protocol, also described below. |
| 5839 | @end defun |
| 5840 | |
| 5841 | As mentioned above, when a factory function is called, it is passed |
| 5842 | an object of type @code{gdb.TuiWindow}. This object has these |
| 5843 | methods and attributes: |
| 5844 | |
| 5845 | @defun TuiWindow.is_valid () |
| 5846 | This method returns @code{True} when this window is valid. When the |
| 5847 | user changes the TUI layout, windows no longer visible in the new |
| 5848 | layout will be destroyed. At this point, the @code{gdb.TuiWindow} |
| 5849 | will no longer be valid, and methods (and attributes) other than |
| 5850 | @code{is_valid} will throw an exception. |
| 5851 | |
| 5852 | When the TUI is disabled using @code{tui disable} (@pxref{TUI |
| 5853 | Commands,,tui disable}) the window is hidden rather than destroyed, |
| 5854 | but @code{is_valid} will still return @code{False} and other methods |
| 5855 | (and attributes) will still throw an exception. |
| 5856 | @end defun |
| 5857 | |
| 5858 | @defvar TuiWindow.width |
| 5859 | This attribute holds the width of the window. It is not writable. |
| 5860 | @end defvar |
| 5861 | |
| 5862 | @defvar TuiWindow.height |
| 5863 | This attribute holds the height of the window. It is not writable. |
| 5864 | @end defvar |
| 5865 | |
| 5866 | @defvar TuiWindow.title |
| 5867 | This attribute holds the window's title, a string. This is normally |
| 5868 | displayed above the window. This attribute can be modified. |
| 5869 | @end defvar |
| 5870 | |
| 5871 | @defun TuiWindow.erase () |
| 5872 | Remove all the contents of the window. |
| 5873 | @end defun |
| 5874 | |
| 5875 | @defun TuiWindow.write (@var{string}) |
| 5876 | Write @var{string} to the window. @var{string} can contain ANSI |
| 5877 | terminal escape styling sequences; @value{GDBN} will translate these |
| 5878 | as appropriate for the terminal. |
| 5879 | @end defun |
| 5880 | |
| 5881 | The factory function that you supply should return an object |
| 5882 | conforming to the TUI window protocol. These are the method that can |
| 5883 | be called on this object, which is referred to below as the ``window |
| 5884 | object''. The methods documented below are optional; if the object |
| 5885 | does not implement one of these methods, @value{GDBN} will not attempt |
| 5886 | to call it. Additional new methods may be added to the window |
| 5887 | protocol in the future. @value{GDBN} guarantees that they will begin |
| 5888 | with a lower-case letter, so you can start implementation methods with |
| 5889 | upper-case letters or underscore to avoid any future conflicts. |
| 5890 | |
| 5891 | @defun Window.close () |
| 5892 | When the TUI window is closed, the @code{gdb.TuiWindow} object will be |
| 5893 | put into an invalid state. At this time, @value{GDBN} will call |
| 5894 | @code{close} method on the window object. |
| 5895 | |
| 5896 | After this method is called, @value{GDBN} will discard any references |
| 5897 | it holds on this window object, and will no longer call methods on |
| 5898 | this object. |
| 5899 | @end defun |
| 5900 | |
| 5901 | @defun Window.render () |
| 5902 | In some situations, a TUI window can change size. For example, this |
| 5903 | can happen if the user resizes the terminal, or changes the layout. |
| 5904 | When this happens, @value{GDBN} will call the @code{render} method on |
| 5905 | the window object. |
| 5906 | |
| 5907 | If your window is intended to update in response to changes in the |
| 5908 | inferior, you will probably also want to register event listeners and |
| 5909 | send output to the @code{gdb.TuiWindow}. |
| 5910 | @end defun |
| 5911 | |
| 5912 | @defun Window.hscroll (@var{num}) |
| 5913 | This is a request to scroll the window horizontally. @var{num} is the |
| 5914 | amount by which to scroll, with negative numbers meaning to scroll |
| 5915 | right. In the TUI model, it is the viewport that moves, not the |
| 5916 | contents. A positive argument should cause the viewport to move |
| 5917 | right, and so the content should appear to move to the left. |
| 5918 | @end defun |
| 5919 | |
| 5920 | @defun Window.vscroll (@var{num}) |
| 5921 | This is a request to scroll the window vertically. @var{num} is the |
| 5922 | amount by which to scroll, with negative numbers meaning to scroll |
| 5923 | backward. In the TUI model, it is the viewport that moves, not the |
| 5924 | contents. A positive argument should cause the viewport to move down, |
| 5925 | and so the content should appear to move up. |
| 5926 | @end defun |
| 5927 | |
| 5928 | @node Python Auto-loading |
| 5929 | @subsection Python Auto-loading |
| 5930 | @cindex Python auto-loading |
| 5931 | |
| 5932 | When a new object file is read (for example, due to the @code{file} |
| 5933 | command, or because the inferior has loaded a shared library), |
| 5934 | @value{GDBN} will look for Python support scripts in several ways: |
| 5935 | @file{@var{objfile}-gdb.py} and @code{.debug_gdb_scripts} section. |
| 5936 | @xref{Auto-loading extensions}. |
| 5937 | |
| 5938 | The auto-loading feature is useful for supplying application-specific |
| 5939 | debugging commands and scripts. |
| 5940 | |
| 5941 | Auto-loading can be enabled or disabled, |
| 5942 | and the list of auto-loaded scripts can be printed. |
| 5943 | |
| 5944 | @table @code |
| 5945 | @anchor{set auto-load python-scripts} |
| 5946 | @kindex set auto-load python-scripts |
| 5947 | @item set auto-load python-scripts [on|off] |
| 5948 | Enable or disable the auto-loading of Python scripts. |
| 5949 | |
| 5950 | @anchor{show auto-load python-scripts} |
| 5951 | @kindex show auto-load python-scripts |
| 5952 | @item show auto-load python-scripts |
| 5953 | Show whether auto-loading of Python scripts is enabled or disabled. |
| 5954 | |
| 5955 | @anchor{info auto-load python-scripts} |
| 5956 | @kindex info auto-load python-scripts |
| 5957 | @cindex print list of auto-loaded Python scripts |
| 5958 | @item info auto-load python-scripts [@var{regexp}] |
| 5959 | Print the list of all Python scripts that @value{GDBN} auto-loaded. |
| 5960 | |
| 5961 | Also printed is the list of Python scripts that were mentioned in |
| 5962 | the @code{.debug_gdb_scripts} section and were either not found |
| 5963 | (@pxref{dotdebug_gdb_scripts section}) or were not auto-loaded due to |
| 5964 | @code{auto-load safe-path} rejection (@pxref{Auto-loading}). |
| 5965 | This is useful because their names are not printed when @value{GDBN} |
| 5966 | tries to load them and fails. There may be many of them, and printing |
| 5967 | an error message for each one is problematic. |
| 5968 | |
| 5969 | If @var{regexp} is supplied only Python scripts with matching names are printed. |
| 5970 | |
| 5971 | Example: |
| 5972 | |
| 5973 | @smallexample |
| 5974 | (gdb) info auto-load python-scripts |
| 5975 | Loaded Script |
| 5976 | Yes py-section-script.py |
| 5977 | full name: /tmp/py-section-script.py |
| 5978 | No my-foo-pretty-printers.py |
| 5979 | @end smallexample |
| 5980 | @end table |
| 5981 | |
| 5982 | When reading an auto-loaded file or script, @value{GDBN} sets the |
| 5983 | @dfn{current objfile}. This is available via the @code{gdb.current_objfile} |
| 5984 | function (@pxref{Objfiles In Python}). This can be useful for |
| 5985 | registering objfile-specific pretty-printers and frame-filters. |
| 5986 | |
| 5987 | @node Python modules |
| 5988 | @subsection Python modules |
| 5989 | @cindex python modules |
| 5990 | |
| 5991 | @value{GDBN} comes with several modules to assist writing Python code. |
| 5992 | |
| 5993 | @menu |
| 5994 | * gdb.printing:: Building and registering pretty-printers. |
| 5995 | * gdb.types:: Utilities for working with types. |
| 5996 | * gdb.prompt:: Utilities for prompt value substitution. |
| 5997 | @end menu |
| 5998 | |
| 5999 | @node gdb.printing |
| 6000 | @subsubsection gdb.printing |
| 6001 | @cindex gdb.printing |
| 6002 | |
| 6003 | This module provides a collection of utilities for working with |
| 6004 | pretty-printers. |
| 6005 | |
| 6006 | @table @code |
| 6007 | @item PrettyPrinter (@var{name}, @var{subprinters}=None) |
| 6008 | This class specifies the API that makes @samp{info pretty-printer}, |
| 6009 | @samp{enable pretty-printer} and @samp{disable pretty-printer} work. |
| 6010 | Pretty-printers should generally inherit from this class. |
| 6011 | |
| 6012 | @item SubPrettyPrinter (@var{name}) |
| 6013 | For printers that handle multiple types, this class specifies the |
| 6014 | corresponding API for the subprinters. |
| 6015 | |
| 6016 | @item RegexpCollectionPrettyPrinter (@var{name}) |
| 6017 | Utility class for handling multiple printers, all recognized via |
| 6018 | regular expressions. |
| 6019 | @xref{Writing a Pretty-Printer}, for an example. |
| 6020 | |
| 6021 | @item FlagEnumerationPrinter (@var{name}) |
| 6022 | A pretty-printer which handles printing of @code{enum} values. Unlike |
| 6023 | @value{GDBN}'s built-in @code{enum} printing, this printer attempts to |
| 6024 | work properly when there is some overlap between the enumeration |
| 6025 | constants. The argument @var{name} is the name of the printer and |
| 6026 | also the name of the @code{enum} type to look up. |
| 6027 | |
| 6028 | @item register_pretty_printer (@var{obj}, @var{printer}, @var{replace}=False) |
| 6029 | Register @var{printer} with the pretty-printer list of @var{obj}. |
| 6030 | If @var{replace} is @code{True} then any existing copy of the printer |
| 6031 | is replaced. Otherwise a @code{RuntimeError} exception is raised |
| 6032 | if a printer with the same name already exists. |
| 6033 | @end table |
| 6034 | |
| 6035 | @node gdb.types |
| 6036 | @subsubsection gdb.types |
| 6037 | @cindex gdb.types |
| 6038 | |
| 6039 | This module provides a collection of utilities for working with |
| 6040 | @code{gdb.Type} objects. |
| 6041 | |
| 6042 | @table @code |
| 6043 | @item get_basic_type (@var{type}) |
| 6044 | Return @var{type} with const and volatile qualifiers stripped, |
| 6045 | and with typedefs and C@t{++} references converted to the underlying type. |
| 6046 | |
| 6047 | C@t{++} example: |
| 6048 | |
| 6049 | @smallexample |
| 6050 | typedef const int const_int; |
| 6051 | const_int foo (3); |
| 6052 | const_int& foo_ref (foo); |
| 6053 | int main () @{ return 0; @} |
| 6054 | @end smallexample |
| 6055 | |
| 6056 | Then in gdb: |
| 6057 | |
| 6058 | @smallexample |
| 6059 | (gdb) start |
| 6060 | (gdb) python import gdb.types |
| 6061 | (gdb) python foo_ref = gdb.parse_and_eval("foo_ref") |
| 6062 | (gdb) python print gdb.types.get_basic_type(foo_ref.type) |
| 6063 | int |
| 6064 | @end smallexample |
| 6065 | |
| 6066 | @item has_field (@var{type}, @var{field}) |
| 6067 | Return @code{True} if @var{type}, assumed to be a type with fields |
| 6068 | (e.g., a structure or union), has field @var{field}. |
| 6069 | |
| 6070 | @item make_enum_dict (@var{enum_type}) |
| 6071 | Return a Python @code{dictionary} type produced from @var{enum_type}. |
| 6072 | |
| 6073 | @item deep_items (@var{type}) |
| 6074 | Returns a Python iterator similar to the standard |
| 6075 | @code{gdb.Type.iteritems} method, except that the iterator returned |
| 6076 | by @code{deep_items} will recursively traverse anonymous struct or |
| 6077 | union fields. For example: |
| 6078 | |
| 6079 | @smallexample |
| 6080 | struct A |
| 6081 | @{ |
| 6082 | int a; |
| 6083 | union @{ |
| 6084 | int b0; |
| 6085 | int b1; |
| 6086 | @}; |
| 6087 | @}; |
| 6088 | @end smallexample |
| 6089 | |
| 6090 | @noindent |
| 6091 | Then in @value{GDBN}: |
| 6092 | @smallexample |
| 6093 | (@value{GDBP}) python import gdb.types |
| 6094 | (@value{GDBP}) python struct_a = gdb.lookup_type("struct A") |
| 6095 | (@value{GDBP}) python print struct_a.keys () |
| 6096 | @{['a', '']@} |
| 6097 | (@value{GDBP}) python print [k for k,v in gdb.types.deep_items(struct_a)] |
| 6098 | @{['a', 'b0', 'b1']@} |
| 6099 | @end smallexample |
| 6100 | |
| 6101 | @item get_type_recognizers () |
| 6102 | Return a list of the enabled type recognizers for the current context. |
| 6103 | This is called by @value{GDBN} during the type-printing process |
| 6104 | (@pxref{Type Printing API}). |
| 6105 | |
| 6106 | @item apply_type_recognizers (recognizers, type_obj) |
| 6107 | Apply the type recognizers, @var{recognizers}, to the type object |
| 6108 | @var{type_obj}. If any recognizer returns a string, return that |
| 6109 | string. Otherwise, return @code{None}. This is called by |
| 6110 | @value{GDBN} during the type-printing process (@pxref{Type Printing |
| 6111 | API}). |
| 6112 | |
| 6113 | @item register_type_printer (locus, printer) |
| 6114 | This is a convenience function to register a type printer |
| 6115 | @var{printer}. The printer must implement the type printer protocol. |
| 6116 | The @var{locus} argument is either a @code{gdb.Objfile}, in which case |
| 6117 | the printer is registered with that objfile; a @code{gdb.Progspace}, |
| 6118 | in which case the printer is registered with that progspace; or |
| 6119 | @code{None}, in which case the printer is registered globally. |
| 6120 | |
| 6121 | @item TypePrinter |
| 6122 | This is a base class that implements the type printer protocol. Type |
| 6123 | printers are encouraged, but not required, to derive from this class. |
| 6124 | It defines a constructor: |
| 6125 | |
| 6126 | @defmethod TypePrinter __init__ (self, name) |
| 6127 | Initialize the type printer with the given name. The new printer |
| 6128 | starts in the enabled state. |
| 6129 | @end defmethod |
| 6130 | |
| 6131 | @end table |
| 6132 | |
| 6133 | @node gdb.prompt |
| 6134 | @subsubsection gdb.prompt |
| 6135 | @cindex gdb.prompt |
| 6136 | |
| 6137 | This module provides a method for prompt value-substitution. |
| 6138 | |
| 6139 | @table @code |
| 6140 | @item substitute_prompt (@var{string}) |
| 6141 | Return @var{string} with escape sequences substituted by values. Some |
| 6142 | escape sequences take arguments. You can specify arguments inside |
| 6143 | ``@{@}'' immediately following the escape sequence. |
| 6144 | |
| 6145 | The escape sequences you can pass to this function are: |
| 6146 | |
| 6147 | @table @code |
| 6148 | @item \\ |
| 6149 | Substitute a backslash. |
| 6150 | @item \e |
| 6151 | Substitute an ESC character. |
| 6152 | @item \f |
| 6153 | Substitute the selected frame; an argument names a frame parameter. |
| 6154 | @item \n |
| 6155 | Substitute a newline. |
| 6156 | @item \p |
| 6157 | Substitute a parameter's value; the argument names the parameter. |
| 6158 | @item \r |
| 6159 | Substitute a carriage return. |
| 6160 | @item \t |
| 6161 | Substitute the selected thread; an argument names a thread parameter. |
| 6162 | @item \v |
| 6163 | Substitute the version of GDB. |
| 6164 | @item \w |
| 6165 | Substitute the current working directory. |
| 6166 | @item \[ |
| 6167 | Begin a sequence of non-printing characters. These sequences are |
| 6168 | typically used with the ESC character, and are not counted in the string |
| 6169 | length. Example: ``\[\e[0;34m\](gdb)\[\e[0m\]'' will return a |
| 6170 | blue-colored ``(gdb)'' prompt where the length is five. |
| 6171 | @item \] |
| 6172 | End a sequence of non-printing characters. |
| 6173 | @end table |
| 6174 | |
| 6175 | For example: |
| 6176 | |
| 6177 | @smallexample |
| 6178 | substitute_prompt ("frame: \f, args: \p@{print frame-arguments@}") |
| 6179 | @end smallexample |
| 6180 | |
| 6181 | @exdent will return the string: |
| 6182 | |
| 6183 | @smallexample |
| 6184 | "frame: main, args: scalars" |
| 6185 | @end smallexample |
| 6186 | @end table |