network.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_NET_TEST_NETWORK_H__
#define __MOTR_NET_TEST_NETWORK_H__

#include "net/net.h"
#include "net/test/serialize.h"         /* m0_net_test_serialize_op */
#include "net/test/slist.h"             /* m0_net_test_slist */

enum m0_net_test_network_buf_type {
        M0_NET_TEST_BUF_BULK,   
        M0_NET_TEST_BUF_PING,   
};

struct m0_net_test_network_ctx;

typedef void (*m0_net_test_network_buffer_cb_proc_t)
        (struct m0_net_test_network_ctx   *ctx,
         const uint32_t                    buf_index,
         enum m0_net_queue_type            q,
         const struct m0_net_buffer_event *ev);

struct m0_net_test_network_buffer_callbacks {
        m0_net_test_network_buffer_cb_proc_t ntnbc_cb[M0_NET_QT_NR];
};

struct m0_net_test_network_timeouts {
        m0_time_t ntnt_timeout[M0_NET_QT_NR];
};

struct m0_net_test_network_cfg {
        struct m0_net_tm_callbacks                  ntncfg_tm_cb;
        struct m0_net_test_network_buffer_callbacks ntncfg_buf_cb;
        m0_bcount_t                                 ntncfg_buf_size_ping;
        uint32_t                                    ntncfg_buf_ping_nr;
        m0_bcount_t                                 ntncfg_buf_size_bulk;
        uint32_t                                    ntncfg_buf_bulk_nr;
        uint32_t                                    ntncfg_ep_max;
        struct m0_net_test_network_timeouts         ntncfg_timeouts;
        bool                                        ntncfg_sync;
};

struct m0_net_test_network_ctx {
        struct m0_net_test_network_cfg              ntc_cfg;
        struct m0_net_domain                       *ntc_dom;
        struct m0_net_transfer_mc                  *ntc_tm;
        struct m0_net_buffer                       *ntc_buf_ping;
        struct m0_net_buffer                       *ntc_buf_bulk;
        struct m0_net_end_point                   **ntc_ep;
        uint32_t                                    ntc_ep_nr;
};

int m0_net_test_network_ctx_init(struct m0_net_test_network_ctx *ctx,
                                 struct m0_net_test_network_cfg *cfg,
                                 const char *tm_addr);
void m0_net_test_network_ctx_fini(struct m0_net_test_network_ctx *ctx);
bool m0_net_test_network_ctx_invariant(struct m0_net_test_network_ctx *ctx);

int m0_net_test_network_ep_add(struct m0_net_test_network_ctx *ctx,
                               const char *ep_addr);

int m0_net_test_network_ep_add_slist(struct m0_net_test_network_ctx *ctx,
                                     const struct m0_net_test_slist *eps);

int m0_net_test_network_msg_send(struct m0_net_test_network_ctx *ctx,
                                 uint32_t buf_ping_index,
                                 uint32_t ep_index);

int m0_net_test_network_msg_send_ep(struct m0_net_test_network_ctx *ctx,
                                    uint32_t buf_ping_index,
                                    struct m0_net_end_point *ep);

int m0_net_test_network_msg_recv(struct m0_net_test_network_ctx *ctx,
                                 uint32_t buf_ping_index);

int m0_net_test_network_bulk_enqueue(struct m0_net_test_network_ctx *ctx,
                                     int32_t buf_bulk_index,
                                     int32_t ep_index,
                                     enum m0_net_queue_type q);
void m0_net_test_network_buffer_dequeue(struct m0_net_test_network_ctx *ctx,
                                        enum m0_net_test_network_buf_type
                                        buf_type,
                                        int32_t buf_index);

m0_bcount_t
m0_net_test_network_bd_serialize(enum m0_net_test_serialize_op op,
                                 struct m0_net_test_network_ctx *ctx,
                                 uint32_t buf_bulk_index,
                                 uint32_t buf_ping_index,
                                 m0_bcount_t offset);

size_t m0_net_test_network_bd_nr(struct m0_net_test_network_ctx *ctx,
                                 uint32_t buf_ping_index);

void m0_net_test_network_bd_nr_dec(struct m0_net_test_network_ctx *ctx,
                                   uint32_t buf_ping_index);

struct m0_net_buffer *
m0_net_test_network_buf(struct m0_net_test_network_ctx *ctx,
                        enum m0_net_test_network_buf_type buf_type,
                        uint32_t buf_index);

int m0_net_test_network_buf_resize(struct m0_net_test_network_ctx *ctx,
                                   enum m0_net_test_network_buf_type buf_type,
                                   uint32_t buf_index,
                                   m0_bcount_t new_size);

void m0_net_test_network_buf_fill(struct m0_net_test_network_ctx *ctx,
                                  enum m0_net_test_network_buf_type buf_type,
                                  uint32_t buf_index,
                                  uint8_t fill);

struct m0_net_end_point *
m0_net_test_network_ep(struct m0_net_test_network_ctx *ctx, size_t ep_index);

ssize_t m0_net_test_network_ep_search(struct m0_net_test_network_ctx *ctx,
                                      const char *ep_addr);

struct m0_net_test_network_timeouts m0_net_test_network_timeouts_never(void);

#endif /*  __MOTR_NET_TEST_NETWORK_H__ */

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