commands.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_COMMANDS_H__
#define __MOTR_NET_TEST_COMMANDS_H__

#include "lib/semaphore.h"              /* m0_semaphore */

#include "net/test/slist.h"             /* m0_net_test_slist */
#include "net/test/ringbuf.h"           /* m0_net_test_ringbuf */
#include "net/test/stats.h"             /* m0_net_test_stats */
#include "net/test/network.h"           /* m0_net_test_network_ctx */

enum {
        M0_NET_TEST_CMD_SIZE_MAX = 16384,
};

enum m0_net_test_role {
        M0_NET_TEST_ROLE_CLIENT,
        M0_NET_TEST_ROLE_SERVER
};

enum m0_net_test_type {
        M0_NET_TEST_TYPE_PING,
        M0_NET_TEST_TYPE_BULK,
        M0_NET_TEST_TYPE_STUB,
};

enum m0_net_test_cmd_type {
        M0_NET_TEST_CMD_INIT = 0,
        M0_NET_TEST_CMD_INIT_DONE,
        M0_NET_TEST_CMD_START,
        M0_NET_TEST_CMD_START_DONE,
        M0_NET_TEST_CMD_STATUS,
        M0_NET_TEST_CMD_STATUS_DATA,
        M0_NET_TEST_CMD_STOP,
        M0_NET_TEST_CMD_STOP_DONE,
        M0_NET_TEST_CMD_NR,
};

struct m0_net_test_cmd_done {
        int ntcd_errno;
};

struct m0_net_test_cmd_init {
        enum m0_net_test_role    ntci_role;
        enum m0_net_test_type    ntci_type;
        uint64_t                 ntci_msg_nr;
        m0_bcount_t              ntci_msg_size;
        uint64_t                 ntci_bd_buf_nr;
        m0_bcount_t              ntci_bd_buf_size;
        uint64_t                 ntci_bd_nr_max;
        uint64_t                 ntci_msg_concurrency;
        m0_time_t                ntci_buf_send_timeout;
        m0_time_t                ntci_buf_bulk_timeout;
        char                    *ntci_tm_ep;
        struct m0_net_test_slist ntci_ep;
};

struct m0_net_test_cmd_status_data {
        struct m0_net_test_msg_nr ntcsd_msg_nr_send;
        struct m0_net_test_msg_nr ntcsd_msg_nr_recv;
        struct m0_net_test_msg_nr ntcsd_bulk_nr_send;
        struct m0_net_test_msg_nr ntcsd_bulk_nr_recv;
        struct m0_net_test_msg_nr ntcsd_transfers;
        m0_time_t                 ntcsd_time_start;
        m0_time_t                 ntcsd_time_finish;
        m0_time_t                 ntcsd_time_now;
        bool                      ntcsd_finished;
        struct m0_net_test_mps    ntcsd_mps_send;
        struct m0_net_test_mps    ntcsd_mps_recv;
        struct m0_net_test_stats  ntcsd_rtt;
};

struct m0_net_test_cmd {
        enum m0_net_test_cmd_type ntc_type;
        union {
                struct m0_net_test_cmd_done        ntc_done;
                struct m0_net_test_cmd_init        ntc_init;
                struct m0_net_test_cmd_status_data ntc_status_data;
        };
        ssize_t ntc_ep_index;
        size_t  ntc_buf_index;
};

struct m0_net_test_cmd_buf_status {
        struct m0_net_end_point *ntcbs_ep;
        int                      ntcbs_buf_status;
        bool                     ntcbs_in_recv_queue;
};

struct m0_net_test_cmd_ctx;

typedef void (*m0_net_test_commands_send_cb_t)(struct m0_net_test_cmd_ctx *ctx,
                                               size_t ep_index,
                                               int buf_status);

struct m0_net_test_cmd_ctx {
        struct m0_net_test_network_ctx     ntcc_net;
        struct m0_net_test_ringbuf         ntcc_rb;
        size_t                             ntcc_ep_nr;
        struct m0_semaphore                ntcc_sem_send;
        struct m0_semaphore                ntcc_sem_recv;
        m0_net_test_commands_send_cb_t     ntcc_send_cb;
        size_t                             ntcc_send_nr;
        struct m0_mutex                    ntcc_send_mutex;
        struct m0_net_test_cmd_buf_status *ntcc_buf_status;
};

int m0_net_test_commands_init(struct m0_net_test_cmd_ctx *ctx,
                              const char *cmd_ep,
                              m0_time_t send_timeout,
                              m0_net_test_commands_send_cb_t send_cb,
                              struct m0_net_test_slist *ep_list);
void m0_net_test_commands_fini(struct m0_net_test_cmd_ctx *ctx);

bool m0_net_test_commands_invariant(struct m0_net_test_cmd_ctx *ctx);

int m0_net_test_commands_send(struct m0_net_test_cmd_ctx *ctx,
                              struct m0_net_test_cmd *cmd);
void m0_net_test_commands_send_wait_all(struct m0_net_test_cmd_ctx *ctx);

int m0_net_test_commands_recv(struct m0_net_test_cmd_ctx *ctx,
                              struct m0_net_test_cmd *cmd,
                              m0_time_t deadline);
int m0_net_test_commands_recv_enqueue(struct m0_net_test_cmd_ctx *ctx,
                                      size_t buf_index);
void m0_net_test_commands_received_free(struct m0_net_test_cmd *cmd);

#endif /*  __MOTR_NET_TEST_COMMANDS_H__ */

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