fd.h

Go to the documentation of this file.

/* -*- C -*- */
/*
 * Copyright (c) 2015-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_FD_H__
#define __MOTR_FD_H__

#include "layout/pdclust.h"
#include "conf/obj.h"        /* M0_CONF_PVER_HEIGHT */

/* import */
struct m0_pdclust_src_addr;
struct m0_confc;
struct m0_poolmach;
struct m0_pool_version;

struct m0_fd_tile_cell {
        struct m0_pdclust_tgt_addr ftc_tgt;
        struct m0_pdclust_src_addr ftc_src;
};

struct m0_fd_tile {
        uint64_t                ft_rows;
        uint64_t                ft_cols;
        uint64_t                ft_G;
        uint64_t                ft_depth;
        uint64_t                ft_child[M0_CONF_PVER_HEIGHT];
        struct m0_fd_tile_cell *ft_cell;
};

struct m0_fd_perm_cache {
        uint64_t        fpc_magic;
        uint64_t        fpc_omega;
        struct m0_fid   fpc_gfid;
        /* Length of a permutation. */
        uint32_t        fpc_len;
        uint64_t       *fpc_lcode;
        uint64_t       *fpc_permute;
        uint64_t       *fpc_inverse;
};

struct m0_fd_cache_info {
        uint64_t  fci_nr;
        uint64_t *fci_info;
};

struct m0_fd_tree {
        uint16_t                ft_depth;
        struct m0_fd_tree_node *ft_root;
        struct m0_tl            ft_perm_cache;
        uint64_t                ft_cnt;
        struct m0_fd_cache_info ft_cache_info;
};

struct m0_fd_tree_node {
        /* A pointer to parent of a node. */
        struct m0_fd_tree_node  *ftn_parent;
        /* Level at which node resides in a tree. */
        uint16_t                 ftn_depth;
        /* Number of children a node has. */
        uint32_t                 ftn_child_nr;
        /* Index within siblings of a node. */
        uint32_t                 ftn_rel_idx;
        /* Index, when all nodes of the level ftn_depth are enumerated. */
        uint32_t                 ftn_abs_idx;
        /* An array of pointers to children. */
        struct m0_fd_tree_node **ftn_children;
        enum m0_ha_obj_state     ftn_ha_state;
};

M0_INTERNAL int m0_fd_tolerance_check(struct m0_conf_pver *pv,
                                      uint32_t *failure_level);
M0_INTERNAL int m0_fd_tile_build(const struct m0_conf_pver *pv,
                                 struct m0_pool_version *pool_ver,
                                 uint32_t *failure_level);

M0_INTERNAL void m0_fd_tile_destroy(struct m0_fd_tile *tile);

M0_INTERNAL void m0_fd_src_to_tgt(const struct m0_fd_tile *tile,
                                  const struct m0_pdclust_src_addr *src,
                                  struct m0_pdclust_tgt_addr *tgt);
M0_INTERNAL void m0_fd_tgt_to_src(const struct m0_fd_tile *tile,
                                  const struct m0_pdclust_tgt_addr *tgt,
                                  struct m0_pdclust_src_addr *src);

M0_INTERNAL int m0_fd_tree_build(const struct m0_conf_pver *pv,
                                 struct m0_fd_tree *tree);

M0_INTERNAL void m0_fd_tree_destroy(struct m0_fd_tree *tree);


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

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

M0_INTERNAL int m0_fd_perm_cache_init(struct m0_fd_perm_cache *cache,
                                      uint64_t len);

M0_INTERNAL void m0_fd_perm_cache_fini(struct m0_fd_perm_cache *cache);

/* __MOTR_LAYOUT_FD_H__ */
#endif

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