This is ./gdb.info, produced by makeinfo version 4.0b from gdb.texinfo. INFO-DIR-SECTION Programming & development tools. START-INFO-DIR-ENTRY * Gdb: (gdb). The GNU debugger. END-INFO-DIR-ENTRY This file documents the GNU debugger GDB. This is the Ninth Edition, January 2002, of `Debugging with GDB: the GNU Source-Level Debugger' for GDB Version 5.1.1. Copyright (C) 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1998, 1999, 2000, 2001, 2002 Free Software Foundation, Inc. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.1 or any later version published by the Free Software Foundation; with the Invariant Sections being "Free Software" and "Free Software Needs Free Documentation", with the Front-Cover Texts being "A GNU Manual," and with the Back-Cover Texts as in (a) below. (a) The Free Software Foundation's Back-Cover Text is: "You have freedom to copy and modify this GNU Manual, like GNU software. Copies published by the Free Software Foundation raise funds for GNU development."  File: gdb.info, Node: GDB/MI Output Syntax, Next: GDB/MI Simple Examples, Prev: GDB/MI Input Syntax, Up: GDB/MI Command Syntax GDB/MI Output Syntax -------------------- The output from GDB/MI consists of zero or more out-of-band records followed, optionally, by a single result record. This result record is for the most recent command. The sequence of output records is terminated by `(gdb)'. If an input command was prefixed with a `TOKEN' then the corresponding output for that command will also be prefixed by that same TOKEN. `OUTPUT ==>' `( OUT-OF-BAND-RECORD )* [ RESULT-RECORD ] "(gdb)" NL' `RESULT-RECORD ==>' ` [ TOKEN ] "^" RESULT-CLASS ( "," RESULT )* NL' `OUT-OF-BAND-RECORD ==>' `ASYNC-RECORD | STREAM-RECORD' `ASYNC-RECORD ==>' `EXEC-ASYNC-OUTPUT | STATUS-ASYNC-OUTPUT | NOTIFY-ASYNC-OUTPUT' `EXEC-ASYNC-OUTPUT ==>' `[ TOKEN ] "*" ASYNC-OUTPUT' `STATUS-ASYNC-OUTPUT ==>' `[ TOKEN ] "+" ASYNC-OUTPUT' `NOTIFY-ASYNC-OUTPUT ==>' `[ TOKEN ] "=" ASYNC-OUTPUT' `ASYNC-OUTPUT ==>' `ASYNC-CLASS ( "," RESULT )* NL' `RESULT-CLASS ==>' `"done" | "running" | "connected" | "error" | "exit"' `ASYNC-CLASS ==>' `"stopped" | OTHERS' (where OTHERS will be added depending on the needs--this is still in development). `RESULT ==>' ` VARIABLE "=" VALUE' `VARIABLE ==>' ` STRING ' `VALUE ==>' ` CONST | TUPLE | LIST ' `CONST ==>' `C-STRING' `TUPLE ==>' ` "{}" | "{" RESULT ( "," RESULT )* "}" ' `LIST ==>' ` "[]" | "[" VALUE ( "," VALUE )* "]" | "[" RESULT ( "," RESULT )* "]" ' `STREAM-RECORD ==>' `CONSOLE-STREAM-OUTPUT | TARGET-STREAM-OUTPUT | LOG-STREAM-OUTPUT' `CONSOLE-STREAM-OUTPUT ==>' `"~" C-STRING' `TARGET-STREAM-OUTPUT ==>' `"@" C-STRING' `LOG-STREAM-OUTPUT ==>' `"&" C-STRING' `NL ==>' `CR | CR-LF' `TOKEN ==>' _any sequence of digits_. Notes: * All output sequences end in a single line containing a period. * The `TOKEN' is from the corresponding request. If an execution command is interrupted by the `-exec-interrupt' command, the TOKEN associated with the `*stopped' message is the one of the original execution command, not the one of the interrupt command. * STATUS-ASYNC-OUTPUT contains on-going status information about the progress of a slow operation. It can be discarded. All status output is prefixed by `+'. * EXEC-ASYNC-OUTPUT contains asynchronous state change on the target (stopped, started, disappeared). All async output is prefixed by `*'. * NOTIFY-ASYNC-OUTPUT contains supplementary information that the client should handle (e.g., a new breakpoint information). All notify output is prefixed by `='. * CONSOLE-STREAM-OUTPUT is output that should be displayed as is in the console. It is the textual response to a CLI command. All the console output is prefixed by `~'. * TARGET-STREAM-OUTPUT is the output produced by the target program. All the target output is prefixed by `@'. * LOG-STREAM-OUTPUT is output text coming from GDB's internals, for instance messages that should be displayed as part of an error log. All the log output is prefixed by `&'. * New GDB/MI commands should only output LISTS containing VALUES. *Note GDB/MI Stream Records: GDB/MI Stream Records, for more details about the various output records.  File: gdb.info, Node: GDB/MI Simple Examples, Prev: GDB/MI Output Syntax, Up: GDB/MI Command Syntax Simple Examples of GDB/MI Interaction ------------------------------------- This subsection presents several simple examples of interaction using the GDB/MI interface. In these examples, `->' means that the following line is passed to GDB/MI as input, while `<-' means the output received from GDB/MI. Target Stop ........... Here's an example of stopping the inferior process: -> -stop <- (gdb) and later: <- *stop,reason="stop",address="0x123",source="a.c:123" <- (gdb) Simple CLI Command .................. Here's an example of a simple CLI command being passed through GDB/MI and on to the CLI. -> print 1+2 <- ~3\n <- (gdb) Command With Side Effects ......................... -> -symbol-file xyz.exe <- *breakpoint,nr="3",address="0x123",source="a.c:123" <- (gdb) A Bad Command ............. Here's what happens if you pass a non-existent command: -> -rubbish <- error,"Rubbish not found" <- (gdb)  File: gdb.info, Node: GDB/MI Compatibility with CLI, Next: GDB/MI Output Records, Prev: GDB/MI Command Syntax, Up: GDB/MI GDB/MI Compatibility with CLI ============================= To help users familiar with GDB's existing CLI interface, GDB/MI accepts existing CLI commands. As specified by the syntax, such commands can be directly entered into the GDB/MI interface and GDB will respond. This mechanism is provided as an aid to developers of GDB/MI clients and not as a reliable interface into the CLI. Since the command is being interpreteted in an environment that assumes GDB/MI behaviour, the exact output of such commands is likely to end up being an un-supported hybrid of GDB/MI and CLI output.  File: gdb.info, Node: GDB/MI Output Records, Next: GDB/MI Command Description Format, Prev: GDB/MI Compatibility with CLI, Up: GDB/MI GDB/MI Output Records ===================== * Menu: * GDB/MI Result Records:: * GDB/MI Stream Records:: * GDB/MI Out-of-band Records::  File: gdb.info, Node: GDB/MI Result Records, Next: GDB/MI Stream Records, Up: GDB/MI Output Records GDB/MI Result Records --------------------- In addition to a number of out-of-band notifications, the response to a GDB/MI command includes one of the following result indications: `"^done" [ "," RESULTS ]' The synchronous operation was successful, `RESULTS' are the return values. `"^running"' The asynchronous operation was successfully started. The target is running. `"^error" "," C-STRING' The operation failed. The `C-STRING' contains the corresponding error message.  File: gdb.info, Node: GDB/MI Stream Records, Next: GDB/MI Out-of-band Records, Prev: GDB/MI Result Records, Up: GDB/MI Output Records GDB/MI Stream Records --------------------- GDB internally maintains a number of output streams: the console, the target, and the log. The output intended for each of these streams is funneled through the GDB/MI interface using "stream records". Each stream record begins with a unique "prefix character" which identifies its stream (*note GDB/MI Output Syntax: GDB/MI Output Syntax.). In addition to the prefix, each stream record contains a `STRING-OUTPUT'. This is either raw text (with an implicit new line) or a quoted C string (which does not contain an implicit newline). `"~" STRING-OUTPUT' The console output stream contains text that should be displayed in the CLI console window. It contains the textual responses to CLI commands. `"@" STRING-OUTPUT' The target output stream contains any textual output from the running target. `"&" STRING-OUTPUT' The log stream contains debugging messages being produced by GDB's internals.  File: gdb.info, Node: GDB/MI Out-of-band Records, Prev: GDB/MI Stream Records, Up: GDB/MI Output Records GDB/MI Out-of-band Records -------------------------- "Out-of-band" records are used to notify the GDB/MI client of additional changes that have occurred. Those changes can either be a consequence of GDB/MI (e.g., a breakpoint modified) or a result of target activity (e.g., target stopped). The following is a preliminary list of possible out-of-band records. `"*" "stop"'  File: gdb.info, Node: GDB/MI Command Description Format, Next: GDB/MI Breakpoint Table Commands, Prev: GDB/MI Output Records, Up: GDB/MI GDB/MI Command Description Format ================================= The remaining sections describe blocks of commands. Each block of commands is laid out in a fashion similar to this section. Note the the line breaks shown in the examples are here only for readability. They don't appear in the real output. Also note that the commands with a non-available example (N.A.) are not yet implemented. Motivation ---------- The motivation for this collection of commands. Introduction ------------ A brief introduction to this collection of commands as a whole. Commands -------- For each command in the block, the following is described: Synopsis ........ -command ARGS... GDB Command ........... The corresponding GDB CLI command. Result ...... Out-of-band ........... Notes ..... Example .......  File: gdb.info, Node: GDB/MI Breakpoint Table Commands, Next: GDB/MI Data Manipulation, Prev: GDB/MI Command Description Format, Up: GDB/MI GDB/MI Breakpoint table commands ================================ This section documents GDB/MI commands for manipulating breakpoints. The `-break-after' Command -------------------------- Synopsis ........ -break-after NUMBER COUNT The breakpoint number NUMBER is not in effect until it has been hit COUNT times. To see how this is reflected in the output of the `-break-list' command, see the description of the `-break-list' command below. GDB Command ........... The corresponding GDB command is `ignore'. Example ....... (gdb) -break-insert main ^done,bkpt={number="1",addr="0x000100d0",file="hello.c",line="5"} (gdb) -break-after 1 3 ~ ^done (gdb) -break-list ^done,BreakpointTable={nr_rows="1",nr_cols="6", hdr=[{width="3",alignment="-1",col_name="number",colhdr="Num"}, {width="14",alignment="-1",col_name="type",colhdr="Type"}, {width="4",alignment="-1",col_name="disp",colhdr="Disp"}, {width="3",alignment="-1",col_name="enabled",colhdr="Enb"}, {width="10",alignment="-1",col_name="addr",colhdr="Address"}, {width="40",alignment="2",col_name="what",colhdr="What"}], body=[bkpt={number="1",type="breakpoint",disp="keep",enabled="y", addr="0x000100d0",func="main",file="hello.c",line="5",times="0", ignore="3"}]} (gdb) The `-break-condition' Command ------------------------------ Synopsis ........ -break-condition NUMBER EXPR Breakpoint NUMBER will stop the program only if the condition in EXPR is true. The condition becomes part of the `-break-list' output (see the description of the `-break-list' command below). GDB Command ........... The corresponding GDB command is `condition'. Example ....... (gdb) -break-condition 1 1 ^done (gdb) -break-list ^done,BreakpointTable={nr_rows="1",nr_cols="6", hdr=[{width="3",alignment="-1",col_name="number",colhdr="Num"}, {width="14",alignment="-1",col_name="type",colhdr="Type"}, {width="4",alignment="-1",col_name="disp",colhdr="Disp"}, {width="3",alignment="-1",col_name="enabled",colhdr="Enb"}, {width="10",alignment="-1",col_name="addr",colhdr="Address"}, {width="40",alignment="2",col_name="what",colhdr="What"}], body=[bkpt={number="1",type="breakpoint",disp="keep",enabled="y", addr="0x000100d0",func="main",file="hello.c",line="5",cond="1", times="0",ignore="3"}]} (gdb) The `-break-delete' Command --------------------------- Synopsis ........ -break-delete ( BREAKPOINT )+ Delete the breakpoint(s) whose number(s) are specified in the argument list. This is obviously reflected in the breakpoint list. GDB command ........... The corresponding GDB command is `delete'. Example ....... (gdb) -break-delete 1 ^done (gdb) -break-list ^done,BreakpointTable={nr_rows="0",nr_cols="6", hdr=[{width="3",alignment="-1",col_name="number",colhdr="Num"}, {width="14",alignment="-1",col_name="type",colhdr="Type"}, {width="4",alignment="-1",col_name="disp",colhdr="Disp"}, {width="3",alignment="-1",col_name="enabled",colhdr="Enb"}, {width="10",alignment="-1",col_name="addr",colhdr="Address"}, {width="40",alignment="2",col_name="what",colhdr="What"}], body=[]} (gdb) The `-break-disable' Command ---------------------------- Synopsis ........ -break-disable ( BREAKPOINT )+ Disable the named BREAKPOINT(s). The field `enabled' in the break list is now set to `n' for the named BREAKPOINT(s). GDB Command ........... The corresponding GDB command is `disable'. Example ....... (gdb) -break-disable 2 ^done (gdb) -break-list ^done,BreakpointTable={nr_rows="1",nr_cols="6", hdr=[{width="3",alignment="-1",col_name="number",colhdr="Num"}, {width="14",alignment="-1",col_name="type",colhdr="Type"}, {width="4",alignment="-1",col_name="disp",colhdr="Disp"}, {width="3",alignment="-1",col_name="enabled",colhdr="Enb"}, {width="10",alignment="-1",col_name="addr",colhdr="Address"}, {width="40",alignment="2",col_name="what",colhdr="What"}], body=[bkpt={number="2",type="breakpoint",disp="keep",enabled="n", addr="0x000100d0",func="main",file="hello.c",line="5",times="0"}]} (gdb) The `-break-enable' Command --------------------------- Synopsis ........ -break-enable ( BREAKPOINT )+ Enable (previously disabled) BREAKPOINT(s). GDB Command ........... The corresponding GDB command is `enable'. Example ....... (gdb) -break-enable 2 ^done (gdb) -break-list ^done,BreakpointTable={nr_rows="1",nr_cols="6", hdr=[{width="3",alignment="-1",col_name="number",colhdr="Num"}, {width="14",alignment="-1",col_name="type",colhdr="Type"}, {width="4",alignment="-1",col_name="disp",colhdr="Disp"}, {width="3",alignment="-1",col_name="enabled",colhdr="Enb"}, {width="10",alignment="-1",col_name="addr",colhdr="Address"}, {width="40",alignment="2",col_name="what",colhdr="What"}], body=[bkpt={number="2",type="breakpoint",disp="keep",enabled="y", addr="0x000100d0",func="main",file="hello.c",line="5",times="0"}]} (gdb) The `-break-info' Command ------------------------- Synopsis ........ -break-info BREAKPOINT Get information about a single breakpoint. GDB command ........... The corresponding GDB command is `info break BREAKPOINT'. Example ....... N.A. The `-break-insert' Command --------------------------- Synopsis ........ -break-insert [ -t ] [ -h ] [ -r ] [ -c CONDITION ] [ -i IGNORE-COUNT ] [ -p THREAD ] [ LINE | ADDR ] If specified, LINE, can be one of: * function * filename:linenum * filename:function * *address The possible optional parameters of this command are: `-t' Insert a tempoary breakpoint. `-h' Insert a hardware breakpoint. `-c CONDITION' Make the breakpoint conditional on CONDITION. `-i IGNORE-COUNT' Initialize the IGNORE-COUNT. `-r' Insert a regular breakpoint in all the functions whose names match the given regular expression. Other flags are not applicable to regular expresson. Result ...... The result is in the form: ^done,bkptno="NUMBER",func="FUNCNAME", file="FILENAME",line="LINENO" where NUMBER is the GDB number for this breakpoint, FUNCNAME is the name of the function where the breakpoint was inserted, FILENAME is the name of the source file which contains this function, and LINENO is the source line number within that file. Note: this format is open to change. GDB Command ........... The corresponding GDB commands are `break', `tbreak', `hbreak', `thbreak', and `rbreak'. Example ....... (gdb) -break-insert main ^done,bkpt={number="1",addr="0x0001072c",file="recursive2.c",line="4"} (gdb) -break-insert -t foo ^done,bkpt={number="2",addr="0x00010774",file="recursive2.c",line="11"} (gdb) -break-list ^done,BreakpointTable={nr_rows="2",nr_cols="6", hdr=[{width="3",alignment="-1",col_name="number",colhdr="Num"}, {width="14",alignment="-1",col_name="type",colhdr="Type"}, {width="4",alignment="-1",col_name="disp",colhdr="Disp"}, {width="3",alignment="-1",col_name="enabled",colhdr="Enb"}, {width="10",alignment="-1",col_name="addr",colhdr="Address"}, {width="40",alignment="2",col_name="what",colhdr="What"}], body=[bkpt={number="1",type="breakpoint",disp="keep",enabled="y", addr="0x0001072c", func="main",file="recursive2.c",line="4",times="0"}, bkpt={number="2",type="breakpoint",disp="del",enabled="y", addr="0x00010774",func="foo",file="recursive2.c",line="11",times="0"}]} (gdb) -break-insert -r foo.* ~int foo(int, int); ^done,bkpt={number="3",addr="0x00010774",file="recursive2.c",line="11"} (gdb) The `-break-list' Command ------------------------- Synopsis ........ -break-list Displays the list of inserted breakpoints, showing the following fields: `Number' number of the breakpoint `Type' type of the breakpoint: `breakpoint' or `watchpoint' `Disposition' should the breakpoint be deleted or disabled when it is hit: `keep' or `nokeep' `Enabled' is the breakpoint enabled or no: `y' or `n' `Address' memory location at which the breakpoint is set `What' logical location of the breakpoint, expressed by function name, file name, line number `Times' number of times the breakpoint has been hit If there are no breakpoints or watchpoints, the `BreakpointTable' `body' field is an empty list. GDB Command ........... The corresponding GDB command is `info break'. Example ....... (gdb) -break-list ^done,BreakpointTable={nr_rows="2",nr_cols="6", hdr=[{width="3",alignment="-1",col_name="number",colhdr="Num"}, {width="14",alignment="-1",col_name="type",colhdr="Type"}, {width="4",alignment="-1",col_name="disp",colhdr="Disp"}, {width="3",alignment="-1",col_name="enabled",colhdr="Enb"}, {width="10",alignment="-1",col_name="addr",colhdr="Address"}, {width="40",alignment="2",col_name="what",colhdr="What"}], body=[bkpt={number="1",type="breakpoint",disp="keep",enabled="y", addr="0x000100d0",func="main",file="hello.c",line="5",times="0"}, bkpt={number="2",type="breakpoint",disp="keep",enabled="y", addr="0x00010114",func="foo",file="hello.c",line="13",times="0"}]} (gdb) Here's an example of the result when there are no breakpoints: (gdb) -break-list ^done,BreakpointTable={nr_rows="0",nr_cols="6", hdr=[{width="3",alignment="-1",col_name="number",colhdr="Num"}, {width="14",alignment="-1",col_name="type",colhdr="Type"}, {width="4",alignment="-1",col_name="disp",colhdr="Disp"}, {width="3",alignment="-1",col_name="enabled",colhdr="Enb"}, {width="10",alignment="-1",col_name="addr",colhdr="Address"}, {width="40",alignment="2",col_name="what",colhdr="What"}], body=[]} (gdb) The `-break-watch' Command -------------------------- Synopsis ........ -break-watch [ -a | -r ] Create a watchpoint. With the `-a' option it will create an "access" watchpoint, i.e. a watchpoint that triggers either on a read from or on a write to the memory location. With the `-r' option, the watchpoint created is a "read" watchpoint, i.e. it will trigger only when the memory location is accessed for reading. Without either of the options, the watchpoint created is a regular watchpoint, i.e. it will trigger when the memory location is accessed for writing. *Note Setting watchpoints: Set Watchpoints. Note that `-break-list' will report a single list of watchpoints and breakpoints inserted. GDB Command ........... The corresponding GDB commands are `watch', `awatch', and `rwatch'. Example ....... Setting a watchpoint on a variable in the `main' function: (gdb) -break-watch x ^done,wpt={number="2",exp="x"} (gdb) -exec-continue ^running ^done,reason="watchpoint-trigger",wpt={number="2",exp="x"}, value={old="-268439212",new="55"}, frame={func="main",args=[],file="recursive2.c",line="5"} (gdb) Setting a watchpoint on a variable local to a function. GDB will stop the program execution twice: first for the variable changing value, then for the watchpoint going out of scope. (gdb) -break-watch C ^done,wpt={number="5",exp="C"} (gdb) -exec-continue ^running ^done,reason="watchpoint-trigger", wpt={number="5",exp="C"},value={old="-276895068",new="3"}, frame={func="callee4",args=[], file="../../../devo/gdb/testsuite/gdb.mi/basics.c",line="13"} (gdb) -exec-continue ^running ^done,reason="watchpoint-scope",wpnum="5", frame={func="callee3",args=[{name="strarg", value="0x11940 \"A string argument.\""}], file="../../../devo/gdb/testsuite/gdb.mi/basics.c",line="18"} (gdb) Listing breakpoints and watchpoints, at different points in the program execution. Note that once the watchpoint goes out of scope, it is deleted. (gdb) -break-watch C ^done,wpt={number="2",exp="C"} (gdb) -break-list ^done,BreakpointTable={nr_rows="2",nr_cols="6", hdr=[{width="3",alignment="-1",col_name="number",colhdr="Num"}, {width="14",alignment="-1",col_name="type",colhdr="Type"}, {width="4",alignment="-1",col_name="disp",colhdr="Disp"}, {width="3",alignment="-1",col_name="enabled",colhdr="Enb"}, {width="10",alignment="-1",col_name="addr",colhdr="Address"}, {width="40",alignment="2",col_name="what",colhdr="What"}], body=[bkpt={number="1",type="breakpoint",disp="keep",enabled="y", addr="0x00010734",func="callee4", file="../../../devo/gdb/testsuite/gdb.mi/basics.c",line="8",times="1"}, bkpt={number="2",type="watchpoint",disp="keep", enabled="y",addr="",what="C",times="0"}]} (gdb) -exec-continue ^running ^done,reason="watchpoint-trigger",wpt={number="2",exp="C"}, value={old="-276895068",new="3"}, frame={func="callee4",args=[], file="../../../devo/gdb/testsuite/gdb.mi/basics.c",line="13"} (gdb) -break-list ^done,BreakpointTable={nr_rows="2",nr_cols="6", hdr=[{width="3",alignment="-1",col_name="number",colhdr="Num"}, {width="14",alignment="-1",col_name="type",colhdr="Type"}, {width="4",alignment="-1",col_name="disp",colhdr="Disp"}, {width="3",alignment="-1",col_name="enabled",colhdr="Enb"}, {width="10",alignment="-1",col_name="addr",colhdr="Address"}, {width="40",alignment="2",col_name="what",colhdr="What"}], body=[bkpt={number="1",type="breakpoint",disp="keep",enabled="y", addr="0x00010734",func="callee4", file="../../../devo/gdb/testsuite/gdb.mi/basics.c",line="8",times="1"}, bkpt={number="2",type="watchpoint",disp="keep", enabled="y",addr="",what="C",times="-5"}]} (gdb) -exec-continue ^running ^done,reason="watchpoint-scope",wpnum="2", frame={func="callee3",args=[{name="strarg", value="0x11940 \"A string argument.\""}], file="../../../devo/gdb/testsuite/gdb.mi/basics.c",line="18"} (gdb) -break-list ^done,BreakpointTable={nr_rows="1",nr_cols="6", hdr=[{width="3",alignment="-1",col_name="number",colhdr="Num"}, {width="14",alignment="-1",col_name="type",colhdr="Type"}, {width="4",alignment="-1",col_name="disp",colhdr="Disp"}, {width="3",alignment="-1",col_name="enabled",colhdr="Enb"}, {width="10",alignment="-1",col_name="addr",colhdr="Address"}, {width="40",alignment="2",col_name="what",colhdr="What"}], body=[bkpt={number="1",type="breakpoint",disp="keep",enabled="y", addr="0x00010734",func="callee4", file="../../../devo/gdb/testsuite/gdb.mi/basics.c",line="8",times="1"}]} (gdb)  File: gdb.info, Node: GDB/MI Data Manipulation, Next: GDB/MI Program Control, Prev: GDB/MI Breakpoint Table Commands, Up: GDB/MI GDB/MI Data Manipulation ======================== This section describes the GDB/MI commands that manipulate data: examine memory and registers, evaluate expressions, etc. The `-data-disassemble' Command ------------------------------- Synopsis ........ -data-disassemble [ -s START-ADDR -e END-ADDR ] | [ -f FILENAME -l LINENUM [ -n LINES ] ] -- MODE Where: `START-ADDR' is the beginning address (or `$pc') `END-ADDR' is the end address `FILENAME' is the name of the file to disassemble `LINENUM' is the line number to disassemble around `LINES' is the the number of disassembly lines to be produced. If it is -1, the whole function will be disassembled, in case no END-ADDR is specified. If END-ADDR is specified as a non-zero value, and LINES is lower than the number of disassembly lines between START-ADDR and END-ADDR, only LINES lines are displayed; if LINES is higher than the number of lines between START-ADDR and END-ADDR, only the lines up to END-ADDR are displayed. `MODE' is either 0 (meaning only disassembly) or 1 (meaning mixed source and disassembly). Result ...... The output for each instruction is composed of four fields: * Address * Func-name * Offset * Instruction Note that whatever included in the instruction field, is not manipulated directely by GDB/MI, i.e. it is not possible to adjust its format. GDB Command ........... There's no direct mapping from this command to the CLI. Example ....... Disassemble from the current value of `$pc' to `$pc + 20': (gdb) -data-disassemble -s $pc -e "$pc + 20" -- 0 ^done, asm_insns=[ {address="0x000107c0",func-name="main",offset="4", inst="mov 2, %o0"}, {address="0x000107c4",func-name="main",offset="8", inst="sethi %hi(0x11800), %o2"}, {address="0x000107c8",func-name="main",offset="12", inst="or %o2, 0x140, %o1\t! 0x11940 <_lib_version+8>"}, {address="0x000107cc",func-name="main",offset="16", inst="sethi %hi(0x11800), %o2"}, {address="0x000107d0",func-name="main",offset="20", inst="or %o2, 0x168, %o4\t! 0x11968 <_lib_version+48>"}] (gdb) Disassemble the whole `main' function. Line 32 is part of `main'. -data-disassemble -f basics.c -l 32 -- 0 ^done,asm_insns=[ {address="0x000107bc",func-name="main",offset="0", inst="save %sp, -112, %sp"}, {address="0x000107c0",func-name="main",offset="4", inst="mov 2, %o0"}, {address="0x000107c4",func-name="main",offset="8", inst="sethi %hi(0x11800), %o2"}, [...] {address="0x0001081c",func-name="main",offset="96",inst="ret "}, {address="0x00010820",func-name="main",offset="100",inst="restore "}] (gdb) Disassemble 3 instructions from the start of `main': (gdb) -data-disassemble -f basics.c -l 32 -n 3 -- 0 ^done,asm_insns=[ {address="0x000107bc",func-name="main",offset="0", inst="save %sp, -112, %sp"}, {address="0x000107c0",func-name="main",offset="4", inst="mov 2, %o0"}, {address="0x000107c4",func-name="main",offset="8", inst="sethi %hi(0x11800), %o2"}] (gdb) Disassemble 3 instructions from the start of `main' in mixed mode: (gdb) -data-disassemble -f basics.c -l 32 -n 3 -- 1 ^done,asm_insns=[ src_and_asm_line={line="31", file="/kwikemart/marge/ezannoni/flathead-dev/devo/gdb/ \ testsuite/gdb.mi/basics.c",line_asm_insn=[ {address="0x000107bc",func-name="main",offset="0", inst="save %sp, -112, %sp"}]}, src_and_asm_line={line="32", file="/kwikemart/marge/ezannoni/flathead-dev/devo/gdb/ \ testsuite/gdb.mi/basics.c",line_asm_insn=[ {address="0x000107c0",func-name="main",offset="4", inst="mov 2, %o0"}, {address="0x000107c4",func-name="main",offset="8", inst="sethi %hi(0x11800), %o2"}]}] (gdb) The `-data-evaluate-expression' Command --------------------------------------- Synopsis ........ -data-evaluate-expression EXPR Evaluate EXPR as an expression. The expression could contain an inferior function call. The function call will execute synchronously. If the expression contains spaces, it must be enclosed in double quotes. GDB Command ........... The corresponding GDB commands are `print', `output', and `call'. In `gdbtk' only, there's a corresponding `gdb_eval' command. Example ....... In the following example, the numbers that precede the commands are the "tokens" described in *Note GDB/MI Command Syntax: GDB/MI Command Syntax. Notice how GDB/MI returns the same tokens in its output. 211-data-evaluate-expression A 211^done,value="1" (gdb) 311-data-evaluate-expression &A 311^done,value="0xefffeb7c" (gdb) 411-data-evaluate-expression A+3 411^done,value="4" (gdb) 511-data-evaluate-expression "A + 3" 511^done,value="4" (gdb) The `-data-list-changed-registers' Command ------------------------------------------ Synopsis ........ -data-list-changed-registers Display a list of the registers that have changed. GDB Command ........... GDB doesn't have a direct analog for this command; `gdbtk' has the corresponding command `gdb_changed_register_list'. Example ....... On a PPC MBX board: (gdb) -exec-continue ^running (gdb) *stopped,reason="breakpoint-hit",bkptno="1",frame={func="main", args=[],file="try.c",line="5"} (gdb) -data-list-changed-registers ^done,changed-registers=["0","1","2","4","5","6","7","8","9", "10","11","13","14","15","16","17","18","19","20","21","22","23", "24","25","26","27","28","30","31","64","65","66","67","69"] (gdb) The `-data-list-register-names' Command --------------------------------------- Synopsis ........ -data-list-register-names [ ( REGNO )+ ] Show a list of register names for the current target. If no arguments are given, it shows a list of the names of all the registers. If integer numbers are given as arguments, it will print a list of the names of the registers corresponding to the arguments. To ensure consistency between a register name and its number, the output list may include empty register names. GDB Command ........... GDB does not have a command which corresponds to `-data-list-register-names'. In `gdbtk' there is a corresponding command `gdb_regnames'. Example ....... For the PPC MBX board: (gdb) -data-list-register-names ^done,register-names=["r0","r1","r2","r3","r4","r5","r6","r7", "r8","r9","r10","r11","r12","r13","r14","r15","r16","r17","r18", "r19","r20","r21","r22","r23","r24","r25","r26","r27","r28","r29", "r30","r31","f0","f1","f2","f3","f4","f5","f6","f7","f8","f9", "f10","f11","f12","f13","f14","f15","f16","f17","f18","f19","f20", "f21","f22","f23","f24","f25","f26","f27","f28","f29","f30","f31", "", "pc","ps","cr","lr","ctr","xer"] (gdb) -data-list-register-names 1 2 3 ^done,register-names=["r1","r2","r3"] (gdb) The `-data-list-register-values' Command ---------------------------------------- Synopsis ........ -data-list-register-values FMT [ ( REGNO )*] Display the registers' contents. FMT is the format according to which the registers' contents are to be returned, followed by an optional list of numbers specifying the registers to display. A missing list of numbers indicates that the contents of all the registers must be returned. Allowed formats for FMT are: `x' Hexadecimal `o' Octal `t' Binary `d' Decimal `r' Raw `N' Natural GDB Command ........... The corresponding GDB commands are `info reg', `info all-reg', and (in `gdbtk') `gdb_fetch_registers'. Example ....... For a PPC MBX board (note: line breaks are for readability only, they don't appear in the actual output): (gdb) -data-list-register-values r 64 65 ^done,register-values=[{number="64",value="0xfe00a300"}, {number="65",value="0x00029002"}] (gdb) -data-list-register-values x ^done,register-values=[{number="0",value="0xfe0043c8"}, {number="1",value="0x3fff88"},{number="2",value="0xfffffffe"}, {number="3",value="0x0"},{number="4",value="0xa"}, {number="5",value="0x3fff68"},{number="6",value="0x3fff58"}, {number="7",value="0xfe011e98"},{number="8",value="0x2"}, {number="9",value="0xfa202820"},{number="10",value="0xfa202808"}, {number="11",value="0x1"},{number="12",value="0x0"}, {number="13",value="0x4544"},{number="14",value="0xffdfffff"}, {number="15",value="0xffffffff"},{number="16",value="0xfffffeff"}, {number="17",value="0xefffffed"},{number="18",value="0xfffffffe"}, {number="19",value="0xffffffff"},{number="20",value="0xffffffff"}, {number="21",value="0xffffffff"},{number="22",value="0xfffffff7"}, {number="23",value="0xffffffff"},{number="24",value="0xffffffff"}, {number="25",value="0xffffffff"},{number="26",value="0xfffffffb"}, {number="27",value="0xffffffff"},{number="28",value="0xf7bfffff"}, {number="29",value="0x0"},{number="30",value="0xfe010000"}, {number="31",value="0x0"},{number="32",value="0x0"}, {number="33",value="0x0"},{number="34",value="0x0"}, {number="35",value="0x0"},{number="36",value="0x0"}, {number="37",value="0x0"},{number="38",value="0x0"}, {number="39",value="0x0"},{number="40",value="0x0"}, {number="41",value="0x0"},{number="42",value="0x0"}, {number="43",value="0x0"},{number="44",value="0x0"}, {number="45",value="0x0"},{number="46",value="0x0"}, {number="47",value="0x0"},{number="48",value="0x0"}, {number="49",value="0x0"},{number="50",value="0x0"}, {number="51",value="0x0"},{number="52",value="0x0"}, {number="53",value="0x0"},{number="54",value="0x0"}, {number="55",value="0x0"},{number="56",value="0x0"}, {number="57",value="0x0"},{number="58",value="0x0"}, {number="59",value="0x0"},{number="60",value="0x0"}, {number="61",value="0x0"},{number="62",value="0x0"}, {number="63",value="0x0"},{number="64",value="0xfe00a300"}, {number="65",value="0x29002"},{number="66",value="0x202f04b5"}, {number="67",value="0xfe0043b0"},{number="68",value="0xfe00b3e4"}, {number="69",value="0x20002b03"}] (gdb) The `-data-read-memory' Command ------------------------------- Synopsis ........ -data-read-memory [ -o BYTE-OFFSET ] ADDRESS WORD-FORMAT WORD-SIZE NR-ROWS NR-COLS [ ASCHAR ] where: `ADDRESS' An expression specifying the address of the first memory word to be read. Complex expressions containing embedded white space should be quoted using the C convention. `WORD-FORMAT' The format to be used to print the memory words. The notation is the same as for GDB's `print' command (*note Output formats: Output Formats.). `WORD-SIZE' The size of each memory word in bytes. `NR-ROWS' The number of rows in the output table. `NR-COLS' The number of columns in the output table. `ASCHAR' If present, indicates that each row should include an ASCII dump. The value of ASCHAR is used as a padding character when a byte is not a member of the printable ASCII character set (printable ASCII characters are those whose code is between 32 and 126, inclusively). `BYTE-OFFSET' An offset to add to the ADDRESS before fetching memory. This command displays memory contents as a table of NR-ROWS by NR-COLS words, each word being WORD-SIZE bytes. In total, `NR-ROWS * NR-COLS * WORD-SIZE' bytes are read (returned as `total-bytes'). Should less then the requested number of bytes be returned by the target, the missing words are identified using `N/A'. The number of bytes read from the target is returned in `nr-bytes' and the starting address used to read memory in `addr'. The address of the next/previous row or page is available in `next-row' and `prev-row', `next-page' and `prev-page'. GDB Command ........... The corresponding GDB command is `x'. `gdbtk' has `gdb_get_mem' memory read command. Example ....... Read six bytes of memory starting at `bytes+6' but then offset by `-6' bytes. Format as three rows of two columns. One byte per word. Display each word in hex. (gdb) 9-data-read-memory -o -6 -- bytes+6 x 1 3 2 9^done,addr="0x00001390",nr-bytes="6",total-bytes="6", next-row="0x00001396",prev-row="0x0000138e",next-page="0x00001396", prev-page="0x0000138a",memory=[ {addr="0x00001390",data=["0x00","0x01"]}, {addr="0x00001392",data=["0x02","0x03"]}, {addr="0x00001394",data=["0x04","0x05"]}] (gdb) Read two bytes of memory starting at address `shorts + 64' and display as a single word formatted in decimal. (gdb) 5-data-read-memory shorts+64 d 2 1 1 5^done,addr="0x00001510",nr-bytes="2",total-bytes="2", next-row="0x00001512",prev-row="0x0000150e", next-page="0x00001512",prev-page="0x0000150e",memory=[ {addr="0x00001510",data=["128"]}] (gdb) Read thirty two bytes of memory starting at `bytes+16' and format as eight rows of four columns. Include a string encoding with `x' used as the non-printable character. (gdb) 4-data-read-memory bytes+16 x 1 8 4 x 4^done,addr="0x000013a0",nr-bytes="32",total-bytes="32", next-row="0x000013c0",prev-row="0x0000139c", next-page="0x000013c0",prev-page="0x00001380",memory=[ {addr="0x000013a0",data=["0x10","0x11","0x12","0x13"],ascii="xxxx"}, {addr="0x000013a4",data=["0x14","0x15","0x16","0x17"],ascii="xxxx"}, {addr="0x000013a8",data=["0x18","0x19","0x1a","0x1b"],ascii="xxxx"}, {addr="0x000013ac",data=["0x1c","0x1d","0x1e","0x1f"],ascii="xxxx"}, {addr="0x000013b0",data=["0x20","0x21","0x22","0x23"],ascii=" !\"#"}, {addr="0x000013b4",data=["0x24","0x25","0x26","0x27"],ascii="$%&'"}, {addr="0x000013b8",data=["0x28","0x29","0x2a","0x2b"],ascii="()*+"}, {addr="0x000013bc",data=["0x2c","0x2d","0x2e","0x2f"],ascii=",-./"}] (gdb) The `-display-delete' Command ----------------------------- Synopsis ........ -display-delete NUMBER Delete the display NUMBER. GDB Command ........... The corresponding GDB command is `delete display'. Example ....... N.A. The `-display-disable' Command ------------------------------ Synopsis ........ -display-disable NUMBER Disable display NUMBER. GDB Command ........... The corresponding GDB command is `disable display'. Example ....... N.A. The `-display-enable' Command ----------------------------- Synopsis ........ -display-enable NUMBER Enable display NUMBER. GDB Command ........... The corresponding GDB command is `enable display'. Example ....... N.A. The `-display-insert' Command ----------------------------- Synopsis ........ -display-insert EXPRESSION Display EXPRESSION every time the program stops. GDB Command ........... The corresponding GDB command is `display'. Example ....... N.A. The `-display-list' Command --------------------------- Synopsis ........ -display-list List the displays. Do not show the current values. GDB Command ........... The corresponding GDB command is `info display'. Example ....... N.A. The `-environment-cd' Command ----------------------------- Synopsis ........ -environment-cd PATHDIR Set GDB's working directory. GDB Command ........... The corresponding GDB command is `cd'. Example ....... (gdb) -environment-cd /kwikemart/marge/ezannoni/flathead-dev/devo/gdb ^done (gdb) The `-environment-directory' Command ------------------------------------ Synopsis ........ -environment-directory PATHDIR Add directory PATHDIR to beginning of search path for source files. GDB Command ........... The corresponding GDB command is `dir'. Example ....... (gdb) -environment-directory /kwikemart/marge/ezannoni/flathead-dev/devo/gdb ^done (gdb) The `-environment-path' Command ------------------------------- Synopsis ........ -environment-path ( PATHDIR )+ Add directories PATHDIR to beginning of search path for object files. GDB Command ........... The corresponding GDB command is `path'. Example ....... (gdb) -environment-path /kwikemart/marge/ezannoni/flathead-dev/ppc-eabi/gdb ^done (gdb) The `-environment-pwd' Command ------------------------------ Synopsis ........ -environment-pwd Show the current working directory. GDB command ........... The corresponding GDB command is `pwd'. Example ....... (gdb) -environment-pwd ~Working directory /kwikemart/marge/ezannoni/flathead-dev/devo/gdb. ^done (gdb)