epan/wmem/wmem_allocator.h

   1 /* wmem_allocator.h
   2  * Definitions for the Wireshark Memory Manager Allocator
   3  * Copyright 2012, Evan Huus <eapache@gmail.com>
   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 modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation; either version 2 of the License, or
  14  * (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 along
  22  * with this program; if not, write to the Free Software Foundation, Inc.,
  23  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  24  */
  25
  26 #ifndef __WMEM_ALLOCATOR_H__
  27 #define __WMEM_ALLOCATOR_H__
  28
  29 #include <glib.h>
  30 #include <string.h>
  31
  32 #ifdef __cplusplus
  33 extern "C" {
  34 #endif /* __cplusplus */
  35
  36 enum _wmem_allocator_type_t;
  37 struct _wmem_user_cb_container_t;
  38
  39 /* See section "4. Internal Design" of doc/README.wmem for details
  40  * on this structure */
  41 struct _wmem_allocator_t {
  42     /* Consumer functions */
  43     void *(*alloc)(void *private_data, const size_t size);
  44     void  (*free)(void *private_data, void *ptr);
  45     void *(*realloc)(void *private_data, void *ptr, const size_t size);
  46
  47     /* Producer/Manager functions */
  48     void  (*free_all)(void *private_data);
  49     void  (*gc)(void *private_data);
  50     void  (*cleanup)(void *private_data);
  51
  52     /* Callback List */
  53     struct _wmem_user_cb_container_t *callbacks;
  54
  55     /* Implementation details */
  56     void                        *private_data;
  57     enum _wmem_allocator_type_t  type;
  58     gboolean                     in_scope;
  59 };
  60
  61 #ifdef __cplusplus
  62 }
  63 #endif /* __cplusplus */
  64
  65 #endif /* __WMEM_ALLOCATOR_H__ */
  66
  67 /*
  68  * Editor modelines  -  http://www.wireshark.org/tools/modelines.html
  69  *
  70  * Local variables:
  71  * c-basic-offset: 4
  72  * tab-width: 8
  73  * indent-tabs-mode: nil
  74  * End:
  75  *
  76  * vi: set shiftwidth=4 tabstop=8 expandtab:
  77  * :indentSize=4:tabSize=8:noTabs=true:
  78  */