Get rid of "tvb_compat()"; it's no longer needed (the one remaining call
[obnox/wireshark/wip.git] / epan / tvbuff.h
1 /* tvbuff.h
2  *
3  * Testy, Virtual(-izable) Buffer of guint8*'s
4  * 
5  * "Testy" -- the buffer gets mad when an attempt is made to access data
6  *              beyond the bounds of the buffer. An exception is thrown.
7  *
8  * "Virtual" -- the buffer can have its own data, can use a subset of
9  *              the data of a backing tvbuff, or can be a composite of
10  *              other tvbuffs.
11  *
12  * $Id: tvbuff.h,v 1.20 2001/11/20 22:46:12 guy Exp $
13  *
14  * Copyright (c) 2000 by Gilbert Ramirez <gram@alumni.rice.edu>
15  *
16  * Ethereal - Network traffic analyzer
17  * By Gerald Combs <gerald@ethereal.com>
18  * Copyright 1998 Gerald Combs
19  * 
20  * This program is free software; you can redistribute it and/or
21  * modify it under the terms of the GNU General Public License
22  * as published by the Free Software Foundation; either version 2
23  * of the License, or (at your option) any later version.
24  * 
25  * This program is distributed in the hope that it will be useful,
26  * but WITHOUT ANY WARRANTY; without even the implied warranty of
27  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
28  * GNU General Public License for more details.
29  * 
30  * You should have received a copy of the GNU General Public License
31  * along with this program; if not, write to the Free Software
32  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
33  */
34
35 #ifndef __TVBUFF_H__
36 #define __TVBUFF_H__
37
38 #include <glib.h>
39 #include "exceptions.h"
40
41 typedef struct tvbuff tvbuff_t;
42
43 typedef void (*tvbuff_free_cb_t)(void*);
44
45 /* The different types of tvbuff's */
46 typedef enum {
47         TVBUFF_REAL_DATA,
48         TVBUFF_SUBSET,
49         TVBUFF_COMPOSITE
50 } tvbuff_type;
51
52 /* TVBUFF_REAL_DATA contains a guint8* that points to real data.
53  * The data is allocated and contiguous.
54  *
55  * TVBUFF_SUBSET has a backing tvbuff. The TVBUFF_SUBSET is a "window"
56  * through which the program sees only a portion of the backing tvbuff.
57  *
58  * TVBUFF_COMPOSITE combines multiple tvbuffs sequentually to produce
59  * a larger byte array.
60  *
61  * tvbuff's of any type can be used as the backing-tvbuff of a
62  * TVBUFF_SUBSET or as the member of a TVBUFF_COMPOSITE.
63  * TVBUFF_COMPOSITEs can have member-tvbuffs of different types.
64  *
65  * Once a tvbuff is create/initialized/finalized, the tvbuff is read-only.
66  * That is, it cannot point to any other data. A new tvbuff must be created if
67  * you want a tvbuff that points to other data.
68  */
69
70
71 /* "class" initialization. Called once during execution of program
72  * so that tvbuff.c can initialize its data. */
73 extern void tvbuff_init(void);
74
75 /* "class" cleanup. Called once during execution of program
76  * so that tvbuff.c can clean up its data. */
77 extern void tvbuff_cleanup(void);
78
79
80 /* Returns a pointer to a newly initialized tvbuff. Note that
81  * tvbuff's of types TVBUFF_SUBSET and TVBUFF_COMPOSITE
82  * require further initialization via the appropriate functions */
83 extern tvbuff_t* tvb_new(tvbuff_type);
84
85 /* Marks a tvbuff for freeing. The guint8* data of a TVBUFF_REAL_DATA
86  * is *never* freed by the tvbuff routines. The tvbuff itself is actually freed
87  * once its usage count drops to 0.
88  *
89  * Usage counts increment for any time the tvbuff is
90  * used as a member of another tvbuff, i.e., as the backing buffer for
91  * a TVBUFF_SUBSET or as a member of a TVBUFF_COMPOSITE.
92  *
93  * Although you may call tvb_free(), the tvbuff may still be in use
94  * by other tvbuff's (TVBUFF_SUBSET or TVBUFF_COMPOSITE), so it is not
95  * safe, unless you know otherwise, to free your guint8* data. If you
96  * cannot be sure that your TVBUFF_REAL_DATA is not in use by another
97  * tvbuff, register a callback with tvb_set_free_cb(); when your tvbuff
98  * is _really_ freed, then your callback will be called, and at that time
99  * you can free your original data.
100  *
101  * The caller can artificially increment/decrement the usage count
102  * with tvbuff_increment_usage_count()/tvbuff_decrement_usage_count().
103  */
104 extern void tvb_free(tvbuff_t*);
105
106 /* Free the tvbuff_t and all tvbuff's created from it. */
107 extern void tvb_free_chain(tvbuff_t*);
108
109 /* Both return the new usage count, after the increment or decrement */
110 extern guint tvb_increment_usage_count(tvbuff_t*, guint count);
111
112 /* If a decrement causes the usage count to drop to 0, a the tvbuff
113  * is immediately freed. Be sure you know exactly what you're doing
114  * if you decide to use this function, as another tvbuff could
115  * still have a pointer to the just-freed tvbuff, causing corrupted data
116  * or a segfault in the future */
117 extern guint tvb_decrement_usage_count(tvbuff_t*, guint count);
118
119 /* Set a callback function to call when a tvbuff is actually freed
120  * (once the usage count drops to 0). One argument is passed to
121  * that callback --- a void* that points to the real data.
122  * Obviously, this only applies to a TVBUFF_REAL_DATA tvbuff. */
123 extern void tvb_set_free_cb(tvbuff_t*, tvbuff_free_cb_t);
124
125
126 /* Attach a TVBUFF_REAL_DATA tvbuff to a parent tvbuff. This connection
127  * is used during a tvb_free_chain()... the "child" TVBUFF_REAL_DATA acts
128  * as if is part of the chain-of-creation of the parent tvbuff, although it
129  * isn't. This is useful if you need to take the data from some tvbuff,
130  * run some operation on it, like decryption or decompression, and make a new
131  * tvbuff from it, yet want the new tvbuff to be part of the chain. The reality
132  * is that the new tvbuff *is* part of the "chain of creation", but in a way
133  * that these tvbuff routines is ignorant of. Use this function to make
134  * the tvbuff routines knowledgable of this fact. */
135 extern void tvb_set_child_real_data_tvbuff(tvbuff_t* parent, tvbuff_t* child);
136
137 /* Sets parameters for TVBUFF_REAL_DATA. Can throw ReportedBoundsError. */
138 extern void tvb_set_real_data(tvbuff_t*, const guint8* data, guint length,
139     gint reported_length);
140
141 /* Combination of tvb_new() and tvb_set_real_data(). Can throw ReportedBoundsError. */
142 extern tvbuff_t* tvb_new_real_data(const guint8* data, guint length,
143     gint reported_length, const gchar *name);
144
145
146 /* Define the subset of the backing buffer to use.
147  *
148  * 'backing_offset' can be negative, to indicate bytes from
149  * the end of the backing buffer.
150  *
151  * 'backing_length' can be 0, although the usefulness of the buffer would
152  * be rather limited.
153  *
154  * 'backing_length' of -1 means "to the end of the backing buffer"
155  *
156  * Will throw BoundsError if 'backing_offset'/'length'
157  * is beyond the bounds of the backing tvbuff.
158  * Can throw ReportedBoundsError. */
159 extern void tvb_set_subset(tvbuff_t* tvb, tvbuff_t* backing,
160                 gint backing_offset, gint backing_length, gint reported_length);
161
162 /* Combination of tvb_new() and tvb_set_subset()
163  * Can throw ReportedBoundsError. */
164 extern tvbuff_t* tvb_new_subset(tvbuff_t* backing,
165                 gint backing_offset, gint backing_length, gint reported_length);
166
167
168 /* Both tvb_composite_append and tvb_composite_prepend can throw
169  * BoundsError if member_offset/member_length goes beyond bounds of
170  * the 'member' tvbuff. */
171
172 /* Append to the list of tvbuffs that make up this composite tvbuff */
173 extern void tvb_composite_append(tvbuff_t* tvb, tvbuff_t* member);
174
175 /* Prepend to the list of tvbuffs that make up this composite tvbuff */
176 extern void tvb_composite_prepend(tvbuff_t* tvb, tvbuff_t* member);
177
178 /* Helper function that calls tvb_new(TVBUFF_COMPOSITE).
179  * Provided only to maintain symmetry with other constructors */
180 extern tvbuff_t* tvb_new_composite(void);
181
182 /* Mark a composite tvbuff as initialized. No further appends or prepends
183  * occur, data access can finally happen after this finalization. */
184 extern void tvb_composite_finalize(tvbuff_t* tvb);
185
186
187 /* Get total length of buffer */
188 extern guint tvb_length(tvbuff_t*);
189
190 /* Computes bytes to end of buffer, from offset (which can be negative,
191  * to indicate bytes from end of buffer). Function returns -1 to
192  * indicate that offset is out of bounds. No exception is thrown. */
193 extern gint tvb_length_remaining(tvbuff_t*, gint offset);
194
195 /* Checks (w/o throwing exception) that the bytes referred to by
196  * 'offset'/'length' actually exist in the buffer */
197 extern gboolean tvb_bytes_exist(tvbuff_t*, gint offset, gint length);
198
199 /* Checks (w/o throwing exception) that offset exists in buffer */
200 extern gboolean tvb_offset_exists(tvbuff_t*, gint offset);
201
202 /* Get reported length of buffer */
203 extern guint tvb_reported_length(tvbuff_t*);
204
205 /* Computes bytes of reported packet data to end of buffer, from offset
206  * (which can be negative, to indicate bytes from end of buffer). Function
207  * returns -1 to indicate that offset is out of bounds. No exception is
208  * thrown. */
209 extern gint tvb_reported_length_remaining(tvbuff_t *tvb, gint offset);
210
211 /* Set the reported length of a tvbuff to a given value; used for protocols
212    whose headers contain an explicit length and where the calling
213    dissector's payload may include padding as well as the packet for
214    this protocol.
215
216    Also adjusts the data length. */
217 extern void tvb_set_reported_length(tvbuff_t*, guint);
218
219 /* Returns the offset from the first byte of real data. */
220 extern gint tvb_raw_offset(tvbuff_t*);
221
222 /************** START OF ACCESSORS ****************/
223 /* All accessors will throw BoundsError or ReportedBoundsError if appropriate */
224
225 extern guint8  tvb_get_guint8(tvbuff_t*, gint offset);
226
227 extern guint16 tvb_get_ntohs(tvbuff_t*, gint offset);
228 extern guint32 tvb_get_ntoh24(tvbuff_t*, gint offset);
229 extern guint32 tvb_get_ntohl(tvbuff_t*, gint offset);
230
231 extern guint16 tvb_get_letohs(tvbuff_t*, gint offset);
232 extern guint32 tvb_get_letoh24(tvbuff_t*, gint offset);
233 extern guint32 tvb_get_letohl(tvbuff_t*, gint offset);
234
235 /* Returns target for convenience. Does not suffer from possible
236  * expense of tvb_get_ptr(), since this routine is smart enough
237  * to copy data in chunks if the request range actually exists in
238  * different TVBUFF_REAL_DATA tvbuffs. This function assumes that the
239  * target memory is already allocated; it does not allocate or free the
240  * target memory. */
241 extern guint8* tvb_memcpy(tvbuff_t*, guint8* target, gint offset, gint length);
242
243 /* It is the user's responsibility to g_free() the memory allocated by
244  * tvb_memdup(). Calls tvb_memcpy() */
245 extern guint8* tvb_memdup(tvbuff_t*, gint offset, gint length);
246
247 /* WARNING! This function is possibly expensive, temporarily allocating
248  * another copy of the packet data. Furthermore, it's dangerous because once
249  * this pointer is given to the user, there's no guarantee that the user will
250  * honor the 'length' and not overstep the boundaries of the buffer.
251  *
252  * The returned pointer is data that is internal to the tvbuff, so do not
253  * attempt to free it. Don't modify the data, either, because another tvbuff
254  * that might be using this tvbuff may have already copied that portion of
255  * the data (sometimes tvbuff's need to make copies of data, but that's the
256  * internal implementation that you need not worry about). Assume that the
257  * guint8* points to read-only data that the tvbuff manages.
258  *
259  * Return a pointer into our buffer if the data asked for via 'offset'/'length'
260  * is contiguous (which might not be the case for TVBUFF_COMPOSITE). If the
261  * data is not contiguous, a tvb_memdup() is called for the entire buffer
262  * and the pointer to the newly-contiguous data is returned. This dynamically-
263  * allocated memory will be freed when the tvbuff is freed, after the
264  * tvbuff_free_cb_t() is called, if any. */
265 extern const guint8* tvb_get_ptr(tvbuff_t*, gint offset, gint length);
266
267 /* Find first occurence of any of the needles in tvbuff, starting at offset.
268  * Searches at most maxlength number of bytes; if maxlength is -1, searches
269  * to end of tvbuff.
270  * Returns the offset of the found needle, or -1 if not found.
271  * Will not throw an exception, even if maxlength exceeds boundary of tvbuff;
272  * in that case, -1 will be returned if the boundary is reached before
273  * finding needle. */
274 extern gint tvb_find_guint8(tvbuff_t*, gint offset, gint maxlength,
275     guint8 needle);
276
277 /* Find first occurence of any of the needles in tvbuff, starting at offset.
278  * Searches at most maxlength number of bytes. Returns the offset of the
279  * found needle, or -1 if not found. Will not throw an exception, even if
280  * maxlength exceeds boundary of tvbuff; in that case, -1 will be returned if
281  * the boundary is reached before finding needle. */
282 extern gint tvb_pbrk_guint8(tvbuff_t *, gint offset, gint maxlength,
283     guint8 *needles);
284
285 /* Find size of stringz (NUL-terminated string) by looking for terminating
286  * NUL.  The size of the string includes the terminating NUL.
287  *
288  * If the NUL isn't found, it throws the appropriate exception.
289  */
290 extern guint tvb_strsize(tvbuff_t *tvb, gint offset);
291
292 /* Find length of string by looking for end of string ('\0'), up to
293  * 'maxlength' characters'; if 'maxlength' is -1, searches to end
294  * of tvbuff.
295  * Returns -1 if 'maxlength' reached before finding EOS. */
296 extern gint tvb_strnlen(tvbuff_t*, gint offset, guint maxlength);
297
298 /*
299  * Format the data in the tvb from offset for size ...
300  */
301 extern guint8 * tvb_format_text(tvbuff_t *tvb, gint offset, gint size);
302
303 /* Looks for a stringz (NUL-terminated string) in tvbuff and copies
304  * no more than maxlength number of bytes, including terminating NUL, to buffer.
305  * Returns length of string (not including terminating NUL), or -1 if the string was
306  * truncated in the buffer due to not having reached the terminating NUL.
307  * In this way, it acts like snprintf().
308  */
309 extern gint tvb_get_nstringz(tvbuff_t *tvb, gint offset, guint maxlength,
310     guint8* buffer);
311
312 /* Like tvb_get_nstringz(), but never returns -1. The string is guaranteed to
313  * have a terminating NUL. If the string was truncated when copied into buffer,
314  * a NUL is placed at the end of buffer to terminate it.
315  */
316 extern gint tvb_get_nstringz0(tvbuff_t *tvb, gint offset, guint maxlength,
317     guint8* buffer);
318
319 /*
320  * Given a tvbuff, an offset into the tvbuff, and a length that starts
321  * at that offset (which may be -1 for "all the way to the end of the
322  * tvbuff"), find the end of the (putative) line that starts at the
323  * specified offset in the tvbuff, going no further than the specified
324  * length.
325  *
326  * Return the offset right past the end of the line as the return value,
327  * and return the offset of the EOL character(s) in "*eol".
328  */
329 extern gint tvb_find_line_end(tvbuff_t *tvb, gint offset, int len, gint *eol);
330
331 /*
332  * Given a tvbuff, an offset into the tvbuff, and a length that starts
333  * at that offset (which may be -1 for "all the way to the end of the
334  * tvbuff"), find the end of the (putative) line that starts at the
335  * specified offset in the tvbuff, going no further than the specified
336  * length.
337  *
338  * However, treat quoted strings inside the buffer specially - don't
339  * treat newlines in quoted strings as line terminators.
340  *
341  * Return the length of the line (not counting the line terminator at
342  * the end), or the amount of data remaining in the buffer if we don't
343  * find a line terminator.
344  *
345  * Set "*next_offset" to the offset of the character past the line
346  * terminator, or past the end of the buffer if we don't find a line
347  * terminator.
348  */
349 extern gint tvb_find_line_end_unquoted(tvbuff_t *tvb, gint offset, int len,
350     gint *next_offset);
351
352 /*
353  * Call strncmp after checking if enough chars left, returning 0 if
354  * it returns 0 (meaning "equal") and -1 otherwise, otherwise return -1.
355  */
356 extern gint tvb_strneql(tvbuff_t *tvb, gint offset, const guint8 *str,
357     gint size);
358
359 /*
360  * Call strncasecmp after checking if enough chars left, returning 0 if
361  * it returns 0 (meaning "equal") and -1 otherwise, otherwise return -1.
362  */
363 extern gint tvb_strncaseeql(tvbuff_t *tvb, gint offset, const guint8 *str,
364     gint size);
365
366 /*
367  * Call memcmp after checking if enough chars left, returning 0 if
368  * it returns 0 (meaning "equal") and -1 otherwise, otherwise return -1.
369  */
370 extern gint tvb_memeql(tvbuff_t *tvb, gint offset, const guint8 *str,
371     gint size);
372
373 /*
374  * Format a bunch of data from a tvbuff as bytes, returning a pointer
375  * to the string with the formatted data.
376  */
377 extern gchar *tvb_bytes_to_str(tvbuff_t *tvb, gint offset, gint len);
378
379 extern gchar *tvb_get_name(tvbuff_t *tvb);
380
381 /************** END OF ACCESSORS ****************/
382
383 #endif /* __TVBUFF_H__ */