ocf_trace.h

/*
 * Copyright(c) 2012-2020 Intel Corporation
 * SPDX-License-Identifier: BSD-3-Clause-Clear
 */

#ifndef __OCF_TRACE_H__
#define __OCF_TRACE_H__

#include "ocf_def.h"
#include "ocf_types.h"

typedef uint64_t log_sid_t;

#define OCF_EVENT_VERSION       1
#define OCF_TRACING_STOP        1

typedef enum {
        ocf_event_type_cache_desc,

        ocf_event_type_core_desc,

        ocf_event_type_io,

        ocf_event_type_io_cmpl,

        ocf_event_type_io_file,
} ocf_event_type;

struct ocf_event_hdr {
        log_sid_t sid;

        uint64_t timestamp;

        ocf_event_type type;

        uint32_t size;
};

struct ocf_event_cache_desc {
        struct ocf_event_hdr hdr;

        const char *name;

        ocf_cache_line_size_t cache_line_size;

        ocf_cache_mode_t cache_mode;

        uint64_t cache_size;

        uint32_t cores_no;

        uint32_t version;
};

struct ocf_event_core_desc {
        struct ocf_event_hdr hdr;

        const char *name;

        uint64_t core_size;
};

typedef enum {
        ocf_event_operation_rd = 'R',

        ocf_event_operation_wr = 'W',

        ocf_event_operation_flush = 'F',

        ocf_event_operation_discard = 'D',
} ocf_event_operation_t;

struct ocf_event_io {
        struct ocf_event_hdr hdr;

        uint64_t addr;

        uint32_t len;

        uint32_t io_class;

        const char *core_name;

        ocf_event_operation_t operation;
};

struct ocf_event_io_cmpl {
        struct ocf_event_hdr hdr;

        log_sid_t rsid;

        bool is_hit;
};


typedef void (*ocf_trace_callback_t)(ocf_cache_t cache, void *trace_ctx,
                ocf_queue_t queue, const void* trace, const uint32_t size);

int ocf_mngt_start_trace(ocf_cache_t cache, void *trace_ctx,
                ocf_trace_callback_t trace_callback);

int ocf_mngt_stop_trace(ocf_cache_t cache);

#endif /* __OCF_TRACE_H__ */