layout.h

Go to the documentation of this file.

/* -*- C -*- */
/*
 * Copyright (c) 2016-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_DIX_LAYOUT_H__
#define __MOTR_DIX_LAYOUT_H__

#include "lib/types.h"
#include "fid/fid.h"
#include "fid/fid_xc.h"
#include "dix/imask.h"
#include "dix/imask_xc.h"
#include "lib/buf.h"
#include "lib/types_xc.h"

/* Import */
struct m0_pdclust_layout;
struct m0_pdclust_instance;
struct m0_pool_version;
struct m0_layout_domain;

enum dix_layout_type {
        DIX_LTYPE_UNKNOWN,
        DIX_LTYPE_ID,
        DIX_LTYPE_DESCR,
        DIX_LTYPE_COMPOSITE_DESCR,
        DIX_LTYPE_CAPTURE_DESCR,
};

enum m0_dix_hash_fnc_type {
        HASH_FNC_NONE,
        HASH_FNC_FNV1,
        HASH_FNC_CITY
};

struct m0_dix_ldesc {
        uint32_t            ld_hash_fnc;
        struct m0_fid       ld_pver;
        struct m0_dix_imask ld_imask;
} M0_XCA_RECORD M0_XCA_DOMAIN(rpc);

struct m0_dix_capture_ldesc {
        struct m0_uint128 ca_orig_id;
        struct m0_fid     ca_pver;
        uint64_t          ca_lid;
} M0_XCA_RECORD M0_XCA_DOMAIN(rpc);

struct m0_dix_composite_layer {
        struct m0_uint128 cr_subobj;
        uint64_t          cr_lid;
        int               cr_priority;
} M0_XCA_RECORD M0_XCA_DOMAIN(rpc);

struct m0_dix_composite_ldesc {
        int                            cld_nr_layers;
        struct m0_dix_composite_layer *cld_layers;
} M0_XCA_SEQUENCE M0_XCA_DOMAIN(rpc);

struct m0_dix_layout {
        uint32_t dl_type;
        union {
                uint64_t                      dl_id
                                        M0_XCA_TAG("DIX_LTYPE_ID");
                struct m0_dix_ldesc           dl_desc
                                        M0_XCA_TAG("DIX_LTYPE_DESCR");
                struct m0_dix_capture_ldesc   dl_cap_desc
                                        M0_XCA_TAG("DIX_LTYPE_CAPTURE_DESCR");
                struct m0_dix_composite_ldesc dl_comp_desc
                                        M0_XCA_TAG("DIX_LTYPE_COMPOSITE_DESCR");
        } u;
} M0_XCA_UNION M0_XCA_DOMAIN(rpc);

struct m0_dix_linst {
        struct m0_dix_ldesc        *li_ldescr;
        struct m0_pdclust_layout   *li_pl;
        struct m0_pdclust_instance *li_pi;
};

struct m0_dix_layout_iter {
        struct m0_dix_linst dit_linst;

        uint32_t            dit_W;

        uint64_t            dit_unit;

        struct m0_buf       dit_key;
};

M0_INTERNAL void m0_dix_target(struct m0_dix_linst *inst,
                               uint64_t             unit,
                               struct m0_buf       *key,
                               uint64_t            *out_id);

M0_INTERNAL uint32_t m0_dix_devices_nr(struct m0_dix_linst *linst);

M0_INTERNAL struct m0_pooldev *m0_dix_tgt2sdev(struct m0_dix_linst *linst,
                                               uint64_t             tgt);

M0_INTERNAL int m0_dix_layout_init(struct m0_dix_linst     *dli,
                                   struct m0_layout_domain *domain,
                                   const struct m0_fid     *fid,
                                   uint64_t                 layout_id,
                                   struct m0_pool_version  *pver,
                                   struct m0_dix_ldesc     *dld);

M0_INTERNAL void m0_dix_layout_fini(struct m0_dix_linst *dli);

M0_INTERNAL int m0_dix_ldesc_init(struct m0_dix_ldesc       *ld,
                                  struct m0_ext             *range,
                                  m0_bcount_t                range_nr,
                                  enum m0_dix_hash_fnc_type  htype,
                                  struct m0_fid             *pver);

M0_INTERNAL int m0_dix_ldesc_copy(struct m0_dix_ldesc       *dst,
                                  const struct m0_dix_ldesc *src);

M0_INTERNAL void m0_dix_ldesc_fini(struct m0_dix_ldesc *ld);

M0_INTERNAL
int m0_dix_layout_iter_init(struct m0_dix_layout_iter *iter,
                            const struct m0_fid       *index,
                            struct m0_layout_domain   *ldom,
                            struct m0_pool_version    *pver,
                            struct m0_dix_ldesc       *ldesc,
                            struct m0_buf             *key);

M0_INTERNAL void m0_dix_layout_iter_next(struct m0_dix_layout_iter *iter,
                                         uint64_t                  *tgt);

M0_INTERNAL void m0_dix_layout_iter_goto(struct m0_dix_layout_iter *iter,
                                         uint64_t                   unit_nr);
M0_INTERNAL void m0_dix_layout_iter_reset(struct m0_dix_layout_iter *iter);

M0_INTERNAL void m0_dix_layout_iter_get_at(struct m0_dix_layout_iter *iter,
                                           uint64_t                   unit,
                                           uint64_t                  *tgt);

M0_INTERNAL uint32_t m0_dix_liter_N(struct m0_dix_layout_iter *iter);

M0_INTERNAL uint32_t m0_dix_liter_P(struct m0_dix_layout_iter *iter);

M0_INTERNAL uint32_t m0_dix_liter_K(struct m0_dix_layout_iter *iter);

M0_INTERNAL uint32_t m0_dix_liter_S(struct m0_dix_layout_iter *iter);

M0_INTERNAL uint32_t m0_dix_liter_W(struct m0_dix_layout_iter *iter);

M0_INTERNAL uint32_t m0_dix_liter_spare_offset(struct m0_dix_layout_iter *iter);

M0_INTERNAL
uint32_t m0_dix_liter_unit_classify(struct m0_dix_layout_iter *iter,
                                    uint64_t                   unit);

M0_INTERNAL void m0_dix_layout_iter_fini(struct m0_dix_layout_iter *iter);

M0_INTERNAL bool m0_dix_layout_eq(const struct m0_dix_layout *layout1,
                                  const struct m0_dix_layout *layout2);

#endif /* __MOTR_DIX_LAYOUT_H__ */

/*
 *  Local variables:
 *  c-indentation-style: "K&R"
 *  c-basic-offset: 8
 *  tab-width: 8
 *  fill-column: 80
 *  scroll-step: 1
 *  End:
 */
/*
 * vim: tabstop=8 shiftwidth=8 noexpandtab textwidth=80 nowrap
 */