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