VirtualBox

source: vbox/trunk/src/VBox/Runtime/r3/alloc-ef.h@ 67954

Last change on this file since 67954 was 62592, checked in by vboxsync, 8 years ago

IPRT: More unused parameters and undefined preprocessor macor warning (C4668) fixes/workarounds. The latter triggers in stdint.h from the compiler and in windows SDK/DDK headers.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 7.5 KB
Line 
1/* $Id: alloc-ef.h 62592 2016-07-27 13:24:48Z vboxsync $ */
2/** @file
3 * IPRT - Memory Allocation, electric fence.
4 */
5
6/*
7 * Copyright (C) 2006-2016 Oracle Corporation
8 *
9 * This file is part of VirtualBox Open Source Edition (OSE), as
10 * available from http://www.virtualbox.org. This file is free software;
11 * you can redistribute it and/or modify it under the terms of the GNU
12 * General Public License (GPL) as published by the Free Software
13 * Foundation, in version 2 as it comes in the "COPYING" file of the
14 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16 *
17 * The contents of this file may alternatively be used under the terms
18 * of the Common Development and Distribution License Version 1.0
19 * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
20 * VirtualBox OSE distribution, in which case the provisions of the
21 * CDDL are applicable instead of those of the GPL.
22 *
23 * You may elect to license modified versions of this file under the
24 * terms and conditions of either the GPL or the CDDL or both.
25 */
26
27#ifndef ___alloc_ef_h
28#define ___alloc_ef_h
29
30/*******************************************************************************
31* Defined Constants And Macros *
32*******************************************************************************/
33#if defined(DOXYGEN_RUNNING)
34# define RTALLOC_USE_EFENCE
35# define RTALLOC_EFENCE_IN_FRONT
36# define RTALLOC_EFENCE_FREE_FILL 'f'
37#endif
38
39/** @def RTALLOC_USE_EFENCE
40 * If defined the electric fence put up for ALL allocations by RTMemAlloc(),
41 * RTMemAllocZ(), RTMemRealloc(), RTMemTmpAlloc() and RTMemTmpAllocZ().
42 */
43#if 0
44# define RTALLOC_USE_EFENCE
45#endif
46
47/** @def RTALLOC_EFENCE_SIZE
48 * The size of the fence. This must be page aligned.
49 */
50#define RTALLOC_EFENCE_SIZE PAGE_SIZE
51
52/** @def RTALLOC_EFENCE_ALIGNMENT
53 * The allocation alignment, power of two of course.
54 *
55 * Use this for working around misaligned sizes, usually stemming from
56 * allocating a string or something after the main structure. When you
57 * encounter this, please fix the allocation to RTMemAllocVar or RTMemAllocZVar.
58 */
59#if 0
60# define RTALLOC_EFENCE_ALIGNMENT (ARCH_BITS / 8)
61#else
62# define RTALLOC_EFENCE_ALIGNMENT 1
63#endif
64
65/** @def RTALLOC_EFENCE_IN_FRONT
66 * Define this to put the fence up in front of the block.
67 * The default (when this isn't defined) is to up it up after the block.
68 */
69//# define RTALLOC_EFENCE_IN_FRONT
70
71/** @def RTALLOC_EFENCE_TRACE
72 * Define this to support actual free and reallocation of blocks.
73 */
74#define RTALLOC_EFENCE_TRACE
75
76/** @def RTALLOC_EFENCE_FREE_DELAYED
77 * This define will enable free() delay and protection of the freed data
78 * while it's being delayed. The value of RTALLOC_EFENCE_FREE_DELAYED defines
79 * the threshold of the delayed blocks.
80 * Delayed blocks does not consume any physical memory, only virtual address space.
81 * Requires RTALLOC_EFENCE_TRACE.
82 */
83#define RTALLOC_EFENCE_FREE_DELAYED (20 * _1M)
84
85/** @def RTALLOC_EFENCE_FREE_FILL
86 * This define will enable memset(,RTALLOC_EFENCE_FREE_FILL,)'ing the user memory
87 * in the block before freeing/decommitting it. This is useful in GDB since GDB
88 * appears to be able to read the content of the page even after it's been
89 * decommitted.
90 * Requires RTALLOC_EFENCE_TRACE.
91 */
92#if defined(RT_OS_LINUX) || defined(RT_OS_SOLARIS) || defined(DOXYGEN_RUNNING)
93# define RTALLOC_EFENCE_FREE_FILL 'f'
94#endif
95
96/** @def RTALLOC_EFENCE_FILLER
97 * This define will enable memset(,RTALLOC_EFENCE_FILLER,)'ing the allocated
98 * memory when the API doesn't require it to be zero'd.
99 */
100#define RTALLOC_EFENCE_FILLER 0xef
101
102/** @def RTALLOC_EFENCE_NOMAN_FILLER
103 * This define will enable memset(,RTALLOC_EFENCE_NOMAN_FILLER,)'ing the
104 * unprotected but not allocated area of memory, the so called no man's land.
105 */
106#define RTALLOC_EFENCE_NOMAN_FILLER 0xaa
107
108/** @def RTALLOC_EFENCE_FENCE_FILLER
109 * This define will enable memset(,RTALLOC_EFENCE_FENCE_FILLER,)'ing the
110 * fence itself, as debuggers can usually read them.
111 */
112#define RTALLOC_EFENCE_FENCE_FILLER 0xcc
113
114#if defined(DOXYGEN_RUNNING)
115/** @def RTALLOC_EFENCE_CPP
116 * This define will enable the new and delete wrappers.
117 */
118# define RTALLOC_EFENCE_CPP
119#endif
120
121#if defined(RUNNING_DOXYGEN)
122/** @def RTALLOC_REPLACE_MALLOC
123 * Replaces the malloc, calloc, realloc, free and friends in libc (experimental).
124 * Set in LocalConfig.kmk. Requires RTALLOC_EFENCE_TRACE to work. */
125# define RTALLOC_REPLACE_MALLOC
126#endif
127#if defined(RTALLOC_REPLACE_MALLOC) && !defined(RTALLOC_EFENCE_TRACE)
128# error "RTALLOC_REPLACE_MALLOC requires RTALLOC_EFENCE_TRACE."
129#endif
130
131
132/*******************************************************************************
133* Header Files *
134*******************************************************************************/
135#ifdef RT_OS_WINDOWS
136# include <iprt/win/windows.h>
137#else
138# include <sys/mman.h>
139#endif
140#include <iprt/avl.h>
141#include <iprt/thread.h>
142
143
144/*******************************************************************************
145* Structures and Typedefs *
146*******************************************************************************/
147/**
148 * Allocation types.
149 */
150typedef enum RTMEMTYPE
151{
152 RTMEMTYPE_RTMEMALLOC,
153 RTMEMTYPE_RTMEMALLOCZ,
154 RTMEMTYPE_RTMEMREALLOC,
155 RTMEMTYPE_RTMEMFREE,
156
157 RTMEMTYPE_NEW,
158 RTMEMTYPE_NEW_ARRAY,
159 RTMEMTYPE_DELETE,
160 RTMEMTYPE_DELETE_ARRAY
161} RTMEMTYPE;
162
163#ifdef RTALLOC_EFENCE_TRACE
164/**
165 * Node tracking a memory allocation.
166 */
167typedef struct RTMEMBLOCK
168{
169 /** Avl node code, key is the user block pointer. */
170 AVLPVNODECORE Core;
171 /** Allocation type. */
172 RTMEMTYPE enmType;
173 /** The unaligned size of the block. */
174 size_t cbUnaligned;
175 /** The aligned size of the block. */
176 size_t cbAligned;
177 /** The allocation tag (read-only string). */
178 const char *pszTag;
179 /** The return address of the allocator function. */
180 void *pvCaller;
181 /** Line number of the alloc call. */
182 unsigned iLine;
183 /** File from within the allocation was made. */
184 const char *pszFile;
185 /** Function from within the allocation was made. */
186 const char *pszFunction;
187} RTMEMBLOCK, *PRTMEMBLOCK;
188
189#endif
190
191
192/*******************************************************************************
193* Internal Functions *
194******************************************************************************/
195RT_C_DECLS_BEGIN
196RTDECL(void *) rtR3MemAlloc(const char *pszOp, RTMEMTYPE enmType, size_t cbUnaligned, size_t cbAligned,
197 const char *pszTag, void *pvCaller, RT_SRC_POS_DECL);
198RTDECL(void *) rtR3MemRealloc(const char *pszOp, RTMEMTYPE enmType, void *pvOld, size_t cbNew,
199 const char *pszTag, void *pvCaller, RT_SRC_POS_DECL);
200RTDECL(void) rtR3MemFree(const char *pszOp, RTMEMTYPE enmType, void *pv, void *pvCaller, RT_SRC_POS_DECL);
201RT_C_DECLS_END
202
203
204/*******************************************************************************
205* Global Variables *
206*******************************************************************************/
207#ifdef RTALLOC_REPLACE_MALLOC
208RT_C_DECLS_BEGIN
209extern void * (*g_pfnOrgMalloc)(size_t);
210extern void * (*g_pfnOrgCalloc)(size_t, size_t);
211extern void * (*g_pfnOrgRealloc)(void *, size_t);
212extern void (*g_pfnOrgFree)(void *);
213RT_C_DECLS_END
214#endif
215
216#endif
217
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette