log_store.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_LOG_STORE_H__
#define __MOTR_BE_LOG_STORE_H__

#include "lib/buf.h"            /* m0_buf */
#include "lib/types.h"          /* m0_bcount_t */
#include "module/module.h"      /* m0_module */
#include "stob/stob.h"          /* m0_stob_id */

#include "be/fmt.h"             /* m0_be_fmt_log_store_header */

struct m0_be_log_io;
struct m0_be_io;
struct m0_be_io_credit;
struct m0_be_op;
struct m0_stob;

enum {
        M0_BE_LOG_STORE_LEVEL_ASSIGNS,
        M0_BE_LOG_STORE_LEVEL_STOB_DOMAIN,
        M0_BE_LOG_STORE_LEVEL_STOB_FIND,
        M0_BE_LOG_STORE_LEVEL_STOB_LOCATE,
        M0_BE_LOG_STORE_LEVEL_STOB_CREATE,
        M0_BE_LOG_STORE_LEVEL_ZERO,
        M0_BE_LOG_STORE_LEVEL_LS_HEADER_INIT,
        M0_BE_LOG_STORE_LEVEL_LS_HEADER_BUF_ALLOC,
        M0_BE_LOG_STORE_LEVEL_HEADER_CREATE,
        M0_BE_LOG_STORE_LEVEL_HEADER_ENCODE,
        M0_BE_LOG_STORE_LEVEL_HEADER_IO,
        M0_BE_LOG_STORE_LEVEL_HEADER_DECODE,
        M0_BE_LOG_STORE_LEVEL_RBUF_ARR_ALLOC,
        M0_BE_LOG_STORE_LEVEL_RBUF_INIT,
        M0_BE_LOG_STORE_LEVEL_RBUF_ASSIGN,
        M0_BE_LOG_STORE_LEVEL_READY,
};

enum m0_be_log_store_io_type {
        M0_BE_LOG_STORE_IO_READ,
        M0_BE_LOG_STORE_IO_WRITE,
};

struct m0_be_log_store_cfg {
        /*
         * Backing store stob id.
         * It's used in m0_be_log_store_create() and m0_be_log_store_open().
         */
        struct m0_stob_id lsc_stob_id;
        char             *lsc_stob_domain_location;
        const char       *lsc_stob_domain_init_cfg;

        /*
         * The following fields are used in m0_be_log_store_create() only.
         * They are saved in log store header (m0_be_fmt_log_store_header)
         * (except lsc_stob_domain_key and lsc_stob_domain_create_cfg).
         */

        uint64_t          lsc_stob_domain_key;
        const char       *lsc_stob_domain_create_cfg;

        m0_bcount_t       lsc_size;
        const char       *lsc_stob_create_cfg;
        bool              lsc_stob_dont_zero;
        unsigned          lsc_rbuf_nr;
        m0_bcount_t       lsc_rbuf_size;
};

struct m0_be_log_store {
        struct m0_be_log_store_cfg        ls_cfg;
        bool                              ls_create_mode;
        bool                              ls_destroy_mode;
        bool                              ls_stob_destroyed;
        struct m0_module                  ls_module;

        struct m0_stob                   *ls_stob;
        /*
         * Temporary solution.
         * @see m0_be_log_store_cfg::lsc_stob_domain_location
         */
        struct m0_stob_domain            *ls_stob_domain;

        /* Log store header. */
        struct m0_be_fmt_log_store_header ls_header;
        /* Buffer for encoded m0_be_log_store.ls_header. */
        struct m0_buf                     ls_header_buf;
        m0_bindex_t                       ls_offset_discarded;

        struct m0_be_log_io              *ls_rbuf_write_lio;
        struct m0_be_op                  *ls_rbuf_write_op;
        struct m0_buf                     ls_rbuf_write_buf;
        struct m0_be_log_io              *ls_rbuf_read_lio;
        struct m0_be_op                  *ls_rbuf_read_op;
        struct m0_buf                    *ls_rbuf_read_buf;
};

M0_INTERNAL bool m0_be_log_store__invariant(struct m0_be_log_store *ls);

M0_INTERNAL int  m0_be_log_store_open(struct m0_be_log_store     *ls,
                                      struct m0_be_log_store_cfg *ls_cfg);
M0_INTERNAL void m0_be_log_store_close(struct m0_be_log_store *ls);

M0_INTERNAL int  m0_be_log_store_create(struct m0_be_log_store     *ls,
                                        struct m0_be_log_store_cfg *ls_cfg);
M0_INTERNAL void m0_be_log_store_destroy(struct m0_be_log_store *ls);
/* TODO destroy by cfg? */

M0_INTERNAL void
m0_be_log_store_module_setup(struct m0_be_log_store     *ls,
                             struct m0_be_log_store_cfg *ls_cfg,
                             bool                        create_mode);

M0_INTERNAL uint32_t m0_be_log_store_bshift(struct m0_be_log_store *ls);
M0_INTERNAL m0_bcount_t m0_be_log_store_buf_size(struct m0_be_log_store *ls);
M0_INTERNAL void m0_be_log_store_io_credit(struct m0_be_log_store *ls,
                                           struct m0_be_io_credit *accum);
M0_INTERNAL void m0_be_log_store_io_translate(struct m0_be_log_store *ls,
                                              m0_bindex_t             position,
                                              struct m0_be_io        *bio);

M0_INTERNAL int m0_be_log_store_io_window(struct m0_be_log_store *ls,
                                          m0_bindex_t             offset,
                                          m0_bcount_t            *length);
M0_INTERNAL void m0_be_log_store_io_discard(struct m0_be_log_store *ls,
                                            m0_bindex_t             offset,
                                            struct m0_be_op        *op);

M0_INTERNAL bool m0_be_log_store_overwrites(struct m0_be_log_store *ls,
                                            m0_bindex_t             index,
                                            m0_bcount_t             size,
                                            m0_bindex_t             position);

M0_INTERNAL struct m0_buf *
m0_be_log_store_rbuf_write_buf(struct m0_be_log_store *ls);
M0_INTERNAL struct m0_buf *
m0_be_log_store_rbuf_read_buf_first(struct m0_be_log_store *ls,
                                    unsigned               *iter);
M0_INTERNAL struct m0_buf *
m0_be_log_store_rbuf_read_buf_next(struct m0_be_log_store *ls,
                                   unsigned               *iter);
M0_INTERNAL struct m0_be_log_io *
m0_be_log_store_rbuf_io_first(struct m0_be_log_store        *ls,
                              enum m0_be_log_store_io_type   io_type,
                              struct m0_be_op              **op,
                              unsigned                      *iter);
M0_INTERNAL struct m0_be_log_io *
m0_be_log_store_rbuf_io_next(struct m0_be_log_store        *ls,
                             enum m0_be_log_store_io_type   io_type,
                             struct m0_be_op              **op,
                             unsigned                      *iter);
M0_INTERNAL void
m0_be_log_store_rbuf_io_reset(struct m0_be_log_store       *ls,
                              enum m0_be_log_store_io_type  io_type);

M0_INTERNAL bool
m0_be_log_store_contains_stob(struct m0_be_log_store  *ls,
                              const struct m0_stob_id *stob_id);
#endif /* __MOTR_BE_LOG_STORE_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
 */