di.h

Go to the documentation of this file.

/* -*- C -*- */
/*
 * Copyright (c) 2013-2020 Seagate Technology LLC and/or its Affiliates
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * For any questions about this software or licensing,
 * please email opensource@seagate.com or cortx-questions@seagate.com.
 *
 */


#pragma once

#ifndef __MOTR_FILE_DI_H__
#define __MOTR_FILE_DI_H__

#include "lib/types.h"
#include "lib/vec.h"
#include "ioservice/io_fops.h"

struct m0_file;

struct m0_di_type {
        const char *dt_name;
};

enum m0_di_checksum_len {
        M0_DI_CRC32_LEN = 1,
        M0_DI_ELEMENT_SIZE = 64,
};

enum m0_di_types {
        M0_DI_NONE,
        M0_DI_CRC32_4K,
        M0_DI_CRC32_64K,
        M0_DI_T10_DIF,
        M0_DI_NR
};

enum {
        M0_DI_DEFAULT_TYPE =
#ifdef ENABLE_DATA_INTEGRITY
                M0_DI_CRC32_4K
#else
                M0_DI_NONE
#endif
};

struct m0_di_ops {
        const struct m0_di_type *do_type;
        uint64_t    (*do_mask)     (const struct m0_file *file);
        uint64_t    (*do_in_shift) (const struct m0_file *file);
        uint64_t    (*do_out_shift)(const struct m0_file *file);
        void        (*do_sum)      (const struct m0_file *file,
                                    const struct m0_indexvec *io_info,
                                    const struct m0_bufvec *in,
                                    struct m0_bufvec *out);
        bool        (*do_check)    (const struct m0_file *file,
                                    const struct m0_indexvec *io_info,
                                    const struct m0_bufvec *in,
                                    const struct m0_bufvec *out);
};

M0_INTERNAL const struct m0_di_ops *m0_di_ops_get(enum m0_di_types di_type);

M0_INTERNAL void m0_md_di_set(void *addr, m0_bcount_t nob,
                              uint64_t *cksum_field);

M0_INTERNAL bool m0_md_di_chk(void *addr, m0_bcount_t nob,
                              uint64_t *cksum_field);

#define M0_MD_DI_SET(obj, field)                           \
({                                                         \
        void *__obj = (obj);                               \
        m0_md_di_set(__obj, sizeof *(obj), &__obj->field); \
})

#define M0_MD_DI_CHK(obj, field)                           \
({                                                         \
        void *__obj = (obj);                               \
        m0_md_di_chk(__obj, sizeof *(obj), &__obj->field); \
})

M0_INTERNAL void m0_crc32(const void *data, uint64_t len,
                          uint64_t *cksum);

M0_INTERNAL bool m0_crc32_chk(const void *data, uint64_t len,
                              const uint64_t *cksum);

M0_INTERNAL m0_bcount_t m0_di_size_get(const struct m0_file *file,
                                       const m0_bcount_t size);

#endif /* __MOTR_FILE_DI_H__ */

/*
 *  Local variables:
 *  c-indentation-style: "K&R"
 *  c-basic-offset: 8
 *  tab-width: 8
 *  fill-column: 79
 *  scroll-step: 1
 *  End:
 */