session: basic fifo-tuning-logic
[vpp.git] / src / plugins / hs_apps / proxy.h
1
2 /*
3  * builtin_proxy.h - skeleton vpp engine plug-in header file
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_proxy_h__
19 #define __included_proxy_h__
20
21 #include <vnet/vnet.h>
22 #include <vnet/ip/ip.h>
23
24 #include <vppinfra/hash.h>
25 #include <vppinfra/error.h>
26 #include <vnet/session/session.h>
27 #include <vnet/session/application_interface.h>
28
29 typedef struct
30 {
31   svm_fifo_t *server_rx_fifo;
32   svm_fifo_t *server_tx_fifo;
33
34   u64 vpp_server_handle;
35   u64 vpp_active_open_handle;
36 } proxy_session_t;
37
38 typedef struct
39 {
40   svm_queue_t *vl_input_queue;  /**< vpe input queue */
41   /** per-thread vectors */
42   svm_msg_q_t **server_event_queue;
43   svm_msg_q_t **active_open_event_queue;
44   u8 **rx_buf;                          /**< intermediate rx buffers */
45
46   u32 cli_node_index;                   /**< cli process node index */
47   u32 server_client_index;              /**< server API client handle */
48   u32 server_app_index;                 /**< server app index */
49   u32 active_open_client_index;         /**< active open API client handle */
50   u32 active_open_app_index;            /**< active open index after attach */
51
52   uword *proxy_session_by_server_handle;
53   uword *proxy_session_by_active_open_handle;
54
55   /*
56    * Configuration params
57    */
58   u8 *connect_uri;                      /**< URI for slave's connect */
59   u32 configured_segment_size;
60   u32 fifo_size;                        /**< initial fifo size */
61   u32 max_fifo_size;                    /**< max fifo size */
62   u8 high_watermark;                    /**< high watermark (%) */
63   u8 low_watermark;                     /**< low watermark (%) */
64   u32 private_segment_count;            /**< Number of private fifo segs */
65   u32 private_segment_size;             /**< size of private fifo segs */
66   int rcv_buffer_size;
67   u8 *server_uri;
68   u8 *client_uri;
69
70   /*
71    * Test state variables
72    */
73   proxy_session_t *sessions;            /**< Session pool, shared */
74   clib_spinlock_t sessions_lock;
75   u32 **connection_index_by_thread;
76   pthread_t client_thread_handle;
77
78   /*
79    * Flags
80    */
81   u8 is_init;
82   u8 prealloc_fifos;            /**< Request fifo preallocation */
83 } proxy_main_t;
84
85 extern proxy_main_t proxy_main;
86
87 #endif /* __included_proxy_h__ */
88
89 /*
90  * fd.io coding-style-patch-verification: ON
91  *
92  * Local Variables:
93  * eval: (c-set-style "gnu")
94  * End:
95  */