bulk.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_RPC_BULK_H__
#define __MOTR_RPC_BULK_H__

#include "lib/vec.h"
#include "lib/tlist.h"
#include "lib/mutex.h"
#include "lib/chan.h"
#include "net/net.h"
#include "xcode/xcode.h"          /* M0_XCA_ENUM */

struct m0_rpc_conn;

enum m0_rpc_bulk_op_states {
        M0_RPC_BULK_OP_INITIATE,
        M0_RPC_BULK_OP_FINISH,
} M0_XCA_ENUM;

enum {
        M0_RPC_BULK_NETBUF_ALLOCATED   = (1 << 0),
        M0_RPC_BULK_NETBUF_REGISTERED  = (1 << 1),
        M0_RPC_BULK_NETBUF_QUEUED      = (1 << 2),

        M0_RPC_BULK_TMO = 60
};

struct m0_rpc_bulk_buf {
        uint64_t              bb_magic;
        struct m0_net_buffer *bb_nbuf;
        struct m0_0vec        bb_zerovec;
        struct m0_tlink       bb_link;
        struct m0_rpc_bulk   *bb_rbulk;
        uint64_t              bb_flags;
};

M0_INTERNAL int m0_rpc_bulk_buf_add(struct m0_rpc_bulk *rbulk,
                                    uint32_t segs_nr, m0_bcount_t length,
                                    struct m0_net_domain *netdom,
                                    struct m0_net_buffer *nb,
                                    struct m0_rpc_bulk_buf **out);

M0_INTERNAL int m0_rpc_bulk_buf_databuf_add(struct m0_rpc_bulk_buf *rbuf,
                                            void *buf,
                                            m0_bcount_t count,
                                            m0_bindex_t index,
                                            struct m0_net_domain *netdom);

struct m0_rpc_bulk {
        uint64_t        rb_magic;
        struct m0_mutex rb_mutex;
        struct m0_tl    rb_buflist;
        struct m0_chan  rb_chan;
        m0_bcount_t     rb_bytes;
        int32_t         rb_rc;
        uint64_t        rb_id;
};

M0_INTERNAL void m0_rpc_bulk_init(struct m0_rpc_bulk *rbulk);

M0_INTERNAL void m0_rpc_bulk_buflist_empty(struct m0_rpc_bulk *rbulk);

M0_INTERNAL void m0_rpc_bulk_fini(struct m0_rpc_bulk *rbulk);

enum m0_rpc_bulk_op_type {
        M0_RPC_BULK_STORE = (1 << 0),
        M0_RPC_BULK_LOAD  = (1 << 1),
} M0_XCA_ENUM;

M0_INTERNAL void m0_rpc_bulk_qtype(struct m0_rpc_bulk *rbulk,
                                   enum m0_net_queue_type q);

M0_INTERNAL int
m0_rpc_bulk_store(struct m0_rpc_bulk                   *rbulk,
                  const struct m0_rpc_conn             *conn,
                  struct m0_net_buf_desc_data          *to_desc,
                  const struct m0_net_buffer_callbacks *bulk_cb);

M0_INTERNAL int
m0_rpc_bulk_load(struct m0_rpc_bulk                   *rbulk,
                 const struct m0_rpc_conn             *conn,
                 struct m0_net_buf_desc_data          *from_desc,
                 const struct m0_net_buffer_callbacks *bulk_cb);

M0_INTERNAL void m0_rpc_bulk_store_del(struct m0_rpc_bulk *rbulk);

M0_INTERNAL size_t m0_rpc_bulk_store_del_unqueued(struct m0_rpc_bulk *rbulk);

M0_INTERNAL void m0_rpc_bulk_default_cb(const struct m0_net_buffer_event *evt);

extern const struct m0_net_buffer_callbacks m0_rpc__buf_bulk_cb;

M0_INTERNAL size_t m0_rpc_bulk_buf_length(struct m0_rpc_bulk *rbulk);

M0_INTERNAL bool m0_rpc_bulk_is_empty(struct m0_rpc_bulk *rbulk);

#endif

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