cp.h

Go to the documentation of this file.

/* -*- C -*- */
/*
 * Copyright (c) 2017-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_CP_H__
#define __MOTR_DIX_CM_CP_H__

#include "fid/fid.h"           /* m0_fid */
#include "fop/fom_long_lock.h" /* m0_long_lock_link */
#include "rpc/at.h"            /* m0_rpc_at_buf */
#include "cas/ctg_store.h"     /* m0_ctg_op */
#include "cm/cp.h"             /* m0_cm_cp */

/* Import */
struct m0_fom;
struct m0_cm;

extern const struct m0_cm_cp_ops m0_dix_cm_repair_cp_ops;
extern const struct m0_cm_cp_ops m0_dix_cm_rebalance_cp_ops;

struct m0_dix_cm_cp {
        struct m0_cm_cp             dc_base;

        struct m0_fid               dc_ctg_fid;

        bool                       dc_is_local;

        struct m0_ctg_op           dc_ctg_op;

        int                        dc_ctg_op_rc;

        uint32_t                   dc_ctg_op_flags;

        struct m0_cas_ctg         *dc_ctg;

        struct m0_long_lock_link   dc_ctg_lock;
        struct m0_long_lock_link   dc_meta_lock;

        struct m0_long_lock_addb2  dc_ctg_lock_addb2;
        struct m0_long_lock_addb2  dc_meta_lock_addb2;

        int                        dc_phase_transmit;

        struct m0_buf              dc_key;
        struct m0_buf              dc_val;
};

enum m0_dix_cm_phase_transmit {
        DCM_PT_KEY = 0,
        DCM_PT_VAL,
        DCM_PT_NR
};

M0_INTERNAL struct m0_dix_cm_cp *cp2dixcp(const struct m0_cm_cp *cp);

M0_INTERNAL uint64_t m0_dix_cm_cp_home_loc_helper(const struct m0_cm_cp *cp);

M0_INTERNAL struct m0_cm *cpfom2cm(struct m0_fom *fom);

M0_INTERNAL bool m0_dix_cm_cp_invariant(const struct m0_cm_cp *cp);

M0_INTERNAL struct m0_cm_cp *m0_dix_cm_cp_alloc(struct m0_cm *cm);

M0_INTERNAL int m0_dix_cm_cp_init(struct m0_cm_cp *cp);

M0_INTERNAL int m0_dix_cm_cp_fail(struct m0_cm_cp    *cp,
                                  struct m0_fop_type *ft);

M0_INTERNAL int m0_dix_cm_cp_read(struct m0_cm_cp *cp);

M0_INTERNAL int m0_dix_cm_cp_xform(struct m0_cm_cp *cp);

M0_INTERNAL int m0_dix_cm_cp_write(struct m0_cm_cp *cp);

M0_INTERNAL int m0_dix_cm_cp_write_pre(struct m0_cm_cp *cp);

M0_INTERNAL int m0_dix_cm_cp_io_wait(struct m0_cm_cp    *cp,
                                     struct m0_fop_type *ft);

M0_INTERNAL int m0_dix_cm_cp_sw_check(struct m0_cm_cp *cp);

M0_INTERNAL int m0_dix_cm_cp_send(struct m0_cm_cp *cp, struct m0_fop_type *ft);

M0_INTERNAL int m0_dix_cm_cp_send_wait(struct m0_cm_cp *cp);

M0_INTERNAL int m0_dix_cm_cp_recv_init(struct m0_cm_cp *cp);

M0_INTERNAL int m0_dix_cm_cp_recv_wait(struct m0_cm_cp *cp);

M0_INTERNAL void m0_dix_cm_cp_complete(struct m0_cm_cp *cp);

M0_INTERNAL void m0_dix_cm_cp_free(struct m0_cm_cp *cp);

M0_INTERNAL int m0_dix_cm_cp_fini(struct m0_cm_cp *cp);

M0_INTERNAL void m0_dix_cm_cp_tgt_info_fill(struct m0_dix_cm_cp *dix_cp,
                                            const struct m0_fid *cctg_fid);

M0_INTERNAL void m0_dix_cm_cp_setup(struct m0_dix_cm_cp *dix_cp,
                                    const struct m0_fid *cctg_fid,
                                    uint64_t failed_unit_index);

M0_INTERNAL int m0_dix_cm_cp_dup(struct m0_cm_cp *src, struct m0_cm_cp **dst);

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