MaxScale/server/core/memlog.c

/*
 * Copyright (c) 2016 MariaDB Corporation Ab
 *
 * Use of this software is governed by the Business Source License included
 * in the LICENSE.TXT file and at www.mariadb.com/bsl.
 *
 * Change Date: 2019-07-01
 *
 * On the date above, in accordance with the Business Source License, use
 * of this software will be governed by version 2 or later of the General
 * Public License.
 */

/**
 * @file memlog.c  - Implementation of memory logging mechanism for debug purposes
 *
 * @verbatim
 * Revision History
 *
 * Date         Who             Description
 * 26/09/14     Mark Riddoch    Initial implementation
 *
 * @endverbatim
 */
#include <maxscale/memlog.h>
#include <stdlib.h>
#include <stdio.h>
#include <string.h>
#include <stdint.h>
#include <maxscale/alloc.h>
#include <maxscale/log_manager.h>

static MEMLOG *memlogs = NULL;
static SPINLOCK memlock = SPINLOCK_INIT;

/**
 * Create a new instance of a memory logger.
 *
 * @param name  The name of the memory log
 * @param type  The type of item being logged
 * @param size  The number of items to store in memory before flushign to disk
 *
 * @return MEMLOG*      A memory log handle
 */
MEMLOG *
memlog_create(char *name, MEMLOGTYPE type, int size)
{
    name = MXS_STRDUP(name);

    MEMLOG *log = (MEMLOG *)MXS_MALLOC(sizeof(MEMLOG));

    if (!name || !log)
    {
        MXS_FREE(name);
        MXS_FREE(log);
        return NULL;
    }

    log->name = name;
    spinlock_init(&log->lock);
    log->type = type;
    log->offset = 0;
    log->size = size;
    log->flags = 0;
    switch (type)
    {
    case ML_INT:
        log->values = MXS_MALLOC(sizeof(int) * size);
        break;
    case ML_LONG:
        log->values = MXS_MALLOC(sizeof(long) * size);
        break;
    case ML_LONGLONG:
        log->values = MXS_MALLOC(sizeof(long long) * size);
        break;
    case ML_STRING:
        log->values = MXS_MALLOC(sizeof(char *) * size);
        break;
    }
    if (log->values == NULL)
    {
        MXS_FREE(name);
        MXS_FREE(log);
        return NULL;
    }
    spinlock_acquire(&memlock);
    log->next = memlogs;
    memlogs = log;
    spinlock_release(&memlock);

    return log;
}

/**
 * Destroy a memory logger any unwritten data will be flushed to disk
 *
 * @param log   The memory log to destroy
 */
void
memlog_destroy(MEMLOG *log)
{
    MEMLOG *ptr;

    if ((log->flags & MLNOAUTOFLUSH) == 0)
    {
        memlog_flush(log);
    }
    MXS_FREE(log->values);

    spinlock_acquire(&memlock);
    if (memlogs == log)
    {
        memlogs = log->next;
    }
    else
    {
        ptr = memlogs;
        while (ptr && ptr->next != log)
        {
            ptr = ptr->next;
        }
        if (ptr)
        {
            ptr->next = log->next;
        }
    }
    spinlock_release(&memlock);
    MXS_FREE(log->name);
    MXS_FREE(log);
}

/**
 * Log a data item to the memory logger
 *
 * @param log   The memory logger
 * @param value The value to log
 */
void
memlog_log(MEMLOG *log, void *value)
{
    if (!log)
    {
        return;
    }
    spinlock_acquire(&log->lock);
    switch (log->type)
    {
    case ML_INT:
        ((int *)(log->values))[log->offset] = (intptr_t)value;
        break;
    case ML_LONG:
        ((long *)(log->values))[log->offset] = (long)value;
        break;
    case ML_LONGLONG:
        ((long long *)(log->values))[log->offset] = (long long)value;
        break;
    case ML_STRING:
        ((char **)(log->values))[log->offset] = (char *)value;
        break;
    }
    log->offset++;
    if (log->offset == log->size)
    {
        if ((log->flags & MLNOAUTOFLUSH) == 0)
        {
            memlog_flush(log);
        }
        log->offset = 0;
        log->iflags = MLWRAPPED;
    }
    spinlock_release(&log->lock);
}

/**
 * Flush all memlogs to disk, called during shutdown
 *
 */
void
memlog_flush_all()
{
    MEMLOG  *log;

    spinlock_acquire(&memlock);
    log = memlogs;
    while (log)
    {
        spinlock_acquire(&log->lock);
        memlog_flush(log);
        spinlock_release(&log->lock);
        log = log->next;
    }
    spinlock_release(&memlock);
}

/**
 * Set the flags for a memlog
 *
 * @param       log             The memlog to set the flags for
 * @param       flags           The new flags values
 */
void
memlog_set(MEMLOG *log, unsigned int flags)
{
    log->flags = flags;
}

/**
 * Flush a memory log to disk
 *
 * Assumes the the log->lock has been acquired by the caller
 *
 * @param log   The memory log to flush
 */
void
memlog_flush(MEMLOG *log)
{
    FILE *fp;
    int i;

    if ((fp = fopen(log->name, "a")) == NULL)
    {
        return;
    }
    if ((log->flags & MLNOAUTOFLUSH) && (log->iflags & MLWRAPPED))
    {
        for (i = 0; i < log->size; i++)
        {
            int ind = (i + log->offset) % log->size;
            switch (log->type)
            {
            case ML_INT:
                fprintf(fp, "%d\n",
                        ((int *)(log->values))[ind]);
                break;
            case ML_LONG:
                fprintf(fp, "%ld\n",
                        ((long *)(log->values))[ind]);
                break;
            case ML_LONGLONG:
                fprintf(fp, "%lld\n",
                        ((long long *)(log->values))[ind]);
                break;
            case ML_STRING:
                fprintf(fp, "%s\n",
                        ((char **)(log->values))[ind]);
                break;
            }
        }
    }
    else
    {
        for (i = 0; i < log->offset; i++)
        {
            switch (log->type)
            {
            case ML_INT:
                fprintf(fp, "%d\n", ((int *)(log->values))[i]);
                break;
            case ML_LONG:
                fprintf(fp, "%ld\n", ((long *)(log->values))[i]);
                break;
            case ML_LONGLONG:
                fprintf(fp, "%lld\n", ((long long *)(log->values))[i]);
                break;
            case ML_STRING:
                fprintf(fp, "%s\n", ((char **)(log->values))[i]);
                break;
            }
        }
    }
    log->offset = 0;
    fclose(fp);
}