sal/rtl/source/alloc_impl.h

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: alloc_impl.h,v $
  10  * $Revision: 1.6 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef INCLUDED_RTL_ALLOC_IMPL_H
  32 #define INCLUDED_RTL_ALLOC_IMPL_H
  33
  34 #include "sal/types.h"
  35
  36 #ifdef __cplusplus
  37 extern "C" {
  38 #endif
  39
  40
  41 /** Alignment macros
  42  */
  43 #if SAL_TYPES_ALIGNMENT4 > 1
  44 #define RTL_MEMORY_ALIGNMENT_4 SAL_TYPES_ALIGNMENT4
  45 #else
  46 #define RTL_MEMORY_ALIGNMENT_4 sizeof(int)
  47 #endif /* SAL_TYPES_ALIGNMENT4 */
  48
  49 #if SAL_TYPES_ALIGNMENT8 > 1
  50 #define RTL_MEMORY_ALIGNMENT_8 SAL_TYPES_ALIGNMENT8
  51 #else
  52 #define RTL_MEMORY_ALIGNMENT_8 sizeof(void*)
  53 #endif /* SAL_TYPES_ALIGNMENT8 */
  54
  55 #if 0  /* @@@ */
  56 #define RTL_MEMORY_ALIGNMENT_1 8
  57 #define RTL_MEMORY_ALIGNMENT_2 (sizeof(void*) * 2)
  58 #endif /* @@@ */
  59
  60 #define RTL_MEMORY_ALIGN(value, align) (((value) + ((align) - 1)) & ~((align) - 1))
  61
  62 #define RTL_MEMORY_ISP2(value) (((value) & ((value) - 1)) == 0)
  63 #define RTL_MEMORY_P2ALIGN(value, align) ((value) & -(sal_IntPtr)(align))
  64
  65 #define RTL_MEMORY_P2ROUNDUP(value, align) \
  66     (-(-(sal_IntPtr)(value) & -(sal_IntPtr)(align)))
  67 #define RTL_MEMORY_P2END(value, align) \
  68     (-(~(sal_IntPtr)(value) & -(sal_IntPtr)(align)))
  69
  70
  71 /** Function inlining macros
  72  *  (compiler dependent)
  73  */
  74 #ifndef RTL_MEMORY_INLINE
  75 #if defined(__GNUC__)
  76 #define RTL_MEMORY_INLINE __inline__
  77 #elif defined(_MSC_VER)
  78 #define RTL_MEMORY_INLINE __inline
  79 #else
  80 #define RTL_MEMORY_INLINE
  81 #endif /* __GNUC__ || _MSC_VER */
  82 #endif /* RTL_MEMORY_INLINE */
  83
  84
  85 /** printf() format specifier(s)
  86  *  (from C90 <sys/int_fmtio.h>)
  87  */
  88 #ifndef PRIu64
  89 #if defined(_MSC_VER)
  90 #define PRIu64 "I64u"
  91 #else  /* !_MSC_VER */
  92 #define PRIu64 "llu"
  93 #endif /* !_MSC_VER */
  94 #endif /* PRIu64 */
  95
  96
  97 /** highbit(): log2() + 1
  98  *  (complexity O(1))
  99  */
 100 static RTL_MEMORY_INLINE int
 101 highbit(sal_Size n)
 102 {
 103   register int k = 1;
 104
 105   if (n == 0)
 106     return (0);
 107 #if SAL_TYPES_SIZEOFLONG == 8
 108   if (n & 0xffffffff00000000ul)
 109     k |= 32, n >>= 32;
 110 #endif
 111   if (n & 0xffff0000)
 112     k |= 16, n >>= 16;
 113   if (n & 0xff00)
 114     k |= 8, n >>= 8;
 115   if (n & 0xf0)
 116     k |= 4, n >>= 4;
 117   if (n & 0x0c)
 118     k |= 2, n >>= 2;
 119   if (n & 0x02)
 120     k++;
 121
 122   return (k);
 123 }
 124
 125 #if defined(__SUNPRO_C) || defined(__SUNPRO_CC)
 126 #pragma inline(highbit)
 127 #endif /* __SUNPRO_C */
 128
 129
 130 /** lowbit(): find first bit set
 131  *  (complexity O(1))
 132  */
 133 static RTL_MEMORY_INLINE int
 134 lowbit(sal_Size n)
 135 {
 136   register int k = 1;
 137
 138   if (n == 0)
 139     return (0);
 140 #if SAL_TYPES_SIZEOFLONG == 8
 141   if (!(n & 0xffffffff))
 142     k |= 32, n >>= 32;
 143 #endif
 144   if (!(n & 0xffff))
 145     k |= 16, n >>= 16;
 146   if (!(n & 0xff))
 147     k |= 8, n >>= 8;
 148   if (!(n & 0xf))
 149     k |= 4, n >>= 4;
 150   if (!(n & 0x3))
 151     k |= 2, n >>= 2;
 152   if (!(n & 0x1))
 153     k++;
 154   return (k);
 155 }
 156
 157 #if defined(__SUNPRO_C) || defined(__SUNPRO_CC)
 158 #pragma inline(lowbit)
 159 #endif /* __SUNPRO_C */
 160
 161
 162 /** Queue manipulation macros
 163  *  (doubly linked circular list)
 164  *  (complexity O(1))
 165  */
 166 #define QUEUE_STARTED_NAMED(entry, name) \
 167   (((entry)->m_##name##next == (entry)) && ((entry)->m_##name##prev == (entry)))
 168
 169 #define QUEUE_START_NAMED(entry, name) \
 170 { \
 171   (entry)->m_##name##next = (entry); \
 172   (entry)->m_##name##prev = (entry); \
 173 }
 174
 175 #define QUEUE_REMOVE_NAMED(entry, name) \
 176 { \
 177   (entry)->m_##name##prev->m_##name##next = (entry)->m_##name##next; \
 178   (entry)->m_##name##next->m_##name##prev = (entry)->m_##name##prev; \
 179   QUEUE_START_NAMED(entry, name); \
 180 }
 181
 182 #define QUEUE_INSERT_HEAD_NAMED(head, entry, name) \
 183 { \
 184   (entry)->m_##name##prev = (head); \
 185   (entry)->m_##name##next = (head)->m_##name##next; \
 186   (head)->m_##name##next = (entry); \
 187   (entry)->m_##name##next->m_##name##prev = (entry); \
 188 }
 189
 190 #define QUEUE_INSERT_TAIL_NAMED(head, entry, name) \
 191 { \
 192   (entry)->m_##name##next = (head); \
 193   (entry)->m_##name##prev = (head)->m_##name##prev; \
 194   (head)->m_##name##prev = (entry); \
 195   (entry)->m_##name##prev->m_##name##next = (entry); \
 196 }
 197
 198
 199 /** rtl_memory_lock_type
 200  *  (platform dependent)
 201  */
 202 #if defined(SAL_UNX) || defined(SAL_OS2)
 203
 204 #include <unistd.h>
 205 #include <pthread.h>
 206
 207 typedef pthread_mutex_t rtl_memory_lock_type;
 208
 209 #define RTL_MEMORY_LOCK_INIT(lock)    pthread_mutex_init((lock), NULL)
 210 #define RTL_MEMORY_LOCK_DESTROY(lock) pthread_mutex_destroy((lock))
 211
 212 #define RTL_MEMORY_LOCK_ACQUIRE(lock) pthread_mutex_lock((lock))
 213 #define RTL_MEMORY_LOCK_RELEASE(lock) pthread_mutex_unlock((lock))
 214
 215 #elif defined(SAL_W32)
 216
 217 #define WIN32_LEAN_AND_MEAN
 218 #ifdef _MSC_VER
 219 #pragma warning(push,1) /* disable warnings within system headers */
 220 #endif
 221 #include <windows.h>
 222 #ifdef _MSC_VER
 223 #pragma warning(pop)
 224 #endif
 225
 226 typedef CRITICAL_SECTION rtl_memory_lock_type;
 227
 228 #define RTL_MEMORY_LOCK_INIT(lock)    InitializeCriticalSection((lock))
 229 #define RTL_MEMORY_LOCK_DESTROY(lock) DeleteCriticalSection((lock))
 230
 231 #define RTL_MEMORY_LOCK_ACQUIRE(lock) EnterCriticalSection((lock))
 232 #define RTL_MEMORY_LOCK_RELEASE(lock) LeaveCriticalSection((lock))
 233
 234 #else
 235 #error Unknown platform
 236 #endif /* SAL_UNX | SAL_W32 */
 237
 238
 239 /** Cache creation flags.
 240  *  @internal
 241  */
 242 #define RTL_CACHE_FLAG_NOMAGAZINE   (1 << 13) /* w/o magazine layer */
 243 #define RTL_CACHE_FLAG_QUANTUMCACHE (2 << 13) /* used as arena quantum cache */
 244
 245
 246 #ifdef __cplusplus
 247 }
 248 #endif
 249
 250 #endif /* INCLUDED_RTL_ALLOC_IMPL_H */