b5f6c981f7b4043a52b8f88e3e22750eb90b8869
[vpp.git] / src / plugins / hs_apps / echo_client.h
1
2 /*
3  * echo_client.h - built-in application layer echo client
4  *
5  * Copyright (c) 2017-2019 Cisco and/or its affiliates.
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_echo_client_h__
19 #define __included_echo_client_h__
20
21 #include <vnet/session/session.h>
22 #include <vnet/session/application_interface.h>
23
24 typedef struct ec_session_
25 {
26   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
27   app_session_t data;
28   u32 vpp_session_index;
29   u32 thread_index;
30   u64 bytes_to_send;
31   u64 bytes_sent;
32   u64 bytes_to_receive;
33   u64 bytes_received;
34   u64 vpp_session_handle;
35 } ec_session_t;
36
37 typedef struct ec_worker_
38 {
39   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
40   ec_session_t *sessions;       /**< session pool */
41   u8 *rx_buf;                   /**< prealloced rx buffer */
42   u32 *conn_indices;            /**< sessions handled by worker */
43   u32 *conns_this_batch;        /**< sessions handled in batch */
44   svm_msg_q_t *vpp_event_queue; /**< session layer worker mq */
45   u32 thread_index;             /**< thread index for worker */
46 } ec_worker_t;
47
48 typedef struct
49 {
50   ec_worker_t *wrk;              /**< Per-thread state */
51   u8 *connect_test_data;         /**< Pre-computed test data */
52
53   volatile u32 ready_connections;
54   volatile u64 rx_total;
55   volatile u64 tx_total;
56   volatile int run_test; /**< Signal start of test */
57
58   f64 syn_start_time;
59   f64 test_start_time;
60   f64 test_end_time;
61   u32 prev_conns;
62   u32 repeats;
63
64   u32 connect_conn_index; /**< Connects attempted progress */
65
66   /*
67    * Application setup parameters
68    */
69
70   u32 cli_node_index;                   /**< cli process node index */
71   u32 app_index;                        /**< app index after attach */
72
73   /*
74    * Configuration params
75    */
76   u32 n_clients;                        /**< Number of clients */
77   u8 *connect_uri;                      /**< URI for slave's connect */
78   session_endpoint_cfg_t connect_sep;   /**< Sever session endpoint */
79   u64 bytes_to_send;                    /**< Bytes to send */
80   u32 configured_segment_size;
81   u32 fifo_size;
82   u32 expected_connections;             /**< Number of clients/connections */
83   u32 connections_per_batch;            /**< Connections to rx/tx at once */
84   u32 private_segment_count;            /**< Number of private fifo segs */
85   u64 private_segment_size;             /**< size of private fifo segs */
86   u32 tls_engine;                       /**< TLS engine mbedtls/openssl */
87   u8 is_dgram;
88   u32 no_copy;                          /**< Don't memcpy data to tx fifo */
89   u32 quic_streams;                     /**< QUIC streams per connection */
90   u32 ckpair_index;                     /**< Cert key pair for tls/quic */
91   u64 attach_flags;                     /**< App attach flags */
92   u8 *appns_id;                         /**< App namespaces id */
93   u64 appns_secret;                     /**< App namespace secret */
94   f64 syn_timeout;                      /**< Test syn timeout (s) */
95   f64 test_timeout;                     /**< Test timeout (s) */
96
97   /*
98    * Flags
99    */
100   u8 app_is_init;
101   u8 test_client_attached;
102   u8 no_return;
103   u8 test_return_packets;
104   int drop_packets;             /**< drop all packets */
105   u8 prealloc_fifos;            /**< Request fifo preallocation */
106   u8 prealloc_sessions;
107   u8 no_output;
108   u8 test_bytes;
109   u8 test_failed;
110   u8 transport_proto;
111   u8 barrier_acq_needed;
112
113   vlib_main_t *vlib_main;
114 } ec_main_t;
115
116 typedef enum ec_state_
117 {
118   EC_STARTING,
119   EC_RUNNING,
120   EC_EXITING
121 } ec_state_t;
122
123 typedef enum ec_cli_signal_
124 {
125   EC_CLI_CONNECTS_DONE = 1,
126   EC_CLI_CONNECTS_FAILED,
127   EC_CLI_TEST_DONE
128 } ec_cli_signal_t;
129
130 void ec_program_connects (void);
131
132 #endif /* __included_echo_client_h__ */
133
134 /*
135  * fd.io coding-style-patch-verification: ON
136  *
137  * Local Variables:
138  * eval: (c-set-style "gnu")
139  * End:
140  */