tx_group.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_TX_GROUP_H__
#define __MOTR_BE_TX_GROUP_H__

#include "lib/tlist.h"          /* m0_tl */

#include "be/tx_credit.h"       /* m0_be_tx_credit */
#include "be/tx_group_format.h" /* m0_be_group_format */
#include "be/tx_group_fom.h"    /* m0_be_group_fom */
#include "be/tx_regmap.h"       /* m0_be_reg_area */
#include "be/tx.h"              /* m0_be_tx_state */

struct m0_be_engine;
struct m0_be_domain;
struct m0_be_tx;
struct be_recovering_tx;
struct m0_be_op;

enum m0_be_tx_group_state {
        M0_BGS_READY,
        M0_BGS_OPEN,
        M0_BGS_FROZEN,
        M0_BGS_CLOSED,
        M0_BGS_NR,
};

struct m0_be_tx_group_cfg {
        unsigned long                  tgc_tx_nr_max;
        unsigned long                  tgc_seg_nr_max;
        struct m0_be_tx_credit         tgc_size_max;
        m0_bcount_t                    tgc_payload_max;
        struct m0_be_domain           *tgc_domain;
        struct m0_be_engine           *tgc_engine;
        struct m0_be_log              *tgc_log;
        struct m0_be_log_discard      *tgc_log_discard;
        struct m0_be_pd               *tgc_pd;
        struct m0_reqh                *tgc_reqh;
        struct m0_be_group_format_cfg  tgc_format;
};

struct m0_be_tx_group {
        struct m0_be_tx_group_cfg  tg_cfg;
        struct m0_be_tx_credit     tg_used;
        struct m0_be_tx_credit     tg_size;
        struct m0_be_tx_credit     tg_log_reserved;
        m0_bcount_t                tg_payload_prepared;
        uint32_t                   tg_nr_unclosed;
        uint32_t                   tg_nr_unstable;
        struct m0_tl               tg_txs;
        struct m0_tl               tg_txs_recovering;
        struct be_recovering_tx   *tg_rtxs;
        /* Linkage for engine lists (m0_be_engine::eng_txs). */
        struct m0_tlink            tg_engine_linkage;
        /* Magic for tg_engine_linkage. */
        uint64_t                   tg_magic;
        struct m0_be_group_format  tg_od;               /* XXX rename */
        struct m0_be_log          *tg_log;
        struct m0_be_domain       *tg_domain;
        struct m0_be_engine       *tg_engine;
        struct m0_be_tx_group_fom  tg_fom;
        struct m0_be_reg_area      tg_reg_area;
        bool                       tg_recovering;
        struct m0_be_reg_area_merger  tg_merger;
        struct m0_sm_timer         tg_close_timer;
        struct m0_sm_ast           tg_close_timer_arm;
        struct m0_sm_ast           tg_close_timer_disarm;
        m0_time_t                  tg_close_deadline;
        enum m0_be_tx_group_state  tg_state;
};

M0_INTERNAL bool m0_be_tx_group__invariant(struct m0_be_tx_group *gr);

/* ------------------------------------------------------------------
 *                  Interfaces used by m0_be_engine
 * ------------------------------------------------------------------ */

M0_INTERNAL int m0_be_tx_group_init(struct m0_be_tx_group     *gr,
                                    struct m0_be_tx_group_cfg *gr_cfg);
M0_INTERNAL void m0_be_tx_group_fini(struct m0_be_tx_group *gr);

M0_INTERNAL int m0_be_tx_group_start(struct m0_be_tx_group *gr);
M0_INTERNAL void m0_be_tx_group_stop(struct m0_be_tx_group *gr);

M0_INTERNAL int m0_be_tx_group_tx_add(struct m0_be_tx_group *gr,
                                      struct m0_be_tx       *tx);
M0_INTERNAL size_t m0_be_tx_group_tx_nr(struct m0_be_tx_group *gr);

M0_INTERNAL void m0_be_tx_group_tx_closed(struct m0_be_tx_group *gr,
                                          struct m0_be_tx       *tx);

M0_INTERNAL void m0_be_tx_group_close(struct m0_be_tx_group *gr);

M0_INTERNAL void m0_be_tx_group_stable(struct m0_be_tx_group *gr);

M0_INTERNAL struct m0_sm_group *
m0_be_tx_group__sm_group(struct m0_be_tx_group *gr);
M0_INTERNAL bool m0_be_tx_group_is_recovering(struct m0_be_tx_group *gr);

/* ------------------------------------------------------------------
 *              Interfaces used by m0_be_tx_group_fom
 * ------------------------------------------------------------------ */

M0_INTERNAL void m0_be_tx_group_reset(struct m0_be_tx_group *gr);

M0_INTERNAL void m0_be_tx_group_prepare(struct m0_be_tx_group *gr,
                                        struct m0_be_op       *op);

M0_INTERNAL void m0_be_tx_group_tx_del(struct m0_be_tx_group *gr,
                                       struct m0_be_tx       *tx);
M0_INTERNAL void m0_be_tx_group_open(struct m0_be_tx_group *gr);

M0_INTERNAL void
m0_be_tx_group__tx_state_post(struct m0_be_tx_group *gr,
                              enum m0_be_tx_state    state,
                              bool                   del_tx_from_group);
M0_INTERNAL int m0_be_tx_group__allocate(struct m0_be_tx_group *gr);
M0_INTERNAL void m0_be_tx_group__deallocate(struct m0_be_tx_group *gr);

M0_INTERNAL void m0_be_tx_group_seg_place_prepare(struct m0_be_tx_group *gr);
M0_INTERNAL void m0_be_tx_group_seg_place(struct m0_be_tx_group *gr,
                                          struct m0_be_op       *op);
M0_INTERNAL void m0_be_tx_group_encode(struct m0_be_tx_group *gr);

M0_INTERNAL void m0_be_tx_group_log_write(struct m0_be_tx_group *gr,
                                          struct m0_be_op       *op);

/* ------------------------------------------------------------------
 *                      Interfaces used by recovery.
 * ------------------------------------------------------------------ */

M0_INTERNAL void m0_be_tx_group_recovery_prepare(struct m0_be_tx_group *gr,
                                                 struct m0_be_log      *log);
M0_INTERNAL void m0_be_tx_group_log_read(struct m0_be_tx_group *gr,
                                         struct m0_be_op       *op);
M0_INTERNAL int m0_be_tx_group_decode(struct m0_be_tx_group *gr);
M0_INTERNAL int m0_be_tx_group_reconstruct(struct m0_be_tx_group *gr,
                                           struct m0_sm_group    *sm_grp);
M0_INTERNAL void m0_be_tx_group_reconstruct_tx_open(struct m0_be_tx_group *gr,
                                                    struct m0_be_op       *op);
M0_INTERNAL void
m0_be_tx_group_reconstruct_tx_close(struct m0_be_tx_group *gr,
                                    struct m0_be_op       *op_gc);
M0_INTERNAL int m0_be_tx_group_reapply(struct m0_be_tx_group *gr,
                                       struct m0_be_op       *op);

/* ------------------------------------------------------------------
 *                      Interfaces used by domain.
 * ------------------------------------------------------------------ */

M0_INTERNAL void m0_be_tx_group_discard(struct m0_be_log_discard      *ld,
                                        struct m0_be_log_discard_item *ldi);

M0_INTERNAL void
m0_be_tx_group_seg_io_credit(struct m0_be_tx_group_cfg *gr_cfg,
                             struct m0_be_io_credit    *io_cred);

/* XXX see comment in be/tx_group.c */
#if 0
M0_INTERNAL void tx_group_init(struct m0_be_tx_group *gr,
                               struct m0_stob *log_stob);
M0_INTERNAL void tx_group_fini(struct m0_be_tx_group *gr);

M0_INTERNAL void tx_group_add(struct m0_be_tx_engine *eng,
                              struct m0_be_tx_group *gr,
                              struct m0_be_tx *tx);
M0_INTERNAL void tx_group_close(struct m0_be_tx_engine *eng,
                                struct m0_be_tx_group *gr);
/* Note the absence of tx_group_open(). */
#endif

#define M0_BE_TX_GROUP_TX_FORALL(gr, tx) \
        m0_tl_for(grp, &(gr)->tg_txs, (tx))

#define M0_BE_TX_GROUP_TX_ENDFOR m0_tl_endfor

M0_TL_DESCR_DECLARE(grp, M0_EXTERN);
M0_TL_DECLARE(grp, M0_INTERNAL, struct m0_be_tx);

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