dvander@370: /**
ds@653: * vim: set ts=4 :
ds@1330: * =============================================================================
dvander@1231: * SourceMod
ds@1947: * Copyright (C) 2004-2008 AlliedModders LLC. All rights reserved.
ds@1330: * =============================================================================
dvander@370: *
ds@1330: * This program is free software; you can redistribute it and/or modify it under
ds@1330: * the terms of the GNU General Public License, version 3.0, as published by the
ds@1330: * Free Software Foundation.
dvander@1231: *
ds@1330: * This program is distributed in the hope that it will be useful, but WITHOUT
ds@1330: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
ds@1330: * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
ds@1330: * details.
dvander@1231: *
ds@1330: * You should have received a copy of the GNU General Public License along with
ds@1330: * this program. If not, see .
dvander@1231: *
ds@1330: * As a special exception, AlliedModders LLC gives you permission to link the
ds@1330: * code of this program (as well as its derivative works) to "Half-Life 2," the
ds@1330: * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
ds@1330: * by the Valve Corporation. You must obey the GNU General Public License in
ds@1330: * all respects for all other code used. Additionally, AlliedModders LLC grants
ds@1330: * this exception to all derivative works. AlliedModders LLC defines further
ds@1330: * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
ds@1330: * or .
dvander@370: *
dvander@370: * Version: $Id$
dvander@370: */
dvander@370:
dvander@218: #ifndef _INCLUDE_SOURCEMOD_HANDLESYSTEM_H_
dvander@218: #define _INCLUDE_SOURCEMOD_HANDLESYSTEM_H_
dvander@218:
dvander@218: #include
dvander@900: #include
dvander@218: #include "sm_globals.h"
dvander@218: #include "sm_trie.h"
dvander@218: #include "sourcemod.h"
dvander@218: #include "sm_memtable.h"
dvander@218:
dvander@222: #define HANDLESYS_MAX_HANDLES (1<<14)
dvander@218: #define HANDLESYS_MAX_TYPES (1<<9)
dvander@218: #define HANDLESYS_MAX_SUBTYPES 0xF
dvander@218: #define HANDLESYS_SUBTYPE_MASK 0xF
dvander@218: #define HANDLESYS_TYPEARRAY_SIZE (HANDLESYS_MAX_TYPES * (HANDLESYS_MAX_SUBTYPES + 1))
dvander@218: #define HANDLESYS_MAX_SERIALS 0xFFFF
dvander@218: #define HANDLESYS_SERIAL_MASK 0xFFFF0000
dvander@218: #define HANDLESYS_HANDLE_MASK 0x0000FFFF
dvander@218:
dvander@1766: #define HANDLESYS_MEMUSAGE_MIN_VERSION 3
dvander@1766:
dvander@229: /**
dvander@229: * The QHandle is a nasty structure that compacts the handle system into a big vector.
dvander@229: * The members of the vector each encapsulate one Handle, however, they also act as nodes
dvander@229: * in an inlined linked list and an inlined vector.
dvander@229: *
dvander@229: * The first of these lists is the 'freeID' list. Each node from 1 to N (where N
dvander@229: * is the number of free nodes) has a 'freeID' that specifies a free Handle ID. This
dvander@229: * is a quick hack to get around allocating a second base vector.
dvander@229: *
dvander@229: * The second vector is the identity linked list. An identity has its own handle, so
dvander@229: * these handles are used as sentinel nodes for index linking. They point to the first and last
ds@487: * index into the handle array. Each subsequent Handle who is owned by that identity is mapped into
dvander@229: * that list. This lets owning identities be unloaded in O(n) time.
dvander@229: *
dvander@229: * Eventually, there may be a third list for type chains.
dvander@229: */
dvander@229:
dvander@229: enum HandleSet
dvander@229: {
dvander@229: HandleSet_None = 0,
dvander@259: HandleSet_Used, /* The Handle is in use */
dvander@259: HandleSet_Freed, /* The "master" Handle of a clone chain is freed */
dvander@259: HandleSet_Identity, /* The Handle is a special identity */
dvander@229: };
dvander@229:
dvander@218: struct QHandle
dvander@218: {
dvander@222: HandleType_t type; /* Handle type */
dvander@222: void *object; /* Unmaintained object pointer */
dvander@229: IdentityToken_t *owner; /* Identity of object which owns this */
dvander@222: unsigned int serial; /* Serial no. for sanity checking */
dvander@222: unsigned int refcount; /* Reference count for safe destruction */
dvander@262: unsigned int clone; /* If non-zero, this is our cloned parent index */
dvander@229: HandleSet set; /* Information about the handle's state */
dvander@528: bool access_special; /* Whether or not access rules are special or type-derived */
dvander@789: bool is_destroying; /* Whether or not the handle is being destroyed */
dvander@528: HandleAccess sec; /* Security rules */
dvander@229: /* The following variables are unrelated to the Handle array, and used
dvander@229: * as an inlined chain of information */
dvander@229: unsigned int freeID; /* ID of a free handle in the free handle chain */
dvander@229: /* Indexes into the handle array for owner membership.
dvander@229: * For identity roots, these are treated as the head/tail. */
dvander@283: unsigned int ch_prev; /* chained previous handle */
dvander@283: unsigned int ch_next; /* chained next handle */
dvander@218: };
dvander@218:
dvander@218: struct QHandleType
dvander@218: {
dvander@218: IHandleTypeDispatch *dispatch;
dvander@218: unsigned int freeID;
dvander@218: unsigned int children;
dvander@262: TypeAccess typeSec;
dvander@262: HandleAccess hndlSec;
dvander@218: unsigned int opened;
dvander@218: int nameIdx;
dvander@218: };
dvander@218:
dvander@1687: typedef void (HANDLE_REPORTER)(const char *str, ...);
dvander@1687:
dvander@218: class HandleSystem :
dvander@218: public IHandleSys
dvander@218: {
dvander@229: friend HandleError IdentityHandle(IdentityToken_t *token, unsigned int *index);
dvander@229: friend class ShareSystem;
dvander@218: public:
dvander@218: HandleSystem();
dvander@218: ~HandleSystem();
dvander@218: public: //IHandleSystem
dvander@262:
dvander@262: HandleType_t CreateType(const char *name,
dvander@262: IHandleTypeDispatch *dispatch,
dvander@262: HandleType_t parent,
dvander@262: const TypeAccess *typeAccess,
dvander@262: const HandleAccess *hndlAccess,
dvander@262: IdentityToken_t *ident,
dvander@262: HandleError *err);
dvander@262:
dvander@229: bool RemoveType(HandleType_t type, IdentityToken_t *ident);
dvander@262:
dvander@218: bool FindHandleType(const char *name, HandleType_t *type);
dvander@262:
dvander@218: Handle_t CreateHandle(HandleType_t type,
dvander@262: void *object,
dvander@262: IdentityToken_t *owner,
dvander@262: IdentityToken_t *ident,
dvander@262: HandleError *err);
dvander@283:
dvander@262: HandleError FreeHandle(Handle_t handle, const HandleSecurity *pSecurity);
dvander@262:
dvander@262: HandleError CloneHandle(Handle_t handle,
dvander@262: Handle_t *newhandle,
dvander@262: IdentityToken_t *newOwner,
dvander@262: const HandleSecurity *pSecurity);
dvander@262:
dvander@262: HandleError ReadHandle(Handle_t handle,
dvander@262: HandleType_t type,
dvander@262: const HandleSecurity *pSecurity,
dvander@262: void **object);
dvander@262:
dvander@262: bool InitAccessDefaults(TypeAccess *pTypeAccess, HandleAccess *pHandleAccess);
dvander@262:
dvander@229: bool TypeCheck(HandleType_t intype, HandleType_t outtype);
dvander@528:
dvander@528: virtual Handle_t CreateHandleEx(HandleType_t type,
dvander@528: void *object,
dvander@528: const HandleSecurity *pSec,
dvander@528: const HandleAccess *pAccess,
dvander@528: HandleError *err);
dvander@900:
dvander@1687: void Dump(HANDLE_REPORTER rep);
dvander@2959:
dvander@2959: /* Bypasses security checks. */
dvander@2959: Handle_t FastCloneHandle(Handle_t hndl);
dvander@229: protected:
dvander@222: /**
dvander@222: * Decodes a handle with sanity and security checking.
dvander@222: */
dvander@222: HandleError GetHandle(Handle_t handle,
dvander@229: IdentityToken_t *ident,
dvander@222: QHandle **pHandle,
dvander@222: unsigned int *index,
dvander@259: bool ignoreFree=false);
dvander@222:
dvander@2959: Handle_t FastCloneHandle(QHandle *pHandle, unsigned int index);
dvander@2959: void GetHandleUnchecked(Handle_t hndl, QHandle *& pHandle, unsigned int &index);
dvander@2959:
dvander@222: /**
dvander@222: * Creates a basic handle and sets its reference count to 1.
dvander@222: * Does not do any type or security checking.
dvander@222: */
dvander@229: HandleError MakePrimHandle(HandleType_t type,
dvander@229: QHandle **pHandle,
dvander@229: unsigned int *index,
dvander@229: HandleType_t *handle,
dvander@283: IdentityToken_t *owner,
dvander@283: bool identity=false);
dvander@222:
dvander@222: /**
ds@729: * Frees a primitive handle. Does no object freeing, only reference count, bookkeeping,
dvander@229: * and linked list maintenance.
dvander@283: * If used on an Identity handle, destroys all Handles under that identity.
dvander@222: */
dvander@222: void ReleasePrimHandle(unsigned int index);
dvander@229:
dvander@229: /**
dvander@283: * Sets the security owner of a type.
dvander@229: */
dvander@229: void SetTypeSecurityOwner(HandleType_t type, IdentityToken_t *pToken);
dvander@229:
dvander@283: /**
dvander@283: * Helper function to check access rights.
dvander@229: */
dvander@283: bool CheckAccess(QHandle *pHandle, HandleAccessRight right, const HandleSecurity *pSecurity);
dvander@262:
dvander@283: /**
dvander@283: * Some wrappers for internal functions, so we can pass indexes instead of encoded handles.
dvander@283: */
dvander@283: HandleError FreeHandle(QHandle *pHandle, unsigned int index);
dvander@283: void UnlinkHandleFromOwner(QHandle *pHandle, unsigned int index);
dvander@283: HandleError CloneHandle(QHandle *pHandle, unsigned int index, Handle_t *newhandle, IdentityToken_t *newOwner);
dvander@528: Handle_t CreateHandleInt(HandleType_t type, void *object, const HandleSecurity *pSec, HandleError *err, const HandleAccess *pAccess, bool identity);
dvander@1638:
dvander@1638: bool TryAndFreeSomeHandles();
dvander@1638: HandleError TryAllocHandle(unsigned int *handle);
dvander@222: private:
dvander@218: QHandle *m_Handles;
dvander@218: QHandleType *m_Types;
dvander@218: Trie *m_TypeLookup;
dvander@218: unsigned int m_TypeTail;
dvander@218: unsigned int m_FreeTypes;
dvander@218: unsigned int m_HandleTail;
dvander@218: unsigned int m_FreeHandles;
dvander@218: unsigned int m_HSerial;
dvander@218: BaseStringTable *m_strtab;
dvander@218: };
dvander@218:
dvander@218: extern HandleSystem g_HandleSys;
dvander@218:
dvander@2959: struct AutoHandleRooter
dvander@2959: {
dvander@2959: public:
dvander@2959: AutoHandleRooter(Handle_t hndl)
dvander@2959: {
dvander@2959: if (hndl != BAD_HANDLE)
dvander@2959: this->hndl = g_HandleSys.FastCloneHandle(hndl);
dvander@2959: else
dvander@2959: this->hndl = BAD_HANDLE;
dvander@2959: }
dvander@2959:
dvander@2959: ~AutoHandleRooter()
dvander@2959: {
dvander@2959: if (hndl != BAD_HANDLE)
dvander@2959: {
dvander@2959: HandleSecurity sec(g_pCoreIdent, g_pCoreIdent);
dvander@2959: g_HandleSys.FreeHandle(hndl, &sec);
dvander@2959: }
dvander@2959: }
dvander@2959: private:
dvander@2959: Handle_t hndl;
dvander@2959: };
dvander@2959:
dvander@218: #endif //_INCLUDE_SOURCEMOD_HANDLESYSTEM_H_