log.h

Go to the documentation of this file.

/*
 * CDDL HEADER START
 *
 * This file and its contents are supplied under the terms of the
 * Common Development and Distribution License ("CDDL"), version 1.0.
 * You may only use this file in accordance with the terms of version
 * 1.0 of the CDDL.
 *
 * A full copy of the text of the CDDL should have accompanied this
 * source.  A copy of the CDDL is also available via the Internet at
 * http://www.illumos.org/license/CDDL.
 *
 * CDDL HEADER END
 */
/*
 * Copyright 2023 Saso Kiselkov. All rights reserved.
 */
#ifndef _ACF_UTILS_LOG_H_
#define _ACF_UTILS_LOG_H_
 
#include <stdarg.h>
 
#ifndef _LACF_WITHOUT_XPLM
#include <XPLMUtilities.h>
#endif
 
#include "sysmacros.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*
 * Before using any of the log_* functionality, be sure to properly
 * initialize it and pass it a logging function!
 */
typedef void (*logfunc_t)(const char *);
API_EXPORT void log_init(logfunc_t func, const char *prefix);
API_EXPORT void log_fini(void);
API_EXPORT logfunc_t log_get_logfunc(void);
 
#ifndef _LACF_WITHOUT_XPLM
UNUSED_ATTR static void
log_xplm_cb(const char *str)
{
    XPLMDebugString(str);
}
#endif  /* !defined(_LACF_WITHOUT_XPLM) */
 
#if defined(__GNUC__) || defined(__clang__)
#define BUILTIN_STRRCHR __builtin_strrchr
#else   /* !defined(__GNUC__) && !defined(__clang__) */
#define BUILTIN_STRRCHR strrchr
#endif  /* !defined(__GNUC__) && !defined(__clang__) */
 
#define log_basename(f) \
    (BUILTIN_STRRCHR(f, '/') ? BUILTIN_STRRCHR(f, '/') + 1 : \
        (BUILTIN_STRRCHR(f, '\\') ? BUILTIN_STRRCHR(f, '\\') + 1 : (f)))
#define logMsg(...) \
    log_impl(log_basename(__FILE__), __LINE__, __VA_ARGS__)
#define logMsg_v(fmt, ap) \
    log_impl_v(log_basename(__FILE__), __LINE__, (fmt), (ap))
API_EXPORT void log_impl(const char *filename, int line,
    PRINTF_FORMAT(const char *fmt), ...) PRINTF_ATTR(3);
API_EXPORT void log_impl_v(const char *filename, int line, const char *fmt,
    va_list ap);
API_EXPORT void log_backtrace(int skip_frames);
#if IBM
API_EXPORT void log_backtrace_sw64(PCONTEXT ctx);
#endif
 
#ifdef __cplusplus
}
#endif
 
#endif  /* _ACF_UTILS_LOG_H_ */