core/sourcemod.cpp
author Borja Ferrer <faluco@alliedmods.net>
Sun Feb 04 22:41:44 2007 +0000 (2007-02-04)
changeset 430 ed37e9767ed4
parent 422 5ef0f5610c2a
child 438 e6e11c82d87e
permissions -rw-r--r--
Optimized forwards, now paused functions are stored in a temp list so we dont have to check if they're runnable on each function execution.
dvander@370
     1
/**
dvander@370
     2
 * ===============================================================
dvander@370
     3
 * SourceMod (C)2004-2007 AlliedModders LLC.  All rights reserved.
dvander@370
     4
 * ===============================================================
dvander@370
     5
 *
dvander@370
     6
 * This file is not open source and may not be copied without explicit
dvander@370
     7
 * written permission of AlliedModders LLC.  This file may not be redistributed 
dvander@370
     8
 * in whole or significant part.
dvander@370
     9
 * For information, see LICENSE.txt or http://www.sourcemod.net/license.php
dvander@370
    10
 *
dvander@370
    11
 * Version: $Id$
dvander@370
    12
 */
dvander@370
    13
dvander@160
    14
#include <stdio.h>
dvander@160
    15
#include "sourcemod.h"
dvander@160
    16
#include "sourcemm_api.h"
dvander@160
    17
#include "systems/LibrarySys.h"
dvander@160
    18
#include "vm/sp_vm_engine.h"
dvander@160
    19
#include <sh_string.h>
dvander@176
    20
#include "PluginSys.h"
dvander@252
    21
#include "ShareSys.h"
faluco@281
    22
#include "CLogger.h"
dvander@315
    23
#include "ExtensionSys.h"
dvander@340
    24
#include "AdminCache.h"
dvander@347
    25
#include "sm_stringutil.h"
dvander@160
    26
dvander@209
    27
SH_DECL_HOOK6(IServerGameDLL, LevelInit, SH_NOATTRIB, false, bool, const char *, const char *, const char *, const char *, bool, bool);
faluco@333
    28
SH_DECL_HOOK0_void(IServerGameDLL, LevelShutdown, SH_NOATTRIB, false);
dvander@209
    29
dvander@160
    30
SourcePawnEngine g_SourcePawn;
dvander@160
    31
SourceModBase g_SourceMod;
dvander@160
    32
dvander@160
    33
ILibrary *g_pJIT = NULL;
dvander@160
    34
SourceHook::String g_BaseDir;
dvander@160
    35
ISourcePawnEngine *g_pSourcePawn = &g_SourcePawn;
dvander@160
    36
IVirtualMachine *g_pVM;
dvander@252
    37
IdentityToken_t *g_pCoreIdent = NULL;
dvander@160
    38
dvander@160
    39
typedef int (*GIVEENGINEPOINTER)(ISourcePawnEngine *);
dvander@160
    40
typedef unsigned int (*GETEXPORTCOUNT)();
dvander@160
    41
typedef IVirtualMachine *(*GETEXPORT)(unsigned int);
dvander@160
    42
typedef void (*NOTIFYSHUTDOWN)();
dvander@160
    43
dvander@160
    44
void ShutdownJIT()
dvander@160
    45
{
dvander@160
    46
	NOTIFYSHUTDOWN notify = (NOTIFYSHUTDOWN)g_pJIT->GetSymbolAddress("NotifyShutdown");
dvander@160
    47
	if (notify)
dvander@160
    48
	{
dvander@160
    49
		notify();
dvander@160
    50
	}
dvander@160
    51
dvander@160
    52
	g_pJIT->CloseLibrary();
dvander@160
    53
}
dvander@160
    54
dvander@209
    55
SourceModBase::SourceModBase()
dvander@209
    56
{
dvander@209
    57
	m_IsMapLoading = false;
faluco@333
    58
	m_ExecPluginReload = false;
dvander@209
    59
}
dvander@209
    60
dvander@160
    61
bool SourceModBase::InitializeSourceMod(char *error, size_t err_max, bool late)
dvander@160
    62
{
dvander@160
    63
	g_BaseDir.assign(g_SMAPI->GetBaseDir());
dvander@209
    64
	g_LibSys.PathFormat(m_SMBaseDir, sizeof(m_SMBaseDir), "%s/addons/sourcemod", g_BaseDir.c_str());
dvander@345
    65
	g_LibSys.PathFormat(m_SMRelDir, sizeof(m_SMRelDir), "addons/sourcemod");
dvander@160
    66
dvander@160
    67
	/* Attempt to load the JIT! */
dvander@160
    68
	char file[PLATFORM_MAX_PATH];
dvander@160
    69
	char myerror[255];
dvander@209
    70
	g_SMAPI->PathFormat(file, sizeof(file), "%s/bin/sourcepawn.jit.x86.%s",
dvander@317
    71
		GetSourceModPath(),
dvander@160
    72
		PLATFORM_LIB_EXT
dvander@160
    73
		);
dvander@160
    74
dvander@160
    75
	g_pJIT = g_LibSys.OpenLibrary(file, myerror, sizeof(myerror));
dvander@160
    76
	if (!g_pJIT)
dvander@160
    77
	{
dvander@160
    78
		if (error && err_max)
dvander@160
    79
		{
dvander@160
    80
			snprintf(error, err_max, "%s (failed to load bin/sourcepawn.jit.x86.%s)", 
dvander@160
    81
				myerror,
dvander@160
    82
				PLATFORM_LIB_EXT);
dvander@160
    83
		}
dvander@160
    84
		return false;
dvander@160
    85
	}
dvander@160
    86
dvander@160
    87
	int err;
dvander@160
    88
	GIVEENGINEPOINTER jit_init = (GIVEENGINEPOINTER)g_pJIT->GetSymbolAddress("GiveEnginePointer");
dvander@160
    89
	if (!jit_init)
dvander@160
    90
	{
dvander@160
    91
		ShutdownJIT();
dvander@160
    92
		if (error && err_max)
dvander@160
    93
		{
dvander@160
    94
			snprintf(error, err_max, "Failed to find GiveEnginePointer in JIT!");
dvander@160
    95
		}
dvander@160
    96
		return false;
dvander@160
    97
	}
dvander@160
    98
dvander@160
    99
	if ((err=jit_init(g_pSourcePawn)) != 0)
dvander@160
   100
	{
dvander@160
   101
		ShutdownJIT();
dvander@160
   102
		if (error && err_max)
dvander@160
   103
		{
dvander@160
   104
			snprintf(error, err_max, "GiveEnginePointer returned %d in the JIT", err);
dvander@160
   105
		}
dvander@160
   106
		return false;
dvander@160
   107
	}
dvander@160
   108
dvander@160
   109
	GETEXPORTCOUNT jit_getnum = (GETEXPORTCOUNT)g_pJIT->GetSymbolAddress("GetExportCount");
dvander@160
   110
	GETEXPORT jit_get = (GETEXPORT)g_pJIT->GetSymbolAddress("GetExport");
dvander@160
   111
	if (!jit_get)
dvander@160
   112
	{
dvander@160
   113
		ShutdownJIT();
dvander@160
   114
		if (error && err_max)
dvander@160
   115
		{
dvander@160
   116
			snprintf(error, err_max, "JIT is missing a necessary export!");
dvander@160
   117
		}
dvander@160
   118
		return false;
dvander@160
   119
	}
dvander@160
   120
dvander@160
   121
	unsigned int num = jit_getnum();
dvander@160
   122
	if (!num || ((g_pVM=jit_get(0)) == NULL))
dvander@160
   123
	{
dvander@160
   124
		ShutdownJIT();
dvander@160
   125
		if (error && err_max)
dvander@160
   126
		{
dvander@160
   127
			snprintf(error, err_max, "JIT did not export any virtual machines!");
dvander@160
   128
		}
dvander@160
   129
		return false;
dvander@160
   130
	}
dvander@160
   131
dvander@176
   132
	unsigned int api = g_pVM->GetAPIVersion();
dvander@176
   133
	if (api != SOURCEPAWN_VM_API_VERSION)
dvander@176
   134
	{
dvander@176
   135
		ShutdownJIT();
dvander@176
   136
		if (error && err_max)
dvander@176
   137
		{
dvander@176
   138
			snprintf(error, err_max, "JIT is not a compatible version");
dvander@176
   139
		}
dvander@176
   140
		return false;
dvander@176
   141
	}
dvander@176
   142
dvander@209
   143
	StartSourceMod(late);
dvander@176
   144
dvander@160
   145
	return true;
dvander@160
   146
}
dvander@209
   147
dvander@209
   148
void SourceModBase::StartSourceMod(bool late)
dvander@209
   149
{
dvander@209
   150
	/* First initialize the global hooks we need */
dvander@209
   151
	SH_ADD_HOOK_MEMFUNC(IServerGameDLL, LevelInit, gamedll, this, &SourceModBase::LevelInit, false);
faluco@333
   152
	SH_ADD_HOOK_MEMFUNC(IServerGameDLL, LevelShutdown, gamedll, this, &SourceModBase::LevelShutdown, false);
dvander@209
   153
dvander@214
   154
	/* Notify! */
dvander@214
   155
	SMGlobalClass *pBase = SMGlobalClass::head;
dvander@214
   156
	while (pBase)
dvander@214
   157
	{
dvander@315
   158
		pBase->OnSourceModStartup(false);
dvander@214
   159
		pBase = pBase->m_pGlobalClassNext;
dvander@214
   160
	}
dvander@214
   161
dvander@252
   162
	/* Make the global core identity */
dvander@252
   163
	g_pCoreIdent = g_ShareSys.CreateCoreIdentity();
dvander@252
   164
dvander@214
   165
	/* Notify! */
dvander@214
   166
	pBase = SMGlobalClass::head;
dvander@214
   167
	while (pBase)
dvander@214
   168
	{
dvander@214
   169
		pBase->OnSourceModAllInitialized();
dvander@214
   170
		pBase = pBase->m_pGlobalClassNext;
dvander@214
   171
	}
dvander@317
   172
dvander@317
   173
	/* Add us now... */
dvander@317
   174
	g_ShareSys.AddInterface(NULL, this);
dvander@209
   175
}
dvander@209
   176
dvander@209
   177
bool SourceModBase::LevelInit(char const *pMapName, char const *pMapEntities, char const *pOldLevel, char const *pLandmarkName, bool loadGame, bool background)
dvander@209
   178
{
dvander@209
   179
	m_IsMapLoading = true;
faluco@333
   180
	m_ExecPluginReload = true;
dvander@209
   181
faluco@281
   182
	g_Logger.MapChange(pMapName);
faluco@281
   183
dvander@209
   184
	DoGlobalPluginLoads();
dvander@209
   185
dvander@209
   186
	m_IsMapLoading = false;
dvander@209
   187
dvander@340
   188
	g_Admins.DumpAdminCache(ADMIN_CACHE_GROUPS|ADMIN_CACHE_ADMINS|ADMIN_CACHE_OVERRIDES, true);
dvander@340
   189
dvander@209
   190
	RETURN_META_VALUE(MRES_IGNORED, true);
dvander@209
   191
}
dvander@209
   192
faluco@333
   193
void SourceModBase::LevelShutdown()
faluco@333
   194
{
faluco@333
   195
	if (m_ExecPluginReload)
faluco@333
   196
	{
faluco@333
   197
		g_PluginSys.ReloadOrUnloadPlugins();
faluco@333
   198
		m_ExecPluginReload = false;
faluco@333
   199
	}
faluco@333
   200
}
faluco@333
   201
dvander@315
   202
bool SourceModBase::IsMapLoading()
dvander@315
   203
{
dvander@315
   204
	return m_IsMapLoading;
dvander@315
   205
}
dvander@315
   206
dvander@209
   207
void SourceModBase::DoGlobalPluginLoads()
dvander@209
   208
{
dvander@209
   209
	char config_path[PLATFORM_MAX_PATH];
dvander@209
   210
	char plugins_path[PLATFORM_MAX_PATH];
dvander@209
   211
dvander@317
   212
	BuildPath(Path_SM, config_path, 
dvander@209
   213
		sizeof(config_path),
dvander@317
   214
		"configs/plugin_settings.cfg");
dvander@317
   215
	BuildPath(Path_SM, plugins_path,
dvander@209
   216
		sizeof(plugins_path),
dvander@317
   217
		"plugins");
dvander@209
   218
dvander@397
   219
	/* Load any auto extensions */
dvander@397
   220
	g_Extensions.TryAutoload();
dvander@397
   221
dvander@315
   222
	/* Run the first pass */
dvander@211
   223
	g_PluginSys.LoadAll_FirstPass(config_path, plugins_path);
dvander@213
   224
dvander@315
   225
	/* Mark any extensions as loaded */
dvander@315
   226
	g_Extensions.MarkAllLoaded();
dvander@315
   227
dvander@213
   228
	/* No modules yet, it's safe to call this from here */
dvander@213
   229
	g_PluginSys.LoadAll_SecondPass();
dvander@315
   230
dvander@315
   231
	/* Re-mark any extensions as loaded */
dvander@315
   232
	g_Extensions.MarkAllLoaded();
dvander@211
   233
}
dvander@211
   234
dvander@317
   235
size_t SourceModBase::BuildPath(PathType type, char *buffer, size_t maxlength, char *format, ...)
dvander@317
   236
{
dvander@317
   237
	char _buffer[PLATFORM_MAX_PATH+1];
dvander@317
   238
	va_list ap;
dvander@317
   239
dvander@317
   240
	va_start(ap, format);
dvander@317
   241
	vsnprintf(_buffer, PLATFORM_MAX_PATH, format, ap);
dvander@317
   242
	va_end(ap);
dvander@317
   243
dvander@317
   244
	const char *base = NULL;
dvander@317
   245
	if (type == Path_Game)
dvander@317
   246
	{
dvander@317
   247
		base = GetModPath();
dvander@317
   248
	} else if (type == Path_SM) {
dvander@317
   249
		base = GetSourceModPath();
dvander@345
   250
	} else if (type == Path_SM_Rel) {
dvander@345
   251
		base = m_SMRelDir;
dvander@317
   252
	}
dvander@317
   253
dvander@317
   254
	if (base)
dvander@317
   255
	{
dvander@317
   256
		return g_LibSys.PathFormat(buffer, maxlength, "%s/%s", base, _buffer);
dvander@317
   257
	} else {
dvander@317
   258
		return g_LibSys.PathFormat(buffer, maxlength, "%s", _buffer);
dvander@317
   259
	}
dvander@317
   260
}
dvander@317
   261
faluco@289
   262
void SourceModBase::CloseSourceMod()
faluco@289
   263
{
faluco@289
   264
	/* Notify! */
faluco@289
   265
	SMGlobalClass *pBase = SMGlobalClass::head;
faluco@289
   266
	while (pBase)
faluco@289
   267
	{
faluco@289
   268
		pBase->OnSourceModShutdown();
faluco@289
   269
		pBase = pBase->m_pGlobalClassNext;
faluco@289
   270
	}
faluco@289
   271
faluco@289
   272
	/* Notify! */
faluco@289
   273
	pBase = SMGlobalClass::head;
faluco@289
   274
	while (pBase)
faluco@289
   275
	{
faluco@289
   276
		pBase->OnSourceModAllShutdown();
faluco@289
   277
		pBase = pBase->m_pGlobalClassNext;
faluco@289
   278
	}
faluco@289
   279
faluco@333
   280
	SH_REMOVE_HOOK_MEMFUNC(IServerGameDLL, LevelInit, gamedll, this, &SourceModBase::LevelInit, false);
faluco@333
   281
	SH_REMOVE_HOOK_MEMFUNC(IServerGameDLL, LevelShutdown, gamedll, this, &SourceModBase::LevelShutdown, false);
faluco@333
   282
faluco@289
   283
	/* Rest In Peace */
faluco@289
   284
	ShutdownJIT();
faluco@289
   285
}
faluco@289
   286
dvander@317
   287
void SourceModBase::LogMessage(IExtension *pExt, const char *format, ...)
dvander@317
   288
{
dvander@317
   289
	IExtensionInterface *pAPI = pExt->GetAPI();
dvander@317
   290
	const char *tag = pAPI->GetExtensionTag();
dvander@317
   291
	char buffer[2048];
dvander@317
   292
	va_list ap;
dvander@317
   293
dvander@317
   294
	va_start(ap, format);
dvander@317
   295
	vsnprintf(buffer, sizeof(buffer), format, ap);
dvander@317
   296
	va_end(ap);
dvander@317
   297
dvander@317
   298
	if (tag)
dvander@317
   299
	{
dvander@317
   300
		g_Logger.LogMessage("[%s] %s", tag, buffer);
dvander@317
   301
	} else {
dvander@317
   302
		g_Logger.LogMessage("%s", buffer);
dvander@317
   303
	}
dvander@317
   304
}
dvander@317
   305
dvander@317
   306
void SourceModBase::LogError(IExtension *pExt, const char *format, ...)
dvander@317
   307
{
dvander@317
   308
	IExtensionInterface *pAPI = pExt->GetAPI();
dvander@317
   309
	const char *tag = pAPI->GetExtensionTag();
dvander@317
   310
	char buffer[2048];
dvander@317
   311
	va_list ap;
dvander@317
   312
dvander@317
   313
	va_start(ap, format);
dvander@317
   314
	vsnprintf(buffer, sizeof(buffer), format, ap);
dvander@317
   315
	va_end(ap);
dvander@317
   316
dvander@317
   317
	if (tag)
dvander@317
   318
	{
dvander@317
   319
		g_Logger.LogError("[%s] %s", tag, buffer);
dvander@317
   320
	} else {
dvander@317
   321
		g_Logger.LogError("%s", buffer);
dvander@317
   322
	}
dvander@317
   323
}
dvander@317
   324
dvander@347
   325
size_t SourceModBase::FormatString(char *buffer, size_t maxlength, IPluginContext *pContext, const cell_t *params, unsigned int param)
dvander@347
   326
{
dvander@347
   327
	char *fmt;
dvander@347
   328
dvander@347
   329
	pContext->LocalToString(params[param], &fmt);
dvander@347
   330
dvander@347
   331
	int lparam = ++param;
dvander@347
   332
dvander@347
   333
	return atcprintf(buffer, maxlength, fmt, pContext, params, &lparam);
dvander@347
   334
}
dvander@347
   335
dvander@317
   336
const char *SourceModBase::GetSourceModPath()
dvander@209
   337
{
dvander@209
   338
	return m_SMBaseDir;
dvander@209
   339
}
dvander@211
   340
dvander@317
   341
const char *SourceModBase::GetModPath()
dvander@255
   342
{
dvander@255
   343
	return g_BaseDir.c_str();
dvander@255
   344
}
dvander@255
   345
faluco@422
   346
void SourceModBase::SetGlobalTarget(unsigned int index)
faluco@422
   347
{
faluco@422
   348
	m_target = index;
faluco@422
   349
}
faluco@422
   350
faluco@422
   351
unsigned int SourceModBase::GetGlobalTarget() const
faluco@422
   352
{
faluco@422
   353
	return m_target;
faluco@422
   354
}
faluco@422
   355
dvander@211
   356
SMGlobalClass *SMGlobalClass::head = NULL;
dvander@211
   357
dvander@211
   358
SMGlobalClass::SMGlobalClass()
dvander@211
   359
{
dvander@211
   360
	m_pGlobalClassNext = SMGlobalClass::head;
dvander@211
   361
	SMGlobalClass::head = this;
dvander@211
   362
}