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