epan/wmem_scopes.h

   1 /** @file
   2  * Definitions for the Wireshark Memory Manager Scopes
   3  * Copyright 2012, Evan Huus <eapache@gmail.com>
   4  *
   5  * Wireshark - Network traffic analyzer
   6  * By Gerald Combs <gerald@wireshark.org>
   7  * Copyright 1998 Gerald Combs
   8  *
   9  * SPDX-License-Identifier: GPL-2.0-or-later
  10  */
  11
  12 #ifndef __WMEM_SCOPES_H__
  13 #define __WMEM_SCOPES_H__
  14
  15 #include <wsutil/wmem/wmem.h>
  16
  17 #ifdef __cplusplus
  18 extern "C" {
  19 #endif /* __cplusplus */
  20
  21 /**
  22  * @brief Fetch the current epan scope.
  23  *
  24  * Allocated memory is freed when wmem_leave_epan_scope() is called, which is normally at program exit.
  25  */
  26 WS_DLL_PUBLIC
  27 wmem_allocator_t *
  28 wmem_epan_scope(void);
  29
  30 /**
  31  * @brief Fetch the current packet scope.
  32  *
  33  * Allocated memory is freed when wmem_leave_packet_scope() is called, which is normally at the end of packet dissection.
  34  * N.B. Please use pinfo->pool in new code when possible. See
  35  * <https://lists.wireshark.org/archives/wireshark-dev/202107/msg00052.html>
  36  */
  37 WS_DLL_PUBLIC
  38 wmem_allocator_t *
  39 wmem_packet_scope(void);
  40
  41 WS_DLL_LOCAL
  42 void
  43 wmem_enter_packet_scope(void);
  44
  45 WS_DLL_LOCAL
  46 void
  47 wmem_leave_packet_scope(void);
  48
  49 /**
  50  * @brief Fetch the current file scope.
  51  *
  52  * Allocated memory is freed when wmem_leave_file_scope() is called, which is normally when a capture file is closed.
  53  */
  54 WS_DLL_PUBLIC
  55 wmem_allocator_t *
  56 wmem_file_scope(void);
  57
  58 WS_DLL_LOCAL
  59 void
  60 wmem_enter_file_scope(void);
  61
  62 WS_DLL_LOCAL
  63 void
  64 wmem_leave_file_scope(void);
  65
  66 /* Scope Management */
  67
  68 WS_DLL_PUBLIC
  69 void
  70 wmem_init_scopes(void);
  71
  72 WS_DLL_PUBLIC
  73 void
  74 wmem_cleanup_scopes(void);
  75
  76 #ifdef __cplusplus
  77 }
  78 #endif /* __cplusplus */
  79
  80 #endif /* __WMEM_SCOPES_H__ */
  81
  82 /*
  83  * Editor modelines  -  https://www.wireshark.org/tools/modelines.html
  84  *
  85  * Local variables:
  86  * c-basic-offset: 4
  87  * tab-width: 8
  88  * indent-tabs-mode: nil
  89  * End:
  90  *
  91  * vi: set shiftwidth=4 tabstop=8 expandtab:
  92  * :indentSize=4:tabSize=8:noTabs=true:
  93  */