host stack: update stale copyright
[vpp.git] / src / vnet / session-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/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 <svm/svm_fifo_segment.h>
28 #include <vnet/session/session.h>
29 #include <vnet/session/application_interface.h>
30
31 typedef struct
32 {
33   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
34   app_session_t data;
35   u64 bytes_to_send;
36   u64 bytes_sent;
37   u64 bytes_to_receive;
38   u64 bytes_received;
39   u64 vpp_session_handle;
40   u8 thread_index;
41 } eclient_session_t;
42
43 typedef struct
44 {
45   /*
46    * Application setup parameters
47    */
48   svm_queue_t *vl_input_queue;          /**< vpe input queue */
49   svm_msg_q_t **vpp_event_queue;
50
51   u32 cli_node_index;                   /**< cli process node index */
52   u32 my_client_index;                  /**< loopback API client handle */
53   u32 app_index;                        /**< app index after attach */
54
55   /*
56    * Configuration params
57    */
58   u8 *connect_uri;                      /**< URI for slave's connect */
59   u64 bytes_to_send;                    /**< Bytes to send */
60   u32 configured_segment_size;
61   u32 fifo_size;
62   u32 expected_connections;             /**< Number of clients/connections */
63   u32 connections_per_batch;            /**< Connections to rx/tx at once */
64   u32 private_segment_count;            /**< Number of private fifo segs */
65   u32 private_segment_size;             /**< size of private fifo segs */
66   u32 tls_engine;                       /**< TLS engine mbedtls/openssl */
67   u8 is_dgram;
68   u32 no_copy;                          /**< Don't memcpy data to tx fifo */
69
70   /*
71    * Test state variables
72    */
73   eclient_session_t *sessions;          /**< Session pool, shared */
74   clib_spinlock_t sessions_lock;
75   u8 **rx_buf;                          /**< intermediate rx buffers */
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   u8 no_output;
102   u8 test_bytes;
103   u8 test_failed;
104
105   vlib_main_t *vlib_main;
106 } echo_client_main_t;
107
108 enum
109 {
110   ECHO_CLIENTS_STARTING,
111   ECHO_CLIENTS_RUNNING,
112   ECHO_CLIENTS_EXITING
113 } echo_clients_test_state_e;
114 extern echo_client_main_t echo_client_main;
115
116 vlib_node_registration_t echo_clients_node;
117
118 #endif /* __included_echo_client_h__ */
119
120 /*
121  * fd.io coding-style-patch-verification: ON
122  *
123  * Local Variables:
124  * eval: (c-set-style "gnu")
125  * End:
126  */