ub_logging.h

Go to the documentation of this file.

/*
 * Copyright (c) 2023 Texas Instruments Incorporated
 * Copyright (c) 2023 Excelfore Corporation (https://excelfore.com)
 *
 * All rights reserved not granted herein.
 * Limited License.
 *
 * Texas Instruments Incorporated grants a world-wide, royalty-free,
 * non-exclusive license under copyrights and patents it now or hereafter
 * owns or controls to make, have made, use, import, offer to sell and sell ("Utilize")
 * this software subject to the terms herein. With respect to the foregoing patent
 * license, such license is granted solely to the extent that any such patent is necessary
 * to Utilize the software alone. The patent license shall not apply to any combinations which
 * include this software, other than combinations with devices manufactured by or for TI ("TI Devices").
 * No hardware patent is licensed hereunder.
 *
 * Redistributions must preserve existing copyright notices and reproduce this license (including the
 * above copyright notice and the disclaimer and (if applicable) source code license limitations below)
 * in the documentation and/or other materials provided with the distribution
 *
 * Redistribution and use in binary form, without modification, are permitted provided that the following
 * conditions are met:
 *
 * * No reverse engineering, decompilation, or disassembly of this software is permitted with respect to any
 * software provided in binary form.
 * * any redistribution and use are licensed by TI for use only with TI Devices.
 * * Nothing shall obligate TI to provide you with source code for the software licensed and provided to you in object code.
 *
 * If software source code is provided to you, modification and redistribution of the source code are permitted
 * provided that the following conditions are met:
 *
 * * any redistribution and use of the source code, including any resulting derivative works, are licensed by
 * TI for use only with TI Devices.
 * * any redistribution and use of any object code compiled from the source code and any resulting derivative
 * works, are licensed by TI for use only with TI Devices.
 *
 * Neither the name of Texas Instruments Incorporated nor the names of its suppliers may be used to endorse or
 * promote products derived from this software without specific prior written permission.
 *
 * DISCLAIMER.
 *
 * THIS SOFTWARE IS PROVIDED BY TI AND TI"S LICENSORS "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 TI AND TI"S LICENSORS 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.
*/
#ifndef UB_LOGGING_H_
#define UB_LOGGING_H_
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef int ub_dbgmsg_level_t;
 
#define UBL_NONE   0
#define UBL_FATAL  1
#define UBL_ERROR  2
#define UBL_WARN   3
#define UBL_INFO   4
#define UBL_INFOV  5
#define UBL_DEBUG  6
#define UBL_DEBUGV 7
 
#ifndef MAX_LOGMSG_CATEGORIES
 
#define MAX_LOGMSG_CATEGORIES 16
#endif
 
#define DBGMSG_LEVEL_MARK {"NON", "FTL", "ERR", "WRN", "INF", "IFV", "DBG", "DBV"}
 
#define UBL_TS_BIT_FIELDS 3 // bit0 and bit1
 
#ifndef UB_LOG_COMPILE_LEVEL
#define UB_LOG_COMPILE_LEVEL UBL_DEBUGV
#endif
 
#define UB_LOG_IS_COMPILED(level) (UB_LOG_COMPILE_LEVEL >= level)
 
#define UB_LOG_HELPER(level, tstype, ...)           \
    {                               \
        char coutstr[UB_CHARS_IN_LINE];             \
        (void)snprintf(coutstr, UB_CHARS_IN_LINE, __VA_ARGS__); \
        (void)ub_log_print(UB_LOGCAT, tstype, level, coutstr);  \
    }
 
#if UB_LOG_IS_COMPILED(UBL_DEBUGV)
#define UB_LOG_UBL_DEBUGV(...) UB_LOG_HELPER(UBL_DEBUGV, 0, __VA_ARGS__)
#define UB_TLOG_UBL_DEBUGV(...) UB_LOG_HELPER(UBL_DEBUGV, UB_LOGTSTYPE, __VA_ARGS__)
#else
#define UB_LOG_UBL_DEBUGV(...)
#define UB_TLOG_UBL_DEBUGV(...)
#endif
 
#if UB_LOG_IS_COMPILED(UBL_DEBUG)
#define UB_LOG_UBL_DEBUG(...) UB_LOG_HELPER(UBL_DEBUG, 0, __VA_ARGS__)
#define UB_TLOG_UBL_DEBUG(...) UB_LOG_HELPER(UBL_DEBUG, UB_LOGTSTYPE, __VA_ARGS__)
#else
#define UB_LOG_UBL_DEBUG(...)
#define UB_TLOG_UBL_DEBUG(...)
#endif
 
#if UB_LOG_IS_COMPILED(UBL_INFOV)
#define UB_LOG_UBL_INFOV(...) UB_LOG_HELPER(UBL_INFOV, 0, __VA_ARGS__)
#define UB_TLOG_UBL_INFOV(...) UB_LOG_HELPER(UBL_INFOV, UB_LOGTSTYPE, __VA_ARGS__)
#else
#define UB_LOG_UBL_INFOV(...)
#define UB_TLOG_UBL_INFOV(...)
#endif
 
#if UB_LOG_IS_COMPILED(UBL_INFO)
#define UB_LOG_UBL_INFO(...) UB_LOG_HELPER(UBL_INFO, 0, __VA_ARGS__)
#define UB_TLOG_UBL_INFO(...) UB_LOG_HELPER(UBL_INFO, UB_LOGTSTYPE, __VA_ARGS__)
#else
#define UB_LOG_UBL_INFO(...)
#define UB_TLOG_UBL_INFO(...)
#endif
 
#if UB_LOG_IS_COMPILED(UBL_WARN)
#define UB_LOG_UBL_WARN(...) UB_LOG_HELPER(UBL_WARN, 0, __VA_ARGS__)
#define UB_TLOG_UBL_WARN(...) UB_LOG_HELPER(UBL_WARN, UB_LOGTSTYPE, __VA_ARGS__)
#else
#define UB_LOG_UBL_WARN(...)
#define UB_TLOG_UBL_WARN(...)
#endif
 
#if UB_LOG_IS_COMPILED(UBL_ERROR)
#define UB_LOG_UBL_ERROR(...) UB_LOG_HELPER(UBL_ERROR, 0, __VA_ARGS__)
#define UB_TLOG_UBL_ERROR(...) UB_LOG_HELPER(UBL_ERROR, UB_LOGTSTYPE, __VA_ARGS__)
#else
#define UB_LOG_UBL_ERROR(...)
#define UB_TLOG_UBL_ERROR(...)
#endif
 
#if UB_LOG_IS_COMPILED(UBL_FATAL)
#define UB_LOG_UBL_FATAL(...) UB_LOG_HELPER(UBL_FATAL, 0, __VA_ARGS__)
#define UB_TLOG_UBL_FATAL(...) UB_LOG_HELPER(UBL_FATAL, UB_LOGTSTYPE, __VA_ARGS__)
#else
#define UB_LOG_UBL_FATAL(...)
#define UB_TLOG_UBL_FATAL(...)
#endif
 
#define UB_LOG_UBL_NONE(...)
#define UB_TLOG_UBL_NONE(...)
 
#define UBL_OVERRIDE_ISTR(x,y) ub_log_initstr_override(x,UBB_GETENV(y))
 
#ifdef PRINT_FORMAT_NO_WARNING
 
#define PRINT_FORMAT_ATTRIBUTE1
#define PRINT_FORMAT_ATTRIBUTE4
#else
 
#define PRINT_FORMAT_ATTRIBUTE1 __attribute__((format (printf, 1, 2))) 
#define PRINT_FORMAT_ATTRIBUTE4 __attribute__((format (printf, 4, 5))) 
#endif
 
void ub_console_debug_select_print(bool console, bool debug, const char *astr);
 
const char *ub_log_initstr_override(const char *ns, const char *os);
 
void ub_log_init(const char *istr);
 
int ub_log_add_category(const char *catstr);
 
int ub_log_print(int cat_index, int flags, ub_dbgmsg_level_t level, const char *astr);
 
bool ub_clog_on(int cat_index, ub_dbgmsg_level_t level);
 
bool ub_dlog_on(int cat_index, ub_dbgmsg_level_t level);
 
int ub_log_change(int cat_index, ub_dbgmsg_level_t clevel, ub_dbgmsg_level_t dlevel);
 
int ub_log_return(int cat_index);
 
void ub_log_flush(void);
 
#ifdef __cplusplus
}
#endif
 
#endif