ocf_metadata.h

Go to the documentation of this file.

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

#ifndef __OCF_METADATA_H__
#define __OCF_METADATA_H__

struct ocf_atomic_metadata {
        uint64_t core_line : 46;

        uint32_t core_seq_no : 16;

        uint32_t valid : 1;

        uint32_t dirty : 1;
} __attribute__((packed));

#define OCF_ATOMIC_METADATA_SIZE        sizeof(struct ocf_atomic_metadata)

int ocf_metadata_get_atomic_entry(ocf_cache_t cache, uint64_t addr,
                struct ocf_atomic_metadata *entry);

struct ocf_metadata_probe_status {
        bool clean_shutdown;

        bool cache_dirty;

        char cache_name[OCF_CACHE_NAME_SIZE];
};

typedef void (*ocf_metadata_probe_end_t)(void *priv, int error,
                struct ocf_metadata_probe_status *status);

void ocf_metadata_probe(ocf_ctx_t ctx, ocf_volume_t volume,
                ocf_metadata_probe_end_t cmpl, void *priv);

typedef void (*ocf_metadata_probe_cores_end_t)(void *priv, int error,
                unsigned int num_cores);

void ocf_metadata_probe_cores(ocf_ctx_t ctx, ocf_volume_t volume,
                struct ocf_volume_uuid *uuids, uint32_t uuid_count,
                ocf_metadata_probe_cores_end_t cmpl, void *priv);

int ocf_metadata_check_invalid_before(ocf_cache_t cache, uint64_t addr);

int ocf_metadata_check_invalid_after(ocf_cache_t cache, uint64_t addr,
                uint32_t bytes);

#endif /* __OCF_METADATA_H__ */