core/smn_timers.cpp
author David Anderson <dvander@alliedmods.net>
Sun Jul 06 04:49:55 2008 +0000 (2008-07-06)
branchrefac-jit
changeset 2168 c24a6fa957db
permissions -rw-r--r--
jit refactoring branch
dvander@2168
     1
/**
dvander@2168
     2
 * vim: set ts=4 :
dvander@2168
     3
 * =============================================================================
dvander@2168
     4
 * SourceMod
dvander@2168
     5
 * Copyright (C) 2004-2008 AlliedModders LLC.  All rights reserved.
dvander@2168
     6
 * =============================================================================
dvander@2168
     7
 *
dvander@2168
     8
 * This program is free software; you can redistribute it and/or modify it under
dvander@2168
     9
 * the terms of the GNU General Public License, version 3.0, as published by the
dvander@2168
    10
 * Free Software Foundation.
dvander@2168
    11
 * 
dvander@2168
    12
 * This program is distributed in the hope that it will be useful, but WITHOUT
dvander@2168
    13
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
dvander@2168
    14
 * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
dvander@2168
    15
 * details.
dvander@2168
    16
 *
dvander@2168
    17
 * You should have received a copy of the GNU General Public License along with
dvander@2168
    18
 * this program.  If not, see <http://www.gnu.org/licenses/>.
dvander@2168
    19
 *
dvander@2168
    20
 * As a special exception, AlliedModders LLC gives you permission to link the
dvander@2168
    21
 * code of this program (as well as its derivative works) to "Half-Life 2," the
dvander@2168
    22
 * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
dvander@2168
    23
 * by the Valve Corporation.  You must obey the GNU General Public License in
dvander@2168
    24
 * all respects for all other code used.  Additionally, AlliedModders LLC grants
dvander@2168
    25
 * this exception to all derivative works.  AlliedModders LLC defines further
dvander@2168
    26
 * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
dvander@2168
    27
 * or <http://www.sourcemod.net/license.php>.
dvander@2168
    28
 *
dvander@2168
    29
 * Version: $Id$
dvander@2168
    30
 */
dvander@2168
    31
dvander@2168
    32
#include "HandleSys.h"
dvander@2168
    33
#include "TimerSys.h"
dvander@2168
    34
#include "PluginSys.h"
dvander@2168
    35
#include "Logger.h"
dvander@2168
    36
#include "DebugReporter.h"
dvander@2168
    37
dvander@2168
    38
#define TIMER_HNDL_CLOSE	(1<<9)
dvander@2168
    39
dvander@2168
    40
HandleType_t g_TimerType;
dvander@2168
    41
dvander@2168
    42
struct TimerInfo 
dvander@2168
    43
{
dvander@2168
    44
	ITimer *Timer;
dvander@2168
    45
	IPluginFunction *Hook;
dvander@2168
    46
	IPluginContext *pContext;
dvander@2168
    47
	Handle_t TimerHandle;
dvander@2168
    48
	int UserData;
dvander@2168
    49
	int Flags;
dvander@2168
    50
};
dvander@2168
    51
dvander@2168
    52
class TimerNatives :
dvander@2168
    53
	public SMGlobalClass,
dvander@2168
    54
	public IHandleTypeDispatch,
dvander@2168
    55
	public ITimedEvent
dvander@2168
    56
{
dvander@2168
    57
public:
dvander@2168
    58
	~TimerNatives();
dvander@2168
    59
public: //ITimedEvent
dvander@2168
    60
	ResultType OnTimer(ITimer *pTimer, void *pData);
dvander@2168
    61
	void OnTimerEnd(ITimer *pTimer, void *pData);
dvander@2168
    62
public: //IHandleTypeDispatch
dvander@2168
    63
	void OnHandleDestroy(HandleType_t type, void *object);
dvander@2168
    64
public: //SMGlobalClass
dvander@2168
    65
	void OnSourceModAllInitialized();
dvander@2168
    66
	void OnSourceModShutdown();
dvander@2168
    67
public:
dvander@2168
    68
	TimerInfo *CreateTimerInfo();
dvander@2168
    69
	void DeleteTimerInfo(TimerInfo *pInfo);
dvander@2168
    70
private:
dvander@2168
    71
	CStack<TimerInfo *> m_FreeTimers;
dvander@2168
    72
};
dvander@2168
    73
dvander@2168
    74
TimerNatives::~TimerNatives()
dvander@2168
    75
{
dvander@2168
    76
	CStack<TimerInfo *>::iterator iter;
dvander@2168
    77
	for (iter=m_FreeTimers.begin(); iter!=m_FreeTimers.end(); iter++)
dvander@2168
    78
	{
dvander@2168
    79
		delete (*iter);
dvander@2168
    80
	}
dvander@2168
    81
	m_FreeTimers.popall();
dvander@2168
    82
}
dvander@2168
    83
dvander@2168
    84
void TimerNatives::OnSourceModAllInitialized()
dvander@2168
    85
{
dvander@2168
    86
	HandleAccess sec;
dvander@2168
    87
dvander@2168
    88
	g_HandleSys.InitAccessDefaults(NULL, &sec);
dvander@2168
    89
	sec.access[HandleAccess_Clone] = HANDLE_RESTRICT_IDENTITY;
dvander@2168
    90
dvander@2168
    91
	g_TimerType = g_HandleSys.CreateType("Timer", this, 0, NULL, &sec, g_pCoreIdent, NULL);
dvander@2168
    92
}
dvander@2168
    93
dvander@2168
    94
void TimerNatives::OnSourceModShutdown()
dvander@2168
    95
{
dvander@2168
    96
	g_HandleSys.RemoveType(g_TimerType, g_pCoreIdent);
dvander@2168
    97
	g_TimerType = 0;
dvander@2168
    98
}
dvander@2168
    99
dvander@2168
   100
void TimerNatives::OnHandleDestroy(HandleType_t type, void *object)
dvander@2168
   101
{
dvander@2168
   102
	TimerInfo *pTimer = reinterpret_cast<TimerInfo *>(object);
dvander@2168
   103
dvander@2168
   104
	g_Timers.KillTimer(pTimer->Timer);
dvander@2168
   105
}
dvander@2168
   106
dvander@2168
   107
TimerInfo *TimerNatives::CreateTimerInfo()
dvander@2168
   108
{
dvander@2168
   109
	TimerInfo *pInfo;
dvander@2168
   110
dvander@2168
   111
	if (m_FreeTimers.empty())
dvander@2168
   112
	{
dvander@2168
   113
		pInfo = new TimerInfo;
dvander@2168
   114
	} else {
dvander@2168
   115
		pInfo = m_FreeTimers.front();
dvander@2168
   116
		m_FreeTimers.pop();
dvander@2168
   117
	}
dvander@2168
   118
dvander@2168
   119
	return pInfo;
dvander@2168
   120
}
dvander@2168
   121
dvander@2168
   122
void TimerNatives::DeleteTimerInfo(TimerInfo *pInfo)
dvander@2168
   123
{
dvander@2168
   124
	m_FreeTimers.push(pInfo);
dvander@2168
   125
}
dvander@2168
   126
dvander@2168
   127
ResultType TimerNatives::OnTimer(ITimer *pTimer, void *pData)
dvander@2168
   128
{
dvander@2168
   129
	TimerInfo *pInfo = reinterpret_cast<TimerInfo *>(pData);
dvander@2168
   130
	IPluginFunction *pFunc = pInfo->Hook;
dvander@2168
   131
	cell_t res = static_cast<ResultType>(Pl_Continue);
dvander@2168
   132
dvander@2168
   133
	pFunc->PushCell(pInfo->TimerHandle);
dvander@2168
   134
	pFunc->PushCell(pInfo->UserData);
dvander@2168
   135
	pFunc->Execute(&res);
dvander@2168
   136
dvander@2168
   137
	return static_cast<ResultType>(res);
dvander@2168
   138
}
dvander@2168
   139
dvander@2168
   140
void TimerNatives::OnTimerEnd(ITimer *pTimer, void *pData)
dvander@2168
   141
{
dvander@2168
   142
	HandleSecurity sec;
dvander@2168
   143
	HandleError herr;
dvander@2168
   144
	TimerInfo *pInfo = reinterpret_cast<TimerInfo *>(pData);
dvander@2168
   145
	Handle_t usrhndl = static_cast<Handle_t>(pInfo->UserData);
dvander@2168
   146
dvander@2168
   147
	sec.pOwner = pInfo->pContext->GetIdentity();
dvander@2168
   148
	sec.pIdentity = g_pCoreIdent;
dvander@2168
   149
dvander@2168
   150
	if (pInfo->Flags & TIMER_HNDL_CLOSE)
dvander@2168
   151
	{
dvander@2168
   152
		if ((herr=g_HandleSys.FreeHandle(usrhndl, &sec)) != HandleError_None)
dvander@2168
   153
		{
dvander@2168
   154
			g_DbgReporter.GenerateError(pInfo->pContext,
dvander@2168
   155
										pInfo->Hook->GetFunctionID(), 
dvander@2168
   156
										SP_ERROR_NATIVE, 
dvander@2168
   157
										"Invalid data handle %x (error %d) passed during timer end",
dvander@2168
   158
										usrhndl, 
dvander@2168
   159
										herr);
dvander@2168
   160
		}
dvander@2168
   161
	}
dvander@2168
   162
dvander@2168
   163
	if ((herr=g_HandleSys.FreeHandle(pInfo->TimerHandle, &sec)) != HandleError_None)
dvander@2168
   164
	{
dvander@2168
   165
		g_DbgReporter.GenerateError(pInfo->pContext, 
dvander@2168
   166
									pInfo->Hook->GetFunctionID(), 
dvander@2168
   167
									SP_ERROR_NATIVE, 
dvander@2168
   168
									"Invalid timer handle %x (error %d) during timer end, displayed function is timer callback, not the stack trace", 
dvander@2168
   169
									pInfo->TimerHandle, 
dvander@2168
   170
									herr);
dvander@2168
   171
		return;
dvander@2168
   172
	}
dvander@2168
   173
	DeleteTimerInfo(pInfo);
dvander@2168
   174
}
dvander@2168
   175
dvander@2168
   176
/*******************************
dvander@2168
   177
*                              *
dvander@2168
   178
* TIMER NATIVE IMPLEMENTATIONS *
dvander@2168
   179
*                              *
dvander@2168
   180
********************************/
dvander@2168
   181
dvander@2168
   182
static TimerNatives s_TimerNatives;
dvander@2168
   183
dvander@2168
   184
static cell_t smn_CreateTimer(IPluginContext *pCtx, const cell_t *params)
dvander@2168
   185
{
dvander@2168
   186
	IPluginFunction *pFunc;
dvander@2168
   187
	TimerInfo *pInfo;
dvander@2168
   188
	ITimer *pTimer;
dvander@2168
   189
	Handle_t hndl;
dvander@2168
   190
	int flags = params[4];
dvander@2168
   191
dvander@2168
   192
	pFunc = pCtx->GetFunctionById(params[2]);
dvander@2168
   193
	if (!pFunc)
dvander@2168
   194
	{
dvander@2168
   195
		return pCtx->ThrowNativeError("Invalid function id (%X)", params[2]);
dvander@2168
   196
	}
dvander@2168
   197
dvander@2168
   198
	pInfo = s_TimerNatives.CreateTimerInfo();
dvander@2168
   199
	pTimer = g_Timers.CreateTimer(&s_TimerNatives, sp_ctof(params[1]), pInfo, flags);
dvander@2168
   200
dvander@2168
   201
	if (!pTimer)
dvander@2168
   202
	{
dvander@2168
   203
		s_TimerNatives.DeleteTimerInfo(pInfo);
dvander@2168
   204
		return 0;
dvander@2168
   205
	}
dvander@2168
   206
dvander@2168
   207
	hndl = g_HandleSys.CreateHandle(g_TimerType, pInfo, pCtx->GetIdentity(), g_pCoreIdent, NULL);
dvander@2168
   208
dvander@2168
   209
	pInfo->UserData = params[3];
dvander@2168
   210
	pInfo->Flags = flags;
dvander@2168
   211
	pInfo->TimerHandle = hndl;
dvander@2168
   212
	pInfo->Hook = pFunc;
dvander@2168
   213
	pInfo->Timer = pTimer;
dvander@2168
   214
	pInfo->pContext = pCtx;
dvander@2168
   215
dvander@2168
   216
	return hndl;
dvander@2168
   217
}
dvander@2168
   218
dvander@2168
   219
static cell_t smn_KillTimer(IPluginContext *pCtx, const cell_t *params)
dvander@2168
   220
{
dvander@2168
   221
	Handle_t hndl = static_cast<Handle_t>(params[1]);
dvander@2168
   222
	HandleError herr;
dvander@2168
   223
	HandleSecurity sec;
dvander@2168
   224
	TimerInfo *pInfo;
dvander@2168
   225
dvander@2168
   226
	sec.pOwner = pCtx->GetIdentity();
dvander@2168
   227
	sec.pIdentity = g_pCoreIdent;
dvander@2168
   228
dvander@2168
   229
	if ((herr=g_HandleSys.ReadHandle(hndl, g_TimerType, &sec, (void **)&pInfo))
dvander@2168
   230
		!= HandleError_None)
dvander@2168
   231
	{
dvander@2168
   232
		return pCtx->ThrowNativeError("Invalid timer handle %x (error %d)", hndl, herr);
dvander@2168
   233
	}
dvander@2168
   234
dvander@2168
   235
	g_Timers.KillTimer(pInfo->Timer);
dvander@2168
   236
dvander@2168
   237
	if (params[2] && !(pInfo->Flags & TIMER_HNDL_CLOSE))
dvander@2168
   238
	{
dvander@2168
   239
		sec.pOwner = pInfo->pContext->GetIdentity();
dvander@2168
   240
		sec.pIdentity = g_pCoreIdent;
dvander@2168
   241
dvander@2168
   242
		if ((herr=g_HandleSys.FreeHandle(static_cast<Handle_t>(pInfo->UserData), &sec)) != HandleError_None)
dvander@2168
   243
		{
dvander@2168
   244
			return pCtx->ThrowNativeError("Invalid data handle %x (error %d)", hndl, herr);
dvander@2168
   245
		}
dvander@2168
   246
	}
dvander@2168
   247
dvander@2168
   248
	return 1;
dvander@2168
   249
}
dvander@2168
   250
dvander@2168
   251
static cell_t smn_TriggerTimer(IPluginContext *pCtx, const cell_t *params)
dvander@2168
   252
{
dvander@2168
   253
	Handle_t hndl = static_cast<Handle_t>(params[1]);
dvander@2168
   254
	HandleError herr;
dvander@2168
   255
	HandleSecurity sec;
dvander@2168
   256
	TimerInfo *pInfo;
dvander@2168
   257
dvander@2168
   258
	sec.pOwner = pCtx->GetIdentity();
dvander@2168
   259
	sec.pIdentity = g_pCoreIdent;
dvander@2168
   260
dvander@2168
   261
	if ((herr=g_HandleSys.ReadHandle(hndl, g_TimerType, &sec, (void **)&pInfo))
dvander@2168
   262
		!= HandleError_None)
dvander@2168
   263
	{
dvander@2168
   264
		return pCtx->ThrowNativeError("Invalid timer handle %x (error %d)", hndl, herr);
dvander@2168
   265
	}
dvander@2168
   266
dvander@2168
   267
	g_Timers.FireTimerOnce(pInfo->Timer, params[2] ? true : false);
dvander@2168
   268
dvander@2168
   269
	return 1;
dvander@2168
   270
}
dvander@2168
   271
dvander@2168
   272
static cell_t smn_GetTickedTime(IPluginContext *pContext, const cell_t *params)
dvander@2168
   273
{
dvander@2168
   274
	return sp_ftoc(*g_pUniversalTime);
dvander@2168
   275
}
dvander@2168
   276
dvander@2168
   277
static cell_t smn_GetMapTimeLeft(IPluginContext *pContext, const cell_t *params)
dvander@2168
   278
{
dvander@2168
   279
	float time_left;
dvander@2168
   280
	if (!g_Timers.GetMapTimeLeft(&time_left))
dvander@2168
   281
	{
dvander@2168
   282
		return 0;
dvander@2168
   283
	}
dvander@2168
   284
dvander@2168
   285
	cell_t *addr;
dvander@2168
   286
	pContext->LocalToPhysAddr(params[1], &addr);
dvander@2168
   287
	*addr = (int)time_left;
dvander@2168
   288
dvander@2168
   289
	return 1;
dvander@2168
   290
}
dvander@2168
   291
dvander@2168
   292
static cell_t smn_GetMapTimeLimit(IPluginContext *pContext, const cell_t *params)
dvander@2168
   293
{
dvander@2168
   294
	IMapTimer *pMapTimer = g_Timers.GetMapTimer();
dvander@2168
   295
dvander@2168
   296
	if (!pMapTimer)
dvander@2168
   297
	{
dvander@2168
   298
		return 0;
dvander@2168
   299
	}
dvander@2168
   300
dvander@2168
   301
	cell_t *addr;
dvander@2168
   302
	pContext->LocalToPhysAddr(params[1], &addr);
dvander@2168
   303
dvander@2168
   304
	*addr = pMapTimer->GetMapTimeLimit();
dvander@2168
   305
dvander@2168
   306
	return 1;
dvander@2168
   307
}
dvander@2168
   308
dvander@2168
   309
static cell_t smn_ExtendMapTimeLimit(IPluginContext *pContext, const cell_t *params)
dvander@2168
   310
{
dvander@2168
   311
	IMapTimer *pMapTimer = g_Timers.GetMapTimer();
dvander@2168
   312
dvander@2168
   313
	if (!pMapTimer)
dvander@2168
   314
	{
dvander@2168
   315
		return 0;
dvander@2168
   316
	}
dvander@2168
   317
dvander@2168
   318
	pMapTimer->ExtendMapTimeLimit(params[1]);
dvander@2168
   319
dvander@2168
   320
	return 1;
dvander@2168
   321
}
dvander@2168
   322
dvander@2168
   323
static cell_t smn_IsServerProcessing(IPluginContext *pContext, const cell_t *params)
dvander@2168
   324
{
dvander@2168
   325
	return (gpGlobals->frametime > 0.0f) ? 1 : 0;
dvander@2168
   326
}
dvander@2168
   327
dvander@2168
   328
static cell_t smn_GetTickInterval(IPluginContext *pContext, const cell_t *params)
dvander@2168
   329
{
dvander@2168
   330
	return sp_ftoc(gpGlobals->interval_per_tick);
dvander@2168
   331
}
dvander@2168
   332
dvander@2168
   333
REGISTER_NATIVES(timernatives)
dvander@2168
   334
{
dvander@2168
   335
	{"CreateTimer",				smn_CreateTimer},
dvander@2168
   336
	{"KillTimer",				smn_KillTimer},
dvander@2168
   337
	{"TriggerTimer",			smn_TriggerTimer},
dvander@2168
   338
	{"GetTickedTime",			smn_GetTickedTime},
dvander@2168
   339
	{"GetMapTimeLeft",			smn_GetMapTimeLeft},
dvander@2168
   340
	{"GetMapTimeLimit",			smn_GetMapTimeLimit},
dvander@2168
   341
	{"ExtendMapTimeLimit",		smn_ExtendMapTimeLimit},
dvander@2168
   342
	{"IsServerProcessing",		smn_IsServerProcessing},
dvander@2168
   343
	{"GetTickInterval",			smn_GetTickInterval},
dvander@2168
   344
	{NULL,						NULL}
dvander@2168
   345
};
dvander@2168
   346