[v2,5/8] Add __v*printf_internal with flags arguments.

From: Zack Weinberg <zackw@panix.com>

  From: Zack Weinberg <zackw@panix.com>

Changes since v1:

  - Fixed white-space errors.
  - In argp_fmtstream_printf, do not call __vsnprintf, instead call
    __vsnprintf_internal passing 0 to mode_flags.  With this change,
    there's no need to use libc_hidden_{proto,def} for __vsnprintf
    (because it doesn't have other internal callers).  Also, it is no
    longer necessary to '#undef __vsnprintf' and '#define __vsnprintf
    vsnprintf' in argp-namefrob.h.
  - In __argp_error and __argp_failure call __vasprintf_internal
    directly, passing 0 (zero) to mode_flags, since these functions do
    not currently have support for long double with the same format as
    double (a subsequent patch in my personal branch provides that and
    adjusts the call accordingly).
    With this change, there's no need to use libc_hidden_{proto,def} for
    __vasprintf.  It is also no longer required to '#undef __vasprintf'
    and '#define __vasprintf vasprintf' in argp-namefrob.h.
  - Declarations of _IO_vfprintf, _IO_vsprintf, __vfwprintf, and
    __vswprintf removed from the internal headers: libio.h, iolibio.h,
    and include/wchar.h, since they are no longer called from within
    glibc.
  - Added attribute_hidden to all new internal functions, since they are
    all called from within libc.
    Here are the objdumps of one such calls, before and after this
    change, on a 32-bits powerpc machine:
    Without attribute_hidden:
      $ objdump -d --reloc INTERNAL-VISIBLE-glibc/libc.so | grep "<vprintf@@GLIBC_2.4>:" -A 21
      000523a0 <vprintf@@GLIBC_2.4>:
         523a0:       94 21 ff f0     stwu    r1,-16(r1)
         523a4:       7c 85 23 78     mr      r5,r4
         523a8:       7c 08 02 a6     mflr    r0
         523ac:       42 9f 00 05     bcl     20,4*cr7+so,523b0 <vprintf@@GLIBC_2.4+0x10>
         523b0:       7c 64 1b 78     mr      r4,r3
         523b4:       38 c0 00 00     li      r6,0
         523b8:       93 c1 00 08     stw     r30,8(r1)
         523bc:       90 01 00 14     stw     r0,20(r1)
         523c0:       7f c8 02 a6     mflr    r30
         523c4:       3f de 00 15     addis   r30,r30,21
         523c8:       3b de dc 44     addi    r30,r30,-9148
         523cc:       81 3e fe 80     lwz     r9,-384(r30)
         523d0:       80 69 00 00     lwz     r3,0(r9)
         523d4:       48 01 52 bd     bl      67690 <__vfprintf_internal>
         523d8:       80 01 00 14     lwz     r0,20(r1)
         523dc:       83 c1 00 08     lwz     r30,8(r1)
         523e0:       38 21 00 10     addi    r1,r1,16
         523e4:       7c 08 03 a6     mtlr    r0
         523e8:       4e 80 00 20     blr
    With attribute_hidden:
      $ objdump -d --reloc INTERNAL-HIDDEN-glibc/libc.so | grep "<vprintf@@GLIBC_2.4>:" -A 18
      00052370 <vprintf@@GLIBC_2.4>:
         52370:       94 21 ff f0     stwu    r1,-16(r1)
         52374:       7c 85 23 78     mr      r5,r4
         52378:       7d 88 02 a6     mflr    r12
         5237c:       42 9f 00 05     bcl     20,4*cr7+so,52380 <vprintf@@GLIBC_2.4+0x10>
         52380:       7c 64 1b 78     mr      r4,r3
         52384:       38 c0 00 00     li      r6,0
         52388:       93 c1 00 08     stw     r30,8(r1)
         5238c:       7f c8 02 a6     mflr    r30
         52390:       7d 88 03 a6     mtlr    r12
         52394:       3f de 00 15     addis   r30,r30,21
         52398:       3b de dc 74     addi    r30,r30,-9100
         5239c:       81 3e fe 80     lwz     r9,-384(r30)
         523a0:       83 c1 00 08     lwz     r30,8(r1)
         523a4:       80 69 00 00     lwz     r3,0(r9)
         523a8:       38 21 00 10     addi    r1,r1,16
         523ac:       48 01 52 24     b       675d0 <__vfprintf_internal>
    The branch-and-link instruction is gone.

Additional note for review:

  - Reviewing the changes from vfprintf.c to vfprintf-internal.c in the
    original patch would be vey hard, because git doesn't detect the
    filename change.  To make review a little easier, I did as Zack did
    and manually edited the diff.  I'll reply to this thread and attach
    the original patch if someone wants to apply it.
    (ping me if I forget it)

-- 8< --
There are a lot more printf variants than there are scanf variants,
and the code for setting up and tearing down their custom FILE
variants around the call to __vf(w)printf is more complicated and
variable.  Therefore, I have added _internal versions of all the
v*printf variants, rather than introducing helper routines so that
they can all directly call __vf(w)printf_internal, as was done with
scanf.

As with the scanf changes, in this patch the _internal functions still
look at the environmental mode bits and all callers pass 0 for the
flags parameter.

Several of the affected public functions had _IO_ name aliases that
were not exported (but, in one case, appeared in libio.h anyway);
I was originally planning to leave them as aliases to avoid having
to touch internal callers, but it turns out ldbl_*_alias only work
for exported symbols, so they've all been removed instead.  It also
turns out there were hardly any internal callers.  _IO_vsprintf and
_IO_vfprintf *are* exported, so those two stick around.

Summary for the changes to each of the affected symbols:

  _IO_vfprintf, _IO_vsprintf:
    All internal calls removed, thus the internal declarations, as well
    as uses of libc_hidden_proto and libc_hidden_def, were also removed.
    The external symbol is now exposed via uses of ldbl_strong_alias
    to __vfprintf_internal and __vsprintf_internal, respectively.

  _IO_vasprintf, _IO_vdprintf, _IO_vsnprintf,
  _IO_vfwprintf, _IO_vswprintf,
  _IO_obstack_vprintf, _IO_obstack_printf:
    All internal calls removed, thus declaration in internal headers
    were also removed.  They were never exported, so there are no
    aliases tying them to the internal functions.  I.e.: entirely gone.

  __vsnprintf:
    Internal calls were always preceded by macros such as
      #define __vsnprintf _IO_vsnprintf, and
      #define __vsnprintf vsnprintf
    The macros were removed and their uses replaced with calls to the
    new internal function __vsnprintf_internal.  Since there were no
    internal calls, the internal declaration was also removed.  The
    external symbol is preserved with ldbl_weak_alias to ___vsnprintf.

  __vfwprintf:
    All internal calls converted into calls to __vfwprintf_internal,
    thus the internal declaration was removed.  The function is now a
    wrapper that calls __vfwprintf_internal.  The external symbol is
    preserved.

  __vswprintf:
    Similarly, but no external symbol.

  __vasprintf, __vdprintf, __vfprintf, __vsprintf:
    New internal wrappers.  Not exported.

  vasprintf, vdprintf, vfprintf, vsprintf, vsnprintf,
  vfwprintf, vswprintf,
  obstack_vprintf, obstack_printf:
    These functions used to be aliases to the respective _IO_* function,
    they are now aliases to their respective __* functions.

Tested for powerpc and powerpc64le.

2018-10-16  Zack Weinberg  <zackw@panix.com>
	    Gabriel F. T. Gomes  <gabriel@inconstante.eti.br>

	* libio/libioP.h (__vfprintf_internal, __vfwprintf_internal)
	(__vasprintf_internal, __vdprintf_internal, __obstack_vprintf_internal)
	(__vsprintf_internal, __vsnprintf_internal, __vswprintf_internal):
	New functions.
	(PRINTF_LDBL_IS_DBL, PRINTF_FORTIFY): New constants.
	(_IO_vasprintf, _IO_vdprintf, _IO_vsnprintf): Remove prototypes.

	* stdio-common/vfprintf-internal.c: Rename from vfprintf.c.
	Include wctype.h here if COMPILE_WPRINTF is defined.
	Define __vfprintf_internal or __vfwprintf_internal, depending
	on COMPILE_WPRINTF.
	Temporarily, on entry to this function, update mode_flags
	according to the environmental settings corresponding to
	PRINTF_LDBL_IS_DBL and PRINTF_FORTIFY.
	(LDBL_IS_DBL, DO_FORTIFY): New macros.	Throughout, use
	LDBL_IS_DBL instead of __ldbl_is_dbl, and DO_FORTIFY instead of
	checking _IO_FLAGS2_FORTIFY on the destination FILE.
	* stdio-common/vfwprintf-internal.c: Rename from vfwprintf.c.
	Include vfprintf-internal.c.  Don't include wctype.h.
	* stdio-common/vfprintf.c: New file.  Just define __vfprintf
	as a wrapper around __vfprintf_internal, with aliases _IO_vfprintf
	and vfprintf.
	* stdio-common/vfwprintf.c: New file.  Just define __vfwprintf
	as a wrapper around __vfwprintf_internal, with aliases _IO_vfwprintf
	and vfwprintf.
	* stdio-common/Makefile: Add vfprintf-internal and vfwprintf-internal.

	* libio/iovdprintf.c (_IO_vdprintf): Rename to __vdprintf_internal
	and add mode_flags argument; use __vfprintf_internal.
	(__vdprintf): New function.  Alias vdprintf to this.
	* libio/iovsprintf.c (_IO_vsprintf, __vsprintf): Similarly.
	* libio/vasprintf.c (_IO_vasprintf, __vasprintf): Similarly.
	* libio/obprintf.c (_IO_obstack_vprintf, __obstack_vprintf): Similarly.
	(__obstack_printf): Use __obstack_printf_internal.
	* libio/vsnprintf.c (_IO_vsnprintf, ___vsnprintf): Similarly, with
	public aliases __vsnprintf and vsnprintf.
	Remove use of ldbl_hidden_def, since __vsnprintf is no longer
	called internally.
	* libio/vswprintf (_IO_vswprintf, __vswprintf): Similarly, with
	public aliases _IO_vsprintf and vsprintf.
	* libio/swprintf.c (__swprintf): Use __vswprintf_internal.
	* stdio-common/asprintf.c (__asprintf): Use __vasprintf_internal.
	* stdio-common/dprintf.c (__dprintf): Use __vdprintf_internal.
	* stdio-common/snprintf.c (__snprintf): Use __vsprintf_internal.
	* stdio-common/sprintf.c (__sprintf): Use __vsprintf_internal.

	* debug/obprintf_chk.c, debug/vasprintf_chk.c, debug/vdprintf_chk.c
	* debug/vsnprintf_chk.c, debug/vsprintf_chk.c, hurd/vpprintf.c
	* stdio-common/fprintf.c, stdio-common/fxprintf.c
	* stdio-common/printf.c: Use __vfprintf_internal.

	* debug/fwprintf_chk.c, debug/vfwprintf_chk.c, debug/vswprintf_chk.c
	* debug/vwprintf_chk.c, debug/wprintf_chk.c, libio/fwprintf.c
	* libio/vwprintf.c, libio/wprintf.c: Use __vfwprintf_internal.

	* sysdeps/ieee754/ldbl-opt/nldbl-compat.c: Use __vsprintf_internal,
	__obstack_vprintf_internal, __vasprintf_internal, __vdprintf_internal,
	__vsnprintf_internal, __vswprintf_internal, __vfprintf_internal, and
	__vfwprintf_internal.

	* libio/libio.h: Remove libc_hidden_proto and declaration for
	_IO_vfprintf.
	Remove declaration of _IO_vfwprintf.
	* libio/iolibio.h: Remove libc_hidden_proto and declaration for
	_IO_vsprintf.
	Remove declarations of _IO_vswprintf, _IO_obstack_printf, and
	_IO_obstack_printf.
	* include/stdio.h: Add prototype for __vasprintf.
	(__vsnprintf): Remove declaration, because there are no more
	internal calls.
	* include/wchar.h (__vfwprintf, __vswprintf): Remove
	declaration, because there are no more internal calls.

	* argp/argp-fmtstream.c (__argp_fmtstream_printf): Use
	__vsnprintf_internal, instead of _IO_vsnprintf.
	* argp/argp-help.c (__argp_error, __argp_failure): Use
	__vasprintf_internal, instead of _IO_vasprintf.
	* argp/argp-namefrob.h (__vsnprintf): Do not undefined then
	redefine, because there are no more internal calls.

Signed-off-by: Zack Weinberg <zackw@panix.com>
Signed-off-by: Gabriel F. T. Gomes <gabriel@inconstante.eti.br>
---
 argp/argp-fmtstream.c                   |    3 +-
 argp/argp-help.c                        |    4 +-
 argp/argp-namefrob.h                    |    2 -
 debug/fwprintf_chk.c                    |    2 +-
 debug/obprintf_chk.c                    |    2 +-
 debug/vasprintf_chk.c                   |    2 +-
 debug/vdprintf_chk.c                    |    2 +-
 debug/vfwprintf_chk.c                   |    2 +-
 debug/vsnprintf_chk.c                   |    2 +-
 debug/vsprintf_chk.c                    |    2 +-
 debug/vswprintf_chk.c                   |    2 +-
 debug/vwprintf_chk.c                    |    2 +-
 debug/wprintf_chk.c                     |    2 +-
 hurd/vpprintf.c                         |    2 +-
 include/stdio.h                         |    3 -
 include/wchar.h                         |   10 -
 libio/fwprintf.c                        |    2 +-
 libio/iolibio.h                         |    8 -
 libio/iovdprintf.c                      |   13 +-
 libio/iovsprintf.c                      |   16 +-
 libio/libio.h                           |    5 -
 libio/libioP.h                          |   40 +-
 libio/obprintf.c                        |   19 +-
 libio/swprintf.c                        |    2 +-
 libio/vasprintf.c                       |   20 +-
 libio/vsnprintf.c                       |   16 +-
 libio/vswprintf.c                       |   16 +-
 libio/vwprintf.c                        |    2 +-
 libio/wprintf.c                         |    2 +-
 stdio-common/Makefile                   |    3 +-
 stdio-common/asprintf.c                 |    6 +-
 stdio-common/dprintf.c                  |    5 +-
 stdio-common/fprintf.c                  |    2 +-
 stdio-common/fxprintf.c                 |    4 +-
 stdio-common/printf.c                   |    3 +-
 stdio-common/snprintf.c                 |    4 +-
 stdio-common/sprintf.c                  |    4 +-
 stdio-common/vfprintf-internal.c        | 2366 +++++++++++++++++++++++++++++++
 stdio-common/vfprintf.c                 | 2351 +-----------------------------
 stdio-common/vfwprintf-internal.c       |    2 +
 stdio-common/vfwprintf.c                |   28 +-
 stdio-common/vprintf.c                  |    4 +-
 stdlib/strfrom-skeleton.c               |    2 +-
 sysdeps/ieee754/ldbl-opt/nldbl-compat.c |   21 +-
 44 files changed, 2544 insertions(+), 2466 deletions(-)
 create mode 100644 stdio-common/vfprintf-internal.c
 create mode 100644 stdio-common/vfwprintf-internal.c

[v2,5/8] Add __v*printf_internal with flags arguments.

Commit Message

Comments

Patch