ocf_core.h

Go to the documentation of this file.

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

#ifndef __OCF_CORE_H__
#define __OCF_CORE_H__

#include "ocf_volume.h"
#include "ocf_io.h"
#include "ocf_mngt.h"

struct ocf_core_info {
        uint64_t core_size;

        uint64_t core_size_bytes;

        struct {
                uint32_t flushed;

                uint32_t dirty;
        };

        uint32_t dirty_for;

        uint32_t seq_cutoff_threshold;

        ocf_seq_cutoff_policy seq_cutoff_policy;
};

int ocf_core_get_by_name(ocf_cache_t cache, const char *name, size_t name_len,
                ocf_core_t *core);

ocf_cache_t ocf_core_get_cache(ocf_core_t core);

ocf_volume_t ocf_core_get_volume(ocf_core_t core);

ocf_volume_t ocf_core_get_front_volume(ocf_core_t core);

static inline const struct ocf_volume_uuid *ocf_core_get_uuid(ocf_core_t core)
{
        return ocf_volume_get_uuid(ocf_core_get_volume(core));
}

uint32_t ocf_core_get_seq_cutoff_threshold(ocf_core_t core);

ocf_seq_cutoff_policy ocf_core_get_seq_cutoff_policy(ocf_core_t core);

const char *ocf_core_get_name(ocf_core_t core);

ocf_core_state_t ocf_core_get_state(ocf_core_t core);

static inline struct ocf_io *ocf_core_new_io(ocf_core_t core, ocf_queue_t queue,
                uint64_t addr, uint32_t bytes, uint32_t dir,
                uint32_t io_class, uint64_t flags)
{
        ocf_volume_t volume = ocf_core_get_front_volume(core);

        return ocf_volume_new_io(volume, queue, addr, bytes, dir,
                        io_class, flags);
}

static inline void ocf_core_submit_io(struct ocf_io *io)
{
        ocf_volume_submit_io(io);
}

int ocf_core_submit_io_fast(struct ocf_io *io);

static inline void ocf_core_submit_flush(struct ocf_io *io)
{
        ocf_volume_submit_flush(io);
}

static inline void ocf_core_submit_discard(struct ocf_io *io)
{
        ocf_volume_submit_discard(io);
}

typedef int (*ocf_core_visitor_t)(ocf_core_t core, void *cntx);

int ocf_core_visit(ocf_cache_t cache, ocf_core_visitor_t visitor, void *cntx,
                bool only_opened);

int ocf_core_get_info(ocf_core_t core, struct ocf_core_info *info);

void ocf_core_set_priv(ocf_core_t core, void *priv);

void *ocf_core_get_priv(ocf_core_t core);

#endif /* __OCF_CORE_H__ */