38af231dec38d84798ef23ddbcbe392c1b24ac9c
[vpp.git] / src / vnet / tcp / builtin_client.h
1
2 /*
3  * tclient.h - skeleton vpp engine plug-in header file
4  *
5  * Copyright (c) <current-year> <your-organization>
6  * Licensed under the Apache License, Version 2.0 (the "License");
7  * you may not use this file except in compliance with the License.
8  * You may obtain a copy of the License at:
9  *
10  *     http://www.apache.org/licenses/LICENSE-2.0
11  *
12  * Unless required by applicable law or agreed to in writing, software
13  * distributed under the License is distributed on an "AS IS" BASIS,
14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15  * See the License for the specific language governing permissions and
16  * limitations under the License.
17  */
18 #ifndef __included_tclient_h__
19 #define __included_tclient_h__
20
21 #include <vnet/vnet.h>
22 #include <vnet/ip/ip.h>
23 #include <vnet/ethernet/ethernet.h>
24
25 #include <vppinfra/hash.h>
26 #include <vppinfra/error.h>
27 #include <vlibmemory/unix_shared_memory_queue.h>
28 #include <svm/svm_fifo_segment.h>
29 #include <vnet/session/session.h>
30 #include <vnet/session/application_interface.h>
31
32 typedef struct
33 {
34   u64 bytes_to_send;
35   u64 bytes_sent;
36   u64 bytes_to_receive;
37   u64 bytes_received;
38
39   svm_fifo_t *server_rx_fifo;
40   svm_fifo_t *server_tx_fifo;
41
42   u64 vpp_session_handle;
43 } session_t;
44
45 typedef struct
46 {
47   /*
48    * Application setup parameters
49    */
50   unix_shared_memory_queue_t *vl_input_queue;   /**< vpe input queue */
51   unix_shared_memory_queue_t *our_event_queue;  /**< Our event queue */
52   unix_shared_memory_queue_t *vpp_event_queue;  /**< $$$ single thread */
53
54   u32 cli_node_index;                   /**< cli process node index */
55   u32 my_client_index;                  /**< loopback API client handle */
56   u32 app_index;                        /**< app index after attach */
57
58   /*
59    * Configuration params
60    */
61   u8 *connect_uri;                      /**< URI for slave's connect */
62   u64 bytes_to_send;                    /**< Bytes to send */
63   u32 configured_segment_size;
64   u32 fifo_size;
65   u32 expected_connections;             /**< Number of clients/connections */
66   u32 connections_per_batch;            /**< Connections to rx/tx at once */
67   u32 private_segment_count;            /**< Number of private fifo segs */
68   u32 private_segment_size;             /**< size of private fifo segs */
69
70   /*
71    * Test state variables
72    */
73   session_t *sessions;                  /**< Sessions pool */
74   u8 *rx_buf;                           /**< intermediate rx buffer */
75   uword *session_index_by_vpp_handles;  /**< Hash table for disconnecting */
76   u8 *connect_test_data;                /**< Pre-computed test data */
77   u32 **connection_index_by_thread;
78   u32 **connections_this_batch_by_thread; /**< active connection batch */
79   pthread_t client_thread_handle;
80
81   volatile u32 ready_connections;
82   volatile u32 finished_connections;
83   volatile u64 rx_total;
84   volatile u64 tx_total;
85   volatile int run_test;                /**< Signal start of test */
86
87   f64 test_start_time;
88   f64 test_end_time;
89   u32 prev_conns;
90   u32 repeats;
91   /*
92    * Flags
93    */
94   u8 is_init;
95   u8 test_client_attached;
96   u8 no_return;
97   u8 test_return_packets;
98   int i_am_master;
99   int drop_packets;             /**< drop all packets */
100   u8 prealloc_fifos;            /**< Request fifo preallocation */
101
102   /*
103    * Convenience
104    */
105   vlib_main_t *vlib_main;
106   vnet_main_t *vnet_main;
107   ethernet_main_t *ethernet_main;
108 } tclient_main_t;
109
110 tclient_main_t tclient_main;
111
112 vlib_node_registration_t tclient_node;
113
114 #endif /* __included_tclient_h__ */
115
116 /*
117  * fd.io coding-style-patch-verification: ON
118  *
119  * Local Variables:
120  * eval: (c-set-style "gnu")
121  * End:
122  */