openssh/buffer.c

   1 /* $OpenBSD: buffer.c,v 1.31 2006/08/03 03:34:41 deraadt Exp $ */
   2 /*
   3  * Author: Tatu Ylonen <ylo@cs.hut.fi>
   4  * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
   5  *                    All rights reserved
   6  * Functions for manipulating fifo buffers (that can grow if needed).
   7  *
   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".
  13  */
  14
  15 #include "includes.h"
  16
  17 #include <sys/param.h>
  18
  19 #include <stdio.h>
  20 #include <string.h>
  21 #include <stdarg.h>
  22
  23 #include "xmalloc.h"
  24 #include "buffer.h"
  25 #include "log.h"
  26
  27 #define BUFFER_MAX_CHUNK        0x100000
  28 #define BUFFER_MAX_LEN          0xa00000
  29 #define BUFFER_ALLOCSZ          0x008000
  30
  31 /* Initializes the buffer structure. */
  32
  33 void
  34 buffer_init(Buffer *buffer)
  35 {
  36         const u_int len = 4096;
  37
  38         buffer->alloc = 0;
  39         buffer->buf = xmalloc(len);
  40         buffer->alloc = len;
  41         buffer->offset = 0;
  42         buffer->end = 0;
  43 }
  44
  45 /* Frees any memory used for the buffer. */
  46
  47 void
  48 buffer_free(Buffer *buffer)
  49 {
  50         if (buffer->alloc > 0) {
  51                 memset(buffer->buf, 0, buffer->alloc);
  52                 buffer->alloc = 0;
  53                 xfree(buffer->buf);
  54         }
  55 }
  56
  57 /*
  58  * Clears any data from the buffer, making it empty.  This does not actually
  59  * zero the memory.
  60  */
  61
  62 void
  63 buffer_clear(Buffer *buffer)
  64 {
  65         buffer->offset = 0;
  66         buffer->end = 0;
  67 }
  68
  69 /* Appends data to the buffer, expanding it if necessary. */
  70
  71 void
  72 buffer_append(Buffer *buffer, const void *data, u_int len)
  73 {
  74         void *p;
  75         p = buffer_append_space(buffer, len);
  76         memcpy(p, data, len);
  77 }
  78
  79 static int
  80 buffer_compact(Buffer *buffer)
  81 {
  82         /*
  83          * If the buffer is quite empty, but all data is at the end, move the
  84          * data to the beginning.
  85          */
  86         if (buffer->offset > MIN(buffer->alloc, BUFFER_MAX_CHUNK)) {
  87                 memmove(buffer->buf, buffer->buf + buffer->offset,
  88                         buffer->end - buffer->offset);
  89                 buffer->end -= buffer->offset;
  90                 buffer->offset = 0;
  91                 return (1);
  92         }
  93         return (0);
  94 }
  95
  96 /*
  97  * Appends space to the buffer, expanding the buffer if necessary. This does
  98  * not actually copy the data into the buffer, but instead returns a pointer
  99  * to the allocated region.
 100  */
 101
 102 void *
 103 buffer_append_space(Buffer *buffer, u_int len)
 104 {
 105         u_int newlen;
 106         void *p;
 107
 108         if (len > BUFFER_MAX_CHUNK)
 109                 fatal("buffer_append_space: len %u not supported", len);
 110
 111         /* If the buffer is empty, start using it from the beginning. */
 112         if (buffer->offset == buffer->end) {
 113                 buffer->offset = 0;
 114                 buffer->end = 0;
 115         }
 116 restart:
 117         /* If there is enough space to store all data, store it now. */
 118         if (buffer->end + len < buffer->alloc) {
 119                 p = buffer->buf + buffer->end;
 120                 buffer->end += len;
 121                 return p;
 122         }
 123
 124         /* Compact data back to the start of the buffer if necessary */
 125         if (buffer_compact(buffer))
 126                 goto restart;
 127
 128         /* Increase the size of the buffer and retry. */
 129         newlen = roundup(buffer->alloc + len, BUFFER_ALLOCSZ);
 130         /* need it to be slightly larger than the MAX LEN for this */
 131         /* still investigating *why* but this works for now -cjr */
 132         if (newlen > (BUFFER_MAX_LEN_HPN + BUFFER_MAX_LEN))
 133                 fatal("buffer_append_space: alloc %u not supported",
 134                     newlen);
 135         buffer->buf = xrealloc(buffer->buf, 1, newlen);
 136         buffer->alloc = newlen;
 137         goto restart;
 138         /* NOTREACHED */
 139 }
 140
 141 /*
 142  * Check whether an allocation of 'len' will fit in the buffer
 143  * This must follow the same math as buffer_append_space
 144  */
 145 int
 146 buffer_check_alloc(Buffer *buffer, u_int len)
 147 {
 148         if (buffer->offset == buffer->end) {
 149                 buffer->offset = 0;
 150                 buffer->end = 0;
 151         }
 152  restart:
 153         if (buffer->end + len < buffer->alloc)
 154                 return (1);
 155         if (buffer_compact(buffer))
 156                 goto restart;
 157         if (roundup(buffer->alloc + len, BUFFER_ALLOCSZ) <= BUFFER_MAX_LEN)
 158                 return (1);
 159         return (0);
 160 }
 161
 162 /* Returns the number of bytes of data in the buffer. */
 163
 164 u_int
 165 buffer_len(Buffer *buffer)
 166 {
 167         return buffer->end - buffer->offset;
 168 }
 169
 170 /* Gets data from the beginning of the buffer. */
 171
 172 int
 173 buffer_get_ret(Buffer *buffer, void *buf, u_int len)
 174 {
 175         if (len > buffer->end - buffer->offset) {
 176                 error("buffer_get_ret: trying to get more bytes %d than in buffer %d",
 177                     len, buffer->end - buffer->offset);
 178                 return (-1);
 179         }
 180         memcpy(buf, buffer->buf + buffer->offset, len);
 181         buffer->offset += len;
 182         return (0);
 183 }
 184
 185 void
 186 buffer_get(Buffer *buffer, void *buf, u_int len)
 187 {
 188         if (buffer_get_ret(buffer, buf, len) == -1)
 189                 fatal("buffer_get: buffer error");
 190 }
 191
 192 /* Consumes the given number of bytes from the beginning of the buffer. */
 193
 194 int
 195 buffer_consume_ret(Buffer *buffer, u_int bytes)
 196 {
 197         if (bytes > buffer->end - buffer->offset) {
 198                 error("buffer_consume_ret: trying to get more bytes than in buffer");
 199                 return (-1);
 200         }
 201         buffer->offset += bytes;
 202         return (0);
 203 }
 204
 205 void
 206 buffer_consume(Buffer *buffer, u_int bytes)
 207 {
 208         if (buffer_consume_ret(buffer, bytes) == -1)
 209                 fatal("buffer_consume: buffer error");
 210 }
 211
 212 /* Consumes the given number of bytes from the end of the buffer. */
 213
 214 int
 215 buffer_consume_end_ret(Buffer *buffer, u_int bytes)
 216 {
 217         if (bytes > buffer->end - buffer->offset)
 218                 return (-1);
 219         buffer->end -= bytes;
 220         return (0);
 221 }
 222
 223 void
 224 buffer_consume_end(Buffer *buffer, u_int bytes)
 225 {
 226         if (buffer_consume_end_ret(buffer, bytes) == -1)
 227                 fatal("buffer_consume_end: trying to get more bytes than in buffer");
 228 }
 229
 230 /* Returns a pointer to the first used byte in the buffer. */
 231
 232 void *
 233 buffer_ptr(Buffer *buffer)
 234 {
 235         return buffer->buf + buffer->offset;
 236 }
 237
 238 /* Dumps the contents of the buffer to stderr. */
 239
 240 void
 241 buffer_dump(Buffer *buffer)
 242 {
 243         u_int i;
 244         u_char *ucp = buffer->buf;
 245
 246         for (i = buffer->offset; i < buffer->end; i++) {
 247                 fprintf(stderr, "%02x", ucp[i]);
 248                 if ((i-buffer->offset)%16==15)
 249                         fprintf(stderr, "\r\n");
 250                 else if ((i-buffer->offset)%2==1)
 251                         fprintf(stderr, " ");
 252         }
 253         fprintf(stderr, "\r\n");
 254 }