io_foms.h

Go to the documentation of this file.

/* -*- C -*- */
/*
 * Copyright (c) 2012-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_IOSERVICE_IO_FOMS_H__
#define __MOTR_IOSERVICE_IO_FOMS_H__

#include "reqh/reqh.h"     /* M0_FOPH_NR */
#include "fop/fop.h"
#include "ioservice/io_fops.h"
#include "stob/stob.h"
#include "net/net.h"
#include "fop/fom.h"
#include "stob/io.h"       /* m0_stob_io */
#include "cob/cob.h"       /* m0_cob */

struct m0_fid;
struct m0_fop_file_fid;
struct m0_io_fom_cob_rw;

struct m0_stob_io_desc {
        uint64_t                 siod_magic;
        struct m0_stob_io        siod_stob_io;
        struct m0_tlink          siod_linkage;
        struct m0_fom_callback   siod_fcb;
        struct m0_fol_frag       siod_fol_frag;
};

struct m0_io_fom_cob_rw {
        struct m0_fom                    fcrw_gen;
        struct m0_pool_version          *fcrw_pver;
        uint32_t                         fcrw_ndesc;
        int                              fcrw_curr_desc_index;
        m0_bcount_t                      fcrw_total_ioivec_cnt;
        m0_bcount_t                      fcrw_curr_size;
        uint32_t                         fcrw_batch_size;
        m0_bcount_t                      fcrw_req_count;
        m0_bcount_t                      fcrw_count;
        uint32_t                         fcrw_bshift;
        uint64_t                         fcrw_cob_size;

        struct m0_stob_io                fcrw_io;

        uint32_t                         fcrw_num_stobio_launched;
        struct m0_net_buffer_pool       *fcrw_bp;
        struct m0_stob                  *fcrw_stob;
        struct m0_cob                   *fcrw_cob;
        struct m0_stob_io_desc          *fcrw_stio;
        struct m0_tl                     fcrw_stio_list;
        struct m0_tl                     fcrw_done_list;
        struct m0_rpc_bulk               fcrw_bulk;
        m0_time_t                        fcrw_fom_start_time;
        m0_time_t                        fcrw_phase_start_time;
        struct m0_tl                     fcrw_netbuf_list;
        int                              fcrw_rc;
        struct m0_fol_frag               fcrw_fol_frag;
        m0_time_t                        fcrw_io_launch_time;
        uint64_t                         fcrw_flags;
};

enum m0_io_fom_cob_rw_phases {
        M0_FOPH_IO_FOM_PREPARE = M0_FOPH_TYPE_SPECIFIC,
        M0_FOPH_IO_FOM_BUFFER_ACQUIRE,
        M0_FOPH_IO_FOM_BUFFER_WAIT,
        M0_FOPH_IO_STOB_INIT,
        M0_FOPH_IO_STOB_WAIT,
        M0_FOPH_IO_ZERO_COPY_INIT,
        M0_FOPH_IO_ZERO_COPY_WAIT,
        M0_FOPH_IO_BUFFER_RELEASE,
        M0_FOPH_IO_SYNC
};

struct m0_io_fom_cob_rw_state_transition {
        int         fcrw_st_current_phase;
        int         (*fcrw_st_state_function)(struct m0_fom *);
        int         fcrw_st_next_phase_again;
        int         fcrw_st_next_phase_wait;
        const char *fcrw_st_desc;
};

M0_INTERNAL const char *m0_io_fom_cob_rw_service_name(struct m0_fom *fom);

M0_INTERNAL int m0_io_cob_create(struct m0_cob_domain *cdom,
                                 struct m0_fid *fid,
                                 struct m0_fid *pver,
                                 uint64_t lid,
                                 struct m0_be_tx *tx);
M0_INTERNAL int m0_io_cob_stob_create(struct m0_fom *fom,
                                      struct m0_cob_domain *ios_cdom,
                                      struct m0_fid *fid,
                                      struct m0_fid *pver,
                                      uint64_t lid,
                                      bool crow,
                                      struct m0_cob **out);

M0_INTERNAL uint64_t m0_io_size(struct m0_stob_io *sio, uint32_t bshift);

#endif /* __MOTR_IOSERVICE_IO_FOMS_H__ */
 /*
 *  Local variables:
 *  c-indentation-style: "K&R"
 *  c-basic-offset: 8
 *  tab-width: 8
 *  fill-column: 80
 *  scroll-step: 1
 *  End:
 */