ocf_volume.h

Go to the documentation of this file.

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

#ifndef __OCF_VOLUME_H__
#define __OCF_VOLUME_H__

#include "ocf_types.h"
#include "ocf_env_headers.h"
#include "ocf/ocf_err.h"

struct ocf_io;

#define OCF_VOLUME_UUID_MAX_SIZE        (4096UL - sizeof(uint32_t))

struct ocf_volume_uuid {
        size_t size;
        void *data;
};

struct ocf_volume_caps {
        uint32_t atomic_writes : 1;
};

struct ocf_volume_ops {
        void (*submit_io)(struct ocf_io *io);

        void (*submit_flush)(struct ocf_io *io);

        void (*submit_metadata)(struct ocf_io *io);

        void (*submit_discard)(struct ocf_io *io);

        void (*submit_write_zeroes)(struct ocf_io *io);

        int (*open)(ocf_volume_t volume, void *volume_params);

        void (*close)(ocf_volume_t volume);

        unsigned int (*get_max_io_size)(ocf_volume_t volume);

        uint64_t (*get_length)(ocf_volume_t volume);
};

struct ocf_volume_properties {
        const char *name;
        uint32_t io_priv_size;
        uint32_t volume_priv_size;
        struct ocf_volume_caps caps;
        struct ocf_volume_ops ops;
        struct ocf_io_ops io_ops;
        void (*deinit)(void);
};

int ocf_uuid_set_str(ocf_uuid_t uuid, char *str);

static inline const char *ocf_uuid_to_str(const struct ocf_volume_uuid *uuid)
{
        return (const char *)uuid->data;
}

int ocf_volume_init(ocf_volume_t volume, ocf_volume_type_t type,
                struct ocf_volume_uuid *uuid, bool uuid_copy);

void ocf_volume_deinit(ocf_volume_t volume);

int ocf_volume_create(ocf_volume_t *volume, ocf_volume_type_t type,
                struct ocf_volume_uuid *uuid);

void ocf_volume_destroy(ocf_volume_t volume);

ocf_volume_type_t ocf_volume_get_type(ocf_volume_t volume);

const struct ocf_volume_uuid *ocf_volume_get_uuid(ocf_volume_t volume);

void *ocf_volume_get_priv(ocf_volume_t volume);

ocf_cache_t ocf_volume_get_cache(ocf_volume_t volume);

int ocf_volume_is_atomic(ocf_volume_t volume);

struct ocf_io *ocf_volume_new_io(ocf_volume_t volume, ocf_queue_t queue,
                uint64_t addr, uint32_t bytes, uint32_t dir,
                uint32_t io_class, uint64_t flags);


void ocf_volume_submit_io(struct ocf_io *io);

void ocf_volume_submit_flush(struct ocf_io *io);

void ocf_volume_submit_discard(struct ocf_io *io);

int ocf_volume_open(ocf_volume_t volume, void *volume_params);

void ocf_volume_close(ocf_volume_t volume);

unsigned int ocf_volume_get_max_io_size(ocf_volume_t volume);

uint64_t ocf_volume_get_length(ocf_volume_t volume);

#endif /* __OCF_VOLUME_H__ */