2 * Copyright (c) 1988, 1993
3 * The Regents of the University of California. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
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
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 $
41 #if defined(__STDC__) || defined(LINT_ARGS)
48 * This defines a structure for a ring buffer.
50 * The circular buffer has two parts:
52 * full: [consume, supply)
53 * empty: [supply, consume)
58 unsigned char *consume, /* where data comes out of */
59 *supply, /* where data comes in to */
60 *bottom, /* lowest address in buffer */
61 *top, /* highest address+1 in buffer */
62 *mark; /* marker (user defined) */
63 int size; /* size in bytes of buffer */
64 u_long consumetime, /* help us keep straight full, empty, etc. */
68 /* Here are some functions and macros to deal with the ring buffer */
70 /* Initialization routine */
72 ring_init(Ring *ring, unsigned char *buffer, int count);
74 /* Data movement routines */
76 ring_supply_data(Ring *ring, unsigned char *buffer, int count);
79 ring_consume_data(Ring *ring, unsigned char *buffer, int count);
82 /* Buffer state transition routines */
84 ring_supplied(Ring *ring, int count),
85 ring_consumed(Ring *ring, int count);
87 /* Buffer state query routines */
90 ring_empty_count(Ring *ring),
91 ring_empty_consecutive(Ring *ring),
92 ring_full_count(Ring *ring),
93 ring_full_consecutive(Ring *ring);
97 ring_clear_mark(Ring *),