From 968738f9b133c8bda7d5ced178fd92f4445d791c Mon Sep 17 00:00:00 2001 From: Yaakov Selkowitz Date: Thu, 18 Dec 2014 14:55:21 +0000 Subject: Implement BSD/GNU unlocked stdio extensions. * libc/include/stdio.h (clearerr_unlocked, feof_unlocked, ferror_unlocked, fflush_unlocked, fgetc_unlocked, fgets_unlocked, fileno_unlocked, fputc_unlocked, fputs_unlocked, fread_unlocked, fwrite_unlocked): Declare. * libc/include/wchar.h (fgetwc_unlocked, fgetws_unlocked, fputwc_unlocked, fputws_unlocked, getwc_unlocked, getwchar_unlocked, putwc_unlocked, putwchar_unlocked): Declare. * libc/stdio/Makefile.am (ELIX_4_SOURCES): Add clearerr_u.c, feof_u.c, ferror_u.c, fflush_u.c, fgetc_u.c, fgets_u.c, fgetwc_u.c, fgetws_u.c, fileno_u.c, fputc_u.c, fputs_u.c, fputwc_u.c, fputws_u.c, fread_u.c, fwrite_u.c, getwc_u.c, getwchar_u.c, putwc_u.c, putwchar_u.c. Add necessary dependencies. * libc/stdio/Makefile.in: Regenerate. * libc/stdio/clearerr.c: Document unlocked variant. * libc/stdio/clearerr_u.c: New file. * libc/stdio/feof.c: Document unlocked variant. * libc/stdio/feof_u.c: New file. * libc/stdio/ferror.c: Document unlocked variant. * libc/stdio/ferror_u.c: New file. * libc/stdio/fflush.c: Add __IMPL_UNLOCKED__ overrides. Document unlocked variants. * libc/stdio/fflush_u.c: New file. * libc/stdio/fgetc.c: Document unlocked variants. * libc/stdio/fgetc_u.c: New file. * libc/stdio/fgets.c: Add __IMPL_UNLOCKED__ overrides. Document unlocked variants. * libc/stdio/fgets_u.c: New file. * libc/stdio/fgetwc.c: Document unlocked variants. (__fgetwc): Make non-static. * libc/stdio/fgetwc_u.c: New file. * libc/stdio/fgetws.c: Add __IMPL_UNLOCKED__ overrides. Document unlocked variants. * libc/stdio/fgetws_u.c: New file. * libc/stdio/fileno.c: Document unlocked variant. * libc/stdio/fileno_u.c: New file. * libc/stdio/fputc.c: Document unlocked variants. * libc/stdio/fputc_u.c: New file. * libc/stdio/fputs.c: Add __IMPL_UNLOCKED__ overrides. Document unlocked variants. * libc/stdio/fputs_u.c: New file. * libc/stdio/fputwc.c: Document unlocked variants. (__fputwc): Make non-static. * libc/stdio/fputwc_u.c: New file. * libc/stdio/fputws.c: Add __IMPL_UNLOCKED__ overrides. Document unlocked variants. * libc/stdio/fputws_u.c: New file. * libc/stdio/fread.c: Add __IMPL_UNLOCKED__ overrides. Document unlocked variants. * libc/stdio/fread_u.c: New file. * libc/stdio/fwrite.c: Add __IMPL_UNLOCKED__ overrides. Document unlocked variants. * libc/stdio/fwrite_u.c: New file. * libc/stdio/getwc_u.c: New file. * libc/stdio/getwchar.c: Document unlocked variants. * libc/stdio/getwchar_u.c: New file. * libc/stdio/local.h: Define locking macros as empty ifdef __IMPL_UNLOCKED__. (__fgetwc, __fputwc): Declare. * libc/stdio/putwc_u.c: New file. * libc/stdio/putwchar.c: Document unlocked variants. * libc/stdio/putwchar_u.c: New file. --- newlib/libc/stdio/fgetc.c | 42 ++++++++++++++++++++++++++++++++++++++---- 1 file changed, 38 insertions(+), 4 deletions(-) (limited to 'newlib/libc/stdio/fgetc.c') diff --git a/newlib/libc/stdio/fgetc.c b/newlib/libc/stdio/fgetc.c index 20492d24b..34447a2c8 100644 --- a/newlib/libc/stdio/fgetc.c +++ b/newlib/libc/stdio/fgetc.c @@ -17,30 +17,53 @@ /* FUNCTION -<>---get a character from a file or stream +<>, <>---get a character from a file or stream INDEX fgetc +INDEX + fgetc_unlocked INDEX _fgetc_r +INDEX + _fgetc_unlocked_r ANSI_SYNOPSIS #include int fgetc(FILE *<[fp]>); + #define _BSD_SOURCE + #include + int fgetc_unlocked(FILE *<[fp]>); + #include int _fgetc_r(struct _reent *<[ptr]>, FILE *<[fp]>); + #define _BSD_SOURCE + #include + int _fgetc_unlocked_r(struct _reent *<[ptr]>, FILE *<[fp]>); + TRAD_SYNOPSIS #include int fgetc(<[fp]>) FILE *<[fp]>; + #define _BSD_SOURCE + #include + int fgetc_unlocked(<[fp]>) + FILE *<[fp]>; + #include int _fgetc_r(<[ptr]>, <[fp]>) struct _reent *<[ptr]>; FILE *<[fp]>; + #define _BSD_SOURCE + #include + int _fgetc_unlocked_r(<[ptr]>, <[fp]>) + struct _reent *<[ptr]>; + FILE *<[fp]>; + DESCRIPTION Use <> to get the next single character from the file or stream identified by <[fp]>. As a side effect, <> advances the file's @@ -48,9 +71,18 @@ current position indicator. For a macro version of this function, see <>. -The function <<_fgetc_r>> is simply a reentrant version of -<> that is passed the additional reentrant structure -pointer argument: <[ptr]>. +<> is a non-thread-safe version of <>. +<> may only safely be used within a scope +protected by flockfile() (or ftrylockfile()) and funlockfile(). This +function may safely be used in a multi-threaded program if and only +if they are called while the invoking thread owns the (FILE *) +object, as is the case after a successful call to the flockfile() or +ftrylockfile() functions. If threads are disabled, then +<> is equivalent to <>. + +The functions <<_fgetc_r>> and <<_fgetc_unlocked_r>> are simply reentrant +versions that are passed the additional reentrant structure pointer +argument: <[ptr]>. RETURNS The next character (read as an <>, and cast to @@ -63,6 +95,8 @@ using the <> and <> functions. PORTABILITY ANSI C requires <>. +<> is a BSD extension also provided by GNU libc. + Supporting OS subroutines required: <>, <>, <>, <>, <>, <>, <>. */ -- cgit v1.2.3