core/sourcehook/sh_pagealloc.h
author Scott Ehlert <ds@alliedmods.net>
Sat May 15 18:31:36 2010 -0500 (2010-05-15)
changeset 711 f76a4eb5ee58
parent 684 8015336442cb
child 733 2365240861a2
permissions -rw-r--r--
Fixed buildbot upload for OS X with horrible workaround (r=dvander).
pavolmarko@480
     1
#ifndef __SH_PAGEALLOC_H__
pavolmarko@480
     2
#define __SH_PAGEALLOC_H__
pavolmarko@480
     3
dvander@684
     4
# if SH_XP == SH_XP_WINAPI
pavolmarko@480
     5
#		include <windows.h>
dvander@684
     6
# elif SH_XP == SH_XP_POSIX
pavolmarko@480
     7
#		include <sys/mman.h>
pavolmarko@480
     8
#		include <unistd.h>
pavolmarko@480
     9
# else
pavolmarko@480
    10
#		error Unsupported OS/Compiler
pavolmarko@480
    11
# endif
pavolmarko@480
    12
pavolmarko@480
    13
pavolmarko@480
    14
namespace SourceHook
pavolmarko@480
    15
{
pavolmarko@480
    16
pavolmarko@480
    17
	/*
pavolmarko@480
    18
	Class which lets us allocate memory regions in special pages only meant for on the fly code generation.
pavolmarko@480
    19
pavolmarko@480
    20
	If we alloc with malloc and then set the page access type to read/exec only, other regions returned by
pavolmarko@480
    21
	malloc that are in the same page would lose their write access as well and the process could crash.
pavolmarko@480
    22
pavolmarko@480
    23
	Allocating one page per code generation session is usually a waste of memory and on some platforms also
pavolmarko@480
    24
	a waste of virtual address space (Windows� VirtualAlloc has a granularity of 64K).
pavolmarko@480
    25
pavolmarko@480
    26
pavolmarko@480
    27
	IMPORTANT: the memory that Alloc() returns is not a in a defined state!
pavolmarko@480
    28
	It could be in read+exec OR read+write mode.
pavolmarko@480
    29
	-> call SetRE() or SetRW() before using allocated memory!
pavolmarko@480
    30
	*/
pavolmarko@480
    31
	class CPageAlloc
pavolmarko@480
    32
	{
pavolmarko@480
    33
		struct AllocationUnit
pavolmarko@480
    34
		{
pavolmarko@480
    35
			size_t begin_offset;
pavolmarko@480
    36
			size_t size;
pavolmarko@480
    37
pavolmarko@480
    38
			AllocationUnit(size_t p_offs, size_t p_size) : begin_offset(p_offs), size(p_size)
pavolmarko@480
    39
			{
pavolmarko@480
    40
			}
pavolmarko@480
    41
pavolmarko@480
    42
			bool operator < (const AllocationUnit &other) const
pavolmarko@480
    43
			{
pavolmarko@480
    44
				return begin_offset < other.begin_offset;
pavolmarko@480
    45
			}
pavolmarko@480
    46
		};
pavolmarko@480
    47
pavolmarko@480
    48
		typedef List<AllocationUnit> AUList;
pavolmarko@480
    49
		struct AllocatedRegion
pavolmarko@480
    50
		{
pavolmarko@480
    51
			void *startPtr;
pavolmarko@480
    52
			size_t size;
pavolmarko@480
    53
			bool isolated;					// may contain only one AU
pavolmarko@480
    54
			size_t minAlignment;
pavolmarko@480
    55
			AUList allocUnits;
pavolmarko@480
    56
pavolmarko@480
    57
			void CheckGap(size_t gap_begin, size_t gap_end, size_t reqsize,
pavolmarko@480
    58
				size_t &smallestgap_pos, size_t &smallestgap_size, size_t &outAlignBytes)
pavolmarko@480
    59
			{
pavolmarko@480
    60
				size_t gapsize = gap_end - gap_begin;
pavolmarko@480
    61
				// How many bytes do we actually need here?
pavolmarko@480
    62
				//   = requested size + alignment bytes
pavolmarko@480
    63
				size_t neededSize = reqsize;
pavolmarko@480
    64
				size_t alignBytes = minAlignment - ((reinterpret_cast<intptr_t>(startPtr) + gap_begin) % minAlignment);
pavolmarko@480
    65
pavolmarko@480
    66
				alignBytes %= minAlignment;
pavolmarko@480
    67
				neededSize += alignBytes;
pavolmarko@480
    68
pavolmarko@480
    69
				if (gapsize >= neededSize)
pavolmarko@480
    70
				{
pavolmarko@480
    71
					if (gapsize < smallestgap_size)
pavolmarko@480
    72
					{
pavolmarko@480
    73
						smallestgap_size = gapsize;
pavolmarko@480
    74
						smallestgap_pos = gap_begin;
pavolmarko@480
    75
						outAlignBytes = alignBytes;
pavolmarko@480
    76
					}
pavolmarko@480
    77
				}
pavolmarko@480
    78
			}
pavolmarko@480
    79
pavolmarko@480
    80
			bool TryAlloc(size_t reqsize, void * &outAddr)
pavolmarko@480
    81
			{
pavolmarko@480
    82
				// Check for isolated
pavolmarko@480
    83
				if (isolated && !allocUnits.empty())
pavolmarko@480
    84
					return false;
pavolmarko@480
    85
pavolmarko@480
    86
				// Find the smallest gap where req fits
pavolmarko@480
    87
				size_t lastend = 0;
pavolmarko@480
    88
				size_t smallestgap_pos = size + 1;
pavolmarko@480
    89
				size_t smallestgap_size = size + 1;
pavolmarko@480
    90
				size_t alignmentbytes = 0;
pavolmarko@480
    91
pavolmarko@480
    92
				for (AUList::iterator iter = allocUnits.begin(); iter != allocUnits.end(); ++iter)
pavolmarko@480
    93
				{
pavolmarko@480
    94
					CheckGap(lastend, iter->begin_offset, reqsize, smallestgap_pos, smallestgap_size, alignmentbytes);
pavolmarko@480
    95
					lastend = iter->begin_offset + iter->size;
pavolmarko@480
    96
				}
pavolmarko@480
    97
pavolmarko@480
    98
				CheckGap(lastend, size, reqsize, smallestgap_pos, smallestgap_size, alignmentbytes);
pavolmarko@480
    99
pavolmarko@480
   100
				if (smallestgap_pos < size)
pavolmarko@480
   101
				{
pavolmarko@480
   102
					outAddr = reinterpret_cast<void*>(reinterpret_cast<char*>(startPtr) + smallestgap_pos + alignmentbytes);
pavolmarko@480
   103
					allocUnits.push_sorted( AllocationUnit(smallestgap_pos, reqsize + alignmentbytes) );
pavolmarko@480
   104
					return true;
pavolmarko@480
   105
				}
pavolmarko@480
   106
				else
pavolmarko@480
   107
				{
pavolmarko@480
   108
					return false;
pavolmarko@480
   109
				}
pavolmarko@480
   110
			}
pavolmarko@480
   111
pavolmarko@480
   112
			bool TryFree(void *addr)
pavolmarko@480
   113
			{
pavolmarko@480
   114
				if (addr < startPtr || addr >= reinterpret_cast<void*>(reinterpret_cast<char*>(startPtr) + size))
pavolmarko@480
   115
					return false;
pavolmarko@480
   116
pavolmarko@480
   117
				intptr_t start = reinterpret_cast<intptr_t>(startPtr);
pavolmarko@480
   118
pavolmarko@480
   119
				for (AUList::iterator iter = allocUnits.begin(); iter != allocUnits.end(); ++iter)
pavolmarko@480
   120
				{
pavolmarko@480
   121
					size_t AUBegin = start + iter->begin_offset;
pavolmarko@480
   122
					void *alignedAUBegin = reinterpret_cast<void*>(
pavolmarko@480
   123
						AUBegin + ((minAlignment - AUBegin % minAlignment) % minAlignment)
pavolmarko@480
   124
						);
pavolmarko@480
   125
					
pavolmarko@480
   126
					if (addr == alignedAUBegin)
pavolmarko@480
   127
					{
pavolmarko@480
   128
						allocUnits.erase(iter);
pavolmarko@480
   129
						return true;
pavolmarko@480
   130
					}
pavolmarko@480
   131
				}
pavolmarko@480
   132
pavolmarko@480
   133
				return false;
pavolmarko@480
   134
			}
pavolmarko@480
   135
pavolmarko@480
   136
			bool Contains(void *addr)
pavolmarko@480
   137
			{
pavolmarko@480
   138
				return addr >= startPtr && addr < reinterpret_cast<void*>(reinterpret_cast<char*>(startPtr) + size);
pavolmarko@480
   139
			}
pavolmarko@480
   140
pavolmarko@480
   141
			void FreeRegion()
pavolmarko@480
   142
			{
dvander@684
   143
#if SH_XP == SH_XP_POSIX
pavolmarko@480
   144
				munmap(startPtr, size);
dvander@684
   145
#elif SH_XP == SH_XP_WINAPI
pavolmarko@480
   146
				VirtualFree(startPtr, 0, MEM_RELEASE);
pavolmarko@480
   147
#endif
pavolmarko@480
   148
			}
pavolmarko@480
   149
		};
pavolmarko@480
   150
pavolmarko@480
   151
		typedef List<AllocatedRegion> ARList;
pavolmarko@480
   152
pavolmarko@480
   153
		size_t m_MinAlignment;
pavolmarko@480
   154
		size_t m_PageSize;
pavolmarko@480
   155
		ARList m_Regions;
pavolmarko@480
   156
pavolmarko@480
   157
		bool AddRegion(size_t minSize, bool isolated)
pavolmarko@480
   158
		{
pavolmarko@480
   159
			AllocatedRegion newRegion;
pavolmarko@480
   160
			newRegion.startPtr = 0;
pavolmarko@480
   161
			newRegion.isolated = isolated;
pavolmarko@480
   162
			newRegion.minAlignment = m_MinAlignment;
pavolmarko@480
   163
pavolmarko@480
   164
			// Compute real size -> align up to m_PageSize boundary
pavolmarko@480
   165
pavolmarko@480
   166
			newRegion.size = minSize - (minSize % m_PageSize);
pavolmarko@480
   167
			if (newRegion.size < minSize)
pavolmarko@480
   168
				newRegion.size += m_PageSize;
pavolmarko@480
   169
dvander@684
   170
#if SH_XP == SH_XP_POSIX
dvander@684
   171
# if !defined MAP_ANONYMOUS
dvander@684
   172
#  define MAP_ANONYMOUS MAP_ANON
dvander@684
   173
# endif
pavolmarko@480
   174
			newRegion.startPtr = mmap(0, newRegion.size, PROT_READ | PROT_WRITE, MAP_PRIVATE | MAP_ANONYMOUS, -1, 0);
dvander@684
   175
#elif SH_XP == SH_XP_WINAPI
pavolmarko@480
   176
			newRegion.startPtr = VirtualAlloc(NULL, newRegion.size, MEM_COMMIT, PAGE_READWRITE);
pavolmarko@480
   177
#endif
pavolmarko@480
   178
pavolmarko@480
   179
			if (newRegion.startPtr)
pavolmarko@480
   180
			{
pavolmarko@480
   181
				m_Regions.push_back(newRegion);
pavolmarko@480
   182
				return true;
pavolmarko@480
   183
			}
pavolmarko@480
   184
			else
pavolmarko@480
   185
			{
pavolmarko@480
   186
				return false;
pavolmarko@480
   187
			}
pavolmarko@480
   188
pavolmarko@480
   189
		}
pavolmarko@480
   190
pavolmarko@480
   191
		void *AllocPriv(size_t size, bool isolated)
pavolmarko@480
   192
		{
pavolmarko@480
   193
			void *addr;
pavolmarko@480
   194
pavolmarko@480
   195
			if (!isolated)
pavolmarko@480
   196
			{
pavolmarko@480
   197
				for (ARList::iterator iter = m_Regions.begin(); iter != m_Regions.end(); ++iter)
pavolmarko@480
   198
				{
pavolmarko@480
   199
					if (iter->TryAlloc(size, addr))
pavolmarko@480
   200
						return addr;
pavolmarko@480
   201
				}
pavolmarko@480
   202
			}
pavolmarko@480
   203
pavolmarko@480
   204
			if (!AddRegion(size, isolated))
pavolmarko@480
   205
				return NULL;
pavolmarko@480
   206
pavolmarko@480
   207
			bool tmp = m_Regions.back().TryAlloc(size, addr);
pavolmarko@480
   208
			SH_ASSERT(tmp, ("TryAlloc fails after AddRegion"));
pavolmarko@480
   209
			return tmp ? addr : NULL;
pavolmarko@480
   210
		}
pavolmarko@480
   211
pavolmarko@480
   212
	public:
pavolmarko@480
   213
		CPageAlloc(size_t minAlignment = 1 /* power of 2 */ ) : m_MinAlignment(minAlignment)
pavolmarko@480
   214
		{
dvander@684
   215
#if SH_XP == SH_XP_POSIX
pavolmarko@480
   216
			m_PageSize = sysconf(_SC_PAGESIZE);
dvander@684
   217
#elif SH_XP == SH_XP_WINAPI
pavolmarko@480
   218
			SYSTEM_INFO sysInfo;
pavolmarko@480
   219
			GetSystemInfo(&sysInfo);
pavolmarko@480
   220
			m_PageSize = sysInfo.dwPageSize;
pavolmarko@480
   221
#endif
pavolmarko@480
   222
		}
pavolmarko@480
   223
pavolmarko@480
   224
		~CPageAlloc()
pavolmarko@480
   225
		{
pavolmarko@480
   226
			// Free all regions
pavolmarko@480
   227
			for (ARList::iterator iter = m_Regions.begin(); iter != m_Regions.end(); ++iter)
pavolmarko@480
   228
			{
pavolmarko@480
   229
				iter->FreeRegion();
pavolmarko@480
   230
			}
pavolmarko@480
   231
		}
pavolmarko@480
   232
pavolmarko@480
   233
		void *Alloc(size_t size)
pavolmarko@480
   234
		{
pavolmarko@480
   235
			return AllocPriv(size, false);
pavolmarko@480
   236
		}
pavolmarko@480
   237
pavolmarko@480
   238
		void *AllocIsolated(size_t size)
pavolmarko@480
   239
		{
pavolmarko@480
   240
			return AllocPriv(size, true);
pavolmarko@480
   241
		}
pavolmarko@480
   242
pavolmarko@480
   243
		void Free(void *ptr)
pavolmarko@480
   244
		{
pavolmarko@480
   245
			for (ARList::iterator iter = m_Regions.begin(); iter != m_Regions.end(); ++iter)
pavolmarko@480
   246
			{
pavolmarko@480
   247
				if (iter->TryFree(ptr))
pavolmarko@480
   248
				{
pavolmarko@480
   249
					if (iter->allocUnits.empty())
pavolmarko@480
   250
					{
pavolmarko@480
   251
						iter->FreeRegion();
pavolmarko@480
   252
						m_Regions.erase(iter);
pavolmarko@480
   253
					}
pavolmarko@480
   254
					break;
pavolmarko@480
   255
				}
pavolmarko@480
   256
			}
pavolmarko@480
   257
		}
pavolmarko@480
   258
pavolmarko@480
   259
		void SetRE(void *ptr)
pavolmarko@480
   260
		{
pavolmarko@480
   261
			for (ARList::iterator iter = m_Regions.begin(); iter != m_Regions.end(); ++iter)
pavolmarko@480
   262
			{
pavolmarko@480
   263
				if (iter->Contains(ptr))
pavolmarko@480
   264
				{
pavolmarko@480
   265
					SetMemAccess(iter->startPtr, iter->size, SH_MEM_READ | SH_MEM_EXEC);
pavolmarko@480
   266
					break;
pavolmarko@480
   267
				}
pavolmarko@480
   268
			}
pavolmarko@480
   269
		}
pavolmarko@480
   270
pavolmarko@480
   271
		void SetRW(void *ptr)
pavolmarko@480
   272
		{
pavolmarko@480
   273
			for (ARList::iterator iter = m_Regions.begin(); iter != m_Regions.end(); ++iter)
pavolmarko@480
   274
			{
pavolmarko@480
   275
				if (iter->Contains(ptr))
pavolmarko@480
   276
				{
pavolmarko@480
   277
					SetMemAccess(iter->startPtr, iter->size, SH_MEM_READ | SH_MEM_WRITE);
pavolmarko@480
   278
					break;
pavolmarko@480
   279
				}
pavolmarko@480
   280
			}
pavolmarko@480
   281
		}
pavolmarko@480
   282
pavolmarko@480
   283
		size_t GetPageSize()
pavolmarko@480
   284
		{
pavolmarko@480
   285
			return m_PageSize;
pavolmarko@480
   286
		}
pavolmarko@480
   287
	};
pavolmarko@480
   288
}
pavolmarko@480
   289
pavolmarko@480
   290
#endif
pavolmarko@480
   291