libstdc++: Optimize std::ostream inserters for single characters
authorJonathan Wakely <jwakely@redhat.com>
Mon, 10 Jan 2022 17:38:33 +0000 (17:38 +0000)
committerJonathan Wakely <jwakely@redhat.com>
Tue, 11 Jan 2022 13:28:46 +0000 (13:28 +0000)
commite4fe6dba90b831dbd8f5e23041c5e0e8bdd75332
treee9757b17655a98468412868faf777a6f372933c5
parent7317a46128a3572f39d1d8f96155111d00d9d229
libstdc++: Optimize std::ostream inserters for single characters

On the libsdc++ mailing list Lewis Hyatt pointed out the performance
overhead of using sputn in stream inserters, rather than writing
directly to the streambuf's put area:
https://gcc.gnu.org/pipermail/libstdc++/2021-July/052877.html

As Lewis noted, the standard explicitly requires a call to sputn for
inserting a std::basic_string_view or std::basic_string.  But for
inserting single characters or null-terminated strings it is more vague,
and so we can improve performance by not using the __ostream_insert
function.

This is a minimal change that avoids __ostream_insert for single
characters. We can use the unformatted basic_ostream::put(charT)
function when we don't need the additional effects of a formatted output
function (i.e. padding and resetting the width). The put function will
insert into the buffer if possible, and only make a virtual call (to
overflow) if the buffer is full.

We could also avoid sputn when inserting null-terminated character
strings, but that would require using a new function for inserting
null-terminated strings, so the existing code using sputn is still used
for basic_string and basic_string_view. My preference is to leave that
for now, and try to improve the standard. We could either remove the
requirement to call sputn, or allow sputn to write directly to the
buffer instead of calling xsputn.

libstdc++-v3/ChangeLog:

* include/std/ostream (operator<<(basic_ostream&, charT)):
Use unformatted input if no padding is needed.
(operator<<(basic_ostream<char>&, char)): Likewise.
libstdc++-v3/include/std/ostream