Add the DragonFly cvs id and perform general cleanups on cvs/rcs/sccs ids. Most
[dragonfly.git] / crypto / telnet / telnet / ring.h
CommitLineData
984263bc
MD
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/crypto/telnet/telnet/ring.h,v 1.1.1.1.8.1 2002/04/13 10:59:08 markm Exp $
1de703da 35 * $DragonFly: src/crypto/telnet/telnet/ring.h,v 1.2 2003/06/17 04:24:37 dillon Exp $
984263bc
MD
36 */
37
38#if defined(P)
39# undef P
40#endif
41
42#if defined(__STDC__) || defined(LINT_ARGS)
43# define P(x) x
44#else
45# define P(x) ()
46#endif
47
48/*
49 * This defines a structure for a ring buffer.
50 *
51 * The circular buffer has two parts:
52 *(((
53 * full: [consume, supply)
54 * empty: [supply, consume)
55 *]]]
56 *
57 */
58typedef struct {
59 unsigned char *consume, /* where data comes out of */
60 *supply, /* where data comes in to */
61 *bottom, /* lowest address in buffer */
62 *top, /* highest address+1 in buffer */
63 *mark; /* marker (user defined) */
64#ifdef ENCRYPTION
65 unsigned char *clearto; /* Data to this point is clear text */
66 unsigned char *encryyptedto; /* Data is encrypted to here */
67#endif /* ENCRYPTION */
68 int size; /* size in bytes of buffer */
69 u_long consumetime, /* help us keep straight full, empty, etc. */
70 supplytime;
71} Ring;
72
73/* Here are some functions and macros to deal with the ring buffer */
74
75/* Initialization routine */
76extern int
77 ring_init(Ring *ring, unsigned char *buffer, int count);
78
79/* Data movement routines */
80extern void
81 ring_supply_data(Ring *ring, unsigned char *buffer, int count);
82#ifdef notdef
83extern void
84 ring_consume_data(Ring *ring, unsigned char *buffer, int count);
85#endif
86
87/* Buffer state transition routines */
88extern void
89 ring_supplied(Ring *ring, int count),
90 ring_consumed(Ring *ring, int count);
91
92/* Buffer state query routines */
93extern int
94 ring_at_mark(Ring *),
95 ring_empty_count(Ring *ring),
96 ring_empty_consecutive(Ring *ring),
97 ring_full_count(Ring *ring),
98 ring_full_consecutive(Ring *ring);
99
100#ifdef ENCRYPTION
101extern void
102 ring_encrypt(Ring *ring, void (*func)(unsigned char *, int)),
103 ring_clearto(Ring *ring);
104#endif /* ENCRYPTION */
105
106extern void
107 ring_clear_mark(Ring *),
108 ring_mark(Ring *);