core/sourcehook/sh_memory.h
author Asher Baker <asherkin@gmail.com>
Mon Sep 03 13:43:02 2012 +0100 (2012-09-03)
changeset 803 90e35e1d67d3
parent 767 fd3ff8d792ce
permissions -rw-r--r--
Fixed include order issue introduced in 276192fd70a1 (bug 5079, bug 5469).
dvander@10
     1
/* ======== SourceHook ========
pavolmarko@733
     2
* Copyright (C) 2004-2010 Metamod:Source Development Team
pavolmarko@1
     3
* No warranties of any kind
pavolmarko@1
     4
*
dvander@10
     5
* License: zlib/libpng
pavolmarko@1
     6
*
dvander@10
     7
* Author(s): Pavol "PM OnoTo" Marko, Scott "Damaged Soul" Ehlert
dvander@10
     8
* Contributors: lancevorgin, XAD, theqizmo
pavolmarko@1
     9
* ============================
pavolmarko@1
    10
*/
pavolmarko@1
    11
pavolmarko@1
    12
#ifndef __SHINT_MEMORY_H__
pavolmarko@1
    13
#define __SHINT_MEMORY_H__
pavolmarko@1
    14
pavolmarko@1
    15
// Feb 17 / 2005:
pavolmarko@1
    16
//  Unprotect now sets to readwrite
pavolmarko@1
    17
//  The vtable doesn't need to be executable anyway
pavolmarko@1
    18
dvander@684
    19
# if SH_XP == SH_XP_WINAPI
pavolmarko@1
    20
#		include <windows.h>
pavolmarko@1
    21
#		define SH_MEM_READ 1
pavolmarko@1
    22
#		define SH_MEM_WRITE 2
pavolmarko@1
    23
#		define SH_MEM_EXEC 4
dvander@684
    24
# elif SH_XP == SH_XP_POSIX
pavolmarko@1
    25
#		include <sys/mman.h>
pavolmarko@117
    26
#		include <stdio.h>
pavolmarko@117
    27
#		include <signal.h>
pavolmarko@117
    28
#		include <setjmp.h>
dvander@633
    29
#		include <stdint.h>
pavolmarko@1
    30
// http://www.die.net/doc/linux/man/man2/mprotect.2.html
pavolmarko@1
    31
#		include <limits.h>
pavolmarko@1
    32
#		ifndef PAGESIZE
pavolmarko@1
    33
#			define PAGESIZE 4096
pavolmarko@1
    34
#		endif
pavolmarko@1
    35
#		define SH_MEM_READ PROT_READ
pavolmarko@1
    36
#		define SH_MEM_WRITE PROT_WRITE
pavolmarko@1
    37
#		define SH_MEM_EXEC PROT_EXEC
pavolmarko@1
    38
pavolmarko@1
    39
// We need to align addr down to pagesize on linux
pavolmarko@1
    40
// We assume PAGESIZE is a power of two
dvander@633
    41
#		define SH_LALIGN(x) (void*)((uintptr_t)(x) & ~(PAGESIZE-1))
dvander@633
    42
#		define SH_LALDIF(x) ((uintptr_t)(x) % PAGESIZE)
pavolmarko@1
    43
# else
pavolmarko@1
    44
#		error Unsupported OS/Compiler
pavolmarko@1
    45
# endif
dvander@767
    46
#if SH_SYS == SH_SYS_APPLE
dvander@767
    47
# include <mach/mach.h>
dvander@767
    48
# include <mach/vm_region.h>
dvander@767
    49
# include <mach/mach_traps.h>
dvander@767
    50
#endif
pavolmarko@1
    51
pavolmarko@480
    52
#include "sh_list.h"
pavolmarko@1
    53
pavolmarko@1
    54
namespace SourceHook
pavolmarko@1
    55
{
dvander@767
    56
	static inline bool GetPageBits(void *addr, int *bits)
dvander@767
    57
	{
dvander@767
    58
#if SH_SYS == SH_SYS_LINUX
dvander@767
    59
		// On linux, first check /proc/self/maps
dvander@767
    60
		unsigned long laddr = reinterpret_cast<unsigned long>(addr);
dvander@767
    61
dvander@767
    62
		FILE *pF = fopen("/proc/self/maps", "r");
dvander@767
    63
		if (pF) {
dvander@767
    64
			// Linux /proc/self/maps -> parse
dvander@767
    65
			// Format:
dvander@767
    66
			// lower    upper    prot     stuff                 path
dvander@767
    67
			// 08048000-0804c000 r-xp 00000000 03:03 1010107    /bin/cat
dvander@767
    68
			unsigned long rlower, rupper;
dvander@767
    69
			char r, w, x;
dvander@767
    70
			while (fscanf(pF, "%lx-%lx %c%c%c", &rlower, &rupper, &r, &w, &x) != EOF) {
dvander@767
    71
				// Check whether we're IN THERE!
dvander@767
    72
				if (laddr >= rlower && laddr < rupper) {
dvander@767
    73
					fclose(pF);
dvander@767
    74
					*bits = 0;
dvander@767
    75
					if (r == 'r')
dvander@767
    76
						*bits |= SH_MEM_READ;
dvander@767
    77
					if (w == 'w')
dvander@767
    78
						*bits |= SH_MEM_WRITE;
dvander@767
    79
					if (x == 'x')
dvander@767
    80
						*bits |= SH_MEM_EXEC;
dvander@767
    81
					return true;
dvander@767
    82
				}
dvander@767
    83
				// Read to end of line
dvander@767
    84
				int c;
dvander@767
    85
				while ((c = fgetc(pF)) != '\n') {
dvander@767
    86
					if (c == EOF)
dvander@767
    87
						break;
dvander@767
    88
				}
dvander@767
    89
				if (c == EOF)
dvander@767
    90
					break;
dvander@767
    91
			}
dvander@767
    92
			fclose(pF);
dvander@767
    93
			return false;
dvander@767
    94
		}
dvander@767
    95
		pF = fopen("/proc/curproc/map", "r");
dvander@767
    96
		if (pF) {
dvander@767
    97
			// FreeBSD /proc/curproc/map -> parse
dvander@767
    98
			// 0x804800 0x805500 13 15 0xc6e18960 r-x 21 0x0 COW NC vnode
dvander@767
    99
			unsigned long rlower, rupper, ignoreLong;
dvander@767
   100
			int ignoreInt;
dvander@767
   101
			char r, w, x;
dvander@767
   102
			while (fscanf(pF, "0x%lx 0x%lx %d %d 0x%lx %c%c%c", &rlower, &rupper, &ignoreInt,
dvander@767
   103
						  &ignoreInt, &ignoreLong, &r, &w, &x) != EOF) {
dvander@767
   104
				// Check whether we're IN THERE!
dvander@767
   105
				if (laddr >= rlower && laddr < rupper) {
dvander@767
   106
					fclose(pF);
dvander@767
   107
					*bits = 0;
dvander@767
   108
					if (r == 'r')
dvander@767
   109
						*bits |= SH_MEM_READ;
dvander@767
   110
					if (r == 'w')
dvander@767
   111
						*bits |= SH_MEM_WRITE;
dvander@767
   112
					if (r == 'x')
dvander@767
   113
						*bits |= SH_MEM_EXEC;
dvander@767
   114
					return true;
dvander@767
   115
				}
dvander@767
   116
				// Read to end of line
dvander@767
   117
				int c;
dvander@767
   118
				while ((c = fgetc(pF)) != '\n') {
dvander@767
   119
					if (c == EOF)
dvander@767
   120
						break;
dvander@767
   121
				}
dvander@767
   122
				if (c == EOF)
dvander@767
   123
					break;
dvander@767
   124
			}
dvander@767
   125
			fclose(pF);
dvander@767
   126
			return false;
dvander@767
   127
		}
dvander@767
   128
		return false;
dvander@767
   129
#elif SH_SYS == SH_SYS_APPLE
dvander@767
   130
		vm_size_t ignoreSize;
dvander@767
   131
		vm_address_t vmaddr = (vm_address_t)addr;
dvander@767
   132
		vm_region_basic_info_data_t info;
dvander@767
   133
		vm_region_flavor_t flavor = VM_REGION_BASIC_INFO;
dvander@767
   134
		memory_object_name_t obj;
dvander@767
   135
dvander@767
   136
		mach_msg_type_number_t count = VM_REGION_BASIC_INFO_COUNT;
dvander@767
   137
		kern_return_t kr = vm_region(mach_task_self(), &vmaddr, &ignoreSize, flavor,
dvander@767
   138
		                             (vm_region_info_t)&info, &count, &obj);
dvander@767
   139
		if (kr != KERN_SUCCESS)
dvander@767
   140
			return false;
dvander@767
   141
		*bits = 0;
dvander@767
   142
		if (info.protection & VM_PROT_READ)
dvander@767
   143
			*bits |= SH_MEM_READ;
dvander@767
   144
		if (info.protection & VM_PROT_WRITE)
dvander@767
   145
			*bits |= SH_MEM_WRITE;
dvander@767
   146
		if (info.protection & VM_PROT_EXECUTE)
dvander@767
   147
			*bits |= SH_MEM_EXEC;
dvander@767
   148
		return true;
dvander@767
   149
#elif SH_XP == SH_XP_WINAPI
dvander@767
   150
		SYSTEM_INFO info;
dvander@767
   151
		GetSystemInfo(&info);
dvander@767
   152
dvander@767
   153
		MEMORY_BASIC_INFORMATION mem;
dvander@767
   154
		size_t base = size_t(addr) & ~size_t(info.dwPageSize - 1);
dvander@767
   155
		if (!VirtualQuery((void *)base, &mem, sizeof(mem)))
dvander@767
   156
			return false;
dvander@767
   157
		switch (mem.Protect) {
dvander@767
   158
			case PAGE_EXECUTE:
dvander@767
   159
				*bits = SH_MEM_EXEC;
dvander@767
   160
				break;
dvander@767
   161
			case PAGE_EXECUTE_READ:
dvander@767
   162
				*bits = SH_MEM_EXEC | SH_MEM_READ;
dvander@767
   163
				break;
dvander@767
   164
			case PAGE_EXECUTE_READWRITE:
dvander@767
   165
			case PAGE_EXECUTE_WRITECOPY:
dvander@767
   166
				*bits = SH_MEM_EXEC | SH_MEM_READ | SH_MEM_WRITE;
dvander@767
   167
				break;
dvander@767
   168
			case PAGE_NOACCESS:
dvander@767
   169
				*bits = 0;
dvander@767
   170
				break;
dvander@767
   171
			case PAGE_READONLY:
dvander@767
   172
				*bits = SH_MEM_READ;
dvander@767
   173
				break;
dvander@767
   174
			case PAGE_READWRITE:
dvander@767
   175
			case PAGE_WRITECOPY:
dvander@767
   176
				*bits = SH_MEM_READ | SH_MEM_WRITE;
dvander@767
   177
				break;
dvander@767
   178
			default:
dvander@767
   179
				return false;
dvander@767
   180
		}
dvander@767
   181
		return true;
dvander@767
   182
#endif
dvander@767
   183
	}
dvander@767
   184
pavolmarko@1
   185
	inline bool SetMemAccess(void *addr, size_t len, int access)
pavolmarko@1
   186
	{
dvander@684
   187
# if SH_XP == SH_XP_POSIX
pavolmarko@50
   188
		return mprotect(SH_LALIGN(addr), len + SH_LALDIF(addr), access)==0 ? true : false;
dvander@684
   189
# elif SH_XP == SH_XP_WINAPI
pavolmarko@1
   190
		DWORD tmp;
pavolmarko@1
   191
		DWORD prot;
pavolmarko@1
   192
		switch (access)
pavolmarko@1
   193
		{
pavolmarko@1
   194
		case SH_MEM_READ:
pavolmarko@1
   195
			prot = PAGE_READONLY; break;
pavolmarko@1
   196
		case SH_MEM_READ | SH_MEM_WRITE:
pavolmarko@1
   197
			prot = PAGE_READWRITE; break;
pavolmarko@1
   198
		case SH_MEM_READ | SH_MEM_EXEC:
pavolmarko@1
   199
			prot = PAGE_EXECUTE_READ; break;
pavolmarko@1
   200
		default:
pavolmarko@1
   201
		case SH_MEM_READ | SH_MEM_WRITE | SH_MEM_EXEC:
pavolmarko@1
   202
			prot = PAGE_EXECUTE_READWRITE; break;
pavolmarko@1
   203
		}
pavolmarko@1
   204
		return VirtualProtect(addr, len, prot, &tmp) ? true : false;
pavolmarko@1
   205
# endif
pavolmarko@1
   206
	}
pavolmarko@1
   207
dvander@767
   208
	inline bool MakePageWritable(void *addr)
dvander@767
   209
	{
dvander@767
   210
		int bits;
dvander@767
   211
		if (GetPageBits(addr, &bits)) {
dvander@767
   212
			if (bits & SH_MEM_WRITE)
dvander@767
   213
				return true;
dvander@767
   214
			bits |= SH_MEM_WRITE;
dvander@767
   215
		} else {
dvander@767
   216
			bits = SH_MEM_READ | SH_MEM_WRITE | SH_MEM_EXEC;
dvander@767
   217
		}
dvander@767
   218
		return SetMemAccess(addr, sizeof(void *), bits);
dvander@767
   219
	}
dvander@767
   220
dvander@684
   221
#if SH_XP == SH_XP_POSIX
pavolmarko@117
   222
	namespace
pavolmarko@117
   223
	{
pavolmarko@117
   224
		bool g_BadReadCalled;
pavolmarko@117
   225
		jmp_buf g_BadReadJmpBuf;
pavolmarko@117
   226
dvander@684
   227
# if SH_SYS == SH_SYS_LINUX
pavolmarko@117
   228
		static void BadReadHandler(int sig)
pavolmarko@117
   229
		{
pavolmarko@117
   230
			if (g_BadReadCalled)
pavolmarko@117
   231
				longjmp(g_BadReadJmpBuf, 1);
pavolmarko@117
   232
		}
dvander@684
   233
# elif SH_SYS == SH_SYS_APPLE
dvander@684
   234
		static void BadReadHandler(int signal, siginfo_t* my_siginfo, void* my_context)	
dvander@684
   235
		{
dvander@684
   236
			if (g_BadReadCalled)
dvander@684
   237
				longjmp(g_BadReadJmpBuf, 1);
dvander@684
   238
		}
dvander@684
   239
# endif
pavolmarko@117
   240
	}
pavolmarko@117
   241
#endif
pavolmarko@117
   242
pavolmarko@117
   243
	/**
pavolmarko@117
   244
	*	@brief Checks whether the specified memory region is (still) accessible
pavolmarko@117
   245
	*
pavolmarko@117
   246
	*	@param addr The lower boundary
pavolmarko@117
   247
	*	@param len Length of the region to be checked
pavolmarko@117
   248
	*/
pavolmarko@117
   249
	namespace
pavolmarko@117
   250
	{
pavolmarko@117
   251
		bool ModuleInMemory(char *addr, size_t len)
pavolmarko@117
   252
		{
dvander@684
   253
#if SH_SYS == SH_SYS_LINUX
pavolmarko@117
   254
			// On linux, first check /proc/self/maps
pavolmarko@117
   255
			long lower = reinterpret_cast<long>(addr);
pavolmarko@117
   256
			long upper = lower + len;
pavolmarko@117
   257
pavolmarko@117
   258
			FILE *pF = fopen("/proc/self/maps", "r");
pavolmarko@117
   259
			if (pF)
pavolmarko@117
   260
			{
pavolmarko@117
   261
				// Linux /proc/self/maps -> parse
pavolmarko@117
   262
				// Format:
pavolmarko@117
   263
				// lower    upper    prot     stuff                 path
pavolmarko@117
   264
				// 08048000-0804c000 r-xp 00000000 03:03 1010107    /bin/cat
pavolmarko@117
   265
				long rlower, rupper;
pavolmarko@117
   266
				while (fscanf(pF, "%lx-%lx", &rlower, &rupper) != EOF)
pavolmarko@117
   267
				{
pavolmarko@117
   268
					// Check whether we're IN THERE!
pavolmarko@117
   269
					if (lower >= rlower && upper <= rupper)
pavolmarko@117
   270
					{
pavolmarko@117
   271
						fclose(pF);
pavolmarko@117
   272
						return true;
pavolmarko@117
   273
					}
pavolmarko@117
   274
					// Read to end of line
pavolmarko@117
   275
					int c;
pavolmarko@117
   276
					while ((c = fgetc(pF)) != '\n')
pavolmarko@117
   277
					{
pavolmarko@117
   278
						if (c == EOF)
pavolmarko@117
   279
							break;
pavolmarko@117
   280
					}
pavolmarko@117
   281
					if (c == EOF)
pavolmarko@117
   282
						break;
pavolmarko@117
   283
				}
pavolmarko@117
   284
				fclose(pF);
pavolmarko@117
   285
				return false;
pavolmarko@117
   286
			}
pavolmarko@117
   287
			pF = fopen("/proc/curproc/map", "r");
pavolmarko@117
   288
			if (pF)
pavolmarko@117
   289
			{
pavolmarko@117
   290
				// FreeBSD /proc/curproc/map -> parse
pavolmarko@117
   291
				// 0x804800 0x805500 13 15 0xc6e18960 r-x 21 0x0 COW NC vnode
pavolmarko@117
   292
				long rlower, rupper;
pavolmarko@117
   293
				while (fscanf(pF, "0x%lx 0x%lx", &rlower, &rupper) != EOF)
pavolmarko@117
   294
				{
pavolmarko@117
   295
					// Check whether we're IN THERE!
pavolmarko@117
   296
					if (lower >= rlower && upper <= rupper)
pavolmarko@117
   297
					{
pavolmarko@117
   298
						fclose(pF);
pavolmarko@117
   299
						return true;
pavolmarko@117
   300
					}
pavolmarko@117
   301
					// Read to end of line
pavolmarko@117
   302
					int c;
pavolmarko@117
   303
					while ((c = fgetc(pF)) != '\n')
pavolmarko@117
   304
					{
pavolmarko@117
   305
						if (c == EOF)
pavolmarko@117
   306
							break;
pavolmarko@117
   307
					}
pavolmarko@117
   308
					if (c == EOF)
pavolmarko@117
   309
						break;
pavolmarko@117
   310
				}
pavolmarko@117
   311
				fclose(pF);
pavolmarko@117
   312
				return false;
pavolmarko@117
   313
			}
pavolmarko@117
   314
pavolmarko@117
   315
			// Both of the above failed, try to actually read and trap sigsegv (implemented by Damaged Soul)
pavolmarko@117
   316
			void(*prevHandler)(int sig);
pavolmarko@117
   317
			g_BadReadCalled = true;
pavolmarko@117
   318
pavolmarko@117
   319
			if (setjmp(g_BadReadJmpBuf))
pavolmarko@117
   320
				return true;
pavolmarko@117
   321
pavolmarko@117
   322
			prevHandler = signal(SIGSEGV, BadReadHandler);
pavolmarko@117
   323
pavolmarko@117
   324
			volatile const char *p = reinterpret_cast<const char*>(addr);
pavolmarko@117
   325
			char dummy;
pavolmarko@117
   326
pavolmarko@117
   327
			for (size_t i = 0; i < len; i++)
pavolmarko@117
   328
				dummy = p[i];
pavolmarko@117
   329
pavolmarko@117
   330
			g_BadReadCalled = false;
pavolmarko@117
   331
pavolmarko@117
   332
			signal(SIGSEGV, prevHandler);
pavolmarko@117
   333
pavolmarko@117
   334
			return false;
dvander@684
   335
#elif SH_SYS == SH_SYS_APPLE
dvander@684
   336
			struct sigaction sa, osa;
dvander@684
   337
			sa.sa_sigaction = BadReadHandler;
dvander@684
   338
			sa.sa_flags = SA_SIGINFO | SA_RESTART;
dvander@684
   339
dvander@684
   340
			g_BadReadCalled = true;
dvander@684
   341
dvander@684
   342
			if (setjmp(g_BadReadJmpBuf))
dvander@684
   343
				return false;
dvander@684
   344
dvander@684
   345
			if (sigaction(SIGBUS, &sa, &osa) == -1)
dvander@684
   346
				return false;
dvander@684
   347
dvander@684
   348
			volatile const char *p = reinterpret_cast<const char *>(addr);
dvander@684
   349
			char dummy;
dvander@684
   350
dvander@684
   351
			for (size_t i = 0; i < len; i++)
dvander@684
   352
				dummy = p[i];
dvander@684
   353
dvander@684
   354
			g_BadReadCalled = false;
dvander@684
   355
dvander@684
   356
			sigaction(SIGBUS, &osa, NULL);
dvander@684
   357
dvander@684
   358
			return true;
dvander@684
   359
#elif SH_XP == SH_XP_WINAPI
pavolmarko@117
   360
			// On Win32, simply use IsBadReadPtr
pavolmarko@117
   361
			return !IsBadReadPtr(addr, len);
pavolmarko@117
   362
#endif
pavolmarko@117
   363
		}
pavolmarko@117
   364
	}
pavolmarko@1
   365
}
pavolmarko@1
   366
dvander@34
   367
#endif