loader/loader.cpp
author David Anderson <dvander@alliedmods.net>
Thu Jan 10 18:15:45 2008 +0000 (2008-01-10)
changeset 1840 dd80e60b571c
parent 1561 b437438914c5
child 1843 051154c7d130
permissions -rw-r--r--
added extended error messaging to the loader
faluco@1557
     1
/**
faluco@1557
     2
 * vim: set ts=4 :
faluco@1557
     3
 * =============================================================================
faluco@1557
     4
 * SourceMod
faluco@1557
     5
 * Copyright (C) 2004-2007 AlliedModders LLC.  All rights reserved.
faluco@1557
     6
 * =============================================================================
faluco@1557
     7
 *
faluco@1557
     8
 * This program is free software; you can redistribute it and/or modify it under
faluco@1557
     9
 * the terms of the GNU General Public License, version 3.0, as published by the
faluco@1557
    10
 * Free Software Foundation.
faluco@1557
    11
 * 
faluco@1557
    12
 * This program is distributed in the hope that it will be useful, but WITHOUT
faluco@1557
    13
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
faluco@1557
    14
 * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
faluco@1557
    15
 * details.
faluco@1557
    16
 *
faluco@1557
    17
 * You should have received a copy of the GNU General Public License along with
faluco@1557
    18
 * this program.  If not, see <http://www.gnu.org/licenses/>.
faluco@1557
    19
 *
faluco@1557
    20
 * As a special exception, AlliedModders LLC gives you permission to link the
faluco@1557
    21
 * code of this program (as well as its derivative works) to "Half-Life 2," the
faluco@1557
    22
 * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
faluco@1557
    23
 * by the Valve Corporation.  You must obey the GNU General Public License in
faluco@1557
    24
 * all respects for all other code used.  Additionally, AlliedModders LLC grants
faluco@1557
    25
 * this exception to all derivative works.  AlliedModders LLC defines further
faluco@1557
    26
 * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
faluco@1557
    27
 * or <http://www.sourcemod.net/license.php>.
faluco@1557
    28
 *
faluco@1557
    29
 * Version: $Id$
faluco@1557
    30
 */
faluco@1557
    31
faluco@1557
    32
#include <ISmmPluginExt.h>
faluco@1557
    33
#include <stdarg.h>
faluco@1557
    34
#include <string.h>
faluco@1557
    35
#include <stdio.h>
faluco@1557
    36
faluco@1557
    37
#if defined _MSC_VER
faluco@1557
    38
	#define DLL_EXPORT				extern "C" __declspec(dllexport)
faluco@1557
    39
	#define openlib(lib)			LoadLibrary(lib)
faluco@1557
    40
	#define closelib(lib)			FreeLibrary(lib)
faluco@1557
    41
	#define findsym(lib, sym)		GetProcAddress(lib, sym)
faluco@1557
    42
	#define PLATFORM_EXT			".dll"
faluco@1557
    43
	#define vsnprintf				_vsnprintf
faluco@1557
    44
	#define PATH_SEP_CHAR			"\\"
faluco@1557
    45
	inline bool IsPathSepChar(char c) 
faluco@1557
    46
	{
faluco@1557
    47
		return (c == '/' || c == '\\');
faluco@1557
    48
	}
faluco@1557
    49
	#include <Windows.h>
faluco@1557
    50
#else
faluco@1557
    51
	#define DLL_EXPORT				extern "C" __attribute__((visibility("default")))
faluco@1557
    52
	#define openlib(lib)			dlopen(lib, RTLD_NOW)
faluco@1557
    53
	#define closelib(lib)			dlclose(lib)
faluco@1557
    54
	#define findsym(lib, sym)		dlsym(lib, sym)
faluco@1557
    55
	#define PLATFORM_EXT			".so"
faluco@1557
    56
	typedef void *					HINSTANCE;
faluco@1557
    57
	#define PATH_SEP_CHAR			"/"
faluco@1557
    58
	inline bool IsPathSepChar(char c) 
faluco@1557
    59
	{
faluco@1557
    60
		return (c == '/');
faluco@1557
    61
	}
faluco@1557
    62
	#include <dlfcn.h>
faluco@1557
    63
#endif
faluco@1557
    64
faluco@1557
    65
#define METAMOD_API_MAJOR			2
faluco@1557
    66
#define FILENAME_1_4_EP1			"sourcemod.1.ep1" PLATFORM_EXT
faluco@1557
    67
#define FILENAME_1_6_EP2			"sourcemod.2.ep2" PLATFORM_EXT
faluco@1557
    68
#define FILENAME_1_6_EP1			"sourcemod.2.ep1" PLATFORM_EXT
faluco@1557
    69
faluco@1557
    70
HINSTANCE g_hCore = NULL;
dvander@1561
    71
bool load_attempted = false;
faluco@1557
    72
dvander@1840
    73
size_t UTIL_Format(char *buffer, size_t maxlength, const char *fmt, ...);
dvander@1840
    74
dvander@1840
    75
class FailPlugin : public SourceMM::ISmmFailPlugin
dvander@1840
    76
{
dvander@1840
    77
public:
dvander@1840
    78
	int GetApiVersion()
dvander@1840
    79
	{
dvander@1840
    80
		return fail_version;
dvander@1840
    81
	}
dvander@1840
    82
dvander@1840
    83
	bool Load(SourceMM::PluginId id, SourceMM::ISmmAPI *ismm, char *error, size_t maxlength, bool late)
dvander@1840
    84
	{
dvander@1840
    85
		if (error != NULL && maxlength != 0)
dvander@1840
    86
		{
dvander@1840
    87
			UTIL_Format(error, maxlength, "%s", error_buffer);
dvander@1840
    88
		}
dvander@1840
    89
		return false;
dvander@1840
    90
	}
dvander@1840
    91
dvander@1840
    92
	int fail_version;
dvander@1840
    93
	char error_buffer[512];
dvander@1840
    94
} s_FailPlugin;
dvander@1840
    95
faluco@1557
    96
size_t UTIL_Format(char *buffer, size_t maxlength, const char *fmt, ...)
faluco@1557
    97
{
faluco@1557
    98
	va_list ap;
faluco@1557
    99
faluco@1557
   100
	va_start(ap, fmt);
faluco@1557
   101
	size_t len = vsnprintf(buffer, maxlength, fmt, ap);
faluco@1557
   102
	va_end(ap);
faluco@1557
   103
faluco@1557
   104
	if (len >= maxlength)
faluco@1557
   105
	{
faluco@1557
   106
		len = maxlength - 1;
faluco@1557
   107
		buffer[len] = '\0';
faluco@1557
   108
	}
faluco@1557
   109
faluco@1557
   110
	return len;
faluco@1557
   111
}
faluco@1557
   112
dvander@1840
   113
METAMOD_PLUGIN *_GetPluginPtr(const char *path, int fail_api)
faluco@1557
   114
{
faluco@1557
   115
	METAMOD_FN_ORIG_LOAD fn;
faluco@1557
   116
	METAMOD_PLUGIN *pl;
faluco@1557
   117
	int ret;
faluco@1557
   118
faluco@1557
   119
	if (!(g_hCore=openlib(path)))
faluco@1557
   120
	{
dvander@1840
   121
#if defined __linux__
dvander@1840
   122
		UTIL_Format(s_FailPlugin.error_buffer, 
dvander@1840
   123
			sizeof(s_FailPlugin.error_buffer),
dvander@1840
   124
			"%s",
dvander@1840
   125
			dlerror());
dvander@1840
   126
#else
dvander@1840
   127
		DWORD err = GetLastError();
dvander@1840
   128
dvander@1840
   129
		if (FormatMessageA(
dvander@1840
   130
				FORMAT_MESSAGE_FROM_SYSTEM|FORMAT_MESSAGE_IGNORE_INSERTS,
dvander@1840
   131
				NULL,
dvander@1840
   132
				err,
dvander@1840
   133
				MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT),
dvander@1840
   134
				s_FailPlugin.error_buffer,
dvander@1840
   135
				sizeof(s_FailPlugin.error_buffer),
dvander@1840
   136
				NULL)
dvander@1840
   137
			== 0)
dvander@1840
   138
		{
dvander@1840
   139
			UTIL_Format(s_FailPlugin.error_buffer, 
dvander@1840
   140
				sizeof(s_FailPlugin.error_buffer),
dvander@1840
   141
				"unknown error %x",
dvander@1840
   142
				err);
dvander@1840
   143
		}
dvander@1840
   144
#endif
dvander@1840
   145
dvander@1840
   146
		s_FailPlugin.fail_version = fail_api;
dvander@1840
   147
dvander@1840
   148
		return (METAMOD_PLUGIN *)&s_FailPlugin;
faluco@1557
   149
	}
faluco@1557
   150
faluco@1557
   151
	if (!(fn=(METAMOD_FN_ORIG_LOAD)findsym(g_hCore, "CreateInterface")))
faluco@1557
   152
	{
faluco@1557
   153
		goto error;
faluco@1557
   154
	}
faluco@1557
   155
faluco@1557
   156
	pl = (METAMOD_PLUGIN *)fn(METAMOD_PLAPI_NAME, &ret);
faluco@1557
   157
	if (!pl)
faluco@1557
   158
	{
faluco@1557
   159
		goto error;
faluco@1557
   160
	}
faluco@1557
   161
faluco@1557
   162
	return pl;
faluco@1557
   163
error:
faluco@1557
   164
	closelib(g_hCore);
faluco@1557
   165
	g_hCore = NULL;
faluco@1557
   166
	return NULL;
faluco@1557
   167
}
faluco@1557
   168
faluco@1557
   169
bool GetFileOfAddress(void *pAddr, char *buffer, size_t maxlength)
faluco@1557
   170
{
faluco@1557
   171
#if defined _MSC_VER
faluco@1557
   172
	MEMORY_BASIC_INFORMATION mem;
faluco@1557
   173
	if (!VirtualQuery(pAddr, &mem, sizeof(mem)))
faluco@1557
   174
		return false;
faluco@1557
   175
	if (mem.AllocationBase == NULL)
faluco@1557
   176
		return false;
faluco@1557
   177
	HMODULE dll = (HMODULE)mem.AllocationBase;
faluco@1557
   178
	GetModuleFileName(dll, (LPTSTR)buffer, maxlength);
faluco@1557
   179
#else
faluco@1557
   180
	Dl_info info;
faluco@1557
   181
	if (!dladdr(pAddr, &info))
faluco@1557
   182
		return false;
faluco@1557
   183
	if (!info.dli_fbase || !info.dli_fname)
faluco@1557
   184
		return false;
faluco@1557
   185
	const char *dllpath = info.dli_fname;
faluco@1557
   186
	snprintf(buffer, maxlength, "%s", dllpath);
faluco@1557
   187
#endif
faluco@1557
   188
	return true;
faluco@1557
   189
}
faluco@1557
   190
faluco@1557
   191
DLL_EXPORT METAMOD_PLUGIN *CreateInterface_MMS(const MetamodVersionInfo *mvi, const MetamodLoaderInfo *mli)
faluco@1557
   192
{
faluco@1557
   193
	char *filename;
dvander@1561
   194
dvander@1561
   195
	load_attempted = true;
faluco@1557
   196
	
faluco@1557
   197
	if (mvi->api_major > METAMOD_API_MAJOR)
faluco@1557
   198
	{
faluco@1557
   199
		return NULL;
faluco@1557
   200
	}
faluco@1557
   201
faluco@1557
   202
	switch (mvi->source_engine)
faluco@1557
   203
	{
faluco@1557
   204
	case SOURCE_ENGINE_ORANGEBOX:
faluco@1557
   205
		{
faluco@1557
   206
			filename = FILENAME_1_6_EP2;
faluco@1557
   207
			break;
faluco@1557
   208
		}
faluco@1557
   209
	case SOURCE_ENGINE_EPISODEONE:
faluco@1557
   210
	case SOURCE_ENGINE_ORIGINAL:
faluco@1557
   211
		{
faluco@1557
   212
			filename = FILENAME_1_6_EP1;
faluco@1557
   213
			break;
faluco@1557
   214
		}
faluco@1557
   215
	default:
faluco@1557
   216
		{
faluco@1557
   217
			return NULL;
faluco@1557
   218
		}
faluco@1557
   219
	}
faluco@1557
   220
faluco@1557
   221
	char abspath[256];
faluco@1557
   222
	UTIL_Format(abspath, sizeof(abspath), "%s" PATH_SEP_CHAR "%s", mli->pl_path, filename);
faluco@1557
   223
dvander@1840
   224
	return _GetPluginPtr(abspath, METAMOD_FAIL_API_V2);
faluco@1557
   225
}
faluco@1557
   226
faluco@1557
   227
DLL_EXPORT void UnloadInterface_MMS()
faluco@1557
   228
{
faluco@1557
   229
	if (g_hCore)
faluco@1557
   230
	{
faluco@1557
   231
		closelib(g_hCore);
faluco@1557
   232
		g_hCore = NULL;
faluco@1557
   233
	}
faluco@1557
   234
}
faluco@1557
   235
faluco@1557
   236
DLL_EXPORT void *CreateInterface(const char *iface, int *ret)
faluco@1557
   237
{
dvander@1561
   238
	/**
dvander@1561
   239
	 * If a load has already been attempted, bail out immediately.
dvander@1561
   240
	 */
dvander@1561
   241
	if (load_attempted)
dvander@1561
   242
	{
dvander@1561
   243
		return NULL;
dvander@1561
   244
	}
dvander@1561
   245
dvander@1561
   246
	if (strcmp(iface, METAMOD_PLAPI_NAME) == 0)
faluco@1557
   247
	{
faluco@1557
   248
		char thisfile[256];
faluco@1557
   249
		char targetfile[256];
faluco@1557
   250
faluco@1557
   251
		if (!GetFileOfAddress((void *)CreateInterface_MMS, thisfile, sizeof(thisfile)))
faluco@1557
   252
		{
faluco@1557
   253
			return NULL;
faluco@1557
   254
		}
faluco@1557
   255
faluco@1557
   256
		size_t len = strlen(thisfile);
faluco@1557
   257
		for (size_t iter=len-1; iter>=0 && iter<len; iter--)
faluco@1557
   258
		{
faluco@1557
   259
			if (IsPathSepChar(thisfile[iter]))
faluco@1557
   260
			{
faluco@1557
   261
				thisfile[iter] = '\0';
faluco@1557
   262
				break;
faluco@1557
   263
			}
faluco@1557
   264
		}
faluco@1557
   265
faluco@1557
   266
		UTIL_Format(targetfile, sizeof(targetfile), "%s" PATH_SEP_CHAR FILENAME_1_4_EP1, thisfile);
faluco@1557
   267
dvander@1840
   268
		return _GetPluginPtr(targetfile, METAMOD_FAIL_API_V1);
faluco@1557
   269
	}
faluco@1557
   270
faluco@1557
   271
	return NULL;
faluco@1557
   272
}
faluco@1557
   273
faluco@1557
   274
#if defined _MSC_VER
faluco@1557
   275
BOOL WINAPI DllMain(HINSTANCE hinstDLL, DWORD fdwReason, LPVOID lpReserved)
faluco@1557
   276
{
faluco@1557
   277
	if (fdwReason == DLL_PROCESS_DETACH)
faluco@1557
   278
	{
faluco@1557
   279
		UnloadInterface_MMS();
faluco@1557
   280
	}
faluco@1557
   281
	return TRUE;
faluco@1557
   282
}
faluco@1557
   283
#else
faluco@1557
   284
__attribute__((destructor)) static void gcc_fini()
faluco@1557
   285
{
faluco@1557
   286
	UnloadInterface_MMS();
faluco@1557
   287
}
faluco@1557
   288
#endif