| <html lang="en"> |
| <head> |
| <title>GDB/MI Stack Manipulation - Debugging with GDB</title> |
| <meta http-equiv="Content-Type" content="text/html"> |
| <meta name="description" content="Debugging with GDB"> |
| <meta name="generator" content="makeinfo 4.13"> |
| <link title="Top" rel="start" href="index.html#Top"> |
| <link rel="up" href="GDB_002fMI.html#GDB_002fMI" title="GDB/MI"> |
| <link rel="prev" href="GDB_002fMI-Program-Execution.html#GDB_002fMI-Program-Execution" title="GDB/MI Program Execution"> |
| <link rel="next" href="GDB_002fMI-Variable-Objects.html#GDB_002fMI-Variable-Objects" title="GDB/MI Variable Objects"> |
| <link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage"> |
| <!-- |
| Copyright (C) 1988-2019 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.3 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 FSF's Back-Cover Text is: ``You are free to copy and modify |
| this GNU Manual. Buying copies from GNU Press supports the FSF in |
| developing GNU and promoting software freedom.'' |
| --> |
| <meta http-equiv="Content-Style-Type" content="text/css"> |
| <style type="text/css"><!-- |
| pre.display { font-family:inherit } |
| pre.format { font-family:inherit } |
| pre.smalldisplay { font-family:inherit; font-size:smaller } |
| pre.smallformat { font-family:inherit; font-size:smaller } |
| pre.smallexample { font-size:smaller } |
| pre.smalllisp { font-size:smaller } |
| span.sc { font-variant:small-caps } |
| span.roman { font-family:serif; font-weight:normal; } |
| span.sansserif { font-family:sans-serif; font-weight:normal; } |
| --></style> |
| </head> |
| <body> |
| <div class="node"> |
| <a name="GDB%2fMI-Stack-Manipulation"></a> |
| <a name="GDB_002fMI-Stack-Manipulation"></a> |
| <p> |
| Next: <a rel="next" accesskey="n" href="GDB_002fMI-Variable-Objects.html#GDB_002fMI-Variable-Objects">GDB/MI Variable Objects</a>, |
| Previous: <a rel="previous" accesskey="p" href="GDB_002fMI-Program-Execution.html#GDB_002fMI-Program-Execution">GDB/MI Program Execution</a>, |
| Up: <a rel="up" accesskey="u" href="GDB_002fMI.html#GDB_002fMI">GDB/MI</a> |
| <hr> |
| </div> |
| |
| <h3 class="section">27.14 <span class="sc">gdb/mi</span> Stack Manipulation Commands</h3> |
| |
| <h4 class="subheading">The <code>-enable-frame-filters</code> Command</h4> |
| |
| <p><a name="index-g_t_002denable_002dframe_002dfilters-3019"></a> |
| <pre class="smallexample"> -enable-frame-filters |
| </pre> |
| <p><span class="sc">gdb</span> allows Python-based frame filters to affect the output of |
| the MI commands relating to stack traces. As there is no way to |
| implement this in a fully backward-compatible way, a front end must |
| request that this functionality be enabled. |
| |
| <p>Once enabled, this feature cannot be disabled. |
| |
| <p>Note that if Python support has not been compiled into <span class="sc">gdb</span>, |
| this command will still succeed (and do nothing). |
| |
| <h4 class="subheading">The <code>-stack-info-frame</code> Command</h4> |
| |
| <p><a name="index-g_t_002dstack_002dinfo_002dframe-3020"></a> |
| |
| <h5 class="subsubheading">Synopsis</h5> |
| |
| <pre class="smallexample"> -stack-info-frame |
| </pre> |
| <p>Get info on the selected frame. |
| |
| <h5 class="subsubheading"><span class="sc">gdb</span> Command</h5> |
| |
| <p>The corresponding <span class="sc">gdb</span> command is ‘<samp><span class="samp">info frame</span></samp>’ or ‘<samp><span class="samp">frame</span></samp>’ |
| (without arguments). |
| |
| <h5 class="subsubheading">Example</h5> |
| |
| <pre class="smallexample"> (gdb) |
| -stack-info-frame |
| ^done,frame={level="1",addr="0x0001076c",func="callee3", |
| file="../../../devo/gdb/testsuite/gdb.mi/basics.c", |
| fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="17", |
| arch="i386:x86_64"} |
| (gdb) |
| </pre> |
| <h4 class="subheading">The <code>-stack-info-depth</code> Command</h4> |
| |
| <p><a name="index-g_t_002dstack_002dinfo_002ddepth-3021"></a> |
| |
| <h5 class="subsubheading">Synopsis</h5> |
| |
| <pre class="smallexample"> -stack-info-depth [ <var>max-depth</var> ] |
| </pre> |
| <p>Return the depth of the stack. If the integer argument <var>max-depth</var> |
| is specified, do not count beyond <var>max-depth</var> frames. |
| |
| <h5 class="subsubheading"><span class="sc">gdb</span> Command</h5> |
| |
| <p>There's no equivalent <span class="sc">gdb</span> command. |
| |
| <h5 class="subsubheading">Example</h5> |
| |
| <p>For a stack with frame levels 0 through 11: |
| |
| <pre class="smallexample"> (gdb) |
| -stack-info-depth |
| ^done,depth="12" |
| (gdb) |
| -stack-info-depth 4 |
| ^done,depth="4" |
| (gdb) |
| -stack-info-depth 12 |
| ^done,depth="12" |
| (gdb) |
| -stack-info-depth 11 |
| ^done,depth="11" |
| (gdb) |
| -stack-info-depth 13 |
| ^done,depth="12" |
| (gdb) |
| </pre> |
| <p><a name="g_t_002dstack_002dlist_002darguments"></a> |
| |
| <h4 class="subheading">The <code>-stack-list-arguments</code> Command</h4> |
| |
| <p><a name="index-g_t_002dstack_002dlist_002darguments-3022"></a> |
| |
| <h5 class="subsubheading">Synopsis</h5> |
| |
| <pre class="smallexample"> -stack-list-arguments [ --no-frame-filters ] [ --skip-unavailable ] <var>print-values</var> |
| [ <var>low-frame</var> <var>high-frame</var> ] |
| </pre> |
| <p>Display a list of the arguments for the frames between <var>low-frame</var> |
| and <var>high-frame</var> (inclusive). If <var>low-frame</var> and |
| <var>high-frame</var> are not provided, list the arguments for the whole |
| call stack. If the two arguments are equal, show the single frame |
| at the corresponding level. It is an error if <var>low-frame</var> is |
| larger than the actual number of frames. On the other hand, |
| <var>high-frame</var> may be larger than the actual number of frames, in |
| which case only existing frames will be returned. |
| |
| <p>If <var>print-values</var> is 0 or <code>--no-values</code>, print only the names of |
| the variables; if it is 1 or <code>--all-values</code>, print also their |
| values; and if it is 2 or <code>--simple-values</code>, print the name, |
| type and value for simple data types, and the name and type for arrays, |
| structures and unions. If the option <code>--no-frame-filters</code> is |
| supplied, then Python frame filters will not be executed. |
| |
| <p>If the <code>--skip-unavailable</code> option is specified, arguments that |
| are not available are not listed. Partially available arguments |
| are still displayed, however. |
| |
| <p>Use of this command to obtain arguments in a single frame is |
| deprecated in favor of the ‘<samp><span class="samp">-stack-list-variables</span></samp>’ command. |
| |
| <h5 class="subsubheading"><span class="sc">gdb</span> Command</h5> |
| |
| <p><span class="sc">gdb</span> does not have an equivalent command. <code>gdbtk</code> has a |
| ‘<samp><span class="samp">gdb_get_args</span></samp>’ command which partially overlaps with the |
| functionality of ‘<samp><span class="samp">-stack-list-arguments</span></samp>’. |
| |
| <h5 class="subsubheading">Example</h5> |
| |
| <pre class="smallexample"> (gdb) |
| -stack-list-frames |
| ^done, |
| stack=[ |
| frame={level="0",addr="0x00010734",func="callee4", |
| file="../../../devo/gdb/testsuite/gdb.mi/basics.c", |
| fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="8", |
| arch="i386:x86_64"}, |
| frame={level="1",addr="0x0001076c",func="callee3", |
| file="../../../devo/gdb/testsuite/gdb.mi/basics.c", |
| fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="17", |
| arch="i386:x86_64"}, |
| frame={level="2",addr="0x0001078c",func="callee2", |
| file="../../../devo/gdb/testsuite/gdb.mi/basics.c", |
| fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="22", |
| arch="i386:x86_64"}, |
| frame={level="3",addr="0x000107b4",func="callee1", |
| file="../../../devo/gdb/testsuite/gdb.mi/basics.c", |
| fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="27", |
| arch="i386:x86_64"}, |
| frame={level="4",addr="0x000107e0",func="main", |
| file="../../../devo/gdb/testsuite/gdb.mi/basics.c", |
| fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="32", |
| arch="i386:x86_64"}] |
| (gdb) |
| -stack-list-arguments 0 |
| ^done, |
| stack-args=[ |
| frame={level="0",args=[]}, |
| frame={level="1",args=[name="strarg"]}, |
| frame={level="2",args=[name="intarg",name="strarg"]}, |
| frame={level="3",args=[name="intarg",name="strarg",name="fltarg"]}, |
| frame={level="4",args=[]}] |
| (gdb) |
| -stack-list-arguments 1 |
| ^done, |
| stack-args=[ |
| frame={level="0",args=[]}, |
| frame={level="1", |
| args=[{name="strarg",value="0x11940 \"A string argument.\""}]}, |
| frame={level="2",args=[ |
| {name="intarg",value="2"}, |
| {name="strarg",value="0x11940 \"A string argument.\""}]}, |
| {frame={level="3",args=[ |
| {name="intarg",value="2"}, |
| {name="strarg",value="0x11940 \"A string argument.\""}, |
| {name="fltarg",value="3.5"}]}, |
| frame={level="4",args=[]}] |
| (gdb) |
| -stack-list-arguments 0 2 2 |
| ^done,stack-args=[frame={level="2",args=[name="intarg",name="strarg"]}] |
| (gdb) |
| -stack-list-arguments 1 2 2 |
| ^done,stack-args=[frame={level="2", |
| args=[{name="intarg",value="2"}, |
| {name="strarg",value="0x11940 \"A string argument.\""}]}] |
| (gdb) |
| </pre> |
| <!-- @subheading -stack-list-exception-handlers --> |
| <p><a name="g_t_002dstack_002dlist_002dframes"></a> |
| |
| <h4 class="subheading">The <code>-stack-list-frames</code> Command</h4> |
| |
| <p><a name="index-g_t_002dstack_002dlist_002dframes-3023"></a> |
| |
| <h5 class="subsubheading">Synopsis</h5> |
| |
| <pre class="smallexample"> -stack-list-frames [ --no-frame-filters <var>low-frame</var> <var>high-frame</var> ] |
| </pre> |
| <p>List the frames currently on the stack. For each frame it displays the |
| following info: |
| |
| <dl> |
| <dt>‘<samp><var>level</var></samp>’<dd>The frame number, 0 being the topmost frame, i.e., the innermost function. |
| <br><dt>‘<samp><var>addr</var></samp>’<dd>The <code>$pc</code> value for that frame. |
| <br><dt>‘<samp><var>func</var></samp>’<dd>Function name. |
| <br><dt>‘<samp><var>file</var></samp>’<dd>File name of the source file where the function lives. |
| <br><dt>‘<samp><var>fullname</var></samp>’<dd>The full file name of the source file where the function lives. |
| <br><dt>‘<samp><var>line</var></samp>’<dd>Line number corresponding to the <code>$pc</code>. |
| <br><dt>‘<samp><var>from</var></samp>’<dd>The shared library where this function is defined. This is only given |
| if the frame's function is not known. |
| <br><dt>‘<samp><var>arch</var></samp>’<dd>Frame's architecture. |
| </dl> |
| |
| <p>If invoked without arguments, this command prints a backtrace for the |
| whole stack. If given two integer arguments, it shows the frames whose |
| levels are between the two arguments (inclusive). If the two arguments |
| are equal, it shows the single frame at the corresponding level. It is |
| an error if <var>low-frame</var> is larger than the actual number of |
| frames. On the other hand, <var>high-frame</var> may be larger than the |
| actual number of frames, in which case only existing frames will be |
| returned. If the option <code>--no-frame-filters</code> is supplied, then |
| Python frame filters will not be executed. |
| |
| <h5 class="subsubheading"><span class="sc">gdb</span> Command</h5> |
| |
| <p>The corresponding <span class="sc">gdb</span> commands are ‘<samp><span class="samp">backtrace</span></samp>’ and ‘<samp><span class="samp">where</span></samp>’. |
| |
| <h5 class="subsubheading">Example</h5> |
| |
| <p>Full stack backtrace: |
| |
| <pre class="smallexample"> (gdb) |
| -stack-list-frames |
| ^done,stack= |
| [frame={level="0",addr="0x0001076c",func="foo", |
| file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="11", |
| arch="i386:x86_64"}, |
| frame={level="1",addr="0x000107a4",func="foo", |
| file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14", |
| arch="i386:x86_64"}, |
| frame={level="2",addr="0x000107a4",func="foo", |
| file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14", |
| arch="i386:x86_64"}, |
| frame={level="3",addr="0x000107a4",func="foo", |
| file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14", |
| arch="i386:x86_64"}, |
| frame={level="4",addr="0x000107a4",func="foo", |
| file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14", |
| arch="i386:x86_64"}, |
| frame={level="5",addr="0x000107a4",func="foo", |
| file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14", |
| arch="i386:x86_64"}, |
| frame={level="6",addr="0x000107a4",func="foo", |
| file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14", |
| arch="i386:x86_64"}, |
| frame={level="7",addr="0x000107a4",func="foo", |
| file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14", |
| arch="i386:x86_64"}, |
| frame={level="8",addr="0x000107a4",func="foo", |
| file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14", |
| arch="i386:x86_64"}, |
| frame={level="9",addr="0x000107a4",func="foo", |
| file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14", |
| arch="i386:x86_64"}, |
| frame={level="10",addr="0x000107a4",func="foo", |
| file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14", |
| arch="i386:x86_64"}, |
| frame={level="11",addr="0x00010738",func="main", |
| file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="4", |
| arch="i386:x86_64"}] |
| (gdb) |
| </pre> |
| <p>Show frames between <var>low_frame</var> and <var>high_frame</var>: |
| |
| <pre class="smallexample"> (gdb) |
| -stack-list-frames 3 5 |
| ^done,stack= |
| [frame={level="3",addr="0x000107a4",func="foo", |
| file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14", |
| arch="i386:x86_64"}, |
| frame={level="4",addr="0x000107a4",func="foo", |
| file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14", |
| arch="i386:x86_64"}, |
| frame={level="5",addr="0x000107a4",func="foo", |
| file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14", |
| arch="i386:x86_64"}] |
| (gdb) |
| </pre> |
| <p>Show a single frame: |
| |
| <pre class="smallexample"> (gdb) |
| -stack-list-frames 3 3 |
| ^done,stack= |
| [frame={level="3",addr="0x000107a4",func="foo", |
| file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14", |
| arch="i386:x86_64"}] |
| (gdb) |
| </pre> |
| <h4 class="subheading">The <code>-stack-list-locals</code> Command</h4> |
| |
| <p><a name="index-g_t_002dstack_002dlist_002dlocals-3024"></a><a name="g_t_002dstack_002dlist_002dlocals"></a> |
| |
| <h5 class="subsubheading">Synopsis</h5> |
| |
| <pre class="smallexample"> -stack-list-locals [ --no-frame-filters ] [ --skip-unavailable ] <var>print-values</var> |
| </pre> |
| <p>Display the local variable names for the selected frame. If |
| <var>print-values</var> is 0 or <code>--no-values</code>, print only the names of |
| the variables; if it is 1 or <code>--all-values</code>, print also their |
| values; and if it is 2 or <code>--simple-values</code>, print the name, |
| type and value for simple data types, and the name and type for arrays, |
| structures and unions. In this last case, a frontend can immediately |
| display the value of simple data types and create variable objects for |
| other data types when the user wishes to explore their values in |
| more detail. If the option <code>--no-frame-filters</code> is supplied, then |
| Python frame filters will not be executed. |
| |
| <p>If the <code>--skip-unavailable</code> option is specified, local variables |
| that are not available are not listed. Partially available local |
| variables are still displayed, however. |
| |
| <p>This command is deprecated in favor of the |
| ‘<samp><span class="samp">-stack-list-variables</span></samp>’ command. |
| |
| <h5 class="subsubheading"><span class="sc">gdb</span> Command</h5> |
| |
| <p>‘<samp><span class="samp">info locals</span></samp>’ in <span class="sc">gdb</span>, ‘<samp><span class="samp">gdb_get_locals</span></samp>’ in <code>gdbtk</code>. |
| |
| <h5 class="subsubheading">Example</h5> |
| |
| <pre class="smallexample"> (gdb) |
| -stack-list-locals 0 |
| ^done,locals=[name="A",name="B",name="C"] |
| (gdb) |
| -stack-list-locals --all-values |
| ^done,locals=[{name="A",value="1"},{name="B",value="2"}, |
| {name="C",value="{1, 2, 3}"}] |
| -stack-list-locals --simple-values |
| ^done,locals=[{name="A",type="int",value="1"}, |
| {name="B",type="int",value="2"},{name="C",type="int [3]"}] |
| (gdb) |
| </pre> |
| <p><a name="g_t_002dstack_002dlist_002dvariables"></a> |
| |
| <h4 class="subheading">The <code>-stack-list-variables</code> Command</h4> |
| |
| <p><a name="index-g_t_002dstack_002dlist_002dvariables-3025"></a> |
| |
| <h5 class="subsubheading">Synopsis</h5> |
| |
| <pre class="smallexample"> -stack-list-variables [ --no-frame-filters ] [ --skip-unavailable ] <var>print-values</var> |
| </pre> |
| <p>Display the names of local variables and function arguments for the selected frame. If |
| <var>print-values</var> is 0 or <code>--no-values</code>, print only the names of |
| the variables; if it is 1 or <code>--all-values</code>, print also their |
| values; and if it is 2 or <code>--simple-values</code>, print the name, |
| type and value for simple data types, and the name and type for arrays, |
| structures and unions. If the option <code>--no-frame-filters</code> is |
| supplied, then Python frame filters will not be executed. |
| |
| <p>If the <code>--skip-unavailable</code> option is specified, local variables |
| and arguments that are not available are not listed. Partially |
| available arguments and local variables are still displayed, however. |
| |
| <h5 class="subsubheading">Example</h5> |
| |
| <pre class="smallexample"> (gdb) |
| -stack-list-variables --thread 1 --frame 0 --all-values |
| ^done,variables=[{name="x",value="11"},{name="s",value="{a = 1, b = 2}"}] |
| (gdb) |
| </pre> |
| <h4 class="subheading">The <code>-stack-select-frame</code> Command</h4> |
| |
| <p><a name="index-g_t_002dstack_002dselect_002dframe-3026"></a> |
| |
| <h5 class="subsubheading">Synopsis</h5> |
| |
| <pre class="smallexample"> -stack-select-frame <var>framenum</var> |
| </pre> |
| <p>Change the selected frame. Select a different frame <var>framenum</var> on |
| the stack. |
| |
| <p>This command in deprecated in favor of passing the ‘<samp><span class="samp">--frame</span></samp>’ |
| option to every command. |
| |
| <h5 class="subsubheading"><span class="sc">gdb</span> Command</h5> |
| |
| <p>The corresponding <span class="sc">gdb</span> commands are ‘<samp><span class="samp">frame</span></samp>’, ‘<samp><span class="samp">up</span></samp>’, |
| ‘<samp><span class="samp">down</span></samp>’, ‘<samp><span class="samp">select-frame</span></samp>’, ‘<samp><span class="samp">up-silent</span></samp>’, and ‘<samp><span class="samp">down-silent</span></samp>’. |
| |
| <h5 class="subsubheading">Example</h5> |
| |
| <pre class="smallexample"> (gdb) |
| -stack-select-frame 2 |
| ^done |
| (gdb) |
| </pre> |
| <!-- %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% --> |
| </body></html> |
| |
