loader/loader.cpp
author Nicholas Hastings <skamonkey@gmail.com>
Sat Mar 29 14:14:00 2014 -0400 (2014-03-29)
changeset 4301 5a9c242fa868
parent 4144 353e86f4c6ab
permissions -rw-r--r--
Add support for Contagion (bug 6007, r=asherkin).
     1 /**
     2  * vim: set ts=4 sw=4 tw=99 noet :
     3  * =============================================================================
     4  * SourceMod
     5  * Copyright (C) 2004-2010 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 
    30 #include <ISmmPluginExt.h>
    31 #include <stdarg.h>
    32 #include <string.h>
    33 #include <stdio.h>
    34 #include <stdlib.h>
    35 
    36 #if defined _MSC_VER
    37 	#define DLL_EXPORT				extern "C" __declspec(dllexport)
    38 	#define openlib(lib)			LoadLibrary(lib)
    39 	#define closelib(lib)			FreeLibrary(lib)
    40 	#define findsym(lib, sym)		GetProcAddress(lib, sym)
    41 	#define PLATFORM_EXT			".dll"
    42 	#define vsnprintf				_vsnprintf
    43 	#define PATH_SEP_CHAR			"\\"
    44 	inline bool IsPathSepChar(char c) 
    45 	{
    46 		return (c == '/' || c == '\\');
    47 	}
    48 	#include <Windows.h>
    49 #else
    50 	#define DLL_EXPORT				extern "C" __attribute__((visibility("default")))
    51 	#define openlib(lib)			dlopen(lib, RTLD_NOW)
    52 	#define closelib(lib)			dlclose(lib)
    53 	#define findsym(lib, sym)		dlsym(lib, sym)
    54 	#if defined __linux__
    55 	#define PLATFORM_EXT			".so"
    56 	#elif defined __APPLE__
    57 	#define PLATFORM_EXT			".dylib"
    58 	#endif
    59 	typedef void *					HINSTANCE;
    60 	#define PATH_SEP_CHAR			"/"
    61 	inline bool IsPathSepChar(char c) 
    62 	{
    63 		return (c == '/');
    64 	}
    65 	#include <dlfcn.h>
    66 #endif
    67 
    68 #define METAMOD_API_MAJOR			2
    69 #define FILENAME_1_4_EP1			"sourcemod.1.ep1" PLATFORM_EXT
    70 #define FILENAME_1_6_EP2			"sourcemod.2.ep2" PLATFORM_EXT
    71 #define FILENAME_1_6_EP1			"sourcemod.2.ep1" PLATFORM_EXT
    72 #define FILENAME_1_6_L4D			"sourcemod.2.l4d" PLATFORM_EXT
    73 #define FILENAME_1_6_DARKM			"sourcemod.2.darkm" PLATFORM_EXT
    74 #define FILENAME_1_6_L4D2			"sourcemod.2.l4d2" PLATFORM_EXT
    75 #define FILENAME_1_6_SWARM			"sourcemod.2.swarm" PLATFORM_EXT
    76 #define FILENAME_1_6_BGT			"sourcemod.2.bgt" PLATFORM_EXT
    77 #define FILENAME_1_6_EYE			"sourcemod.2.eye" PLATFORM_EXT
    78 #define FILENAME_1_6_PORTAL2		"sourcemod.2.portal2" PLATFORM_EXT
    79 #define FILENAME_1_6_CSGO			"sourcemod.2.csgo" PLATFORM_EXT
    80 #define FILENAME_1_6_CSS			"sourcemod.2.css" PLATFORM_EXT
    81 #define FILENAME_1_6_HL2DM			"sourcemod.2.hl2dm" PLATFORM_EXT
    82 #define FILENAME_1_6_DODS			"sourcemod.2.dods" PLATFORM_EXT
    83 #define FILENAME_1_6_SDK2013		"sourcemod.2.sdk2013" PLATFORM_EXT
    84 #define FILENAME_1_6_TF2			"sourcemod.2.tf2" PLATFORM_EXT
    85 #define FILENAME_1_6_ND				"sourcemod.2.nd" PLATFORM_EXT
    86 #define FILENAME_1_6_DOTA			"sourcemod.2.dota" PLATFORM_EXT
    87 #define FILENAME_1_6_BLADE			"sourcemod.2.blade" PLATFORM_EXT
    88 #define FILENAME_1_6_INSURGENCY		"sourcemod.2.insurgency" PLATFORM_EXT
    89 #define FILENAME_1_6_CONTAGION		"sourcemod.2.contagion" PLATFORM_EXT
    90 
    91 HINSTANCE g_hCore = NULL;
    92 bool load_attempted = false;
    93 
    94 size_t UTIL_Format(char *buffer, size_t maxlength, const char *fmt, ...);
    95 
    96 class FailPlugin : public SourceMM::ISmmFailPlugin
    97 {
    98 public:
    99 	int GetApiVersion()
   100 	{
   101 		return fail_version;
   102 	}
   103 
   104 	bool Load(SourceMM::PluginId id, SourceMM::ISmmAPI *ismm, char *error, size_t maxlength, bool late)
   105 	{
   106 		if (error != NULL && maxlength != 0)
   107 		{
   108 			UTIL_Format(error, maxlength, "%s", error_buffer);
   109 		}
   110 		return false;
   111 	}
   112 
   113 	int fail_version;
   114 	char error_buffer[512];
   115 } s_FailPlugin;
   116 
   117 size_t UTIL_Format(char *buffer, size_t maxlength, const char *fmt, ...)
   118 {
   119 	va_list ap;
   120 
   121 	va_start(ap, fmt);
   122 	size_t len = vsnprintf(buffer, maxlength, fmt, ap);
   123 	va_end(ap);
   124 
   125 	if (len >= maxlength)
   126 	{
   127 		len = maxlength - 1;
   128 		buffer[len] = '\0';
   129 	}
   130 
   131 	return len;
   132 }
   133 
   134 METAMOD_PLUGIN *_GetPluginPtr(const char *path, int fail_api)
   135 {
   136 	METAMOD_FN_ORIG_LOAD fn;
   137 	METAMOD_PLUGIN *pl;
   138 	int ret;
   139 
   140 	if (!(g_hCore=openlib(path)))
   141 	{
   142 #if defined __linux__ || defined __APPLE__
   143 		UTIL_Format(s_FailPlugin.error_buffer, 
   144 			sizeof(s_FailPlugin.error_buffer),
   145 			"%s",
   146 			dlerror());
   147 #else
   148 		DWORD err = GetLastError();
   149 
   150 		if (FormatMessageA(
   151 				FORMAT_MESSAGE_FROM_SYSTEM|FORMAT_MESSAGE_IGNORE_INSERTS,
   152 				NULL,
   153 				err,
   154 				MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT),
   155 				s_FailPlugin.error_buffer,
   156 				sizeof(s_FailPlugin.error_buffer),
   157 				NULL)
   158 			== 0)
   159 		{
   160 			UTIL_Format(s_FailPlugin.error_buffer, 
   161 				sizeof(s_FailPlugin.error_buffer),
   162 				"unknown error %x",
   163 				err);
   164 		}
   165 #endif
   166 
   167 		s_FailPlugin.fail_version = fail_api;
   168 
   169 		return (METAMOD_PLUGIN *)&s_FailPlugin;
   170 	}
   171 
   172 	if (!(fn=(METAMOD_FN_ORIG_LOAD)findsym(g_hCore, "CreateInterface")))
   173 	{
   174 		goto error;
   175 	}
   176 
   177 	pl = (METAMOD_PLUGIN *)fn(METAMOD_PLAPI_NAME, &ret);
   178 	if (!pl)
   179 	{
   180 		goto error;
   181 	}
   182 
   183 	return pl;
   184 error:
   185 	closelib(g_hCore);
   186 	g_hCore = NULL;
   187 	return NULL;
   188 }
   189 
   190 bool GetFileOfAddress(void *pAddr, char *buffer, size_t maxlength)
   191 {
   192 #if defined _MSC_VER
   193 	MEMORY_BASIC_INFORMATION mem;
   194 	if (!VirtualQuery(pAddr, &mem, sizeof(mem)))
   195 		return false;
   196 	if (mem.AllocationBase == NULL)
   197 		return false;
   198 	HMODULE dll = (HMODULE)mem.AllocationBase;
   199 	GetModuleFileName(dll, (LPTSTR)buffer, maxlength);
   200 #else
   201 	Dl_info info;
   202 	if (!dladdr(pAddr, &info))
   203 		return false;
   204 	if (!info.dli_fbase || !info.dli_fname)
   205 		return false;
   206 	const char *dllpath = info.dli_fname;
   207 	snprintf(buffer, maxlength, "%s", dllpath);
   208 #endif
   209 	return true;
   210 }
   211 
   212 DLL_EXPORT METAMOD_PLUGIN *CreateInterface_MMS(const MetamodVersionInfo *mvi, const MetamodLoaderInfo *mli)
   213 {
   214 	const char *filename;
   215 
   216 	load_attempted = true;
   217 	
   218 	if (mvi->api_major > METAMOD_API_MAJOR)
   219 	{
   220 		return NULL;
   221 	}
   222 
   223 	switch (mvi->source_engine)
   224 	{
   225 	case SOURCE_ENGINE_ORIGINAL:
   226 	case SOURCE_ENGINE_EPISODEONE:
   227 		{
   228 			filename = FILENAME_1_6_EP1;
   229 			break;
   230 		}
   231 	case SOURCE_ENGINE_ORANGEBOX:
   232 		{
   233 			filename = FILENAME_1_6_EP2;
   234 			break;
   235 		}
   236 	case SOURCE_ENGINE_LEFT4DEAD:
   237 		{
   238 			filename = FILENAME_1_6_L4D;
   239 			break;
   240 		}
   241 	case SOURCE_ENGINE_DARKMESSIAH:
   242 		{
   243 			filename = FILENAME_1_6_DARKM;
   244 			break;
   245 		}
   246 	case SOURCE_ENGINE_LEFT4DEAD2:
   247 		{
   248 			const char *gamedir = mvi->GetGameDir();
   249 			if (strcmp(gamedir, "nucleardawn") == 0)
   250 			{
   251 				filename = FILENAME_1_6_ND;
   252 			}
   253 			else
   254 			{
   255 				filename = FILENAME_1_6_L4D2;
   256 			}
   257 			break;
   258 		}
   259 	case SOURCE_ENGINE_NUCLEARDAWN:
   260 		{
   261 			filename = FILENAME_1_6_ND;
   262 			break;
   263 		}
   264 	case SOURCE_ENGINE_CONTAGION:
   265 		{
   266 			filename = FILENAME_1_6_CONTAGION;
   267 			break;
   268 		}
   269 	case SOURCE_ENGINE_ALIENSWARM:
   270 		{
   271 			filename = FILENAME_1_6_SWARM;
   272 			break;
   273 		}
   274 	case SOURCE_ENGINE_BLOODYGOODTIME:
   275 		{
   276 			filename = FILENAME_1_6_BGT;
   277 			break;
   278 		}
   279 	case SOURCE_ENGINE_EYE:
   280 		{
   281 			filename = FILENAME_1_6_EYE;
   282 			break;
   283 		}
   284 	case SOURCE_ENGINE_PORTAL2:
   285 		{
   286 			filename = FILENAME_1_6_PORTAL2;
   287 			break;
   288 		}
   289 	case SOURCE_ENGINE_CSGO:
   290 		{
   291 			filename = FILENAME_1_6_CSGO;
   292 			break;
   293 		}
   294 	case SOURCE_ENGINE_CSS:
   295 		{
   296 			filename = FILENAME_1_6_CSS;
   297 			break;
   298 		}
   299 	case SOURCE_ENGINE_HL2DM:
   300 		{
   301 			filename = FILENAME_1_6_HL2DM;
   302 			break;
   303 		}
   304 	case SOURCE_ENGINE_DODS:
   305 		{
   306 			filename = FILENAME_1_6_DODS;
   307 			break;
   308 		}
   309 	case SOURCE_ENGINE_SDK2013:
   310 		{
   311 			filename = FILENAME_1_6_SDK2013;
   312 			break;
   313 		}
   314 	case SOURCE_ENGINE_TF2:
   315 		{
   316 			filename = FILENAME_1_6_TF2;
   317 			break;
   318 		}
   319 	case SOURCE_ENGINE_ORANGEBOXVALVE_DEPRECATED:
   320 		{
   321 			const char *gamedir = mvi->GetGameDir();
   322 			if (strcmp(gamedir, "tf") == 0)
   323 			{
   324 				filename = FILENAME_1_6_TF2;
   325 			}
   326 			else if (strcmp(gamedir, "dod") == 0)
   327 			{
   328 				filename = FILENAME_1_6_DODS;
   329 			}
   330 			else if (strcmp(gamedir, "hl2mp") == 0)
   331 			{
   332 				filename = FILENAME_1_6_HL2DM;
   333 			}
   334 			else
   335 			{
   336 				return NULL;
   337 			}
   338 			break;
   339 		}
   340 	case SOURCE_ENGINE_DOTA:
   341 		{
   342 			filename = FILENAME_1_6_DOTA;
   343 			break;
   344 		}
   345 	case SOURCE_ENGINE_BLADE:
   346 		{
   347 			filename = FILENAME_1_6_BLADE;
   348 			break;
   349 		}
   350 	case SOURCE_ENGINE_INSURGENCY:
   351 		{
   352 			filename = FILENAME_1_6_INSURGENCY;
   353 			break;
   354 		}
   355 	default:
   356 		{
   357 			return NULL;
   358 		}
   359 	}
   360 
   361 	char abspath[256];
   362 	UTIL_Format(abspath, sizeof(abspath), "%s" PATH_SEP_CHAR "%s", mli->pl_path, filename);
   363 
   364 	return _GetPluginPtr(abspath, METAMOD_FAIL_API_V2);
   365 }
   366 
   367 DLL_EXPORT void UnloadInterface_MMS()
   368 {
   369 	if (g_hCore)
   370 	{
   371 		closelib(g_hCore);
   372 		g_hCore = NULL;
   373 	}
   374 }
   375 
   376 DLL_EXPORT void *CreateInterface(const char *iface, int *ret)
   377 {
   378 	/**
   379 	 * If a load has already been attempted, bail out immediately.
   380 	 */
   381 	if (load_attempted)
   382 	{
   383 		return NULL;
   384 	}
   385 
   386 	if (strcmp(iface, METAMOD_PLAPI_NAME) == 0)
   387 	{
   388 		char thisfile[256];
   389 		char targetfile[256];
   390 
   391 		if (!GetFileOfAddress((void *)CreateInterface_MMS, thisfile, sizeof(thisfile)))
   392 		{
   393 			return NULL;
   394 		}
   395 
   396 		size_t len = strlen(thisfile);
   397 		for (size_t iter=len-1; iter<len; iter--)
   398 		{
   399 			if (IsPathSepChar(thisfile[iter]))
   400 			{
   401 				thisfile[iter] = '\0';
   402 				break;
   403 			}
   404 		}
   405 
   406 		UTIL_Format(targetfile, sizeof(targetfile), "%s" PATH_SEP_CHAR FILENAME_1_4_EP1, thisfile);
   407 
   408 		return _GetPluginPtr(targetfile, METAMOD_FAIL_API_V1);
   409 	}
   410 
   411 	return NULL;
   412 }
   413 
   414 #if defined _MSC_VER
   415 BOOL WINAPI DllMain(HINSTANCE hinstDLL, DWORD fdwReason, LPVOID lpReserved)
   416 {
   417 	if (fdwReason == DLL_PROCESS_DETACH)
   418 	{
   419 		UnloadInterface_MMS();
   420 	}
   421 	return TRUE;
   422 }
   423 #else
   424 __attribute__((destructor)) static void gcc_fini()
   425 {
   426 	UnloadInterface_MMS();
   427 }
   428 #endif
   429 
   430 /* Overload a few things to prevent libstdc++ linking */
   431 #if defined __linux__ || defined __APPLE__
   432 extern "C" void __cxa_pure_virtual(void)
   433 {
   434 }
   435 
   436 void *operator new(size_t size)
   437 {
   438 	return malloc(size);
   439 }
   440 
   441 void *operator new[](size_t size)
   442 {
   443 	return malloc(size);
   444 }
   445 
   446 void operator delete(void *ptr)
   447 {
   448 	free(ptr);
   449 }
   450 
   451 void operator delete[](void * ptr)
   452 {
   453 	free(ptr);
   454 }
   455 #endif
   456 
   457