dtm.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_DTM_DTM_H__
#define __MOTR_DTM_DTM_H__

#include "lib/types.h"           /* m0_uint128 */

#include "fol/fol.h"
#include "dtm/history.h"
#include "dtm/nucleus.h"
#include "dtm/catalogue.h"
#include "dtm/fol.h"
#include "be/tx.h"              /* m0_be_tx */

/* import */
struct m0_dtm_history_type;
struct m0_dtm0_dtx;

/* export */
struct m0_dtm;
struct m0_dtx;

enum {
        M0_DTM_HISTORY_TYPE_NR = 256
};

struct m0_dtm {
        struct m0_dtm_nu                  d_nu;
        struct m0_uint128                 d_id;
        struct m0_dtm_catalogue           d_cat[M0_DTM_HISTORY_TYPE_NR];
        struct m0_dtm_fol                 d_fol;
        struct m0_tl                      d_excited;
        const struct m0_dtm_history_type *d_htype[M0_DTM_HISTORY_TYPE_NR];
};

enum m0_dtx_state {
        M0_DTX_INVALID,
        M0_DTX_INIT,
        M0_DTX_OPEN,
        M0_DTX_DONE
};

struct m0_dtx {
        enum m0_dtx_state      tx_state;
        struct m0_be_tx        tx_betx;
        struct m0_be_tx_credit tx_betx_cred;
        struct m0_fol_rec      tx_fol_rec;
        /* It is the real dtx here (at least on the originator side). */
        struct m0_dtm0_dtx    *tx_dtx;
};

M0_INTERNAL void m0_dtx_init(struct m0_dtx *tx,
                             struct m0_be_domain *be_domain,
                             struct m0_sm_group  *sm_group);
M0_INTERNAL void m0_dtx_prep(struct m0_dtx *tx,
                             const struct m0_be_tx_credit *cred);
M0_INTERNAL void m0_dtx_open(struct m0_dtx *tx);
M0_INTERNAL void m0_dtx_done(struct m0_dtx *tx);
M0_INTERNAL int m0_dtx_open_sync(struct m0_dtx *tx);
M0_INTERNAL int m0_dtx_done_sync(struct m0_dtx *tx);
M0_INTERNAL void m0_dtx_opened(struct m0_dtx *tx);
M0_INTERNAL void m0_dtx_fini(struct m0_dtx *tx);
M0_INTERNAL int m0_dtx_fol_add(struct m0_dtx *tx);

M0_INTERNAL void m0_dtm_init(struct m0_dtm *dtm, struct m0_uint128 *id);
M0_INTERNAL void m0_dtm_fini(struct m0_dtm *dtm);

M0_INTERNAL int  m0_dtm_global_init(void);
M0_INTERNAL void m0_dtm_global_fini(void);

#endif /* __MOTR_DTM_DTM_H__ */

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