log_sched.c

Go to the documentation of this file.

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


#define M0_TRACE_SUBSYSTEM M0_TRACE_SUBSYS_BE
#include "lib/trace.h"

#include "be/log_sched.h"

#include "be/io_sched.h" /* m0_be_io_sched */
#include "lib/memory.h"  /* m0_alloc_aligned */
#include "lib/errno.h"   /* ENOMEM */

M0_INTERNAL int m0_be_log_sched_init(struct m0_be_log_sched     *sched,
                                     struct m0_be_log_sched_cfg *cfg)
{
        sched->lsh_pos = 0;
        cfg->lsch_io_sched_cfg.bisc_pos_start = 0;
        return m0_be_io_sched_init(&sched->lsh_io_sched,
                                   &cfg->lsch_io_sched_cfg);
}

M0_INTERNAL void m0_be_log_sched_fini(struct m0_be_log_sched *sched)
{
        m0_be_io_sched_fini(&sched->lsh_io_sched);
}

M0_INTERNAL void m0_be_log_sched_lock(struct m0_be_log_sched *sched)
{
        m0_be_io_sched_lock(&sched->lsh_io_sched);
}

M0_INTERNAL void m0_be_log_sched_unlock(struct m0_be_log_sched *sched)
{
        m0_be_io_sched_unlock(&sched->lsh_io_sched);
}

M0_INTERNAL bool m0_be_log_sched_is_locked(struct m0_be_log_sched *sched)
{
        return m0_be_io_sched_is_locked(&sched->lsh_io_sched);
}

M0_INTERNAL void m0_be_log_sched_add(struct m0_be_log_sched *sched,
                                     struct m0_be_log_io    *lio,
                                     struct m0_be_op        *op)
{
        struct m0_ext *ext = NULL;
        struct m0_ext  ext2;

        M0_LOG(M0_DEBUG, "sched=%p lio=%p lio_record=%p op=%p "
               "m0_be_io_size(&lio->lio_be_io)=%"PRIu64,
               sched, lio, lio->lio_record, op,
               m0_be_io_size(&lio->lio_be_io));

        M0_PRE(m0_be_log_sched_is_locked(sched));
        M0_PRE(!m0_be_log_io_is_empty(lio));

        lio->lio_sched = sched;
        if (m0_be_io_opcode(m0_be_log_io_be_io(lio)) != SIO_READ) {
                /*
                 * Note: it makes a simple queue from an ext-based queue.
                 * In the future m0_be_log_sched_add() is going to have
                 * m0_ext parameter.
                 */
                ext2.e_start = sched->lsh_pos;
                ext2.e_end = ++sched->lsh_pos;
                m0_ext_init(&ext2);
                ext = &ext2;
        }
        m0_be_io_sched_add(&sched->lsh_io_sched, &lio->lio_be_io, ext, op);
}

M0_INTERNAL int m0_be_log_io_init(struct m0_be_log_io *lio)
{
        return 0;
}

M0_INTERNAL void m0_be_log_io_fini(struct m0_be_log_io *lio)
{
}

M0_INTERNAL void m0_be_log_io_reset(struct m0_be_log_io *lio)
{
        lio->lio_buf_addr = NULL;
        lio->lio_buf_size = 0;
        lio->lio_bufvec   = M0_BUFVEC_INIT_BUF(NULL, NULL);
        m0_be_io_reset(&lio->lio_be_io);
}

M0_INTERNAL int m0_be_log_io_allocate(struct m0_be_log_io    *lio,
                                      struct m0_be_io_credit *iocred,
                                      uint32_t                log_bshift)
{
        m0_bcount_t size  = iocred->bic_reg_size;
        void       *addr;
        int         rc;

        M0_ENTRY("lio=%p iocred="BE_IOCRED_F" log_bshift=%"PRIu32,
                 lio, BE_IOCRED_P(iocred), log_bshift);
        M0_PRE(m0_is_aligned(size, 1 << log_bshift));

        addr = m0_alloc_aligned(size, log_bshift);
        rc   = addr == NULL ? -ENOMEM : 0;
        if (rc != 0)
                goto err;
        rc = m0_be_io_init(&lio->lio_be_io);
        if (rc != 0)
                goto err_free;
        rc = m0_be_io_allocate(&lio->lio_be_io, iocred);
        if (rc != 0)
                goto err_lio_fini;

        lio->lio_buf        = M0_BUF_INIT(size, addr);
        lio->lio_log_bshift = log_bshift;

        return rc;

err_lio_fini:
        m0_be_io_fini(&lio->lio_be_io);
err_free:
        m0_free_aligned(addr, size, log_bshift);
err:
        return M0_RC(rc);
}

M0_INTERNAL void m0_be_log_io_deallocate(struct m0_be_log_io *lio)
{
        struct m0_buf *buf = &lio->lio_buf;

        m0_be_io_deallocate(&lio->lio_be_io);
        m0_be_io_fini(&lio->lio_be_io);
        m0_free_aligned(buf->b_addr, buf->b_nob, lio->lio_log_bshift);
}

M0_INTERNAL struct m0_bufvec *m0_be_log_io_bufvec(struct m0_be_log_io *lio)
{
        return &lio->lio_bufvec;
}

M0_INTERNAL struct m0_be_io *m0_be_log_io_be_io(struct m0_be_log_io *lio)
{
        return &lio->lio_be_io;
}

M0_INTERNAL void m0_be_log_io_user_data_set(struct m0_be_log_io *lio,
                                            void                *data)
{
        lio->lio_user_data = data;
}

M0_INTERNAL void *m0_be_log_io_user_data(struct m0_be_log_io *lio)
{
        return lio->lio_user_data;
}

M0_INTERNAL bool m0_be_log_io_is_empty(struct m0_be_log_io *lio)
{
        return m0_be_io_is_empty(&lio->lio_be_io);
}

#undef M0_TRACE_SUBSYSTEM

/*
 *  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
 */