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  * $FreeBSD: src/usr.bin/telnet/ring.h,v 1.2.14.1 2002/04/13 11:07:13 markm Exp $
  35  * $DragonFly: src/usr.bin/telnet/ring.h,v 1.3 2008/10/16 01:52:33 swildner Exp $
  36  */
  37
  38 /*
  39  * This defines a structure for a ring buffer.
  40  *
  41  * The circular buffer has two parts:
  42  *(((
  43  *      full:   [consume, supply)
  44  *      empty:  [supply, consume)
  45  *]]]
  46  *
  47  */
  48 typedef struct {
  49     unsigned char       *consume,       /* where data comes out of */
  50                         *supply,        /* where data comes in to */
  51                         *bottom,        /* lowest address in buffer */
  52                         *top,           /* highest address+1 in buffer */
  53                         *mark;          /* marker (user defined) */
  54     int         size;           /* size in bytes of buffer */
  55     u_long      consumetime,    /* help us keep straight full, empty, etc. */
  56                 supplytime;
  57 } Ring;
  58
  59 /* Here are some functions and macros to deal with the ring buffer */
  60
  61 /* Initialization routine */
  62 extern int
  63         ring_init(Ring *ring, unsigned char *buffer, int count);
  64
  65 /* Data movement routines */
  66 extern void
  67         ring_supply_data(Ring *ring, unsigned char *buffer, int count);
  68 #ifdef notdef
  69 extern void
  70         ring_consume_data(Ring *ring, unsigned char *buffer, int count);
  71 #endif
  72
  73 /* Buffer state transition routines */
  74 extern void
  75         ring_supplied(Ring *ring, int count),
  76         ring_consumed(Ring *ring, int count);
  77
  78 /* Buffer state query routines */
  79 extern int
  80         ring_at_mark(Ring *),
  81         ring_empty_count(Ring *ring),
  82         ring_empty_consecutive(Ring *ring),
  83         ring_full_count(Ring *ring),
  84         ring_full_consecutive(Ring *ring);
  85
  86
  87 extern void
  88         ring_clear_mark(Ring *),
  89         ring_mark(Ring *);