epan/emem.h

   1 /* emem.h
   2  * Definitions for Wireshark memory management and garbage collection
   3  * Ronnie Sahlberg 2005
   4  *
   5  * $Id$
   6  *
   7  * Wireshark - Network traffic analyzer
   8  * By Gerald Combs <gerald@wireshark.org>
   9  * Copyright 1998 Gerald Combs
  10  *
  11  * This program is free software; you can redistribute it and/or
  12  * modify it under the terms of the GNU General Public License
  13  * as published by the Free Software Foundation; either version 2
  14  * of the License, or (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program; if not, write to the Free Software
  23  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  24  */
  25
  26 #ifndef __EMEM_H__
  27 #define __EMEM_H__
  28
  29 #include "gnuc_format_check.h"
  30
  31 /*  Initialize all the memory allocation pools described below.
  32  *  This function must be called once when *shark initialize to set up the
  33  *  required structures.
  34  */
  35 void emem_init(void);
  36
  37 /* Functions for handling memory allocation and garbage collection with
  38  * a packet lifetime scope.
  39  * These functions are used to allocate memory that will only remain persistent
  40  * until Wireshark starts dissecting the next packet in the list.
  41  * Everytime Wireshark starts decoding the next packet all memory allocated
  42  * through these functions will be released back to the free pool.
  43  *
  44  * These functions are very fast and offer automatic garbage collection:
  45  * Everytime a new packet is dissected, all memory allocations done in
  46  * the previous packet is freed.
  47  */
  48
  49 /* Allocate memory with a packet lifetime scope */
  50 void *ep_alloc(size_t size);
  51 #define ep_new(type) ((type*)ep_alloc(sizeof(type)))
  52
  53 /* Allocate memory with a packet lifetime scope and fill it with zeros*/
  54 void* ep_alloc0(size_t size);
  55 #define ep_new0(type) ((type*)ep_alloc0(sizeof(type)))
  56
  57 /* Duplicate a string with a packet lifetime scope */
  58 gchar* ep_strdup(const gchar* src);
  59
  60 /* Duplicate at most n characters of a string with a packet lifetime scope */
  61 gchar* ep_strndup(const gchar* src, size_t len);
  62
  63 /* Duplicate a buffer with a packet lifetime scope */
  64 void* ep_memdup(const void* src, size_t len);
  65
  66 /* Create a formatted string with a packet lifetime scope */
  67 gchar* ep_strdup_vprintf(const gchar* fmt, va_list ap);
  68 gchar* ep_strdup_printf(const gchar* fmt, ...)
  69     GNUC_FORMAT_CHECK(printf, 1, 2);
  70
  71 /* allocates with a packet lifetime scope an array of type made of num elements */
  72 #define ep_alloc_array(type,num) (type*)ep_alloc(sizeof(type)*(num))
  73
  74 /* allocates with a packet lifetime scope an array of type made of num elements,
  75  * initialised to zero.
  76  */
  77 #define ep_alloc_array0(type,num) (type*)ep_alloc0(sizeof(type)*(num))
  78
  79 /*
  80  * Splits a string into a maximum of max_tokens pieces, using the given
  81  * delimiter. If max_tokens is reached, the remainder of string is appended
  82  * to the last token. Consecutive delimiters are treated as a single delimiter.
  83  *
  84  * the vector and all the strings are allocated with packet lifetime scope
  85  */
  86 gchar** ep_strsplit(const gchar* string, const gchar* delimiter, int max_tokens);
  87
  88 /* release all memory allocated in the previous packet dissector */
  89 void ep_free_all(void);
  90
  91
  92 /* a stack implemented using ephemeral allocators */
  93
  94 typedef struct _ep_stack_frame_t** ep_stack_t;
  95
  96 struct _ep_stack_frame_t {
  97     void* payload;
  98     struct _ep_stack_frame_t* below;
  99     struct _ep_stack_frame_t* above;
 100 };
 101
 102 /*
 103  * creates an empty stack with a packet lifetime scope
 104  */
 105 ep_stack_t ep_stack_new(void);
 106
 107 /*
 108  * pushes item into stack, returns item
 109  */
 110 void* ep_stack_push(ep_stack_t stack, void* item);
 111
 112 /*
 113  * pops an item from the stack
 114  */
 115 void* ep_stack_pop(ep_stack_t stack);
 116
 117 /*
 118  * returns the item on top of the stack without popping it
 119  */
 120 #define ep_stack_peek(stack) ((*(stack))->payload)
 121
 122
 123 /* Functions for handling memory allocation and garbage collection with
 124  * a capture lifetime scope.
 125  * These functions are used to allocate memory that will only remain persistent
 126  * until Wireshark opens a new capture or capture file.
 127  * Everytime Wireshark starts a new capture or opens a new capture file
 128  * all the data allocated through these functions will be released back
 129  * to the free pool.
 130  *
 131  * These functions are very fast and offer automatic garbage collection.
 132  */
 133
 134 /* Allocate memory with a capture lifetime scope */
 135 void *se_alloc(size_t size);
 136
 137 /* Allocate memory with a capture lifetime scope and fill it with zeros*/
 138 void* se_alloc0(size_t size);
 139
 140 /* Duplicate a string with a capture lifetime scope */
 141 gchar* se_strdup(const gchar* src);
 142
 143 /* Duplicate at most n characters of a string with a capture lifetime scope */
 144 gchar* se_strndup(const gchar* src, size_t len);
 145
 146 /* Duplicate a buffer with a capture lifetime scope */
 147 void* se_memdup(const void* src, size_t len);
 148
 149 /* Create a formatted string with a capture lifetime scope */
 150 gchar* se_strdup_vprintf(const gchar* fmt, va_list ap);
 151 gchar* se_strdup_printf(const gchar* fmt, ...)
 152     GNUC_FORMAT_CHECK(printf, 1, 2);
 153
 154 /* allocates with a capture lifetime scope an array of type made of num elements */
 155 #define se_alloc_array(type,num) (type*)se_alloc(sizeof(type)*(num))
 156
 157 /* release all memory allocated */
 158 void se_free_all(void);
 159
 160
 161
 162
 163 /**************************************************************
 164  * binary trees
 165  **************************************************************/
 166 typedef struct _emem_tree_node_t {
 167         struct _emem_tree_node_t *parent;
 168         struct _emem_tree_node_t *left;
 169         struct _emem_tree_node_t *right;
 170         struct {
 171 #define EMEM_TREE_RB_COLOR_RED          0
 172 #define EMEM_TREE_RB_COLOR_BLACK        1
 173                 guint32 rb_color:1;
 174 #define EMEM_TREE_NODE_IS_DATA          0
 175 #define EMEM_TREE_NODE_IS_SUBTREE       1
 176                 guint32 is_subtree:1;
 177         } u;
 178         guint32 key32;
 179         void *data;
 180 } emem_tree_node_t;
 181
 182 /* Right now we only do basic red/black trees   but in the future we might want
 183  * to try something different, such as a tree where each node keeps track
 184  * of how many times it has been looked up, and letting often looked up
 185  * nodes bubble upwards in the tree using rotate_right/left.
 186  * That would probably be good for things like nfs filehandles
 187  */
 188 #define EMEM_TREE_TYPE_RED_BLACK        1
 189 typedef struct _emem_tree_t {
 190         struct _emem_tree_t *next;
 191         int type;
 192         const char *name;    /* just a string to make debugging easier */
 193         emem_tree_node_t *tree;
 194         void *(*malloc)(size_t);
 195 } emem_tree_t;
 196
 197 /* *******************************************************************
 198  * Tree functions for SE memory allocation scope
 199  * ******************************************************************* */
 200 /* This function is used to create a se based tree with monitoring.
 201  * When the SE heap is released back to the system the pointer to the
 202  * tree is automatically reset to NULL.
 203  *
 204  * type is : EMEM_TREE_TYPE_RED_BLACK for a standard red/black tree.
 205  */
 206 emem_tree_t *se_tree_create(int type, const char *name);
 207
 208 /* This function is similar to the se_tree_create() call but with the
 209  * difference that when the se memory is release everything including the
 210  * pointer to the tree itself will be released.
 211  * This tree will not be just reset to zero  it will be completely forgotten
 212  * by the allocator.
 213  * Use this function for when you want to store the pointer to a tree inside
 214  * another structure that is also se allocated so that when the structure is
 215  * released, the tree will be completely released as well.
 216  */
 217 emem_tree_t *se_tree_create_non_persistent(int type, const char *name);
 218
 219 /* se_tree_insert32
 220  * Insert data into the tree and key it by a 32bit integer value
 221  */
 222 #define se_tree_insert32 emem_tree_insert32
 223
 224 /* se_tree_lookup32
 225  * Retrieve the data at the search key. the search key is a 32bit integer value
 226  */
 227 #define se_tree_lookup32 emem_tree_lookup32
 228
 229 /* se_tree_lookup32_le
 230  * Retrieve the data for the largest key that is less than or equal
 231  * to the search key.
 232  */
 233 #define se_tree_lookup32_le emem_tree_lookup32_le
 234
 235 /* se_tree_insert32_array
 236  * Insert data into the tree and key it by a 32bit integer value
 237  */
 238 #define se_tree_insert32_array emem_tree_insert32_array
 239
 240 /* se_tree_lookup32_array
 241  * Lookup data from the tree that is index by an array
 242  */
 243 #define se_tree_lookup32_array emem_tree_lookup32_array
 244
 245
 246
 247 /* Create a new string based hash table */
 248 #define se_tree_create_string() se_tree_create(SE_TREE_TYPE_RED_BLACK)
 249
 250 /* Insert a new value under a string key */
 251 #define se_tree_insert_string emem_tree_insert_string
 252
 253 /* Lookup the value under a string key */
 254 #define se_tree_lookup_string emem_tree_lookup_string
 255
 256 /* Traverse a tree */
 257 #define se_tree_foreach emem_tree_foreach
 258
 259
 260 /* *******************************************************************
 261  * Tree functions for PE memory allocation scope
 262  * ******************************************************************* */
 263 /* These trees have PErmanent allocation scope and will never be released
 264  */
 265 emem_tree_t *pe_tree_create(int type, const char *name);
 266 #define pe_tree_insert32 emem_tree_insert32
 267 #define pe_tree_lookup32 emem_tree_lookup32
 268 #define pe_tree_lookup32_le emem_tree_lookup32_le
 269 #define pe_tree_insert32_array emem_tree_insert32_array
 270 #define pe_tree_lookup32_array emem_tree_lookup32_array
 271 #define pe_tree_insert_string emem_tree_insert_string
 272 #define pe_tree_lookup_string emem_tree_lookup_string
 273 #define pe_tree_foreach emem_tree_foreach
 274
 275
 276
 277 /* ******************************************************************
 278  * Real tree functions
 279  * ****************************************************************** */
 280
 281 /* This function is used to insert a node indexed by a guint32 key value.
 282  * The data pointer should be allocated by the appropriate storage scope
 283  * so that it will be released at the same time as the tree itself is
 284  * destroyed.
 285  */
 286 void emem_tree_insert32(emem_tree_t *se_tree, guint32 key, void *data);
 287
 288 /* This function will look up a node in the tree indexed by a guint32 integer
 289  * value.
 290  */
 291 void *emem_tree_lookup32(emem_tree_t *se_tree, guint32 key);
 292
 293 /* This function will look up a node in the tree indexed by a guint32 integer
 294  * value.
 295  * The function will return the node that has the largest key that is
 296  * equal to or smaller than the search key, or NULL if no such key was
 297  * found.
 298  */
 299 void *emem_tree_lookup32_le(emem_tree_t *se_tree, guint32 key);
 300
 301 typedef struct _emem_tree_key_t {
 302         guint32 length;                 /*length in guint32 words */
 303         guint32 *key;
 304 } emem_tree_key_t;
 305
 306 /* This function is used to insert a node indexed by a sequence of guint32
 307  * key values.
 308  * The data pointer should be allocated by SE allocators so that the
 309  * data will be released at the same time as the tree itself is destroyed.
 310  *
 311  * Note: all the "key" members of the "key" argument MUST be aligned on
 312  * 32-bit boundaries; otherwise, this code will crash on platforms such
 313  * as SPARC that require aligned pointers.
 314  *
 315  * If you use ...32_array() calls you MUST make sure that every single node
 316  * you add to a specific tree always has a key of exactly the same number of
 317  * keylen words or things will most likely crash. Or at least that every single
 318  * item that sits behind the same top level node always have exactly the same
 319  * number of words.
 320  *
 321  * One way to guarantee this is the way that NFS does this for the
 322  * nfs_name_snoop_known  tree which holds filehandles for both v2 and v3.
 323  * v2 filehandles are always 32 bytes (8 words) while v3 filehandles can have
 324  * any length (though 32bytes are most common).
 325  * The NFS dissector handles this by providing a guint32 containing the length
 326  * as the very first item in this vector :
 327  *
 328  *                      emem_tree_key_t fhkey[3];
 329  *
 330  *                      fhlen=nns->fh_length;
 331  *                      fhkey[0].length=1;
 332  *                      fhkey[0].key=&fhlen;
 333  *                      fhkey[1].length=fhlen/4;
 334  *                      fhkey[1].key=nns->fh;
 335  *                      fhkey[2].length=0;
 336  */
 337 void emem_tree_insert32_array(emem_tree_t *se_tree, emem_tree_key_t *key, void *data);
 338
 339 /* This function will look up a node in the tree indexed by a sequence of
 340  * guint32 integer values.
 341  */
 342 void *emem_tree_lookup32_array(emem_tree_t *se_tree, emem_tree_key_t *key);
 343
 344 /* case insensitive strings as keys */
 345 #define EMEM_TREE_STRING_NOCASE                 0x00000001
 346 /* Insert a new value under a string key */
 347 void emem_tree_insert_string(emem_tree_t* h, const gchar* k, void* v, guint32 flags);
 348
 349 /* Lookup the value under a string key */
 350 void* emem_tree_lookup_string(emem_tree_t* h, const gchar* k, guint32 flags);
 351
 352
 353 /* traverse a tree. if the callback returns TRUE the traversal will end */
 354 typedef gboolean (*tree_foreach_func)(void *value, void *userdata);
 355
 356 gboolean emem_tree_foreach(emem_tree_t* emem_tree, tree_foreach_func callback, void *user_data);
 357
 358
 359 /* ******************************************************************
 360  * String buffers - Growable strings similar to GStrings
 361  * ****************************************************************** */
 362
 363 typedef struct _emem_strbuf_t {
 364     gchar *str;             /* points to the character data. It may move as text is       */
 365                             /*  added. The str field is nul-terminated and so can         */
 366                             /*  be used as an ordinary C string.                          */
 367     gsize len;              /* strlen: ie: length of str not including trailing '\0'      */
 368     gsize alloc_len;        /* num bytes curently allocated for str: 1 .. MAX_STRBUF_LEN  */
 369     gsize max_alloc_len;    /* max num bytes to allocate for str: 1 .. MAX_STRBUF_LEN     */
 370 } emem_strbuf_t;
 371
 372 /*
 373  * The maximum length is limited to 64K. If you need something bigger, you
 374  * should probably use an actual GString or GByteArray.
 375  */
 376
 377 /**
 378  * Allocate an ephemeral string buffer with "unlimited" size.
 379  *
 380  * @param init The initial string for the buffer, or NULL to allocate an initial zero-length string.
 381  *
 382  * @return A newly-allocated string buffer.
 383  */
 384 emem_strbuf_t *ep_strbuf_new(const gchar *init);
 385
 386 /**
 387  * Allocate an ephemeral string buffer suitable for the protocol tree.
 388  * The string will never grow beyond the maximum tree item length.
 389  *
 390  * @param init The initial string for the buffer, or NULL to allocate an initial zero-length string.
 391  *
 392  * @return A newly-allocated string buffer.
 393  */
 394 emem_strbuf_t *ep_strbuf_new_label(const gchar *init);
 395
 396 /**
 397  * Allocate an ephemeral string buffer with enough initial space for @alloc_len bytes
 398  * and a maximum of @max_alloc_len bytes.
 399  *
 400  * @param alloc_len The initial size of the buffer. This value can be 0, but a nonzero
 401  * value is recommended.
 402  * @param max_alloc_len The maximum size of the buffer. 0 means "unlimited" (within
 403  * reason).
 404  *
 405  * @return A newly-allocated string buffer. @str will be empty.
 406  */
 407 emem_strbuf_t *ep_strbuf_sized_new(gsize alloc_len, gsize max_alloc_len);
 408
 409 /**
 410  * Append vprintf-style formatted text to a string buffer.
 411  *
 412  * @param strbuf The ep_strbuf-allocated string buffer to append to.
 413  * @param format A printf-style string format.
 414  * @param args The list of arguments to append.
 415  */
 416 void ep_strbuf_append_vprintf(emem_strbuf_t *strbuf, const gchar *format, va_list ap);
 417
 418 /**
 419  * Apply printf-style formatted text to a string buffer.
 420  *
 421  * @param strbuf The ep_strbuf-allocated string buffer to set to.
 422  * @param format A printf-style string format.
 423  */
 424 void ep_strbuf_printf(emem_strbuf_t *strbuf, const gchar *format, ...)
 425     GNUC_FORMAT_CHECK(printf, 2, 3);
 426
 427 /**
 428  * Append printf-style formatted text to a string buffer.
 429  *
 430  * @param strbuf The ep_strbuf-allocated string buffer to append to.
 431  * @param format A printf-style string format.
 432  */
 433 void ep_strbuf_append_printf(emem_strbuf_t *strbuf, const gchar *format, ...)
 434     GNUC_FORMAT_CHECK(printf, 2, 3);
 435
 436 /**
 437  * Append a string to a string buffer.
 438  *
 439  * @param strbuf The ep_strbuf-allocated string buffer to append to.
 440  * @param str A null-terminated string.
 441  *
 442  * @return strbuf
 443  */
 444 emem_strbuf_t *ep_strbuf_append(emem_strbuf_t *strbuf, const gchar *str);
 445
 446 /**
 447  * Append a character to a string buffer.
 448  *
 449  * @param strbuf The ep_strbuf-allocated string buffer to append to.
 450  * @param c The character to append.
 451  *
 452  * @return strbuf
 453  */
 454 emem_strbuf_t *ep_strbuf_append_c(emem_strbuf_t *strbuf, const gchar c);
 455
 456 /**
 457  * Chop off the end of a string buffer.
 458  *
 459  * @param strbuf The ep_strbuf-allocated string buffer to append to.
 460  * @param len The new string length.
 461  *
 462  * @return strbuf
 463  */
 464 emem_strbuf_t *ep_strbuf_truncate(emem_strbuf_t *strbuf, gsize len);
 465
 466 void emem_print_tree(emem_tree_t* emem_tree);
 467
 468 /* #define DEBUG_INTENSE_CANARY_CHECKS */
 469
 470 /* Helper to troubleshoot ep memory corruption
 471  * if compiled and the environment variable WIRESHARK_DEBUG_EP_INTENSE_CANARY exists
 472  * it will check the canaries and when found corrupt stop there in the hope
 473  * the corruptor is still there in the stack.
 474  * Some checkpoints are already set in packet.c in strategic points
 475  * before and after dissection of a frame or a dissector call.
 476  */
 477
 478 #ifdef DEBUG_INTENSE_CANARY_CHECKS
 479 void ep_check_canary_integrity(const char* fmt, ...)
 480     GNUC_FORMAT_CHECK(printf, 1, 2);
 481 #define EP_CHECK_CANARY(args) ep_check_canary_integrity args
 482 #else
 483 #define EP_CHECK_CANARY(args)
 484 #endif
 485
 486 /**
 487  * Verify that the given pointer is of ephemeral/seasonal type.
 488  *
 489  * @param ptr The pointer to verify
 490  *
 491  * @return TRUE if the pointer belongs to the ephemeral/seasonal pool.
 492  */
 493 gboolean ep_verify_pointer(const void *ptr);
 494 gboolean se_verify_pointer(const void *ptr);
 495
 496 #endif /* emem.h */