loader/gamedll.cpp
author Scott Ehlert <ds@alliedmods.net>
Wed Feb 18 01:38:23 2009 -0600 (2009-02-18)
changeset 637 b66489d8aedc
parent 608 30b546cc4e03
child 681 a9f34c9f06e7
permissions -rw-r--r--
Added support for Dark Messiah engine and game. (no bug, r=me).

The development of this feature would not be possible without the support of the following people from the game's community:
Dylan Riggs, Carl Pettengill, Ed Moreland, and Christian.
dvander@608
     1
/**
dvander@608
     2
 * vim: set ts=4 :
dvander@608
     3
 * ======================================================
dvander@608
     4
 * Metamod:Source
dvander@608
     5
 * Copyright (C) 2004-2008 AlliedModders LLC and authors.
dvander@608
     6
 * All rights reserved.
dvander@608
     7
 * ======================================================
dvander@608
     8
 *
dvander@608
     9
 * This software is provided 'as-is', without any express or implied warranty.
dvander@608
    10
 * In no event will the authors be held liable for any damages arising from 
dvander@608
    11
 * the use of this software.
dvander@608
    12
 * 
dvander@608
    13
 * Permission is granted to anyone to use this software for any purpose, 
dvander@608
    14
 * including commercial applications, and to alter it and redistribute it 
dvander@608
    15
 * freely, subject to the following restrictions:
dvander@608
    16
 *
dvander@608
    17
 * 1. The origin of this software must not be misrepresented; you must not 
dvander@608
    18
 * claim that you wrote the original software. If you use this software in a 
dvander@608
    19
 * product, an acknowledgment in the product documentation would be 
dvander@608
    20
 * appreciated but is not required.
dvander@608
    21
 * 2. Altered source versions must be plainly marked as such, and must not be
dvander@608
    22
 * misrepresented as being the original software.
dvander@608
    23
 * 3. This notice may not be removed or altered from any source distribution.
dvander@608
    24
 *
dvander@608
    25
 * Version: $Id$
dvander@608
    26
 */
dvander@608
    27
dvander@579
    28
#include <stdio.h>
dvander@579
    29
#include <ctype.h>
dvander@579
    30
#include <string.h>
dvander@579
    31
#include <assert.h>
dvander@579
    32
#include <stdlib.h>
dvander@579
    33
#include <stddef.h>
dvander@579
    34
#include "loader.h"
dvander@579
    35
#include <sh_memfuncinfo.h>
dvander@579
    36
#include <sh_memory.h>
dvander@579
    37
#include "utility.h"
dvander@579
    38
#include "gamedll.h"
dvander@586
    39
dvander@579
    40
class IServerGameDLL;
dvander@579
    41
dvander@579
    42
#define MAX_GAMEDLL_PATHS	10
dvander@579
    43
dvander@579
    44
IGameDllBridge* gamedll_bridge = NULL;
dvander@579
    45
static int game_info_detected = 0;
ds@637
    46
static const char *game_name = NULL;
dvander@579
    47
static char gamedll_paths[MAX_GAMEDLL_PATHS][PLATFORM_MAX_PATH];
dvander@579
    48
static void *gamedll_libs[MAX_GAMEDLL_PATHS];
dvander@579
    49
static unsigned int gamedll_path_count = 0;
dvander@579
    50
static void *gamedll_lib = NULL;
dvander@579
    51
static IServerGameDLL *gamedll_iface = NULL;
dvander@579
    52
static QueryValveInterface gamedll_qvi = NULL;
dvander@579
    53
static int gamedll_version = 0;
dvander@582
    54
static int isgd_shutdown_index = -1;
dvander@579
    55
dvander@579
    56
#if defined _WIN32
dvander@579
    57
#define SERVER_NAME			"server.dll"
dvander@579
    58
#elif defined __linux__
dvander@579
    59
#define SERVER_NAME			"server_i486.so"
dvander@579
    60
#endif
dvander@579
    61
dvander@579
    62
static bool
dvander@579
    63
mm_DetectGameInformation()
dvander@579
    64
{
dvander@579
    65
	char mm_path[PLATFORM_MAX_PATH];
dvander@579
    66
	char game_path[PLATFORM_MAX_PATH];
dvander@579
    67
dvander@579
    68
	if (game_info_detected)
dvander@579
    69
		return game_info_detected == 1 ? true : false;
dvander@579
    70
dvander@579
    71
	game_info_detected = -1;
dvander@579
    72
ds@637
    73
	if ((game_name = mm_GetGameName()) == NULL)
dvander@579
    74
	{
dvander@579
    75
		return false;
dvander@579
    76
	}
dvander@579
    77
dvander@579
    78
	if (!mm_GetFileOfAddress((void*)mm_DetectGameInformation, mm_path, sizeof(mm_path)))
dvander@579
    79
	{
dvander@579
    80
		mm_LogFatal("Could not locate metamod loader library path");
dvander@579
    81
		return false;
dvander@579
    82
	}
dvander@579
    83
dvander@579
    84
	if (!mm_ResolvePath(game_name, game_path, sizeof(game_path)))
dvander@579
    85
	{
dvander@579
    86
		mm_LogFatal("Could not resolve path: %s", game_name);
dvander@579
    87
		return false;
dvander@579
    88
	}
dvander@579
    89
dvander@579
    90
	FILE *fp;
dvander@579
    91
	char gameinfo_path[PLATFORM_MAX_PATH];
dvander@579
    92
dvander@579
    93
	mm_PathFormat(gameinfo_path, sizeof(gameinfo_path), "%s/gameinfo.txt", game_path);
dvander@579
    94
	if ((fp = fopen(gameinfo_path, "rt")) == NULL)
dvander@579
    95
	{
dvander@579
    96
		mm_LogFatal("Could not read file: %s", gameinfo_path);
dvander@579
    97
		return false;
dvander@579
    98
	}
dvander@579
    99
dvander@579
   100
	char temp_path[PLATFORM_MAX_PATH];
dvander@579
   101
	char cur_path[PLATFORM_MAX_PATH];
dvander@579
   102
	getcwd(cur_path, sizeof(cur_path));
dvander@579
   103
dvander@579
   104
	char *ptr;
dvander@579
   105
	const char *lptr;
dvander@579
   106
	bool search = false;
dvander@579
   107
	char buffer[255], key[128], val[128];
dvander@579
   108
	while (!feof(fp) && fgets(buffer, sizeof(buffer), fp) != NULL)
dvander@579
   109
	{
dvander@579
   110
		mm_TrimComments(buffer);
dvander@579
   111
		mm_TrimLeft(buffer);
dvander@579
   112
		mm_TrimRight(buffer);
dvander@579
   113
dvander@579
   114
		if (stricmp(buffer, "SearchPaths") == 0)
dvander@579
   115
			search = true;
dvander@579
   116
dvander@579
   117
		if (!search)
dvander@579
   118
			continue;
dvander@579
   119
dvander@579
   120
		mm_KeySplit(buffer, key, sizeof(key) - 1, val, sizeof(val) - 1);
dvander@579
   121
		if (stricmp(key, "Game") != 0 && stricmp(key, "GameBin") != 0)
dvander@579
   122
			continue;
dvander@579
   123
dvander@579
   124
		if (strncmp(val, "|gameinfo_path|", sizeof("|gameinfo_path|") - 1) == 0)
dvander@579
   125
		{
dvander@579
   126
			ptr = &val[sizeof("|gameinfo_path|") - 1];
dvander@579
   127
			if (ptr[0] == '.')
dvander@579
   128
				ptr++;
dvander@579
   129
			lptr = game_path;
dvander@579
   130
		}
dvander@579
   131
		else
dvander@579
   132
		{
dvander@579
   133
			ptr = val;
dvander@579
   134
			lptr = cur_path;
dvander@579
   135
		}
dvander@579
   136
dvander@579
   137
		if (stricmp(key, "GameBin") == 0)
dvander@579
   138
			mm_PathFormat(temp_path, sizeof(temp_path), "%s/%s/" SERVER_NAME, lptr, ptr);
dvander@579
   139
		else if (!ptr[0])
dvander@579
   140
			mm_PathFormat(temp_path, sizeof(temp_path), "%s/bin/" SERVER_NAME, lptr);
dvander@579
   141
		else
dvander@579
   142
			mm_PathFormat(temp_path, sizeof(temp_path), "%s/%s/bin/" SERVER_NAME, lptr, ptr);
dvander@579
   143
dvander@579
   144
		if (mm_PathCmp(mm_path, temp_path))
dvander@579
   145
			continue;
dvander@579
   146
dvander@579
   147
		FILE *exists = fopen(temp_path, "rb");
dvander@579
   148
		if (!exists)
dvander@579
   149
			continue;
dvander@579
   150
		fclose(exists);
dvander@579
   151
dvander@579
   152
		/* exists is still non-NULL... use this as a flag */
dvander@579
   153
		for (unsigned int i = 0; i < gamedll_path_count; i++)
dvander@579
   154
		{
dvander@579
   155
			if (mm_PathCmp(gamedll_paths[i], temp_path))
dvander@579
   156
			{
dvander@579
   157
				exists = NULL;
dvander@579
   158
				break;
dvander@579
   159
			}
dvander@579
   160
		}
dvander@579
   161
dvander@579
   162
		if (!exists)
dvander@579
   163
			continue;
dvander@579
   164
dvander@579
   165
		mm_Format(gamedll_paths[gamedll_path_count],
dvander@579
   166
				  PLATFORM_MAX_PATH,
dvander@579
   167
				  "%s",
dvander@579
   168
				  temp_path);
dvander@579
   169
		gamedll_path_count++;
dvander@579
   170
dvander@579
   171
		if (gamedll_path_count == MAX_GAMEDLL_PATHS)
dvander@579
   172
			break;
dvander@579
   173
	}
dvander@579
   174
	fclose(fp);
dvander@579
   175
dvander@579
   176
	game_info_detected = 1;
dvander@579
   177
dvander@579
   178
	return true;
dvander@579
   179
}
dvander@579
   180
dvander@579
   181
static void
dvander@579
   182
mm_FreeCachedLibraries()
dvander@579
   183
{
dvander@579
   184
	for (unsigned int i = 0; i < gamedll_path_count; i++)
dvander@579
   185
	{
dvander@579
   186
		if (gamedll_libs[i] == NULL)
dvander@579
   187
			continue;
dvander@579
   188
		mm_UnloadLibrary(gamedll_libs[i]);
dvander@579
   189
	}
dvander@579
   190
}
dvander@579
   191
dvander@579
   192
static void
dvander@579
   193
mm_PatchDllInit(bool patch);
dvander@579
   194
dvander@582
   195
static void
dvander@582
   196
mm_PatchDllShutdown();
dvander@582
   197
dvander@582
   198
static void *isgd_orig_init = NULL;
dvander@582
   199
static void *isgd_orig_shutdown = NULL;
dvander@579
   200
dvander@579
   201
class VEmptyClass
dvander@579
   202
{
dvander@579
   203
};
dvander@579
   204
dvander@579
   205
class IServerGameDLL
dvander@579
   206
{
dvander@579
   207
public:
dvander@579
   208
	virtual bool DLLInit(QueryValveInterface engineFactory, 
dvander@579
   209
						 QueryValveInterface physicsFactory, 
dvander@579
   210
						 QueryValveInterface fileSystemFactory, 
dvander@579
   211
						 void *pGlobals)
dvander@579
   212
	{
ds@637
   213
		MetamodBackend backend = mm_DetermineBackend(engineFactory, game_name);
dvander@579
   214
dvander@579
   215
		char error[255];
dvander@579
   216
		if (backend == MMBackend_UNKNOWN)
dvander@579
   217
		{
dvander@579
   218
			mm_LogFatal("Could not detect engine version");
dvander@579
   219
		}
dvander@579
   220
		else
dvander@579
   221
		{
dvander@579
   222
			if (!mm_LoadMetamodLibrary(backend, error, sizeof(error)))
dvander@579
   223
			{
dvander@579
   224
				mm_LogFatal("Detected engine %d but could not load: %s", backend, error);
dvander@579
   225
			}
dvander@579
   226
			else
dvander@579
   227
			{
dvander@579
   228
				typedef IGameDllBridge *(*GetGameDllBridge)();
dvander@579
   229
				GetGameDllBridge get_bridge = (GetGameDllBridge)mm_GetProcAddress("GetGameDllBridge");
dvander@579
   230
				if (get_bridge == NULL)
dvander@579
   231
				{
dvander@579
   232
					mm_UnloadMetamodLibrary();
dvander@579
   233
					mm_LogFatal("Detected engine %d but could not find GetGameDllBridge callback", backend);
dvander@579
   234
				}
dvander@588
   235
				else
dvander@588
   236
				{
dvander@588
   237
					gamedll_bridge = get_bridge();
dvander@588
   238
				}
dvander@579
   239
			}
dvander@579
   240
		}
dvander@579
   241
dvander@579
   242
		if (gamedll_bridge)
dvander@579
   243
		{
dvander@579
   244
			gamedll_bridge_info info;
dvander@579
   245
dvander@579
   246
			info.engineFactory = (QueryValveInterface)engineFactory;
dvander@579
   247
			info.physicsFactory = (QueryValveInterface)physicsFactory;
dvander@579
   248
			info.fsFactory = (QueryValveInterface)fileSystemFactory;
dvander@579
   249
			info.pGlobals = pGlobals;
dvander@579
   250
			info.dllVersion = gamedll_version;
dvander@579
   251
			info.isgd = gamedll_iface;
dvander@579
   252
			info.gsFactory = gamedll_qvi;
dvander@579
   253
dvander@579
   254
			strcpy(error, "Unknown error");
dvander@579
   255
			if (!gamedll_bridge->DLLInit_Pre(&info, error, sizeof(error)))
dvander@579
   256
			{
dvander@579
   257
				gamedll_bridge = NULL;
dvander@579
   258
				mm_UnloadMetamodLibrary();
dvander@579
   259
				mm_LogFatal("Unknown error loading Metamod for engine %d: %s", backend, error);	
dvander@579
   260
			}
dvander@579
   261
		}
dvander@579
   262
dvander@579
   263
		/* Call the original */
dvander@579
   264
		bool result;
dvander@579
   265
		{
dvander@579
   266
			union
dvander@579
   267
			{
dvander@579
   268
				bool (VEmptyClass::*mfpnew)(QueryValveInterface engineFactory, 
dvander@579
   269
										 	QueryValveInterface physicsFactory, 
dvander@579
   270
										 	QueryValveInterface fileSystemFactory, 
dvander@579
   271
										 	void *pGlobals);
dvander@579
   272
#if defined _WIN32
dvander@579
   273
				void *addr;
dvander@579
   274
			} u;
dvander@582
   275
			u.addr = isgd_orig_init;
dvander@579
   276
#else
dvander@579
   277
				struct
dvander@579
   278
				{
dvander@579
   279
					void *addr;
dvander@579
   280
					intptr_t adjustor;
dvander@579
   281
				} s;
dvander@579
   282
			} u;
dvander@582
   283
			u.s.addr = isgd_orig_init;
dvander@579
   284
			u.s.adjustor = 0;
dvander@579
   285
#endif
dvander@579
   286
			result = (((VEmptyClass *)gamedll_iface)->*u.mfpnew)(engineFactory,
dvander@579
   287
																 physicsFactory,
dvander@579
   288
																 fileSystemFactory,
dvander@579
   289
																 pGlobals);
dvander@579
   290
		}
dvander@579
   291
dvander@579
   292
		/**
dvander@579
   293
		 * :TODO: possible logic hole here, what happens if the gamedll REALLY returns false? 
dvander@579
   294
		 * I'm pretty sure we'll die horribly.
dvander@579
   295
		 */
dvander@579
   296
dvander@579
   297
		if (!result)
dvander@579
   298
		{
dvander@579
   299
			gamedll_bridge->Unload();
dvander@579
   300
			mm_UnloadMetamodLibrary();
dvander@579
   301
			gamedll_bridge = NULL;
dvander@579
   302
		}
dvander@579
   303
		else if (gamedll_bridge != NULL)
dvander@579
   304
		{
dvander@582
   305
			gamedll_bridge->DLLInit_Post(&isgd_shutdown_index);
dvander@582
   306
			assert(isgd_shutdown_index != -1);
dvander@582
   307
			mm_PatchDllShutdown();
dvander@579
   308
		}
dvander@579
   309
dvander@579
   310
		mm_PatchDllInit(false);
dvander@579
   311
dvander@579
   312
		return result;
dvander@579
   313
	}
dvander@582
   314
dvander@582
   315
	virtual void DLLShutdown()
dvander@582
   316
	{
dvander@582
   317
		gamedll_bridge->Unload();
dvander@582
   318
		gamedll_bridge = NULL;
dvander@582
   319
		mm_UnloadMetamodLibrary();
dvander@582
   320
dvander@582
   321
		/* Call original function */
dvander@582
   322
		{
dvander@582
   323
			union
dvander@582
   324
			{
dvander@582
   325
				void (VEmptyClass::*mfpnew)();
dvander@582
   326
#if defined _WIN32
dvander@582
   327
				void *addr;
dvander@582
   328
			} u;
dvander@582
   329
			u.addr = isgd_orig_shutdown;
dvander@582
   330
#else
dvander@582
   331
				struct
dvander@582
   332
				{
dvander@582
   333
					void *addr;
dvander@582
   334
					intptr_t adjustor;
dvander@582
   335
				} s;
dvander@582
   336
			} u;
dvander@582
   337
			u.s.addr = isgd_orig_shutdown;
dvander@582
   338
			u.s.adjustor = 0;
dvander@582
   339
#endif
dvander@582
   340
			(((VEmptyClass *)gamedll_iface)->*u.mfpnew)();
dvander@582
   341
		}
dvander@582
   342
dvander@582
   343
		mm_UnloadLibrary(gamedll_lib);
dvander@582
   344
		gamedll_lib = NULL;
dvander@582
   345
	}
dvander@579
   346
};
dvander@579
   347
dvander@579
   348
static IServerGameDLL isgd_thunk;
dvander@579
   349
dvander@579
   350
static void
dvander@579
   351
mm_PatchDllInit(bool patch)
dvander@579
   352
{
dvander@579
   353
	void **vtable_src;
dvander@579
   354
	void **vtable_dest;
dvander@579
   355
	SourceHook::MemFuncInfo mfp;
dvander@579
   356
dvander@579
   357
	SourceHook::GetFuncInfo(&IServerGameDLL::DLLInit, mfp);
dvander@579
   358
dvander@579
   359
	assert(mfp.isVirtual);
dvander@579
   360
	assert(mfp.thisptroffs == 0);
dvander@579
   361
	assert(mfp.vtbloffs == 0);
dvander@579
   362
dvander@579
   363
	vtable_src = (void **)*(void **)&isgd_thunk;
dvander@579
   364
	vtable_dest = (void **)*(void **)gamedll_iface;
dvander@579
   365
dvander@579
   366
	SourceHook::SetMemAccess(&vtable_dest[mfp.vtblindex],
dvander@579
   367
							 sizeof(void*),
dvander@579
   368
							 SH_MEM_READ|SH_MEM_WRITE|SH_MEM_EXEC);
dvander@579
   369
dvander@579
   370
	if (patch)
dvander@579
   371
	{
dvander@582
   372
		assert(isgd_orig_init == NULL);
dvander@582
   373
		isgd_orig_init = vtable_dest[mfp.vtblindex];
dvander@579
   374
		vtable_dest[mfp.vtblindex] = vtable_src[mfp.vtblindex];
dvander@579
   375
	}
dvander@579
   376
	else
dvander@579
   377
	{
dvander@582
   378
		assert(isgd_orig_init != NULL);
dvander@582
   379
		vtable_dest[mfp.vtblindex] = isgd_orig_init;
dvander@582
   380
		isgd_orig_init = NULL;
dvander@579
   381
	}
dvander@579
   382
}
dvander@579
   383
dvander@579
   384
static void
dvander@582
   385
mm_PatchDllShutdown()
dvander@582
   386
{
dvander@582
   387
	void **vtable_src;
dvander@582
   388
	void **vtable_dest;
dvander@582
   389
	SourceHook::MemFuncInfo mfp;
dvander@582
   390
dvander@582
   391
	mfp.isVirtual = false;
dvander@582
   392
	SourceHook::GetFuncInfo(&IServerGameDLL::DLLShutdown, mfp);
dvander@582
   393
	assert(mfp.isVirtual);
dvander@582
   394
	assert(mfp.thisptroffs == 0);
dvander@582
   395
	assert(mfp.vtbloffs == 0);
dvander@582
   396
dvander@582
   397
	vtable_src = (void **)*(void **)&isgd_thunk;
dvander@582
   398
	vtable_dest = (void **)*(void **)gamedll_iface;
dvander@582
   399
dvander@582
   400
	isgd_orig_shutdown = vtable_dest[isgd_shutdown_index];
dvander@582
   401
	vtable_dest[isgd_shutdown_index] = vtable_src[mfp.vtblindex];
dvander@582
   402
}
dvander@582
   403
dvander@582
   404
static void
dvander@579
   405
mm_PrepForGameLoad()
dvander@579
   406
{
dvander@579
   407
	mm_PatchDllInit(true);
dvander@579
   408
}
dvander@579
   409
dvander@579
   410
void *
dvander@579
   411
mm_GameDllRequest(const char *name, int *ret)
dvander@579
   412
{
ds@606
   413
	if (gamedll_lib != NULL && gamedll_bridge == NULL)
dvander@579
   414
	{
dvander@579
   415
		return gamedll_qvi(name, ret);
dvander@579
   416
	}
dvander@579
   417
dvander@579
   418
	if (strncmp(name, "ServerGameDLL", 13) == 0)
dvander@579
   419
	{
dvander@579
   420
		if (!mm_DetectGameInformation())
dvander@579
   421
		{
dvander@579
   422
			if (ret != NULL)
dvander@579
   423
				*ret = 1;
dvander@579
   424
			return NULL;
dvander@579
   425
		}
dvander@579
   426
dvander@579
   427
		void *lib;
dvander@579
   428
		char error[255];
dvander@579
   429
		void *ptr = NULL;
dvander@579
   430
		QueryValveInterface qvi;
dvander@579
   431
		for (unsigned int i = 0; i < gamedll_path_count; i++)
dvander@579
   432
		{
dvander@579
   433
			if (gamedll_libs[i] == NULL)
dvander@579
   434
			{
dvander@579
   435
				lib = mm_LoadLibrary(gamedll_paths[i], error, sizeof(error));
dvander@579
   436
				if (lib == NULL)
dvander@579
   437
					continue;
dvander@579
   438
				gamedll_libs[i] = lib;
dvander@579
   439
			}
dvander@579
   440
			lib = gamedll_libs[i];
dvander@579
   441
			qvi = (QueryValveInterface)mm_GetLibAddress(lib, "CreateInterface");
dvander@579
   442
			if (qvi == NULL)
dvander@579
   443
				continue;
dvander@579
   444
			ptr = qvi(name, ret);
dvander@579
   445
			if (ptr != NULL)
dvander@579
   446
			{
dvander@579
   447
				gamedll_libs[i] = NULL;
dvander@579
   448
				break;
dvander@579
   449
			}
dvander@579
   450
		}
dvander@579
   451
dvander@579
   452
		if (ptr != NULL)
dvander@579
   453
		{
dvander@579
   454
			mm_FreeCachedLibraries();	
dvander@579
   455
			gamedll_lib = lib;
dvander@579
   456
			gamedll_iface = (IServerGameDLL *)ptr;
dvander@579
   457
			gamedll_qvi = qvi;
dvander@579
   458
			gamedll_version = atoi(&name[13]);
dvander@579
   459
			mm_PrepForGameLoad();
dvander@579
   460
dvander@579
   461
			if (ret != NULL)
dvander@579
   462
				*ret = 0;
dvander@579
   463
			return ptr;
dvander@579
   464
		}
dvander@579
   465
	}
dvander@579
   466
	else if (game_info_detected == 0)
dvander@579
   467
	{
dvander@579
   468
		mm_LogFatal("Received interface request too early: %s", name);
dvander@579
   469
	}
dvander@579
   470
dvander@579
   471
	if (ret != NULL)
dvander@579
   472
		*ret = 1;
dvander@579
   473
	return NULL;
dvander@579
   474
}
dvander@579
   475