Emit and handle (custom) `-register-changed` notification
This commit adds new (custom) asynchronous notification about register value
being changed. Standard GDB does not notify MI clients about register value
being changed when debugging (for example, by CLI command `set $rax = 1` or
via Python's `Value.assign()`).
This caused libgdb's register value cache being out of sync. In the past,
this was partially worked around by manually emiting the notification on
`GDBRegisterWithValue` APIs, but this did not (and could not) handle the case
register was changed from GDB command line.
To solve this problem, this commit installs a custom Python event handler
that emits new GDB/MI notification - `-register-changed` - whenever a register
changes after debugee is stopped. This has been enabled by upstream GDB commit
4825fd "gdb/python: implement support for sending custom MI async notifications"
On libgdbs side, complete inferior state is invalidated. In theory, one could
carefully invalidate only the changed `GDBRegisterWithValue` but in certain cases
this could also change the backtrace (for example, if one updates stack pointer)
or position in code. So it seems safer to just invalidate everything.
"
jv:libgdbs - GNU Debugger Interface Library
Copyright (C) 2015-now Jan Vrany
Copyright (C) 2022-2023 LabWare
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the 'Software'), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
"
"{ Package: 'jv:libgdbs' }"
"{ NameSpace: Smalltalk }"
GDBMICommand subclass:#GDBMI_stack_list_arguments
instanceVariableNames:''
classVariableNames:''
poolDictionaries:''
category:'GDB-Commands-MI'
!
!GDBMI_stack_list_arguments class methodsFor:'documentation'!
copyright
"
jv:libgdbs - GNU Debugger Interface Library
Copyright (C) 2015-now Jan Vrany
Copyright (C) 2022-2023 LabWare
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the 'Software'), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
"
!
documentation
"
The `-stack-list-arguments' Command
-----------------------------------
Synopsis
........
-stack-list-arguments [ --no-frame-filters ] [ --skip-unavailable ] PRINT-VALUES
[ LOW-FRAME HIGH-FRAME ]
Display a list of the arguments for the frames between LOW-FRAME and
HIGH-FRAME (inclusive). If LOW-FRAME and HIGH-FRAME 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 LOW-FRAME is larger than the actual number of frames. On the
other hand, HIGH-FRAME may be larger than the actual number of frames,
in which case only existing frames will be returned.
If PRINT-VALUES is 0 or `--no-values', print only the names of the
variables; if it is 1 or `--all-values', print also their values; and
if it is 2 or `--simple-values', print the name, type and value for
simple data types, and the name and type for arrays, structures and
unions. If the option `--no-frame-filters' is supplied, then Python
frame filters will not be executed.
If the `--skip-unavailable' option is specified, arguments that are
not available are not listed. Partially available arguments are still
displayed, however.
Use of this command to obtain arguments in a single frame is
deprecated in favor of the `-stack-list-variables' command.
{No value for `GDBN'} Command
.............................
{No value for `GDBN'} does not have an equivalent command. `gdbtk' has
a `gdb_get_args' command which partially overlaps with the
functionality of `-stack-list-arguments'.
Example
.......
(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'},
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'},
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'},
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'},
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'}]
(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)
"
! !
!GDBMI_stack_list_arguments methodsFor:'accessing'!
operation
^ 'stack-list-arguments'
! !