1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198
|
/* buffer.c
*
* Wiretap Library
* Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>
*
* SPDX-License-Identifier: GPL-2.0-or-later
*/
#include "config.h"
#define WS_LOG_DOMAIN LOG_DOMAIN_WSUTIL
#include "buffer.h"
#include <stdlib.h>
#include <string.h>
#include <wsutil/ws_assert.h>
#include <wsutil/wslog.h>
#define SMALL_BUFFER_SIZE (2 * 1024) /* Everyone still uses 1500 byte frames, right? */
static GPtrArray *small_buffers; /* Guaranteed to be at least SMALL_BUFFER_SIZE */
/* XXX - Add medium and large buffers? */
/* Initializes a buffer with a certain amount of allocated space */
void
ws_buffer_init(Buffer* buffer, size_t space)
{
ws_assert(buffer);
if (G_UNLIKELY(!small_buffers)) small_buffers = g_ptr_array_sized_new(1024);
if (space <= SMALL_BUFFER_SIZE) {
if (small_buffers->len > 0) {
buffer->data = (uint8_t*) g_ptr_array_remove_index(small_buffers, small_buffers->len - 1);
ws_assert(buffer->data);
} else {
buffer->data = (uint8_t*)g_malloc(SMALL_BUFFER_SIZE);
}
buffer->allocated = SMALL_BUFFER_SIZE;
} else {
buffer->data = (uint8_t*)g_malloc(space);
buffer->allocated = space;
}
buffer->start = 0;
buffer->first_free = 0;
}
/* Frees the memory used by a buffer */
void
ws_buffer_free(Buffer* buffer)
{
ws_assert(buffer);
if (buffer->allocated == SMALL_BUFFER_SIZE) {
ws_assert(buffer->data);
g_ptr_array_add(small_buffers, buffer->data);
} else {
g_free(buffer->data);
}
buffer->allocated = 0;
buffer->data = NULL;
}
/* Assures that there are 'space' bytes at the end of the used space
so that another routine can copy directly into the buffer space. After
doing that, the routine will also want to run
ws_buffer_increase_length(). */
void
ws_buffer_assure_space(Buffer* buffer, size_t space)
{
ws_assert(buffer);
size_t available_at_end = buffer->allocated - buffer->first_free;
bool space_at_beginning;
/* If we've got the space already, good! */
if (space <= available_at_end) {
return;
}
/* Maybe we don't have the space available at the end, but we would
if we moved the used space back to the beginning of the
allocation. The buffer could have become fragmented through lots
of calls to ws_buffer_remove_start(). I'm using buffer->start as the
same as 'available_at_start' in this comparison. */
/* or maybe there's just no more room. */
space_at_beginning = buffer->start >= space;
if (space_at_beginning || buffer->start > 0) {
size_t space_used = buffer->first_free - buffer->start;
/* this memory copy better be safe for overlapping memory regions! */
memmove(buffer->data, buffer->data + buffer->start, space_used);
buffer->start = 0;
buffer->first_free = space_used;
}
/*if (buffer->start >= space) {*/
if (space_at_beginning) {
return;
}
/* We'll allocate more space */
buffer->allocated += space + 1024;
buffer->data = (uint8_t*)g_realloc(buffer->data, buffer->allocated);
}
void
ws_buffer_append(Buffer* buffer, const uint8_t *from, size_t bytes)
{
ws_assert(buffer);
ws_buffer_assure_space(buffer, bytes);
memcpy(buffer->data + buffer->first_free, from, bytes);
buffer->first_free += bytes;
}
void
ws_buffer_remove_start(Buffer* buffer, size_t bytes)
{
ws_assert(buffer);
if (buffer->start + bytes > buffer->first_free) {
ws_error("ws_buffer_remove_start trying to remove %" PRIu64 " bytes. s=%" PRIu64 " ff=%" PRIu64 "!\n",
(uint64_t)bytes, (uint64_t)buffer->start,
(uint64_t)buffer->first_free);
/** ws_error() does an abort() and thus never returns **/
}
buffer->start += bytes;
/*
* If we've removed everything in the buffer, just reset
* the buffer.
*/
if (buffer->start == buffer->first_free)
ws_buffer_clean(buffer);
}
#ifndef SOME_FUNCTIONS_ARE_INLINE
void
ws_buffer_clean(Buffer* buffer)
{
ws_assert(buffer);
buffer->start = 0;
buffer->first_free = 0;
}
void
ws_buffer_increase_length(Buffer* buffer, size_t bytes)
{
ws_assert(buffer);
buffer->first_free += bytes;
}
size_t
ws_buffer_length(const Buffer* buffer)
{
ws_assert(buffer);
return buffer->first_free - buffer->start;
}
uint8_t *
ws_buffer_start_ptr(const Buffer* buffer)
{
ws_assert(buffer);
return buffer->data + buffer->start;
}
uint8_t *
ws_buffer_end_ptr(const Buffer* buffer)
{
ws_assert(buffer);
return buffer->data + buffer->first_free;
}
void
ws_buffer_append_buffer(Buffer* buffer, const Buffer* src_buffer)
{
ws_assert(buffer);
ws_buffer_append(buffer, ws_buffer_start_ptr(src_buffer), ws_buffer_length(src_buffer));
}
#endif
void
ws_buffer_cleanup(void)
{
if (small_buffers) {
g_ptr_array_set_free_func(small_buffers, g_free);
g_ptr_array_free(small_buffers, true);
small_buffers = NULL;
}
}
/*
* Editor modelines - https://www.wireshark.org/tools/modelines.html
*
* Local variables:
* c-basic-offset: 8
* tab-width: 8
* indent-tabs-mode: t
* End:
*
* vi: set shiftwidth=8 tabstop=8 noexpandtab:
* :indentSize=8:tabSize=8:noTabs=false:
*/
|