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.23 2002/03/06 19:17:06 gram 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);
 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 /* Same as above, but throws BoundsError if the offset is out of bounds. */
 196 extern gint tvb_ensure_length_remaining(tvbuff_t*, gint offset);
 197
 198 /* Checks (w/o throwing exception) that the bytes referred to by
 199  * 'offset'/'length' actually exist in the buffer */
 200 extern gboolean tvb_bytes_exist(tvbuff_t*, gint offset, gint length);
 201
 202 /* Checks (w/o throwing exception) that offset exists in buffer */
 203 extern gboolean tvb_offset_exists(tvbuff_t*, gint offset);
 204
 205 /* Get reported length of buffer */
 206 extern guint tvb_reported_length(tvbuff_t*);
 207
 208 /* Computes bytes of reported packet data to end of buffer, from offset
 209  * (which can be negative, to indicate bytes from end of buffer). Function
 210  * returns -1 to indicate that offset is out of bounds. No exception is
 211  * thrown. */
 212 extern gint tvb_reported_length_remaining(tvbuff_t *tvb, gint offset);
 213
 214 /* Set the reported length of a tvbuff to a given value; used for protocols
 215    whose headers contain an explicit length and where the calling
 216    dissector's payload may include padding as well as the packet for
 217    this protocol.
 218
 219    Also adjusts the data length. */
 220 extern void tvb_set_reported_length(tvbuff_t*, guint);
 221
 222 /* Returns the offset from the first byte of real data. */
 223 extern gint tvb_raw_offset(tvbuff_t*);
 224
 225 /************** START OF ACCESSORS ****************/
 226 /* All accessors will throw BoundsError or ReportedBoundsError if appropriate */
 227
 228 extern guint8  tvb_get_guint8(tvbuff_t*, gint offset);
 229
 230 extern guint16 tvb_get_ntohs(tvbuff_t*, gint offset);
 231 extern guint32 tvb_get_ntoh24(tvbuff_t*, gint offset);
 232 extern guint32 tvb_get_ntohl(tvbuff_t*, gint offset);
 233
 234 extern guint16 tvb_get_letohs(tvbuff_t*, gint offset);
 235 extern guint32 tvb_get_letoh24(tvbuff_t*, gint offset);
 236 extern guint32 tvb_get_letohl(tvbuff_t*, gint offset);
 237
 238 /* Returns target for convenience. Does not suffer from possible
 239  * expense of tvb_get_ptr(), since this routine is smart enough
 240  * to copy data in chunks if the request range actually exists in
 241  * different TVBUFF_REAL_DATA tvbuffs. This function assumes that the
 242  * target memory is already allocated; it does not allocate or free the
 243  * target memory. */
 244 extern guint8* tvb_memcpy(tvbuff_t*, guint8* target, gint offset, gint length);
 245
 246 /* It is the user's responsibility to g_free() the memory allocated by
 247  * tvb_memdup(). Calls tvb_memcpy() */
 248 extern guint8* tvb_memdup(tvbuff_t*, gint offset, gint length);
 249
 250 /* WARNING! This function is possibly expensive, temporarily allocating
 251  * another copy of the packet data. Furthermore, it's dangerous because once
 252  * this pointer is given to the user, there's no guarantee that the user will
 253  * honor the 'length' and not overstep the boundaries of the buffer.
 254  *
 255  * The returned pointer is data that is internal to the tvbuff, so do not
 256  * attempt to free it. Don't modify the data, either, because another tvbuff
 257  * that might be using this tvbuff may have already copied that portion of
 258  * the data (sometimes tvbuff's need to make copies of data, but that's the
 259  * internal implementation that you need not worry about). Assume that the
 260  * guint8* points to read-only data that the tvbuff manages.
 261  *
 262  * Return a pointer into our buffer if the data asked for via 'offset'/'length'
 263  * is contiguous (which might not be the case for TVBUFF_COMPOSITE). If the
 264  * data is not contiguous, a tvb_memdup() is called for the entire buffer
 265  * and the pointer to the newly-contiguous data is returned. This dynamically-
 266  * allocated memory will be freed when the tvbuff is freed, after the
 267  * tvbuff_free_cb_t() is called, if any. */
 268 extern const guint8* tvb_get_ptr(tvbuff_t*, gint offset, gint length);
 269
 270 /* Find first occurence of any of the needles in tvbuff, starting at offset.
 271  * Searches at most maxlength number of bytes; if maxlength is -1, searches
 272  * to end of tvbuff.
 273  * Returns the offset of the found needle, or -1 if not found.
 274  * Will not throw an exception, even if maxlength exceeds boundary of tvbuff;
 275  * in that case, -1 will be returned if the boundary is reached before
 276  * finding needle. */
 277 extern gint tvb_find_guint8(tvbuff_t*, gint offset, gint maxlength,
 278     guint8 needle);
 279
 280 /* Find first occurence of any of the needles in tvbuff, starting at offset.
 281  * Searches at most maxlength number of bytes. Returns the offset of the
 282  * found needle, or -1 if not found. Will not throw an exception, even if
 283  * maxlength exceeds boundary of tvbuff; in that case, -1 will be returned if
 284  * the boundary is reached before finding needle. */
 285 extern gint tvb_pbrk_guint8(tvbuff_t *, gint offset, gint maxlength,
 286     guint8 *needles);
 287
 288 /* Find size of stringz (NUL-terminated string) by looking for terminating
 289  * NUL.  The size of the string includes the terminating NUL.
 290  *
 291  * If the NUL isn't found, it throws the appropriate exception.
 292  */
 293 extern guint tvb_strsize(tvbuff_t *tvb, gint offset);
 294
 295 /* Find length of string by looking for end of string ('\0'), up to
 296  * 'maxlength' characters'; if 'maxlength' is -1, searches to end
 297  * of tvbuff.
 298  * Returns -1 if 'maxlength' reached before finding EOS. */
 299 extern gint tvb_strnlen(tvbuff_t*, gint offset, guint maxlength);
 300
 301 /*
 302  * Format the data in the tvb from offset for size ...
 303  */
 304 extern guint8 * tvb_format_text(tvbuff_t *tvb, gint offset, gint size);
 305
 306 /* Looks for a stringz (NUL-terminated string) in tvbuff and copies
 307  * no more than maxlength number of bytes, including terminating NUL, to buffer.
 308  * Returns length of string (not including terminating NUL), or -1 if the string was
 309  * truncated in the buffer due to not having reached the terminating NUL.
 310  * In this way, it acts like snprintf().
 311  *
 312  * When processing a packet where the remaining number of bytes is less
 313  * than maxlength, an exception is not thrown if the end of the packet
 314  * is reached before the NUL is found. If no NUL is found before reaching
 315  * the end of the short packet, -1 is still returned, and the string
 316  * is truncated with a NUL, albeit not at buffer[maxlength], but
 317  * at the correct spot, terminating the string.
 318  */
 319 extern gint tvb_get_nstringz(tvbuff_t *tvb, gint offset, guint maxlength,
 320     guint8* buffer);
 321
 322 /* Like tvb_get_nstringz(), but never returns -1. The string is guaranteed to
 323  * have a terminating NUL. If the string was truncated when copied into buffer,
 324  * a NUL is placed at the end of buffer to terminate it.
 325  */
 326 extern gint tvb_get_nstringz0(tvbuff_t *tvb, gint offset, guint maxlength,
 327     guint8* buffer);
 328
 329 /*
 330  * Given a tvbuff, an offset into the tvbuff, and a length that starts
 331  * at that offset (which may be -1 for "all the way to the end of the
 332  * tvbuff"), find the end of the (putative) line that starts at the
 333  * specified offset in the tvbuff, going no further than the specified
 334  * length.
 335  *
 336  * Return the offset right past the end of the line as the return value,
 337  * and return the offset of the EOL character(s) in "*eol".
 338  */
 339 extern gint tvb_find_line_end(tvbuff_t *tvb, gint offset, int len, gint *eol);
 340
 341 /*
 342  * Given a tvbuff, an offset into the tvbuff, and a length that starts
 343  * at that offset (which may be -1 for "all the way to the end of the
 344  * tvbuff"), find the end of the (putative) line that starts at the
 345  * specified offset in the tvbuff, going no further than the specified
 346  * length.
 347  *
 348  * However, treat quoted strings inside the buffer specially - don't
 349  * treat newlines in quoted strings as line terminators.
 350  *
 351  * Return the length of the line (not counting the line terminator at
 352  * the end), or the amount of data remaining in the buffer if we don't
 353  * find a line terminator.
 354  *
 355  * Set "*next_offset" to the offset of the character past the line
 356  * terminator, or past the end of the buffer if we don't find a line
 357  * terminator.
 358  */
 359 extern gint tvb_find_line_end_unquoted(tvbuff_t *tvb, gint offset, int len,
 360     gint *next_offset);
 361
 362 /*
 363  * Call strncmp after checking if enough chars left, returning 0 if
 364  * it returns 0 (meaning "equal") and -1 otherwise, otherwise return -1.
 365  */
 366 extern gint tvb_strneql(tvbuff_t *tvb, gint offset, const guint8 *str,
 367     gint size);
 368
 369 /*
 370  * Call strncasecmp after checking if enough chars left, returning 0 if
 371  * it returns 0 (meaning "equal") and -1 otherwise, otherwise return -1.
 372  */
 373 extern gint tvb_strncaseeql(tvbuff_t *tvb, gint offset, const guint8 *str,
 374     gint size);
 375
 376 /*
 377  * Call memcmp after checking if enough chars left, returning 0 if
 378  * it returns 0 (meaning "equal") and -1 otherwise, otherwise return -1.
 379  */
 380 extern gint tvb_memeql(tvbuff_t *tvb, gint offset, const guint8 *str,
 381     gint size);
 382
 383 /*
 384  * Format a bunch of data from a tvbuff as bytes, returning a pointer
 385  * to the string with the formatted data.
 386  */
 387 extern gchar *tvb_bytes_to_str(tvbuff_t *tvb, gint offset, gint len);
 388
 389 extern tvbuff_t *tvb_get_ds_tvb(tvbuff_t *tvb);
 390
 391 /************** END OF ACCESSORS ****************/
 392
 393 #endif /* __TVBUFF_H__ */