lib/libc/stdio/local.h

   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: src/lib/libc/stdio/local.h,v 1.1.1.2.6.1 2001/03/05 11:27:49 obrien Exp $
  39  * $DragonFly: src/lib/libc/stdio/local.h,v 1.6 2005/05/09 12:43:40 davidxu Exp $
  40  */
  41
  42 #include <sys/types.h> /* for off_t */
  43 #include <pthread.h>
  44
  45 #ifndef _MACHINE_STDINT_H_
  46 #include <machine/stdint.h>     /* __size_t */
  47 #endif
  48
  49 /*
  50  * Information local to this implementation of stdio,
  51  * in particular, macros and private variables.
  52  */
  53
  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      __vfprintf(FILE *, const char *, __va_list);
  70
  71 extern int      __sdidinit;
  72
  73 /* hold a buncha junk that would grow the ABI */
  74 struct __sFILEX {
  75         unsigned char   *_up;   /* saved _p when _p is doing ungetc data */
  76         pthread_mutex_t fl_mutex;       /* used for MT-safety */
  77         pthread_t       fl_owner;       /* current owner */
  78         int             fl_count;       /* recursive lock count */
  79 };
  80
  81 /*
  82  * Return true iff the given FILE cannot be written now.
  83  */
  84 #define cantwrite(fp) \
  85         ((((fp)->_flags & __SWR) == 0 || (fp)->_bf._base == NULL) && \
  86          __swsetup(fp))
  87
  88 /*
  89  * Test whether the given stdio file has an active ungetc buffer;
  90  * release such a buffer, without restoring ordinary unread data.
  91  */
  92 #define HASUB(fp) ((fp)->_ub._base != NULL)
  93 #define FREEUB(fp) { \
  94         if ((fp)->_ub._base != (fp)->_ubuf) \
  95                 free((char *)(fp)->_ub._base); \
  96         (fp)->_ub._base = NULL; \
  97 }
  98
  99 /*
 100  * test for an fgetln() buffer.
 101  */
 102 #define HASLB(fp) ((fp)->_lb._base != NULL)
 103 #define FREELB(fp) { \
 104         free((char *)(fp)->_lb._base); \
 105         (fp)->_lb._base = NULL; \
 106 }
 107
 108 #define INITEXTRA(fp) { \
 109         (fp)->_extra->_up = NULL; \
 110         (fp)->_extra->fl_mutex = PTHREAD_MUTEX_INITIALIZER; \
 111         (fp)->_extra->fl_owner = NULL; \
 112         (fp)->_extra->fl_count = 0; \
 113 }
 114