plan.h

Go to the documentation of this file.

/* -*- C -*- */
/*
 * Copyright (c) 2016-2021 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.
 *
 * Original author: Nikita Danilov <nikita.danilov@seagate.com>
 * Original creation date: 07-Jun-2016
 */

#pragma once

#ifndef __MOTR_LAYOUT_PLAN_H__
#define __MOTR_LAYOUT_PLAN_H__

#include "lib/types.h"        /* uint64_t */
#include "lib/tlist.h"
#include "lib/vec.h"

struct m0_op;
struct m0_layout;
struct m0_layout_plan;
struct m0_layout_plop;
struct m0_layout_plop_ops;

enum m0_layout_plop_type {
        M0_LAT_IN_WRITE,
        M0_LAT_READ,
        M0_LAT_WRITE,
        M0_LAT_GET,
        M0_LAT_PUT,
        M0_LAT_FUN,
        M0_LAT_OUT_READ,
        M0_LAT_DONE,

        M0_LAT_NR
};

enum m0_layout_plop_state {
        M0_LPS_INIT,
        M0_LPS_STARTED,
        M0_LPS_DONE,
};

struct m0_layout_plop {
        enum m0_layout_plop_type         pl_type;
        enum m0_layout_plop_state        pl_state;
        struct m0_layout_plan           *pl_plan;
        struct target_ioreq             *pl_ti;
        uint64_t                         pl_colour;
        uint64_t                         pl_magix;
        struct m0_tlink                  pl_linkage;
        struct m0_tl                     pl_deps;
        struct m0_tl                     pl_rdeps;
        struct m0_fid                    pl_ent;
        int32_t                          pl_rc;
        const struct m0_layout_plop_ops *pl_ops;
};

struct m0_layout_plop_rel {
        struct m0_layout_plop *plr_dep;
        struct m0_layout_plop *plr_rdep;
        uint64_t               plr_magix;
        struct m0_tlink        plr_dep_linkage;
        struct m0_tlink        plr_rdep_linkage;
};

struct m0_layout_plop_ops {
        void (*po_cancel)(struct m0_layout_plop *plop);
        void (*po_fini)(struct m0_layout_plop *plop);
};

struct m0_layout_inout_plop {
        struct m0_layout_plop iob_base;
        struct m0_indexvec    iob_ready;
        struct m0_bufvec      iob_data;
};

struct m0_layout_io_plop {
        struct m0_layout_plop  iop_base;

        struct m0_rpc_session *iop_session;
        struct m0_indexvec     iop_ext;

        m0_bindex_t            iop_goff;

        struct m0_bufvec       iop_data;
};

struct m0_layout_index_plop {
        struct m0_layout_plop rp_base;
};

struct m0_layout_fun_plop {
        struct m0_layout_plop fp_base;
        int                 (*fp_fun)(struct m0_layout_fun_plop *plop);
        void                 *fp_datum;
};

M0_TL_DESCR_DECLARE(pldeps, M0_EXTERN);
M0_TL_DECLARE(pldeps, M0_EXTERN, struct m0_layout_plop_rel);

M0_TL_DESCR_DECLARE(plrdeps, M0_EXTERN);
M0_TL_DECLARE(plrdeps, M0_EXTERN, struct m0_layout_plop_rel);

M0_INTERNAL struct m0_layout_plan * m0_layout_plan_build(struct m0_op *op);

M0_INTERNAL void m0_layout_plan_fini(struct m0_layout_plan *plan);

enum {
        M0_LAYOUT_PLOT_ANYCOLOUR = ~0ULL
};

M0_INTERNAL int m0_layout_plan_get(struct m0_layout_plan *plan, uint64_t colour,
                                   struct m0_layout_plop **out);

M0_INTERNAL int m0_layout_plop_start(struct m0_layout_plop *plop);

M0_INTERNAL void m0_layout_plop_done(struct m0_layout_plop *plop);

M0_INTERNAL void m0_layout_plan_abort(struct m0_layout_plan *plan);

#endif /* __MOTR_LAYOUT_PLAN_H__ */

/*
 *  Local variables:
 *  c-indentation-style: "K&R"
 *  c-basic-offset: 8
 *  tab-width: 8
 *  fill-column: 80
 *  scroll-step: 1
 *  End:
 */
/*
 * vim: tabstop=8 shiftwidth=8 noexpandtab textwidth=80 nowrap
 */