1 /*- 2 * SPDX-License-Identifier: BSD-3-Clause 3 * 4 * Copyright (c) 1990, 1993 5 * The Regents of the University of California. All rights reserved. 6 * 7 * This code is derived from software contributed to Berkeley by 8 * Chris Torek. 9 * 10 * Copyright (c) 2011 The FreeBSD Foundation 11 * All rights reserved. 12 * Portions of this software were developed by David Chisnall 13 * under sponsorship from the FreeBSD Foundation. 14 * 15 * Redistribution and use in source and binary forms, with or without 16 * modification, are permitted provided that the following conditions 17 * are met: 18 * 1. Redistributions of source code must retain the above copyright 19 * notice, this list of conditions and the following disclaimer. 20 * 2. Redistributions in binary form must reproduce the above copyright 21 * notice, this list of conditions and the following disclaimer in the 22 * documentation and/or other materials provided with the distribution. 23 * 3. Neither the name of the University nor the names of its contributors 24 * may be used to endorse or promote products derived from this software 25 * without specific prior written permission. 26 * 27 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 28 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 29 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 30 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 31 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 32 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 33 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 34 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 35 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 36 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 37 * SUCH DAMAGE. 38 * 39 * @(#)local.h 8.3 (Berkeley) 7/3/94 40 * $FreeBSD$ 41 */ 42 43 #ifndef _STDIO_LOCAL_H 44 #define _STDIO_LOCAL_H 45 46 #include <sys/types.h> /* for off_t */ 47 #include <pthread.h> 48 #include <string.h> 49 #include <wchar.h> 50 #include <locale.h> 51 52 /* 53 * Information local to this implementation of stdio, 54 * in particular, macros and private variables. 55 */ 56 57 extern int _sread(FILE *, char *, int); 58 extern int _swrite(FILE *, char const *, int); 59 extern fpos_t _sseek(FILE *, fpos_t, int); 60 extern int _ftello(FILE *, fpos_t *); 61 extern int _fseeko(FILE *, off_t, int, int); 62 extern int __fflush(FILE *fp); 63 extern void __fcloseall(void); 64 extern wint_t __fgetwc_mbs(FILE *, mbstate_t *, int *, locale_t); 65 extern wint_t __fputwc(wchar_t, FILE *, locale_t); 66 extern int __sflush(FILE *); 67 extern FILE *__sfp(void); 68 extern int __slbexpand(FILE *, size_t); 69 extern int __srefill(FILE *); 70 extern int __sread(void *, char *, int); 71 extern int __swrite(void *, char const *, int); 72 extern fpos_t __sseek(void *, fpos_t, int); 73 extern int __sclose(void *); 74 extern void __sinit(void); 75 extern void _cleanup(void); 76 extern void __smakebuf(FILE *); 77 extern int __swhatbuf(FILE *, size_t *, int *); 78 extern int _fwalk(int (*)(FILE *)); 79 extern int __svfscanf(FILE *, locale_t, const char *, __va_list); 80 extern int __swsetup(FILE *); 81 extern int __sflags(const char *, int *); 82 extern int __ungetc(int, FILE *); 83 extern wint_t __ungetwc(wint_t, FILE *, locale_t); 84 extern int __vfprintf(FILE *, locale_t, const char *, __va_list); 85 extern int __vfscanf(FILE *, const char *, __va_list); 86 extern int __vfwprintf(FILE *, locale_t, const wchar_t *, __va_list); 87 extern int __vfwscanf(FILE * __restrict, locale_t, const wchar_t * __restrict, 88 __va_list); 89 extern size_t __fread(void * __restrict buf, size_t size, size_t count, 90 FILE * __restrict fp); 91 extern int __sdidinit; 92 93 static inline wint_t 94 __fgetwc(FILE *fp, locale_t locale) 95 { 96 int nread; 97 98 return (__fgetwc_mbs(fp, &fp->_mbstate, &nread, locale)); 99 } 100 101 /* 102 * Prepare the given FILE for writing, and return 0 iff it 103 * can be written now. Otherwise, return EOF and set errno. 104 */ 105 #define prepwrite(fp) \ 106 ((((fp)->_flags & __SWR) == 0 || \ 107 ((fp)->_bf._base == NULL && ((fp)->_flags & __SSTR) == 0)) && \ 108 __swsetup(fp)) 109 110 /* 111 * Test whether the given stdio file has an active ungetc buffer; 112 * release such a buffer, without restoring ordinary unread data. 113 */ 114 #define HASUB(fp) ((fp)->_ub._base != NULL) 115 #define FREEUB(fp) { \ 116 if ((fp)->_ub._base != (fp)->_ubuf) \ 117 free((char *)(fp)->_ub._base); \ 118 (fp)->_ub._base = NULL; \ 119 } 120 121 /* 122 * test for an fgetln() buffer. 123 */ 124 #define HASLB(fp) ((fp)->_lb._base != NULL) 125 #define FREELB(fp) { \ 126 free((char *)(fp)->_lb._base); \ 127 (fp)->_lb._base = NULL; \ 128 } 129 130 /* 131 * Structure initializations for 'fake' FILE objects. 132 */ 133 #define FAKE_FILE { \ 134 ._file = -1, \ 135 ._fl_mutex = PTHREAD_MUTEX_INITIALIZER, \ 136 } 137 138 /* 139 * Set the orientation for a stream. If o > 0, the stream has wide- 140 * orientation. If o < 0, the stream has byte-orientation. 141 */ 142 #define ORIENT(fp, o) do { \ 143 if ((fp)->_orientation == 0) \ 144 (fp)->_orientation = (o); \ 145 } while (0) 146 147 void __stdio_cancel_cleanup(void *); 148 #define FLOCKFILE_CANCELSAFE(fp) \ 149 { \ 150 struct _pthread_cleanup_info __cleanup_info__; \ 151 if (__isthreaded) { \ 152 _FLOCKFILE(fp); \ 153 ___pthread_cleanup_push_imp( \ 154 __stdio_cancel_cleanup, (fp), \ 155 &__cleanup_info__); \ 156 } else { \ 157 ___pthread_cleanup_push_imp( \ 158 __stdio_cancel_cleanup, NULL, \ 159 &__cleanup_info__); \ 160 } \ 161 { 162 #define FUNLOCKFILE_CANCELSAFE() \ 163 (void)0; \ 164 } \ 165 ___pthread_cleanup_pop_imp(1); \ 166 } 167 168 #endif /* _STDIO_LOCAL_H */ 169