pvers.h

Go to the documentation of this file.

/*
 * 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_CONF_PVERS_H__
#define __MOTR_CONF_PVERS_H__

#include "conf/obj.h"   /* m0_conf_pver_kind */
#include "conf/confc.h" /* m0_confc */

enum m0_conf_pver_state {
        M0_CPS_HEALTHY,      /* Failures == 0 */
        M0_CPS_DEGRADED,     /* Failures < K */
        M0_CPS_CRITICAL,     /* Failures == K */
        M0_CPS_DAMAGED,      /* Failures > K */
        M0_CPS_NR
};

struct m0_conf_pver_info {
        struct m0_fid            cpi_fid;

        struct m0_pdclust_attr   cpi_attr;

        enum m0_conf_pver_state  cpi_state;
};

int m0_conf_pver_status(struct m0_fid *fid,
                        struct m0_confc *confc,
                        struct m0_conf_pver_info *out_info);

M0_INTERNAL int m0_conf_pver_find(const struct m0_conf_pool *pool,
                                  const struct m0_fid *pver_to_skip,
                                  struct m0_conf_pver **out);

M0_INTERNAL int m0_conf_pver_find_by_fid(const struct m0_fid *fid,
                                         const struct m0_conf_root *root,
                                         struct m0_conf_pver **out);

M0_INTERNAL int m0_conf_pver_formulaic_find(uint32_t fpver_id,
                                            const struct m0_conf_root *root,
                                            const struct m0_conf_pver **out);

M0_INTERNAL int
m0_conf_pver_formulaic_from_virtual(const struct m0_conf_pver *virtual,
                                    const struct m0_conf_root *root,
                                    const struct m0_conf_pver **out);

M0_INTERNAL bool m0_conf_pver_is_clean(const struct m0_conf_pver *pver);

M0_INTERNAL struct m0_fid m0_conf_pver_fid(enum m0_conf_pver_kind kind,
                                           uint64_t container, uint64_t key);

M0_INTERNAL int m0_conf_pver_fid_read(const struct m0_fid *fid,
                                      enum m0_conf_pver_kind *kind,
                                      uint64_t *container, uint64_t *key);

M0_INTERNAL unsigned m0_conf_pver_level(const struct m0_conf_obj *obj);

#endif /* __MOTR_CONF_PVERS_H__ */