op.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_BE_OP_H__
#define __MOTR_BE_OP_H__

#include "lib/buf.h"    /* m0_buf */
#include "lib/tlist.h"  /* m0_tl */
#include "lib/types.h"  /* bool */
#include "lib/mutex.h"  /* m0_mutex */

#include "sm/sm.h"      /* m0_sm */

struct m0_fom;
struct m0_be_tx;
struct m0_be_btree;
struct m0_be_btree_anchor;
struct m0_be_op;

enum m0_be_op_state {
        M0_BOS_INVALID,
        M0_BOS_INIT,
        M0_BOS_ACTIVE,
        M0_BOS_DONE,
        M0_BOS_GC,
};

enum m0_be_op_type {
        M0_BOP_TREE,
        M0_BOP_LIST,
};

typedef void (*m0_be_op_cb_t)(struct m0_be_op *op, void *param);

struct m0_be_op {
        struct m0_sm        bo_sm;
        struct m0_fom      *bo_fom;
        int                 bo_rc;
        bool                bo_rc_is_set;
        /*
         * Workaround.
         *
         * In the future sm group for m0_be_op should be taken
         * from m0_locality_here().
         *
         * @see MOTR-787 comments for the reference.
         */
        struct m0_sm_group  bo_sm_group;

        enum m0_be_op_type  bo_utype; /* bo_u type */
        union {
                struct m0_be_op__btree {
                        struct m0_be_btree        *t_tree;
                        struct m0_be_tx           *t_tx;
                        /* XXX to be defined in btree.c */
                        unsigned int               t_op;
                        const struct m0_buf       *t_in;
                        struct m0_buf              t_out_val;
                        struct m0_buf              t_out_key;
                        struct m0_be_btree_anchor *t_anchor;
                        int                        t_rc;
                } u_btree;

                struct {
                        int                        e_rc;
                } u_emap;
        } bo_u;

        struct m0_tl        bo_children;
        struct m0_tlink     bo_set_link;
        uint64_t            bo_set_link_magic;
        struct m0_be_op    *bo_parent;
        /* is this op an op_set */
        bool                bo_is_op_set;

        m0_be_op_cb_t       bo_cb_active;
        void               *bo_cb_active_param;
        m0_be_op_cb_t       bo_cb_done;
        void               *bo_cb_done_param;
        m0_be_op_cb_t       bo_cb_gc;
        void               *bo_cb_gc_param;
};

M0_INTERNAL void m0_be_op_init(struct m0_be_op *op);
M0_INTERNAL void m0_be_op_fini(struct m0_be_op *op);

M0_INTERNAL void m0_be_op_lock(struct m0_be_op *op);
M0_INTERNAL void m0_be_op_unlock(struct m0_be_op *op);
M0_INTERNAL bool m0_be_op_is_locked(const struct m0_be_op *op);

/*
 * Moves internal sm to M0_BOS_INIT state and resets
 * parent-child op_set relationship.
 */
M0_INTERNAL void m0_be_op_reset(struct m0_be_op *op);

M0_INTERNAL void m0_be_op_active(struct m0_be_op *op);

M0_INTERNAL void m0_be_op_done(struct m0_be_op *op);

M0_INTERNAL bool m0_be_op_is_done(struct m0_be_op *op);

M0_INTERNAL void m0_be_op_callback_set(struct m0_be_op     *op,
                                       m0_be_op_cb_t        cb,
                                       void                *param,
                                       enum m0_be_op_state  state);

M0_INTERNAL void m0_be_op_wait(struct m0_be_op *op);

M0_INTERNAL int m0_be_op_tick_ret(struct m0_be_op *op,
                                  struct m0_fom   *fom,
                                  int              next_state);

M0_INTERNAL void m0_be_op_set_add(struct m0_be_op *parent,
                                  struct m0_be_op *child);

M0_INTERNAL void m0_be_op_rc_set(struct m0_be_op *op, int rc);
M0_INTERNAL int  m0_be_op_rc(struct m0_be_op *op);

#define M0_BE_OP_SYNC(op_obj, action)                   \
        ({                                              \
                struct m0_be_op op_obj = {};            \
                M0_BE_OP_SYNC_WITH(&op_obj, action);    \
        })

#define M0_BE_OP_SYNC_RC(op_obj, action)                \
        ({                                              \
                struct m0_be_op op_obj = {};            \
                M0_BE_OP_SYNC_WITH_RC(&op_obj, action); \
        })


#define M0_BE_OP_SYNC_WITH(op, action)          \
        ({                                      \
                struct m0_be_op *__opp = (op);  \
                                                \
                m0_be_op_init(__opp);           \
                action;                         \
                m0_be_op_wait(__opp);           \
                m0_be_op_fini(__opp);           \
        })

#define M0_BE_OP_SYNC_WITH_RC(op, action)       \
        ({                                      \
                struct m0_be_op *__opp = (op);  \
                int __op_rc;                    \
                                                \
                m0_be_op_init(__opp);           \
                action;                         \
                m0_be_op_wait(__opp);           \
                __op_rc = m0_be_op_rc(__opp);   \
                m0_be_op_fini(__opp);           \
                __op_rc;                        \
        })


#define M0_BE_OP_SYNC_RET(op_obj, action, member)                \
        ({                                                       \
                struct m0_be_op op_obj = {};                     \
                M0_BE_OP_SYNC_RET_WITH(&op_obj, action, member); \
        })

#define M0_BE_OP_SYNC_RET_WITH(op, action, member)      \
        ({                                              \
                struct m0_be_op       *__opp = (op);    \
                typeof(__opp->member)  __result;        \
                                                        \
                m0_be_op_init(__opp);                   \
                action;                                 \
                m0_be_op_wait(__opp);                   \
                __result = __opp->member;               \
                m0_be_op_fini(__opp);                   \
                __result;                               \
        })

#endif /* __MOTR_BE_OP_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
 */