io_fops.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_IOSERVICE_IO_FOPS_H__
#define __MOTR_IOSERVICE_IO_FOPS_H__

#include "fop/fop.h"
#include "fop/fop_xc.h"
#include "fop/fom_generic.h"
#include "fop/fom_generic_xc.h"
#include "lib/types.h"
#include "rpc/rpc.h"
#include "xcode/xcode_attr.h"
#include "net/net_otw_types.h"
#include "net/net_otw_types_xc.h"
#include "fid/fid.h"
#include "fid/fid_xc.h"
#include "lib/buf.h"
#include "lib/buf_xc.h"
#include "lib/vec_xc.h"
#include "mdservice/md_fops.h"
#include "mdservice/md_fops_xc.h"

struct m0_io_fop {
        struct m0_fop           if_fop;
        int                     if_bulk_inited;
        struct m0_rpc_bulk      if_rbulk;
        uint64_t                if_magic;
};

M0_INTERNAL int m0_io_fop_init(struct m0_io_fop *iofop,
                               const struct m0_fid *gfid,
                               struct m0_fop_type *ftype,
                               void (*fop_release)(struct m0_ref *));

M0_INTERNAL void m0_io_fop_fini(struct m0_io_fop *iofop);

M0_INTERNAL struct m0_rpc_bulk *m0_fop_to_rpcbulk(const struct m0_fop *fop);

M0_INTERNAL int m0_io_fop_prepare(struct m0_fop *fop);

M0_INTERNAL void m0_io_fop_destroy(struct m0_fop *fop);

M0_INTERNAL bool m0_is_read_fop(const struct m0_fop *fop);
M0_INTERNAL bool m0_is_write_fop(const struct m0_fop *fop);
M0_INTERNAL bool m0_is_read_rep(const struct m0_fop *fop);
M0_INTERNAL bool m0_is_write_rep(const struct m0_fop *fop);
M0_INTERNAL bool m0_is_io_fop(const struct m0_fop *fop);
M0_INTERNAL bool m0_is_io_fop_rep(const struct m0_fop *fop);
M0_INTERNAL struct m0_fop_cob_rw *io_rw_get(struct m0_fop *fop);
M0_INTERNAL struct m0_fop_cob_rw_reply *io_rw_rep_get(struct m0_fop *fop);
M0_INTERNAL bool m0_is_cob_create_fop(const struct m0_fop *fop);
M0_INTERNAL bool m0_is_cob_delete_fop(const struct m0_fop *fop);
M0_INTERNAL bool m0_is_cob_truncate_fop(const struct m0_fop *fop);
M0_INTERNAL bool m0_is_cob_create_delete_fop(const struct m0_fop *fop);
M0_INTERNAL bool m0_is_cob_getattr_fop(const struct m0_fop *fop);
M0_INTERNAL bool m0_is_cob_setattr_fop(const struct m0_fop *fop);
M0_INTERNAL struct m0_fop_cob_common *m0_cobfop_common_get(struct m0_fop *fop);

M0_INTERNAL void m0_dump_cob_attr(const struct m0_cob_attr *attr);
struct page;
struct m0_io_ioseg;

M0_INTERNAL int m0_ioservice_fop_init(void);
M0_INTERNAL void m0_ioservice_fop_fini(void);

extern struct m0_fop_type m0_fop_cob_readv_fopt;
extern struct m0_fop_type m0_fop_cob_writev_fopt;
extern struct m0_fop_type m0_fop_cob_readv_rep_fopt;
extern struct m0_fop_type m0_fop_cob_writev_rep_fopt;
extern struct m0_fop_type m0_fop_cob_create_fopt;
extern struct m0_fop_type m0_fop_cob_delete_fopt;
extern struct m0_fop_type m0_fop_cob_truncate_fopt;
extern struct m0_fop_type m0_fop_cob_op_reply_fopt;
extern struct m0_fop_type m0_fop_fv_notification_fopt;
extern struct m0_fop_type m0_fop_cob_getattr_fopt;
extern struct m0_fop_type m0_fop_cob_getattr_reply_fopt;
extern struct m0_fop_type m0_fop_fsync_ios_fopt;
extern struct m0_fop_type m0_fop_cob_setattr_fopt;
extern struct m0_fop_type m0_fop_cob_setattr_reply_fopt;

extern struct m0_fom_type m0_io_fom_cob_rw_fomt;

M0_INTERNAL struct m0_fop_cob_rw *io_rw_get(struct m0_fop *fop);
M0_INTERNAL struct m0_fop_cob_rw_reply *io_rw_rep_get(struct m0_fop *fop);

M0_INTERNAL size_t m0_io_fop_size_get(struct m0_fop *fop);

M0_INTERNAL void m0_io_fop_release(struct m0_ref *ref);

M0_INTERNAL uint32_t m0_io_fop_segs_nr(struct m0_fop *fop, uint32_t index);

/* Returns the number of bytes to be read/written. */
M0_INTERNAL m0_bcount_t m0_io_fop_byte_count(struct m0_io_fop *iofop);

struct m0_io_descs {
        uint32_t                     id_nr;
        struct m0_net_buf_desc_data *id_descs;
} M0_XCA_SEQUENCE M0_XCA_DOMAIN(rpc);

struct m0_fop_cob_rw_reply {
        int32_t                 rwr_rc;

        uint64_t                rwr_count;

        uint32_t                rwr_repair_done;

        uint32_t                rwr_cksum_nob_read;

        struct m0_fop_mod_rep   rwr_mod_rep;

        struct m0_buf           rwr_di_data_cksum;
} M0_XCA_RECORD M0_XCA_DOMAIN(rpc);

struct m0_fop_cob_readv_rep {
        int32_t                    c_rc;
        struct m0_fop_cob_rw_reply c_rep;
} M0_XCA_RECORD M0_XCA_DOMAIN(rpc);

struct m0_fop_cob_writev_rep {
        int32_t                    c_rc;
        struct m0_fop_cob_rw_reply c_rep;
} M0_XCA_RECORD M0_XCA_DOMAIN(rpc);

enum m0_io_flags {
        M0_IO_FLAG_CROW   = (1 << 0), 
        M0_IO_FLAG_NOHOLE = (1 << 1), 
        M0_IO_FLAG_SYNC   = (1 << 2)
};

struct m0_fop_cob_rw {
        struct m0_fid             crw_gfid;

        struct m0_fid             crw_fid;

        uint32_t                  crw_index;

        struct m0_fid             crw_pver;

        uint64_t                  crw_lid;

        struct m0_io_descs        crw_desc;

        struct m0_io_indexvec     crw_ivec;
        uint64_t                  crw_flags;
        m0_bcount_t               crw_cksum_size;
        struct m0_buf             crw_di_data;
        struct m0_buf             crw_di_data_cksum;
} M0_XCA_RECORD M0_XCA_DOMAIN(rpc);

struct m0_fop_cob_readv {
        struct m0_fop_cob_rw c_rwv;
} M0_XCA_RECORD M0_XCA_DOMAIN(rpc);

struct m0_fop_cob_writev {
        struct m0_fop_cob_rw c_rwv;
} M0_XCA_RECORD M0_XCA_DOMAIN(rpc);

struct m0_test_ios_fop {
        uint64_t               if_st;
        struct m0_net_buf_desc if_nbd;
} M0_XCA_RECORD M0_XCA_DOMAIN(rpc);

struct m0_fop_cob_common {
        struct m0_fop_cob    c_body;
        struct m0_fid        c_gobfid;

        struct m0_fid        c_cobfid;

        struct m0_fid        c_pver;

        uint32_t             c_cob_idx;

        uint32_t             c_cob_type;

        uint64_t             c_flags;
} M0_XCA_RECORD M0_XCA_DOMAIN(rpc);

struct m0_fop_cob_create {
        struct m0_fop_cob_common cc_common;
} M0_XCA_RECORD M0_XCA_DOMAIN(rpc);

struct m0_fop_cob_delete {
        struct m0_fop_cob_common cd_common;
} M0_XCA_RECORD M0_XCA_DOMAIN(rpc);

struct m0_fop_cob_truncate {
        struct m0_fop_cob_common ct_common;

        /* Size to which a file is truncated. */
        uint64_t                 ct_size;
        /* Range to be truncated */
        struct m0_io_indexvec    ct_io_ivec;
} M0_XCA_RECORD M0_XCA_DOMAIN(rpc);

struct m0_fop_cob_op_rep_common {
        struct m0_fop_mod_rep   cor_mod_rep;
} M0_XCA_RECORD M0_XCA_DOMAIN(rpc);

struct m0_fop_cob_op_reply {
        int32_t                         cor_rc;
        struct m0_fop_cob_op_rep_common cor_common;
} M0_XCA_RECORD M0_XCA_DOMAIN(rpc);

struct m0_fop_cob_getattr {
        struct m0_fop_cob_common cg_common;
} M0_XCA_RECORD M0_XCA_DOMAIN(rpc);

struct m0_fop_cob_getattr_reply {
        int32_t                         cgr_rc;
        struct m0_fop_cob_op_rep_common cgr_common;
        struct m0_fop_cob               cgr_body;
} M0_XCA_RECORD M0_XCA_DOMAIN(rpc);

struct m0_fop_cob_setattr {
        struct m0_fop_cob_common cs_common;
} M0_XCA_RECORD M0_XCA_DOMAIN(rpc);

struct m0_fop_cob_setattr_reply {
        int32_t                         csr_rc;
        struct m0_fop_cob_op_rep_common csr_common;
} M0_XCA_RECORD M0_XCA_DOMAIN(rpc);

/* __MOTR_IOSERVICE_IO_FOPS_H__ */
#endif

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