Files
binutils-gdb/gdbsupport/format.h
Simon Marchi f6022f5390 gdb, gdbsupport, gdbserver: add support for printf 't' length modifier
Tom de Vries reported [1] that a use of the `t` printf length modifier
(used for ptrdiff_t) breaks "set debug dwarf-die 1":

    +break -qualified main
    Reading Reading compcomp unit at offset  unit at offset 0x00x39

    Reading comp unit at offset 0x1a8
    Reading comp unit at offset 0x1e9
    Reading comp unit at offset 0x2c5
    Reading comp unit at offset 0x2a2
    Reading comp unit at offset 0x904
    Unrecognized format specifier 't' in printf

This use is in dwarf2/read.c:

      gdb_printf (gdb_stdlog, "Read die from %s@0x%tx of %s:\n",
		  m_die_section->get_name (),
		  (begin_info_ptr - m_die_section->buffer),
		  bfd_get_filename (m_abfd));

Add support for the `t` length modifier in format_pieces, which
gdb_printf ultimately uses (through ui_out::vmessage).  Modify the three
users of format_pieces: gdb's printf command, gdb's ui_out::vmessage
function and gdbserver's ax_printf function.

The implementation is mostly copied from what we do for size_t.

Since format_pieces is also used to implement the printf command, this
patch brings user-visible changes.  Before:

    (gdb) printf "%td\n", -123
    ️ Unrecognized format specifier 't' in printf

After:

    (gdb) printf "%td\n", -123
    -123

[1] https://inbox.sourceware.org/gdb-patches/d4ccce34-aad5-4e3d-8fc9-efb2fc11275c@suse.de/

Change-Id: Ie9fce78f5f48082d8f8a9ca2847b5ae26acaa60d
Approved-By: Tom Tromey <tom@tromey.com>
2026-01-15 14:34:54 -05:00

104 lines
2.9 KiB
C++

/* Parse a printf-style format string.
Copyright (C) 1986-2026 Free Software Foundation, Inc.
This file is part of GDB.
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>. */
#ifndef GDBSUPPORT_FORMAT_H
#define GDBSUPPORT_FORMAT_H
#if defined(__MINGW32__) && !defined(PRINTF_HAS_LONG_LONG)
# define USE_PRINTF_I64 1
# define PRINTF_HAS_LONG_LONG
#else
# define USE_PRINTF_I64 0
#endif
/* The argclass represents the general type of data that goes with a
format directive; int_arg for %d, long_arg for %l, and so forth.
Note that these primarily distinguish types by size and need for
special handling, so for instance %u and %x are (at present) also
classed as int_arg. */
enum argclass
{
literal_piece,
int_arg, long_arg, long_long_arg, size_t_arg, ptrdiff_t_arg, ptr_arg,
string_arg, wide_string_arg, wide_char_arg,
double_arg, long_double_arg,
dec32float_arg, dec64float_arg, dec128float_arg,
value_arg
};
/* A format piece is a section of the format string that may include a
single print directive somewhere in it, and the associated class
for the argument. */
struct format_piece
{
format_piece (std::string::size_type start, enum argclass argc, int n)
: start (start),
argclass (argc),
n_int_args (n)
{}
/* Where this piece starts, within FORMAT_PIECES::M_STORAGE. */
std::string::size_type start;
enum argclass argclass;
/* Count the number of preceding 'int' arguments that must be passed
along. This is used for a width or precision of '*'. Note that
this feature is only available in "gdb_extensions" mode. */
int n_int_args;
};
class format_pieces
{
public:
format_pieces (const char **arg, bool gdb_extensions = false,
bool value_extension = false);
~format_pieces () = default;
DISABLE_COPY_AND_ASSIGN (format_pieces);
typedef std::vector<format_piece>::iterator iterator;
iterator begin ()
{
return m_pieces.begin ();
}
iterator end ()
{
return m_pieces.end ();
}
/* Return the string associated to PIECE. */
const char *piece_str (const format_piece &piece)
{ return &m_storage[piece.start]; }
private:
std::vector<format_piece> m_pieces;
/* This is used as a buffer of concatenated null-terminated strings. The
individual strings are referenced by FORMAT_PIECE::START. */
std::string m_storage;
};
#endif /* GDBSUPPORT_FORMAT_H */