ocf_ctx.h

Go to the documentation of this file.

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

#ifndef __OCF_CTX_H__
#define __OCF_CTX_H__

#include "ocf_volume.h"
#include "ocf_logger.h"

typedef enum {
        ctx_data_seek_begin,
        ctx_data_seek_current,
} ctx_data_seek_t;

struct ocf_data_ops {
        ctx_data_t *(*alloc)(uint32_t pages);

        void (*free)(ctx_data_t *data);

        int (*mlock)(ctx_data_t *data);

        void (*munlock)(ctx_data_t *data);

        uint32_t (*read)(void *dst, ctx_data_t *src, uint32_t size);

        uint32_t (*write)(ctx_data_t *dst, const void *src, uint32_t size);

        uint32_t (*zero)(ctx_data_t *dst, uint32_t size);

        uint32_t (*seek)(ctx_data_t *dst, ctx_data_seek_t seek, uint32_t size);

        uint64_t (*copy)(ctx_data_t *dst, ctx_data_t *src,
                        uint64_t to, uint64_t from, uint64_t bytes);

        void (*secure_erase)(ctx_data_t *dst);
};

struct ocf_cleaner_ops {
        int (*init)(ocf_cleaner_t c);

        void (*kick)(ocf_cleaner_t c);

        void (*stop)(ocf_cleaner_t c);
};

struct ocf_metadata_updater_ops {
        int (*init)(ocf_metadata_updater_t mu);

        void (*kick)(ocf_metadata_updater_t mu);

        void (*stop)(ocf_metadata_updater_t mu);
};

struct ocf_ctx_ops {
        /* Context data operations */
        struct ocf_data_ops data;

        /* Cleaner operations */
        struct ocf_cleaner_ops cleaner;

        /* Metadata updater operations */
        struct ocf_metadata_updater_ops metadata_updater;

        /* Logger operations */
        struct ocf_logger_ops logger;
};

struct ocf_ctx_config {
        /* Context name */
        const char *name;

        /* Context operations */
        const struct ocf_ctx_ops ops;

        /* Context logger priv */
        void *logger_priv;
};

int ocf_ctx_register_volume_type(ocf_ctx_t ctx, uint8_t type_id,
                const struct ocf_volume_properties *properties);

void ocf_ctx_unregister_volume_type(ocf_ctx_t ctx, uint8_t type_id);

ocf_volume_type_t ocf_ctx_get_volume_type(ocf_ctx_t ctx, uint8_t type_id);

int ocf_ctx_get_volume_type_id(ocf_ctx_t ctx, ocf_volume_type_t type);

int ocf_ctx_volume_create(ocf_ctx_t ctx, ocf_volume_t *volume,
                struct ocf_volume_uuid *uuid, uint8_t type_id);

int ocf_ctx_create(ocf_ctx_t *ctx, const struct ocf_ctx_config *cfg);

void ocf_ctx_get(ocf_ctx_t ctx);

void ocf_ctx_put(ocf_ctx_t ctx);

#endif /* __OCF_CTX_H__ */