e6df387af16f29ad9185381f06829de0723846ed
[metze/wireshark/wip.git] / wiretap / buffer.c
1 /* buffer.c
2  *
3  * $Id$
4  *
5  * Wiretap Library
6  * Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License
10  * as published by the Free Software Foundation; either version 2
11  * of the License, or (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
21  *
22  */
23 #include "config.h"
24
25 #include <stdio.h>
26 #include <stdlib.h>
27 #include <string.h>
28 #include <glib.h>
29
30 #include "buffer.h"
31
32 /* Initializes a buffer with a certain amount of allocated space */
33 void buffer_init(Buffer* buffer, gsize space)
34 {
35         buffer->data = (guint8*)g_malloc(space);
36         buffer->allocated = space;
37         buffer->start = 0;
38         buffer->first_free = 0;
39 }
40
41 /* Frees the memory used by a buffer, and the buffer struct */
42 void buffer_free(Buffer* buffer)
43 {
44         g_free(buffer->data);
45 }
46
47 /* Assures that there are 'space' bytes at the end of the used space
48         so that another routine can copy directly into the buffer space. After
49         doing that, the routine will also want to run
50         buffer_increase_length(). */
51 void buffer_assure_space(Buffer* buffer, gsize space)
52 {
53         gsize available_at_end = buffer->allocated - buffer->first_free;
54         gsize space_used;
55         gboolean space_at_beginning;
56
57         /* If we've got the space already, good! */
58         if (space <= available_at_end) {
59                 return;
60         }
61
62         /* Maybe we don't have the space available at the end, but we would
63                 if we moved the used space back to the beginning of the
64                 allocation. The buffer could have become fragmented through lots
65                 of calls to buffer_remove_start(). I'm using buffer->start as the
66                 same as 'available_at_start' in this comparison. */
67
68         /* or maybe there's just no more room. */
69
70         space_at_beginning = buffer->start >= space;
71         if (space_at_beginning || buffer->start > 0) {
72                 space_used = buffer->first_free - buffer->start;
73                 /* this memory copy better be safe for overlapping memory regions! */
74                 memmove(buffer->data, buffer->data + buffer->start, space_used);
75                 buffer->start = 0;
76                 buffer->first_free = space_used;
77         }
78         /*if (buffer->start >= space) {*/
79         if (space_at_beginning) {
80                 return;
81         }
82
83         /* We'll allocate more space */
84         buffer->allocated += space + 1024;
85         buffer->data = (guint8*)g_realloc(buffer->data, buffer->allocated);
86 }
87
88 void buffer_append(Buffer* buffer, guint8 *from, gsize bytes)
89 {
90         buffer_assure_space(buffer, bytes);
91         memcpy(buffer->data + buffer->first_free, from, bytes);
92         buffer->first_free += bytes;
93 }
94
95 void buffer_remove_start(Buffer* buffer, gsize bytes)
96 {
97         if (buffer->start + bytes > buffer->first_free) {
98                 g_error("buffer_remove_start trying to remove %" G_GINT64_MODIFIER "u bytes. s=%" G_GINT64_MODIFIER "u ff=%" G_GINT64_MODIFIER "u!\n",
99                         (guint64)bytes, (guint64)buffer->start,
100                         (guint64)buffer->first_free);
101                 /** g_error() does an abort() and thus never returns **/
102         }
103         buffer->start += bytes;
104
105         if (buffer->start == buffer->first_free) {
106                 buffer->start = 0;
107                 buffer->first_free = 0;
108         }
109 }
110
111
112 #ifndef SOME_FUNCTIONS_ARE_DEFINES
113 void buffer_clean(Buffer* buffer)
114 {
115         buffer_remove_start(buffer, buffer_length(buffer));
116 }
117 #endif
118
119 #ifndef SOME_FUNCTIONS_ARE_DEFINES
120 void buffer_increase_length(Buffer* buffer, gsize bytes)
121 {
122         buffer->first_free += bytes;
123 }
124 #endif
125
126 #ifndef SOME_FUNCTIONS_ARE_DEFINES
127 gsize buffer_length(Buffer* buffer)
128 {
129         return buffer->first_free - buffer->start;
130 }
131 #endif
132
133 #ifndef SOME_FUNCTIONS_ARE_DEFINES
134 guint8* buffer_start_ptr(Buffer* buffer)
135 {
136         return buffer->data + buffer->start;
137 }
138 #endif
139
140 #ifndef SOME_FUNCTIONS_ARE_DEFINES
141 guint8* buffer_end_ptr(Buffer* buffer)
142 {
143         return buffer->data + buffer->first_free;
144 }
145 #endif
146
147 #ifndef SOME_FUNCTIONS_ARE_DEFINES
148 void buffer_append_buffer(Buffer* buffer, Buffer* src_buffer)
149 {
150         buffer_append(buffer, buffer_start_ptr(src_buffer), buffer_length(src_buffer));
151 }
152 #endif