glibc/libio/vsnprintf.c
Florian Weimer e88b9f0e5c stdio-common: Convert vfprintf and related functions to buffers
vfprintf is entangled with vfwprintf (of course), __printf_fp,
__printf_fphex, __vstrfmon_l_internal, and the strfrom family of
functions.  The latter use the internal snprintf functionality,
so vsnprintf is converted as well.

The simples conversion is __printf_fphex, followed by
__vstrfmon_l_internal and __printf_fp, and finally
__vfprintf_internal and __vfwprintf_internal.  __vsnprintf_internal
and strfrom* are mostly consuming the new interfaces, so they
are comparatively simple.

__printf_fp is a public symbol, so the FILE *-based interface
had to preserved.

The __printf_fp rewrite does not change the actual binary-to-decimal
conversion algorithm, and digits are still not emitted directly to
the target buffer.  However, the staging buffer now uses bytes
instead of wide characters, and one buffer copy is eliminated.

The changes are at least performance-neutral in my testing.
Floating point printing and snprintf improved measurably, so that
this Lua script

  for i=1,5000000 do
      print(i, i * math.pi)
  end

runs about 5% faster for me.  To preserve fprintf performance for
a simple "%d" format, this commit has some logic changes under
LABEL (unsigned_number) to avoid additional function calls.  There
are certainly some very easy performance improvements here: binary,
octal and hexadecimal formatting can easily avoid the temporary work
buffer (the number of digits can be computed ahead-of-time using one
of the __builtin_clz* built-ins). Decimal formatting can use a
specialized version of _itoa_word for base 10.

The existing (inconsistent) width handling between strfmon and printf
is preserved here.  __print_fp_buffer_1 would have to use
__translated_number_width to achieve ISO conformance for printf.

Test expectations in libio/tst-vtables-common.c are adjusted because
the internal staging buffer merges all virtual function calls into
one.

In general, stack buffer usage is greatly reduced, particularly for
unbuffered input streams.  __printf_fp can still use a large buffer
in binary128 mode for %g, though.

Reviewed-by: Adhemerval Zanella  <adhemerval.zanella@linaro.org>
2022-12-19 18:56:54 +01:00

107 lines
3.7 KiB
C

/* Copyright (C) 1994-2022 Free Software Foundation, Inc.
This file is part of the GNU C Library.
The GNU C Library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
The GNU C Library 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
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with the GNU C Library; if not, see
<https://www.gnu.org/licenses/>.
As a special exception, if you link the code in this file with
files compiled with a GNU compiler to produce an executable,
that does not cause the resulting executable to be covered by
the GNU Lesser General Public License. This exception does not
however invalidate any other reasons why the executable file
might be covered by the GNU Lesser General Public License.
This exception applies to code released by its copyright holders
in files containing the exception. */
#include "libioP.h"
#include <array_length.h>
#include <printf.h>
#include <printf_buffer.h>
void
__printf_buffer_flush_snprintf (struct __printf_buffer_snprintf *buf)
{
/* Record the bytes written so far, before switching buffers. */
buf->base.written += buf->base.write_ptr - buf->base.write_base;
if (buf->base.write_base != buf->discard)
{
/* We just finished writing the caller-supplied buffer. Force
NUL termination if the string length is not zero. */
if (buf->base.write_base != buf->base.write_end)
buf->base.write_end[-1] = '\0';
/* Switch to the discard buffer. */
buf->base.write_base = buf->discard;
buf->base.write_ptr = buf->discard;
buf->base.write_end = array_end (buf->discard);
}
buf->base.write_base = buf->discard;
buf->base.write_ptr = buf->discard;
}
void
__printf_buffer_snprintf_init (struct __printf_buffer_snprintf *buf,
char *buffer, size_t length)
{
__printf_buffer_init (&buf->base, buffer, length,
__printf_buffer_mode_snprintf);
if (length > 0)
/* Historic behavior for trivially overlapping buffers (checked by
the test suite). */
*buffer = '\0';
}
int
__printf_buffer_snprintf_done (struct __printf_buffer_snprintf *buf)
{
/* NB: Do not check for buf->base.fail here. Write the null
terminator even in case of errors. */
if (buf->base.write_ptr < buf->base.write_end)
*buf->base.write_ptr = '\0';
else if (buf->base.write_ptr > buf->base.write_base)
/* If write_ptr == write_base, nothing has been written. No null
termination is needed because of the early truncation in
__printf_buffer_snprintf_init (the historic behavior).
We might also be at the start of the discard buffer, but in
this case __printf_buffer_flush_snprintf has already written
the NUL terminator. */
buf->base.write_ptr[-1] = '\0';
return __printf_buffer_done (&buf->base);
}
int
__vsnprintf_internal (char *string, size_t maxlen, const char *format,
va_list args, unsigned int mode_flags)
{
struct __printf_buffer_snprintf buf;
__printf_buffer_snprintf_init (&buf, string, maxlen);
__printf_buffer (&buf.base, format, args, mode_flags);
return __printf_buffer_snprintf_done (&buf);
}
int
___vsnprintf (char *string, size_t maxlen, const char *format, va_list args)
{
return __vsnprintf_internal (string, maxlen, format, args, 0);
}
ldbl_weak_alias (___vsnprintf, __vsnprintf)
ldbl_weak_alias (___vsnprintf, vsnprintf)