acrn-hypervisor/hypervisor/include/debug/logmsg.h
Shiqing Gao 4360235edf hv: treewide: fix 'Macro parameter not in brackets'
Add the brackets for Macro parameter to avoid the unintentional
mistakes.

A simple example that may cause mistakes:
        #define minus(x) -x
When the following call is made,
        z = minus(a-b)
it becomes:
        z = -a-b;
where "-a - b" is equivalent to "(-a) - b" rather than "- (a - b)", as
expected.

v2 -> v3:
 * convert DMAR_WAIT_COMPLETION to inline function
 * remove the macro PIC_PIN_FOREACH and implement the well-formed
   for loop in each case
 * replace __CPP_STRING with STRINGIFY and remove the unused CPP_STRING

v1 -> v2:
 * Remove some changes to function like macro since MISRA-C requires to
   use inline functions if it is possible.
   These MACRO brackets violations will be fixed together when fixing
   other issues related to function like macro.

Tracked-On: #861
Signed-off-by: Shiqing Gao <shiqing.gao@intel.com>
2018-09-07 10:22:00 +08:00

146 lines
3.3 KiB
C

/*
* Copyright (C) 2018 Intel Corporation. All rights reserved.
*
* SPDX-License-Identifier: BSD-3-Clause
*/
#ifndef LOGMSG_H
#define LOGMSG_H
/* Logging severity levels */
#define LOG_FATAL 1U
/* For msg should be write to console and sbuf meanwhile but not fatal error */
#define LOG_ACRN 2U
#define LOG_ERROR 3U
#define LOG_WARNING 4U
#define LOG_INFO 5U
#define LOG_DEBUG 6U
/* Logging flags */
#define LOG_FLAG_STDOUT 0x00000001U
#define LOG_FLAG_MEMORY 0x00000002U
#define LOG_FLAG_NPK 0x00000004U
#define LOG_ENTRY_SIZE 80
/* Size of buffer used to store a message being logged,
* should align to LOG_ENTRY_SIZE.
*/
#define LOG_MESSAGE_MAX_SIZE (4 * LOG_ENTRY_SIZE)
#if defined(HV_DEBUG)
extern uint32_t console_loglevel;
extern uint32_t mem_loglevel;
extern uint32_t npk_loglevel;
void init_logmsg(__unused uint32_t mem_size, uint32_t flags);
void print_logmsg_buffer(uint16_t pcpu_id);
void do_logmsg(uint32_t severity, const char *fmt, ...);
void asm_assert(int32_t line, const char *file, const char *txt);
#define ASSERT(x, ...) \
do { \
if (!(x)) {\
asm_assert(__LINE__, __FILE__, "fatal error");\
} \
} while (0)
/** The well known printf() function.
*
* Formats a string and writes it to the console output.
*
* @param fmt A pointer to the NUL terminated format string.
*
* @return The number of characters actually written or a negative
* number if an error occurred.
*/
int printf(const char *fmt, ...);
/** The well known vprintf() function.
*
* Formats a string and writes it to the console output.
*
* @param fmt A pointer to the NUL terminated format string.
* @param args The variable long argument list as va_list.
* @return The number of characters actually written or a negative
* number if an error occurred.
*/
int vprintf(const char *fmt, va_list args);
#else /* HV_DEBUG */
static inline void init_logmsg(__unused uint32_t mem_size,
__unused uint32_t flags)
{
}
static inline void do_logmsg(__unused uint32_t severity,
__unused const char *fmt, ...)
{
}
static inline void print_logmsg_buffer(__unused uint16_t pcpu_id)
{
}
#define ASSERT(x, ...) do { } while (0)
static inline int printf(__unused const char *fmt, ...)
{
return 0;
}
static inline int vprintf(__unused const char *fmt, __unused va_list args)
{
return 0;
}
#endif /* HV_DEBUG */
#ifndef pr_prefix
#define pr_prefix
#endif
#define pr_fatal(...) \
do { \
do_logmsg(LOG_FATAL, pr_prefix __VA_ARGS__); \
} while (0)
#define pr_acrnlog(...) \
do { \
do_logmsg(LOG_ACRN, pr_prefix __VA_ARGS__); \
} while (0)
#define pr_err(...) \
do { \
do_logmsg(LOG_ERROR, pr_prefix __VA_ARGS__); \
} while (0)
#define pr_warn(...) \
do { \
do_logmsg(LOG_WARNING, pr_prefix __VA_ARGS__); \
} while (0)
#define pr_info(...) \
do { \
do_logmsg(LOG_INFO, pr_prefix __VA_ARGS__); \
} while (0)
#define pr_dbg(...) \
do { \
do_logmsg(LOG_DEBUG, pr_prefix __VA_ARGS__); \
} while (0)
#define dev_dbg(lvl, ...) \
do { \
do_logmsg((lvl), pr_prefix __VA_ARGS__); \
} while (0)
#define panic(...) \
do { pr_fatal("PANIC: %s line: %d\n", __func__, __LINE__); \
pr_fatal(__VA_ARGS__); \
while (1) { asm volatile ("pause" ::: "memory"); }; } while (0)
#endif /* LOGMSG_H */