extensions/sdktools/vcaller.cpp
author Scott Ehlert <ds@alliedmods.net>
Sun Sep 14 03:01:05 2008 -0500 (2008-09-14)
changeset 2289 44045ead61cd
parent 1952 b7aa2b626807
parent 1947 e73a1e51833b
child 2400 76b7b4575e21
permissions -rw-r--r--
Eliminated head: da55a80522cf, a remnant of sourcemod-1.1.0 branch
faluco@1031
     1
/**
faluco@1031
     2
 * vim: set ts=4 :
ds@1330
     3
 * =============================================================================
dvander@1233
     4
 * SourceMod SDKTools Extension
ds@1947
     5
 * Copyright (C) 2004-2008 AlliedModders LLC.  All rights reserved.
ds@1330
     6
 * =============================================================================
faluco@1031
     7
 *
ds@1330
     8
 * This program is free software; you can redistribute it and/or modify it under
ds@1330
     9
 * the terms of the GNU General Public License, version 3.0, as published by the
ds@1330
    10
 * Free Software Foundation.
dvander@1233
    11
 * 
ds@1330
    12
 * This program is distributed in the hope that it will be useful, but WITHOUT
ds@1330
    13
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
ds@1330
    14
 * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
ds@1330
    15
 * details.
dvander@1233
    16
 *
ds@1330
    17
 * You should have received a copy of the GNU General Public License along with
ds@1330
    18
 * this program.  If not, see <http://www.gnu.org/licenses/>.
dvander@1233
    19
 *
ds@1330
    20
 * As a special exception, AlliedModders LLC gives you permission to link the
ds@1330
    21
 * code of this program (as well as its derivative works) to "Half-Life 2," the
ds@1330
    22
 * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
ds@1330
    23
 * by the Valve Corporation.  You must obey the GNU General Public License in
ds@1330
    24
 * all respects for all other code used.  Additionally, AlliedModders LLC grants
ds@1330
    25
 * this exception to all derivative works.  AlliedModders LLC defines further
ds@1330
    26
 * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
ds@1330
    27
 * or <http://www.sourcemod.net/license.php>.
faluco@1031
    28
 *
faluco@1031
    29
 * Version: $Id$
faluco@1031
    30
 */
faluco@1031
    31
dvander@950
    32
#include "extension.h"
dvander@950
    33
#include "vcallbuilder.h"
ds@1240
    34
#include "vglobals.h"
dvander@950
    35
dvander@950
    36
enum SDKLibrary
dvander@950
    37
{
dvander@950
    38
	SDKLibrary_Server,	/**< server.dll/server_i486.so */
dvander@950
    39
	SDKLibrary_Engine,	/**< engine.dll/engine_*.so */
dvander@950
    40
};
dvander@950
    41
dvander@950
    42
enum SDKPassMethod
dvander@950
    43
{
dvander@950
    44
	SDKPass_Pointer,		/**< Pass as a pointer */
dvander@950
    45
	SDKPass_Plain,			/**< Pass as plain data */
dvander@950
    46
	SDKPass_ByValue,		/**< Pass an object by value */
dvander@950
    47
	SDKPass_ByRef,			/**< Pass an object by reference */
dvander@950
    48
};
dvander@950
    49
ds@1042
    50
int s_vtbl_index = -1;
dvander@950
    51
void *s_call_addr = NULL;
dvander@950
    52
ValveCallType s_vcalltype = ValveCall_Static;
dvander@950
    53
bool s_has_return = false;
dvander@950
    54
ValvePassInfo s_return;
dvander@950
    55
unsigned int s_numparams = 0;
dvander@950
    56
ValvePassInfo s_params[SP_MAX_EXEC_PARAMS];
dvander@950
    57
dvander@950
    58
inline void DecodePassMethod(ValveType vtype, SDKPassMethod method, PassType &type, unsigned int &flags)
dvander@950
    59
{
ds@1135
    60
	if (method == SDKPass_Pointer || method == SDKPass_ByRef)
dvander@950
    61
	{
dvander@950
    62
		type = PassType_Basic;
dvander@950
    63
		if (vtype == Valve_POD
dvander@954
    64
			|| vtype == Valve_Float
dvander@954
    65
			|| vtype == Valve_Bool)
dvander@950
    66
		{
ds@1135
    67
			flags = PASSFLAG_BYVAL | PASSFLAG_ASPOINTER;
dvander@950
    68
		} else {
dvander@950
    69
			flags = PASSFLAG_BYVAL;
dvander@950
    70
		}
dvander@950
    71
	} else if (method == SDKPass_Plain) {
dvander@950
    72
		type = PassType_Basic;
dvander@950
    73
		flags = PASSFLAG_BYVAL;
dvander@950
    74
	} else if (method == SDKPass_ByValue) {
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_BYVAL;
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
	{
faluco@1560
   109
		addrInBase = (void *)g_SMAPI->GetServerFactory(false);
dvander@950
   110
	} else if (params[1] == SDKLibrary_Engine) {
faluco@1560
   111
		addrInBase = (void *)g_SMAPI->GetEngineFactory(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];
ds@1135
   195
	SDKPassMethod method = (SDKPassMethod)params[2];
ds@1135
   196
	DecodePassMethod(info->vtype, method, info->type, info->flags);
dvander@954
   197
	info->decflags = params[3] | VDECODE_FLAG_BYREF;
dvander@950
   198
	info->encflags = params[4];
dvander@950
   199
ds@1135
   200
	/* Since SDKPass_ByRef acts like SDKPass_Pointer we can't allow NULL, just in case */
ds@1135
   201
	if (method == SDKPass_ByRef)
ds@1135
   202
	{
ds@1135
   203
		info->decflags &= ~VDECODE_FLAG_ALLOWNULL;
ds@1135
   204
	}
ds@1135
   205
dvander@950
   206
	return 1;
dvander@950
   207
}
dvander@950
   208
dvander@950
   209
static cell_t EndPrepSDKCall(IPluginContext *pContext, const cell_t *params)
dvander@950
   210
{
dvander@950
   211
	ValveCall *vc = NULL;
ds@1042
   212
	if (s_vtbl_index > -1)
dvander@950
   213
	{
dvander@950
   214
		vc = CreateValveVCall(s_vtbl_index, s_vcalltype, s_has_return ? &s_return : NULL, s_params, s_numparams);
dvander@953
   215
	} else if (s_call_addr) {
dvander@953
   216
		vc = CreateValveCall(s_call_addr, s_vcalltype, s_has_return ? &s_return : NULL, s_params, s_numparams);
dvander@950
   217
	}
dvander@950
   218
dvander@950
   219
	if (!vc)
dvander@950
   220
	{
dvander@950
   221
		return BAD_HANDLE;
dvander@950
   222
	}
dvander@950
   223
dvander@968
   224
	if (vc->thisinfo)
dvander@968
   225
	{
dvander@968
   226
		vc->thisinfo->decflags |= VDECODE_FLAG_BYREF;
dvander@968
   227
	}
dvander@968
   228
dvander@950
   229
	Handle_t hndl = handlesys->CreateHandle(g_CallHandle, vc, pContext->GetIdentity(), myself->GetIdentity(), NULL);
dvander@950
   230
	if (!hndl)
dvander@950
   231
	{
dvander@950
   232
		delete vc;
dvander@950
   233
	}
dvander@950
   234
dvander@950
   235
	return hndl;
dvander@950
   236
}
dvander@950
   237
dvander@950
   238
static cell_t SDKCall(IPluginContext *pContext, const cell_t *params)
dvander@950
   239
{
dvander@950
   240
	ValveCall *vc;
dvander@950
   241
	HandleError err;
dvander@950
   242
	HandleSecurity sec(pContext->GetIdentity(), myself->GetIdentity());
dvander@950
   243
dvander@950
   244
	if ((err = handlesys->ReadHandle(params[1], g_CallHandle, &sec, (void **)&vc)) != HandleError_None)
dvander@950
   245
	{
dvander@950
   246
		return pContext->ThrowNativeError("Invalid Handle %x (error %d)", params[1], err);
dvander@950
   247
	}
dvander@950
   248
dvander@950
   249
	unsigned char *ptr = vc->stk_get();
dvander@950
   250
dvander@950
   251
	unsigned int numparams = (unsigned)params[0];
dvander@950
   252
	unsigned int startparam = 2;
dvander@950
   253
	/* Do we need to write a thispointer?  */
dvander@950
   254
ds@1065
   255
	if (vc->thisinfo)
dvander@950
   256
	{
ds@1065
   257
		switch (vc->type)
dvander@950
   258
		{
ds@1065
   259
		case ValveCall_Entity:
ds@1065
   260
		case ValveCall_Player:
ds@1065
   261
			{
ds@1065
   262
				if (startparam > numparams)
ds@1065
   263
				{
ds@1065
   264
					vc->stk_put(ptr);
ds@1065
   265
					return pContext->ThrowNativeError("Expected 1 parameter for entity pointer; found none");
ds@1065
   266
				}
ds@1065
   267
ds@1065
   268
				if (DecodeValveParam(pContext, 
ds@1065
   269
					params[startparam],
ds@1065
   270
					vc,
ds@1065
   271
					vc->thisinfo,
ds@1065
   272
					ptr) == Data_Fail)
ds@1065
   273
				{
ds@1065
   274
					vc->stk_put(ptr);
ds@1065
   275
					return 0;
ds@1065
   276
				}
ds@1065
   277
				startparam++;
ds@1065
   278
			}
ds@1065
   279
			break;
ds@1065
   280
		case ValveCall_GameRules:
ds@1065
   281
			{
ds@1065
   282
				if (g_pGameRules == NULL)
ds@1065
   283
				{
ds@1065
   284
					vc->stk_put(ptr);
ds@1065
   285
					return pContext->ThrowNativeError("GameRules unsupported or not available; file a bug report");
ds@1065
   286
				}
ds@1065
   287
ds@1065
   288
				void *gamerules = *g_pGameRules;
ds@1065
   289
ds@1065
   290
				if (gamerules == NULL)
ds@1065
   291
				{
ds@1065
   292
					vc->stk_put(ptr);
ds@1065
   293
					return pContext->ThrowNativeError("GameRules not available before map is loaded");
ds@1065
   294
				}
ds@1065
   295
				*(void **)ptr = gamerules;
ds@1065
   296
			}
ds@1065
   297
			break;
ds@1240
   298
		case ValveCall_EntityList:
ds@1240
   299
			{
ds@1240
   300
				if (g_EntList == NULL)
ds@1240
   301
				{
ds@1240
   302
					vc->stk_put(ptr);
ds@1240
   303
					return pContext->ThrowNativeError("EntityList unsupported or not available; file a bug report");
ds@1240
   304
				}
ds@1240
   305
ds@1240
   306
				*(void **)ptr = g_EntList;
ds@1240
   307
			}
ds@1240
   308
			break;
dvander@950
   309
		}
dvander@950
   310
	}
dvander@950
   311
dvander@950
   312
	/* See if we need to skip any more parameters */
dvander@950
   313
	unsigned int retparam = startparam;
dvander@950
   314
	if (vc->retinfo)
dvander@950
   315
	{
dvander@950
   316
		if (vc->retinfo->vtype == Valve_String)
dvander@950
   317
		{
dvander@950
   318
			startparam += 2;
dvander@950
   319
		} else if (vc->retinfo->vtype == Valve_Vector
dvander@950
   320
					|| vc->retinfo->vtype == Valve_QAngle)
dvander@950
   321
		{
dvander@950
   322
			startparam += 1;
dvander@950
   323
		}
dvander@950
   324
	}
dvander@950
   325
dvander@950
   326
	unsigned int callparams = vc->call->GetParamCount();
dvander@950
   327
	bool will_copyback = false;
dvander@950
   328
	for (unsigned int i=0; i<callparams; i++)
dvander@950
   329
	{
dvander@950
   330
		unsigned int p = startparam + i;
dvander@950
   331
		if (p > numparams)
dvander@950
   332
		{
dvander@950
   333
			vc->stk_put(ptr);
dvander@950
   334
			return pContext->ThrowNativeError("Expected %dth parameter, found none", p);
dvander@950
   335
		}
dvander@950
   336
		if (DecodeValveParam(pContext,
dvander@950
   337
			params[p],
dvander@987
   338
			vc,
dvander@954
   339
			&(vc->vparams[i]),
dvander@987
   340
			ptr) == Data_Fail)
dvander@950
   341
		{
dvander@950
   342
			vc->stk_put(ptr);
dvander@950
   343
			return 0;
dvander@950
   344
		}
dvander@950
   345
		if (vc->vparams[i].encflags & VENCODE_FLAG_COPYBACK)
dvander@950
   346
		{
dvander@950
   347
			will_copyback = true;
dvander@950
   348
		}
dvander@950
   349
	}
dvander@950
   350
dvander@950
   351
	/* Make the actual call */
dvander@950
   352
	vc->call->Execute(ptr, vc->retbuf);
dvander@950
   353
dvander@950
   354
	/* Do we need to copy anything back? */
dvander@950
   355
	if (will_copyback)
dvander@950
   356
	{
dvander@950
   357
		for (unsigned int i=0; i<callparams; i++)
dvander@950
   358
		{
dvander@950
   359
			if (vc->vparams[i].encflags & VENCODE_FLAG_COPYBACK)
dvander@950
   360
			{
dvander@950
   361
				if (EncodeValveParam(pContext, 
ds@1130
   362
					params[startparam + i], 
dvander@987
   363
					vc,
dvander@954
   364
					&vc->vparams[i],
dvander@987
   365
					ptr) == Data_Fail)
dvander@950
   366
				{
dvander@950
   367
					vc->stk_put(ptr);
dvander@950
   368
					return 0;
dvander@950
   369
				}
dvander@950
   370
			}
dvander@950
   371
		}
dvander@950
   372
	}
dvander@950
   373
dvander@950
   374
	/* Save stack once and for all */
dvander@950
   375
	vc->stk_put(ptr);
dvander@950
   376
dvander@950
   377
	/* Figure out how to decode the return information */
dvander@950
   378
	if (vc->retinfo)
dvander@950
   379
	{
dvander@950
   380
		if (vc->retinfo->vtype == Valve_String)
dvander@950
   381
		{
dvander@950
   382
			if (numparams < 3)
dvander@950
   383
			{
dvander@950
   384
				return pContext->ThrowNativeError("Expected arguments (2,3) for string storage");
dvander@950
   385
			}
dvander@950
   386
			cell_t *addr;
dvander@950
   387
			size_t written;
dvander@950
   388
			pContext->LocalToPhysAddr(params[retparam+1], &addr);
dvander@950
   389
			pContext->StringToLocalUTF8(params[retparam], *addr, *(char **)vc->retbuf, &written);
dvander@950
   390
			return (cell_t)written;
dvander@950
   391
		} else if (vc->retinfo->vtype == Valve_Vector
dvander@950
   392
					|| vc->retinfo->vtype == Valve_QAngle)
dvander@950
   393
		{
dvander@950
   394
			if (numparams < 2)
dvander@950
   395
			{
dvander@950
   396
				return pContext->ThrowNativeError("Expected argument (2) for Float[3] storage");
dvander@950
   397
			}
dvander@987
   398
			if (EncodeValveParam(pContext, params[retparam], vc, vc->retinfo, vc->retbuf)
dvander@950
   399
				== Data_Fail)
dvander@950
   400
			{
dvander@950
   401
				return 0;
dvander@950
   402
			}
dvander@950
   403
		} else if (vc->retinfo->vtype == Valve_CBaseEntity
dvander@950
   404
					|| vc->retinfo->vtype == Valve_CBasePlayer)
dvander@950
   405
		{
dvander@950
   406
			CBaseEntity *pEntity = *(CBaseEntity **)(vc->retbuf);
dvander@950
   407
			if (!pEntity)
dvander@950
   408
			{
dvander@950
   409
				return -1;
dvander@950
   410
			}
dvander@950
   411
			edict_t *pEdict = gameents->BaseEntityToEdict(pEntity);
dvander@950
   412
			if (!pEdict || pEdict->IsFree())
dvander@950
   413
			{
dvander@950
   414
				return -1;
dvander@950
   415
			}
dvander@950
   416
			return engine->IndexOfEdict(pEdict);
dvander@950
   417
		} else if (vc->retinfo->vtype == Valve_Edict) {
dvander@950
   418
			edict_t *pEdict = *(edict_t **)(vc->retbuf);
dvander@950
   419
			if (!pEdict || pEdict->IsFree())
dvander@950
   420
			{
dvander@950
   421
				return -1;
dvander@950
   422
			}
dvander@950
   423
			return engine->IndexOfEdict(pEdict);
dvander@954
   424
		} else if (vc->retinfo->vtype == Valve_Bool) {
dvander@954
   425
			bool *addr = (bool  *)vc->retbuf;
ds@1135
   426
			if (vc->retinfo->flags & PASSFLAG_ASPOINTER)
dvander@954
   427
			{
dvander@954
   428
				addr = *(bool **)addr;
dvander@954
   429
			}
dvander@954
   430
			return *addr ? 1 : 0;
dvander@950
   431
		} else {
dvander@950
   432
			cell_t *addr = (cell_t *)vc->retbuf;
ds@1135
   433
			if (vc->retinfo->flags & PASSFLAG_ASPOINTER)
dvander@950
   434
			{
dvander@950
   435
				addr = *(cell_t **)addr;
dvander@950
   436
			}
dvander@950
   437
			return *addr;
dvander@950
   438
		}
dvander@950
   439
	}
dvander@950
   440
dvander@950
   441
	return 0;
dvander@950
   442
}
dvander@950
   443
dvander@950
   444
sp_nativeinfo_t g_CallNatives[] = 
dvander@950
   445
{
dvander@950
   446
	{"StartPrepSDKCall",			StartPrepSDKCall},
dvander@950
   447
	{"PrepSDKCall_SetVirtual",		PrepSDKCall_SetVirtual},
dvander@950
   448
	{"PrepSDKCall_SetSignature",	PrepSDKCall_SetSignature},
dvander@950
   449
	{"PrepSDKCall_SetFromConf",		PrepSDKCall_SetFromConf},
dvander@950
   450
	{"PrepSDKCall_SetReturnInfo",	PrepSDKCall_SetReturnInfo},
dvander@950
   451
	{"PrepSDKCall_AddParameter",	PrepSDKCall_AddParameter},
dvander@950
   452
	{"EndPrepSDKCall",				EndPrepSDKCall},
dvander@950
   453
	{"SDKCall",						SDKCall},
dvander@950
   454
	{NULL,							NULL},
dvander@950
   455
};