ocf_cache.h

Go to the documentation of this file.

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


#ifndef __OCF_CACHE_H__
#define __OCF_CACHE_H__

#include "ocf_volume.h"
#include "ocf_ctx.h"
#include "ocf_def.h"
#include "ocf_stats.h"

struct ocf_cache_info {
        bool attached;
        uint8_t volume_type;
        uint32_t size;
        /* Statistics of inactive cores */
        struct {
                struct ocf_stat occupancy;
                struct ocf_stat clean;
                struct ocf_stat dirty;
        } inactive;

        uint32_t occupancy;
        uint32_t dirty;
        uint32_t dirty_initial;
        uint32_t dirty_for;
        ocf_cache_mode_t cache_mode;
        /* Statistics of fallback Pass Through */
        struct {
                int error_counter;
                bool status;
        } fallback_pt;

        uint8_t state;
        ocf_eviction_t eviction_policy;
        ocf_cleaning_t cleaning_policy;
        ocf_promotion_t promotion_policy;
        ocf_cache_line_size_t cache_line_size;
        uint32_t flushed;
        uint32_t core_count;
        uint64_t metadata_footprint;
        uint32_t metadata_end_offset;
};

ocf_volume_t ocf_cache_get_volume(ocf_cache_t cache);

const char *ocf_cache_get_name(ocf_cache_t cache);

bool ocf_cache_is_incomplete(ocf_cache_t cache);

bool ocf_cache_is_device_attached(ocf_cache_t cache);

bool ocf_cache_is_running(ocf_cache_t cache);

ocf_cache_mode_t ocf_cache_get_mode(ocf_cache_t cache);

ocf_cache_line_size_t ocf_cache_get_line_size(ocf_cache_t cache);

uint64_t ocf_cache_bytes_2_lines(ocf_cache_t cache, uint64_t bytes);

uint32_t ocf_cache_get_core_count(ocf_cache_t cache);

int ocf_cache_get_info(ocf_cache_t cache, struct ocf_cache_info *info);

const struct ocf_volume_uuid *ocf_cache_get_uuid(ocf_cache_t cache);

ocf_ctx_t ocf_cache_get_ctx(ocf_cache_t cache);

uint8_t ocf_cache_get_type_id(ocf_cache_t cache);

void ocf_cache_set_priv(ocf_cache_t cache, void *priv);

void *ocf_cache_get_priv(ocf_cache_t cache);

#endif /* __OCF_CACHE_H__ */