Remove getc and putc macros from the public stdio.h.

The getc and putc macros in the public stdio.h expand to call _IO_getc
and _IO_putc respectively.  As _IO_getc, fgetc, and getc are all aliases
for the same function, and _IO_putc, fputc, and putc are also all aliases
for the same function, the macros are pointless.  The C standard does
not require getc and putc to be macros, so let's just not have macros.
All four symbols are exported from libc.so at the same, ancient symbol
version, so there should be no risks for binary compatibility.  Similarly,
the getchar and putchar inlines in bits/stdio.h forward to getc and putc
instead of their _IO_ aliases.

As a change from longstanding historical practice, this does seem
like it might break _something_, so there is a note in NEWS, which
is also a convenient place to advise people that if they thought getc
and putc had reduced per-character overhead they should consider using
getc_unlocked and putc_unlocked instead.  (These are also not macros,
but when optimizing, they are inlines.)

	* libio/stdio.h: Don't define getc or putc as macros.
	* libio/bits/stdio.h (getchar, putchar): Use getc and putc,
	not _IO_getc and _IO_putc.
This commit is contained in:
Zack Weinberg 2018-02-05 14:42:29 -05:00
parent de6da571ee
commit 26c07172cd
4 changed files with 12 additions and 11 deletions

View File

@ -1,5 +1,9 @@
2018-02-06 Zack Weinberg <zackw@panix.com> 2018-02-06 Zack Weinberg <zackw@panix.com>
* libio/stdio.h: Don't define getc or putc as macros.
* libio/bits/stdio.h (getchar, putchar): Use getc and putc,
not _IO_getc and _IO_putc.
* stdio-common/tstgetln.c: Don't redefine FILE, va_list, or BUFSIZ. * stdio-common/tstgetln.c: Don't redefine FILE, va_list, or BUFSIZ.
* stdio-common/tstgetln.c: Don't redefine ssize_t. * stdio-common/tstgetln.c: Don't redefine ssize_t.

7
NEWS
View File

@ -13,7 +13,12 @@ Major new features:
Deprecated and removed features, and other changes affecting compatibility: Deprecated and removed features, and other changes affecting compatibility:
[Add deprecations, removals and changes affecting compatibility here] * The stdio.h functions 'getc' and 'putc' are no longer defined as macros.
This was never required by the C standard, and the macros just expanded
to call alternative names for the same functions. If you hoped getc and
putc would provide performance improvements over fgetc and fputc, instead
investigate using (f)getc_unlocked and (f)putc_unlocked, and, if
necessary, flockfile and funlockfile.
Changes to build and runtime requirements: Changes to build and runtime requirements:

View File

@ -43,7 +43,7 @@ vprintf (const char *__restrict __fmt, _G_va_list __arg)
__STDIO_INLINE int __STDIO_INLINE int
getchar (void) getchar (void)
{ {
return _IO_getc (stdin); return getc (stdin);
} }
@ -78,7 +78,7 @@ getchar_unlocked (void)
__STDIO_INLINE int __STDIO_INLINE int
putchar (int __c) putchar (int __c)
{ {
return _IO_putc (__c, stdout); return putc (__c, stdout);
} }

View File

@ -483,10 +483,6 @@ extern int getc (FILE *__stream);
marked with __THROW. */ marked with __THROW. */
extern int getchar (void); extern int getchar (void);
/* The C standard explicitly says this is a macro, so we always do the
optimization for it. */
#define getc(_fp) _IO_getc (_fp)
#ifdef __USE_POSIX199506 #ifdef __USE_POSIX199506
/* These are defined in POSIX.1:1996. /* These are defined in POSIX.1:1996.
@ -523,10 +519,6 @@ extern int putc (int __c, FILE *__stream);
marked with __THROW. */ marked with __THROW. */
extern int putchar (int __c); extern int putchar (int __c);
/* The C standard explicitly says this can be a macro,
so we always do the optimization for it. */
#define putc(_ch, _fp) _IO_putc (_ch, _fp)
#ifdef __USE_MISC #ifdef __USE_MISC
/* Faster version when locking is not necessary. /* Faster version when locking is not necessary.