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