1 /*! 2 * \file trc_error_log_i.h 3 * \brief OpenCSD : 4 * 5 * \copyright Copyright (c) 2015, ARM Limited. All Rights Reserved. 6 */ 7 8 9 /* 10 * Redistribution and use in source and binary forms, with or without modification, 11 * are permitted provided that the following conditions are met: 12 * 13 * 1. Redistributions of source code must retain the above copyright notice, 14 * this list of conditions and the following disclaimer. 15 * 16 * 2. Redistributions in binary form must reproduce the above copyright notice, 17 * this list of conditions and the following disclaimer in the documentation 18 * and/or other materials provided with the distribution. 19 * 20 * 3. Neither the name of the copyright holder nor the names of its contributors 21 * may be used to endorse or promote products derived from this software without 22 * specific prior written permission. 23 * 24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 'AS IS' AND 25 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 26 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 27 * IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 28 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 29 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 30 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND 31 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 32 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 33 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 34 */ 35 36 #ifndef ARM_TRC_ERROR_LOG_I_H_INCLUDED 37 #define ARM_TRC_ERROR_LOG_I_H_INCLUDED 38 39 #include "opencsd/ocsd_if_types.h" 40 #include <string> 41 42 class ocsdError; 43 class ocsdMsgLogger; 44 45 /*! 46 * @class ITraceErrorLog 47 * @brief Error logging interface. 48 * @ingroup ocsd_interfaces 49 * 50 * This class provides a standard interface to the decoder error logger for all trace decode and 51 * reader components. 52 * 53 * Implementation will determine if and how the errors and messages are logged. 54 * 55 */ 56 class ITraceErrorLog 57 { 58 public: ITraceErrorLog()59 ITraceErrorLog() {}; ~ITraceErrorLog()60 virtual ~ITraceErrorLog() {}; 61 62 /*! 63 * Register a named component error source. Allows the logger to associate errors with components. 64 * returned handle to be used with subsequent error log calls. 65 * 66 * @param &component_name : name of the component. 67 * 68 * @return virtual const : Handle associated with the component. 69 */ 70 virtual const ocsd_hndl_err_log_t RegisterErrorSource(const std::string &component_name) = 0; 71 72 /*! 73 * Return the verbosity level of the logger. Errors of the returned ocsd_err_severity_t severity 74 * or lower will be logged, others are ignored. 75 * 76 * @return ocsd_err_severity_t : Current logging severity level. 77 */ 78 virtual const ocsd_err_severity_t GetErrorLogVerbosity() const = 0; 79 80 /*! 81 * Log an error. 82 * Pass an error object and the component or generic handle to associate with the error. 83 * Error will be saved for access by GetLastError(). 84 * 85 * If logger implementation has output print logging enabled then this may be printed to file or screen. 86 * 87 * @param handle : Component handle or standard generic handle 88 * @param *Error : Pointer to an error object. 89 */ 90 virtual void LogError(const ocsd_hndl_err_log_t handle, const ocsdError *Error) = 0; 91 92 /*! 93 * Log a general message. Associated with component or use generic handle. 94 * Message logged to same output as errors if output enabled, but not saved for GetLastError() 95 * 96 * @param handle : Component handle or standard generic handle. 97 * @param filter_level : Verbosity filter. 98 * @param msg : Pointer to an error object. 99 */ 100 virtual void LogMessage(const ocsd_hndl_err_log_t handle, const ocsd_err_severity_t filter_level, const std::string &msg ) = 0; 101 102 /*! 103 * Get a pointer to the last logged error. 104 * Returns 0 if no errors have been logged. 105 * 106 * @return ocsdError *: last error pointer. 107 */ 108 virtual ocsdError *GetLastError() = 0; 109 110 /*! 111 * Get the last error associated with the given Trace source channel ID. 112 * returns a pointer to the error or 0 if no errors associated with the ID. 113 * 114 * @param chan_id : Trace Source Channel ID (CoreSight Trace ID). 115 * 116 * @return ocsdError *: last error pointer for ID or 0. 117 */ 118 virtual ocsdError *GetLastIDError(const uint8_t chan_id) = 0; 119 120 virtual ocsdMsgLogger *getOutputLogger() = 0; 121 virtual void setOutputLogger(ocsdMsgLogger *pLogger) = 0; 122 123 enum generic_handles { 124 HANDLE_GEN_ERR = 0, 125 HANDLE_GEN_WARN, 126 HANDLE_GEN_INFO, 127 /* last value in list */ 128 HANDLE_FIRST_REGISTERED_COMPONENT /**< 1st valid handle value for components registered with logger */ 129 }; 130 }; 131 132 #endif // ARM_TRC_ERROR_LOG_I_H_INCLUDED 133 134 /* End of File trc_error_log_i.h */ 135