usr.bin/telnet/ring.h

   1 /*
   2  * Copyright (c) 1988, 1993
   3  *      The Regents of the University of California.  All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  * 3. All advertising materials mentioning features or use of this software
  14  *    must display the following acknowledgement:
  15  *      This product includes software developed by the University of
  16  *      California, Berkeley and its contributors.
  17  * 4. Neither the name of the University nor the names of its contributors
  18  *    may be used to endorse or promote products derived from this software
  19  *    without specific prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31  * SUCH DAMAGE.
  32  *
  33  *      @(#)ring.h      8.1 (Berkeley) 6/6/93
  34  */
  35
  36 #if defined(P)
  37 # undef P
  38 #endif
  39
  40 #if defined(__STDC__) || defined(LINT_ARGS)
  41 # define        P(x)    x
  42 #else
  43 # define        P(x)    ()
  44 #endif
  45
  46 /*
  47  * This defines a structure for a ring buffer.
  48  *
  49  * The circular buffer has two parts:
  50  *(((
  51  *      full:   [consume, supply)
  52  *      empty:  [supply, consume)
  53  *]]]
  54  *
  55  */
  56 typedef struct {
  57     unsigned char       *consume,       /* where data comes out of */
  58                         *supply,        /* where data comes in to */
  59                         *bottom,        /* lowest address in buffer */
  60                         *top,           /* highest address+1 in buffer */
  61                         *mark;          /* marker (user defined) */
  62     int         size;           /* size in bytes of buffer */
  63     u_long      consumetime,    /* help us keep straight full, empty, etc. */
  64                 supplytime;
  65 } Ring;
  66
  67 /* Here are some functions and macros to deal with the ring buffer */
  68
  69 /* Initialization routine */
  70 extern int
  71         ring_init P((Ring *ring, unsigned char *buffer, int count));
  72
  73 /* Data movement routines */
  74 extern void
  75         ring_supply_data P((Ring *ring, unsigned char *buffer, int count));
  76 #ifdef notdef
  77 extern void
  78         ring_consume_data P((Ring *ring, unsigned char *buffer, int count));
  79 #endif
  80
  81 /* Buffer state transition routines */
  82 extern void
  83         ring_supplied P((Ring *ring, int count)),
  84         ring_consumed P((Ring *ring, int count));
  85
  86 /* Buffer state query routines */
  87 extern int
  88         ring_empty_count P((Ring *ring)),
  89         ring_empty_consecutive P((Ring *ring)),
  90         ring_full_count P((Ring *ring)),
  91         ring_full_consecutive P((Ring *ring));
  92
  93
  94 extern void
  95     ring_clear_mark(),
  96     ring_mark();