io.h

Go to the documentation of this file.

/* -*- C -*- */
/*
 * Copyright (c) 2014-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_STOB_IO_H__
#define __MOTR_STOB_IO_H__

#include "lib/vec.h"            /* m0_bufvec */
#include "lib/chan.h"           /* m0_chan */
#include "lib/mutex.h"          /* m0_mutex */
#include "xcode/xcode.h"          /* M0_XCA_ENUM */

struct m0_stob;
struct m0_stob_domain;
struct m0_be_tx_credit;

enum m0_stob_io_opcode {
        SIO_INVALID,
        SIO_READ,
        SIO_WRITE,
        SIO_BARRIER,
        SIO_SYNC
};

enum m0_stob_io_state {
        SIS_ZERO = 0,
        SIS_IDLE,
        SIS_PREPARED,
        SIS_BUSY,
};

enum m0_stob_io_flags {
        SIF_PREFIX       = (1 << 0),
        SIF_NOHOLE       = (1 << 1),
};

struct m0_stob_io {
        enum m0_stob_io_opcode      si_opcode;
        enum m0_stob_io_flags       si_flags;
        struct m0_bufvec            si_user;
        struct m0_indexvec          si_stob;
        struct m0_chan              si_wait;
        struct m0_mutex             si_mutex; 
        /* The fields below are modified only by an adieu implementation. */

        struct m0_stob             *si_obj;
        const struct m0_stob_io_op *si_op;
        int32_t                     si_rc;
        m0_bcount_t                 si_count;
        enum m0_stob_io_state       si_state;
        struct m0_dtx              *si_tx;
        struct m0_io_scope         *si_scope;
        void                       *si_stob_private;
        uint32_t                    si_stob_magic;
        struct m0_fol_frag         *si_fol_frag;
        struct m0_bufvec            si_battr;
        m0_time_t                   si_start;
        uint64_t                    si_id;

        /* This checksum should be for stob IO, 
         * During Write will be populated checksum in this from request FOP  
         * During Read stob IO code will populate this  
         */
        struct m0_buf               si_cksum;
        /* Size of a Data Unit for which checksum is computed */
        m0_bindex_t                 si_unit_sz;
        /* Size of single unit of checksum e.g md5 checksum with digest has 128 byte size */
        m0_bcount_t                 si_cksum_sz;
        /* Size of checksum actually put into buffer*/
        m0_bcount_t si_cksum_nob_read;
};

struct m0_stob_io_op {
        void (*sio_fini)(struct m0_stob_io *io);
        int  (*sio_launch)(struct m0_stob_io *io);
        int  (*sio_prepare)(struct m0_stob_io *io);
};

M0_INTERNAL void m0_stob_io_init(struct m0_stob_io *io);

M0_INTERNAL void m0_stob_io_fini(struct m0_stob_io *io);

M0_INTERNAL void m0_stob_io_credit(const struct m0_stob_io *io,
                                   const struct m0_stob_domain *dom,
                                   struct m0_be_tx_credit *accum);

M0_INTERNAL int m0_stob_io_launch(struct m0_stob_io *io, struct m0_stob *obj,
                                  struct m0_dtx *tx, struct m0_io_scope *scope);

M0_INTERNAL int m0_stob_io_prepare(struct m0_stob_io *io,
                                   struct m0_stob *obj,
                                   struct m0_dtx *tx,
                                   struct m0_io_scope *scope);

M0_INTERNAL int m0_stob_io_prepare_and_launch(struct m0_stob_io *io,
                                              struct m0_stob *obj,
                                              struct m0_dtx *tx,
                                              struct m0_io_scope *scope);

M0_INTERNAL bool m0_stob_io_user_is_valid(const struct m0_bufvec *user);

M0_INTERNAL bool m0_stob_io_stob_is_valid(const struct m0_indexvec *stob);

M0_INTERNAL int m0_stob_io_bufvec_launch(struct m0_stob   *stob,
                                         struct m0_bufvec *bufvec,
                                         int               op_code,
                                         m0_bindex_t       offset);


M0_INTERNAL void *m0_stob_addr_pack(const void *buf, uint32_t shift);

M0_INTERNAL void *m0_stob_addr_open(const void *buf, uint32_t shift);

M0_INTERNAL void m0_stob_iovec_sort(struct m0_stob_io *stob);

M0_INTERNAL int m0_stob_io_private_setup(struct m0_stob_io *io,
                                         struct m0_stob *obj);
#endif /* __MOTR_STOB_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
 */