dtm0_log.h

Go to the documentation of this file.

/* -*- C -*- */
/*
 * Copyright (c) 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.
 *
 */

#pragma once
#ifndef __MOTR_BE_DTM0_LOG_H__
#define __MOTR_BE_DTM0_LOG_H__

#include "be/list.h"            /* m0_be_list */
#include "dtm0/tx_desc.h"       /* m0_dtm0_tx_desc */
#include "fid/fid.h"            /* m0_fid */
#include "lib/buf.h"            /* m0_buf */
#include "dtm0/dtx.h"           /* struct m0_dtm0_dtx */

struct m0_be_tx;
struct m0_be_tx_credit;
struct m0_dtm0_clk_src;

enum m0_be_dtm0_log_credit_op {
        M0_DTML_CREATE,         
        M0_DTML_SENT,           
        M0_DTML_EXECUTED,       
        M0_DTML_PERSISTENT,     
        M0_DTML_PRUNE,          
        M0_DTML_REDO            
};

struct m0_dtm0_log_rec {
        struct m0_dtm0_dtx     dlr_dtx;
        struct m0_dtm0_tx_desc dlr_txd;
        uint64_t               dlr_magic;
        union  {
                struct m0_be_list_link dlr_link;  /*
                                                   * used when this record is
                                                   * stored within a persistent
                                                   * log that is going to stored
                                                   * in BE.
                                                   */
                struct m0_tlink        dlr_tlink; /*
                                                   * used when this record is
                                                   * stored within a volatile
                                                   * log that is going to stored
                                                   * in memory.
                                                   */
        } u;
        struct m0_buf          dlr_payload;
};

struct m0_be_dtm0_log {
        bool                       dl_is_persistent;
        struct m0_mutex            dl_lock;
        struct m0_be_seg          *dl_seg;
        struct m0_dtm0_clk_src    *dl_cs;
        union {
                struct m0_be_list *dl_persist;
                struct m0_tl      *dl_inmem;
        } u;
};

M0_INTERNAL int m0_be_dtm0_log_alloc(struct m0_be_dtm0_log **log);

M0_INTERNAL int m0_be_dtm0_log_init(struct m0_be_dtm0_log  *log,
                                    struct m0_be_seg       *seg,
                                    struct m0_dtm0_clk_src *cs,
                                    bool                    is_plog);

M0_INTERNAL void m0_be_dtm0_log_fini(struct m0_be_dtm0_log *log);

M0_INTERNAL void m0_be_dtm0_log_free(struct m0_be_dtm0_log **log);

M0_INTERNAL void m0_be_dtm0_log_credit(enum m0_be_dtm0_log_credit_op op,
                                       struct m0_dtm0_tx_desc       *txd,
                                       struct m0_buf                *payload,
                                       struct m0_be_seg             *seg,
                                       struct m0_dtm0_log_rec       *rec,
                                       struct m0_be_tx_credit       *accum);

M0_INTERNAL int m0_be_dtm0_log_create(struct m0_be_tx        *tx,
                                      struct m0_be_seg       *seg,
                                      struct m0_be_dtm0_log **out);

M0_INTERNAL void m0_be_dtm0_log_destroy(struct m0_be_tx        *tx,
                                        struct m0_be_dtm0_log **log);

M0_INTERNAL int m0_be_dtm0_log_update(struct m0_be_dtm0_log  *log,
                                      struct m0_be_tx        *tx,
                                      struct m0_dtm0_tx_desc *txd,
                                      struct m0_buf          *payload);

M0_INTERNAL
struct m0_dtm0_log_rec *m0_be_dtm0_log_find(struct m0_be_dtm0_log    *log,
                                            const struct m0_dtm0_tid *id);

M0_INTERNAL int m0_be_dtm0_log_prune(struct m0_be_dtm0_log    *log,
                                     struct m0_be_tx          *tx,
                                     const struct m0_dtm0_tid *id);

M0_INTERNAL bool m0_be_dtm0_plog_can_prune(struct m0_be_dtm0_log    *log,
                                           const struct m0_dtm0_tid *id,
                                           struct m0_be_tx_credit   *cred);

M0_INTERNAL int m0_be_dtm0_plog_prune(struct m0_be_dtm0_log    *log,
                                      struct m0_be_tx          *tx,
                                      const struct m0_dtm0_tid *id);

M0_INTERNAL void m0_be_dtm0_log_clear(struct m0_be_dtm0_log *log);

M0_INTERNAL int m0_be_dtm0_volatile_log_insert(struct m0_be_dtm0_log  *log,
                                               struct m0_dtm0_log_rec *rec);

M0_INTERNAL void m0_be_dtm0_volatile_log_update(struct m0_be_dtm0_log  *log,
                                                struct m0_dtm0_log_rec *rec);

M0_INTERNAL void m0_be_dtm0_volatile_log_del(struct m0_be_dtm0_log  *log,
                                             struct m0_dtm0_log_rec *rec,
                                             bool                    fini);


struct m0_be_dtm0_log_iter {
        struct m0_be_dtm0_log *dli_log;
        struct m0_dtm0_tid     dli_current_tid;
};

M0_INTERNAL int m0_dtm0_log_rec_copy(struct m0_dtm0_log_rec       *dst,
                                     const struct m0_dtm0_log_rec *src);
M0_INTERNAL void m0_dtm0_log_iter_rec_fini(struct m0_dtm0_log_rec *rec);

M0_INTERNAL void m0_be_dtm0_log_iter_init(struct m0_be_dtm0_log_iter *iter,
                                          struct m0_be_dtm0_log      *log);

M0_INTERNAL void m0_be_dtm0_log_iter_fini(struct m0_be_dtm0_log_iter *iter);

M0_INTERNAL int m0_be_dtm0_log_iter_next(struct m0_be_dtm0_log_iter *iter,
                                         struct m0_dtm0_log_rec     *out);
 /* end DTM0Internals */

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