extensions/sdktools/vcaller.cpp
author Scott Ehlert <ds@alliedmods.net>
Thu Jul 05 20:17:08 2007 +0000 (2007-07-05)
changeset 1042 a435a9c324df
parent 1031 d9cf44ddcd9c
child 1065 11756fc9fb63
permissions -rw-r--r--
Fixed bug where using vtable index 0 would cause call creation to fail
faluco@1031
     1
/**
faluco@1031
     2
 * vim: set ts=4 :
faluco@1031
     3
 * ===============================================================
faluco@1031
     4
 * SourceMod SDK Tools Extension
faluco@1031
     5
 * Copyright (C) 2004-2007 AlliedModders LLC. All rights reserved.
faluco@1031
     6
 * ===============================================================
faluco@1031
     7
 *
faluco@1031
     8
 * This program is free software; you can redistribute it and/or
faluco@1031
     9
 * modify it under the terms of the GNU General Public License
faluco@1031
    10
 * as published by the Free Software Foundation; either version 2
faluco@1031
    11
 * of the License, or (at your option) any later version.
faluco@1031
    12
 * This program is distributed in the hope that it will be useful,
faluco@1031
    13
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
faluco@1031
    14
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
faluco@1031
    15
 * GNU General Public License for more details.
faluco@1031
    16
 * 
faluco@1031
    17
 * You should have received a copy of the GNU General Public License
faluco@1031
    18
 * along with this program; if not, write to the Free Software
faluco@1031
    19
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
faluco@1031
    20
 *
faluco@1031
    21
 * Version: $Id$
faluco@1031
    22
 */
faluco@1031
    23
dvander@950
    24
#include "extension.h"
dvander@950
    25
#include "vcallbuilder.h"
dvander@950
    26
dvander@950
    27
enum SDKLibrary
dvander@950
    28
{
dvander@950
    29
	SDKLibrary_Server,	/**< server.dll/server_i486.so */
dvander@950
    30
	SDKLibrary_Engine,	/**< engine.dll/engine_*.so */
dvander@950
    31
};
dvander@950
    32
dvander@950
    33
enum SDKPassMethod
dvander@950
    34
{
dvander@950
    35
	SDKPass_Pointer,		/**< Pass as a pointer */
dvander@950
    36
	SDKPass_Plain,			/**< Pass as plain data */
dvander@950
    37
	SDKPass_ByValue,		/**< Pass an object by value */
dvander@950
    38
	SDKPass_ByRef,			/**< Pass an object by reference */
dvander@950
    39
};
dvander@950
    40
ds@1042
    41
int s_vtbl_index = -1;
dvander@950
    42
void *s_call_addr = NULL;
dvander@950
    43
ValveCallType s_vcalltype = ValveCall_Static;
dvander@950
    44
bool s_has_return = false;
dvander@950
    45
ValvePassInfo s_return;
dvander@950
    46
unsigned int s_numparams = 0;
dvander@950
    47
ValvePassInfo s_params[SP_MAX_EXEC_PARAMS];
dvander@950
    48
dvander@950
    49
inline void DecodePassMethod(ValveType vtype, SDKPassMethod method, PassType &type, unsigned int &flags)
dvander@950
    50
{
dvander@950
    51
	if (method == SDKPass_Pointer)
dvander@950
    52
	{
dvander@950
    53
		type = PassType_Basic;
dvander@950
    54
		if (vtype == Valve_POD
dvander@954
    55
			|| vtype == Valve_Float
dvander@954
    56
			|| vtype == Valve_Bool)
dvander@950
    57
		{
dvander@954
    58
			flags = PASSFLAG_ASPOINTER;
dvander@950
    59
		} else {
dvander@950
    60
			flags = PASSFLAG_BYVAL;
dvander@950
    61
		}
dvander@950
    62
	} else if (method == SDKPass_Plain) {
dvander@950
    63
		type = PassType_Basic;
dvander@950
    64
		flags = PASSFLAG_BYVAL;
dvander@950
    65
	} else if (method == SDKPass_ByValue) {
dvander@950
    66
		if (vtype == Valve_Vector
dvander@950
    67
			|| vtype == Valve_QAngle)
dvander@950
    68
		{
dvander@950
    69
			type = PassType_Object;
dvander@950
    70
		} else {
dvander@950
    71
			type = PassType_Basic;
dvander@950
    72
		}
dvander@950
    73
		flags = PASSFLAG_BYVAL;
dvander@950
    74
	} else if (method == SDKPass_ByRef) {
dvander@950
    75
		if (vtype == Valve_Vector
dvander@950
    76
			|| vtype == Valve_QAngle)
dvander@950
    77
		{
dvander@950
    78
			type = PassType_Object;
dvander@950
    79
		} else {
dvander@950
    80
			type = PassType_Basic;
dvander@950
    81
		}
dvander@950
    82
		flags = PASSFLAG_BYREF;
dvander@950
    83
	}
dvander@950
    84
}
dvander@950
    85
dvander@950
    86
static cell_t StartPrepSDKCall(IPluginContext *pContext, const cell_t *params)
dvander@950
    87
{
dvander@950
    88
	s_numparams = 0;
ds@1042
    89
	s_vtbl_index = -1;
dvander@950
    90
	s_call_addr = NULL;
dvander@950
    91
	s_has_return = false;
dvander@950
    92
	s_vcalltype = (ValveCallType)params[1];
dvander@950
    93
dvander@950
    94
	return 1;
dvander@950
    95
}
dvander@950
    96
dvander@950
    97
static cell_t PrepSDKCall_SetVirtual(IPluginContext *pContext, const cell_t *params)
dvander@950
    98
{
dvander@950
    99
	s_vtbl_index = params[1];
dvander@950
   100
dvander@950
   101
	return 1;
dvander@950
   102
}
dvander@950
   103
dvander@950
   104
static cell_t PrepSDKCall_SetSignature(IPluginContext *pContext, const cell_t *params)
dvander@950
   105
{
dvander@950
   106
	void *addrInBase = NULL;
dvander@950
   107
	if (params[1] == SDKLibrary_Server)
dvander@950
   108
	{
dvander@956
   109
		addrInBase = (void *)g_SMAPI->serverFactory(false);
dvander@950
   110
	} else if (params[1] == SDKLibrary_Engine) {
dvander@956
   111
		addrInBase = (void *)g_SMAPI->engineFactory(false);
dvander@950
   112
	}
dvander@950
   113
	if (addrInBase == NULL)
dvander@950
   114
	{
dvander@950
   115
		return 0;
dvander@950
   116
	}
dvander@950
   117
dvander@950
   118
	char *sig;
dvander@950
   119
	pContext->LocalToString(params[2], &sig);
dvander@950
   120
dvander@950
   121
#if defined PLATFORM_LINUX
dvander@950
   122
	if (sig[0] == '@')
dvander@950
   123
	{
dvander@950
   124
		Dl_info info;
dvander@950
   125
		if (dladdr(addrInBase, &info) == 0)
dvander@950
   126
		{
dvander@950
   127
			return 0;
dvander@950
   128
		}
dvander@950
   129
		void *handle = dlopen(info.dli_fname, RTLD_NOW);
dvander@950
   130
		if (!handle)
dvander@950
   131
		{
dvander@950
   132
			return 0;
dvander@950
   133
		}
dvander@950
   134
		s_call_addr = dlsym(handle, &sig[1]);
dvander@950
   135
		dlclose(handle);
dvander@950
   136
dvander@950
   137
		return (s_call_addr != NULL) ? 1 : 0;
dvander@950
   138
	}
dvander@950
   139
#endif
dvander@950
   140
dvander@950
   141
	s_call_addr = memutils->FindPattern(addrInBase, sig, params[3]);
dvander@950
   142
dvander@950
   143
	return (s_call_addr != NULL) ? 1 : 0;
dvander@950
   144
}
dvander@950
   145
dvander@950
   146
static cell_t PrepSDKCall_SetFromConf(IPluginContext *pContext, const cell_t *params)
dvander@950
   147
{
dvander@950
   148
	IGameConfig *conf;
dvander@950
   149
dvander@950
   150
	if (params[1] == BAD_HANDLE)
dvander@950
   151
	{
dvander@950
   152
		conf = g_pGameConf;
dvander@950
   153
	} else {
dvander@950
   154
		HandleError err;
dvander@950
   155
		if ((conf = gameconfs->ReadHandle(params[1], pContext->GetIdentity(), &err)) == NULL)
dvander@950
   156
		{
dvander@950
   157
			return pContext->ThrowNativeError("Invalid Handle %x (error %d)", params[1], err);
dvander@950
   158
		}
dvander@950
   159
	}
dvander@950
   160
	
dvander@950
   161
	char *key;
dvander@950
   162
	pContext->LocalToString(params[3], &key);
dvander@950
   163
dvander@950
   164
	if (params[2] == 0)
dvander@950
   165
	{
dvander@950
   166
		return conf->GetOffset(key, &s_vtbl_index) ? 1 : 0;
dvander@950
   167
	} else if (params[2] == 1) {
dvander@950
   168
		bool result = conf->GetMemSig(key, &s_call_addr) ? 1 : 0;
dvander@950
   169
		return (result && s_call_addr != NULL) ? 1 : 0;
dvander@950
   170
	}
dvander@950
   171
dvander@950
   172
	return 0;
dvander@950
   173
}
dvander@950
   174
dvander@950
   175
static cell_t PrepSDKCall_SetReturnInfo(IPluginContext *pContext, const cell_t *params)
dvander@950
   176
{
dvander@950
   177
	s_has_return = true;
dvander@950
   178
	s_return.vtype = (ValveType)params[1];
dvander@950
   179
	DecodePassMethod(s_return.vtype, (SDKPassMethod)params[2], s_return.type, s_return.flags);
dvander@950
   180
	s_return.decflags = params[3];
dvander@950
   181
	s_return.encflags = params[4];
dvander@950
   182
dvander@950
   183
	return 1;
dvander@950
   184
}
dvander@950
   185
dvander@950
   186
static cell_t PrepSDKCall_AddParameter(IPluginContext *pContext, const cell_t *params)
dvander@950
   187
{
dvander@950
   188
	if (s_numparams >= SP_MAX_EXEC_PARAMS)
dvander@950
   189
	{
dvander@950
   190
		return pContext->ThrowNativeError("Parameter limit for SDK calls reached");
dvander@950
   191
	}
dvander@950
   192
dvander@950
   193
	ValvePassInfo *info = &s_params[s_numparams++];
dvander@950
   194
	info->vtype = (ValveType)params[1];
dvander@950
   195
	DecodePassMethod(info->vtype, (SDKPassMethod)params[2], info->type, info->flags);
dvander@954
   196
	info->decflags = params[3] | VDECODE_FLAG_BYREF;
dvander@950
   197
	info->encflags = params[4];
dvander@950
   198
dvander@950
   199
	return 1;
dvander@950
   200
}
dvander@950
   201
dvander@950
   202
static cell_t EndPrepSDKCall(IPluginContext *pContext, const cell_t *params)
dvander@950
   203
{
dvander@950
   204
	ValveCall *vc = NULL;
ds@1042
   205
	if (s_vtbl_index > -1)
dvander@950
   206
	{
dvander@950
   207
		vc = CreateValveVCall(s_vtbl_index, s_vcalltype, s_has_return ? &s_return : NULL, s_params, s_numparams);
dvander@953
   208
	} else if (s_call_addr) {
dvander@953
   209
		vc = CreateValveCall(s_call_addr, s_vcalltype, s_has_return ? &s_return : NULL, s_params, s_numparams);
dvander@950
   210
	}
dvander@950
   211
dvander@950
   212
	if (!vc)
dvander@950
   213
	{
dvander@950
   214
		return BAD_HANDLE;
dvander@950
   215
	}
dvander@950
   216
dvander@968
   217
	if (vc->thisinfo)
dvander@968
   218
	{
dvander@968
   219
		vc->thisinfo->decflags |= VDECODE_FLAG_BYREF;
dvander@968
   220
	}
dvander@968
   221
dvander@950
   222
	Handle_t hndl = handlesys->CreateHandle(g_CallHandle, vc, pContext->GetIdentity(), myself->GetIdentity(), NULL);
dvander@950
   223
	if (!hndl)
dvander@950
   224
	{
dvander@950
   225
		delete vc;
dvander@950
   226
	}
dvander@950
   227
dvander@950
   228
	return hndl;
dvander@950
   229
}
dvander@950
   230
dvander@950
   231
static cell_t SDKCall(IPluginContext *pContext, const cell_t *params)
dvander@950
   232
{
dvander@950
   233
	ValveCall *vc;
dvander@950
   234
	HandleError err;
dvander@950
   235
	HandleSecurity sec(pContext->GetIdentity(), myself->GetIdentity());
dvander@950
   236
dvander@950
   237
	if ((err = handlesys->ReadHandle(params[1], g_CallHandle, &sec, (void **)&vc)) != HandleError_None)
dvander@950
   238
	{
dvander@950
   239
		return pContext->ThrowNativeError("Invalid Handle %x (error %d)", params[1], err);
dvander@950
   240
	}
dvander@950
   241
dvander@950
   242
	unsigned char *ptr = vc->stk_get();
dvander@950
   243
dvander@950
   244
	unsigned int numparams = (unsigned)params[0];
dvander@950
   245
	unsigned int startparam = 2;
dvander@950
   246
	/* Do we need to write a thispointer?  */
dvander@950
   247
dvander@950
   248
	if (vc->thisinfo && 
dvander@950
   249
		(vc->thisinfo->vtype == Valve_CBaseEntity
dvander@950
   250
		 || vc->thisinfo->vtype == Valve_CBasePlayer))
dvander@950
   251
	{
dvander@950
   252
		if (startparam > numparams)
dvander@950
   253
		{
dvander@950
   254
			vc->stk_put(ptr);
dvander@950
   255
			return pContext->ThrowNativeError("Expected 1 parameter for entity pointer; found none");
dvander@950
   256
		}
dvander@950
   257
		if (DecodeValveParam(pContext, 
dvander@987
   258
			params[startparam],
dvander@987
   259
			vc,
dvander@954
   260
			vc->thisinfo,
dvander@950
   261
			ptr) == Data_Fail)
dvander@950
   262
		{
dvander@950
   263
			vc->stk_put(ptr);
dvander@950
   264
			return 0;
dvander@950
   265
		}
dvander@950
   266
		startparam++;
dvander@950
   267
	}
dvander@950
   268
dvander@950
   269
	/* See if we need to skip any more parameters */
dvander@950
   270
	unsigned int retparam = startparam;
dvander@950
   271
	if (vc->retinfo)
dvander@950
   272
	{
dvander@950
   273
		if (vc->retinfo->vtype == Valve_String)
dvander@950
   274
		{
dvander@950
   275
			startparam += 2;
dvander@950
   276
		} else if (vc->retinfo->vtype == Valve_Vector
dvander@950
   277
					|| vc->retinfo->vtype == Valve_QAngle)
dvander@950
   278
		{
dvander@950
   279
			startparam += 1;
dvander@950
   280
		}
dvander@950
   281
	}
dvander@950
   282
dvander@950
   283
	unsigned int callparams = vc->call->GetParamCount();
dvander@950
   284
	bool will_copyback = false;
dvander@950
   285
	for (unsigned int i=0; i<callparams; i++)
dvander@950
   286
	{
dvander@950
   287
		unsigned int p = startparam + i;
dvander@950
   288
		if (p > numparams)
dvander@950
   289
		{
dvander@950
   290
			vc->stk_put(ptr);
dvander@950
   291
			return pContext->ThrowNativeError("Expected %dth parameter, found none", p);
dvander@950
   292
		}
dvander@950
   293
		if (DecodeValveParam(pContext,
dvander@950
   294
			params[p],
dvander@987
   295
			vc,
dvander@954
   296
			&(vc->vparams[i]),
dvander@987
   297
			ptr) == Data_Fail)
dvander@950
   298
		{
dvander@950
   299
			vc->stk_put(ptr);
dvander@950
   300
			return 0;
dvander@950
   301
		}
dvander@950
   302
		if (vc->vparams[i].encflags & VENCODE_FLAG_COPYBACK)
dvander@950
   303
		{
dvander@950
   304
			will_copyback = true;
dvander@950
   305
		}
dvander@950
   306
	}
dvander@950
   307
dvander@950
   308
	/* Make the actual call */
dvander@950
   309
	vc->call->Execute(ptr, vc->retbuf);
dvander@950
   310
dvander@950
   311
	/* Do we need to copy anything back? */
dvander@950
   312
	if (will_copyback)
dvander@950
   313
	{
dvander@950
   314
		for (unsigned int i=0; i<callparams; i++)
dvander@950
   315
		{
dvander@950
   316
			if (vc->vparams[i].encflags & VENCODE_FLAG_COPYBACK)
dvander@950
   317
			{
dvander@950
   318
				if (EncodeValveParam(pContext, 
dvander@950
   319
					startparam + i, 
dvander@987
   320
					vc,
dvander@954
   321
					&vc->vparams[i],
dvander@987
   322
					ptr) == Data_Fail)
dvander@950
   323
				{
dvander@950
   324
					vc->stk_put(ptr);
dvander@950
   325
					return 0;
dvander@950
   326
				}
dvander@950
   327
			}
dvander@950
   328
		}
dvander@950
   329
	}
dvander@950
   330
dvander@950
   331
	/* Save stack once and for all */
dvander@950
   332
	vc->stk_put(ptr);
dvander@950
   333
dvander@950
   334
	/* Figure out how to decode the return information */
dvander@950
   335
	if (vc->retinfo)
dvander@950
   336
	{
dvander@950
   337
		if (vc->retinfo->vtype == Valve_String)
dvander@950
   338
		{
dvander@950
   339
			if (numparams < 3)
dvander@950
   340
			{
dvander@950
   341
				return pContext->ThrowNativeError("Expected arguments (2,3) for string storage");
dvander@950
   342
			}
dvander@950
   343
			cell_t *addr;
dvander@950
   344
			size_t written;
dvander@950
   345
			pContext->LocalToPhysAddr(params[retparam+1], &addr);
dvander@950
   346
			pContext->StringToLocalUTF8(params[retparam], *addr, *(char **)vc->retbuf, &written);
dvander@950
   347
			return (cell_t)written;
dvander@950
   348
		} else if (vc->retinfo->vtype == Valve_Vector
dvander@950
   349
					|| vc->retinfo->vtype == Valve_QAngle)
dvander@950
   350
		{
dvander@950
   351
			if (numparams < 2)
dvander@950
   352
			{
dvander@950
   353
				return pContext->ThrowNativeError("Expected argument (2) for Float[3] storage");
dvander@950
   354
			}
dvander@987
   355
			if (EncodeValveParam(pContext, params[retparam], vc, vc->retinfo, vc->retbuf)
dvander@950
   356
				== Data_Fail)
dvander@950
   357
			{
dvander@950
   358
				return 0;
dvander@950
   359
			}
dvander@950
   360
		} else if (vc->retinfo->vtype == Valve_CBaseEntity
dvander@950
   361
					|| vc->retinfo->vtype == Valve_CBasePlayer)
dvander@950
   362
		{
dvander@950
   363
			CBaseEntity *pEntity = *(CBaseEntity **)(vc->retbuf);
dvander@950
   364
			if (!pEntity)
dvander@950
   365
			{
dvander@950
   366
				return -1;
dvander@950
   367
			}
dvander@950
   368
			edict_t *pEdict = gameents->BaseEntityToEdict(pEntity);
dvander@950
   369
			if (!pEdict || pEdict->IsFree())
dvander@950
   370
			{
dvander@950
   371
				return -1;
dvander@950
   372
			}
dvander@950
   373
			return engine->IndexOfEdict(pEdict);
dvander@950
   374
		} else if (vc->retinfo->vtype == Valve_Edict) {
dvander@950
   375
			edict_t *pEdict = *(edict_t **)(vc->retbuf);
dvander@950
   376
			if (!pEdict || pEdict->IsFree())
dvander@950
   377
			{
dvander@950
   378
				return -1;
dvander@950
   379
			}
dvander@950
   380
			return engine->IndexOfEdict(pEdict);
dvander@954
   381
		} else if (vc->retinfo->vtype == Valve_Bool) {
dvander@954
   382
			bool *addr = (bool  *)vc->retbuf;
dvander@954
   383
			if (vc->retinfo->flags & PASSFLAG_BYREF)
dvander@954
   384
			{
dvander@954
   385
				addr = *(bool **)addr;
dvander@954
   386
			}
dvander@954
   387
			return *addr ? 1 : 0;
dvander@950
   388
		} else {
dvander@950
   389
			cell_t *addr = (cell_t *)vc->retbuf;
dvander@950
   390
			if (vc->retinfo->flags & PASSFLAG_BYREF)
dvander@950
   391
			{
dvander@950
   392
				addr = *(cell_t **)addr;
dvander@950
   393
			}
dvander@950
   394
			return *addr;
dvander@950
   395
		}
dvander@950
   396
	}
dvander@950
   397
dvander@950
   398
	return 0;
dvander@950
   399
}
dvander@950
   400
dvander@950
   401
sp_nativeinfo_t g_CallNatives[] = 
dvander@950
   402
{
dvander@950
   403
	{"StartPrepSDKCall",			StartPrepSDKCall},
dvander@950
   404
	{"PrepSDKCall_SetVirtual",		PrepSDKCall_SetVirtual},
dvander@950
   405
	{"PrepSDKCall_SetSignature",	PrepSDKCall_SetSignature},
dvander@950
   406
	{"PrepSDKCall_SetFromConf",		PrepSDKCall_SetFromConf},
dvander@950
   407
	{"PrepSDKCall_SetReturnInfo",	PrepSDKCall_SetReturnInfo},
dvander@950
   408
	{"PrepSDKCall_AddParameter",	PrepSDKCall_AddParameter},
dvander@950
   409
	{"EndPrepSDKCall",				EndPrepSDKCall},
dvander@950
   410
	{"SDKCall",						SDKCall},
dvander@950
   411
	{NULL,							NULL},
dvander@950
   412
};