core/systems/HandleSys.cpp
author David Anderson <dvander@alliedmods.net>
Thu Jun 07 02:36:54 2007 +0000 (2007-06-07)
changeset 900 b38c83f9d526
parent 789 61b9fe952a02
child 1231 17badaf66ce4
permissions -rw-r--r--
added sm_dump_handles command for tracking down Handle leaks... more to come someday
dvander@370
     1
/**
ds@653
     2
 * vim: set ts=4 :
dvander@370
     3
 * ===============================================================
dvander@370
     4
 * SourceMod (C)2004-2007 AlliedModders LLC.  All rights reserved.
dvander@370
     5
 * ===============================================================
dvander@370
     6
 *
dvander@370
     7
 * This file is not open source and may not be copied without explicit
dvander@370
     8
 * written permission of AlliedModders LLC.  This file may not be redistributed 
dvander@370
     9
 * in whole or significant part.
dvander@370
    10
 * For information, see LICENSE.txt or http://www.sourcemod.net/license.php
dvander@370
    11
 *
dvander@370
    12
 * Version: $Id$
dvander@370
    13
 */
dvander@370
    14
dvander@218
    15
#include "HandleSys.h"
dvander@229
    16
#include "ShareSys.h"
dvander@218
    17
#include "PluginSys.h"
dvander@900
    18
#include "ExtensionSys.h"
dvander@222
    19
#include <assert.h>
dvander@351
    20
#include <string.h>
dvander@218
    21
dvander@218
    22
HandleSystem g_HandleSys;
dvander@218
    23
dvander@229
    24
QHandle *ignore_handle;
dvander@229
    25
dvander@229
    26
inline HandleType_t TypeParent(HandleType_t type)
dvander@229
    27
{
dvander@229
    28
	return (type & ~HANDLESYS_SUBTYPE_MASK);
dvander@229
    29
}
dvander@229
    30
dvander@229
    31
inline HandleError IdentityHandle(IdentityToken_t *token, unsigned int *index)
dvander@229
    32
{
dvander@262
    33
	return g_HandleSys.GetHandle(token->ident, g_ShareSys.GetIdentRoot(), &ignore_handle, index);
dvander@229
    34
}
dvander@229
    35
dvander@218
    36
HandleSystem::HandleSystem()
dvander@218
    37
{
dvander@218
    38
	m_Handles = new QHandle[HANDLESYS_MAX_HANDLES + 1];
dvander@218
    39
	memset(m_Handles, 0, sizeof(QHandle) * (HANDLESYS_MAX_HANDLES + 1));
dvander@218
    40
dvander@218
    41
	m_Types = new QHandleType[HANDLESYS_TYPEARRAY_SIZE];
dvander@218
    42
	memset(m_Types, 0, sizeof(QHandleType) * HANDLESYS_TYPEARRAY_SIZE);
dvander@218
    43
dvander@218
    44
	m_TypeLookup = sm_trie_create();
dvander@218
    45
	m_strtab = new BaseStringTable(512);
dvander@218
    46
dvander@218
    47
	m_TypeTail = 0;
dvander@218
    48
}
dvander@218
    49
dvander@218
    50
HandleSystem::~HandleSystem()
dvander@218
    51
{
dvander@218
    52
	delete [] m_Handles;
dvander@218
    53
	delete [] m_Types;
dvander@218
    54
	sm_trie_destroy(m_TypeLookup);
dvander@218
    55
	delete m_strtab;
dvander@218
    56
}
dvander@218
    57
dvander@218
    58
dvander@262
    59
HandleType_t HandleSystem::CreateType(const char *name, 
dvander@262
    60
									  IHandleTypeDispatch *dispatch, 
dvander@262
    61
									  HandleType_t parent, 
dvander@262
    62
									  const TypeAccess *typeAccess, 
dvander@262
    63
									  const HandleAccess *hndlAccess, 
dvander@262
    64
									  IdentityToken_t *ident,
dvander@262
    65
									  HandleError *err)
dvander@218
    66
{
dvander@218
    67
	if (!dispatch)
dvander@218
    68
	{
dvander@262
    69
		if (err)
dvander@262
    70
		{
dvander@262
    71
			*err = HandleError_Parameter;
dvander@262
    72
		}
dvander@262
    73
		return 0;
dvander@262
    74
	}
dvander@262
    75
dvander@262
    76
	if (typeAccess && typeAccess->hsVersion > SMINTERFACE_HANDLESYSTEM_VERSION)
dvander@262
    77
	{
dvander@262
    78
		if (err)
dvander@262
    79
		{
dvander@262
    80
			*err = HandleError_Version;
dvander@262
    81
		}
dvander@262
    82
		return 0;
dvander@262
    83
	}
dvander@262
    84
dvander@262
    85
	if (hndlAccess && hndlAccess->hsVersion > SMINTERFACE_HANDLESYSTEM_VERSION)
dvander@262
    86
	{
dvander@262
    87
		if (err)
dvander@262
    88
		{
dvander@262
    89
			*err = HandleError_Version;
dvander@262
    90
		}
dvander@218
    91
		return 0;
dvander@218
    92
	}
dvander@218
    93
dvander@218
    94
	bool isChild = false;
dvander@218
    95
dvander@218
    96
	if (parent != 0)
dvander@218
    97
	{
dvander@218
    98
		isChild = true;
dvander@218
    99
		if (parent & HANDLESYS_SUBTYPE_MASK)
dvander@218
   100
		{
dvander@262
   101
			if (err)
dvander@262
   102
			{
dvander@262
   103
				*err = HandleError_NoInherit;
dvander@262
   104
			}
dvander@218
   105
			return 0;
dvander@218
   106
		}
dvander@218
   107
		if (parent >= HANDLESYS_TYPEARRAY_SIZE
dvander@262
   108
			|| m_Types[parent].dispatch == NULL)
dvander@218
   109
		{
dvander@262
   110
			if (err)
dvander@262
   111
			{
dvander@262
   112
				*err = HandleError_Parameter;
dvander@262
   113
			}
dvander@262
   114
			return 0;
dvander@262
   115
		}
dvander@262
   116
		if (m_Types[parent].typeSec.access[HTypeAccess_Inherit] == false
dvander@262
   117
			&& (m_Types[parent].typeSec.ident != ident))
dvander@262
   118
		{
dvander@262
   119
			if (err)
dvander@262
   120
			{
dvander@262
   121
				*err = HandleError_Access;
dvander@262
   122
			}
dvander@218
   123
			return 0;
dvander@218
   124
		}
dvander@218
   125
	}
dvander@218
   126
dvander@262
   127
	if (name && name[0] != '\0')
dvander@218
   128
	{
dvander@262
   129
		if (sm_trie_retrieve(m_TypeLookup, name, NULL))
dvander@218
   130
		{
dvander@262
   131
			if (err)
dvander@262
   132
			{
dvander@262
   133
				*err = HandleError_Parameter;
dvander@262
   134
			}
dvander@262
   135
			return 0;
dvander@218
   136
		}
dvander@218
   137
	}
dvander@218
   138
dvander@218
   139
	unsigned int index;
dvander@218
   140
dvander@218
   141
	if (isChild)
dvander@218
   142
	{
dvander@218
   143
		QHandleType *pParent = &m_Types[parent];
dvander@218
   144
		if (pParent->children >= HANDLESYS_MAX_SUBTYPES)
dvander@218
   145
		{
dvander@262
   146
			if (err)
dvander@262
   147
			{
dvander@262
   148
				*err = HandleError_Limit;
dvander@262
   149
			}
dvander@218
   150
			return 0;
dvander@218
   151
		}
dvander@218
   152
		index = 0;
dvander@218
   153
		for (unsigned int i=1; i<=HANDLESYS_MAX_SUBTYPES; i++)
dvander@218
   154
		{
dvander@218
   155
			if (m_Types[parent + i].dispatch == NULL)
dvander@218
   156
			{
dvander@218
   157
				index = parent + i;
dvander@218
   158
				break;
dvander@218
   159
			}
dvander@218
   160
		}
dvander@218
   161
		if (!index)
dvander@218
   162
		{
dvander@262
   163
			if (err)
dvander@262
   164
			{
dvander@262
   165
				*err = HandleError_Limit;
dvander@262
   166
			}
dvander@218
   167
			return 0;
dvander@218
   168
		}
dvander@218
   169
		pParent->children++;
dvander@218
   170
	} else {
dvander@218
   171
		if (m_FreeTypes == 0)
dvander@218
   172
		{
dvander@218
   173
			/* Reserve another index */
dvander@218
   174
			if (m_TypeTail >= HANDLESYS_TYPEARRAY_SIZE)
dvander@218
   175
			{
dvander@262
   176
				if (err)
dvander@262
   177
				{
dvander@262
   178
					*err = HandleError_Limit;
dvander@262
   179
				}
dvander@218
   180
				return 0;
dvander@218
   181
			} else {
dvander@218
   182
				m_TypeTail += (HANDLESYS_MAX_SUBTYPES + 1);
dvander@218
   183
				index = m_TypeTail;
dvander@218
   184
			}
dvander@218
   185
		} else {
dvander@218
   186
			/* The "free array" is compacted into the normal array for easiness */
dvander@218
   187
			index = m_Types[m_FreeTypes--].freeID;
dvander@218
   188
		}
dvander@218
   189
	}
dvander@218
   190
dvander@218
   191
	QHandleType *pType = &m_Types[index];
dvander@218
   192
	
dvander@218
   193
	pType->dispatch = dispatch;
dvander@218
   194
	if (name && name[0] != '\0')
dvander@218
   195
	{
dvander@218
   196
		pType->nameIdx = m_strtab->AddString(name);
dvander@218
   197
		sm_trie_insert(m_TypeLookup, name, (void *)pType);
dvander@218
   198
	} else {
dvander@218
   199
		pType->nameIdx = -1;
dvander@218
   200
	}
dvander@262
   201
dvander@218
   202
	pType->opened = 0;
dvander@218
   203
dvander@262
   204
	if (typeAccess)
dvander@262
   205
	{
dvander@262
   206
		pType->typeSec = *typeAccess;
dvander@262
   207
	} else {
dvander@262
   208
		InitAccessDefaults(&pType->typeSec, NULL);
dvander@262
   209
		pType->typeSec.ident = ident;
dvander@262
   210
	}
dvander@262
   211
dvander@262
   212
	if (hndlAccess)
dvander@262
   213
	{
dvander@262
   214
		pType->hndlSec = *hndlAccess;
dvander@262
   215
	} else {
dvander@262
   216
		InitAccessDefaults(NULL, &pType->hndlSec);
dvander@262
   217
	}
dvander@262
   218
dvander@218
   219
	if (!isChild)
dvander@218
   220
	{
dvander@218
   221
		pType->children = 0;
dvander@218
   222
	}
dvander@218
   223
dvander@218
   224
	return index;
dvander@218
   225
}
dvander@218
   226
dvander@218
   227
bool HandleSystem::FindHandleType(const char *name, HandleType_t *type)
dvander@218
   228
{
dvander@218
   229
	QHandleType *_type;
dvander@218
   230
dvander@218
   231
	if (!sm_trie_retrieve(m_TypeLookup, name, (void **)&_type))
dvander@218
   232
	{
dvander@218
   233
		return false;
dvander@218
   234
	}
dvander@218
   235
dvander@218
   236
	unsigned int offset = _type - m_Types;
dvander@218
   237
dvander@218
   238
	if (type)
dvander@218
   239
	{
dvander@218
   240
		*type = offset;
dvander@218
   241
	}
dvander@218
   242
dvander@218
   243
	return true;
dvander@218
   244
}
dvander@218
   245
dvander@222
   246
HandleError HandleSystem::MakePrimHandle(HandleType_t type, 
dvander@222
   247
						   QHandle **in_pHandle, 
dvander@222
   248
						   unsigned int *in_index, 
dvander@229
   249
						   Handle_t *in_handle,
dvander@283
   250
						   IdentityToken_t *owner,
dvander@283
   251
						   bool identity)
dvander@222
   252
{
dvander@229
   253
	unsigned int owner_index = 0;
dvander@229
   254
dvander@229
   255
	if (owner && (IdentityHandle(owner, &owner_index) != HandleError_None))
dvander@229
   256
	{
dvander@229
   257
		return HandleError_Identity;
dvander@229
   258
	}
dvander@229
   259
dvander@222
   260
	unsigned int handle;
dvander@222
   261
	if (m_FreeHandles == 0)
dvander@222
   262
	{
dvander@222
   263
		if (m_HandleTail >= HANDLESYS_MAX_HANDLES)
dvander@222
   264
		{
dvander@222
   265
			return HandleError_Limit;;
dvander@222
   266
		}
dvander@222
   267
		handle = ++m_HandleTail;
dvander@222
   268
	} else {
dvander@222
   269
		handle = m_Handles[m_FreeHandles--].freeID;
dvander@222
   270
	}
dvander@222
   271
dvander@222
   272
	QHandle *pHandle = &m_Handles[handle];
dvander@222
   273
	
dvander@222
   274
	assert(pHandle->set == false);
dvander@222
   275
dvander@222
   276
	if (++m_HSerial >= HANDLESYS_MAX_SERIALS)
dvander@222
   277
	{
dvander@222
   278
		m_HSerial = 1;
dvander@222
   279
	}
dvander@222
   280
dvander@222
   281
	/* Set essential information */
dvander@283
   282
	pHandle->set = identity ? HandleSet_Identity : HandleSet_Used;
dvander@222
   283
	pHandle->refcount = 1;
dvander@222
   284
	pHandle->type = type;
dvander@222
   285
	pHandle->serial = m_HSerial;
dvander@229
   286
	pHandle->owner = owner;
dvander@229
   287
	pHandle->ch_next = 0;
dvander@528
   288
	pHandle->access_special = false;
dvander@789
   289
	pHandle->is_destroying = false;
dvander@222
   290
dvander@222
   291
	/* Create the hash value */
dvander@222
   292
	Handle_t hash = pHandle->serial;
dvander@222
   293
	hash <<= 16;
dvander@222
   294
	hash |= handle;
dvander@222
   295
dvander@222
   296
	/* Add a reference count to the type */
dvander@222
   297
	m_Types[type].opened++;
dvander@222
   298
dvander@222
   299
	/* Output */
dvander@222
   300
	*in_pHandle = pHandle;
dvander@222
   301
	*in_index = handle;
dvander@222
   302
	*in_handle = hash;
dvander@222
   303
dvander@283
   304
	/* Decode the identity token 
dvander@283
   305
	 * For now, we don't allow nested ownership
dvander@283
   306
	 */
dvander@283
   307
	if (owner && !identity)
dvander@229
   308
	{
dvander@229
   309
		QHandle *pIdentity = &m_Handles[owner_index];
dvander@229
   310
		if (pIdentity->ch_prev == 0)
dvander@229
   311
		{
dvander@229
   312
			pIdentity->ch_prev = handle;
dvander@229
   313
			pIdentity->ch_next = handle;
dvander@229
   314
			pHandle->ch_prev = 0;
dvander@229
   315
		} else {
dvander@229
   316
			/* Link previous node to us (forward) */
dvander@229
   317
			m_Handles[pIdentity->ch_next].ch_next = handle;
dvander@229
   318
			/* Link us to previous node (backwards) */
dvander@229
   319
			pHandle->ch_prev = pIdentity->ch_next;
dvander@229
   320
			/* Set new tail */
dvander@229
   321
			pIdentity->ch_next = handle;
dvander@229
   322
		}
dvander@229
   323
		pIdentity->refcount++;
dvander@229
   324
	} else {
dvander@229
   325
		pHandle->ch_prev = 0;
dvander@229
   326
	}
dvander@229
   327
dvander@222
   328
	return HandleError_None;
dvander@222
   329
}
dvander@222
   330
dvander@229
   331
void HandleSystem::SetTypeSecurityOwner(HandleType_t type, IdentityToken_t *pToken)
dvander@229
   332
{
dvander@229
   333
	if (!type
dvander@229
   334
		|| type >= HANDLESYS_TYPEARRAY_SIZE
dvander@229
   335
		|| m_Types[type].dispatch == NULL)
dvander@229
   336
	{
dvander@229
   337
		return;
dvander@229
   338
	}
dvander@229
   339
dvander@262
   340
	m_Types[type].typeSec.ident = pToken;
dvander@229
   341
}
dvander@229
   342
dvander@528
   343
Handle_t HandleSystem::CreateHandleInt(HandleType_t type, 
dvander@528
   344
									   void *object, 
dvander@528
   345
									   const HandleSecurity *pSec,
dvander@528
   346
									   HandleError *err, 
dvander@528
   347
									   const HandleAccess *pAccess,
dvander@528
   348
									   bool identity)
dvander@218
   349
{
dvander@528
   350
	IdentityToken_t *ident;
dvander@528
   351
	IdentityToken_t *owner;
dvander@528
   352
dvander@528
   353
	if (pSec)
dvander@528
   354
	{
dvander@528
   355
		ident = pSec->pIdentity;
dvander@528
   356
		owner = pSec->pOwner;
dvander@528
   357
	} else {
dvander@528
   358
		ident = NULL;
dvander@528
   359
		owner = NULL;
dvander@528
   360
	}
dvander@528
   361
dvander@218
   362
	if (!type 
dvander@218
   363
		|| type >= HANDLESYS_TYPEARRAY_SIZE
dvander@218
   364
		|| m_Types[type].dispatch == NULL)
dvander@218
   365
	{
dvander@262
   366
		if (err)
dvander@262
   367
		{
dvander@262
   368
			*err = HandleError_Parameter;
dvander@262
   369
		}
dvander@218
   370
		return 0;
dvander@218
   371
	}
dvander@218
   372
dvander@262
   373
	/* Check to see if we're allowed to create this handle type */
dvander@218
   374
	QHandleType *pType = &m_Types[type];
dvander@262
   375
	if (!pType->typeSec.access[HTypeAccess_Create]
dvander@283
   376
	&& (!pType->typeSec.ident
dvander@283
   377
		|| pType->typeSec.ident != ident))
dvander@218
   378
	{
dvander@262
   379
		if (err)
dvander@262
   380
		{
dvander@262
   381
			*err = HandleError_Access;
dvander@262
   382
		}
dvander@218
   383
		return 0;
dvander@218
   384
	}
dvander@218
   385
dvander@222
   386
	unsigned int index;
dvander@222
   387
	Handle_t handle;
dvander@222
   388
	QHandle *pHandle;
dvander@262
   389
	HandleError _err;
dvander@222
   390
dvander@283
   391
	if ((_err=MakePrimHandle(type, &pHandle, &index, &handle, owner, identity)) != HandleError_None)
dvander@218
   392
	{
dvander@262
   393
		if (err)
dvander@262
   394
		{
dvander@262
   395
			*err = _err;
dvander@262
   396
		}
dvander@222
   397
		return 0;
dvander@218
   398
	}
dvander@218
   399
dvander@528
   400
	if (pAccess)
dvander@528
   401
	{
dvander@528
   402
		pHandle->access_special = true;
dvander@528
   403
		pHandle->sec = *pAccess;
dvander@528
   404
	}
dvander@528
   405
dvander@218
   406
	pHandle->object = object;
dvander@222
   407
	pHandle->clone = 0;
dvander@218
   408
dvander@222
   409
	return handle;
dvander@218
   410
}
dvander@218
   411
dvander@528
   412
Handle_t HandleSystem::CreateHandleEx(HandleType_t type, void *object, const HandleSecurity *pSec, const HandleAccess *pAccess, HandleError *err)
dvander@528
   413
{
dvander@528
   414
	return CreateHandleInt(type, object, pSec, err, pAccess, false);
dvander@528
   415
}
dvander@528
   416
dvander@283
   417
Handle_t HandleSystem::CreateHandle(HandleType_t type, void *object, IdentityToken_t *owner, IdentityToken_t *ident, HandleError *err)
dvander@283
   418
{
dvander@528
   419
	HandleSecurity sec;
dvander@528
   420
dvander@528
   421
	sec.pIdentity = ident;
dvander@528
   422
	sec.pOwner = owner;
dvander@528
   423
dvander@528
   424
	return CreateHandleEx(type, object, &sec, NULL, err);
dvander@283
   425
}
dvander@283
   426
dvander@229
   427
bool HandleSystem::TypeCheck(HandleType_t intype, HandleType_t outtype)
dvander@229
   428
{
dvander@229
   429
	/* Check the type inheritance */
dvander@229
   430
	if (intype & HANDLESYS_SUBTYPE_MASK)
dvander@229
   431
	{
dvander@229
   432
		if (intype != outtype
dvander@229
   433
			&& (TypeParent(intype) != TypeParent(outtype)))
dvander@229
   434
		{
dvander@229
   435
			return false;
dvander@229
   436
		}
dvander@229
   437
	} else {
dvander@229
   438
		if (intype != outtype)
dvander@229
   439
		{
dvander@229
   440
			return false;
dvander@229
   441
		}
dvander@229
   442
	}
dvander@229
   443
dvander@229
   444
	return true;
dvander@229
   445
}
dvander@229
   446
dvander@222
   447
HandleError HandleSystem::GetHandle(Handle_t handle,
dvander@229
   448
									IdentityToken_t *ident, 
dvander@222
   449
									QHandle **in_pHandle, 
dvander@222
   450
									unsigned int *in_index,
dvander@259
   451
									bool ignoreFree)
dvander@218
   452
{
dvander@218
   453
	unsigned int serial = (handle >> 16);
dvander@218
   454
	unsigned int index = (handle & HANDLESYS_HANDLE_MASK);
dvander@218
   455
dvander@218
   456
	if (index == 0 || index == 0xFFFF)
dvander@218
   457
	{
dvander@218
   458
		return HandleError_Index;
dvander@218
   459
	}
dvander@218
   460
dvander@218
   461
	QHandle *pHandle = &m_Handles[index];
dvander@218
   462
dvander@259
   463
	if (!pHandle->set
dvander@259
   464
		|| (pHandle->set == HandleSet_Freed && !ignoreFree))
dvander@218
   465
	{
dvander@218
   466
		return HandleError_Freed;
dvander@229
   467
	} else if (pHandle->set == HandleSet_Identity
dvander@229
   468
			   && ident != g_ShareSys.GetIdentRoot())
dvander@229
   469
	{
dvander@229
   470
		/* Only IdentityHandle() can read this! */
dvander@229
   471
		return HandleError_Identity;
dvander@218
   472
	}
dvander@218
   473
	if (pHandle->serial != serial)
dvander@218
   474
	{
dvander@218
   475
		return HandleError_Changed;
dvander@218
   476
	}
dvander@218
   477
dvander@222
   478
	*in_pHandle = pHandle;
dvander@222
   479
	*in_index = index;
dvander@222
   480
dvander@222
   481
	return HandleError_None;
dvander@222
   482
}
dvander@222
   483
dvander@262
   484
bool HandleSystem::CheckAccess(QHandle *pHandle, HandleAccessRight right, const HandleSecurity *pSecurity)
dvander@262
   485
{
dvander@262
   486
	QHandleType *pType = &m_Types[pHandle->type];
dvander@528
   487
	unsigned int access;
dvander@528
   488
dvander@528
   489
	if (pHandle->access_special)
dvander@528
   490
	{
dvander@528
   491
		access = pHandle->sec.access[right];
dvander@528
   492
	} else {
dvander@528
   493
		access = pType->hndlSec.access[right];
dvander@528
   494
	}
dvander@262
   495
dvander@262
   496
	/* Check if the type's identity matches */
dvander@262
   497
	if (access & HANDLE_RESTRICT_IDENTITY)
dvander@262
   498
	{
dvander@262
   499
		IdentityToken_t *owner = pType->typeSec.ident;
dvander@262
   500
		if (!owner
dvander@262
   501
			|| (!pSecurity || pSecurity->pIdentity != owner))
dvander@262
   502
		{
dvander@262
   503
			return false;
dvander@262
   504
		}
dvander@262
   505
	}
dvander@262
   506
dvander@262
   507
	/* Check if the owner is allowed */
dvander@262
   508
	if (access & HANDLE_RESTRICT_OWNER)
dvander@262
   509
	{
dvander@262
   510
		IdentityToken_t *owner = pHandle->owner;
dvander@262
   511
		if (owner
dvander@262
   512
			&& (!pSecurity || pSecurity->pOwner != owner))
dvander@262
   513
		{
dvander@262
   514
			return false;
dvander@262
   515
		}
dvander@262
   516
	}
dvander@262
   517
dvander@262
   518
	return true;
dvander@262
   519
}
dvander@262
   520
dvander@283
   521
HandleError HandleSystem::CloneHandle(QHandle *pHandle, unsigned int index, Handle_t *newhandle, IdentityToken_t *newOwner)
dvander@283
   522
{
dvander@283
   523
	/* Get a new Handle ID */
dvander@283
   524
	unsigned int new_index;
dvander@283
   525
	QHandle *pNewHandle;
dvander@283
   526
	Handle_t new_handle;
dvander@283
   527
	HandleError err;
dvander@283
   528
dvander@283
   529
	if ((err=MakePrimHandle(pHandle->type, &pNewHandle, &new_index, &new_handle, newOwner)) != HandleError_None)
dvander@283
   530
	{
dvander@283
   531
		return err;
dvander@283
   532
	}
dvander@283
   533
dvander@528
   534
	/* Assign permissions from parent */
dvander@528
   535
	if (pHandle->access_special)
dvander@528
   536
	{
dvander@528
   537
		pNewHandle->access_special = true;
dvander@528
   538
		pNewHandle->sec = pHandle->sec;
dvander@528
   539
	}
dvander@528
   540
dvander@283
   541
	pNewHandle->clone = index;
dvander@283
   542
	pHandle->refcount++;
dvander@283
   543
dvander@283
   544
	*newhandle = new_handle;
dvander@283
   545
dvander@283
   546
	return HandleError_None;
dvander@283
   547
}
dvander@283
   548
dvander@262
   549
HandleError HandleSystem::CloneHandle(Handle_t handle, Handle_t *newhandle, IdentityToken_t *newOwner, const HandleSecurity *pSecurity)
dvander@222
   550
{
dvander@222
   551
	HandleError err;
dvander@222
   552
	QHandle *pHandle;
dvander@222
   553
	unsigned int index;
dvander@262
   554
	IdentityToken_t *ident = pSecurity ? pSecurity->pIdentity : NULL;
dvander@222
   555
dvander@262
   556
	if ((err=GetHandle(handle, ident, &pHandle, &index)) != HandleError_None)
dvander@222
   557
	{
dvander@222
   558
		return err;
dvander@222
   559
	}
dvander@222
   560
dvander@259
   561
	/* Identities cannot be cloned */
dvander@259
   562
	if (pHandle->set == HandleSet_Identity)
dvander@259
   563
	{
dvander@259
   564
		return HandleError_Identity;
dvander@259
   565
	}
dvander@259
   566
dvander@262
   567
	/* Check if the handle can be cloned */
dvander@262
   568
	if (!CheckAccess(pHandle, HandleAccess_Clone, pSecurity))
dvander@262
   569
	{
dvander@262
   570
		return HandleError_Access;
dvander@262
   571
	}
dvander@222
   572
dvander@283
   573
	/* Make sure we're not cloning a clone */
dvander@283
   574
	if (pHandle->clone)
dvander@222
   575
	{
dvander@283
   576
		QHandle *pParent = &m_Handles[pHandle->clone];
dvander@283
   577
		return CloneHandle(pParent, pHandle->clone, newhandle, newOwner);
dvander@222
   578
	}
dvander@222
   579
dvander@283
   580
	return CloneHandle(pHandle, index, newhandle, newOwner);
dvander@283
   581
}
dvander@283
   582
dvander@283
   583
HandleError HandleSystem::FreeHandle(QHandle *pHandle, unsigned int index)
dvander@283
   584
{
dvander@283
   585
	QHandleType *pType = &m_Types[pHandle->type];
dvander@283
   586
dvander@283
   587
	if (pHandle->clone)
dvander@283
   588
	{
dvander@283
   589
		/* If we're a clone, decrease the parent reference count */
dvander@283
   590
		QHandle *pMaster;
dvander@283
   591
		unsigned int master;
dvander@283
   592
dvander@283
   593
		/* Note that if we ever have per-handle security, we would need to re-check
dvander@283
   594
		* the access on this Handle. */
dvander@283
   595
		master = pHandle->clone;
dvander@283
   596
		pMaster = &m_Handles[master];
dvander@283
   597
dvander@283
   598
		/* Release the clone now */
dvander@283
   599
		ReleasePrimHandle(index);
dvander@222
   600
dvander@283
   601
		/* Decrement the master's reference count */
dvander@283
   602
		if (--pMaster->refcount == 0)
dvander@283
   603
		{
dvander@283
   604
			/* Type should be the same but do this anyway... */
dvander@283
   605
			pType = &m_Types[pMaster->type];
dvander@789
   606
			pMaster->is_destroying = true;
dvander@283
   607
			pType->dispatch->OnHandleDestroy(pMaster->type, pMaster->object);
dvander@283
   608
			ReleasePrimHandle(master);
dvander@283
   609
		}
dvander@283
   610
	} else if (pHandle->set == HandleSet_Identity) {
dvander@283
   611
		/* If we're an identity, skip all this stuff!
dvander@283
   612
		 * NOTE: SHARESYS DOES NOT CARE ABOUT THE DESTRUCTOR
dvander@283
   613
		 */
dvander@283
   614
		ReleasePrimHandle(index);
dvander@283
   615
	} else {
dvander@283
   616
		/* Decrement, free if necessary */
dvander@283
   617
		if (--pHandle->refcount == 0)
dvander@283
   618
		{
dvander@789
   619
			pHandle->is_destroying = true;
dvander@283
   620
			pType->dispatch->OnHandleDestroy(pHandle->type, pHandle->object);
dvander@283
   621
			ReleasePrimHandle(index);
dvander@283
   622
		} else {
dvander@283
   623
			/* We must be cloned, so mark ourselves as freed */
dvander@283
   624
			pHandle->set = HandleSet_Freed;
dvander@283
   625
			/* Now, unlink us, so we're not being tracked by the owner */
dvander@283
   626
			if (pHandle->owner)
dvander@283
   627
			{
dvander@283
   628
				UnlinkHandleFromOwner(pHandle, index);
dvander@283
   629
			}
dvander@283
   630
		}
dvander@283
   631
	}
dvander@222
   632
dvander@222
   633
	return HandleError_None;
dvander@222
   634
}
dvander@222
   635
dvander@262
   636
HandleError HandleSystem::FreeHandle(Handle_t handle, const HandleSecurity *pSecurity)
dvander@222
   637
{
dvander@222
   638
	unsigned int index;
dvander@222
   639
	QHandle *pHandle;
dvander@222
   640
	HandleError err;
dvander@262
   641
	IdentityToken_t *ident = pSecurity ? pSecurity->pIdentity : NULL;
dvander@222
   642
dvander@262
   643
	if ((err=GetHandle(handle, ident, &pHandle, &index)) != HandleError_None)
dvander@222
   644
	{
dvander@222
   645
		return err;
dvander@222
   646
	}
dvander@222
   647
dvander@262
   648
	if (!CheckAccess(pHandle, HandleAccess_Delete, pSecurity))
dvander@259
   649
	{
dvander@259
   650
		return HandleError_Access;
dvander@259
   651
	}
dvander@259
   652
dvander@789
   653
	if (pHandle->is_destroying)
dvander@789
   654
	{
dvander@789
   655
		/* Someone tried to free this recursively.  
dvander@789
   656
		 * We'll just ignore this safely.
dvander@789
   657
		 */
dvander@789
   658
		return HandleError_None;
dvander@789
   659
	}
dvander@789
   660
dvander@283
   661
	return FreeHandle(pHandle, index);
dvander@218
   662
}
dvander@218
   663
dvander@262
   664
HandleError HandleSystem::ReadHandle(Handle_t handle, HandleType_t type, const HandleSecurity *pSecurity, void **object)
dvander@218
   665
{
dvander@222
   666
	unsigned int index;
dvander@222
   667
	QHandle *pHandle;
dvander@222
   668
	HandleError err;
dvander@262
   669
	IdentityToken_t *ident = pSecurity ? pSecurity->pIdentity : NULL;
dvander@218
   670
dvander@262
   671
	if ((err=GetHandle(handle, ident, &pHandle, &index)) != HandleError_None)
dvander@218
   672
	{
dvander@222
   673
		return err;
dvander@218
   674
	}
dvander@218
   675
dvander@262
   676
	if (!CheckAccess(pHandle, HandleAccess_Read, pSecurity))
dvander@262
   677
	{
dvander@262
   678
		return HandleError_Access;
dvander@262
   679
	}
dvander@262
   680
dvander@218
   681
	/* Check the type inheritance */
dvander@218
   682
	if (pHandle->type & HANDLESYS_SUBTYPE_MASK)
dvander@218
   683
	{
dvander@218
   684
		if (pHandle->type != type
dvander@218
   685
			&& (TypeParent(pHandle->type) != TypeParent(type)))
dvander@218
   686
		{
dvander@218
   687
			return HandleError_Type;
dvander@218
   688
		}
dvander@247
   689
	} else if (type) {
dvander@218
   690
		if (pHandle->type != type)
dvander@218
   691
		{
dvander@218
   692
			return HandleError_Type;
dvander@218
   693
		}
dvander@218
   694
	}
dvander@218
   695
dvander@218
   696
	if (object)
dvander@218
   697
	{
dvander@222
   698
		/* if we're a clone, the rules change - object is ONLY in our reference */
dvander@222
   699
		if (pHandle->clone)
dvander@222
   700
		{
dvander@262
   701
			pHandle = &m_Handles[pHandle->clone];
dvander@222
   702
		}
dvander@218
   703
		*object = pHandle->object;
dvander@218
   704
	}
dvander@218
   705
dvander@218
   706
	return HandleError_None;
dvander@218
   707
}
dvander@218
   708
dvander@283
   709
void HandleSystem::UnlinkHandleFromOwner(QHandle *pHandle, unsigned int index)
dvander@283
   710
{
dvander@283
   711
	/* Unlink us if necessary */
dvander@283
   712
	unsigned int ident_index;
dvander@283
   713
	if (IdentityHandle(pHandle->owner, &ident_index) != HandleError_None)
dvander@283
   714
	{
dvander@283
   715
		/* Uh-oh! */
dvander@283
   716
		assert(pHandle->owner == 0);
dvander@283
   717
		return;
dvander@283
   718
	}
dvander@283
   719
	/* Note that since 0 is an invalid handle, if any of these links are 0,
dvander@283
   720
	* the data can still be set.
dvander@283
   721
	*/
dvander@283
   722
	QHandle *pIdentity = &m_Handles[ident_index];
dvander@283
   723
dvander@283
   724
	/* Unlink case: We're the head AND tail node */
dvander@283
   725
	if (index == pIdentity->ch_prev && index == pIdentity->ch_next)
dvander@283
   726
	{
dvander@283
   727
		pIdentity->ch_prev = 0;
dvander@283
   728
		pIdentity->ch_next = 0;
dvander@283
   729
	}
dvander@283
   730
	/* Unlink case: We're the head node */
dvander@283
   731
	else if (index == pIdentity->ch_prev) {
dvander@283
   732
		/* Link us to the next in the chain */
dvander@283
   733
		pIdentity->ch_prev = pHandle->ch_next;
dvander@283
   734
		/* Patch up the previous link */
dvander@283
   735
		m_Handles[pHandle->ch_next].ch_prev = 0;
dvander@283
   736
	}
dvander@283
   737
	/* Unlink case: We're the tail node */
dvander@283
   738
	else if (index == pIdentity->ch_next) {
dvander@283
   739
		/* Link us to the previous in the chain */
dvander@283
   740
		pIdentity->ch_next = pHandle->ch_prev;
dvander@283
   741
		/* Patch up the next link */
dvander@283
   742
		m_Handles[pHandle->ch_prev].ch_next = 0;
dvander@283
   743
	}
dvander@283
   744
	/* Unlink case: We're in the middle! */
dvander@283
   745
	else {
dvander@283
   746
		/* Patch the forward reference */
dvander@283
   747
		m_Handles[pHandle->ch_next].ch_prev = pHandle->ch_prev;
dvander@283
   748
		/* Patch the backward reference */
dvander@283
   749
		m_Handles[pHandle->ch_prev].ch_next = pHandle->ch_next;
dvander@283
   750
	}
dvander@283
   751
dvander@283
   752
	/* Lastly, decrease the reference count */
dvander@283
   753
	pIdentity->refcount--;
dvander@283
   754
}
dvander@283
   755
dvander@222
   756
void HandleSystem::ReleasePrimHandle(unsigned int index)
dvander@222
   757
{
dvander@222
   758
	QHandle *pHandle = &m_Handles[index];
dvander@283
   759
	HandleSet set = pHandle->set;
dvander@283
   760
dvander@283
   761
	if (pHandle->owner && (set != HandleSet_Identity))
dvander@283
   762
	{
dvander@283
   763
		UnlinkHandleFromOwner(pHandle, index);
dvander@283
   764
	}
dvander@283
   765
dvander@283
   766
	/* Were we an identity ourself? */
dvander@283
   767
	QHandle *pLocal;
dvander@283
   768
	if (set == HandleSet_Identity)
dvander@283
   769
	{
dvander@283
   770
		/* Extra work to do.  We need to find everything connected to this identity and release it. */
dvander@351
   771
		unsigned int ch_index;
dvander@364
   772
#if defined _DEBUG
dvander@364
   773
		unsigned int old_index = 0;
dvander@364
   774
#endif
dvander@283
   775
		while ((ch_index = pHandle->ch_next) != 0)
dvander@283
   776
		{
dvander@283
   777
			pLocal = &m_Handles[ch_index];
dvander@283
   778
#if defined _DEBUG
dvander@283
   779
			assert(old_index != ch_index);
dvander@283
   780
			assert(pLocal->set == HandleSet_Used);
dvander@283
   781
			old_index = ch_index;
dvander@283
   782
#endif
dvander@283
   783
			FreeHandle(pLocal, ch_index);
dvander@283
   784
		}
dvander@283
   785
	}
dvander@283
   786
dvander@229
   787
	pHandle->set = HandleSet_None;
dvander@222
   788
	m_Types[pHandle->type].opened--;
dvander@222
   789
	m_Handles[++m_FreeHandles].freeID = index;
dvander@222
   790
}
dvander@222
   791
dvander@229
   792
bool HandleSystem::RemoveType(HandleType_t type, IdentityToken_t *ident)
dvander@218
   793
{
dvander@218
   794
	if (type == 0 || type >= HANDLESYS_TYPEARRAY_SIZE)
dvander@218
   795
	{
dvander@218
   796
		return false;
dvander@218
   797
	}
dvander@218
   798
dvander@218
   799
	QHandleType *pType = &m_Types[type];
dvander@218
   800
dvander@262
   801
	if (pType->typeSec.ident
dvander@262
   802
		&& pType->typeSec.ident != ident)
dvander@218
   803
	{
dvander@218
   804
		return false;
dvander@218
   805
	}
dvander@218
   806
dvander@218
   807
	if (pType->dispatch == NULL)
dvander@218
   808
	{
dvander@218
   809
		return false;
dvander@218
   810
	}
dvander@218
   811
dvander@218
   812
	/* Remove children if we have to */
dvander@218
   813
	if (!(type & HANDLESYS_SUBTYPE_MASK))
dvander@218
   814
	{
dvander@218
   815
		QHandleType *childType;
dvander@218
   816
		for (unsigned int i=1; i<=HANDLESYS_MAX_SUBTYPES; i++)
dvander@218
   817
		{
dvander@218
   818
			childType = &m_Types[type + i];
dvander@218
   819
			if (childType->dispatch)
dvander@218
   820
			{
dvander@262
   821
				RemoveType(type + i, childType->typeSec.ident);
dvander@218
   822
			}
dvander@218
   823
		}
dvander@218
   824
		/* Link us into the free chain */
dvander@218
   825
		m_Types[++m_FreeTypes].freeID = type;
dvander@218
   826
	}
dvander@218
   827
dvander@218
   828
	/* Invalidate the type now */
dvander@218
   829
	IHandleTypeDispatch *dispatch = pType->dispatch;
dvander@218
   830
	pType->dispatch = NULL;
dvander@218
   831
dvander@218
   832
	/* Make sure nothing is using this type. */
dvander@218
   833
	if (pType->opened)
dvander@218
   834
	{
dvander@218
   835
		QHandle *pHandle;
dvander@297
   836
		for (unsigned int i=1; i<=m_HandleTail; i++)
dvander@218
   837
		{
dvander@218
   838
			pHandle = &m_Handles[i];
dvander@218
   839
			if (!pHandle->set || pHandle->type != type)
dvander@218
   840
			{
dvander@218
   841
				continue;
dvander@218
   842
			}
dvander@222
   843
			if (pHandle->clone)
dvander@222
   844
			{
dvander@222
   845
				/* Get parent */
dvander@222
   846
				QHandle *pOther = &m_Handles[pHandle->clone];
dvander@222
   847
				if (--pOther->refcount == 0)
dvander@222
   848
				{
dvander@222
   849
					/* Free! */
dvander@222
   850
					dispatch->OnHandleDestroy(type, pOther->object);
dvander@222
   851
					ReleasePrimHandle(pHandle->clone);
dvander@222
   852
				}
dvander@222
   853
				/* Unlink ourselves since we don't have a reference count */
dvander@222
   854
				ReleasePrimHandle(i);
dvander@222
   855
			} else {
dvander@222
   856
				/* If it's not a clone, we still have to check the reference count.
dvander@222
   857
				 * Either way, we'll be destroyed eventually because the handle types do not change.
dvander@222
   858
				 */
dvander@222
   859
				if (--pHandle->refcount == 0)
dvander@222
   860
				{
dvander@222
   861
					/* Free! */
dvander@222
   862
					dispatch->OnHandleDestroy(type, pHandle->object);
dvander@222
   863
					ReleasePrimHandle(i);
dvander@222
   864
				}
dvander@222
   865
			}
dvander@222
   866
			if (pType->opened == 0)
dvander@218
   867
			{
dvander@218
   868
				break;
dvander@218
   869
			}
dvander@218
   870
		}
dvander@218
   871
	}
dvander@218
   872
dvander@218
   873
	return true;
dvander@218
   874
}
dvander@229
   875
dvander@262
   876
bool HandleSystem::InitAccessDefaults(TypeAccess *pTypeAccess, HandleAccess *pHandleAccess)
dvander@262
   877
{
dvander@262
   878
	if (pTypeAccess)
dvander@262
   879
	{
dvander@262
   880
		if (pTypeAccess->hsVersion > SMINTERFACE_HANDLESYSTEM_VERSION)
dvander@262
   881
		{
dvander@262
   882
			return false;
dvander@262
   883
		}
dvander@262
   884
		pTypeAccess->access[HTypeAccess_Create] = false;
dvander@262
   885
		pTypeAccess->access[HTypeAccess_Inherit] = false;
dvander@262
   886
		pTypeAccess->ident = NULL;
dvander@262
   887
	}
dvander@262
   888
dvander@262
   889
	if (pHandleAccess)
dvander@262
   890
	{
dvander@262
   891
		if (pHandleAccess->hsVersion > SMINTERFACE_HANDLESYSTEM_VERSION)
dvander@262
   892
		{
dvander@262
   893
			return false;
dvander@262
   894
		}
dvander@262
   895
dvander@262
   896
		pHandleAccess->access[HandleAccess_Clone] = 0;
dvander@262
   897
		pHandleAccess->access[HandleAccess_Delete] = HANDLE_RESTRICT_OWNER;
dvander@262
   898
		pHandleAccess->access[HandleAccess_Read] = HANDLE_RESTRICT_IDENTITY;
dvander@262
   899
	}
dvander@262
   900
dvander@262
   901
	return true;
dvander@262
   902
}
dvander@900
   903
dvander@900
   904
void HandleSystem::Dump(FILE *fp)
dvander@900
   905
{
dvander@900
   906
	fprintf(fp, "%-10.10s\t%-20.20s\t%-20.20s\n", "Handle", "Owner", "Type");
dvander@900
   907
	fprintf(fp, "---------------------------------------------\n");
dvander@900
   908
	for (unsigned int i=1; i<=m_HandleTail; i++)
dvander@900
   909
	{
dvander@900
   910
		if (m_Handles[i].set == HandleSet_Freed
dvander@900
   911
			|| m_Handles[i].set == HandleSet_Identity)
dvander@900
   912
		{
dvander@900
   913
			continue;
dvander@900
   914
		}
dvander@900
   915
		/* Get the index */
dvander@900
   916
		unsigned int index = (m_Handles[i].serial << 16) | i;
dvander@900
   917
		/* Determine the owner */
dvander@900
   918
		const char *owner = "UNKNOWN";
dvander@900
   919
		if (m_Handles[i].owner)
dvander@900
   920
		{
dvander@900
   921
			IdentityToken_t *pOwner = m_Handles[i].owner;
dvander@900
   922
			if (pOwner == g_pCoreIdent)
dvander@900
   923
			{
dvander@900
   924
				owner = "CORE";
dvander@900
   925
			} else if (pOwner == g_PluginSys.GetIdentity()) {
dvander@900
   926
				owner = "PLUGINSYS";
dvander@900
   927
			} else {
dvander@900
   928
				CExtension *ext = g_Extensions.GetExtensionFromIdent(pOwner);
dvander@900
   929
				if (ext)
dvander@900
   930
				{
dvander@900
   931
					owner = ext->GetFilename();
dvander@900
   932
				} else {
dvander@900
   933
					CPlugin *pPlugin = g_PluginSys.GetPluginFromIdentity(pOwner);
dvander@900
   934
					if (pPlugin)
dvander@900
   935
					{
dvander@900
   936
						owner = pPlugin->GetFilename();
dvander@900
   937
					}
dvander@900
   938
				}
dvander@900
   939
			}
dvander@900
   940
		} else {
dvander@900
   941
			owner = "NONE";
dvander@900
   942
		}
dvander@900
   943
		const char *type = "ANON";
dvander@900
   944
		QHandleType *pType = &m_Types[m_Handles[i].type];
dvander@900
   945
		if (pType->nameIdx != -1)
dvander@900
   946
		{
dvander@900
   947
			type = m_strtab->GetString(pType->nameIdx);
dvander@900
   948
		}
dvander@900
   949
		fprintf(fp, "0x%08x\t%-20.20s\t%-20.20s\n", index, owner, type);
dvander@900
   950
	}
dvander@900
   951
}