loader/serverplugin.cpp
author Scott Ehlert <ds@alliedmods.net>
Tue Jul 27 04:26:14 2010 -0500 (2010-07-27)
changeset 729 ce8a0557380a
parent 728 6fd06d6c6e30
child 780 35f2a207badf
permissions -rw-r--r--
Fixed crash regression on old engines (ep1, darkm) caused by previous changeset (bug 4529, r=dvander).
dvander@608
     1
/**
ds@669
     2
 * vim: set ts=4 sw=4 tw=99 noet :
dvander@608
     3
 * ======================================================
dvander@608
     4
 * Metamod:Source
ds@669
     5
 * Copyright (C) 2004-2009 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
dvander@546
    26
#include <stdio.h>
dvander@547
    27
#include <string.h>
dvander@546
    28
#include <assert.h>
dvander@546
    29
#include <stddef.h>
dvander@546
    30
#include "loader.h"
dvander@546
    31
#include <sh_memfuncinfo.h>
dvander@546
    32
#include <sh_memory.h>
dvander@546
    33
#include "serverplugin.h"
ds@683
    34
#include "gamedll.h"
dvander@546
    35
dvander@546
    36
typedef enum
dvander@546
    37
{
dvander@546
    38
	PLUGIN_CONTINUE = 0,
dvander@546
    39
	PLUGIN_OVERRIDE,
dvander@546
    40
	PLUGIN_STOP,
dvander@546
    41
} PLUGIN_RESULT;
dvander@546
    42
dvander@546
    43
typedef enum
dvander@546
    44
{
dvander@546
    45
    eQueryCvarValueStatus_ValueIntact=0,
dvander@546
    46
    eQueryCvarValueStatus_CvarNotFound=1,
dvander@546
    47
    eQueryCvarValueStatus_NotACvar=2,
dvander@546
    48
    eQueryCvarValueStatus_CvarProtected=3
dvander@546
    49
} EQueryCvarValueStatus;
dvander@546
    50
dvander@546
    51
typedef int QueryCvarCookie_t;
dvander@546
    52
class CCommand;
dvander@546
    53
class IServerPluginCallbacks;
dvander@546
    54
struct edict_t;
dvander@546
    55
dvander@546
    56
class IRandomThings
dvander@546
    57
{
dvander@546
    58
public:
dvander@546
    59
	virtual PLUGIN_RESULT ClientCommand(edict_t *pEntity, const CCommand& args)
dvander@546
    60
	{
dvander@546
    61
		return PLUGIN_CONTINUE;
dvander@546
    62
	}
dvander@546
    63
};
dvander@546
    64
dvander@579
    65
IVspBridge *vsp_bridge = NULL;
dvander@579
    66
dvander@546
    67
/**
dvander@546
    68
 * The vtable must match the general layout for ISPC.  We modify the vtable
dvander@546
    69
 * based on what we get back.
dvander@546
    70
 */
dvander@546
    71
class ServerPlugin
dvander@546
    72
{
ds@637
    73
	const char *game_name;
dvander@546
    74
	unsigned int vsp_version;
dvander@546
    75
	bool load_allowed;
dvander@546
    76
public:
dvander@546
    77
	ServerPlugin()
dvander@546
    78
	{
dvander@546
    79
		load_allowed = false;
dvander@546
    80
	}
dvander@546
    81
	virtual bool Load(QueryValveInterface engineFactory, QueryValveInterface gsFactory)
dvander@546
    82
	{
dvander@546
    83
		if (!load_allowed)
dvander@546
    84
			return false;
dvander@546
    85
dvander@546
    86
		load_allowed = false;
dvander@546
    87
ds@683
    88
		/* Backend should already filled in if loaded as gamedll */
ds@683
    89
		if (gamedll_bridge == NULL)
ds@637
    90
		{
ds@683
    91
			if ((game_name = mm_GetGameName()) == NULL)
ds@683
    92
			{
ds@683
    93
				return false;
ds@683
    94
			}
ds@683
    95
ds@683
    96
			mm_backend = mm_DetermineBackend(engineFactory, game_name);
ds@637
    97
		}
ds@637
    98
ds@683
    99
		if (mm_backend == MMBackend_UNKNOWN)
dvander@546
   100
		{
dvander@579
   101
			mm_LogFatal("Could not detect engine version");
dvander@546
   102
			return false;
dvander@546
   103
		}
ds@729
   104
		
ds@729
   105
		void **this_vtable;
ds@729
   106
		this_vtable = (void **)*(void **)this;
ds@729
   107
ds@729
   108
		if (mm_backend >= MMBackend_Episode2)
dvander@546
   109
		{
dvander@546
   110
			/* We need to insert the right type of call into this vtable */
dvander@546
   111
			void **vtable_src;
dvander@546
   112
			IRandomThings sample;
dvander@546
   113
			SourceHook::MemFuncInfo mfp_dest, mfp_src;
dvander@546
   114
dvander@546
   115
			mfp_dest.isVirtual = false;
dvander@546
   116
			mfp_src.isVirtual = false;
dvander@546
   117
dvander@546
   118
			SourceHook::GetFuncInfo(&ServerPlugin::ClientCommand, mfp_dest);
dvander@546
   119
			SourceHook::GetFuncInfo(&IRandomThings::ClientCommand, mfp_src);
dvander@546
   120
dvander@546
   121
			assert(mfp_dest.isVirtual);
dvander@546
   122
			assert(mfp_dest.thisptroffs == 0);
dvander@546
   123
			assert(mfp_dest.vtbloffs == 0);
dvander@546
   124
			assert(mfp_src.isVirtual);
dvander@546
   125
			assert(mfp_src.thisptroffs == 0);
dvander@546
   126
			assert(mfp_src.vtbloffs == 0);
dvander@546
   127
dvander@546
   128
			vtable_src = (void **)*(void **)&sample;
ds@729
   129
			SourceHook::SetMemAccess(&this_vtable[mfp_dest.vtblindex],
ds@687
   130
									 sizeof(void*),
dvander@546
   131
									 SH_MEM_READ|SH_MEM_WRITE|SH_MEM_EXEC);
ds@729
   132
			this_vtable[mfp_dest.vtblindex] = vtable_src[mfp_src.vtblindex];
ds@729
   133
		}
ds@728
   134
ds@729
   135
#ifdef _WIN32
ds@729
   136
		/* AS inserted ClientFullyConnect into vtable, so move entries up on older engines */
ds@729
   137
		if (mm_backend != MMBackend_AlienSwarm)
ds@729
   138
		{
ds@729
   139
			SourceHook::MemFuncInfo mfp_fconnect;
ds@729
   140
			mfp_fconnect.isVirtual = false;
ds@728
   141
ds@729
   142
			SourceHook::GetFuncInfo(&ServerPlugin::ClientFullyConnect, mfp_fconnect);
ds@728
   143
ds@729
   144
			assert(mfp_fconnect.isVirtual);
ds@729
   145
			assert(mfp_fconnect.thisptroffs == 0);
ds@729
   146
			assert(mfp_fconnect.vtbloffs == 0);
ds@728
   147
ds@729
   148
			/* Shifting ClientDisconnect through OnQueryCvarValueFinished up into slot for
ds@729
   149
			 * ClientFullyConnect (8 entries)
ds@729
   150
			 */
ds@729
   151
			SourceHook::SetMemAccess(&this_vtable[mfp_fconnect.vtblindex],
ds@729
   152
									 sizeof(void *) * 8,
ds@729
   153
									 SH_MEM_READ|SH_MEM_WRITE|SH_MEM_EXEC);
ds@729
   154
			memmove(&this_vtable[mfp_fconnect.vtblindex],
ds@729
   155
					&this_vtable[mfp_fconnect.vtblindex + 1],
ds@729
   156
					sizeof(void *) * 8);
dvander@546
   157
		}
ds@729
   158
#endif
dvander@546
   159
dvander@546
   160
		char error[255];
ds@683
   161
		if (gamedll_bridge == NULL)
dvander@546
   162
		{
ds@683
   163
			if (!mm_LoadMetamodLibrary(mm_backend, error, sizeof(error)))
ds@683
   164
			{
ds@683
   165
				mm_LogFatal("Detected engine %d but could not load: %s", mm_backend, error);
ds@683
   166
				return false;
ds@683
   167
			}
dvander@546
   168
		}
dvander@546
   169
dvander@546
   170
		typedef IVspBridge *(*GetVspBridge)();
dvander@546
   171
		GetVspBridge get_bridge = (GetVspBridge)mm_GetProcAddress("GetVspBridge");
dvander@546
   172
		if (get_bridge == NULL)
dvander@546
   173
		{
ds@683
   174
			if (gamedll_bridge == NULL)
ds@683
   175
			{
ds@683
   176
				mm_UnloadMetamodLibrary();
ds@683
   177
			}
ds@683
   178
			mm_LogFatal("Detected engine %d but could not find GetVspBridge callback", mm_backend);
dvander@546
   179
			return false;
dvander@546
   180
		}
dvander@546
   181
dvander@579
   182
		vsp_bridge = get_bridge();
dvander@546
   183
dvander@546
   184
		vsp_bridge_info info;
dvander@546
   185
dvander@546
   186
		info.engineFactory = engineFactory;
dvander@546
   187
		info.gsFactory = gsFactory;
dvander@546
   188
		info.vsp_callbacks = (IServerPluginCallbacks*)this;
dvander@546
   189
		info.vsp_version = vsp_version;
dvander@546
   190
dvander@547
   191
		strcpy(error, "Unknown error");
dvander@579
   192
		if (!vsp_bridge->Load(&info, error, sizeof(error)))
dvander@546
   193
		{
dvander@579
   194
			vsp_bridge = NULL;
ds@683
   195
			if (gamedll_bridge == NULL)
ds@683
   196
			{
ds@683
   197
				mm_UnloadMetamodLibrary();
ds@683
   198
			}
ds@683
   199
			mm_LogFatal("Unknown error loading Metamod for engine %d: %s", mm_backend, error);	
dvander@546
   200
			return false;
dvander@546
   201
		}
dvander@546
   202
dvander@546
   203
		return true;
dvander@546
   204
	}
dvander@546
   205
	virtual void Unload()
dvander@546
   206
	{
dvander@579
   207
		if (vsp_bridge == NULL)
dvander@546
   208
			return;
dvander@579
   209
		vsp_bridge->Unload();
ds@683
   210
ds@683
   211
		if (gamedll_bridge == NULL)
ds@683
   212
		{
ds@683
   213
			mm_UnloadMetamodLibrary();
ds@683
   214
		}
dvander@546
   215
	}
dvander@546
   216
	virtual void Pause()
dvander@546
   217
	{
dvander@546
   218
	}
dvander@546
   219
	virtual void UnPause()
dvander@546
   220
	{
dvander@546
   221
	}
dvander@546
   222
	virtual const char *GetPluginDescription()
dvander@546
   223
	{
dvander@579
   224
		if (vsp_bridge == NULL)
dvander@546
   225
			return "Metamod:Source Loader Shim";
dvander@579
   226
		return vsp_bridge->GetDescription();
dvander@546
   227
	}
dvander@546
   228
	virtual void LevelInit(char const *pMapName)
dvander@546
   229
	{
dvander@546
   230
	}
dvander@546
   231
	virtual void ServerActivate(edict_t *pEdictList, int edictCount, int clientMax)
dvander@546
   232
	{
dvander@546
   233
	}
dvander@546
   234
	virtual void GameFrame(bool simulating)
dvander@546
   235
	{
dvander@546
   236
	}
dvander@546
   237
	virtual void LevelShutdown()
dvander@546
   238
	{
dvander@546
   239
	}
dvander@546
   240
	virtual void ClientActive(edict_t *pEntity)
dvander@546
   241
	{
dvander@546
   242
	}
ds@729
   243
#ifdef _WIN32
ds@728
   244
	virtual void ClientFullyConnect(edict_t *pEntity)
ds@728
   245
	{
ds@728
   246
	}
ds@729
   247
#endif
dvander@546
   248
	virtual void ClientDisconnect(edict_t *pEntity)
dvander@546
   249
	{
dvander@546
   250
	}
dvander@546
   251
	virtual void ClientPutInServer(edict_t *pEntity, char const *playername)
dvander@546
   252
	{
dvander@546
   253
	}
dvander@546
   254
	virtual void SetCommandClient(int index)
dvander@546
   255
	{
dvander@546
   256
	}
dvander@546
   257
	virtual void ClientSettingsChanged(edict_t *pEdict)
dvander@546
   258
	{
dvander@546
   259
	}
dvander@546
   260
	virtual PLUGIN_RESULT ClientConnect(bool *bAllowConnect,
dvander@546
   261
										edict_t *pEntity,
dvander@546
   262
										const char *pszName,
dvander@546
   263
										const char *pszAddress,
dvander@546
   264
										char *reject,
dvander@546
   265
										int maxrejectlen) 
dvander@546
   266
	{
dvander@546
   267
		return PLUGIN_CONTINUE;
dvander@546
   268
	}
dvander@546
   269
	virtual PLUGIN_RESULT ClientCommand(edict_t *pEntity)
dvander@546
   270
	{
dvander@546
   271
		return PLUGIN_CONTINUE;
dvander@546
   272
	}
dvander@546
   273
	virtual PLUGIN_RESULT NetworkIDValidated(const char *pszUserName, const char *pszNetworkID)
dvander@546
   274
	{
dvander@546
   275
		return PLUGIN_CONTINUE;
dvander@546
   276
	}
dvander@546
   277
	virtual void OnQueryCvarValueFinished(QueryCvarCookie_t iCookie,
dvander@546
   278
										  edict_t *pPlayerEntity,
dvander@546
   279
										  EQueryCvarValueStatus eStatus,
dvander@546
   280
										  const char *pCvarName,
dvander@546
   281
										  const char *pCvarValue)
dvander@546
   282
	{
dvander@546
   283
	}
dvander@546
   284
	void PrepForLoad(unsigned int version)
dvander@546
   285
	{
dvander@546
   286
		vsp_version = version;
dvander@546
   287
		load_allowed = true;
dvander@546
   288
	}
dvander@546
   289
};
dvander@546
   290
dvander@546
   291
ServerPlugin mm_vsp_callbacks;
dvander@546
   292
dvander@546
   293
void *mm_GetVspCallbacks(unsigned int version)
dvander@546
   294
{
dvander@579
   295
	if (vsp_bridge != NULL)
dvander@546
   296
		return NULL;
dvander@546
   297
dvander@555
   298
	/* Only support versions 1 or 2 right now */
dvander@555
   299
	if (version > 2)
dvander@555
   300
		return NULL;
dvander@555
   301
dvander@546
   302
	mm_vsp_callbacks.PrepForLoad(version);
dvander@546
   303
dvander@546
   304
	return &mm_vsp_callbacks;
dvander@546
   305
}
dvander@546
   306