io.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_IO_H__
#define __MOTR_BE_IO_H__

#include "lib/chan.h"           /* m0_clink */
#include "lib/types.h"          /* m0_bcount_t */
#include "lib/atomic.h"         /* m0_atomic64 */
#include "lib/ext.h"            /* m0_ext */
#include "lib/tlist.h"          /* m0_tlink */
#include "lib/ext.h"            /* m0_ext */

#include "be/op.h"              /* m0_be_op */

#include "stob/io.h"            /* m0_stob_io */
#include "sm/sm.h"              /* m0_sm_ast */

struct m0_stob;
struct m0_be_io;
struct m0_be_io_sched;

struct m0_be_io_part {
        struct m0_stob_io bip_sio;
        struct m0_clink   bip_clink;
        struct m0_stob   *bip_stob;
        uint32_t          bip_bshift;
        struct m0_be_io  *bip_bio;
        int               bip_rc;
};

struct m0_be_io_credit {
        uint64_t    bic_reg_nr;
        m0_bcount_t bic_reg_size;
        uint64_t    bic_part_nr;
};

#define M0_BE_IO_CREDIT(reg_nr, reg_size, part_nr) (struct m0_be_io_credit){ \
        .bic_reg_nr = (reg_nr),                                              \
        .bic_reg_size = (reg_size),                                          \
        .bic_part_nr = (part_nr),                                            \
}

#define BE_IOCRED_F "(reg_nr=%" PRIu64 " reg_size=%" PRIu64 \
                    " part_nr=%" PRIu64 ")"
#define BE_IOCRED_P(iocred) \
             (iocred)->bic_reg_nr, (iocred)->bic_reg_size, (iocred)->bic_part_nr

struct m0_be_io {
        struct m0_be_io_part   *bio_part;
        struct m0_bufvec        bio_bv_user;
        struct m0_indexvec      bio_iv_stob;
        uint32_t                bio_vec_pos;
        struct m0_be_io_credit  bio_iocred;
        struct m0_be_io_credit  bio_used;
        unsigned                bio_stob_nr;
        struct m0_atomic64      bio_stob_io_finished_nr;
        struct m0_be_op        *bio_op;
        bool                    bio_sync;
        enum m0_stob_io_opcode  bio_opcode;
        struct m0_sm_ast        bio_ast;

        void                   *bio_user_data;

        /* m0_be_io_sched fields */
        struct m0_be_io_sched  *bio_sched;
        struct m0_tlink         bio_sched_link;
        uint64_t                bio_sched_magic;
        struct m0_be_op         bio_sched_op;
        struct m0_be_op        *bio_sched_op_user;
        struct m0_ext           bio_ext;
};

M0_INTERNAL int m0_be_io_init(struct m0_be_io *bio);
M0_INTERNAL void m0_be_io_fini(struct m0_be_io *bio);
M0_INTERNAL bool m0_be_io__invariant(struct m0_be_io *bio);

M0_INTERNAL int m0_be_io_allocate(struct m0_be_io        *bio,
                                  struct m0_be_io_credit *iocred);
M0_INTERNAL void m0_be_io_deallocate(struct m0_be_io *bio);


M0_INTERNAL void m0_be_io_add(struct m0_be_io *bio,
                              struct m0_stob  *stob,
                              void            *ptr_user,
                              m0_bindex_t      offset_stob,
                              m0_bcount_t      size);

M0_INTERNAL void m0_be_io_add_nostob(struct m0_be_io *bio,
                                     void            *ptr_user,
                                     m0_bindex_t      offset_stob,
                                     m0_bcount_t      size);
M0_INTERNAL void m0_be_io_stob_assign(struct m0_be_io *bio,
                                      struct m0_stob  *stob,
                                      m0_bindex_t      offset,
                                      m0_bcount_t      size);
M0_INTERNAL void m0_be_io_stob_move(struct m0_be_io *bio,
                                    struct m0_stob  *stob,
                                    m0_bindex_t      offset,
                                    m0_bindex_t      win_start,
                                    m0_bcount_t      win_size);
M0_INTERNAL void m0_be_io_vec_pack(struct m0_be_io *bio);
M0_INTERNAL m0_bcount_t m0_be_io_size(struct m0_be_io *bio);

M0_INTERNAL void m0_be_io_sync_enable(struct m0_be_io *bio);
M0_INTERNAL bool m0_be_io_sync_is_enabled(struct m0_be_io *bio);

M0_INTERNAL enum m0_stob_io_opcode m0_be_io_opcode(struct m0_be_io *io);

M0_INTERNAL void m0_be_io_configure(struct m0_be_io        *bio,
                                    enum m0_stob_io_opcode  opcode);

M0_INTERNAL void m0_be_io_launch(struct m0_be_io *bio, struct m0_be_op *op);

M0_INTERNAL bool m0_be_io_is_empty(struct m0_be_io *bio);
M0_INTERNAL void m0_be_io_reset(struct m0_be_io *bio);
M0_INTERNAL void m0_be_io_sort(struct m0_be_io *bio);

M0_INTERNAL void m0_be_io_user_data_set(struct m0_be_io *bio, void *data);
M0_INTERNAL void *m0_be_io_user_data(struct m0_be_io *bio);

M0_INTERNAL int m0_be_io_single(struct m0_stob         *stob,
                                enum m0_stob_io_opcode  opcode,
                                void                   *ptr_user,
                                m0_bindex_t             offset_stob,
                                m0_bcount_t             size);

M0_INTERNAL bool m0_be_io_intersect(const struct m0_be_io *bio1,
                                    const struct m0_be_io *bio2);

M0_INTERNAL bool m0_be_io_ptr_user_is_eq(const struct m0_be_io *bio1,
                                         const struct m0_be_io *bio2);
M0_INTERNAL bool m0_be_io_offset_stob_is_eq(const struct m0_be_io *bio1,
                                            const struct m0_be_io *bio2);


M0_INTERNAL void m0_be_io_credit_add(struct m0_be_io_credit       *iocred0,
                                     const struct m0_be_io_credit *iocred1);

M0_INTERNAL bool m0_be_io_credit_le(const struct m0_be_io_credit *iocred0,
                                    const struct m0_be_io_credit *iocred1);

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