sal/rtl/alloc_arena.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef INCLUDED_SAL_RTL_ALLOC_ARENA_HXX
  21 #define INCLUDED_SAL_RTL_ALLOC_ARENA_HXX
  22
  23 #include <sal/types.h>
  24 #include <rtl/alloc.h>
  25 #include "alloc_impl.hxx"
  26
  27 /** rtl_arena_stat_type
  28  *  @internal
  29  */
  30 struct rtl_arena_stat_type
  31 {
  32     sal_uInt64 m_alloc;
  33     sal_uInt64 m_free;
  34
  35     sal_Size   m_mem_total;
  36     sal_Size   m_mem_alloc;
  37 };
  38
  39 /** rtl_arena_segment_type
  40  *  @internal
  41  */
  42 #define RTL_ARENA_SEGMENT_TYPE_HEAD (sal_Size(0x01))
  43 #define RTL_ARENA_SEGMENT_TYPE_SPAN (sal_Size(0x02))
  44 #define RTL_ARENA_SEGMENT_TYPE_FREE (sal_Size(0x04))
  45 #define RTL_ARENA_SEGMENT_TYPE_USED (sal_Size(0x08))
  46
  47 struct rtl_arena_segment_type
  48 {
  49     /* segment list linkage */
  50     rtl_arena_segment_type * m_snext;
  51     rtl_arena_segment_type * m_sprev;
  52
  53     /* free/used list linkage */
  54     rtl_arena_segment_type * m_fnext;
  55     rtl_arena_segment_type * m_fprev;
  56
  57     /* segment description */
  58     sal_uIntPtr         m_addr;
  59     sal_Size            m_size;
  60     sal_Size            m_type;
  61 };
  62
  63 /** rtl_arena_type
  64  *  @internal
  65  */
  66 #define RTL_ARENA_FREELIST_SIZE (sizeof(void*) * 8)
  67 #define RTL_ARENA_HASH_SIZE     64
  68
  69 #define RTL_ARENA_FLAG_RESCALE  1 /* within hash rescale operation */
  70
  71 struct rtl_arena_st
  72 {
  73     /* linkage */
  74     rtl_arena_type *          m_arena_next;
  75     rtl_arena_type *          m_arena_prev;
  76
  77     /* properties */
  78     char                      m_name[RTL_ARENA_NAME_LENGTH + 1];
  79     long                      m_flags;
  80
  81     rtl_memory_lock_type      m_lock;
  82     rtl_arena_stat_type       m_stats;
  83
  84     rtl_arena_type *          m_source_arena;
  85     void * (SAL_CALL * m_source_alloc)(rtl_arena_type *, sal_Size *);
  86     void   (SAL_CALL * m_source_free) (rtl_arena_type *, void *, sal_Size);
  87
  88     sal_Size                  m_quantum;
  89     sal_Size                  m_quantum_shift; /* log2(m_quantum) */
  90
  91     rtl_arena_segment_type    m_segment_reserve_span_head;
  92     rtl_arena_segment_type    m_segment_reserve_head;
  93
  94     rtl_arena_segment_type    m_segment_head;
  95
  96     rtl_arena_segment_type    m_freelist_head[RTL_ARENA_FREELIST_SIZE];
  97     sal_Size                  m_freelist_bitmap;
  98
  99     rtl_arena_segment_type ** m_hash_table;
 100     rtl_arena_segment_type *  m_hash_table_0[RTL_ARENA_HASH_SIZE];
 101     sal_Size                  m_hash_size;  /* m_hash_mask + 1   */
 102     sal_Size                  m_hash_shift; /* log2(m_hash_size) */
 103 };
 104
 105 /** gp_default_arena
 106  *  default arena with pagesize quantum
 107  *
 108  *  @internal
 109  */
 110 extern rtl_arena_type * gp_default_arena;
 111
 112 typedef void (*ArenaForeachFn)(void *addr, sal_Size size);
 113
 114 void rtl_arena_foreach(rtl_arena_type *arena, ArenaForeachFn fn);
 115
 116 #endif // INCLUDED_SAL_RTL_ALLOC_ARENA_HXX
 117
 118 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */