cp.h

Go to the documentation of this file.

/* -*- C -*- */
/*
 * Copyright (c) 2013-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_CM_CP_H__
#define __MOTR_CM_CP_H__

#include "lib/vec.h"
#include "lib/tlist.h"
#include "net/net.h"
#include "net/buffer_pool.h"

#include "fop/fom_generic.h"
#include "rpc/bulk.h"
#include "fop/fop.h"

struct m0_cm_cp;
struct m0_cm;
struct m0_cm_type;

enum {
        M0_CP_SIZE = 4096
};

enum m0_cm_cp_priority {
        M0_CM_CP_PRIORITY_MIN = 0,
        M0_CM_CP_PRIORITY_MAX = 3,
        M0_CM_CP_PRIORITY_NR
};

enum m0_cm_cp_io_op {
        M0_CM_CP_READ,
        M0_CM_CP_WRITE
};

enum m0_cm_cp_phase {
        M0_CCP_INIT = M0_FOM_PHASE_INIT,

        M0_CCP_FINI = M0_FOM_PHASE_FINISH,

        M0_CCP_READ,

        M0_CCP_WRITE_PRE,

        M0_CCP_TX_OPEN,

        M0_CCP_WRITE,

        M0_CCP_TX_DONE,

        M0_CCP_IO_WAIT,

        M0_CCP_XFORM,

        M0_CCP_SW_CHECK,

        M0_CCP_SEND,

        M0_CCP_SEND_WAIT,

        M0_CCP_RECV_INIT,

        M0_CCP_RECV_WAIT,

        M0_CCP_FAIL,

        M0_CCP_NR
};

struct m0_cm_cp_fop {
        struct m0_fop    cf_fop;
        struct m0_cm_cp *cf_cp;
};

struct m0_cm_cp {
        struct m0_fom              c_fom;
        enum m0_cm_cp_priority     c_prio;

        m0_time_t                  c_epoch;

        const struct m0_cm_cp_ops *c_ops;

        struct m0_cm_aggr_group   *c_ag;

        uint64_t                   c_ag_cp_idx;

        struct m0_bitmap           c_xform_cp_indices;

        struct m0_tl               c_buffers;

        uint32_t                   c_buf_nr;

        uint32_t                   c_data_seg_nr;

        struct m0_rpc_bulk         c_bulk;

        enum m0_cm_cp_io_op        c_io_op;

        struct m0_tlink            c_cm_proxy_linkage;

        struct m0_cm_proxy        *c_cm_proxy;

        struct m0_chan            c_reply_wait;
        struct m0_mutex           c_reply_wait_mutex;

        int                       c_rc;

        uint64_t                  c_magix;
};

struct m0_cm_cp_ops {
        int      (*co_phase_next) (struct m0_cm_cp *cp);

        bool     (*co_invariant) (const struct m0_cm_cp *cp);

        uint64_t (*co_home_loc_helper) (const struct m0_cm_cp *cp);

        void     (*co_complete) (struct m0_cm_cp *cp);

        void     (*co_free)(struct m0_cm_cp *cp);

        uint32_t co_action_nr;

        int      (*co_action[]) (struct m0_cm_cp *cp);
};

M0_INTERNAL void m0_cm_cp_init(struct m0_cm_type *cmtype,
                               const struct m0_fom_type_ops *ft_ops);

M0_INTERNAL void m0_cm_cp_only_init(struct m0_cm *cm, struct m0_cm_cp *cp);

M0_INTERNAL int m0_cm_cp_fom_create(struct m0_fop *fop, struct m0_fop *r_fop,
                                    struct m0_fom **m, struct m0_reqh *reqh);
M0_INTERNAL void m0_cm_cp_fom_init(struct m0_cm *cm, struct m0_cm_cp *cp,
                                   struct m0_fop *fop, struct m0_fop *r_fop);

M0_INTERNAL void m0_cm_cp_fom_fini(struct m0_fom *fom);

M0_INTERNAL void m0_cm_cp_only_fini(struct m0_cm_cp *cp);

M0_INTERNAL void m0_cm_cp_fini(struct m0_cm_cp *cp);

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

M0_INTERNAL bool m0_cm_cp_invariant(const struct m0_cm_cp *cp);

M0_INTERNAL void m0_cm_cp_buf_add(struct m0_cm_cp *cp,
                                  struct m0_net_buffer *nb);

M0_INTERNAL void m0_cm_cp_buf_release(struct m0_cm_cp *cp);

M0_INTERNAL uint64_t m0_cm_cp_nr(struct m0_cm_cp *cp);

M0_INTERNAL int m0_cm_cp_bufvec_merge(struct m0_cm_cp *cp);
M0_INTERNAL int m0_cm_cp_bufvec_split(struct m0_cm_cp *cp);
M0_INTERNAL void m0_cm_cp_buf_move(struct m0_cm_cp *src, struct m0_cm_cp *dest);
M0_INTERNAL int m0_cm_cp_dup(struct m0_cm_cp *src, struct m0_cm_cp **dest);

M0_INTERNAL void m0_cm_cp_data_copy(struct m0_cm_cp *src, struct m0_cm_cp *dst);

M0_TL_DESCR_DECLARE(cp_data_buf, M0_EXTERN);
M0_TL_DECLARE(cp_data_buf, M0_INTERNAL, struct m0_net_buffer);

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