Annotation of src/usr.bin/telnet/ring.h, Revision 1.3
1.3 ! art 1: /* $OpenBSD: ring.h,v 1.2 1996/03/27 19:33:06 niklas Exp $ */
1.2 niklas 2: /* $NetBSD: ring.h,v 1.5 1996/02/28 21:04:09 thorpej Exp $ */
3:
1.1 deraadt 4: /*
5: * Copyright (c) 1988, 1993
6: * The Regents of the University of California. All rights reserved.
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: * from: @(#)ring.h 8.1 (Berkeley) 6/6/93
37: */
38:
1.2 niklas 39: #include <sys/cdefs.h>
40: #define P __P
1.1 deraadt 41:
42: /*
43: * This defines a structure for a ring buffer.
44: *
45: * The circular buffer has two parts:
46: *(((
47: * full: [consume, supply)
48: * empty: [supply, consume)
49: *]]]
50: *
51: */
52: typedef struct {
53: unsigned char *consume, /* where data comes out of */
54: *supply, /* where data comes in to */
55: *bottom, /* lowest address in buffer */
56: *top, /* highest address+1 in buffer */
57: *mark; /* marker (user defined) */
1.3 ! art 58: #if defined(ENCRYPTION)
! 59: unsigned char *clearto; /* Data to this point is clear text */
! 60: unsigned char *encryyptedto; /* Data is encrypted to here */
! 61: #endif
1.1 deraadt 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:
1.3 ! art 93: #if defined(ENCRYPTION)
! 94: extern void
! 95: ring_encrypt (Ring *ring, void (*func)()),
! 96: ring_clearto (Ring *ring);
! 97: #endif
! 98:
1.1 deraadt 99:
100: extern void
1.3 ! art 101: ring_clear_mark P((Ring *)),
! 102: ring_mark P((Ring *));