core/sourcehook/sh_memory.h
author Scott Ehlert <ds@alliedmods.net>
Thu Dec 10 00:59:50 2009 -0600 (2009-12-10)
changeset 689 4065ba5e9155
parent 684 8015336442cb
child 733 2365240861a2
permissions -rw-r--r--
Rewrote user message caching code to always use IServerGameDLL::GetUserMessageInfo (bug 4117, r=dvander).

Games where the above function can crash are handled by detouring tier0's Error() function and jumping back to our own code. So in theory this should work on all games now.
dvander@10
     1
/* ======== SourceHook ========
ds@523
     2
* Copyright (C) 2004-2008 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
pavolmarko@1
    46
pavolmarko@480
    47
#include "sh_list.h"
pavolmarko@1
    48
pavolmarko@1
    49
namespace SourceHook
pavolmarko@1
    50
{
pavolmarko@1
    51
	inline bool SetMemAccess(void *addr, size_t len, int access)
pavolmarko@1
    52
	{
dvander@684
    53
# if SH_XP == SH_XP_POSIX
pavolmarko@50
    54
		return mprotect(SH_LALIGN(addr), len + SH_LALDIF(addr), access)==0 ? true : false;
dvander@684
    55
# elif SH_XP == SH_XP_WINAPI
pavolmarko@1
    56
		DWORD tmp;
pavolmarko@1
    57
		DWORD prot;
pavolmarko@1
    58
		switch (access)
pavolmarko@1
    59
		{
pavolmarko@1
    60
		case SH_MEM_READ:
pavolmarko@1
    61
			prot = PAGE_READONLY; break;
pavolmarko@1
    62
		case SH_MEM_READ | SH_MEM_WRITE:
pavolmarko@1
    63
			prot = PAGE_READWRITE; break;
pavolmarko@1
    64
		case SH_MEM_READ | SH_MEM_EXEC:
pavolmarko@1
    65
			prot = PAGE_EXECUTE_READ; break;
pavolmarko@1
    66
		default:
pavolmarko@1
    67
		case SH_MEM_READ | SH_MEM_WRITE | SH_MEM_EXEC:
pavolmarko@1
    68
			prot = PAGE_EXECUTE_READWRITE; break;
pavolmarko@1
    69
		}
pavolmarko@1
    70
		return VirtualProtect(addr, len, prot, &tmp) ? true : false;
pavolmarko@1
    71
# endif
pavolmarko@1
    72
	}
pavolmarko@1
    73
dvander@684
    74
#if SH_XP == SH_XP_POSIX
pavolmarko@117
    75
	namespace
pavolmarko@117
    76
	{
pavolmarko@117
    77
		bool g_BadReadCalled;
pavolmarko@117
    78
		jmp_buf g_BadReadJmpBuf;
pavolmarko@117
    79
dvander@684
    80
# if SH_SYS == SH_SYS_LINUX
pavolmarko@117
    81
		static void BadReadHandler(int sig)
pavolmarko@117
    82
		{
pavolmarko@117
    83
			if (g_BadReadCalled)
pavolmarko@117
    84
				longjmp(g_BadReadJmpBuf, 1);
pavolmarko@117
    85
		}
dvander@684
    86
# elif SH_SYS == SH_SYS_APPLE
dvander@684
    87
		static void BadReadHandler(int signal, siginfo_t* my_siginfo, void* my_context)	
dvander@684
    88
		{
dvander@684
    89
			if (g_BadReadCalled)
dvander@684
    90
				longjmp(g_BadReadJmpBuf, 1);
dvander@684
    91
		}
dvander@684
    92
# endif
pavolmarko@117
    93
	}
pavolmarko@117
    94
#endif
pavolmarko@117
    95
pavolmarko@117
    96
	/**
pavolmarko@117
    97
	*	@brief Checks whether the specified memory region is (still) accessible
pavolmarko@117
    98
	*
pavolmarko@117
    99
	*	@param addr The lower boundary
pavolmarko@117
   100
	*	@param len Length of the region to be checked
pavolmarko@117
   101
	*/
pavolmarko@117
   102
	namespace
pavolmarko@117
   103
	{
pavolmarko@117
   104
		bool ModuleInMemory(char *addr, size_t len)
pavolmarko@117
   105
		{
dvander@684
   106
#if SH_SYS == SH_SYS_LINUX
pavolmarko@117
   107
			// On linux, first check /proc/self/maps
pavolmarko@117
   108
			long lower = reinterpret_cast<long>(addr);
pavolmarko@117
   109
			long upper = lower + len;
pavolmarko@117
   110
pavolmarko@117
   111
			FILE *pF = fopen("/proc/self/maps", "r");
pavolmarko@117
   112
			if (pF)
pavolmarko@117
   113
			{
pavolmarko@117
   114
				// Linux /proc/self/maps -> parse
pavolmarko@117
   115
				// Format:
pavolmarko@117
   116
				// lower    upper    prot     stuff                 path
pavolmarko@117
   117
				// 08048000-0804c000 r-xp 00000000 03:03 1010107    /bin/cat
pavolmarko@117
   118
				long rlower, rupper;
pavolmarko@117
   119
				while (fscanf(pF, "%lx-%lx", &rlower, &rupper) != EOF)
pavolmarko@117
   120
				{
pavolmarko@117
   121
					// Check whether we're IN THERE!
pavolmarko@117
   122
					if (lower >= rlower && upper <= rupper)
pavolmarko@117
   123
					{
pavolmarko@117
   124
						fclose(pF);
pavolmarko@117
   125
						return true;
pavolmarko@117
   126
					}
pavolmarko@117
   127
					// Read to end of line
pavolmarko@117
   128
					int c;
pavolmarko@117
   129
					while ((c = fgetc(pF)) != '\n')
pavolmarko@117
   130
					{
pavolmarko@117
   131
						if (c == EOF)
pavolmarko@117
   132
							break;
pavolmarko@117
   133
					}
pavolmarko@117
   134
					if (c == EOF)
pavolmarko@117
   135
						break;
pavolmarko@117
   136
				}
pavolmarko@117
   137
				fclose(pF);
pavolmarko@117
   138
				return false;
pavolmarko@117
   139
			}
pavolmarko@117
   140
			pF = fopen("/proc/curproc/map", "r");
pavolmarko@117
   141
			if (pF)
pavolmarko@117
   142
			{
pavolmarko@117
   143
				// FreeBSD /proc/curproc/map -> parse
pavolmarko@117
   144
				// 0x804800 0x805500 13 15 0xc6e18960 r-x 21 0x0 COW NC vnode
pavolmarko@117
   145
				long rlower, rupper;
pavolmarko@117
   146
				while (fscanf(pF, "0x%lx 0x%lx", &rlower, &rupper) != EOF)
pavolmarko@117
   147
				{
pavolmarko@117
   148
					// Check whether we're IN THERE!
pavolmarko@117
   149
					if (lower >= rlower && upper <= rupper)
pavolmarko@117
   150
					{
pavolmarko@117
   151
						fclose(pF);
pavolmarko@117
   152
						return true;
pavolmarko@117
   153
					}
pavolmarko@117
   154
					// Read to end of line
pavolmarko@117
   155
					int c;
pavolmarko@117
   156
					while ((c = fgetc(pF)) != '\n')
pavolmarko@117
   157
					{
pavolmarko@117
   158
						if (c == EOF)
pavolmarko@117
   159
							break;
pavolmarko@117
   160
					}
pavolmarko@117
   161
					if (c == EOF)
pavolmarko@117
   162
						break;
pavolmarko@117
   163
				}
pavolmarko@117
   164
				fclose(pF);
pavolmarko@117
   165
				return false;
pavolmarko@117
   166
			}
pavolmarko@117
   167
pavolmarko@117
   168
			// Both of the above failed, try to actually read and trap sigsegv (implemented by Damaged Soul)
pavolmarko@117
   169
			void(*prevHandler)(int sig);
pavolmarko@117
   170
			g_BadReadCalled = true;
pavolmarko@117
   171
pavolmarko@117
   172
			if (setjmp(g_BadReadJmpBuf))
pavolmarko@117
   173
				return true;
pavolmarko@117
   174
pavolmarko@117
   175
			prevHandler = signal(SIGSEGV, BadReadHandler);
pavolmarko@117
   176
pavolmarko@117
   177
			volatile const char *p = reinterpret_cast<const char*>(addr);
pavolmarko@117
   178
			char dummy;
pavolmarko@117
   179
pavolmarko@117
   180
			for (size_t i = 0; i < len; i++)
pavolmarko@117
   181
				dummy = p[i];
pavolmarko@117
   182
pavolmarko@117
   183
			g_BadReadCalled = false;
pavolmarko@117
   184
pavolmarko@117
   185
			signal(SIGSEGV, prevHandler);
pavolmarko@117
   186
pavolmarko@117
   187
			return false;
dvander@684
   188
#elif SH_SYS == SH_SYS_APPLE
dvander@684
   189
			struct sigaction sa, osa;
dvander@684
   190
			sa.sa_sigaction = BadReadHandler;
dvander@684
   191
			sa.sa_flags = SA_SIGINFO | SA_RESTART;
dvander@684
   192
dvander@684
   193
			g_BadReadCalled = true;
dvander@684
   194
dvander@684
   195
			if (setjmp(g_BadReadJmpBuf))
dvander@684
   196
				return false;
dvander@684
   197
dvander@684
   198
			if (sigaction(SIGBUS, &sa, &osa) == -1)
dvander@684
   199
				return false;
dvander@684
   200
dvander@684
   201
			volatile const char *p = reinterpret_cast<const char *>(addr);
dvander@684
   202
			char dummy;
dvander@684
   203
dvander@684
   204
			for (size_t i = 0; i < len; i++)
dvander@684
   205
				dummy = p[i];
dvander@684
   206
dvander@684
   207
			g_BadReadCalled = false;
dvander@684
   208
dvander@684
   209
			sigaction(SIGBUS, &osa, NULL);
dvander@684
   210
dvander@684
   211
			return true;
dvander@684
   212
#elif SH_XP == SH_XP_WINAPI
pavolmarko@117
   213
			// On Win32, simply use IsBadReadPtr
pavolmarko@117
   214
			return !IsBadReadPtr(addr, len);
pavolmarko@117
   215
#endif
pavolmarko@117
   216
		}
pavolmarko@117
   217
	}
pavolmarko@1
   218
}
pavolmarko@1
   219
dvander@34
   220
#endif