CDetour/detours.h
author Ruben Gonzalez <drifter01620@gmail.com>
Wed Nov 12 08:29:24 2014 -0500 (2014-11-12)
changeset 197 fd967f09ab68
parent 184 7ddf645a50d5
permissions -rw-r--r--
Update CSGO Gamedata
drifter01620@184
     1
/**
drifter01620@184
     2
* vim: set ts=4 :
drifter01620@184
     3
* =============================================================================
drifter01620@184
     4
* SourceMod
drifter01620@184
     5
* Copyright (C) 2004-2010 AlliedModders LLC.  All rights reserved.
drifter01620@184
     6
* =============================================================================
drifter01620@184
     7
*
drifter01620@184
     8
* This program is free software; you can redistribute it and/or modify it under
drifter01620@184
     9
* the terms of the GNU General Public License, version 3.0, as published by the
drifter01620@184
    10
* Free Software Foundation.
drifter01620@184
    11
* 
drifter01620@184
    12
* This program is distributed in the hope that it will be useful, but WITHOUT
drifter01620@184
    13
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
drifter01620@184
    14
* FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
drifter01620@184
    15
* details.
drifter01620@184
    16
*
drifter01620@184
    17
* You should have received a copy of the GNU General Public License along with
drifter01620@184
    18
* this program.  If not, see <http://www.gnu.org/licenses/>.
drifter01620@184
    19
*
drifter01620@184
    20
* As a special exception, AlliedModders LLC gives you permission to link the
drifter01620@184
    21
* code of this program (as well as its derivative works) to "Half-Life 2," the
drifter01620@184
    22
* "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
drifter01620@184
    23
* by the Valve Corporation.  You must obey the GNU General Public License in
drifter01620@184
    24
* all respects for all other code used.  Additionally, AlliedModders LLC grants
drifter01620@184
    25
* this exception to all derivative works.  AlliedModders LLC defines further
drifter01620@184
    26
* exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
drifter01620@184
    27
* or <http://www.sourcemod.net/license.php>.
drifter01620@184
    28
*
drifter01620@184
    29
* Version: $Id: detours.h 257 2008-09-23 03:12:13Z pred $
drifter01620@184
    30
*/
drifter01620@184
    31
drifter01620@184
    32
#ifndef _INCLUDE_SOURCEMOD_DETOURS_H_
drifter01620@184
    33
#define _INCLUDE_SOURCEMOD_DETOURS_H_
drifter01620@184
    34
drifter01620@184
    35
#include "../cssdm_main.h"
drifter01620@184
    36
#include <jit/jit_helpers.h>
drifter01620@184
    37
#include <jit/x86/x86_macros.h>
drifter01620@184
    38
#include "detourhelpers.h"
drifter01620@184
    39
drifter01620@184
    40
/**
drifter01620@184
    41
 * CDetours class for SourceMod Extensions by pRED*
drifter01620@184
    42
 * detourhelpers.h entirely stolen from CSS:DM and were written by BAILOPAN (I assume).
drifter01620@184
    43
 * asm.h/c from devmaster.net (thanks cybermind) edited by pRED* to handle gcc -fPIC thunks correctly
drifter01620@184
    44
 * Concept by Nephyrin Zey (http://www.doublezen.net/) and Windows Detour Library (http://research.microsoft.com/sn/detours/)
drifter01620@184
    45
 * Member function pointer ideas by Don Clugston (http://www.codeproject.com/cpp/FastDelegate.asp)
drifter01620@184
    46
 */
drifter01620@184
    47
drifter01620@184
    48
#define DETOUR_MEMBER_CALL(name) (this->*name##_Actual)
drifter01620@184
    49
#define DETOUR_STATIC_CALL(name) (name##_Actual)
drifter01620@184
    50
drifter01620@184
    51
#define DETOUR_DECL_STATIC0(name, ret) \
drifter01620@184
    52
ret (*name##_Actual)(void) = NULL; \
drifter01620@184
    53
ret name(void)
drifter01620@184
    54
drifter01620@184
    55
#define DETOUR_DECL_STATIC1(name, ret, p1type, p1name) \
drifter01620@184
    56
ret (*name##_Actual)(p1type) = NULL; \
drifter01620@184
    57
ret name(p1type p1name)
drifter01620@184
    58
drifter01620@184
    59
#define DETOUR_DECL_STATIC4(name, ret, p1type, p1name, p2type, p2name, p3type, p3name, p4type, p4name) \
drifter01620@184
    60
ret (*name##_Actual)(p1type, p2type, p3type, p4type) = NULL; \
drifter01620@184
    61
ret name(p1type p1name, p2type p2name, p3type p3name, p4type p4name)
drifter01620@184
    62
drifter01620@184
    63
#define DETOUR_DECL_MEMBER0(name, ret) \
drifter01620@184
    64
class name##Class \
drifter01620@184
    65
{ \
drifter01620@184
    66
public: \
drifter01620@184
    67
	ret name(); \
drifter01620@184
    68
	static ret (name##Class::* name##_Actual)(void); \
drifter01620@184
    69
}; \
drifter01620@184
    70
ret (name##Class::* name##Class::name##_Actual)(void) = NULL; \
drifter01620@184
    71
ret name##Class::name()
drifter01620@184
    72
drifter01620@184
    73
#define DETOUR_DECL_MEMBER1(name, ret, p1type, p1name) \
drifter01620@184
    74
class name##Class \
drifter01620@184
    75
{ \
drifter01620@184
    76
public: \
drifter01620@184
    77
	ret name(p1type p1name); \
drifter01620@184
    78
	static ret (name##Class::* name##_Actual)(p1type); \
drifter01620@184
    79
}; \
drifter01620@184
    80
ret (name##Class::* name##Class::name##_Actual)(p1type) = NULL; \
drifter01620@184
    81
ret name##Class::name(p1type p1name)
drifter01620@184
    82
drifter01620@184
    83
#define DETOUR_DECL_MEMBER2(name, ret, p1type, p1name, p2type, p2name) \
drifter01620@184
    84
class name##Class \
drifter01620@184
    85
{ \
drifter01620@184
    86
public: \
drifter01620@184
    87
	ret name(p1type p1name, p2type p2name); \
drifter01620@184
    88
	static ret (name##Class::* name##_Actual)(p1type, p2type); \
drifter01620@184
    89
}; \
drifter01620@184
    90
ret (name##Class::* name##Class::name##_Actual)(p1type, p2type) = NULL; \
drifter01620@184
    91
ret name##Class::name(p1type p1name, p2type p2name)
drifter01620@184
    92
drifter01620@184
    93
#define DETOUR_DECL_MEMBER3(name, ret, p1type, p1name, p2type, p2name, p3type, p3name) \
drifter01620@184
    94
class name##Class \
drifter01620@184
    95
{ \
drifter01620@184
    96
public: \
drifter01620@184
    97
	ret name(p1type p1name, p2type p2name, p3type p3name); \
drifter01620@184
    98
	static ret (name##Class::* name##_Actual)(p1type, p2type, p3type); \
drifter01620@184
    99
}; \
drifter01620@184
   100
ret (name##Class::* name##Class::name##_Actual)(p1type, p2type, p3type) = NULL; \
drifter01620@184
   101
ret name##Class::name(p1type p1name, p2type p2name, p3type p3name)
drifter01620@184
   102
drifter01620@184
   103
#define DETOUR_DECL_MEMBER4(name, ret, p1type, p1name, p2type, p2name, p3type, p3name, p4type, p4name) \
drifter01620@184
   104
class name##Class \
drifter01620@184
   105
{ \
drifter01620@184
   106
public: \
drifter01620@184
   107
        ret name(p1type p1name, p2type p2name, p3type p3name, p4type p4name); \
drifter01620@184
   108
        static ret (name##Class::* name##_Actual)(p1type, p2type, p3type, p4type); \
drifter01620@184
   109
}; \
drifter01620@184
   110
ret (name##Class::* name##Class::name##_Actual)(p1type, p2type, p3type, p4type) = NULL; \
drifter01620@184
   111
ret name##Class::name(p1type p1name, p2type p2name, p3type p3name, p4type p4name)
drifter01620@184
   112
drifter01620@184
   113
#define DETOUR_DECL_MEMBER8(name, ret, p1type, p1name, p2type, p2name, p3type, p3name, p4type, p4name, p5type, p5name, p6type, p6name, p7type, p7name, p8type, p8name) \
drifter01620@184
   114
class name##Class \
drifter01620@184
   115
{ \
drifter01620@184
   116
public: \
drifter01620@184
   117
        ret name(p1type p1name, p2type p2name, p3type p3name, p4type p4name, p5type p5name, p6type p6name, p7type p7name, p8type p8name); \
drifter01620@184
   118
        static ret (name##Class::* name##_Actual)(p1type, p2type, p3type, p4type, p5type, p6type, p7type, p8type); \
drifter01620@184
   119
}; \
drifter01620@184
   120
ret (name##Class::* name##Class::name##_Actual)(p1type, p2type, p3type, p4type, p5type, p6type, p7type, p8type) = NULL; \
drifter01620@184
   121
ret name##Class::name(p1type p1name, p2type p2name, p3type p3name, p4type p4name, p5type p5name, p6type p6name, p7type p7name, p8type p8name)
drifter01620@184
   122
drifter01620@184
   123
drifter01620@184
   124
#define GET_MEMBER_CALLBACK(name) (void *)GetCodeAddress(&name##Class::name)
drifter01620@184
   125
#define GET_MEMBER_TRAMPOLINE(name) (void **)(&name##Class::name##_Actual)
drifter01620@184
   126
drifter01620@184
   127
#define GET_STATIC_CALLBACK(name) (void *)&name
drifter01620@184
   128
#define GET_STATIC_TRAMPOLINE(name) (void **)&name##_Actual
drifter01620@184
   129
drifter01620@184
   130
#define DETOUR_CREATE_MEMBER(name, gamedata) CDetourManager::CreateDetour(GET_MEMBER_CALLBACK(name), GET_MEMBER_TRAMPOLINE(name), gamedata);
drifter01620@184
   131
#define DETOUR_CREATE_STATIC(name, gamedata) CDetourManager::CreateDetour(GET_STATIC_CALLBACK(name), GET_STATIC_TRAMPOLINE(name), gamedata);
drifter01620@184
   132
drifter01620@184
   133
drifter01620@184
   134
class GenericClass {};
drifter01620@184
   135
typedef void (GenericClass::*VoidFunc)();
drifter01620@184
   136
drifter01620@184
   137
inline void *GetCodeAddr(VoidFunc mfp)
drifter01620@184
   138
{
drifter01620@184
   139
	return *(void **)&mfp;
drifter01620@184
   140
}
drifter01620@184
   141
drifter01620@184
   142
/**
drifter01620@184
   143
 * Converts a member function pointer to a void pointer.
drifter01620@184
   144
 * This relies on the assumption that the code address lies at mfp+0
drifter01620@184
   145
 * This is the case for both g++ and later MSVC versions on non virtual functions but may be different for other compilers
drifter01620@184
   146
 * Based on research by Don Clugston : http://www.codeproject.com/cpp/FastDelegate.asp
drifter01620@184
   147
 */
drifter01620@184
   148
#define GetCodeAddress(mfp) GetCodeAddr(reinterpret_cast<VoidFunc>(mfp))
drifter01620@184
   149
drifter01620@184
   150
class CDetourManager;
drifter01620@184
   151
drifter01620@184
   152
class CDetour
drifter01620@184
   153
{
drifter01620@184
   154
public:
drifter01620@184
   155
drifter01620@184
   156
	bool IsEnabled();
drifter01620@184
   157
drifter01620@184
   158
	/**
drifter01620@184
   159
	 * These would be somewhat self-explanatory I hope
drifter01620@184
   160
	 */
drifter01620@184
   161
	void EnableDetour();
drifter01620@184
   162
	void DisableDetour();
drifter01620@184
   163
drifter01620@184
   164
	void Destroy();
drifter01620@184
   165
drifter01620@184
   166
	friend class CDetourManager;
drifter01620@184
   167
drifter01620@184
   168
protected:
drifter01620@184
   169
	CDetour(void *callbackfunction, void **trampoline, const char *signame);
drifter01620@184
   170
drifter01620@184
   171
	bool Init(ISourcePawnEngine *spengine, IGameConfig *gameconf);
drifter01620@184
   172
private:
drifter01620@184
   173
drifter01620@184
   174
	/* These create/delete the allocated memory */
drifter01620@184
   175
	bool CreateDetour();
drifter01620@184
   176
	void DeleteDetour();
drifter01620@184
   177
drifter01620@184
   178
	bool enabled;
drifter01620@184
   179
	bool detoured;
drifter01620@184
   180
drifter01620@184
   181
	patch_t detour_restore;
drifter01620@184
   182
	/* Address of the detoured function */
drifter01620@184
   183
	void *detour_address;
drifter01620@184
   184
	/* Address of the allocated trampoline function */
drifter01620@184
   185
	void *detour_trampoline;
drifter01620@184
   186
	/* Address of the callback handler */
drifter01620@184
   187
	void *detour_callback;
drifter01620@184
   188
	/* The function pointer used to call our trampoline */
drifter01620@184
   189
	void **trampoline;
drifter01620@184
   190
	
drifter01620@184
   191
	const char *signame;
drifter01620@184
   192
	ISourcePawnEngine *spengine;
drifter01620@184
   193
	IGameConfig *gameconf;
drifter01620@184
   194
};
drifter01620@184
   195
drifter01620@184
   196
class CDetourManager
drifter01620@184
   197
{
drifter01620@184
   198
public:
drifter01620@184
   199
drifter01620@184
   200
	static void Init(ISourcePawnEngine *spengine, IGameConfig *gameconf);
drifter01620@184
   201
drifter01620@184
   202
	/**
drifter01620@184
   203
	 * Creates a new detour
drifter01620@184
   204
	 *
drifter01620@184
   205
	 * @param callbackfunction			Void pointer to your detour callback function.
drifter01620@184
   206
	 * @param trampoline				Address of the trampoline pointer
drifter01620@184
   207
	 * @param signame					Section name containing a signature to fetch from the gamedata file.
drifter01620@184
   208
	 * @return							A new CDetour pointer to control your detour.
drifter01620@184
   209
	 *
drifter01620@184
   210
	 * Example:
drifter01620@184
   211
	 *
drifter01620@184
   212
	 * CBaseServer::ConnectClient(netadr_s &, int, int, int, char  const*, char  const*, char  const*, int)
drifter01620@184
   213
	 *
drifter01620@184
   214
	 * Define a new class with the required function and a member function pointer to the same type:
drifter01620@184
   215
	 *
drifter01620@184
   216
	 * class CBaseServerDetour
drifter01620@184
   217
	 * {
drifter01620@184
   218
	 * public:
drifter01620@184
   219
	 *		 bool ConnectClient(void *netaddr_s, int, int, int, char  const*, char  const*, char  const*, int);
drifter01620@184
   220
	 *		 static bool (CBaseServerDetour::* ConnectClient_Actual)(void *netaddr_s, int, int, int, char  const*, char  const*, char  const*, int);
drifter01620@184
   221
	 * }
drifter01620@184
   222
	 *
drifter01620@184
   223
	 *	void *callbackfunc = GetCodeAddress(&CBaseServerDetour::ConnectClient);
drifter01620@184
   224
	 *	void **trampoline = (void **)(&CBaseServerDetour::ConnectClient_Actual);
drifter01620@184
   225
	 *
drifter01620@184
   226
	 * Creation:
drifter01620@184
   227
	 * CDetourManager::CreateDetour(callbackfunc,  trampoline, "ConnectClient");
drifter01620@184
   228
	 *
drifter01620@184
   229
	 * Usage:
drifter01620@184
   230
	 *
drifter01620@184
   231
	 * CBaseServerDetour::ConnectClient(void *netaddr_s, int, int, int, char  const*, char  const*, char  const*, int)
drifter01620@184
   232
	 * {
drifter01620@184
   233
	 *			//pre hook code
drifter01620@184
   234
	 *			bool result = (this->*ConnectClient_Actual)(netaddr_s, rest of params);
drifter01620@184
   235
	 *			//post hook code
drifter01620@184
   236
	 *			return result;
drifter01620@184
   237
	 * }
drifter01620@184
   238
	 *
drifter01620@184
   239
	 * Note we changed the netadr_s reference into a void* to avoid needing to define the type
drifter01620@184
   240
	 */
drifter01620@184
   241
	static CDetour *CreateDetour(void *callbackfunction, void **trampoline, const char *signame);
drifter01620@184
   242
drifter01620@184
   243
	friend class CBlocker;
drifter01620@184
   244
	friend class CDetour;
drifter01620@184
   245
drifter01620@184
   246
private:
drifter01620@184
   247
	static ISourcePawnEngine *spengine;
drifter01620@184
   248
	static IGameConfig *gameconf;
drifter01620@184
   249
};
drifter01620@184
   250
drifter01620@184
   251
#endif // _INCLUDE_SOURCEMOD_DETOURS_H_