Re: Remote query for structure layout

[Simon Marchi <simon.marchi@polymtl.ca>]

On 2021-03-28 7:06 a.m., Thomas Weißschuh wrote:> Hi everybody,
> 
> I would like to propose a new command for the remote protocol that can be used to
> query structure layouts.
> Essentially a `qSymbol` equivalent for the output of `ptype`.
> 
> Background:
> 
> The RTOS-support in OpenOCD has to read in-memory datastructures of the debug
> target to reconstruct the threading information for GDB.
> For example for FreeRTOS this is done by first looking up the scheduler
> datastructure via `qSymbol` and then doing hardcoded pointer arithmetic based on
> the retrieved symbol addresses.
> (https://repo.or.cz/openocd.git/blob/HEAD:/src/rtos/FreeRTOS.c#l60)
> 
> Unfortunately the specific offsets inside the structures can change based on
> compilation options of FreeRTOS.
> 
> If GDB could report the information it already has from the debug information
> (as shown in `ptype /o`) via its remote protocol then the logic in OpenOCD
> could be more robust.
> 
> Ideas:
> 
> While a simple mapping of (structure name, member name) -> (offset) mapping
> would be enough for my usecase it would probably be better to report more data.
> 
> * type of a typename (struct, union)
> * total size of the type
> * all members of the type including their own type and offsets
> 
> Example:
> 
> # request info for type "foo_t"
> IN  qType:666f6f5f74
> # "foo_t" is a struct of size 32 and members:
> # * bar_t bar at offset 0
> # * baz_t baz at offset 16
> OUT qType:666f6f5f74:struct:32:0;6261725f74;626172,16;62617a5f74;62617a
> 
> (Or some XML equivalent)
> 
> Is this something that would fit into gdb?
> 
> Regards,
> Thomas

Hi,

I think that would make sense.  We already help the stub look up some
things in the debugged process using qSymbol, so it would be a bit silly
to say "now you're on your own to interpret it!".

If we go there, we could also help the stub make the link between the
symbol and its type, so that you don't have to hardcode that symbol
"foo" is of type "foo_t".  For example, if you could also pass a symbol
name (like pxCurrentTCB) to qType, you wouldn't have to hardcode its
type name in the openocd source code, it's one less thing that can go
wrong.  Or it could be another packet that does symbol name to type
name, which you then pass to qType.

Simon