xref: /freebsd/lib/libc/stdio/fflush.c (revision fda0a14f4744c2851766f395775c7531e7c4f7dd)
158f0484fSRodney W. Grimes /*-
258f0484fSRodney W. Grimes  * Copyright (c) 1990, 1993
358f0484fSRodney W. Grimes  *	The Regents of the University of California.  All rights reserved.
458f0484fSRodney W. Grimes  *
558f0484fSRodney W. Grimes  * This code is derived from software contributed to Berkeley by
658f0484fSRodney W. Grimes  * Chris Torek.
758f0484fSRodney W. Grimes  *
858f0484fSRodney W. Grimes  * Redistribution and use in source and binary forms, with or without
958f0484fSRodney W. Grimes  * modification, are permitted provided that the following conditions
1058f0484fSRodney W. Grimes  * are met:
1158f0484fSRodney W. Grimes  * 1. Redistributions of source code must retain the above copyright
1258f0484fSRodney W. Grimes  *    notice, this list of conditions and the following disclaimer.
1358f0484fSRodney W. Grimes  * 2. Redistributions in binary form must reproduce the above copyright
1458f0484fSRodney W. Grimes  *    notice, this list of conditions and the following disclaimer in the
1558f0484fSRodney W. Grimes  *    documentation and/or other materials provided with the distribution.
161d8053c5SEd Maste  * 3. Neither the name of the University nor the names of its contributors
1758f0484fSRodney W. Grimes  *    may be used to endorse or promote products derived from this software
1858f0484fSRodney W. Grimes  *    without specific prior written permission.
1958f0484fSRodney W. Grimes  *
2058f0484fSRodney W. Grimes  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
2158f0484fSRodney W. Grimes  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
2258f0484fSRodney W. Grimes  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
2358f0484fSRodney W. Grimes  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
2458f0484fSRodney W. Grimes  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
2558f0484fSRodney W. Grimes  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
2658f0484fSRodney W. Grimes  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
2758f0484fSRodney W. Grimes  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
2858f0484fSRodney W. Grimes  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
2958f0484fSRodney W. Grimes  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
3058f0484fSRodney W. Grimes  * SUCH DAMAGE.
3158f0484fSRodney W. Grimes  */
3258f0484fSRodney W. Grimes 
3358f0484fSRodney W. Grimes #if defined(LIBC_SCCS) && !defined(lint)
3458f0484fSRodney W. Grimes static char sccsid[] = "@(#)fflush.c	8.1 (Berkeley) 6/4/93";
3558f0484fSRodney W. Grimes #endif /* LIBC_SCCS and not lint */
36333fc21eSDavid E. O'Brien #include <sys/cdefs.h>
37333fc21eSDavid E. O'Brien __FBSDID("$FreeBSD$");
3858f0484fSRodney W. Grimes 
39d201fe46SDaniel Eischen #include "namespace.h"
4058f0484fSRodney W. Grimes #include <errno.h>
4158f0484fSRodney W. Grimes #include <stdio.h>
42d201fe46SDaniel Eischen #include "un-namespace.h"
43ec216c26SJohn Birrell #include "libc_private.h"
44d201fe46SDaniel Eischen #include "local.h"
4558f0484fSRodney W. Grimes 
4629ac6bd2SDaniel Eischen static int	sflush_locked(FILE *);
4729ac6bd2SDaniel Eischen 
48d201fe46SDaniel Eischen /*
49d201fe46SDaniel Eischen  * Flush a single file, or (if fp is NULL) all files.
50d201fe46SDaniel Eischen  * MT-safe version
51d201fe46SDaniel Eischen  */
52f70177e7SJulian Elischer int
53d201fe46SDaniel Eischen fflush(FILE *fp)
5458f0484fSRodney W. Grimes {
55f70177e7SJulian Elischer 	int retval;
5658f0484fSRodney W. Grimes 
5758f0484fSRodney W. Grimes 	if (fp == NULL)
5829ac6bd2SDaniel Eischen 		return (_fwalk(sflush_locked));
59*fda0a14fSKonstantin Belousov 	FLOCKFILE_CANCELSAFE(fp);
600a31135dSColin Percival 
610a31135dSColin Percival 	/*
620a31135dSColin Percival 	 * There is disagreement about the correct behaviour of fflush()
6305c9304fSPedro F. Giffuni 	 * when passed a file which is not open for writing.  According to
640a31135dSColin Percival 	 * the ISO C standard, the behaviour is undefined.
650a31135dSColin Percival 	 * Under linux, such an fflush returns success and has no effect;
660a31135dSColin Percival 	 * under Windows, such an fflush is documented as behaving instead
670a31135dSColin Percival 	 * as fpurge().
680a31135dSColin Percival 	 * Given that applications may be written with the expectation of
690a31135dSColin Percival 	 * either of these two behaviours, the only safe (non-astonishing)
700a31135dSColin Percival 	 * option is to return EBADF and ask that applications be fixed.
7105c9304fSPedro F. Giffuni 	 * SUSv3 now requires that fflush() returns success on a read-only
7205c9304fSPedro F. Giffuni 	 * stream.
7305c9304fSPedro F. Giffuni 	 *
740a31135dSColin Percival 	 */
7505c9304fSPedro F. Giffuni 	if ((fp->_flags & (__SWR | __SRW)) == 0)
7605c9304fSPedro F. Giffuni 		retval = 0;
7705c9304fSPedro F. Giffuni 	else
78f70177e7SJulian Elischer 		retval = __sflush(fp);
79*fda0a14fSKonstantin Belousov 	FUNLOCKFILE_CANCELSAFE();
80f70177e7SJulian Elischer 	return (retval);
8158f0484fSRodney W. Grimes }
8258f0484fSRodney W. Grimes 
83d201fe46SDaniel Eischen /*
84d201fe46SDaniel Eischen  * Flush a single file, or (if fp is NULL) all files.
85d201fe46SDaniel Eischen  * Non-MT-safe version
86d201fe46SDaniel Eischen  */
87f70177e7SJulian Elischer int
88d201fe46SDaniel Eischen __fflush(FILE *fp)
8958f0484fSRodney W. Grimes {
90d201fe46SDaniel Eischen 	int retval;
91d201fe46SDaniel Eischen 
92d201fe46SDaniel Eischen 	if (fp == NULL)
9329ac6bd2SDaniel Eischen 		return (_fwalk(sflush_locked));
9405c9304fSPedro F. Giffuni 	if ((fp->_flags & (__SWR | __SRW)) == 0)
9505c9304fSPedro F. Giffuni 		retval = 0;
9605c9304fSPedro F. Giffuni 	else
97d201fe46SDaniel Eischen 		retval = __sflush(fp);
98d201fe46SDaniel Eischen 	return (retval);
99d201fe46SDaniel Eischen }
100d201fe46SDaniel Eischen 
101d201fe46SDaniel Eischen int
102d201fe46SDaniel Eischen __sflush(FILE *fp)
103d201fe46SDaniel Eischen {
104d201fe46SDaniel Eischen 	unsigned char *p;
105d201fe46SDaniel Eischen 	int n, t;
10658f0484fSRodney W. Grimes 
10758f0484fSRodney W. Grimes 	t = fp->_flags;
10858f0484fSRodney W. Grimes 	if ((t & __SWR) == 0)
10958f0484fSRodney W. Grimes 		return (0);
11058f0484fSRodney W. Grimes 
11158f0484fSRodney W. Grimes 	if ((p = fp->_bf._base) == NULL)
11258f0484fSRodney W. Grimes 		return (0);
11358f0484fSRodney W. Grimes 
11458f0484fSRodney W. Grimes 	n = fp->_p - p;		/* write this much */
11558f0484fSRodney W. Grimes 
11658f0484fSRodney W. Grimes 	/*
11758f0484fSRodney W. Grimes 	 * Set these immediately to avoid problems with longjmp and to allow
11858f0484fSRodney W. Grimes 	 * exchange buffering (via setvbuf) in user write function.
11958f0484fSRodney W. Grimes 	 */
12058f0484fSRodney W. Grimes 	fp->_p = p;
12158f0484fSRodney W. Grimes 	fp->_w = t & (__SLBF|__SNBF) ? 0 : fp->_bf._size;
12258f0484fSRodney W. Grimes 
12358f0484fSRodney W. Grimes 	for (; n > 0; n -= t, p += t) {
1245e00917dSAndrey A. Chernov 		t = _swrite(fp, (char *)p, n);
12558f0484fSRodney W. Grimes 		if (t <= 0) {
12605c9304fSPedro F. Giffuni 			/* Reset _p and _w. */
127805288c2SXin LI 			if (p > fp->_p) {
128805288c2SXin LI 				/* Some was written. */
12905c9304fSPedro F. Giffuni 				memmove(fp->_p, p, n);
13005c9304fSPedro F. Giffuni 				fp->_p += n;
13105c9304fSPedro F. Giffuni 				if ((fp->_flags & (__SLBF | __SNBF)) == 0)
13205c9304fSPedro F. Giffuni 					fp->_w -= n;
133805288c2SXin LI 			}
13458f0484fSRodney W. Grimes 			fp->_flags |= __SERR;
13558f0484fSRodney W. Grimes 			return (EOF);
13658f0484fSRodney W. Grimes 		}
13758f0484fSRodney W. Grimes 	}
13858f0484fSRodney W. Grimes 	return (0);
13958f0484fSRodney W. Grimes }
14029ac6bd2SDaniel Eischen 
14129ac6bd2SDaniel Eischen static int
14229ac6bd2SDaniel Eischen sflush_locked(FILE *fp)
14329ac6bd2SDaniel Eischen {
14429ac6bd2SDaniel Eischen 	int	ret;
14529ac6bd2SDaniel Eischen 
146*fda0a14fSKonstantin Belousov 	FLOCKFILE_CANCELSAFE(fp);
14729ac6bd2SDaniel Eischen 	ret = __sflush(fp);
148*fda0a14fSKonstantin Belousov 	FUNLOCKFILE_CANCELSAFE();
14929ac6bd2SDaniel Eischen 	return (ret);
15029ac6bd2SDaniel Eischen }
151