X-Git-Url: https://git.saurik.com/apple/security.git/blobdiff_plain/5dd5f9ec28f304ca377c42fd7f711d6cf12b90e1..5c19dc3ae3bd8e40a9c028b0deddd50ff337692c:/OSX/libsecurity_cdsa_utilities/lib/callback.h diff --git a/OSX/libsecurity_cdsa_utilities/lib/callback.h b/OSX/libsecurity_cdsa_utilities/lib/callback.h new file mode 100644 index 00000000..05695891 --- /dev/null +++ b/OSX/libsecurity_cdsa_utilities/lib/callback.h @@ -0,0 +1,113 @@ +/* + * Copyright (c) 2000-2001,2003-2004,2006,2011-2012,2014 Apple Inc. All Rights Reserved. + * + * @APPLE_LICENSE_HEADER_START@ + * + * This file contains Original Code and/or Modifications of Original Code + * as defined in and that are subject to the Apple Public Source License + * Version 2.0 (the 'License'). You may not use this file except in + * compliance with the License. Please obtain a copy of the License at + * http://www.opensource.apple.com/apsl/ and read it before using this + * file. + * + * The Original Code and all software distributed under the License are + * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER + * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES, + * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. + * Please see the License for the specific language governing rights and + * limitations under the License. + * + * @APPLE_LICENSE_HEADER_END@ + */ + + +// +// Encapsulate the callback mechanism of CSSM. +// +#ifndef _H_CALLBACK +#define _H_CALLBACK + +#include +#include +#include +#include + +namespace Security +{ + +// +// A single module-specific callback as requested by the user. +// +class ModuleCallback { +public: + ModuleCallback() : mCallback(0), mContext(0) { } + ModuleCallback(CSSM_API_ModuleEventHandler callback, void *context) + : mCallback(callback), mContext(context) { } + + void operator () (CSSM_MODULE_EVENT event, + const Guid &guid, uint32 subId, + CSSM_SERVICE_TYPE serviceType) const; + + operator bool () const { return mCallback || mContext; } + bool operator ! () const { return !bool(*this); } + + bool operator == (const ModuleCallback &cb) const + { return mCallback == cb.mCallback && mContext == cb.mContext; } + bool operator < (const ModuleCallback &cb) const + { return mCallback < cb.mCallback + || (mCallback == cb.mCallback && mContext < cb.mContext); } + +private: + CSSM_API_ModuleEventHandler mCallback; + void *mContext; +}; + + +// +// A set of callbacks that can be invoked automatically in a thread-safe manner. +// THREADS: The set itself is not interlocked by the ModuleCallbackSet class; you +// are responsible for ensuring single access to the set object. The class ensures +// that any threads it spawns to execute the callbacks will not step on each other +// or on you, and that you will not be able to erase() a callback while it has +// activity scheduled against it. This also applies to the invocation method +// (operator ()) - you must lock against multiple accesses to it until it returns. +// +class ModuleCallbackSet { +public: + unsigned int size() const { return (int)callbacks.size(); } + void insert(const ModuleCallback &newCallback); + void erase(const ModuleCallback &oldCallback); + + void operator () (CSSM_MODULE_EVENT event, + const Guid &guid, uint32 subId, + CSSM_SERVICE_TYPE serviceType) const; + +private: + // note mutex *: we don't want to rely on copy-ability of Mutex objects + typedef multimap CallbackMap; + mutable CallbackMap callbacks; + + struct Runner : public Thread { + Runner(CallbackMap &inCallbacks, + CSSM_MODULE_EVENT inEvent, + const Guid &inGuid, + uint32 inSSId, + CSSM_SERVICE_TYPE inServiceType) + : callbacks(inCallbacks), event(inEvent), guid(inGuid), + subserviceId(inSSId), serviceType(inServiceType) { } + + CallbackMap callbacks; // note that we share the CountingMutex * values! + const CSSM_MODULE_EVENT event; + const Guid guid; + const uint32 subserviceId; + const CSSM_SERVICE_TYPE serviceType; + + void action(); + }; +}; + +} // end namespace Security + + +#endif //_H_CALLBACK