xref: /freebsd/lib/libc/stdio/local.h (revision c17d43407fe04133a94055b0dbc7ea8965654a9f)
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  * $FreeBSD$
38  */
39 
40 #include <sys/types.h>	/* for off_t */
41 #include <pthread.h>
42 
43 /*
44  * Information local to this implementation of stdio,
45  * in particular, macros and private variables.
46  */
47 
48 extern int	_sread(FILE *, char *, int);
49 extern int	_swrite(FILE *, char const *, int);
50 extern fpos_t	_sseek(FILE *, fpos_t, int);
51 extern int	_ftello(FILE *, fpos_t *);
52 extern int	_fseeko(FILE *, off_t, int, int);
53 extern int	__fflush(FILE *fp);
54 extern int	__sflush(FILE *);
55 extern FILE	*__sfp(void);
56 extern int	__srefill(FILE *);
57 extern int	__sread(void *, char *, int);
58 extern int	__swrite(void *, char const *, int);
59 extern fpos_t	__sseek(void *, fpos_t, int);
60 extern int	__sclose(void *);
61 extern void	__sinit(void);
62 extern void	_cleanup(void);
63 extern void	(*__cleanup)(void);
64 extern void	__smakebuf(FILE *);
65 extern int	__swhatbuf(FILE *, size_t *, int *);
66 extern int	_fwalk(int (*)(FILE *));
67 extern int	__swsetup(FILE *);
68 extern int	__sflags(const char *, int *);
69 extern int	__ungetc(int, FILE *);
70 extern int	__vfprintf(FILE *, const char *, _BSD_VA_LIST_);
71 
72 extern int	__sdidinit;
73 
74 
75 /* hold a buncha junk that would grow the ABI */
76 struct __sFILEX {
77 	unsigned char	*_up;	/* saved _p when _p is doing ungetc data */
78 	pthread_mutex_t	fl_mutex;	/* used for MT-safety */
79 	pthread_t	fl_owner;	/* current owner */
80 	int		fl_count;	/* recursive lock count */
81 };
82 
83 /*
84  * Return true iff the given FILE cannot be written now.
85  */
86 #define	cantwrite(fp) \
87  	((((fp)->_flags & __SWR) == 0 || \
88  	    ((fp)->_bf._base == NULL && ((fp)->_flags & __SSTR) == 0)) && \
89 	 __swsetup(fp))
90 
91 /*
92  * Test whether the given stdio file has an active ungetc buffer;
93  * release such a buffer, without restoring ordinary unread data.
94  */
95 #define	HASUB(fp) ((fp)->_ub._base != NULL)
96 #define	FREEUB(fp) { \
97 	if ((fp)->_ub._base != (fp)->_ubuf) \
98 		free((char *)(fp)->_ub._base); \
99 	(fp)->_ub._base = NULL; \
100 }
101 
102 /*
103  * test for an fgetln() buffer.
104  */
105 #define	HASLB(fp) ((fp)->_lb._base != NULL)
106 #define	FREELB(fp) { \
107 	free((char *)(fp)->_lb._base); \
108 	(fp)->_lb._base = NULL; \
109 }
110 
111 #define	INITEXTRA(fp) { \
112 	(fp)->_extra->_up = NULL; \
113 	(fp)->_extra->fl_mutex = PTHREAD_MUTEX_INITIALIZER; \
114 	(fp)->_extra->fl_owner = NULL; \
115 	(fp)->_extra->fl_count = 0; \
116 }
117