pdclust.h

Go to the documentation of this file.

/* -*- C -*- */
/*
 * Copyright (c) 2012-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_LAYOUT_PDCLUST_H__
#define __MOTR_LAYOUT_PDCLUST_H__

/* import */
#include "lib/arith.h" /* M0_IS_8ALIGNED */
#include "sns/parity_math.h"
#include "layout/layout.h"

#define M0_PDCLUST_SEED "upjumpandpumpim,"

struct m0_pool;

/* export */
struct m0_pdclust_attr;
struct m0_layout_pdclust_rec;
struct m0_pdclust_layout;
struct m0_pdclust_instance;
struct m0_pdclust_src_addr;
struct m0_pdclust_tgt_addr;

enum m0_pdclust_unit_type {
        M0_PUT_DATA,
        M0_PUT_PARITY,
        M0_PUT_SPARE,
        M0_PUT_NR
};

struct m0_pdclust_attr {
        uint32_t           pa_N;

        uint32_t           pa_K;

        uint32_t           pa_S;

        uint32_t           pa_P;

        uint64_t           pa_unit_size;

        struct m0_uint128  pa_seed;
};

struct m0_layout_pdclust_rec {
        uint32_t               pr_let_id;

        struct m0_pdclust_attr pr_attr;
};
M0_BASSERT(M0_IS_8ALIGNED(sizeof(struct m0_layout_pdclust_rec)));

struct m0_pdclust_layout {
        struct m0_striped_layout  pl_base;
        struct m0_pdclust_attr    pl_attr;
        uint32_t                  pl_C;
        uint32_t                  pl_L;

        uint64_t                  pl_magic;
};

struct m0_pdclust_instance {
        /* Super class, storing pointer to the layout being used. */
        struct m0_layout_instance    pi_base;
        struct tile_cache {
                uint64_t  tc_tile_no;

                uint32_t *tc_permute;

                uint32_t *tc_inverse;

                uint32_t *tc_lcode;
        } pi_tile_cache;

        uint64_t                     pi_cache_nr;
        struct m0_fd_perm_cache     *pi_perm_cache;
        struct m0_parity_math        pi_math;

        uint64_t                     pi_magic;

        struct m0_mutex              pi_mutex;
};

struct m0_pdclust_src_addr {
        uint64_t sa_group;
        uint64_t sa_unit;
};

struct m0_pdclust_tgt_addr {
        uint64_t ta_frame;
        uint64_t ta_obj;
};

M0_INTERNAL int m0_pdclust_build(struct m0_layout_domain *dom,
                                 uint64_t lid,
                                 const struct m0_pdclust_attr *attr,
                                 struct m0_layout_enum *le,
                                 struct m0_pdclust_layout **out);

M0_INTERNAL bool m0_pdclust_attr_check(const struct m0_pdclust_attr *attr);
M0_INTERNAL uint32_t m0_pdclust_N(const struct m0_pdclust_layout *pl);
M0_INTERNAL uint32_t m0_pdclust_K(const struct m0_pdclust_layout *pl);
M0_INTERNAL uint32_t m0_pdclust_S(const struct m0_pdclust_layout *pl);
M0_INTERNAL uint32_t m0_pdclust_P(const struct m0_pdclust_layout *pl);
M0_INTERNAL uint32_t m0_pdclust_size(const struct m0_pdclust_layout *pl);
M0_INTERNAL uint64_t m0_pdclust_unit_size(const struct m0_pdclust_layout *pl);

M0_INTERNAL struct m0_pdclust_layout *m0_layout_to_pdl(const struct m0_layout
                                                       *l);

M0_INTERNAL struct m0_layout *m0_pdl_to_layout(struct m0_pdclust_layout *pl);

M0_INTERNAL enum m0_pdclust_unit_type
m0_pdclust_unit_classify(const struct m0_pdclust_layout *play, int unit);

M0_INTERNAL struct m0_pdclust_instance *
m0_layout_instance_to_pdi(const struct m0_layout_instance *li);

M0_INTERNAL void m0_pdclust_instance_map(struct m0_pdclust_instance *pi,
                                         const struct m0_pdclust_src_addr *src,
                                         struct m0_pdclust_tgt_addr *tgt);
M0_INTERNAL void m0_pdclust_instance_inv(struct m0_pdclust_instance *pi,
                                         const struct m0_pdclust_tgt_addr *tgt,
                                         struct m0_pdclust_src_addr *src);

M0_INTERNAL int m0_pdclust_perm_cache_build(struct m0_layout *layout,
                                            struct m0_pdclust_instance *pi);

M0_INTERNAL void m0_pdclust_perm_cache_destroy(struct m0_layout *layout,
                                               struct m0_pdclust_instance *pi);

M0_INTERNAL bool m0_pdclust_is_replicated(struct m0_pdclust_layout *play);
extern struct m0_layout_type m0_pdclust_layout_type;

M0_EXTERN const struct m0_pdclust_src_addr M0_PDCLUST_SRC_NULL;

/* __MOTR_LAYOUT_PDCLUST_H__ */
#endif

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