annotate circbuffer.c @ 108:10f4d3319780

- added circular buffering for channels - added stderr support for the client - cleaned up a bunch of "unused" warnings, duplicated header definitions - added exit-status support for the client
author Matt Johnston <matt@ucc.asn.au>
date Thu, 26 Aug 2004 13:16:40 +0000
parents
children 0cfba3034be5
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
108
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
1 /*
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
2 * Dropbear SSH
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
3 *
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
4 * Copyright (c) 2002-2004 Matt Johnston
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
5 * All rights reserved.
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
6 *
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
7 * Permission is hereby granted, free of charge, to any person obtaining a copy
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
8 * of this software and associated documentation files (the "Software"), to deal
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
9 * in the Software without restriction, including without limitation the rights
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
10 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
11 * copies of the Software, and to permit persons to whom the Software is
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
12 * furnished to do so, subject to the following conditions:
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
13 *
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
14 * The above copyright notice and this permission notice shall be included in
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
15 * all copies or substantial portions of the Software.
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
16 *
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
20 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
21 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
22 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
23 * SOFTWARE. */
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
24
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
25 #include "includes.h"
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
26 #include "dbutil.h"
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
27 #include "circbuffer.h"
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
28
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
29 #define MAX_CBUF_SIZE 100000000
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
30
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
31 circbuffer * cbuf_new(unsigned int size) {
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
32
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
33 circbuffer *cbuf = NULL;
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
34
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
35 if (size > MAX_CBUF_SIZE) {
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
36 dropbear_exit("bad cbuf size");
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
37 }
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
38
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
39 cbuf = (circbuffer*)m_malloc(sizeof(circbuffer));
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
40 cbuf->data = (unsigned char*)m_malloc(size);
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
41 cbuf->used = 0;
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
42 cbuf->readpos = 0;
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
43 cbuf->writepos = 0;
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
44 cbuf->size = size;
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
45
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
46 return cbuf;
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
47 }
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
48
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
49 void cbuf_free(circbuffer * cbuf) {
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
50
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
51 m_free(cbuf->data);
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
52 m_free(cbuf);
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
53 }
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
54
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
55 unsigned int cbuf_getused(circbuffer * cbuf) {
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
56
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
57 return cbuf->used;
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
58
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
59 }
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
60
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
61 unsigned int cbuf_getavail(circbuffer * cbuf) {
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
62
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
63 return cbuf->size - cbuf->used;
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
64
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
65 }
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
66
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
67 unsigned int cbuf_readlen(circbuffer *cbuf) {
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
68
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
69 assert(((2*cbuf->size)+cbuf->writepos-cbuf->readpos)%cbuf->size == cbuf->used%cbuf->size);
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
70 assert(((2*cbuf->size)+cbuf->readpos-cbuf->writepos)%cbuf->size == (cbuf->size-cbuf->used)%cbuf->size);
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
71
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
72 if (cbuf->used == 0) {
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
73 TRACE(("cbuf_readlen: unused buffer"));
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
74 return 0;
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
75 }
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
76
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
77 if (cbuf->readpos < cbuf->writepos) {
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
78 return cbuf->writepos - cbuf->readpos;
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
79 }
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
80
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
81 return cbuf->size - cbuf->readpos;
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
82 }
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
83
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
84 unsigned int cbuf_writelen(circbuffer *cbuf) {
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
85
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
86 assert(cbuf->used <= cbuf->size);
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
87 assert(((2*cbuf->size)+cbuf->writepos-cbuf->readpos)%cbuf->size == cbuf->used%cbuf->size);
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
88 assert(((2*cbuf->size)+cbuf->readpos-cbuf->writepos)%cbuf->size == (cbuf->size-cbuf->used)%cbuf->size);
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
89
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
90 if (cbuf->used == cbuf->size) {
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
91 TRACE(("cbuf_writelen: full buffer"));
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
92 return 0; /* full */
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
93 }
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
94
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
95 if (cbuf->writepos < cbuf->readpos) {
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
96 return cbuf->readpos - cbuf->writepos;
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
97 }
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
98
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
99 return cbuf->size - cbuf->writepos;
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
100 }
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
101
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
102 unsigned char* cbuf_readptr(circbuffer *cbuf, unsigned int len) {
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
103 if (len > cbuf_readlen(cbuf)) {
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
104 dropbear_exit("bad cbuf read");
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
105 }
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
106
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
107 return &cbuf->data[cbuf->readpos];
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
108 }
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
109
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
110 unsigned char* cbuf_writeptr(circbuffer *cbuf, unsigned int len) {
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
111
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
112 if (len > cbuf_writelen(cbuf)) {
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
113 dropbear_exit("bad cbuf write");
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
114 }
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
115
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
116 return &cbuf->data[cbuf->writepos];
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
117 }
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
118
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
119 void cbuf_incrwrite(circbuffer *cbuf, unsigned int len) {
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
120 if (len > cbuf_writelen(cbuf)) {
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
121 dropbear_exit("bad cbuf write");
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
122 }
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
123
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
124 cbuf->used += len;
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
125 assert(cbuf->used <= cbuf->size);
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
126 cbuf->writepos = (cbuf->writepos + len) % cbuf->size;
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
127 }
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
128
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
129
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
130 void cbuf_incrread(circbuffer *cbuf, unsigned int len) {
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
131 if (len > cbuf_readlen(cbuf)) {
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
132 dropbear_exit("bad cbuf read");
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
133 }
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
134
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
135 assert(cbuf->used >= len);
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
136 cbuf->used -= len;
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
137 cbuf->readpos = (cbuf->readpos + len) % cbuf->size;
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
138 }