dvander@608: /** dvander@608: * vim: set ts=4 : dvander@608: * ====================================================== dvander@608: * Metamod:Source dvander@608: * Copyright (C) 2004-2008 AlliedModders LLC and authors. dvander@608: * All rights reserved. dvander@608: * ====================================================== dvander@608: * dvander@608: * This software is provided 'as-is', without any express or implied warranty. dvander@608: * In no event will the authors be held liable for any damages arising from dvander@608: * the use of this software. dvander@608: * dvander@608: * Permission is granted to anyone to use this software for any purpose, dvander@608: * including commercial applications, and to alter it and redistribute it dvander@608: * freely, subject to the following restrictions: dvander@608: * dvander@608: * 1. The origin of this software must not be misrepresented; you must not dvander@608: * claim that you wrote the original software. If you use this software in a dvander@608: * product, an acknowledgment in the product documentation would be dvander@608: * appreciated but is not required. dvander@608: * 2. Altered source versions must be plainly marked as such, and must not be dvander@608: * misrepresented as being the original software. dvander@608: * 3. This notice may not be removed or altered from any source distribution. dvander@608: * dvander@608: * Version: $Id$ dvander@608: */ dvander@608: dvander@579: #include dvander@579: #include dvander@579: #include dvander@579: #include dvander@579: #include dvander@579: #include dvander@579: #include "loader.h" dvander@579: #include dvander@579: #include dvander@579: #include "utility.h" dvander@579: #include "gamedll.h" dvander@586: dvander@579: class IServerGameDLL; dvander@579: dvander@579: #define MAX_GAMEDLL_PATHS 10 dvander@579: dvander@579: IGameDllBridge* gamedll_bridge = NULL; dvander@579: static int game_info_detected = 0; ds@637: static const char *game_name = NULL; dvander@579: static char gamedll_paths[MAX_GAMEDLL_PATHS][PLATFORM_MAX_PATH]; dvander@579: static void *gamedll_libs[MAX_GAMEDLL_PATHS]; dvander@579: static unsigned int gamedll_path_count = 0; dvander@579: static void *gamedll_lib = NULL; dvander@579: static IServerGameDLL *gamedll_iface = NULL; dvander@579: static QueryValveInterface gamedll_qvi = NULL; dvander@579: static int gamedll_version = 0; dvander@582: static int isgd_shutdown_index = -1; dvander@579: dvander@579: #if defined _WIN32 dvander@579: #define SERVER_NAME "server.dll" dvander@579: #elif defined __linux__ ds@681: #define SERVER_NAME "server" BINARY_SUFFIX dvander@579: #endif dvander@579: dvander@579: static bool dvander@579: mm_DetectGameInformation() dvander@579: { dvander@579: char mm_path[PLATFORM_MAX_PATH]; dvander@579: char game_path[PLATFORM_MAX_PATH]; dvander@579: dvander@579: if (game_info_detected) dvander@579: return game_info_detected == 1 ? true : false; dvander@579: dvander@579: game_info_detected = -1; dvander@579: ds@637: if ((game_name = mm_GetGameName()) == NULL) dvander@579: { dvander@579: return false; dvander@579: } dvander@579: dvander@579: if (!mm_GetFileOfAddress((void*)mm_DetectGameInformation, mm_path, sizeof(mm_path))) dvander@579: { dvander@579: mm_LogFatal("Could not locate metamod loader library path"); dvander@579: return false; dvander@579: } dvander@579: dvander@579: if (!mm_ResolvePath(game_name, game_path, sizeof(game_path))) dvander@579: { dvander@579: mm_LogFatal("Could not resolve path: %s", game_name); dvander@579: return false; dvander@579: } dvander@579: dvander@579: FILE *fp; dvander@579: char gameinfo_path[PLATFORM_MAX_PATH]; dvander@579: dvander@579: mm_PathFormat(gameinfo_path, sizeof(gameinfo_path), "%s/gameinfo.txt", game_path); dvander@579: if ((fp = fopen(gameinfo_path, "rt")) == NULL) dvander@579: { dvander@579: mm_LogFatal("Could not read file: %s", gameinfo_path); dvander@579: return false; dvander@579: } dvander@579: dvander@579: char temp_path[PLATFORM_MAX_PATH]; dvander@579: char cur_path[PLATFORM_MAX_PATH]; dvander@579: getcwd(cur_path, sizeof(cur_path)); dvander@579: dvander@579: char *ptr; dvander@579: const char *lptr; dvander@579: bool search = false; dvander@579: char buffer[255], key[128], val[128]; dvander@579: while (!feof(fp) && fgets(buffer, sizeof(buffer), fp) != NULL) dvander@579: { dvander@579: mm_TrimComments(buffer); dvander@579: mm_TrimLeft(buffer); dvander@579: mm_TrimRight(buffer); dvander@579: dvander@579: if (stricmp(buffer, "SearchPaths") == 0) dvander@579: search = true; dvander@579: dvander@579: if (!search) dvander@579: continue; dvander@579: dvander@579: mm_KeySplit(buffer, key, sizeof(key) - 1, val, sizeof(val) - 1); dvander@579: if (stricmp(key, "Game") != 0 && stricmp(key, "GameBin") != 0) dvander@579: continue; dvander@579: dvander@579: if (strncmp(val, "|gameinfo_path|", sizeof("|gameinfo_path|") - 1) == 0) dvander@579: { dvander@579: ptr = &val[sizeof("|gameinfo_path|") - 1]; dvander@579: if (ptr[0] == '.') dvander@579: ptr++; dvander@579: lptr = game_path; dvander@579: } dvander@579: else dvander@579: { dvander@579: ptr = val; dvander@579: lptr = cur_path; dvander@579: } dvander@579: dvander@579: if (stricmp(key, "GameBin") == 0) dvander@579: mm_PathFormat(temp_path, sizeof(temp_path), "%s/%s/" SERVER_NAME, lptr, ptr); dvander@579: else if (!ptr[0]) dvander@579: mm_PathFormat(temp_path, sizeof(temp_path), "%s/bin/" SERVER_NAME, lptr); dvander@579: else dvander@579: mm_PathFormat(temp_path, sizeof(temp_path), "%s/%s/bin/" SERVER_NAME, lptr, ptr); dvander@579: dvander@579: if (mm_PathCmp(mm_path, temp_path)) dvander@579: continue; dvander@579: dvander@579: FILE *exists = fopen(temp_path, "rb"); dvander@579: if (!exists) dvander@579: continue; dvander@579: fclose(exists); dvander@579: dvander@579: /* exists is still non-NULL... use this as a flag */ dvander@579: for (unsigned int i = 0; i < gamedll_path_count; i++) dvander@579: { dvander@579: if (mm_PathCmp(gamedll_paths[i], temp_path)) dvander@579: { dvander@579: exists = NULL; dvander@579: break; dvander@579: } dvander@579: } dvander@579: dvander@579: if (!exists) dvander@579: continue; dvander@579: dvander@579: mm_Format(gamedll_paths[gamedll_path_count], dvander@579: PLATFORM_MAX_PATH, dvander@579: "%s", dvander@579: temp_path); dvander@579: gamedll_path_count++; dvander@579: dvander@579: if (gamedll_path_count == MAX_GAMEDLL_PATHS) dvander@579: break; dvander@579: } dvander@579: fclose(fp); dvander@579: dvander@579: game_info_detected = 1; dvander@579: ds@681: if (gamedll_path_count == 0) ds@681: { ds@681: mm_LogFatal("Could not detect any valid game paths in gameinfo.txt"); ds@681: return false; ds@681: } ds@681: dvander@579: return true; dvander@579: } dvander@579: dvander@579: static void dvander@579: mm_FreeCachedLibraries() dvander@579: { dvander@579: for (unsigned int i = 0; i < gamedll_path_count; i++) dvander@579: { dvander@579: if (gamedll_libs[i] == NULL) dvander@579: continue; dvander@579: mm_UnloadLibrary(gamedll_libs[i]); dvander@579: } dvander@579: } dvander@579: dvander@579: static void dvander@579: mm_PatchDllInit(bool patch); dvander@579: dvander@582: static void dvander@582: mm_PatchDllShutdown(); dvander@582: dvander@582: static void *isgd_orig_init = NULL; dvander@582: static void *isgd_orig_shutdown = NULL; dvander@579: dvander@579: class VEmptyClass dvander@579: { dvander@579: }; dvander@579: dvander@579: class IServerGameDLL dvander@579: { dvander@579: public: dvander@579: virtual bool DLLInit(QueryValveInterface engineFactory, dvander@579: QueryValveInterface physicsFactory, dvander@579: QueryValveInterface fileSystemFactory, dvander@579: void *pGlobals) dvander@579: { ds@637: MetamodBackend backend = mm_DetermineBackend(engineFactory, game_name); dvander@579: dvander@579: char error[255]; dvander@579: if (backend == MMBackend_UNKNOWN) dvander@579: { dvander@579: mm_LogFatal("Could not detect engine version"); dvander@579: } dvander@579: else dvander@579: { dvander@579: if (!mm_LoadMetamodLibrary(backend, error, sizeof(error))) dvander@579: { dvander@579: mm_LogFatal("Detected engine %d but could not load: %s", backend, error); dvander@579: } dvander@579: else dvander@579: { dvander@579: typedef IGameDllBridge *(*GetGameDllBridge)(); dvander@579: GetGameDllBridge get_bridge = (GetGameDllBridge)mm_GetProcAddress("GetGameDllBridge"); dvander@579: if (get_bridge == NULL) dvander@579: { dvander@579: mm_UnloadMetamodLibrary(); dvander@579: mm_LogFatal("Detected engine %d but could not find GetGameDllBridge callback", backend); dvander@579: } dvander@588: else dvander@588: { dvander@588: gamedll_bridge = get_bridge(); dvander@588: } dvander@579: } dvander@579: } dvander@579: dvander@579: if (gamedll_bridge) dvander@579: { dvander@579: gamedll_bridge_info info; dvander@579: dvander@579: info.engineFactory = (QueryValveInterface)engineFactory; dvander@579: info.physicsFactory = (QueryValveInterface)physicsFactory; dvander@579: info.fsFactory = (QueryValveInterface)fileSystemFactory; dvander@579: info.pGlobals = pGlobals; dvander@579: info.dllVersion = gamedll_version; dvander@579: info.isgd = gamedll_iface; dvander@579: info.gsFactory = gamedll_qvi; dvander@579: dvander@579: strcpy(error, "Unknown error"); dvander@579: if (!gamedll_bridge->DLLInit_Pre(&info, error, sizeof(error))) dvander@579: { dvander@579: gamedll_bridge = NULL; dvander@579: mm_UnloadMetamodLibrary(); dvander@579: mm_LogFatal("Unknown error loading Metamod for engine %d: %s", backend, error); dvander@579: } dvander@579: } dvander@579: dvander@579: /* Call the original */ dvander@579: bool result; dvander@579: { dvander@579: union dvander@579: { dvander@579: bool (VEmptyClass::*mfpnew)(QueryValveInterface engineFactory, dvander@579: QueryValveInterface physicsFactory, dvander@579: QueryValveInterface fileSystemFactory, dvander@579: void *pGlobals); dvander@579: #if defined _WIN32 dvander@579: void *addr; dvander@579: } u; dvander@582: u.addr = isgd_orig_init; dvander@579: #else dvander@579: struct dvander@579: { dvander@579: void *addr; dvander@579: intptr_t adjustor; dvander@579: } s; dvander@579: } u; dvander@582: u.s.addr = isgd_orig_init; dvander@579: u.s.adjustor = 0; dvander@579: #endif dvander@579: result = (((VEmptyClass *)gamedll_iface)->*u.mfpnew)(engineFactory, dvander@579: physicsFactory, dvander@579: fileSystemFactory, dvander@579: pGlobals); dvander@579: } dvander@579: dvander@579: /** dvander@579: * :TODO: possible logic hole here, what happens if the gamedll REALLY returns false? dvander@579: * I'm pretty sure we'll die horribly. dvander@579: */ dvander@579: dvander@579: if (!result) dvander@579: { dvander@579: gamedll_bridge->Unload(); dvander@579: mm_UnloadMetamodLibrary(); dvander@579: gamedll_bridge = NULL; dvander@579: } dvander@579: else if (gamedll_bridge != NULL) dvander@579: { dvander@582: gamedll_bridge->DLLInit_Post(&isgd_shutdown_index); dvander@582: assert(isgd_shutdown_index != -1); dvander@582: mm_PatchDllShutdown(); dvander@579: } dvander@579: dvander@579: mm_PatchDllInit(false); dvander@579: dvander@579: return result; dvander@579: } dvander@582: dvander@582: virtual void DLLShutdown() dvander@582: { dvander@582: gamedll_bridge->Unload(); dvander@582: gamedll_bridge = NULL; dvander@582: mm_UnloadMetamodLibrary(); dvander@582: dvander@582: /* Call original function */ dvander@582: { dvander@582: union dvander@582: { dvander@582: void (VEmptyClass::*mfpnew)(); dvander@582: #if defined _WIN32 dvander@582: void *addr; dvander@582: } u; dvander@582: u.addr = isgd_orig_shutdown; dvander@582: #else dvander@582: struct dvander@582: { dvander@582: void *addr; dvander@582: intptr_t adjustor; dvander@582: } s; dvander@582: } u; dvander@582: u.s.addr = isgd_orig_shutdown; dvander@582: u.s.adjustor = 0; dvander@582: #endif dvander@582: (((VEmptyClass *)gamedll_iface)->*u.mfpnew)(); dvander@582: } dvander@582: dvander@582: mm_UnloadLibrary(gamedll_lib); dvander@582: gamedll_lib = NULL; dvander@582: } dvander@579: }; dvander@579: dvander@579: static IServerGameDLL isgd_thunk; dvander@579: dvander@579: static void dvander@579: mm_PatchDllInit(bool patch) dvander@579: { dvander@579: void **vtable_src; dvander@579: void **vtable_dest; dvander@579: SourceHook::MemFuncInfo mfp; dvander@579: dvander@579: SourceHook::GetFuncInfo(&IServerGameDLL::DLLInit, mfp); dvander@579: dvander@579: assert(mfp.isVirtual); dvander@579: assert(mfp.thisptroffs == 0); dvander@579: assert(mfp.vtbloffs == 0); dvander@579: dvander@579: vtable_src = (void **)*(void **)&isgd_thunk; dvander@579: vtable_dest = (void **)*(void **)gamedll_iface; dvander@579: dvander@579: SourceHook::SetMemAccess(&vtable_dest[mfp.vtblindex], dvander@579: sizeof(void*), dvander@579: SH_MEM_READ|SH_MEM_WRITE|SH_MEM_EXEC); dvander@579: dvander@579: if (patch) dvander@579: { dvander@582: assert(isgd_orig_init == NULL); dvander@582: isgd_orig_init = vtable_dest[mfp.vtblindex]; dvander@579: vtable_dest[mfp.vtblindex] = vtable_src[mfp.vtblindex]; dvander@579: } dvander@579: else dvander@579: { dvander@582: assert(isgd_orig_init != NULL); dvander@582: vtable_dest[mfp.vtblindex] = isgd_orig_init; dvander@582: isgd_orig_init = NULL; dvander@579: } dvander@579: } dvander@579: dvander@579: static void dvander@582: mm_PatchDllShutdown() dvander@582: { dvander@582: void **vtable_src; dvander@582: void **vtable_dest; dvander@582: SourceHook::MemFuncInfo mfp; dvander@582: dvander@582: mfp.isVirtual = false; dvander@582: SourceHook::GetFuncInfo(&IServerGameDLL::DLLShutdown, mfp); dvander@582: assert(mfp.isVirtual); dvander@582: assert(mfp.thisptroffs == 0); dvander@582: assert(mfp.vtbloffs == 0); dvander@582: dvander@582: vtable_src = (void **)*(void **)&isgd_thunk; dvander@582: vtable_dest = (void **)*(void **)gamedll_iface; dvander@582: dvander@582: isgd_orig_shutdown = vtable_dest[isgd_shutdown_index]; dvander@582: vtable_dest[isgd_shutdown_index] = vtable_src[mfp.vtblindex]; dvander@582: } dvander@582: dvander@582: static void dvander@579: mm_PrepForGameLoad() dvander@579: { dvander@579: mm_PatchDllInit(true); dvander@579: } dvander@579: dvander@579: void * dvander@579: mm_GameDllRequest(const char *name, int *ret) dvander@579: { ds@606: if (gamedll_lib != NULL && gamedll_bridge == NULL) dvander@579: { dvander@579: return gamedll_qvi(name, ret); dvander@579: } dvander@579: dvander@579: if (strncmp(name, "ServerGameDLL", 13) == 0) dvander@579: { dvander@579: if (!mm_DetectGameInformation()) dvander@579: { dvander@579: if (ret != NULL) dvander@579: *ret = 1; dvander@579: return NULL; dvander@579: } dvander@579: dvander@579: void *lib; dvander@579: char error[255]; dvander@579: void *ptr = NULL; dvander@579: QueryValveInterface qvi; dvander@579: for (unsigned int i = 0; i < gamedll_path_count; i++) dvander@579: { dvander@579: if (gamedll_libs[i] == NULL) dvander@579: { dvander@579: lib = mm_LoadLibrary(gamedll_paths[i], error, sizeof(error)); dvander@579: if (lib == NULL) dvander@579: continue; dvander@579: gamedll_libs[i] = lib; dvander@579: } dvander@579: lib = gamedll_libs[i]; dvander@579: qvi = (QueryValveInterface)mm_GetLibAddress(lib, "CreateInterface"); dvander@579: if (qvi == NULL) dvander@579: continue; dvander@579: ptr = qvi(name, ret); dvander@579: if (ptr != NULL) dvander@579: { dvander@579: gamedll_libs[i] = NULL; dvander@579: break; dvander@579: } dvander@579: } dvander@579: dvander@579: if (ptr != NULL) dvander@579: { dvander@579: mm_FreeCachedLibraries(); dvander@579: gamedll_lib = lib; dvander@579: gamedll_iface = (IServerGameDLL *)ptr; dvander@579: gamedll_qvi = qvi; dvander@579: gamedll_version = atoi(&name[13]); dvander@579: mm_PrepForGameLoad(); dvander@579: dvander@579: if (ret != NULL) dvander@579: *ret = 0; dvander@579: return ptr; dvander@579: } dvander@579: } dvander@579: else if (game_info_detected == 0) dvander@579: { dvander@579: mm_LogFatal("Received interface request too early: %s", name); dvander@579: } dvander@579: dvander@579: if (ret != NULL) dvander@579: *ret = 1; dvander@579: return NULL; dvander@579: } dvander@579: