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