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