extensions/sdktools/vcaller.cpp
author Phong Dang <teame06@gmail.com>
Wed Aug 01 18:22:53 2007 +0000 (2007-08-01)
changeset 1245 bb0611ab4bed
parent 1240 79eebacc9d02
child 1330 ab94316bb52b
permissions -rw-r--r--
Updated license header.
faluco@1031
     1
/**
faluco@1031
     2
 * vim: set ts=4 :
dvander@1233
     3
 * ================================================================
dvander@1233
     4
 * SourceMod SDKTools Extension
dvander@1233
     5
 * Copyright (C) 2004-2007 AlliedModders LLC.  All rights reserved.
dvander@1233
     6
 * ================================================================
faluco@1031
     7
 *
dvander@1233
     8
 * This program is free software; you can redistribute it and/or 
dvander@1233
     9
 * modify it under the terms of the GNU General Public License, 
dvander@1233
    10
 * version 3.0, as published by the Free Software Foundation.
dvander@1233
    11
 * 
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.
dvander@1233
    16
 *
faluco@1031
    17
 * You should have received a copy of the GNU General Public License
dvander@1233
    18
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
dvander@1233
    19
 *
dvander@1233
    20
 * As a special exception, AlliedModders LLC gives you permission to 
dvander@1233
    21
 * link the code of this program (as well as its derivative works) to 
dvander@1233
    22
 * "Half-Life 2," the "Source Engine," the "SourcePawn JIT," and any 
dvander@1233
    23
 * Game MODs that run on software by the Valve Corporation.  You must 
dvander@1233
    24
 * obey the GNU General Public License in all respects for all other 
dvander@1233
    25
 * code used. Additionally, AlliedModders LLC grants this exception 
dvander@1233
    26
 * to all derivative works. AlliedModders LLC defines further 
dvander@1233
    27
 * exceptions, found in LICENSE.txt (as of this writing, version 
dvander@1233
    28
 * JULY-31-2007), or <http://www.sourcemod.net/license.php>.
faluco@1031
    29
 *
faluco@1031
    30
 * Version: $Id$
faluco@1031
    31
 */
faluco@1031
    32
dvander@950
    33
#include "extension.h"
dvander@950
    34
#include "vcallbuilder.h"
ds@1240
    35
#include "vglobals.h"
dvander@950
    36
dvander@950
    37
enum SDKLibrary
dvander@950
    38
{
dvander@950
    39
	SDKLibrary_Server,	/**< server.dll/server_i486.so */
dvander@950
    40
	SDKLibrary_Engine,	/**< engine.dll/engine_*.so */
dvander@950
    41
};
dvander@950
    42
dvander@950
    43
enum SDKPassMethod
dvander@950
    44
{
dvander@950
    45
	SDKPass_Pointer,		/**< Pass as a pointer */
dvander@950
    46
	SDKPass_Plain,			/**< Pass as plain data */
dvander@950
    47
	SDKPass_ByValue,		/**< Pass an object by value */
dvander@950
    48
	SDKPass_ByRef,			/**< Pass an object by reference */
dvander@950
    49
};
dvander@950
    50
ds@1042
    51
int s_vtbl_index = -1;
dvander@950
    52
void *s_call_addr = NULL;
dvander@950
    53
ValveCallType s_vcalltype = ValveCall_Static;
dvander@950
    54
bool s_has_return = false;
dvander@950
    55
ValvePassInfo s_return;
dvander@950
    56
unsigned int s_numparams = 0;
dvander@950
    57
ValvePassInfo s_params[SP_MAX_EXEC_PARAMS];
dvander@950
    58
dvander@950
    59
inline void DecodePassMethod(ValveType vtype, SDKPassMethod method, PassType &type, unsigned int &flags)
dvander@950
    60
{
ds@1135
    61
	if (method == SDKPass_Pointer || method == SDKPass_ByRef)
dvander@950
    62
	{
dvander@950
    63
		type = PassType_Basic;
dvander@950
    64
		if (vtype == Valve_POD
dvander@954
    65
			|| vtype == Valve_Float
dvander@954
    66
			|| vtype == Valve_Bool)
dvander@950
    67
		{
ds@1135
    68
			flags = PASSFLAG_BYVAL | PASSFLAG_ASPOINTER;
dvander@950
    69
		} else {
dvander@950
    70
			flags = PASSFLAG_BYVAL;
dvander@950
    71
		}
dvander@950
    72
	} else if (method == SDKPass_Plain) {
dvander@950
    73
		type = PassType_Basic;
dvander@950
    74
		flags = PASSFLAG_BYVAL;
dvander@950
    75
	} else if (method == SDKPass_ByValue) {
dvander@950
    76
		if (vtype == Valve_Vector
dvander@950
    77
			|| vtype == Valve_QAngle)
dvander@950
    78
		{
dvander@950
    79
			type = PassType_Object;
dvander@950
    80
		} else {
dvander@950
    81
			type = PassType_Basic;
dvander@950
    82
		}
dvander@950
    83
		flags = PASSFLAG_BYVAL;
dvander@950
    84
	}
dvander@950
    85
}
dvander@950
    86
dvander@950
    87
static cell_t StartPrepSDKCall(IPluginContext *pContext, const cell_t *params)
dvander@950
    88
{
dvander@950
    89
	s_numparams = 0;
ds@1042
    90
	s_vtbl_index = -1;
dvander@950
    91
	s_call_addr = NULL;
dvander@950
    92
	s_has_return = false;
dvander@950
    93
	s_vcalltype = (ValveCallType)params[1];
dvander@950
    94
dvander@950
    95
	return 1;
dvander@950
    96
}
dvander@950
    97
dvander@950
    98
static cell_t PrepSDKCall_SetVirtual(IPluginContext *pContext, const cell_t *params)
dvander@950
    99
{
dvander@950
   100
	s_vtbl_index = params[1];
dvander@950
   101
dvander@950
   102
	return 1;
dvander@950
   103
}
dvander@950
   104
dvander@950
   105
static cell_t PrepSDKCall_SetSignature(IPluginContext *pContext, const cell_t *params)
dvander@950
   106
{
dvander@950
   107
	void *addrInBase = NULL;
dvander@950
   108
	if (params[1] == SDKLibrary_Server)
dvander@950
   109
	{
dvander@956
   110
		addrInBase = (void *)g_SMAPI->serverFactory(false);
dvander@950
   111
	} else if (params[1] == SDKLibrary_Engine) {
dvander@956
   112
		addrInBase = (void *)g_SMAPI->engineFactory(false);
dvander@950
   113
	}
dvander@950
   114
	if (addrInBase == NULL)
dvander@950
   115
	{
dvander@950
   116
		return 0;
dvander@950
   117
	}
dvander@950
   118
dvander@950
   119
	char *sig;
dvander@950
   120
	pContext->LocalToString(params[2], &sig);
dvander@950
   121
dvander@950
   122
#if defined PLATFORM_LINUX
dvander@950
   123
	if (sig[0] == '@')
dvander@950
   124
	{
dvander@950
   125
		Dl_info info;
dvander@950
   126
		if (dladdr(addrInBase, &info) == 0)
dvander@950
   127
		{
dvander@950
   128
			return 0;
dvander@950
   129
		}
dvander@950
   130
		void *handle = dlopen(info.dli_fname, RTLD_NOW);
dvander@950
   131
		if (!handle)
dvander@950
   132
		{
dvander@950
   133
			return 0;
dvander@950
   134
		}
dvander@950
   135
		s_call_addr = dlsym(handle, &sig[1]);
dvander@950
   136
		dlclose(handle);
dvander@950
   137
dvander@950
   138
		return (s_call_addr != NULL) ? 1 : 0;
dvander@950
   139
	}
dvander@950
   140
#endif
dvander@950
   141
dvander@950
   142
	s_call_addr = memutils->FindPattern(addrInBase, sig, params[3]);
dvander@950
   143
dvander@950
   144
	return (s_call_addr != NULL) ? 1 : 0;
dvander@950
   145
}
dvander@950
   146
dvander@950
   147
static cell_t PrepSDKCall_SetFromConf(IPluginContext *pContext, const cell_t *params)
dvander@950
   148
{
dvander@950
   149
	IGameConfig *conf;
dvander@950
   150
dvander@950
   151
	if (params[1] == BAD_HANDLE)
dvander@950
   152
	{
dvander@950
   153
		conf = g_pGameConf;
dvander@950
   154
	} else {
dvander@950
   155
		HandleError err;
dvander@950
   156
		if ((conf = gameconfs->ReadHandle(params[1], pContext->GetIdentity(), &err)) == NULL)
dvander@950
   157
		{
dvander@950
   158
			return pContext->ThrowNativeError("Invalid Handle %x (error %d)", params[1], err);
dvander@950
   159
		}
dvander@950
   160
	}
dvander@950
   161
	
dvander@950
   162
	char *key;
dvander@950
   163
	pContext->LocalToString(params[3], &key);
dvander@950
   164
dvander@950
   165
	if (params[2] == 0)
dvander@950
   166
	{
dvander@950
   167
		return conf->GetOffset(key, &s_vtbl_index) ? 1 : 0;
dvander@950
   168
	} else if (params[2] == 1) {
dvander@950
   169
		bool result = conf->GetMemSig(key, &s_call_addr) ? 1 : 0;
dvander@950
   170
		return (result && s_call_addr != NULL) ? 1 : 0;
dvander@950
   171
	}
dvander@950
   172
dvander@950
   173
	return 0;
dvander@950
   174
}
dvander@950
   175
dvander@950
   176
static cell_t PrepSDKCall_SetReturnInfo(IPluginContext *pContext, const cell_t *params)
dvander@950
   177
{
dvander@950
   178
	s_has_return = true;
dvander@950
   179
	s_return.vtype = (ValveType)params[1];
dvander@950
   180
	DecodePassMethod(s_return.vtype, (SDKPassMethod)params[2], s_return.type, s_return.flags);
dvander@950
   181
	s_return.decflags = params[3];
dvander@950
   182
	s_return.encflags = params[4];
dvander@950
   183
dvander@950
   184
	return 1;
dvander@950
   185
}
dvander@950
   186
dvander@950
   187
static cell_t PrepSDKCall_AddParameter(IPluginContext *pContext, const cell_t *params)
dvander@950
   188
{
dvander@950
   189
	if (s_numparams >= SP_MAX_EXEC_PARAMS)
dvander@950
   190
	{
dvander@950
   191
		return pContext->ThrowNativeError("Parameter limit for SDK calls reached");
dvander@950
   192
	}
dvander@950
   193
dvander@950
   194
	ValvePassInfo *info = &s_params[s_numparams++];
dvander@950
   195
	info->vtype = (ValveType)params[1];
ds@1135
   196
	SDKPassMethod method = (SDKPassMethod)params[2];
ds@1135
   197
	DecodePassMethod(info->vtype, method, info->type, info->flags);
dvander@954
   198
	info->decflags = params[3] | VDECODE_FLAG_BYREF;
dvander@950
   199
	info->encflags = params[4];
dvander@950
   200
ds@1135
   201
	/* Since SDKPass_ByRef acts like SDKPass_Pointer we can't allow NULL, just in case */
ds@1135
   202
	if (method == SDKPass_ByRef)
ds@1135
   203
	{
ds@1135
   204
		info->decflags &= ~VDECODE_FLAG_ALLOWNULL;
ds@1135
   205
	}
ds@1135
   206
dvander@950
   207
	return 1;
dvander@950
   208
}
dvander@950
   209
dvander@950
   210
static cell_t EndPrepSDKCall(IPluginContext *pContext, const cell_t *params)
dvander@950
   211
{
dvander@950
   212
	ValveCall *vc = NULL;
ds@1042
   213
	if (s_vtbl_index > -1)
dvander@950
   214
	{
dvander@950
   215
		vc = CreateValveVCall(s_vtbl_index, s_vcalltype, s_has_return ? &s_return : NULL, s_params, s_numparams);
dvander@953
   216
	} else if (s_call_addr) {
dvander@953
   217
		vc = CreateValveCall(s_call_addr, s_vcalltype, s_has_return ? &s_return : NULL, s_params, s_numparams);
dvander@950
   218
	}
dvander@950
   219
dvander@950
   220
	if (!vc)
dvander@950
   221
	{
dvander@950
   222
		return BAD_HANDLE;
dvander@950
   223
	}
dvander@950
   224
dvander@968
   225
	if (vc->thisinfo)
dvander@968
   226
	{
dvander@968
   227
		vc->thisinfo->decflags |= VDECODE_FLAG_BYREF;
dvander@968
   228
	}
dvander@968
   229
dvander@950
   230
	Handle_t hndl = handlesys->CreateHandle(g_CallHandle, vc, pContext->GetIdentity(), myself->GetIdentity(), NULL);
dvander@950
   231
	if (!hndl)
dvander@950
   232
	{
dvander@950
   233
		delete vc;
dvander@950
   234
	}
dvander@950
   235
dvander@950
   236
	return hndl;
dvander@950
   237
}
dvander@950
   238
dvander@950
   239
static cell_t SDKCall(IPluginContext *pContext, const cell_t *params)
dvander@950
   240
{
dvander@950
   241
	ValveCall *vc;
dvander@950
   242
	HandleError err;
dvander@950
   243
	HandleSecurity sec(pContext->GetIdentity(), myself->GetIdentity());
dvander@950
   244
dvander@950
   245
	if ((err = handlesys->ReadHandle(params[1], g_CallHandle, &sec, (void **)&vc)) != HandleError_None)
dvander@950
   246
	{
dvander@950
   247
		return pContext->ThrowNativeError("Invalid Handle %x (error %d)", params[1], err);
dvander@950
   248
	}
dvander@950
   249
dvander@950
   250
	unsigned char *ptr = vc->stk_get();
dvander@950
   251
dvander@950
   252
	unsigned int numparams = (unsigned)params[0];
dvander@950
   253
	unsigned int startparam = 2;
dvander@950
   254
	/* Do we need to write a thispointer?  */
dvander@950
   255
ds@1065
   256
	if (vc->thisinfo)
dvander@950
   257
	{
ds@1065
   258
		switch (vc->type)
dvander@950
   259
		{
ds@1065
   260
		case ValveCall_Entity:
ds@1065
   261
		case ValveCall_Player:
ds@1065
   262
			{
ds@1065
   263
				if (startparam > numparams)
ds@1065
   264
				{
ds@1065
   265
					vc->stk_put(ptr);
ds@1065
   266
					return pContext->ThrowNativeError("Expected 1 parameter for entity pointer; found none");
ds@1065
   267
				}
ds@1065
   268
ds@1065
   269
				if (DecodeValveParam(pContext, 
ds@1065
   270
					params[startparam],
ds@1065
   271
					vc,
ds@1065
   272
					vc->thisinfo,
ds@1065
   273
					ptr) == Data_Fail)
ds@1065
   274
				{
ds@1065
   275
					vc->stk_put(ptr);
ds@1065
   276
					return 0;
ds@1065
   277
				}
ds@1065
   278
				startparam++;
ds@1065
   279
			}
ds@1065
   280
			break;
ds@1065
   281
		case ValveCall_GameRules:
ds@1065
   282
			{
ds@1065
   283
				if (g_pGameRules == NULL)
ds@1065
   284
				{
ds@1065
   285
					vc->stk_put(ptr);
ds@1065
   286
					return pContext->ThrowNativeError("GameRules unsupported or not available; file a bug report");
ds@1065
   287
				}
ds@1065
   288
ds@1065
   289
				void *gamerules = *g_pGameRules;
ds@1065
   290
ds@1065
   291
				if (gamerules == NULL)
ds@1065
   292
				{
ds@1065
   293
					vc->stk_put(ptr);
ds@1065
   294
					return pContext->ThrowNativeError("GameRules not available before map is loaded");
ds@1065
   295
				}
ds@1065
   296
				*(void **)ptr = gamerules;
ds@1065
   297
			}
ds@1065
   298
			break;
ds@1240
   299
		case ValveCall_EntityList:
ds@1240
   300
			{
ds@1240
   301
				if (g_EntList == NULL)
ds@1240
   302
				{
ds@1240
   303
					vc->stk_put(ptr);
ds@1240
   304
					return pContext->ThrowNativeError("EntityList unsupported or not available; file a bug report");
ds@1240
   305
				}
ds@1240
   306
ds@1240
   307
				*(void **)ptr = g_EntList;
ds@1240
   308
			}
ds@1240
   309
			break;
dvander@950
   310
		}
dvander@950
   311
	}
dvander@950
   312
dvander@950
   313
	/* See if we need to skip any more parameters */
dvander@950
   314
	unsigned int retparam = startparam;
dvander@950
   315
	if (vc->retinfo)
dvander@950
   316
	{
dvander@950
   317
		if (vc->retinfo->vtype == Valve_String)
dvander@950
   318
		{
dvander@950
   319
			startparam += 2;
dvander@950
   320
		} else if (vc->retinfo->vtype == Valve_Vector
dvander@950
   321
					|| vc->retinfo->vtype == Valve_QAngle)
dvander@950
   322
		{
dvander@950
   323
			startparam += 1;
dvander@950
   324
		}
dvander@950
   325
	}
dvander@950
   326
dvander@950
   327
	unsigned int callparams = vc->call->GetParamCount();
dvander@950
   328
	bool will_copyback = false;
dvander@950
   329
	for (unsigned int i=0; i<callparams; i++)
dvander@950
   330
	{
dvander@950
   331
		unsigned int p = startparam + i;
dvander@950
   332
		if (p > numparams)
dvander@950
   333
		{
dvander@950
   334
			vc->stk_put(ptr);
dvander@950
   335
			return pContext->ThrowNativeError("Expected %dth parameter, found none", p);
dvander@950
   336
		}
dvander@950
   337
		if (DecodeValveParam(pContext,
dvander@950
   338
			params[p],
dvander@987
   339
			vc,
dvander@954
   340
			&(vc->vparams[i]),
dvander@987
   341
			ptr) == Data_Fail)
dvander@950
   342
		{
dvander@950
   343
			vc->stk_put(ptr);
dvander@950
   344
			return 0;
dvander@950
   345
		}
dvander@950
   346
		if (vc->vparams[i].encflags & VENCODE_FLAG_COPYBACK)
dvander@950
   347
		{
dvander@950
   348
			will_copyback = true;
dvander@950
   349
		}
dvander@950
   350
	}
dvander@950
   351
dvander@950
   352
	/* Make the actual call */
dvander@950
   353
	vc->call->Execute(ptr, vc->retbuf);
dvander@950
   354
dvander@950
   355
	/* Do we need to copy anything back? */
dvander@950
   356
	if (will_copyback)
dvander@950
   357
	{
dvander@950
   358
		for (unsigned int i=0; i<callparams; i++)
dvander@950
   359
		{
dvander@950
   360
			if (vc->vparams[i].encflags & VENCODE_FLAG_COPYBACK)
dvander@950
   361
			{
dvander@950
   362
				if (EncodeValveParam(pContext, 
ds@1130
   363
					params[startparam + i], 
dvander@987
   364
					vc,
dvander@954
   365
					&vc->vparams[i],
dvander@987
   366
					ptr) == Data_Fail)
dvander@950
   367
				{
dvander@950
   368
					vc->stk_put(ptr);
dvander@950
   369
					return 0;
dvander@950
   370
				}
dvander@950
   371
			}
dvander@950
   372
		}
dvander@950
   373
	}
dvander@950
   374
dvander@950
   375
	/* Save stack once and for all */
dvander@950
   376
	vc->stk_put(ptr);
dvander@950
   377
dvander@950
   378
	/* Figure out how to decode the return information */
dvander@950
   379
	if (vc->retinfo)
dvander@950
   380
	{
dvander@950
   381
		if (vc->retinfo->vtype == Valve_String)
dvander@950
   382
		{
dvander@950
   383
			if (numparams < 3)
dvander@950
   384
			{
dvander@950
   385
				return pContext->ThrowNativeError("Expected arguments (2,3) for string storage");
dvander@950
   386
			}
dvander@950
   387
			cell_t *addr;
dvander@950
   388
			size_t written;
dvander@950
   389
			pContext->LocalToPhysAddr(params[retparam+1], &addr);
dvander@950
   390
			pContext->StringToLocalUTF8(params[retparam], *addr, *(char **)vc->retbuf, &written);
dvander@950
   391
			return (cell_t)written;
dvander@950
   392
		} else if (vc->retinfo->vtype == Valve_Vector
dvander@950
   393
					|| vc->retinfo->vtype == Valve_QAngle)
dvander@950
   394
		{
dvander@950
   395
			if (numparams < 2)
dvander@950
   396
			{
dvander@950
   397
				return pContext->ThrowNativeError("Expected argument (2) for Float[3] storage");
dvander@950
   398
			}
dvander@987
   399
			if (EncodeValveParam(pContext, params[retparam], vc, vc->retinfo, vc->retbuf)
dvander@950
   400
				== Data_Fail)
dvander@950
   401
			{
dvander@950
   402
				return 0;
dvander@950
   403
			}
dvander@950
   404
		} else if (vc->retinfo->vtype == Valve_CBaseEntity
dvander@950
   405
					|| vc->retinfo->vtype == Valve_CBasePlayer)
dvander@950
   406
		{
dvander@950
   407
			CBaseEntity *pEntity = *(CBaseEntity **)(vc->retbuf);
dvander@950
   408
			if (!pEntity)
dvander@950
   409
			{
dvander@950
   410
				return -1;
dvander@950
   411
			}
dvander@950
   412
			edict_t *pEdict = gameents->BaseEntityToEdict(pEntity);
dvander@950
   413
			if (!pEdict || pEdict->IsFree())
dvander@950
   414
			{
dvander@950
   415
				return -1;
dvander@950
   416
			}
dvander@950
   417
			return engine->IndexOfEdict(pEdict);
dvander@950
   418
		} else if (vc->retinfo->vtype == Valve_Edict) {
dvander@950
   419
			edict_t *pEdict = *(edict_t **)(vc->retbuf);
dvander@950
   420
			if (!pEdict || pEdict->IsFree())
dvander@950
   421
			{
dvander@950
   422
				return -1;
dvander@950
   423
			}
dvander@950
   424
			return engine->IndexOfEdict(pEdict);
dvander@954
   425
		} else if (vc->retinfo->vtype == Valve_Bool) {
dvander@954
   426
			bool *addr = (bool  *)vc->retbuf;
ds@1135
   427
			if (vc->retinfo->flags & PASSFLAG_ASPOINTER)
dvander@954
   428
			{
dvander@954
   429
				addr = *(bool **)addr;
dvander@954
   430
			}
dvander@954
   431
			return *addr ? 1 : 0;
dvander@950
   432
		} else {
dvander@950
   433
			cell_t *addr = (cell_t *)vc->retbuf;
ds@1135
   434
			if (vc->retinfo->flags & PASSFLAG_ASPOINTER)
dvander@950
   435
			{
dvander@950
   436
				addr = *(cell_t **)addr;
dvander@950
   437
			}
dvander@950
   438
			return *addr;
dvander@950
   439
		}
dvander@950
   440
	}
dvander@950
   441
dvander@950
   442
	return 0;
dvander@950
   443
}
dvander@950
   444
dvander@950
   445
sp_nativeinfo_t g_CallNatives[] = 
dvander@950
   446
{
dvander@950
   447
	{"StartPrepSDKCall",			StartPrepSDKCall},
dvander@950
   448
	{"PrepSDKCall_SetVirtual",		PrepSDKCall_SetVirtual},
dvander@950
   449
	{"PrepSDKCall_SetSignature",	PrepSDKCall_SetSignature},
dvander@950
   450
	{"PrepSDKCall_SetFromConf",		PrepSDKCall_SetFromConf},
dvander@950
   451
	{"PrepSDKCall_SetReturnInfo",	PrepSDKCall_SetReturnInfo},
dvander@950
   452
	{"PrepSDKCall_AddParameter",	PrepSDKCall_AddParameter},
dvander@950
   453
	{"EndPrepSDKCall",				EndPrepSDKCall},
dvander@950
   454
	{"SDKCall",						SDKCall},
dvander@950
   455
	{NULL,							NULL},
dvander@950
   456
};