/*
 * BSD LICENSE
 *
 * Copyright(c) 2018-2023 Intel Corporation. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *   * Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *   * Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in
 *     the documentation and/or other materials provided with the
 *     distribution.
 *   * Neither the name of Intel Corporation nor the names of its
 *     contributors may be used to endorse or promote products derived
 *     from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "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 THE COPYRIGHT
 * OWNER OR CONTRIBUTORS 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.
 *
 */

#include "perf_monitoring.h"

#include "common.h"
#include "log.h"
#include "monitoring.h"
#include "perf.h"

#include <dirent.h> /**< scandir() */
#include <linux/perf_event.h>
#include <stdlib.h>
#include <string.h>
#include <sys/stat.h>

/**
 * Event indexes in table of supported events
 */
#define OS_MON_EVT_IDX_LLC      0
#define OS_MON_EVT_IDX_LMBM     1
#define OS_MON_EVT_IDX_TMBM     2
#define OS_MON_EVT_IDX_RMBM     3
#define OS_MON_EVT_IDX_INST     4
#define OS_MON_EVT_IDX_CYC      5
#define OS_MON_EVT_IDX_IPC      6
#define OS_MON_EVT_IDX_LLC_MISS 7
#define OS_MON_EVT_IDX_LLC_REF  8

/**
 * Paths to RDT perf event info
 */
#ifndef PERF_MON_SUPPORT
#define PERF_MON_SUPPORT "/proc/sys/kernel/perf_event_paranoid"
#endif

/**
 * Monitoring event type
 */
static int os_mon_type = 0;

/**
 * All supported events mask
 */
static enum pqos_mon_event all_evt_mask = (enum pqos_mon_event)0;

/**
 * Table of structures used to store data about
 * supported monitoring events and their
 * mapping onto PQoS events
 */
static struct perf_mon_supported_event {
        const char *name;
        const char *desc;
        enum pqos_mon_event event;
        int supported;
        double scale;
        struct perf_event_attr attrs;
} events_tab[] = {
    {.name = "llc_occupancy",
     .desc = "LLC Occupancy",
     .event = PQOS_MON_EVENT_L3_OCCUP,
     .supported = 0,
     .scale = 1},
    {.name = "local_bytes",
     .desc = "Local Memory B/W",
     .event = PQOS_MON_EVENT_LMEM_BW,
     .supported = 0,
     .scale = 1},
    {.name = "total_bytes",
     .desc = "Total Memory B/W",
     .event = PQOS_MON_EVENT_TMEM_BW,
     .supported = 0,
     .scale = 1},
    {.name = "",
     .desc = "Remote Memory B/W",
     .event = PQOS_MON_EVENT_RMEM_BW,
     .supported = 0,
     .scale = 1},
    {.name = "",
     .desc = "Retired CPU Instructions",
     .event = (enum pqos_mon_event)PQOS_PERF_EVENT_INSTRUCTIONS,
     .supported = 0},
    {.name = "",
     .desc = "Unhalted CPU Cycles",
     .event = (enum pqos_mon_event)PQOS_PERF_EVENT_CYCLES,
     .supported = 0},
    {.name = "",
     .desc = "Instructions/Cycle",
     .event = PQOS_PERF_EVENT_IPC,
     .supported = 0},
    {.name = "",
     .desc = "LLC Misses",
     .event = PQOS_PERF_EVENT_LLC_MISS,
     .supported = 0},
    {.name = "",
     .desc = "LLC References",
     .event = PQOS_PERF_EVENT_LLC_REF,
     .supported = 0},
};

/**
 * @brief Filter directory filenames
 *
 * This function is used by the scandir function
 * to filter hidden (dot) files
 *
 * @param dir dirent structure containing directory info
 *
 * @return if directory entry should be included in scandir() output list
 * @retval 0 means don't include the entry  ("." in our case)
 * @retval 1 means include the entry
 */
static int
filter(const struct dirent *dir)
{
        return (dir->d_name[0] == '.') ? 0 : 1;
}

/**
 * @brief Gets event from supported events table
 *
 * @param event events bitmask of selected events
 *
 * @return event from supported event table
 * @retval NULL if not successful
 */
static struct perf_mon_supported_event *
get_supported_event(const enum pqos_mon_event event)
{
        switch (event) {
        case PQOS_MON_EVENT_L3_OCCUP:
                return &events_tab[OS_MON_EVT_IDX_LLC];
        case PQOS_MON_EVENT_LMEM_BW:
                return &events_tab[OS_MON_EVT_IDX_LMBM];
        case PQOS_MON_EVENT_TMEM_BW:
                return &events_tab[OS_MON_EVT_IDX_TMBM];
        case PQOS_MON_EVENT_RMEM_BW:
                return &events_tab[OS_MON_EVT_IDX_RMBM];
        case (enum pqos_mon_event)PQOS_PERF_EVENT_INSTRUCTIONS:
                return &events_tab[OS_MON_EVT_IDX_INST];
        case (enum pqos_mon_event)PQOS_PERF_EVENT_CYCLES:
                return &events_tab[OS_MON_EVT_IDX_CYC];
        case PQOS_PERF_EVENT_IPC:
                return &events_tab[OS_MON_EVT_IDX_IPC];
        case PQOS_PERF_EVENT_LLC_MISS:
                return &events_tab[OS_MON_EVT_IDX_LLC_MISS];
        case PQOS_PERF_EVENT_LLC_REF:
                return &events_tab[OS_MON_EVT_IDX_LLC_REF];
        default:
                ASSERT(0);
                return NULL;
        }
}

/**
 * @brief Read perf RDT monitoring type from file system
 *
 * @return Operational Status
 * @retval PQOS_RETVAL_OK on success
 */
static int
set_mon_type(void)
{
        FILE *fd;
        char file[64], evt[8];

        snprintf(file, sizeof(file) - 1, "%s", PERF_MON_TYPE);
        fd = pqos_fopen(file, "r");
        if (fd == NULL)
                return PQOS_RETVAL_RESOURCE;
        if (fgets(evt, sizeof(evt), fd) == NULL) {
                LOG_ERROR("Failed to read perf monitoring type!\n");
                pqos_fclose(fd);
                return PQOS_RETVAL_ERROR;
        }
        pqos_fclose(fd);

        os_mon_type = (int)strtol(evt, NULL, 0);
        if (os_mon_type == 0) {
                LOG_ERROR("Failed to convert perf monitoring type!\n");
                return PQOS_RETVAL_ERROR;
        }
        return PQOS_RETVAL_OK;
}

/**
 * @brief Set architectural perf event attributes
 *        in events table and update event mask
 *
 * @param [out] events event mask to be updated
 *
 * @return Operational Status
 * @retval PQOS_RETVAL_OK on success
 */
static int
set_arch_event_attrs(enum pqos_mon_event *events)
{
        struct perf_event_attr attr;

        if (events == NULL)
                return PQOS_RETVAL_PARAM;
        /**
         * Set event attributes
         */
        memset(&attr, 0, sizeof(attr));
        attr.type = PERF_TYPE_HARDWARE;
        attr.size = sizeof(struct perf_event_attr);

        /* Set LLC misses event attributes */
        events_tab[OS_MON_EVT_IDX_LLC_MISS].attrs = attr;
        events_tab[OS_MON_EVT_IDX_LLC_MISS].attrs.config =
            PERF_COUNT_HW_CACHE_MISSES;
        *events |= (enum pqos_mon_event)PQOS_PERF_EVENT_LLC_MISS;

        /* Set LLC references event attributes */
        events_tab[OS_MON_EVT_IDX_LLC_REF].attrs = attr;
        events_tab[OS_MON_EVT_IDX_LLC_REF].attrs.config =
            PERF_COUNT_HW_CACHE_REFERENCES;
        *events |= (enum pqos_mon_event)PQOS_PERF_EVENT_LLC_REF;

        /* Set retired instructions event attributes */
        events_tab[OS_MON_EVT_IDX_INST].attrs = attr;
        events_tab[OS_MON_EVT_IDX_INST].attrs.config =
            PERF_COUNT_HW_INSTRUCTIONS;
        *events |= (enum pqos_mon_event)PQOS_PERF_EVENT_INSTRUCTIONS;

        /* Set unhalted cycles event attributes */
        events_tab[OS_MON_EVT_IDX_CYC].attrs = attr;
        events_tab[OS_MON_EVT_IDX_CYC].attrs.config = PERF_COUNT_HW_CPU_CYCLES;
        *events |= (enum pqos_mon_event)PQOS_PERF_EVENT_CYCLES;

        *events |= (enum pqos_mon_event)PQOS_PERF_EVENT_IPC;

        return PQOS_RETVAL_OK;
}

/**
 * @brief Sets RDT perf event attributes
 *
 * Reads RDT perf event attributes from the file system and sets
 * attribute values in the events table
 *
 * @param idx index of the events table
 * @param fname name of event file
 *
 * @return Operation status
 * @retval PQOS_RETVAL_OK on success
 */
static int
set_rdt_event_attrs(const int idx, const char *fname)
{
        FILE *fd;
        int config, ret;
        double sf = 0;
        char file[512], buf[32], *p;

        /**
         * Read event type from file system
         */
        snprintf(file, sizeof(file) - 1, "%s/%s", PERF_MON_EVENTS, fname);
        fd = pqos_fopen(file, "r");
        if (fd == NULL) {
                LOG_ERROR("Failed to open %s!\n", file);
                return PQOS_RETVAL_ERROR;
        }
        if (fgets(buf, sizeof(buf), fd) == NULL) {
                LOG_ERROR("Failed to read OS monitoring event!\n");
                pqos_fclose(fd);
                return PQOS_RETVAL_ERROR;
        }
        pqos_fclose(fd);
        p = buf;
        strsep(&p, "=");
        if (p == NULL) {
                LOG_ERROR("Failed to parse OS monitoring event value!\n");
                return PQOS_RETVAL_ERROR;
        }
        config = (int)strtol(p, NULL, 0);
        p = buf;

        /**
         * Read scale factor from file system
         */
        snprintf(file, sizeof(file) - 1, "%s/%s.scale", PERF_MON_EVENTS, fname);
        fd = pqos_fopen(file, "r");
        if (fd == NULL) {
                LOG_ERROR("Failed to open OS monitoring event scale file!\n");
                return PQOS_RETVAL_ERROR;
        }
        ret = fscanf(fd, "%10lf", &sf);
        pqos_fclose(fd);
        if (ret < 1) {
                LOG_ERROR("Failed to read OS monitoring event scale factor!\n");
                return PQOS_RETVAL_ERROR;
        }
        events_tab[idx].scale = sf;
        events_tab[idx].supported = 1;

        /**
         * Set event attributes
         */
        memset(&events_tab[idx].attrs, 0, sizeof(events_tab[0].attrs));
        events_tab[idx].attrs.type = os_mon_type;
        events_tab[idx].attrs.config = config;
        events_tab[idx].attrs.size = sizeof(struct perf_event_attr);
        events_tab[idx].attrs.inherit = 1;

        return PQOS_RETVAL_OK;
}

/**
 * @brief Function to detect OS support for
 *        perf events and update events table
 *
 * @return Operational status
 * @retval PQOS_RETVAL_OK on success
 */
static int
set_mon_events(void)
{
        char dir[64];
        int files, i, ret = PQOS_RETVAL_OK;
        enum pqos_mon_event events = (enum pqos_mon_event)0;
        struct dirent **namelist = NULL;

        /**
         * Read and store event data in table
         */
        snprintf(dir, sizeof(dir) - 1, "%s", PERF_MON_EVENTS);
        files = scandir(dir, &namelist, filter, NULL);
        if (files <= 0) {
                LOG_ERROR("Failed to read perf monitoring events directory!\n");
                return PQOS_RETVAL_ERROR;
        }
        /**
         * Loop through each file in the RDT perf directory
         */
        for (i = 0; i < files; i++) {
                unsigned j;
                /**
                 * Check if event exists and if
                 * so, set up event attributes
                 */
                for (j = 0; j < DIM(events_tab); j++) {
                        if ((strcmp(events_tab[j].name, namelist[i]->d_name)) !=
                            0)
                                continue;

                        if (set_rdt_event_attrs(j, namelist[i]->d_name) !=
                            PQOS_RETVAL_OK) {
                                ret = PQOS_RETVAL_ERROR;
                                goto init_pqos_events_exit;
                        }
                        events |= events_tab[j].event;
                }
        }
        /**
         * If both local and total MBM are supported
         * then remote MBM is also supported
         */
        if (events_tab[OS_MON_EVT_IDX_LMBM].supported &&
            events_tab[OS_MON_EVT_IDX_TMBM].supported) {
                events_tab[OS_MON_EVT_IDX_RMBM].supported = 1;
                events |= events_tab[OS_MON_EVT_IDX_RMBM].event;
        }
        if (events == 0) {
                LOG_ERROR("Failed to find perf monitoring events!\n");
                ret = PQOS_RETVAL_RESOURCE;
                goto init_pqos_events_exit;
        }

        all_evt_mask |= events;

init_pqos_events_exit:
        if (files > 0) {
                for (i = 0; i < files; i++)
                        free(namelist[i]);
                free(namelist);
        }
        return ret;
}

int
perf_mon_init(const struct pqos_cpuinfo *cpu, const struct pqos_cap *cap)
{
        int ret;
        unsigned i;

        ASSERT(cpu != NULL);

        UNUSED_PARAM(cpu);
        UNUSED_PARAM(cap);

        /**
         * Perf monitoring not supported
         */
        if (!pqos_file_exists(PERF_MON_SUPPORT)) {
                LOG_INFO("Perf monitoring not supported.");
                return PQOS_RETVAL_RESOURCE;

        } else {
                /* basic perf events are supported */
                events_tab[OS_MON_EVT_IDX_INST].supported = 1;
                events_tab[OS_MON_EVT_IDX_CYC].supported = 1;
                events_tab[OS_MON_EVT_IDX_IPC].supported = 1;
                events_tab[OS_MON_EVT_IDX_LLC_MISS].supported = 1;
                events_tab[OS_MON_EVT_IDX_LLC_REF].supported = 1;
        }

        ret = set_arch_event_attrs(&all_evt_mask);
        if (ret != PQOS_RETVAL_OK)
                return ret;

        /* Set RDT perf attribute type */
        ret = set_mon_type();
        if (ret != PQOS_RETVAL_OK)
                goto perf_mon_init_exit;

        /* Detect and set events */
        ret = set_mon_events();
        if (ret != PQOS_RETVAL_OK)
                return ret;

perf_mon_init_exit:
        for (i = 0; i < DIM(events_tab); i++) {
                if (!events_tab[i].supported)
                        continue;

                LOG_INFO("Detected perf monitoring support for %s\n",
                         events_tab[i].desc);
        }

        return ret;
}

int
perf_mon_fini(void)
{
        unsigned i;

        all_evt_mask = (enum pqos_mon_event)0;
        for (i = 0; i < DIM(events_tab); ++i)
                events_tab[i].supported = 0;

        return PQOS_RETVAL_OK;
}

static int *
perf_mon_get_fd(struct pqos_mon_perf_ctx *ctx, const enum pqos_mon_event event)
{
        switch (event) {
        case PQOS_MON_EVENT_L3_OCCUP:
                return &ctx->fd_llc;
        case PQOS_MON_EVENT_LMEM_BW:
                return &ctx->fd_mbl;
        case PQOS_MON_EVENT_TMEM_BW:
                return &ctx->fd_mbt;
        case PQOS_PERF_EVENT_LLC_MISS:
                return &ctx->fd_llc_misses;
        case PQOS_PERF_EVENT_LLC_REF:
                return &ctx->fd_llc_references;
        case (enum pqos_mon_event)PQOS_PERF_EVENT_CYCLES:
                return &ctx->fd_cyc;
        case (enum pqos_mon_event)PQOS_PERF_EVENT_INSTRUCTIONS:
                return &ctx->fd_inst;
        default:
                return NULL;
        }
}

int
perf_mon_start(struct pqos_mon_data *group, enum pqos_mon_event event)
{
        int i, num_ctrs;
        struct perf_mon_supported_event *se;

        ASSERT(group != NULL);
        ASSERT(group->intl != NULL);
        ASSERT(group->intl->perf.ctx != NULL);

        /**
         * Check if monitoring cores/tasks
         */
        if (group->num_cores > 0)
                num_ctrs = group->num_cores;
        else if (group->tid_nr > 0)
                num_ctrs = group->tid_nr;
        else
                return PQOS_RETVAL_ERROR;

        se = get_supported_event(event);
        if (se == NULL)
                return PQOS_RETVAL_ERROR;

        /**
         * For each core/task assign fd to read counter
         */
        for (i = 0; i < num_ctrs; i++) {
                int ret;
                struct pqos_mon_perf_ctx *ctx = &group->intl->perf.ctx[i];
                int *fd;
                int core = -1;
                pid_t tid = -1;

                if (group->num_cores > 0)
                        core = group->cores[i];
                else
                        tid = group->tid_map[i];

                fd = perf_mon_get_fd(ctx, event);
                if (fd == NULL)
                        return PQOS_RETVAL_ERROR;
                /*
                 * If monitoring cores, pass core list
                 * Otherwise, pass list of TID's
                 */
                ret = perf_setup_counter(&se->attrs, tid, core, -1, 0, fd);
                if (ret != PQOS_RETVAL_OK) {
                        LOG_ERROR("Failed to start perf "
                                  "counters for %s\n",
                                  se->desc);
                        return PQOS_RETVAL_ERROR;
                }
        }

        return PQOS_RETVAL_OK;
}

int
perf_mon_stop(struct pqos_mon_data *group, enum pqos_mon_event event)
{
        int i, num_ctrs;

        ASSERT(group != NULL);
        ASSERT(group->intl != NULL);
        ASSERT(group->intl->perf.ctx != NULL);

        /**
         * Check if monitoring cores/tasks
         */
        if (group->num_cores > 0)
                num_ctrs = group->num_cores;
        else if (group->tid_nr > 0)
                num_ctrs = group->tid_nr;
        else
                return PQOS_RETVAL_ERROR;

        /**
         * For each counter, close associated file descriptor
         */
        for (i = 0; i < num_ctrs; i++) {
                struct pqos_mon_perf_ctx *ctx = &group->intl->perf.ctx[i];
                int *fd = perf_mon_get_fd(ctx, event);

                if (fd == NULL)
                        return PQOS_RETVAL_ERROR;

                perf_shutdown_counter(*fd);
        }

        return PQOS_RETVAL_OK;
}

/**
 * @brief Gives the difference between two values with regard to the possible
 *        overrun
 *
 * @param old_value previous value
 * @param new_value current value
 * @return difference between the two values
 */
static uint64_t
get_delta(const uint64_t old_value, const uint64_t new_value)
{
        if (old_value > new_value)
                return (UINT64_MAX - old_value) + new_value;
        else
                return new_value - old_value;
}

int
perf_mon_poll(struct pqos_mon_data *group, enum pqos_mon_event event)
{
        int ret;
        int i, num_ctrs;
        uint64_t value = 0;
        uint64_t old_value;

        ASSERT(group != NULL);
        ASSERT(group->intl != NULL);
        ASSERT(group->intl->perf.ctx != NULL);

        /**
         * Check if monitoring cores/tasks
         */
        if (group->num_cores > 0)
                num_ctrs = group->num_cores;
        else if (group->tid_nr > 0)
                num_ctrs = group->tid_nr;
        else
                return PQOS_RETVAL_ERROR;

        /**
         * For each task read counter and sum of all counter values
         */
        for (i = 0; i < num_ctrs; i++) {
                struct pqos_mon_perf_ctx *ctx = &group->intl->perf.ctx[i];
                uint64_t counter_value;
                int *fd = perf_mon_get_fd(ctx, event);

                if (fd == NULL)
                        return PQOS_RETVAL_ERROR;

                ret = perf_read_counter(*fd, &counter_value);
                if (ret != PQOS_RETVAL_OK)
                        return ret;
                value += counter_value;
        }

        /**
         * Set value
         */
        switch (event) {
        case PQOS_MON_EVENT_L3_OCCUP:
                group->values.llc = value;
                break;
        case PQOS_MON_EVENT_LMEM_BW:
                old_value = group->values.mbm_local;
                group->values.mbm_local = value;
                group->values.mbm_local_delta =
                    get_delta(old_value, group->values.mbm_local);
                break;
        case PQOS_MON_EVENT_TMEM_BW:
                old_value = group->values.mbm_total;
                group->values.mbm_total = value;
                group->values.mbm_total_delta =
                    get_delta(old_value, group->values.mbm_total);
                break;
        case PQOS_PERF_EVENT_LLC_MISS:
                old_value = group->values.llc_misses;
                group->values.llc_misses = value;
                group->values.llc_misses_delta =
                    get_delta(old_value, group->values.llc_misses);
                break;
        case PQOS_PERF_EVENT_LLC_REF:
                old_value = group->values.llc_references;
                group->values.llc_references = value;
                group->values.llc_references_delta =
                    get_delta(old_value, group->values.llc_references);
                break;
        case (enum pqos_mon_event)PQOS_PERF_EVENT_CYCLES:
                old_value = group->values.ipc_unhalted;
                group->values.ipc_unhalted = value;
                group->values.ipc_unhalted_delta =
                    get_delta(old_value, group->values.ipc_unhalted);
                break;
        case (enum pqos_mon_event)PQOS_PERF_EVENT_INSTRUCTIONS:
                old_value = group->values.ipc_retired;
                group->values.ipc_retired = value;
                group->values.ipc_retired_delta =
                    get_delta(old_value, group->values.ipc_retired);
                break;
        default:
                return PQOS_RETVAL_ERROR;
        }

        return PQOS_RETVAL_OK;
}

int
perf_mon_is_event_supported(const enum pqos_mon_event event)
{
        struct perf_mon_supported_event *se = get_supported_event(event);

        if (se == NULL) {
                LOG_ERROR("Unsupported event selected\n");
                return 0;
        }
        return se->supported;
}
