Blame lib/log.c

Packit Service 5befb9
/*
Packit Service 5befb9
 * BSD LICENSE
Packit Service 5befb9
 *
Packit Service 8a4b7a
 * Copyright(c) 2014-2020 Intel Corporation. All rights reserved.
Packit Service 5befb9
 * All rights reserved.
Packit Service 5befb9
 *
Packit Service 5befb9
 * Redistribution and use in source and binary forms, with or without
Packit Service 5befb9
 * modification, are permitted provided that the following conditions
Packit Service 5befb9
 * are met:
Packit Service 5befb9
 *
Packit Service 5befb9
 *   * Redistributions of source code must retain the above copyright
Packit Service 5befb9
 *     notice, this list of conditions and the following disclaimer.
Packit Service 5befb9
 *   * Redistributions in binary form must reproduce the above copyright
Packit Service 5befb9
 *     notice, this list of conditions and the following disclaimer in
Packit Service 5befb9
 *     the documentation and/or other materials provided with the
Packit Service 5befb9
 *     distribution.
Packit Service 5befb9
 *   * Neither the name of Intel Corporation nor the names of its
Packit Service 5befb9
 *     contributors may be used to endorse or promote products derived
Packit Service 5befb9
 *     from this software without specific prior written permission.
Packit Service 5befb9
 *
Packit Service 5befb9
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
Packit Service 5befb9
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
Packit Service 5befb9
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
Packit Service 5befb9
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
Packit Service 5befb9
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
Packit Service 5befb9
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
Packit Service 5befb9
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
Packit Service 5befb9
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
Packit Service 5befb9
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
Packit Service 5befb9
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
Packit Service 5befb9
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.O
Packit Service 5befb9
 *
Packit Service 5befb9
 */
Packit Service 5befb9
Packit Service 5befb9
/**
Packit Service 5befb9
 * @brief Library operations logger for info, warnings and errors.
Packit Service 5befb9
 */
Packit Service 5befb9
Packit Service 5befb9
#include <stdio.h>
Packit Service 5befb9
#include <stdlib.h>
Packit Service 5befb9
#include <stdarg.h>
Packit Service 5befb9
#include <string.h>
Packit Service 5befb9
#include <unistd.h>
Packit Service 5befb9
#include <errno.h>
Packit Service 5befb9
Packit Service 5befb9
#include "types.h"
Packit Service 5befb9
#include "log.h"
Packit Service 5befb9
Packit Service 5befb9
/**
Packit Service 5befb9
 * ---------------------------------------
Packit Service 5befb9
 * Local data types
Packit Service 5befb9
 * ---------------------------------------
Packit Service 5befb9
 */
Packit Service 8a4b7a
#define AP_BUFFER_SIZE 256
Packit Service 5befb9
Packit Service 5befb9
/**
Packit Service 5befb9
 * ---------------------------------------
Packit Service 5befb9
 * Local data structures
Packit Service 5befb9
 * ---------------------------------------
Packit Service 5befb9
 */
Packit Service 5befb9
Packit Service 8a4b7a
static int m_opt = 0;              /**< log options */
Packit Service 8a4b7a
static int m_fd = -1;              /**< log file descriptor */
Packit Service 8a4b7a
static void *m_context_log = NULL; /**< log callback context */
Packit Service 5befb9
/**
Packit Service 5befb9
 *  log callback
Packit Service 5befb9
 */
Packit Service 5befb9
static void (*m_callback_log)(void *, const size_t, const char *);
Packit Service 8a4b7a
static int log_init_successful = 0; /**< log init gatekeeper */
Packit Service 5befb9
/**
Packit Service 5befb9
 * ---------------------------------------
Packit Service 5befb9
 * Local functions
Packit Service 5befb9
 * ---------------------------------------
Packit Service 5befb9
 */
Packit Service 5befb9
Packit Service 5befb9
/**
Packit Service 5befb9
 * =======================================
Packit Service 5befb9
 * initialize and shutdown
Packit Service 5befb9
 * =======================================
Packit Service 5befb9
 */
Packit Service 5befb9
Packit Service 5befb9
int
Packit Service 8a4b7a
log_init(int fd_log,
Packit Service 8a4b7a
         void (*callback_log)(void *, const size_t, const char *),
Packit Service 8a4b7a
         void *context_log,
Packit Service 8a4b7a
         int verbosity)
Packit Service 5befb9
{
Packit Service 8a4b7a
        /**
Packit Service 5befb9
         * Set log message verbosity
Packit Service 5befb9
         */
Packit Service 5befb9
        switch (verbosity) {
Packit Service 5befb9
        case LOG_VER_SILENT:
Packit Service 5befb9
                m_opt = LOG_OPT_SILENT;
Packit Service 5befb9
                log_init_successful = 1;
Packit Service 8a4b7a
                return LOG_RETVAL_OK;
Packit Service 5befb9
        case LOG_VER_DEFAULT:
Packit Service 5befb9
                m_opt = LOG_OPT_DEFAULT;
Packit Service 5befb9
                break;
Packit Service 5befb9
        case LOG_VER_VERBOSE:
Packit Service 5befb9
                m_opt = LOG_OPT_VERBOSE;
Packit Service 5befb9
                break;
Packit Service 5befb9
        case LOG_VER_SUPER_VERBOSE:
Packit Service 5befb9
                m_opt = LOG_OPT_SUPER_VERBOSE;
Packit Service 5befb9
                break;
Packit Service 5befb9
        default:
Packit Service 5befb9
                m_opt = LOG_OPT_SUPER_VERBOSE;
Packit Service 5befb9
                break;
Packit Service 5befb9
        }
Packit Service 5befb9
Packit Service 8a4b7a
        if (fd_log < 0 && callback_log == NULL) {
Packit Service 8a4b7a
                fprintf(stderr, "%s: no LOG destination selected\n", __func__);
Packit Service 5befb9
                return LOG_RETVAL_ERROR;
Packit Service 5befb9
        }
Packit Service 5befb9
Packit Service 8a4b7a
        m_fd = fd_log;
Packit Service 8a4b7a
        m_callback_log = callback_log;
Packit Service 8a4b7a
        m_context_log = context_log;
Packit Service 8a4b7a
        log_init_successful = 1;
Packit Service 5befb9
Packit Service 5befb9
        return LOG_RETVAL_OK;
Packit Service 5befb9
}
Packit Service 5befb9
Packit Service 5befb9
int
Packit Service 5befb9
log_fini(void)
Packit Service 5befb9
{
Packit Service 8a4b7a
        if (m_opt == LOG_OPT_SILENT) {
Packit Service 5befb9
                log_init_successful = 0;
Packit Service 8a4b7a
                return LOG_RETVAL_OK;
Packit Service 5befb9
        }
Packit Service 5befb9
Packit Service 5befb9
        m_opt = 0;
Packit Service 8a4b7a
        m_fd = -1;
Packit Service 8a4b7a
        m_callback_log = NULL;
Packit Service 8a4b7a
        m_context_log = NULL;
Packit Service 8a4b7a
        log_init_successful = 0;
Packit Service 5befb9
Packit Service 5befb9
        return LOG_RETVAL_OK;
Packit Service 5befb9
}
Packit Service 5befb9
Packit Service 5befb9
void
Packit Service 5befb9
log_printf(int type, const char *str, ...)
Packit Service 5befb9
{
Packit Service 5befb9
        va_list ap;
Packit Service 8a4b7a
        char ap_buffer[AP_BUFFER_SIZE];
Packit Service 5befb9
        int size;
Packit Service 5befb9
Packit Service 8a4b7a
        /* If log_init has not been successful then
Packit Service 8a4b7a
         * log_printf should not work. */
Packit Service 5befb9
        ASSERT(log_init_successful == 1);
Packit Service 8a4b7a
        if (log_init_successful == 0)
Packit Service 8a4b7a
                return;
Packit Service 5befb9
Packit Service 8a4b7a
        if (m_opt == LOG_OPT_SILENT)
Packit Service 8a4b7a
                return;
Packit Service 5befb9
Packit Service 5befb9
        if ((m_opt & type) == 0)
Packit Service 5befb9
                return;
Packit Service 5befb9
Packit Service 5befb9
        ASSERT(str != NULL);
Packit Service 5befb9
        if (str == NULL)
Packit Service 5befb9
                return;
Packit Service 5befb9
Packit Service 8a4b7a
        va_start(ap, str);
Packit Service 8a4b7a
        ap_buffer[AP_BUFFER_SIZE - 1] = '\0';
Packit Service 8a4b7a
        size = vsnprintf(ap_buffer, AP_BUFFER_SIZE - 1, str, ap);
Packit Service 8a4b7a
        va_end(ap);
Packit Service 8a4b7a
        ASSERT(size >= 0);
Packit Service 8a4b7a
        if (size < 0)
Packit Service 8a4b7a
                return;
Packit Service 5befb9
Packit Service 8a4b7a
        if (m_callback_log != NULL)
Packit Service 8a4b7a
                m_callback_log(m_context_log, size, ap_buffer);
Packit Service 5befb9
Packit Service 8a4b7a
        if (m_fd >= 0) {
Packit Service 8a4b7a
                if (write(m_fd, ap_buffer, size) < 0)
Packit Service 8a4b7a
                        fprintf(stderr, "%s: printing to file failed\n",
Packit Service 5befb9
                                __func__);
Packit Service 8a4b7a
        }
Packit Service 5befb9
}