cm.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_DIX_CM_H__
#define __MOTR_DIX_CM_H__


#include "lib/chan.h"     /* m0_clink */
#include "cm/cm.h"
#include "cm/repreb/cm.h"
#include "dix/cm/iter.h"

/* Import */
enum m0_pool_nd_state;
struct m0_pdclust_layout;

#define M0_DIX_CM_TYPE_DECLARE(cmtype, id, ops, name, typecode) \
M0_CM_TYPE_DECLARE(cmtype, id, ops, name, typecode);            \
M0_INTERNAL struct m0_dix_cm_type cmtype ## _dcmt = {           \
        .dct_base = &cmtype ## _cmt,                            \
}

struct m0_dix_cm_type {
        struct m0_cm_type  *dct_base;
        struct m0_fom_type  dct_iter_fomt;
};

struct m0_dix_cm_stats {
        uint64_t dcs_read_size;
        uint64_t dcs_write_size;
};

struct m0_dix_cm {
        /* Base copy machine context. */
        struct m0_cm           dcm_base;

        /* DIX copy machine specific type. */
        struct m0_dix_cm_type *dcm_type;

        enum m0_cm_op          dcm_op;

        struct m0_dix_cm_iter  dcm_it;

        m0_time_t              dcm_start_time;

        m0_time_t              dcm_stop_time;

        int                    dcm_stats_key;

        bool                   dcm_iter_inprogress;

        bool                   dcm_cp_in_progress;

        struct m0_clink        dcm_proxies_completed;

        int                    dcm_processed_nr;
        uint64_t               dcm_recs_nr;

        uint64_t               dcm_magic;
};

M0_EXTERN const struct m0_cm_cp_ops m0_dix_cm_repair_cp_ops;
M0_EXTERN const struct m0_cm_cp_ops m0_dix_cm_rebalance_cp_ops;
M0_EXTERN struct m0_cm_type     dix_repair_cmt;
M0_EXTERN struct m0_cm_type     dix_rebalance_cmt;
M0_EXTERN struct m0_dix_cm_type dix_repair_dcmt;
M0_EXTERN struct m0_dix_cm_type dix_rebalance_dcmt;

M0_INTERNAL int m0_dix_cm_type_register(void);
M0_INTERNAL void m0_dix_cm_type_deregister(void);

M0_INTERNAL struct m0_dix_cm *cm2dix(struct m0_cm *cm);

M0_INTERNAL int m0_dix_cm_prepare(struct m0_cm *cm);

M0_INTERNAL void m0_dix_cm_stop(struct m0_cm *cm);

M0_INTERNAL int m0_dix_cm_setup(struct m0_cm *cm);

M0_INTERNAL int m0_dix_cm_start(struct m0_cm *cm);

M0_INTERNAL void m0_dix_cm_fini(struct m0_cm *cm);

M0_INTERNAL void m0_dix_cm_svc_fini(struct m0_reqh_service *service);

M0_INTERNAL enum dix_repair_state
m0_dix_cm_fid_repair_done(struct m0_fid *gfid, struct m0_reqh *reqh,
                          enum m0_pool_nd_state device_state);

M0_INTERNAL void m0_dix_cm_repair_trigger_fop_init(void);
M0_INTERNAL void m0_dix_cm_repair_trigger_fop_fini(void);

M0_INTERNAL void m0_dix_cm_rebalance_trigger_fop_init(void);
M0_INTERNAL void m0_dix_cm_rebalance_trigger_fop_fini(void);

M0_INTERNAL void m0_dix_repair_sw_onwire_fop_init(void);
M0_INTERNAL void m0_dix_repair_sw_onwire_fop_fini(void);

M0_INTERNAL void m0_dix_rebalance_sw_onwire_fop_init(void);
M0_INTERNAL void m0_dix_rebalance_sw_onwire_fop_fini(void);

M0_INTERNAL int m0_dix_get_space_for(struct m0_cm             *cm,
                                     const struct m0_cm_ag_id *id,
                                     size_t                   *count);

M0_INTERNAL int m0_dix_cm_data_next(struct m0_cm *cm, struct m0_cm_cp *cp);

M0_INTERNAL int m0_dix_cm_ag_next(struct m0_cm             *cm,
                                  const struct m0_cm_ag_id *id_curr,
                                  struct m0_cm_ag_id       *id_next);

M0_INTERNAL bool m0_dix_is_peer(struct m0_cm               *cm,
                                struct m0_reqh_service_ctx *ctx);

M0_INTERNAL struct m0_reqh *m0_dix_cm2reqh(const struct m0_dix_cm *dcm);

#endif /* __MOTR_DIX_CM_H__ */

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