Loading...
Searching...
No Matches
ocsd_lib_dcd_register.h
Go to the documentation of this file.
/*
* \file ocsd_lib_dcd_register.h
* \brief OpenCSD : Library decoder registration and management.
*
* \copyright Copyright (c) 2016, ARM Limited. All Rights Reserved.
*/
#ifndef ARM_OCSD_LIB_DCD_REGISTER_H_INCLUDED
#define ARM_OCSD_LIB_DCD_REGISTER_H_INCLUDED
/*
* Redistribution and use in source and binary forms, with or without modification,
* are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* 3. Neither the name of the copyright holder nor the names of its contributors
* may be used to endorse or promote products derived from this software without
* specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 'AS IS' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
* IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
* INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#include <map>
#include "opencsd/ocsd_if_types.h"
#include "common/ocsd_dcd_mngr_i.h"
class OcsdLibDcdRegister
{
public:
static OcsdLibDcdRegister *getDecoderRegister();
static void deregisterAllDecoders();
static const ocsd_trace_protocol_t getNextCustomProtocolID();
static void releaseLastCustomProtocolID();
const ocsd_err_t registerDecoderTypeByName(const std::string &name, IDecoderMngr *p_decoder_fact);
const ocsd_err_t getDecoderMngrByName(const std::string &name, IDecoderMngr **p_decoder_mngr);
const ocsd_err_t getDecoderMngrByType(const ocsd_trace_protocol_t decoderType, IDecoderMngr **p_decoder_mngr);
const bool isRegisteredDecoder(const std::string &name);
const bool getFirstNamedDecoder(std::string &name);
const bool getNextNamedDecoder(std::string &name);
const bool isRegisteredDecoderType(const ocsd_trace_protocol_t decoderType);
private:
void registerBuiltInDecoders();
void deRegisterCustomDecoders();
std::map<const std::string, IDecoderMngr *> m_decoder_mngrs;
std::map<const std::string, IDecoderMngr *>::const_iterator m_iter;
std::map<const ocsd_trace_protocol_t, IDecoderMngr *> m_typed_decoder_mngrs;
// cache last found by type to speed up repeated quries on same object.
IDecoderMngr *m_pLastTypedDecoderMngr;
// singleton pattern - need just one of these in the library - ensure all default constructors are private.
OcsdLibDcdRegister();
OcsdLibDcdRegister(OcsdLibDcdRegister const &) {};
OcsdLibDcdRegister& operator=(OcsdLibDcdRegister const &){ return *this; };
~OcsdLibDcdRegister();
static OcsdLibDcdRegister *m_p_libMngr;
static bool m_b_registeredBuiltins;
static ocsd_trace_protocol_t m_nextCustomProtocolID;
};
typedef IDecoderMngr *(*CreateMngr)(const std::string &name);
template <typename T> IDecoderMngr *createManagerInst(const std::string &name)
{
return new (std::nothrow)T(name);
}
typedef struct built_in_decoder_info {
IDecoderMngr *pMngr;
CreateMngr PFn;
const char *name;
} built_in_decoder_info_t;
#define CREATE_BUILTIN_ENTRY(C,N) { 0, createManagerInst<C>, N }
#endif // ARM_OCSD_LIB_DCD_REGISTER_H_INCLUDED
/* End of File ocsd_lib_dcd_register.h */
IDecoderMngr
Definition ocsd_dcd_mngr_i.h:50
OcsdLibDcdRegister
Definition ocsd_lib_dcd_register.h:55
OcsdLibDcdRegister::isRegisteredDecoder
const bool isRegisteredDecoder(const std::string &name)
OcsdLibDcdRegister::getDecoderMngrByType
const ocsd_err_t getDecoderMngrByType(const ocsd_trace_protocol_t decoderType, IDecoderMngr **p_decoder_mngr)
OcsdLibDcdRegister::registerDecoderTypeByName
const ocsd_err_t registerDecoderTypeByName(const std::string &name, IDecoderMngr *p_decoder_fact)
register a decoder manager interface
OcsdLibDcdRegister::getDecoderRegister
static OcsdLibDcdRegister * getDecoderRegister()
OcsdLibDcdRegister::isRegisteredDecoderType
const bool isRegisteredDecoderType(const ocsd_trace_protocol_t decoderType)
OcsdLibDcdRegister::getDecoderMngrByName
const ocsd_err_t getDecoderMngrByName(const std::string &name, IDecoderMngr **p_decoder_mngr)
OcsdLibDcdRegister::getNextCustomProtocolID
static const ocsd_trace_protocol_t getNextCustomProtocolID()
OcsdLibDcdRegister::releaseLastCustomProtocolID
static void releaseLastCustomProtocolID()
OcsdLibDcdRegister::getNextNamedDecoder
const bool getNextNamedDecoder(std::string &name)
OcsdLibDcdRegister::getFirstNamedDecoder
const bool getFirstNamedDecoder(std::string &name)
OcsdLibDcdRegister::deregisterAllDecoders
static void deregisterAllDecoders()
library cleanup - deregisters decoder managers and destroys the register object.
ocsd_trace_protocol_t
enum _ocsd_trace_protocol_t ocsd_trace_protocol_t
ocsd_err_t
enum _ocsd_err_t ocsd_err_t
ocsd_dcd_mngr_i.h
ocsd_if_types.h
OpenCSD : Standard Types used in the library interfaces.
built_in_decoder_info_t
struct built_in_decoder_info built_in_decoder_info_t
createManagerInst
IDecoderMngr * createManagerInst(const std::string &name)
Definition ocsd_lib_dcd_register.h:112
CreateMngr
IDecoderMngr *(* CreateMngr)(const std::string &name)
Definition ocsd_lib_dcd_register.h:103
built_in_decoder_info
Definition ocsd_lib_dcd_register.h:120
built_in_decoder_info::pMngr
IDecoderMngr * pMngr
pointer to created decoder manager
Definition ocsd_lib_dcd_register.h:121
built_in_decoder_info::name
const char * name
registered name of the decoder.
Definition ocsd_lib_dcd_register.h:123
built_in_decoder_info::PFn
CreateMngr PFn
function to create the decoder manager.
Definition ocsd_lib_dcd_register.h:122