loader/serverplugin.cpp
author Scott Ehlert <ds@alliedmods.net>
Tue Nov 18 07:20:38 2008 -0600 (2008-11-18)
changeset 576 fc3600fed257
parent 555 22e39517e97b
child 579 be04fd67923b
permissions -rw-r--r--
Added unload logic for core and core-legacy; no crash on exit anymore
dvander@546
     1
#include <stdio.h>
dvander@547
     2
#include <string.h>
dvander@546
     3
#include <assert.h>
dvander@546
     4
#include <stddef.h>
dvander@546
     5
#include "loader.h"
dvander@546
     6
#include <sh_memfuncinfo.h>
dvander@546
     7
#include <sh_memory.h>
dvander@546
     8
#include "serverplugin.h"
dvander@546
     9
dvander@546
    10
typedef enum
dvander@546
    11
{
dvander@546
    12
	PLUGIN_CONTINUE = 0,
dvander@546
    13
	PLUGIN_OVERRIDE,
dvander@546
    14
	PLUGIN_STOP,
dvander@546
    15
} PLUGIN_RESULT;
dvander@546
    16
dvander@546
    17
typedef enum
dvander@546
    18
{
dvander@546
    19
    eQueryCvarValueStatus_ValueIntact=0,
dvander@546
    20
    eQueryCvarValueStatus_CvarNotFound=1,
dvander@546
    21
    eQueryCvarValueStatus_NotACvar=2,
dvander@546
    22
    eQueryCvarValueStatus_CvarProtected=3
dvander@546
    23
} EQueryCvarValueStatus;
dvander@546
    24
dvander@546
    25
typedef int QueryCvarCookie_t;
dvander@546
    26
class CCommand;
dvander@546
    27
class IServerPluginCallbacks;
dvander@546
    28
struct edict_t;
dvander@546
    29
dvander@546
    30
#if defined WIN32
dvander@546
    31
#define LIBRARY_EXT		".dll"
dvander@546
    32
#else
dvander@546
    33
#define LIBRARY_EXT		"_i486.so"
dvander@546
    34
#endif
dvander@546
    35
dvander@546
    36
class IRandomThings
dvander@546
    37
{
dvander@546
    38
public:
dvander@546
    39
	virtual PLUGIN_RESULT ClientCommand(edict_t *pEntity, const CCommand& args)
dvander@546
    40
	{
dvander@546
    41
		return PLUGIN_CONTINUE;
dvander@546
    42
	}
dvander@546
    43
};
dvander@546
    44
dvander@546
    45
/**
dvander@546
    46
 * The vtable must match the general layout for ISPC.  We modify the vtable
dvander@546
    47
 * based on what we get back.
dvander@546
    48
 */
dvander@546
    49
class ServerPlugin
dvander@546
    50
{
dvander@546
    51
	IVspBridge* bridge;
dvander@546
    52
	unsigned int vsp_version;
dvander@546
    53
	bool load_allowed;
dvander@546
    54
public:
dvander@546
    55
	ServerPlugin()
dvander@546
    56
	{
dvander@546
    57
		load_allowed = false;
dvander@546
    58
	}
dvander@546
    59
	virtual bool Load(QueryValveInterface engineFactory, QueryValveInterface gsFactory)
dvander@546
    60
	{
dvander@546
    61
		MetamodBackend backend = MMBackend_UNKNOWN;
dvander@546
    62
dvander@546
    63
		if (!load_allowed)
dvander@546
    64
			return false;
dvander@546
    65
dvander@546
    66
		load_allowed = false;
dvander@546
    67
dvander@546
    68
		/* Check for L4D */
dvander@546
    69
		if (engineFactory("VEngineServer022", NULL) != NULL &&
dvander@546
    70
			engineFactory("VEngineCvar007", NULL) != NULL)
dvander@546
    71
		{
dvander@546
    72
			backend = MMBackend_Left4Dead;
dvander@546
    73
		}
dvander@546
    74
		else if (engineFactory("VEngineServer021", NULL) != NULL)
dvander@546
    75
		{
dvander@546
    76
			/* Check for OB */
dvander@546
    77
			if (engineFactory("VEngineCvar004", NULL) != NULL &&
dvander@546
    78
				engineFactory("VModelInfoServer002", NULL) != NULL)
dvander@546
    79
			{
dvander@546
    80
				backend = MMBackend_Episode2;
dvander@546
    81
			}
dvander@546
    82
			/* Check for EP1 */
dvander@546
    83
			else if (engineFactory("VModelInfoServer001", NULL) != NULL &&
dvander@546
    84
					 (engineFactory("VEngineCvar003", NULL) != NULL ||
dvander@546
    85
					  engineFactory("VEngineCvar002", NULL) != NULL))
dvander@546
    86
			{
dvander@546
    87
				backend = MMBackend_Episode1;
dvander@546
    88
			}
dvander@546
    89
		}
dvander@546
    90
dvander@546
    91
		if (backend == MMBackend_UNKNOWN)
dvander@546
    92
		{
dvander@546
    93
			mm_LogFatal("Could not detect engine version, spewing stats:");
dvander@546
    94
			return false;
dvander@546
    95
		}
dvander@546
    96
		else if (backend >= MMBackend_Episode2)
dvander@546
    97
		{
dvander@546
    98
			/* We need to insert the right type of call into this vtable */
dvander@546
    99
			void **vtable_src;
dvander@546
   100
			void **vtable_dest;
dvander@546
   101
			IRandomThings sample;
dvander@546
   102
			SourceHook::MemFuncInfo mfp_dest, mfp_src;
dvander@546
   103
dvander@546
   104
			mfp_dest.isVirtual = false;
dvander@546
   105
			mfp_src.isVirtual = false;
dvander@546
   106
dvander@546
   107
			SourceHook::GetFuncInfo(&ServerPlugin::ClientCommand, mfp_dest);
dvander@546
   108
			SourceHook::GetFuncInfo(&IRandomThings::ClientCommand, mfp_src);
dvander@546
   109
dvander@546
   110
			assert(mfp_dest.isVirtual);
dvander@546
   111
			assert(mfp_dest.thisptroffs == 0);
dvander@546
   112
			assert(mfp_dest.vtbloffs == 0);
dvander@546
   113
			assert(mfp_src.isVirtual);
dvander@546
   114
			assert(mfp_src.thisptroffs == 0);
dvander@546
   115
			assert(mfp_src.vtbloffs == 0);
dvander@546
   116
dvander@546
   117
			vtable_src = (void **)*(void **)&sample;
dvander@546
   118
			vtable_dest = (void **)*(void **)this;
dvander@546
   119
			SourceHook::SetMemAccess(&vtable_dest[mfp_dest.vtblindex],
dvander@546
   120
									 sizeof(void*),
dvander@546
   121
									 SH_MEM_READ|SH_MEM_WRITE|SH_MEM_EXEC);
dvander@546
   122
			vtable_dest[mfp_dest.vtblindex] = vtable_src[mfp_src.vtblindex];
dvander@546
   123
		}
dvander@546
   124
dvander@546
   125
		char error[255];
dvander@546
   126
		if (!mm_LoadMetamodLibrary(backend, error, sizeof(error)))
dvander@546
   127
		{
dvander@546
   128
			mm_LogFatal("Detected engine %d but could not load: %s", backend, error);
dvander@546
   129
			return false;
dvander@546
   130
		}
dvander@546
   131
dvander@546
   132
		typedef IVspBridge *(*GetVspBridge)();
dvander@546
   133
		GetVspBridge get_bridge = (GetVspBridge)mm_GetProcAddress("GetVspBridge");
dvander@546
   134
		if (get_bridge == NULL)
dvander@546
   135
		{
dvander@546
   136
			mm_UnloadMetamodLibrary();
dvander@547
   137
			mm_LogFatal("Detected engine %d but could not find GetVspBridge callback.", backend);
dvander@546
   138
			return false;
dvander@546
   139
		}
dvander@546
   140
dvander@546
   141
		bridge = get_bridge();
dvander@546
   142
dvander@546
   143
		vsp_bridge_info info;
dvander@546
   144
dvander@546
   145
		info.engineFactory = engineFactory;
dvander@546
   146
		info.gsFactory = gsFactory;
dvander@546
   147
		info.vsp_callbacks = (IServerPluginCallbacks*)this;
dvander@546
   148
		info.vsp_version = vsp_version;
dvander@546
   149
dvander@547
   150
		strcpy(error, "Unknown error");
dvander@547
   151
		if (!bridge->Load(&info, error, sizeof(error)))
dvander@546
   152
		{
dvander@546
   153
			mm_UnloadMetamodLibrary();
dvander@547
   154
			mm_LogFatal("Unknown error loading Metamod for engine %d: %s", backend, error);	
dvander@546
   155
			return false;
dvander@546
   156
		}
dvander@546
   157
dvander@546
   158
		return true;
dvander@546
   159
	}
dvander@546
   160
	virtual void Unload()
dvander@546
   161
	{
dvander@546
   162
		if (bridge == NULL)
dvander@546
   163
			return;
dvander@546
   164
		bridge->Unload();
ds@576
   165
		mm_UnloadMetamodLibrary();
dvander@546
   166
	}
dvander@546
   167
	virtual void Pause()
dvander@546
   168
	{
dvander@546
   169
	}
dvander@546
   170
	virtual void UnPause()
dvander@546
   171
	{
dvander@546
   172
	}
dvander@546
   173
	virtual const char *GetPluginDescription()
dvander@546
   174
	{
dvander@546
   175
		if (bridge == NULL)
dvander@546
   176
			return "Metamod:Source Loader Shim";
dvander@546
   177
		return bridge->GetDescription();
dvander@546
   178
	}
dvander@546
   179
	virtual void LevelInit(char const *pMapName)
dvander@546
   180
	{
dvander@546
   181
	}
dvander@546
   182
	virtual void ServerActivate(edict_t *pEdictList, int edictCount, int clientMax)
dvander@546
   183
	{
dvander@546
   184
	}
dvander@546
   185
	virtual void GameFrame(bool simulating)
dvander@546
   186
	{
dvander@546
   187
	}
dvander@546
   188
	virtual void LevelShutdown()
dvander@546
   189
	{
dvander@546
   190
	}
dvander@546
   191
	virtual void ClientActive(edict_t *pEntity)
dvander@546
   192
	{
dvander@546
   193
	}
dvander@546
   194
	virtual void ClientDisconnect(edict_t *pEntity)
dvander@546
   195
	{
dvander@546
   196
	}
dvander@546
   197
	virtual void ClientPutInServer(edict_t *pEntity, char const *playername)
dvander@546
   198
	{
dvander@546
   199
	}
dvander@546
   200
	virtual void SetCommandClient(int index)
dvander@546
   201
	{
dvander@546
   202
	}
dvander@546
   203
	virtual void ClientSettingsChanged(edict_t *pEdict)
dvander@546
   204
	{
dvander@546
   205
	}
dvander@546
   206
	virtual PLUGIN_RESULT ClientConnect(bool *bAllowConnect,
dvander@546
   207
										edict_t *pEntity,
dvander@546
   208
										const char *pszName,
dvander@546
   209
										const char *pszAddress,
dvander@546
   210
										char *reject,
dvander@546
   211
										int maxrejectlen) 
dvander@546
   212
	{
dvander@546
   213
		return PLUGIN_CONTINUE;
dvander@546
   214
	}
dvander@546
   215
	virtual PLUGIN_RESULT ClientCommand(edict_t *pEntity)
dvander@546
   216
	{
dvander@546
   217
		return PLUGIN_CONTINUE;
dvander@546
   218
	}
dvander@546
   219
	virtual PLUGIN_RESULT NetworkIDValidated(const char *pszUserName, const char *pszNetworkID)
dvander@546
   220
	{
dvander@546
   221
		return PLUGIN_CONTINUE;
dvander@546
   222
	}
dvander@546
   223
	virtual void OnQueryCvarValueFinished(QueryCvarCookie_t iCookie,
dvander@546
   224
										  edict_t *pPlayerEntity,
dvander@546
   225
										  EQueryCvarValueStatus eStatus,
dvander@546
   226
										  const char *pCvarName,
dvander@546
   227
										  const char *pCvarValue)
dvander@546
   228
	{
dvander@546
   229
	}
dvander@546
   230
	void PrepForLoad(unsigned int version)
dvander@546
   231
	{
dvander@546
   232
		vsp_version = version;
dvander@546
   233
		load_allowed = true;
dvander@546
   234
	}
dvander@546
   235
	bool IsLoaded()
dvander@546
   236
	{
dvander@546
   237
		return bridge != NULL;
dvander@546
   238
	}
dvander@546
   239
};
dvander@546
   240
dvander@546
   241
ServerPlugin mm_vsp_callbacks;
dvander@546
   242
dvander@546
   243
void *mm_GetVspCallbacks(unsigned int version)
dvander@546
   244
{
dvander@546
   245
	if (mm_vsp_callbacks.IsLoaded())
dvander@546
   246
		return NULL;
dvander@546
   247
dvander@555
   248
	/* Only support versions 1 or 2 right now */
dvander@555
   249
	if (version > 2)
dvander@555
   250
		return NULL;
dvander@555
   251
dvander@546
   252
	mm_vsp_callbacks.PrepForLoad(version);
dvander@546
   253
dvander@546
   254
	return &mm_vsp_callbacks;
dvander@546
   255
}
dvander@546
   256