xref: /freebsd/lib/libc/stdio/local.h (revision 9207b4cff7b8d483f4dd3c62266c2b58819eb7f9)
1 /*-
2  * Copyright (c) 1990, 1993
3  *	The Regents of the University of California.  All rights reserved.
4  *
5  * This code is derived from software contributed to Berkeley by
6  * Chris Torek.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  * 3. All advertising materials mentioning features or use of this software
17  *    must display the following acknowledgement:
18  *	This product includes software developed by the University of
19  *	California, Berkeley and its contributors.
20  * 4. Neither the name of the University nor the names of its contributors
21  *    may be used to endorse or promote products derived from this software
22  *    without specific prior written permission.
23  *
24  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34  * SUCH DAMAGE.
35  *
36  *	@(#)local.h	8.3 (Berkeley) 7/3/94
37  *
38  * $FreeBSD$
39  */
40 
41 #include <sys/types.h>	/* for off_t */
42 #include <pthread.h>
43 
44 /*
45  * Information local to this implementation of stdio,
46  * in particular, macros and private variables.
47  */
48 
49 extern int	_sread __P((FILE *, char *, int));
50 extern int	_swrite __P((FILE *, char const *, int));
51 extern fpos_t	_sseek __P((FILE *, fpos_t, int));
52 extern int	_ftello __P((FILE *, fpos_t *));
53 extern int	_fseeko __P((FILE *, off_t, int, int));
54 extern int	__fflush __P((FILE *fp));
55 extern int	__sflush __P((FILE *));
56 extern FILE	*__sfp __P((void));
57 extern int	__srefill __P((FILE *));
58 extern int	__sread __P((void *, char *, int));
59 extern int	__swrite __P((void *, char const *, int));
60 extern fpos_t	__sseek __P((void *, fpos_t, int));
61 extern int	__sclose __P((void *));
62 extern void	__sinit __P((void));
63 extern void	_cleanup __P((void));
64 extern void	(*__cleanup) __P((void));
65 extern void	__smakebuf __P((FILE *));
66 extern int	__swhatbuf __P((FILE *, size_t *, int *));
67 extern int	_fwalk __P((int (*)(FILE *)));
68 extern int	__swsetup __P((FILE *));
69 extern int	__sflags __P((const char *, int *));
70 extern int	__ungetc __P((int, FILE *));
71 extern int	__vfprintf __P((FILE *, const char *, _BSD_VA_LIST_));
72 
73 extern int	__sdidinit;
74 
75 
76 /* hold a buncha junk that would grow the ABI */
77 struct __sFILEX {
78 	unsigned char	*_up;	/* saved _p when _p is doing ungetc data */
79 	pthread_mutex_t	fl_mutex;	/* used for MT-safety */
80 	pthread_t	fl_owner;	/* current owner */
81 	int		fl_count;	/* recursive lock count */
82 };
83 
84 /*
85  * Return true iff the given FILE cannot be written now.
86  */
87 #define	cantwrite(fp) \
88  	((((fp)->_flags & __SWR) == 0 || \
89  	    ((fp)->_bf._base == NULL && ((fp)->_flags & __SSTR) == 0)) && \
90 	 __swsetup(fp))
91 
92 /*
93  * Test whether the given stdio file has an active ungetc buffer;
94  * release such a buffer, without restoring ordinary unread data.
95  */
96 #define	HASUB(fp) ((fp)->_ub._base != NULL)
97 #define	FREEUB(fp) { \
98 	if ((fp)->_ub._base != (fp)->_ubuf) \
99 		free((char *)(fp)->_ub._base); \
100 	(fp)->_ub._base = NULL; \
101 }
102 
103 /*
104  * test for an fgetln() buffer.
105  */
106 #define	HASLB(fp) ((fp)->_lb._base != NULL)
107 #define	FREELB(fp) { \
108 	free((char *)(fp)->_lb._base); \
109 	(fp)->_lb._base = NULL; \
110 }
111 
112 #define	INITEXTRA(fp) { \
113 	(fp)->_extra->_up = NULL; \
114 	(fp)->_extra->fl_mutex = PTHREAD_MUTEX_INITIALIZER; \
115 	(fp)->_extra->fl_owner = NULL; \
116 	(fp)->_extra->fl_count = 0; \
117 }
118