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