Damien Miller | e3476ed | 2006-07-24 14:13:33 +1000 | [diff] [blame^] | 1 | /* $OpenBSD: buffer.c,v 1.28 2006/07/22 20:48:22 stevesk Exp $ */ |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 2 | /* |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 3 | * Author: Tatu Ylonen <ylo@cs.hut.fi> |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 4 | * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland |
| 5 | * All rights reserved |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 6 | * Functions for manipulating fifo buffers (that can grow if needed). |
Damien Miller | 4af5130 | 2000-04-16 11:18:38 +1000 | [diff] [blame] | 7 | * |
Damien Miller | e4340be | 2000-09-16 13:29:08 +1100 | [diff] [blame] | 8 | * As far as I am concerned, the code I have written for this software |
| 9 | * can be used freely for any purpose. Any derived versions of this |
| 10 | * software must be clearly marked as such, and if the derived work is |
| 11 | * incompatible with the protocol description in the RFC file, it must be |
| 12 | * called by a name other than "ssh" or "Secure Shell". |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 13 | */ |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 14 | |
| 15 | #include "includes.h" |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 16 | |
Damien Miller | e3476ed | 2006-07-24 14:13:33 +1000 | [diff] [blame^] | 17 | #include <string.h> |
| 18 | |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 19 | #include "xmalloc.h" |
| 20 | #include "buffer.h" |
Ben Lindstrom | 226cfa0 | 2001-01-22 05:34:40 +0000 | [diff] [blame] | 21 | #include "log.h" |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 22 | |
Damien Miller | 499a0d5 | 2006-04-23 12:06:03 +1000 | [diff] [blame] | 23 | #define BUFFER_MAX_CHUNK 0x100000 |
| 24 | #define BUFFER_MAX_LEN 0xa00000 |
| 25 | #define BUFFER_ALLOCSZ 0x008000 |
| 26 | |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 27 | /* Initializes the buffer structure. */ |
| 28 | |
Damien Miller | 4af5130 | 2000-04-16 11:18:38 +1000 | [diff] [blame] | 29 | void |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 30 | buffer_init(Buffer *buffer) |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 31 | { |
Damien Miller | 5efcecc | 2003-09-17 07:31:14 +1000 | [diff] [blame] | 32 | const u_int len = 4096; |
| 33 | |
| 34 | buffer->alloc = 0; |
| 35 | buffer->buf = xmalloc(len); |
| 36 | buffer->alloc = len; |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 37 | buffer->offset = 0; |
| 38 | buffer->end = 0; |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 39 | } |
| 40 | |
| 41 | /* Frees any memory used for the buffer. */ |
| 42 | |
Damien Miller | 4af5130 | 2000-04-16 11:18:38 +1000 | [diff] [blame] | 43 | void |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 44 | buffer_free(Buffer *buffer) |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 45 | { |
Damien Miller | 5efcecc | 2003-09-17 07:31:14 +1000 | [diff] [blame] | 46 | if (buffer->alloc > 0) { |
| 47 | memset(buffer->buf, 0, buffer->alloc); |
Darren Tucker | d2730d3 | 2003-09-22 21:00:19 +1000 | [diff] [blame] | 48 | buffer->alloc = 0; |
Damien Miller | 5efcecc | 2003-09-17 07:31:14 +1000 | [diff] [blame] | 49 | xfree(buffer->buf); |
| 50 | } |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 51 | } |
| 52 | |
Damien Miller | 5428f64 | 1999-11-25 11:54:57 +1100 | [diff] [blame] | 53 | /* |
| 54 | * Clears any data from the buffer, making it empty. This does not actually |
| 55 | * zero the memory. |
| 56 | */ |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 57 | |
Damien Miller | 4af5130 | 2000-04-16 11:18:38 +1000 | [diff] [blame] | 58 | void |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 59 | buffer_clear(Buffer *buffer) |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 60 | { |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 61 | buffer->offset = 0; |
| 62 | buffer->end = 0; |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 63 | } |
| 64 | |
| 65 | /* Appends data to the buffer, expanding it if necessary. */ |
| 66 | |
Damien Miller | 4af5130 | 2000-04-16 11:18:38 +1000 | [diff] [blame] | 67 | void |
Damien Miller | 5a6b4fe | 2001-12-21 14:56:54 +1100 | [diff] [blame] | 68 | buffer_append(Buffer *buffer, const void *data, u_int len) |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 69 | { |
Damien Miller | 5a6b4fe | 2001-12-21 14:56:54 +1100 | [diff] [blame] | 70 | void *p; |
| 71 | p = buffer_append_space(buffer, len); |
| 72 | memcpy(p, data, len); |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 73 | } |
| 74 | |
Damien Miller | 499a0d5 | 2006-04-23 12:06:03 +1000 | [diff] [blame] | 75 | static int |
| 76 | buffer_compact(Buffer *buffer) |
| 77 | { |
| 78 | /* |
| 79 | * If the buffer is quite empty, but all data is at the end, move the |
| 80 | * data to the beginning. |
| 81 | */ |
| 82 | if (buffer->offset > MIN(buffer->alloc, BUFFER_MAX_CHUNK)) { |
| 83 | memmove(buffer->buf, buffer->buf + buffer->offset, |
| 84 | buffer->end - buffer->offset); |
| 85 | buffer->end -= buffer->offset; |
| 86 | buffer->offset = 0; |
| 87 | return (1); |
| 88 | } |
| 89 | return (0); |
| 90 | } |
| 91 | |
Damien Miller | 5428f64 | 1999-11-25 11:54:57 +1100 | [diff] [blame] | 92 | /* |
| 93 | * Appends space to the buffer, expanding the buffer if necessary. This does |
| 94 | * not actually copy the data into the buffer, but instead returns a pointer |
| 95 | * to the allocated region. |
| 96 | */ |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 97 | |
Damien Miller | 5a6b4fe | 2001-12-21 14:56:54 +1100 | [diff] [blame] | 98 | void * |
| 99 | buffer_append_space(Buffer *buffer, u_int len) |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 100 | { |
Ben Lindstrom | f2b4e4e | 2003-09-16 03:31:03 +0000 | [diff] [blame] | 101 | u_int newlen; |
Damien Miller | 5a6b4fe | 2001-12-21 14:56:54 +1100 | [diff] [blame] | 102 | void *p; |
| 103 | |
Darren Tucker | 11327cc | 2005-03-14 23:22:25 +1100 | [diff] [blame] | 104 | if (len > BUFFER_MAX_CHUNK) |
Damien Miller | 468cd71 | 2002-06-26 19:14:25 +1000 | [diff] [blame] | 105 | fatal("buffer_append_space: len %u not supported", len); |
| 106 | |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 107 | /* If the buffer is empty, start using it from the beginning. */ |
| 108 | if (buffer->offset == buffer->end) { |
| 109 | buffer->offset = 0; |
| 110 | buffer->end = 0; |
| 111 | } |
| 112 | restart: |
| 113 | /* If there is enough space to store all data, store it now. */ |
| 114 | if (buffer->end + len < buffer->alloc) { |
Damien Miller | 5a6b4fe | 2001-12-21 14:56:54 +1100 | [diff] [blame] | 115 | p = buffer->buf + buffer->end; |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 116 | buffer->end += len; |
Damien Miller | 5a6b4fe | 2001-12-21 14:56:54 +1100 | [diff] [blame] | 117 | return p; |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 118 | } |
Damien Miller | 787b2ec | 2003-11-21 23:56:47 +1100 | [diff] [blame] | 119 | |
Damien Miller | 499a0d5 | 2006-04-23 12:06:03 +1000 | [diff] [blame] | 120 | /* Compact data back to the start of the buffer if necessary */ |
| 121 | if (buffer_compact(buffer)) |
| 122 | goto restart; |
| 123 | |
| 124 | /* Increase the size of the buffer and retry. */ |
| 125 | newlen = roundup(buffer->alloc + len, BUFFER_ALLOCSZ); |
Darren Tucker | 11327cc | 2005-03-14 23:22:25 +1100 | [diff] [blame] | 126 | if (newlen > BUFFER_MAX_LEN) |
Damien Miller | 468cd71 | 2002-06-26 19:14:25 +1000 | [diff] [blame] | 127 | fatal("buffer_append_space: alloc %u not supported", |
Ben Lindstrom | f2b4e4e | 2003-09-16 03:31:03 +0000 | [diff] [blame] | 128 | newlen); |
Damien Miller | 3681209 | 2006-03-26 14:22:47 +1100 | [diff] [blame] | 129 | buffer->buf = xrealloc(buffer->buf, 1, newlen); |
Ben Lindstrom | f2b4e4e | 2003-09-16 03:31:03 +0000 | [diff] [blame] | 130 | buffer->alloc = newlen; |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 131 | goto restart; |
Damien Miller | 5a6b4fe | 2001-12-21 14:56:54 +1100 | [diff] [blame] | 132 | /* NOTREACHED */ |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 133 | } |
| 134 | |
Damien Miller | 499a0d5 | 2006-04-23 12:06:03 +1000 | [diff] [blame] | 135 | /* |
| 136 | * Check whether an allocation of 'len' will fit in the buffer |
| 137 | * This must follow the same math as buffer_append_space |
| 138 | */ |
| 139 | int |
| 140 | buffer_check_alloc(Buffer *buffer, u_int len) |
| 141 | { |
| 142 | if (buffer->offset == buffer->end) { |
| 143 | buffer->offset = 0; |
| 144 | buffer->end = 0; |
| 145 | } |
| 146 | restart: |
| 147 | if (buffer->end + len < buffer->alloc) |
| 148 | return (1); |
| 149 | if (buffer_compact(buffer)) |
| 150 | goto restart; |
| 151 | if (roundup(buffer->alloc + len, BUFFER_ALLOCSZ) <= BUFFER_MAX_LEN) |
| 152 | return (1); |
| 153 | return (0); |
| 154 | } |
| 155 | |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 156 | /* Returns the number of bytes of data in the buffer. */ |
| 157 | |
Ben Lindstrom | 46c1622 | 2000-12-22 01:43:59 +0000 | [diff] [blame] | 158 | u_int |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 159 | buffer_len(Buffer *buffer) |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 160 | { |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 161 | return buffer->end - buffer->offset; |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 162 | } |
| 163 | |
| 164 | /* Gets data from the beginning of the buffer. */ |
| 165 | |
Darren Tucker | 50dbe83 | 2004-11-05 20:41:24 +1100 | [diff] [blame] | 166 | int |
| 167 | buffer_get_ret(Buffer *buffer, void *buf, u_int len) |
| 168 | { |
| 169 | if (len > buffer->end - buffer->offset) { |
| 170 | error("buffer_get_ret: trying to get more bytes %d than in buffer %d", |
| 171 | len, buffer->end - buffer->offset); |
| 172 | return (-1); |
| 173 | } |
| 174 | memcpy(buf, buffer->buf + buffer->offset, len); |
| 175 | buffer->offset += len; |
| 176 | return (0); |
| 177 | } |
| 178 | |
Damien Miller | 4af5130 | 2000-04-16 11:18:38 +1000 | [diff] [blame] | 179 | void |
Damien Miller | 5a6b4fe | 2001-12-21 14:56:54 +1100 | [diff] [blame] | 180 | buffer_get(Buffer *buffer, void *buf, u_int len) |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 181 | { |
Darren Tucker | 50dbe83 | 2004-11-05 20:41:24 +1100 | [diff] [blame] | 182 | if (buffer_get_ret(buffer, buf, len) == -1) |
| 183 | fatal("buffer_get: buffer error"); |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 184 | } |
| 185 | |
| 186 | /* Consumes the given number of bytes from the beginning of the buffer. */ |
| 187 | |
Darren Tucker | 50dbe83 | 2004-11-05 20:41:24 +1100 | [diff] [blame] | 188 | int |
| 189 | buffer_consume_ret(Buffer *buffer, u_int bytes) |
| 190 | { |
| 191 | if (bytes > buffer->end - buffer->offset) { |
| 192 | error("buffer_consume_ret: trying to get more bytes than in buffer"); |
| 193 | return (-1); |
| 194 | } |
| 195 | buffer->offset += bytes; |
| 196 | return (0); |
| 197 | } |
| 198 | |
Damien Miller | 4af5130 | 2000-04-16 11:18:38 +1000 | [diff] [blame] | 199 | void |
Ben Lindstrom | 46c1622 | 2000-12-22 01:43:59 +0000 | [diff] [blame] | 200 | buffer_consume(Buffer *buffer, u_int bytes) |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 201 | { |
Darren Tucker | 50dbe83 | 2004-11-05 20:41:24 +1100 | [diff] [blame] | 202 | if (buffer_consume_ret(buffer, bytes) == -1) |
| 203 | fatal("buffer_consume: buffer error"); |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 204 | } |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 205 | |
| 206 | /* Consumes the given number of bytes from the end of the buffer. */ |
| 207 | |
Darren Tucker | 50dbe83 | 2004-11-05 20:41:24 +1100 | [diff] [blame] | 208 | int |
| 209 | buffer_consume_end_ret(Buffer *buffer, u_int bytes) |
| 210 | { |
| 211 | if (bytes > buffer->end - buffer->offset) |
| 212 | return (-1); |
| 213 | buffer->end -= bytes; |
| 214 | return (0); |
| 215 | } |
| 216 | |
Damien Miller | 4af5130 | 2000-04-16 11:18:38 +1000 | [diff] [blame] | 217 | void |
Ben Lindstrom | 46c1622 | 2000-12-22 01:43:59 +0000 | [diff] [blame] | 218 | buffer_consume_end(Buffer *buffer, u_int bytes) |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 219 | { |
Darren Tucker | 50dbe83 | 2004-11-05 20:41:24 +1100 | [diff] [blame] | 220 | if (buffer_consume_end_ret(buffer, bytes) == -1) |
Damien Miller | 22c7726 | 2000-04-13 12:26:34 +1000 | [diff] [blame] | 221 | fatal("buffer_consume_end: trying to get more bytes than in buffer"); |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 222 | } |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 223 | |
| 224 | /* Returns a pointer to the first used byte in the buffer. */ |
| 225 | |
Damien Miller | 5a6b4fe | 2001-12-21 14:56:54 +1100 | [diff] [blame] | 226 | void * |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 227 | buffer_ptr(Buffer *buffer) |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 228 | { |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 229 | return buffer->buf + buffer->offset; |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 230 | } |
| 231 | |
| 232 | /* Dumps the contents of the buffer to stderr. */ |
| 233 | |
Damien Miller | 4af5130 | 2000-04-16 11:18:38 +1000 | [diff] [blame] | 234 | void |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 235 | buffer_dump(Buffer *buffer) |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 236 | { |
Darren Tucker | 631a4a9 | 2003-09-22 21:08:21 +1000 | [diff] [blame] | 237 | u_int i; |
Damien Miller | 4a8ed54 | 2002-01-22 23:33:31 +1100 | [diff] [blame] | 238 | u_char *ucp = buffer->buf; |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 239 | |
Ben Lindstrom | 5eabda3 | 2001-04-12 23:34:34 +0000 | [diff] [blame] | 240 | for (i = buffer->offset; i < buffer->end; i++) { |
| 241 | fprintf(stderr, "%02x", ucp[i]); |
| 242 | if ((i-buffer->offset)%16==15) |
| 243 | fprintf(stderr, "\r\n"); |
| 244 | else if ((i-buffer->offset)%2==1) |
| 245 | fprintf(stderr, " "); |
| 246 | } |
Ben Lindstrom | 3bb4f9d | 2001-04-08 18:30:26 +0000 | [diff] [blame] | 247 | fprintf(stderr, "\r\n"); |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 248 | } |