loader/gamedll.cpp
author David Anderson <dvander@alliedmods.net>
Sun Nov 23 21:21:49 2008 -0600 (2008-11-23)
changeset 579 be04fd67923b
child 582 4a962b0ad436
permissions -rw-r--r--
Initial import of gameinfo loader.
dvander@579
     1
#include <stdio.h>
dvander@579
     2
#include <ctype.h>
dvander@579
     3
#include <string.h>
dvander@579
     4
#include <assert.h>
dvander@579
     5
#include <stdlib.h>
dvander@579
     6
#include <stddef.h>
dvander@579
     7
#include "loader.h"
dvander@579
     8
#include <sh_memfuncinfo.h>
dvander@579
     9
#include <sh_memory.h>
dvander@579
    10
#include "utility.h"
dvander@579
    11
#include "gamedll.h"
dvander@579
    12
#include "valve_commandline.h"
dvander@579
    13
dvander@579
    14
class IServerGameDLL;
dvander@579
    15
typedef ICommandLine *(*GetCommandLine)();
dvander@579
    16
dvander@579
    17
#define MAX_GAMEDLL_PATHS	10
dvander@579
    18
dvander@579
    19
IGameDllBridge* gamedll_bridge = NULL;
dvander@579
    20
static int game_info_detected = 0;
dvander@579
    21
static char gamedll_paths[MAX_GAMEDLL_PATHS][PLATFORM_MAX_PATH];
dvander@579
    22
static void *gamedll_libs[MAX_GAMEDLL_PATHS];
dvander@579
    23
static unsigned int gamedll_path_count = 0;
dvander@579
    24
static void *gamedll_lib = NULL;
dvander@579
    25
static IServerGameDLL *gamedll_iface = NULL;
dvander@579
    26
static QueryValveInterface gamedll_qvi = NULL;
dvander@579
    27
static int gamedll_version = 0;
dvander@579
    28
dvander@579
    29
#if defined _WIN32
dvander@579
    30
#define TIER0_NAME			"bin\\tier0.dll"
dvander@579
    31
#define VSTDLIB_NAME		"bin\\vstdlib.dll"
dvander@579
    32
#define SERVER_NAME			"server.dll"
dvander@579
    33
#elif defined __linux__
dvander@579
    34
#define TIER0_NAME			"bin/tier0_i486.so"
dvander@579
    35
#define VSTDLIB_NAME		"bin/vstdlib_i486.so"
dvander@579
    36
#define SERVER_NAME			"server_i486.so"
dvander@579
    37
#endif
dvander@579
    38
dvander@579
    39
static bool
dvander@579
    40
mm_DetectGameInformation()
dvander@579
    41
{
dvander@579
    42
	void *lib;
dvander@579
    43
	char error[255];
dvander@579
    44
	GetCommandLine valve_cmdline;
dvander@579
    45
	char mm_path[PLATFORM_MAX_PATH];
dvander@579
    46
	char lib_path[PLATFORM_MAX_PATH];
dvander@579
    47
	char game_name[PLATFORM_MAX_PATH];
dvander@579
    48
	char game_path[PLATFORM_MAX_PATH];
dvander@579
    49
dvander@579
    50
	if (game_info_detected)
dvander@579
    51
		return game_info_detected == 1 ? true : false;
dvander@579
    52
dvander@579
    53
	game_info_detected = -1;
dvander@579
    54
dvander@579
    55
	if (!mm_ResolvePath(TIER0_NAME, lib_path, sizeof(lib_path)))
dvander@579
    56
	{
dvander@579
    57
		mm_LogFatal("Could not find path for: " TIER0_NAME);
dvander@579
    58
		return false;
dvander@579
    59
	}
dvander@579
    60
dvander@579
    61
	if ((lib = mm_LoadLibrary(lib_path, error, sizeof(error))) == NULL)
dvander@579
    62
	{
dvander@579
    63
		mm_LogFatal("Could not load %s: %s", lib_path, error);
dvander@579
    64
		return false;
dvander@579
    65
	}
dvander@579
    66
dvander@579
    67
	valve_cmdline = (GetCommandLine)mm_GetLibAddress(lib, "CommandLine_Tier0");
dvander@579
    68
	if (valve_cmdline == NULL)
dvander@579
    69
	{
dvander@579
    70
		/* We probably have a Ship engine. */
dvander@579
    71
		mm_UnloadLibrary(lib);
dvander@579
    72
		if (!mm_ResolvePath(VSTDLIB_NAME, lib_path, sizeof(lib_path)))
dvander@579
    73
		{
dvander@579
    74
			mm_LogFatal("Could not find path for: " VSTDLIB_NAME);
dvander@579
    75
			return false;
dvander@579
    76
		}
dvander@579
    77
dvander@579
    78
		if ((lib = mm_LoadLibrary(lib_path, error, sizeof(error))) == NULL)
dvander@579
    79
		{
dvander@579
    80
			mm_LogFatal("Could not load %s: %s", lib_path, error);
dvander@579
    81
			return false;
dvander@579
    82
		}
dvander@579
    83
dvander@579
    84
		valve_cmdline = (GetCommandLine)mm_GetLibAddress(lib, "CommandLine");
dvander@579
    85
	}
dvander@579
    86
dvander@579
    87
	mm_UnloadLibrary(lib);
dvander@579
    88
dvander@579
    89
	if (valve_cmdline == NULL)
dvander@579
    90
	{
dvander@579
    91
		mm_LogFatal("Could not locate any command line functionality");
dvander@579
    92
		return false;
dvander@579
    93
	}
dvander@579
    94
dvander@579
    95
	if (!mm_GetFileOfAddress((void*)mm_DetectGameInformation, mm_path, sizeof(mm_path)))
dvander@579
    96
	{
dvander@579
    97
		mm_LogFatal("Could not locate metamod loader library path");
dvander@579
    98
		return false;
dvander@579
    99
	}
dvander@579
   100
dvander@579
   101
	mm_Format(game_name,
dvander@579
   102
			  sizeof(game_name),
dvander@579
   103
			  "%s",
dvander@579
   104
			  valve_cmdline()->ParmValue("-game", "hl2"));
dvander@579
   105
	if (!mm_ResolvePath(game_name, game_path, sizeof(game_path)))
dvander@579
   106
	{
dvander@579
   107
		mm_LogFatal("Could not resolve path: %s", game_name);
dvander@579
   108
		return false;
dvander@579
   109
	}
dvander@579
   110
dvander@579
   111
	FILE *fp;
dvander@579
   112
	char gameinfo_path[PLATFORM_MAX_PATH];
dvander@579
   113
dvander@579
   114
	mm_PathFormat(gameinfo_path, sizeof(gameinfo_path), "%s/gameinfo.txt", game_path);
dvander@579
   115
	if ((fp = fopen(gameinfo_path, "rt")) == NULL)
dvander@579
   116
	{
dvander@579
   117
		mm_LogFatal("Could not read file: %s", gameinfo_path);
dvander@579
   118
		return false;
dvander@579
   119
	}
dvander@579
   120
dvander@579
   121
	char temp_path[PLATFORM_MAX_PATH];
dvander@579
   122
	char cur_path[PLATFORM_MAX_PATH];
dvander@579
   123
	getcwd(cur_path, sizeof(cur_path));
dvander@579
   124
dvander@579
   125
	char *ptr;
dvander@579
   126
	const char *lptr;
dvander@579
   127
	bool search = false;
dvander@579
   128
	char buffer[255], key[128], val[128];
dvander@579
   129
	while (!feof(fp) && fgets(buffer, sizeof(buffer), fp) != NULL)
dvander@579
   130
	{
dvander@579
   131
		mm_TrimComments(buffer);
dvander@579
   132
		mm_TrimLeft(buffer);
dvander@579
   133
		mm_TrimRight(buffer);
dvander@579
   134
dvander@579
   135
		if (stricmp(buffer, "SearchPaths") == 0)
dvander@579
   136
			search = true;
dvander@579
   137
dvander@579
   138
		if (!search)
dvander@579
   139
			continue;
dvander@579
   140
dvander@579
   141
		mm_KeySplit(buffer, key, sizeof(key) - 1, val, sizeof(val) - 1);
dvander@579
   142
		if (stricmp(key, "Game") != 0 && stricmp(key, "GameBin") != 0)
dvander@579
   143
			continue;
dvander@579
   144
dvander@579
   145
		if (strncmp(val, "|gameinfo_path|", sizeof("|gameinfo_path|") - 1) == 0)
dvander@579
   146
		{
dvander@579
   147
			ptr = &val[sizeof("|gameinfo_path|") - 1];
dvander@579
   148
			if (ptr[0] == '.')
dvander@579
   149
				ptr++;
dvander@579
   150
			lptr = game_path;
dvander@579
   151
		}
dvander@579
   152
		else
dvander@579
   153
		{
dvander@579
   154
			ptr = val;
dvander@579
   155
			lptr = cur_path;
dvander@579
   156
		}
dvander@579
   157
dvander@579
   158
		if (stricmp(key, "GameBin") == 0)
dvander@579
   159
			mm_PathFormat(temp_path, sizeof(temp_path), "%s/%s/" SERVER_NAME, lptr, ptr);
dvander@579
   160
		else if (!ptr[0])
dvander@579
   161
			mm_PathFormat(temp_path, sizeof(temp_path), "%s/bin/" SERVER_NAME, lptr);
dvander@579
   162
		else
dvander@579
   163
			mm_PathFormat(temp_path, sizeof(temp_path), "%s/%s/bin/" SERVER_NAME, lptr, ptr);
dvander@579
   164
dvander@579
   165
		if (mm_PathCmp(mm_path, temp_path))
dvander@579
   166
			continue;
dvander@579
   167
dvander@579
   168
		FILE *exists = fopen(temp_path, "rb");
dvander@579
   169
		if (!exists)
dvander@579
   170
			continue;
dvander@579
   171
		fclose(exists);
dvander@579
   172
dvander@579
   173
		/* exists is still non-NULL... use this as a flag */
dvander@579
   174
		for (unsigned int i = 0; i < gamedll_path_count; i++)
dvander@579
   175
		{
dvander@579
   176
			if (mm_PathCmp(gamedll_paths[i], temp_path))
dvander@579
   177
			{
dvander@579
   178
				exists = NULL;
dvander@579
   179
				break;
dvander@579
   180
			}
dvander@579
   181
		}
dvander@579
   182
dvander@579
   183
		if (!exists)
dvander@579
   184
			continue;
dvander@579
   185
dvander@579
   186
		mm_Format(gamedll_paths[gamedll_path_count],
dvander@579
   187
				  PLATFORM_MAX_PATH,
dvander@579
   188
				  "%s",
dvander@579
   189
				  temp_path);
dvander@579
   190
		gamedll_path_count++;
dvander@579
   191
dvander@579
   192
		if (gamedll_path_count == MAX_GAMEDLL_PATHS)
dvander@579
   193
			break;
dvander@579
   194
	}
dvander@579
   195
	fclose(fp);
dvander@579
   196
dvander@579
   197
	game_info_detected = 1;
dvander@579
   198
dvander@579
   199
	return true;
dvander@579
   200
}
dvander@579
   201
dvander@579
   202
static void
dvander@579
   203
mm_FreeCachedLibraries()
dvander@579
   204
{
dvander@579
   205
	for (unsigned int i = 0; i < gamedll_path_count; i++)
dvander@579
   206
	{
dvander@579
   207
		if (gamedll_libs[i] == NULL)
dvander@579
   208
			continue;
dvander@579
   209
		mm_UnloadLibrary(gamedll_libs[i]);
dvander@579
   210
	}
dvander@579
   211
}
dvander@579
   212
dvander@579
   213
static void
dvander@579
   214
mm_PatchDllInit(bool patch);
dvander@579
   215
dvander@579
   216
static void *isgd_orig_call = NULL;
dvander@579
   217
dvander@579
   218
class VEmptyClass
dvander@579
   219
{
dvander@579
   220
};
dvander@579
   221
dvander@579
   222
class IServerGameDLL
dvander@579
   223
{
dvander@579
   224
public:
dvander@579
   225
	virtual bool DLLInit(QueryValveInterface engineFactory, 
dvander@579
   226
						 QueryValveInterface physicsFactory, 
dvander@579
   227
						 QueryValveInterface fileSystemFactory, 
dvander@579
   228
						 void *pGlobals)
dvander@579
   229
	{
dvander@579
   230
		MetamodBackend backend = mm_DetermineBackend(engineFactory);
dvander@579
   231
dvander@579
   232
		char error[255];
dvander@579
   233
		if (backend == MMBackend_UNKNOWN)
dvander@579
   234
		{
dvander@579
   235
			mm_LogFatal("Could not detect engine version");
dvander@579
   236
		}
dvander@579
   237
		else
dvander@579
   238
		{
dvander@579
   239
			if (!mm_LoadMetamodLibrary(backend, error, sizeof(error)))
dvander@579
   240
			{
dvander@579
   241
				mm_LogFatal("Detected engine %d but could not load: %s", backend, error);
dvander@579
   242
			}
dvander@579
   243
			else
dvander@579
   244
			{
dvander@579
   245
				typedef IGameDllBridge *(*GetGameDllBridge)();
dvander@579
   246
				GetGameDllBridge get_bridge = (GetGameDllBridge)mm_GetProcAddress("GetGameDllBridge");
dvander@579
   247
				if (get_bridge == NULL)
dvander@579
   248
				{
dvander@579
   249
					mm_UnloadMetamodLibrary();
dvander@579
   250
					mm_LogFatal("Detected engine %d but could not find GetGameDllBridge callback", backend);
dvander@579
   251
				}
dvander@579
   252
				gamedll_bridge = get_bridge();
dvander@579
   253
			}
dvander@579
   254
		}
dvander@579
   255
dvander@579
   256
		if (gamedll_bridge)
dvander@579
   257
		{
dvander@579
   258
			gamedll_bridge_info info;
dvander@579
   259
dvander@579
   260
			info.engineFactory = (QueryValveInterface)engineFactory;
dvander@579
   261
			info.physicsFactory = (QueryValveInterface)physicsFactory;
dvander@579
   262
			info.fsFactory = (QueryValveInterface)fileSystemFactory;
dvander@579
   263
			info.pGlobals = pGlobals;
dvander@579
   264
			info.dllVersion = gamedll_version;
dvander@579
   265
			info.isgd = gamedll_iface;
dvander@579
   266
			info.gsFactory = gamedll_qvi;
dvander@579
   267
dvander@579
   268
			strcpy(error, "Unknown error");
dvander@579
   269
			if (!gamedll_bridge->DLLInit_Pre(&info, error, sizeof(error)))
dvander@579
   270
			{
dvander@579
   271
				gamedll_bridge = NULL;
dvander@579
   272
				mm_UnloadMetamodLibrary();
dvander@579
   273
				mm_LogFatal("Unknown error loading Metamod for engine %d: %s", backend, error);	
dvander@579
   274
			}
dvander@579
   275
		}
dvander@579
   276
dvander@579
   277
		/* Call the original */
dvander@579
   278
		bool result;
dvander@579
   279
		{
dvander@579
   280
			union
dvander@579
   281
			{
dvander@579
   282
				bool (VEmptyClass::*mfpnew)(QueryValveInterface engineFactory, 
dvander@579
   283
										 	QueryValveInterface physicsFactory, 
dvander@579
   284
										 	QueryValveInterface fileSystemFactory, 
dvander@579
   285
										 	void *pGlobals);
dvander@579
   286
#if defined _WIN32
dvander@579
   287
				void *addr;
dvander@579
   288
			} u;
dvander@579
   289
			u.addr = isgd_orig_call;
dvander@579
   290
#else
dvander@579
   291
				struct
dvander@579
   292
				{
dvander@579
   293
					void *addr;
dvander@579
   294
					intptr_t adjustor;
dvander@579
   295
				} s;
dvander@579
   296
			} u;
dvander@579
   297
			u.s.addr = isgd_orig_call;
dvander@579
   298
			u.s.adjustor = 0;
dvander@579
   299
#endif
dvander@579
   300
			result = (((VEmptyClass *)gamedll_iface)->*u.mfpnew)(engineFactory,
dvander@579
   301
																 physicsFactory,
dvander@579
   302
																 fileSystemFactory,
dvander@579
   303
																 pGlobals);
dvander@579
   304
		}
dvander@579
   305
dvander@579
   306
		/**
dvander@579
   307
		 * :TODO: possible logic hole here, what happens if the gamedll REALLY returns false? 
dvander@579
   308
		 * I'm pretty sure we'll die horribly.
dvander@579
   309
		 */
dvander@579
   310
dvander@579
   311
		if (!result)
dvander@579
   312
		{
dvander@579
   313
			gamedll_bridge->Unload();
dvander@579
   314
			mm_UnloadMetamodLibrary();
dvander@579
   315
			gamedll_bridge = NULL;
dvander@579
   316
		}
dvander@579
   317
		else if (gamedll_bridge != NULL)
dvander@579
   318
		{
dvander@579
   319
			gamedll_bridge->DLLInit_Post();
dvander@579
   320
		}
dvander@579
   321
dvander@579
   322
		mm_PatchDllInit(false);
dvander@579
   323
dvander@579
   324
		return result;
dvander@579
   325
	}
dvander@579
   326
};
dvander@579
   327
dvander@579
   328
static IServerGameDLL isgd_thunk;
dvander@579
   329
dvander@579
   330
static void
dvander@579
   331
mm_PatchDllInit(bool patch)
dvander@579
   332
{
dvander@579
   333
	void **vtable_src;
dvander@579
   334
	void **vtable_dest;
dvander@579
   335
	SourceHook::MemFuncInfo mfp;
dvander@579
   336
dvander@579
   337
	SourceHook::GetFuncInfo(&IServerGameDLL::DLLInit, mfp);
dvander@579
   338
dvander@579
   339
	assert(mfp.isVirtual);
dvander@579
   340
	assert(mfp.thisptroffs == 0);
dvander@579
   341
	assert(mfp.vtbloffs == 0);
dvander@579
   342
dvander@579
   343
	vtable_src = (void **)*(void **)&isgd_thunk;
dvander@579
   344
	vtable_dest = (void **)*(void **)gamedll_iface;
dvander@579
   345
dvander@579
   346
	SourceHook::SetMemAccess(&vtable_dest[mfp.vtblindex],
dvander@579
   347
							 sizeof(void*),
dvander@579
   348
							 SH_MEM_READ|SH_MEM_WRITE|SH_MEM_EXEC);
dvander@579
   349
dvander@579
   350
	if (patch)
dvander@579
   351
	{
dvander@579
   352
		assert(isgd_orig_call == NULL);
dvander@579
   353
		isgd_orig_call = vtable_dest[mfp.vtblindex];
dvander@579
   354
		vtable_dest[mfp.vtblindex] = vtable_src[mfp.vtblindex];
dvander@579
   355
	}
dvander@579
   356
	else
dvander@579
   357
	{
dvander@579
   358
		assert(isgd_orig_call != NULL);
dvander@579
   359
		vtable_dest[mfp.vtblindex] = isgd_orig_call;
dvander@579
   360
		isgd_orig_call = NULL;
dvander@579
   361
	}
dvander@579
   362
}
dvander@579
   363
dvander@579
   364
static void
dvander@579
   365
mm_PrepForGameLoad()
dvander@579
   366
{
dvander@579
   367
	mm_PatchDllInit(true);
dvander@579
   368
}
dvander@579
   369
dvander@579
   370
void *
dvander@579
   371
mm_GameDllRequest(const char *name, int *ret)
dvander@579
   372
{
dvander@579
   373
	if (gamedll_lib != NULL && gamedll_bridge == NULL)
dvander@579
   374
	{
dvander@579
   375
		mm_LogFatal("Requested unknown interface before game load: %s", name);
dvander@579
   376
		return gamedll_qvi(name, ret);
dvander@579
   377
	}
dvander@579
   378
dvander@579
   379
	if (strncmp(name, "ServerGameDLL", 13) == 0)
dvander@579
   380
	{
dvander@579
   381
		if (!mm_DetectGameInformation())
dvander@579
   382
		{
dvander@579
   383
			if (ret != NULL)
dvander@579
   384
				*ret = 1;
dvander@579
   385
			return NULL;
dvander@579
   386
		}
dvander@579
   387
dvander@579
   388
		void *lib;
dvander@579
   389
		char error[255];
dvander@579
   390
		void *ptr = NULL;
dvander@579
   391
		QueryValveInterface qvi;
dvander@579
   392
		for (unsigned int i = 0; i < gamedll_path_count; i++)
dvander@579
   393
		{
dvander@579
   394
			if (gamedll_libs[i] == NULL)
dvander@579
   395
			{
dvander@579
   396
				lib = mm_LoadLibrary(gamedll_paths[i], error, sizeof(error));
dvander@579
   397
				if (lib == NULL)
dvander@579
   398
					continue;
dvander@579
   399
				gamedll_libs[i] = lib;
dvander@579
   400
			}
dvander@579
   401
			lib = gamedll_libs[i];
dvander@579
   402
			qvi = (QueryValveInterface)mm_GetLibAddress(lib, "CreateInterface");
dvander@579
   403
			if (qvi == NULL)
dvander@579
   404
				continue;
dvander@579
   405
			ptr = qvi(name, ret);
dvander@579
   406
			if (ptr != NULL)
dvander@579
   407
			{
dvander@579
   408
				gamedll_libs[i] = NULL;
dvander@579
   409
				break;
dvander@579
   410
			}
dvander@579
   411
		}
dvander@579
   412
dvander@579
   413
		if (ptr != NULL)
dvander@579
   414
		{
dvander@579
   415
			mm_FreeCachedLibraries();	
dvander@579
   416
			gamedll_lib = lib;
dvander@579
   417
			gamedll_iface = (IServerGameDLL *)ptr;
dvander@579
   418
			gamedll_qvi = qvi;
dvander@579
   419
			gamedll_version = atoi(&name[13]);
dvander@579
   420
			mm_PrepForGameLoad();
dvander@579
   421
dvander@579
   422
			if (ret != NULL)
dvander@579
   423
				*ret = 0;
dvander@579
   424
			return ptr;
dvander@579
   425
		}
dvander@579
   426
	}
dvander@579
   427
	else if (game_info_detected == 0)
dvander@579
   428
	{
dvander@579
   429
		mm_LogFatal("Received interface request too early: %s", name);
dvander@579
   430
	}
dvander@579
   431
dvander@579
   432
	if (ret != NULL)
dvander@579
   433
		*ret = 1;
dvander@579
   434
	return NULL;
dvander@579
   435
}
dvander@579
   436