1*c120c564SAndrew Turner /*! 2*c120c564SAndrew Turner * \file ocsd_error_logger.h 3*c120c564SAndrew Turner * \brief OpenCSD : Library error logger. 4*c120c564SAndrew Turner * 5*c120c564SAndrew Turner * \copyright Copyright (c) 2015, ARM Limited. All Rights Reserved. 6*c120c564SAndrew Turner */ 7*c120c564SAndrew Turner 8*c120c564SAndrew Turner /* 9*c120c564SAndrew Turner * Redistribution and use in source and binary forms, with or without modification, 10*c120c564SAndrew Turner * are permitted provided that the following conditions are met: 11*c120c564SAndrew Turner * 12*c120c564SAndrew Turner * 1. Redistributions of source code must retain the above copyright notice, 13*c120c564SAndrew Turner * this list of conditions and the following disclaimer. 14*c120c564SAndrew Turner * 15*c120c564SAndrew Turner * 2. Redistributions in binary form must reproduce the above copyright notice, 16*c120c564SAndrew Turner * this list of conditions and the following disclaimer in the documentation 17*c120c564SAndrew Turner * and/or other materials provided with the distribution. 18*c120c564SAndrew Turner * 19*c120c564SAndrew Turner * 3. Neither the name of the copyright holder nor the names of its contributors 20*c120c564SAndrew Turner * may be used to endorse or promote products derived from this software without 21*c120c564SAndrew Turner * specific prior written permission. 22*c120c564SAndrew Turner * 23*c120c564SAndrew Turner * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 'AS IS' AND 24*c120c564SAndrew Turner * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 25*c120c564SAndrew Turner * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 26*c120c564SAndrew Turner * IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 27*c120c564SAndrew Turner * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 28*c120c564SAndrew Turner * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 29*c120c564SAndrew Turner * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND 30*c120c564SAndrew Turner * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 31*c120c564SAndrew Turner * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 32*c120c564SAndrew Turner * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 33*c120c564SAndrew Turner */ 34*c120c564SAndrew Turner 35*c120c564SAndrew Turner #ifndef ARM_OCSD_ERROR_LOGGER_H_INCLUDED 36*c120c564SAndrew Turner #define ARM_OCSD_ERROR_LOGGER_H_INCLUDED 37*c120c564SAndrew Turner 38*c120c564SAndrew Turner #include <string> 39*c120c564SAndrew Turner #include <vector> 40*c120c564SAndrew Turner //#include <fstream> 41*c120c564SAndrew Turner 42*c120c564SAndrew Turner #include "interfaces/trc_error_log_i.h" 43*c120c564SAndrew Turner #include "ocsd_error.h" 44*c120c564SAndrew Turner #include "ocsd_msg_logger.h" 45*c120c564SAndrew Turner 46*c120c564SAndrew Turner class ocsdDefaultErrorLogger : public ITraceErrorLog 47*c120c564SAndrew Turner { 48*c120c564SAndrew Turner public: 49*c120c564SAndrew Turner ocsdDefaultErrorLogger(); 50*c120c564SAndrew Turner virtual ~ocsdDefaultErrorLogger(); 51*c120c564SAndrew Turner 52*c120c564SAndrew Turner bool initErrorLogger(const ocsd_err_severity_t verbosity, bool bCreateOutputLogger = false); //!< Initialise the error logger with a severity filter, optionally create an output logger on stderr. 53*c120c564SAndrew Turner getOutputLogger()54*c120c564SAndrew Turner virtual ocsdMsgLogger *getOutputLogger() { return m_output_logger; }; 55*c120c564SAndrew Turner virtual void setOutputLogger(ocsdMsgLogger *pLogger); 56*c120c564SAndrew Turner 57*c120c564SAndrew Turner virtual const ocsd_hndl_err_log_t RegisterErrorSource(const std::string &component_name); 58*c120c564SAndrew Turner 59*c120c564SAndrew Turner virtual void LogError(const ocsd_hndl_err_log_t handle, const ocsdError *Error); 60*c120c564SAndrew Turner virtual void LogMessage(const ocsd_hndl_err_log_t handle, const ocsd_err_severity_t filter_level, const std::string &msg ); 61*c120c564SAndrew Turner GetErrorLogVerbosity()62*c120c564SAndrew Turner virtual const ocsd_err_severity_t GetErrorLogVerbosity() const { return m_Verbosity; }; 63*c120c564SAndrew Turner GetLastError()64*c120c564SAndrew Turner virtual ocsdError *GetLastError() { return m_lastErr; }; GetLastIDError(const uint8_t chan_id)65*c120c564SAndrew Turner virtual ocsdError *GetLastIDError(const uint8_t chan_id) 66*c120c564SAndrew Turner { 67*c120c564SAndrew Turner if(OCSD_IS_VALID_CS_SRC_ID(chan_id)) 68*c120c564SAndrew Turner return m_lastErrID[chan_id]; 69*c120c564SAndrew Turner return 0; 70*c120c564SAndrew Turner }; 71*c120c564SAndrew Turner 72*c120c564SAndrew Turner private: 73*c120c564SAndrew Turner void CreateErrorObj(ocsdError **ppErr, const ocsdError *p_from); 74*c120c564SAndrew Turner 75*c120c564SAndrew Turner ocsdError *m_lastErr; 76*c120c564SAndrew Turner ocsdError *m_lastErrID[0x80]; 77*c120c564SAndrew Turner 78*c120c564SAndrew Turner ocsd_err_severity_t m_Verbosity; 79*c120c564SAndrew Turner 80*c120c564SAndrew Turner ocsdMsgLogger *m_output_logger; // pointer to a standard message output logger; 81*c120c564SAndrew Turner bool m_created_output_logger; // true if this class created it's own logger; 82*c120c564SAndrew Turner 83*c120c564SAndrew Turner std::vector<std::string> m_error_sources; 84*c120c564SAndrew Turner }; 85*c120c564SAndrew Turner 86*c120c564SAndrew Turner 87*c120c564SAndrew Turner #endif // ARM_OCSD_ERROR_LOGGER_H_INCLUDED 88*c120c564SAndrew Turner 89*c120c564SAndrew Turner /* End of File ocsd_error_logger.h */ 90