extensions/sdktools/output.cpp
author Matt Woodrow <pred@alliedmods.net>
Tue May 20 02:51:02 2008 +0000 (2008-05-20)
changeset 2062 88443d433b8c
parent 2026 03b4a9c4a70e
child 2122 2c31629b07f4
permissions -rw-r--r--
Fixed amb1687 - Infinite loop in Entity Outputs
     1 /**
     2  * vim: set ts=4 :
     3  * =============================================================================
     4  * SourceMod SDKTools Extension
     5  * Copyright (C) 2004-2008 AlliedModders LLC.  All rights reserved.
     6  * =============================================================================
     7  *
     8  * This program is free software; you can redistribute it and/or modify it under
     9  * the terms of the GNU General Public License, version 3.0, as published by the
    10  * Free Software Foundation.
    11  * 
    12  * This program is distributed in the hope that it will be useful, but WITHOUT
    13  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
    14  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
    15  * details.
    16  *
    17  * You should have received a copy of the GNU General Public License along with
    18  * this program.  If not, see <http://www.gnu.org/licenses/>.
    19  *
    20  * As a special exception, AlliedModders LLC gives you permission to link the
    21  * code of this program (as well as its derivative works) to "Half-Life 2," the
    22  * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
    23  * by the Valve Corporation.  You must obey the GNU General Public License in
    24  * all respects for all other code used.  Additionally, AlliedModders LLC grants
    25  * this exception to all derivative works.  AlliedModders LLC defines further
    26  * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
    27  * or <http://www.sourcemod.net/license.php>.
    28  *
    29  * Version: $Id$
    30  */
    31 
    32 #include "extension.h"
    33 #include "output.h"
    34 
    35 ISourcePawnEngine *spengine = NULL;
    36 EntityOutputManager g_OutputManager;
    37 
    38 EntityOutputManager::EntityOutputManager()
    39 {
    40 	info_address = NULL;
    41 	info_callback = NULL;
    42 	HookCount = 0;
    43 	is_detoured = false;
    44 	enabled = false;
    45 }
    46 
    47 EntityOutputManager::~EntityOutputManager()
    48 {
    49 	if (!enabled)
    50 	{
    51 		return;
    52 	}
    53 
    54 	EntityOutputs->Destroy();
    55 	ClassNames->Destroy();
    56 	ShutdownFireEventDetour();
    57 }
    58 
    59 void EntityOutputManager::Init()
    60 {
    61 	enabled = CreateFireEventDetour();
    62 
    63 	if (!enabled)
    64 	{
    65 		return;
    66 	}
    67 
    68 	EntityOutputs = adtfactory->CreateBasicTrie();
    69 	ClassNames = adtfactory->CreateBasicTrie();
    70 }
    71 
    72 bool EntityOutputManager::IsEnabled()
    73 {
    74 	return enabled;
    75 }
    76 
    77 bool EntityOutputManager::CreateFireEventDetour()
    78 {
    79 	if (!g_pGameConf->GetMemSig("FireOutput", &info_address) || !info_address)
    80 	{
    81 		g_pSM->LogError(myself, "Could not locate FireOutput - Disabling Entity Outputs");
    82 		return false;
    83 	}
    84 
    85 	if (!g_pGameConf->GetOffset("FireOutputBackup", (int *)&(info_restore.bytes)))
    86 	{
    87 		g_pSM->LogError(myself, "Could not locate FireOutputBackup - Disabling Entity Outputs");
    88 		return false;
    89 	}
    90 
    91 	/* First, save restore bits */
    92 	for (size_t i=0; i<info_restore.bytes; i++)
    93 	{
    94 		info_restore.patch[i] = ((unsigned char *)info_address)[i];
    95 	}
    96 
    97 	info_callback = spengine->ExecAlloc(100);
    98 	JitWriter wr;
    99 	JitWriter *jit = &wr;
   100 	wr.outbase = (jitcode_t)info_callback;
   101 	wr.outptr = wr.outbase;
   102 
   103 	/* Function we are detouring into is
   104 	 *
   105 	 * void FireEventDetour(CBaseEntityOutput(void *) *pOutput, CBaseEntity *pActivator, CBaseEntity *pCaller, float fDelay = 0 )
   106 	 */
   107 
   108 	/* push		fDelay [esp+20h]
   109 	 * push		pCaller [esp+1Ch]
   110 	 * push		pActivator [esp+18h]
   111 	 * push		pOutput [ecx]
   112 	 */
   113 
   114 
   115 #if defined PLATFORM_WINDOWS
   116 
   117 	IA32_Push_Rm_Disp8_ESP(jit, 32);
   118 	IA32_Push_Rm_Disp8_ESP(jit, 32);
   119 	IA32_Push_Rm_Disp8_ESP(jit, 32);
   120 
   121 	IA32_Push_Reg(jit, REG_ECX);
   122 
   123 #elif defined PLATFORM_LINUX
   124 	IA32_Push_Rm_Disp8_ESP(jit, 20);
   125 	IA32_Push_Rm_Disp8_ESP(jit, 20);
   126 	IA32_Push_Rm_Disp8_ESP(jit, 20);
   127 
   128 	IA32_Push_Rm_Disp8_ESP(jit, 16);
   129 #endif
   130 
   131 	jitoffs_t call = IA32_Call_Imm32(jit, 0); 
   132 	IA32_Write_Jump32_Abs(jit, call, (void *)TempDetour);
   133 
   134 	
   135 #if defined PLATFORM_LINUX
   136 	IA32_Add_Rm_Imm8(jit, REG_ESP, 4, MOD_REG);		//add esp, 4
   137 #elif defined PLATFORM_WINDOWS
   138 	IA32_Pop_Reg(jit, REG_ECX);
   139 #endif
   140 
   141 	IA32_Add_Rm_Imm8(jit, REG_ESP, 12, MOD_REG);	//add esp, 12 (0Ch)
   142 
   143 
   144 	/* Patch old bytes in */
   145 	for (size_t i=0; i<info_restore.bytes; i++)
   146 	{
   147 		jit->write_ubyte(info_restore.patch[i]);
   148 	}
   149 
   150 	/* Return to the original function */
   151 	call = IA32_Jump_Imm32(jit, 0);
   152 	IA32_Write_Jump32_Abs(jit, call, (unsigned char *)info_address + info_restore.bytes);
   153 
   154 	return true;
   155 }
   156 
   157 void EntityOutputManager::InitFireEventDetour()
   158 {
   159 	if (!is_detoured)
   160 	{
   161 		DoGatePatch((unsigned char *)info_address, &info_callback);
   162 		is_detoured = true;
   163 	}
   164 }
   165 
   166 void EntityOutputManager::DeleteFireEventDetour()
   167 {
   168 	if (is_detoured)
   169 	{
   170 		ShutdownFireEventDetour();
   171 	}
   172 
   173 	if (info_callback)
   174 	{
   175 		/* Free the gate */
   176 		spengine->ExecFree(info_callback);
   177 		info_callback = NULL;
   178 	}
   179 }
   180 
   181 void TempDetour(void *pOutput, CBaseEntity *pActivator, CBaseEntity *pCaller, float fDelay)
   182 {
   183 	g_OutputManager.FireEventDetour(pOutput, pActivator, pCaller, fDelay);
   184 }
   185 
   186 void EntityOutputManager::ShutdownFireEventDetour()
   187 {
   188 	if (info_callback)
   189 	{
   190 		/* Remove the patch */
   191 		ApplyPatch(info_address, 0, &info_restore, NULL);
   192 		is_detoured = false;
   193 	}
   194 }
   195 
   196 void EntityOutputManager::FireEventDetour(void *pOutput, CBaseEntity *pActivator, CBaseEntity *pCaller, float fDelay)
   197 {
   198 	char sOutput[20];
   199 	Q_snprintf(sOutput, sizeof(sOutput), "%x", pOutput);
   200 
   201 	// attempt to directly lookup a hook using the pOutput pointer
   202 	OutputNameStruct *pOutputName = NULL;
   203 
   204 	edict_t *pEdict = gameents->BaseEntityToEdict(pCaller);
   205 
   206 	/* TODO: Add support for entities without an edict */
   207 	if (pEdict == NULL)
   208 	{
   209 		return;
   210 	}
   211 
   212 	bool fastLookup = false;
   213 	
   214 	// Fast lookup failed - check the slow way for hooks that havn't fired yet
   215 	if ((fastLookup = EntityOutputs->Retrieve(sOutput, (void **)&pOutputName)) == false)
   216 	{
   217 		const char *classname = pEdict->GetClassName();
   218 		const char *outputname = FindOutputName(pOutput, pCaller);
   219 
   220 		pOutputName = FindOutputPointer(classname, outputname, false);
   221 
   222 		if (!pOutputName)
   223 		{
   224 			return;
   225 		}
   226 	}
   227 
   228 	if (!pOutputName->hooks.empty())
   229 	{
   230 		if (!fastLookup)
   231 		{
   232 			// hook exists on this classname and output - map it into our quick find trie
   233 			EntityOutputs->Insert(sOutput, pOutputName);
   234 		}
   235 
   236 		SourceHook::List<omg_hooks *>::iterator _iter;
   237 
   238 		omg_hooks *hook;
   239 
   240 		_iter = pOutputName->hooks.begin();
   241 
   242 		while (_iter != pOutputName->hooks.end())
   243 		{
   244 			hook = (omg_hooks *)*_iter;
   245 
   246 			hook->in_use = true;
   247 
   248 			int serial = pEdict->m_NetworkSerialNumber;
   249 			
   250 			if (serial != hook->entity_filter && hook->entity_index == engine->IndexOfEdict(pEdict))
   251 			{
   252 				// same entity index but different serial number. Entity has changed, kill the hook.
   253 				_iter = pOutputName->hooks.erase(_iter);
   254 				CleanUpHook(hook);
   255 
   256 				continue;
   257 			}
   258 
   259 			if (hook->entity_filter == -1 || hook->entity_filter == serial) // Global classname hook
   260 			{
   261 				//fire the forward to hook->pf
   262 				hook->pf->PushString(pOutputName->Name);
   263 				hook->pf->PushCell(engine->IndexOfEdict(pEdict));
   264 				
   265 				edict_t *pEdictActivator = gameents->BaseEntityToEdict(pActivator);
   266 				if (!pEdictActivator)
   267 				{
   268 					hook->pf->PushCell(-1);
   269 				}
   270 				else
   271 				{
   272 					hook->pf->PushCell(engine->IndexOfEdict(pEdictActivator));
   273 				}
   274 				//hook->pf->PushCell(handle);
   275 				hook->pf->PushFloat(fDelay);
   276 				hook->pf->Execute(NULL);
   277 
   278 				if ((hook->entity_filter != -1) && hook->only_once)
   279 				{
   280 					_iter = pOutputName->hooks.erase(_iter);
   281 					CleanUpHook(hook);
   282 
   283 					continue;
   284 				}
   285 
   286 				if (hook->delete_me)
   287 				{
   288 					_iter = pOutputName->hooks.erase(_iter);
   289 					CleanUpHook(hook);
   290 					continue;
   291 				}
   292 			}
   293 
   294 			hook->in_use = false;
   295 			_iter++;
   296 		}
   297 	}
   298 }
   299 
   300 omg_hooks *EntityOutputManager::NewHook()
   301 {
   302 	omg_hooks *hook;
   303 
   304 	if (FreeHooks.empty())
   305 	{
   306 		hook = new omg_hooks;
   307 	}
   308 	else
   309 	{
   310 		hook = g_OutputManager.FreeHooks.front();
   311 		g_OutputManager.FreeHooks.pop();
   312 	}
   313 
   314 	return hook;
   315 }
   316 
   317 void EntityOutputManager::OnHookAdded()
   318 {
   319 	HookCount++;
   320 
   321 	if (HookCount == 1)
   322 	{
   323 		// This is the first hook created
   324 		InitFireEventDetour();
   325 	}
   326 }
   327 
   328 void EntityOutputManager::OnHookRemoved()
   329 {
   330 	HookCount--;
   331 
   332 	if (HookCount == 0)
   333 	{
   334 		ShutdownFireEventDetour();
   335 	}
   336 }
   337 
   338 void EntityOutputManager::CleanUpHook(omg_hooks *hook)
   339 {
   340 	FreeHooks.push(hook);
   341 
   342 	OnHookRemoved();
   343 
   344 	IPlugin *pPlugin = plsys->FindPluginByContext(hook->pf->GetParentContext()->GetContext());
   345 	SourceHook::List<omg_hooks *> *pList = NULL;
   346 
   347 	if (!pPlugin->GetProperty("OutputHookList", (void **)&pList, false) || !pList)
   348 	{
   349 		return;
   350 	}
   351 
   352 	SourceHook::List<omg_hooks *>::iterator p_iter = pList->begin();
   353 
   354 	omg_hooks *pluginHook;
   355 
   356 	while (p_iter != pList->end())
   357 	{
   358 		pluginHook = (omg_hooks *)*p_iter;
   359 		if (pluginHook == hook)
   360 		{
   361 			p_iter = pList->erase(p_iter);
   362 		}
   363 		else
   364 		{
   365 			p_iter++;
   366 		}
   367 	}
   368 }
   369 
   370 void EntityOutputManager::OnPluginDestroyed(IPlugin *plugin)
   371 {
   372 	SourceHook::List<omg_hooks *> *pList = NULL;
   373 
   374 	if (plugin->GetProperty("OutputHookList", (void **)&pList, true))
   375 	{
   376 		SourceHook::List<omg_hooks *>::iterator p_iter = pList->begin();
   377 		omg_hooks *hook;
   378 
   379 		while (p_iter != pList->end())
   380 		{
   381 			hook = (omg_hooks *)*p_iter;
   382 		
   383 			p_iter = pList->erase(p_iter); //remove from this plugins list
   384 			hook->m_parent->hooks.remove(hook); // remove from the y's list
   385 
   386 			FreeHooks.push(hook); //save the omg_hook
   387 
   388 			OnHookRemoved();
   389 		}		
   390 	}
   391 }
   392 
   393 OutputNameStruct *EntityOutputManager::FindOutputPointer(const char *classname, const char *outputname, bool create)
   394 {
   395 	ClassNameStruct *pClassname;
   396 	
   397 	if (!ClassNames->Retrieve(classname, (void **)&pClassname))
   398 	{
   399 		if (create)
   400 		{
   401 			pClassname = new ClassNameStruct;
   402 			ClassNames->Insert(classname, pClassname);
   403 		}
   404 		else
   405 		{
   406 			return NULL;
   407 		}
   408 	}
   409 
   410 	OutputNameStruct *pOutputName;
   411 
   412 	if (!pClassname->OutputList->Retrieve(outputname, (void **)&pOutputName))
   413 	{
   414 		if (create)
   415 		{
   416 			pOutputName = new OutputNameStruct;
   417 			pClassname->OutputList->Insert(outputname, pOutputName);
   418 			strncpy(pOutputName->Name, outputname, sizeof(pOutputName->Name));
   419 			pOutputName->Name[49] = 0;
   420 		}
   421 		else
   422 		{
   423 			return NULL;
   424 		}
   425 	}
   426 
   427 	return pOutputName;
   428 }
   429 
   430 // Iterate the datamap of pCaller and look for output pointers with the same address as pOutput
   431 const char *EntityOutputManager::FindOutputName(void *pOutput, CBaseEntity *pCaller)
   432 {
   433 	datamap_t *pMap = gamehelpers->GetDataMap(pCaller);
   434 
   435 	while (pMap)
   436 	{
   437 		for (int i=0; i<pMap->dataNumFields; i++)
   438 		{
   439 			if (pMap->dataDesc[i].flags & FTYPEDESC_OUTPUT)
   440 			{
   441 				if ((char *)pCaller + pMap->dataDesc[i].fieldOffset[0] == pOutput)
   442 				{
   443 					return pMap->dataDesc[i].externalName;
   444 				}
   445 			}
   446 		}
   447 		pMap = pMap->baseMap;
   448 	}
   449 
   450 	return NULL;
   451 }
   452 
   453 // Thanks SM core
   454 edict_t *EntityOutputManager::BaseHandleToEdict(CBaseHandle &hndl)
   455 {
   456 	if (!hndl.IsValid())
   457 	{
   458 		return NULL;
   459 	}
   460 
   461 	int index = hndl.GetEntryIndex();
   462 
   463 	edict_t *pStoredEdict;
   464 
   465 	pStoredEdict = engine->PEntityOfEntIndex(index);
   466 
   467 	if (pStoredEdict == NULL)
   468 	{
   469 		return NULL;
   470 	}
   471 
   472 	IServerEntity *pSE = pStoredEdict->GetIServerEntity();
   473 
   474 	if (pSE == NULL)
   475 	{
   476 		return NULL;
   477 	}
   478 
   479 	if (pSE->GetRefEHandle() != hndl)
   480 	{
   481 		return NULL;
   482 	}
   483 
   484 	return pStoredEdict;
   485 }