src/plugins/hs_apps/sapi/vpp_echo_common.h

   1 /*
   2  * Copyright (c) 2019 Cisco and/or its affiliates.
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15
  16 #ifndef __included_vpp_echo_common_h__
  17 #define __included_vpp_echo_common_h__
  18
  19 #include <vnet/session/application_interface.h>
  20 #include <vpp/api/vpe_msg_enum.h>
  21
  22 #define vl_typedefs             /* define message structures */
  23 #include <vpp/api/vpe_all_api_h.h>
  24 #undef vl_typedefs
  25
  26 /* declare message handlers for each api */
  27
  28 #define vl_endianfun            /* define message structures */
  29 #include <vpp/api/vpe_all_api_h.h>
  30 #undef vl_endianfun
  31
  32 /* instantiate all the print functions we know about */
  33 #define vl_print(handle, ...)
  34 #define vl_printfun
  35 #include <vpp/api/vpe_all_api_h.h>
  36 #undef vl_printfun
  37
  38 #define TIMEOUT 10.0
  39
  40 #define foreach_echo_fail_code                                          \
  41   _(ECHO_FAIL_NONE, "ECHO_FAIL_NONE")                                   \
  42   _(ECHO_FAIL_SEND_IO_EVT, "ECHO_FAIL_SEND_IO_EVT")                     \
  43   _(ECHO_FAIL_SOCKET_CONNECT, "ECHO_FAIL_SOCKET_CONNECT")               \
  44   _(ECHO_FAIL_INIT_SHM_API, "ECHO_FAIL_INIT_SHM_API")                   \
  45   _(ECHO_FAIL_SHMEM_CONNECT, "ECHO_FAIL_SHMEM_CONNECT")                 \
  46   _(ECHO_FAIL_TEST_BYTES_ERR, "ECHO_FAIL_TEST_BYTES_ERR")               \
  47   _(ECHO_FAIL_BIND, "ECHO_FAIL_BIND")                                   \
  48   _(ECHO_FAIL_ACCEPTED_WAIT_FOR_SEG_ALLOC,                              \
  49     "ECHO_FAIL_ACCEPTED_WAIT_FOR_SEG_ALLOC")                            \
  50   _(ECHO_FAIL_SESSION_CONNECT, "ECHO_FAIL_SESSION_CONNECT")             \
  51   _(ECHO_FAIL_CONNECTED_WAIT_FOR_SEG_ALLOC,                             \
  52     "ECHO_FAIL_CONNECTED_WAIT_FOR_SEG_ALLOC")                           \
  53   _(ECHO_FAIL_APP_ATTACH, "ECHO_FAIL_APP_ATTACH")                       \
  54   _(ECHO_FAIL_SERVER_DISCONNECT_TIMEOUT,                                \
  55     "ECHO_FAIL_SERVER_DISCONNECT_TIMEOUT")                              \
  56   _(ECHO_FAIL_INVALID_URI, "ECHO_FAIL_INVALID_URI")                     \
  57   _(ECHO_FAIL_PROTOCOL_NOT_SUPPORTED,                                   \
  58     "ECHO_FAIL_PROTOCOL_NOT_SUPPORTED")                                 \
  59   _(ECHO_FAIL_CONNECT_TO_VPP, "ECHO_FAIL_CONNECT_TO_VPP")               \
  60   _(ECHO_FAIL_ATTACH_TO_VPP, "ECHO_FAIL_ATTACH_TO_VPP")                 \
  61   _(ECHO_FAIL_1ST_PTHREAD_CREATE, "ECHO_FAIL_1ST_PTHREAD_CREATE")       \
  62   _(ECHO_FAIL_PTHREAD_CREATE, "ECHO_FAIL_PTHREAD_CREATE")               \
  63   _(ECHO_FAIL_DETACH, "ECHO_FAIL_DETACH")                               \
  64   _(ECHO_FAIL_MQ_PTHREAD, "ECHO_FAIL_MQ_PTHREAD")                       \
  65   _(ECHO_FAIL_VL_API_APP_ATTACH, "ECHO_FAIL_VL_API_APP_ATTACH")         \
  66   _(ECHO_FAIL_VL_API_MISSING_SEGMENT_NAME,                              \
  67     "ECHO_FAIL_VL_API_MISSING_SEGMENT_NAME")                            \
  68   _(ECHO_FAIL_VL_API_RECV_FD_MSG, "ECHO_FAIL_VL_API_RECV_FD_MSG")       \
  69   _(ECHO_FAIL_VL_API_SVM_FIFO_SEG_ATTACH,                               \
  70     "ECHO_FAIL_VL_API_SVM_FIFO_SEG_ATTACH")                             \
  71   _(ECHO_FAIL_VL_API_FIFO_SEG_ATTACH,                                   \
  72     "ECHO_FAIL_VL_API_FIFO_SEG_ATTACH")                                 \
  73   _(ECHO_FAIL_VL_API_DETACH_REPLY, "ECHO_FAIL_VL_API_DETACH_REPLY")     \
  74   _(ECHO_FAIL_VL_API_BIND_URI_REPLY, "ECHO_FAIL_VL_API_BIND_URI_REPLY") \
  75   _(ECHO_FAIL_VL_API_UNBIND_REPLY, "ECHO_FAIL_VL_API_UNBIND_REPLY")     \
  76   _(ECHO_FAIL_VL_API_DISCONNECT_SESSION_REPLY,                          \
  77     "ECHO_FAIL_VL_API_DISCONNECT_SESSION_REPLY")                        \
  78   _(ECHO_FAIL_VL_API_TLS_CERT_ADD_REPLY,                                \
  79     "ECHO_FAIL_VL_API_TLS_CERT_ADD_REPLY")                              \
  80   _(ECHO_FAIL_VL_API_TLS_KEY_ADD_REPLY,                                 \
  81     "ECHO_FAIL_VL_API_TLS_KEY_ADD_REPLY")                               \
  82   _(ECHO_FAIL_GET_SESSION_FROM_HANDLE,                                  \
  83     "ECHO_FAIL_GET_SESSION_FROM_HANDLE")                                \
  84   _(ECHO_FAIL_QUIC_WRONG_CONNECT, "ECHO_FAIL_QUIC_WRONG_CONNECT")       \
  85   _(ECHO_FAIL_QUIC_WRONG_ACCEPT, "ECHO_FAIL_QUIC_WRONG_ACCEPT")         \
  86   _(ECHO_FAIL_TCP_BAPI_CONNECT, "ECHO_FAIL_TCP_BAPI_CONNECT")           \
  87   _(ECHO_FAIL_UDP_BAPI_CONNECT, "ECHO_FAIL_UDP_BAPI_CONNECT")           \
  88   _(ECHO_FAIL_MISSING_START_EVENT, "ECHO_FAIL_MISSING_START_EVENT")     \
  89   _(ECHO_FAIL_MISSING_END_EVENT, "ECHO_FAIL_MISSING_END_EVENT")         \
  90   _(ECHO_FAIL_TEST_ASSERT_RX_TOTAL, "ECHO_FAIL_TEST_ASSERT_RX_TOTAL")   \
  91   _(ECHO_FAIL_TEST_ASSERT_TX_TOTAL, "ECHO_FAIL_TEST_ASSERT_TX_TOTAL")   \
  92   _(ECHO_FAIL_TEST_ASSERT_ALL_SESSIONS_CLOSED,                          \
  93     "ECHO_FAIL_TEST_ASSERT_ALL_SESSIONS_CLOSED")
  94
  95 typedef enum
  96 {
  97 #define _(sym, str) sym,
  98   foreach_echo_fail_code
  99 #undef _
 100 } echo_fail_t;
 101
 102 extern char *echo_fail_code_str[];
 103
 104 #define CHECK(fail, expected, result, _fmt, _args...)                   \
 105     if (expected != result)                                             \
 106       ECHO_FAIL (fail, "expected %d, got %d : " _fmt, expected,         \
 107                  result, ##_args);                                      \
 108
 109 #define ECHO_FAIL(fail, _fmt, _args...)                                 \
 110   {                                                                     \
 111     echo_main_t *em = &echo_main;                                       \
 112     em->has_failed = fail;                                              \
 113     if (vec_len(em->fail_descr))                                        \
 114       em->fail_descr = format(em->fail_descr, " | %s (%d): "_fmt,       \
 115                               echo_fail_code_str[fail], fail, ##_args); \
 116     else                                                                \
 117       em->fail_descr = format(0, "%s (%d): "_fmt,                       \
 118                               echo_fail_code_str[fail], fail, ##_args); \
 119     em->time_to_stop = 1;                                               \
 120     if (em->log_lvl > 0)                                                \
 121       clib_warning ("%v", em->fail_descr);                              \
 122   }
 123
 124 #define ECHO_LOG(lvl, _fmt,_args...)    \
 125   {                                     \
 126     echo_main_t *em = &echo_main;       \
 127     if (em->log_lvl > lvl)              \
 128          clib_warning (_fmt, ##_args);  \
 129   }
 130
 131 #define ECHO_REGISTER_PROTO(proto, vft)         \
 132   static void __clib_constructor                \
 133   vpp_echo_init_##proto ()                      \
 134   {                                             \
 135     echo_main_t *em = &echo_main;               \
 136     em->available_proto_cb_vft[proto] = &vft;   \
 137   }
 138
 139 typedef struct
 140 {
 141   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 142 #define _(type, name) type name;
 143   foreach_app_session_field
 144 #undef _
 145   u64 vpp_session_handle;
 146   u64 bytes_sent;
 147   u64 bytes_to_send;
 148   volatile u64 bytes_received;
 149   volatile u64 bytes_to_receive;
 150   f64 start;
 151   u32 listener_index;           /* listener index in echo session pool */
 152   u32 idle_cycles;              /* consecutive enq/deq with no data */
 153   volatile u64 accepted_session_count;  /* sessions we accepted (as a listener) */
 154 } echo_session_t;
 155
 156 typedef enum
 157 {
 158   ECHO_NO_DATA_SOURCE,
 159   ECHO_TEST_DATA_SOURCE,
 160   ECHO_RX_DATA_SOURCE,
 161   ECHO_INVALID_DATA_SOURCE
 162 } data_source_t;
 163
 164 enum echo_close_f_t
 165 {
 166   ECHO_CLOSE_F_INVALID = 0,
 167   ECHO_CLOSE_F_PASSIVE,         /* wait for close msg */
 168   ECHO_CLOSE_F_ACTIVE,          /* send close msg */
 169   ECHO_CLOSE_F_NONE,            /* don't bother sending close msg */
 170 };
 171
 172 enum quic_session_type_t
 173 {
 174   ECHO_SESSION_TYPE_QUIC,
 175   ECHO_SESSION_TYPE_STREAM,
 176   ECHO_SESSION_TYPE_LISTEN,
 177 };
 178
 179 enum quic_session_state_t
 180 {
 181   ECHO_SESSION_STATE_INITIAL,
 182   ECHO_SESSION_STATE_READY,
 183   ECHO_SESSION_STATE_AWAIT_CLOSING,     /* Data transfer is done, wait for close evt */
 184   ECHO_SESSION_STATE_AWAIT_DATA,        /* Peer closed, wait for outstanding data */
 185   ECHO_SESSION_STATE_CLOSING,   /* told vpp to close */
 186   ECHO_SESSION_STATE_CLOSED,    /* closed in vpp */
 187 };
 188
 189 typedef enum
 190 {
 191   STATE_START,
 192   STATE_ATTACHED,
 193   STATE_LISTEN,
 194   STATE_READY,
 195   STATE_DATA_DONE,
 196   STATE_DISCONNECTED,
 197   STATE_DETACHED
 198 } connection_state_t;
 199
 200 typedef enum echo_test_evt_
 201 {
 202   ECHO_EVT_START = 1,           /* app starts */
 203   ECHO_EVT_FIRST_QCONNECT = (1 << 1),   /* First connect Quic session sent */
 204   ECHO_EVT_LAST_QCONNECTED = (1 << 2),  /* All Quic session are connected */
 205   ECHO_EVT_FIRST_SCONNECT = (1 << 3),   /* First connect Stream session sent */
 206   ECHO_EVT_LAST_SCONNECTED = (1 << 4),  /* All Stream session are connected */
 207   ECHO_EVT_LAST_BYTE = (1 << 5),        /* Last byte received */
 208   ECHO_EVT_EXIT = (1 << 6),     /* app exits */
 209 } echo_test_evt_t;
 210
 211 typedef union session_connected_bundled_msg_
 212 {
 213   session_connected_msg_t *mp;
 214   vl_api_connect_uri_reply_t *bmp;
 215 } session_connected_bundled_msg_t;
 216
 217 typedef struct echo_proto_cb_vft_
 218 {
 219   void (*connected_cb) (session_connected_bundled_msg_t * mp, u32 session_index, u8 is_failed); /* Session is connected */
 220   void (*accepted_cb) (session_accepted_msg_t * mp, echo_session_t * session);  /* Session got accepted */
 221   void (*bound_uri_cb) (session_bound_msg_t * mp, echo_session_t * session);    /* Session got bound */
 222   void (*reset_cb) (session_reset_msg_t * mp, echo_session_t * s);      /* Received RESET on session */
 223   void (*disconnected_cb) (session_disconnected_msg_t * mp, echo_session_t * s);        /* Received DISCONNECT on session */
 224   void (*disconnected_reply_cb) (echo_session_t * s);   /* ACK disconnect we sent to vpp */
 225   void (*cleanup_cb) (echo_session_t * s, u8 parent_died);      /* Session should be cleaned up (parent listener may be dead) */
 226   /* Add CLI options */
 227   int (*process_opts_cb) (unformat_input_t * a);
 228   void (*set_defaults_before_opts_cb) (void);
 229   void (*set_defaults_after_opts_cb) (void);
 230   void (*print_usage_cb) (void);
 231 } echo_proto_cb_vft_t;
 232
 233 typedef enum
 234 {
 235   RETURN_PACKETS_NOTEST,
 236   RETURN_PACKETS_LOG_WRONG,
 237   RETURN_PACKETS_ASSERT,
 238 } test_return_packets_t;
 239
 240 typedef struct teardown_stat_
 241 {
 242   u32 q;                        /* quic sessions */
 243   u32 s;                        /* stream sessions */
 244 } teardown_stat_t;
 245
 246 typedef struct
 247 {
 248   svm_queue_t *vl_input_queue;  /* vpe input queue */
 249   u32 my_client_index;          /* API client handle */
 250   u8 *uri;                      /* The URI we're playing with */
 251   echo_session_t *sessions;     /* Session pool */
 252   svm_msg_q_t *our_event_queue; /* Our event queue */
 253   clib_time_t clib_time;        /* For deadman timers */
 254   u8 *socket_name;
 255   int i_am_master;
 256   u32 listen_session_index;     /* Index of vpp listener session */
 257
 258   uword *session_index_by_vpp_handles;  /* Hash table : quic_echo s_id -> vpp s_handle */
 259   clib_spinlock_t sid_vpp_handles_lock; /* Hash table lock */
 260
 261   uword *shared_segment_handles;        /* Hash table : segment_names -> 1 */
 262   clib_spinlock_t segment_handles_lock; /* Hash table lock */
 263   echo_proto_cb_vft_t *proto_cb_vft;
 264   svm_msg_q_t *rpc_msq_queue;   /* MQ between quic_echo threads */
 265   fifo_segment_main_t segment_main;
 266
 267   /* State of the connection, shared between msg RX thread and main thread */
 268   volatile connection_state_t state;
 269   volatile u8 time_to_stop;     /* Signal variables */
 270   u8 has_failed;                /* stores the exit code */
 271   u8 *fail_descr;               /* vector containing fail description */
 272
 273   /** Flag that decides if socket, instead of svm, api is used to connect to
 274    * vpp. If sock api is used, shm binary api is subsequently bootstrapped
 275    * and all other messages are exchanged using shm IPC. */
 276   u8 use_sock_api;
 277
 278   u8 *connect_test_data;
 279   u8 test_return_packets;
 280   u64 bytes_to_send;            /* target per stream */
 281   u64 bytes_to_receive;         /* target per stream */
 282   u32 fifo_size;
 283   u32 rx_buf_size;
 284   u32 tx_buf_size;
 285   data_source_t data_source;    /* Use no/dummy/mirrored data */
 286   u8 send_stream_disconnects;   /* actively send disconnect */
 287   u8 output_json;               /* Output stats as JSON */
 288   u8 log_lvl;                   /* Verbosity of the logging */
 289   int max_test_msg;             /* Limit the number of incorrect data messages */
 290   u32 evt_q_size;               /* Size of the vpp MQ (app<->vpp events) */
 291
 292   u8 *appns_id;
 293   u64 appns_flags;
 294   u64 appns_secret;
 295
 296   pthread_t *data_thread_handles;       /* vec of data thread handles */
 297   pthread_t mq_thread_handle;   /* Message queue thread handle */
 298   u32 *volatile data_thread_args;
 299
 300   u32 n_connects;               /* Target number of connects to send */
 301   u32 n_sessions;               /* Number of sessions to prealloc */
 302   u32 n_clients;                /* Target number of clients doing RX/TX */
 303   u32 n_rx_threads;             /* Number of data threads */
 304
 305   volatile u32 n_clients_connected;     /* Number of STREAM sessions connected */
 306   volatile u32 nxt_available_sidx;      /* next unused prealloced session_index */
 307
 308   /* VNET_API_ERROR_FOO -> "Foo" hash table */
 309   uword *error_string_by_error_number;
 310   echo_proto_cb_vft_t *available_proto_cb_vft[TRANSPORT_N_PROTO];
 311
 312   struct
 313   {
 314     u64 tx_total;
 315     u64 rx_total;
 316     teardown_stat_t reset_count;        /* received reset from vpp */
 317     teardown_stat_t close_count;        /* received close from vpp */
 318     teardown_stat_t active_count;       /* sent close to vpp */
 319     teardown_stat_t clean_count;        /* cleaned up stale session */
 320   } stats;
 321
 322   struct                        /* Event based timing : start & end depend on CLI specified events */
 323   {
 324     f64 start_time;
 325     f64 end_time;
 326     u8 events_sent;
 327     u8 start_event;
 328     u8 end_event;
 329   } timing;
 330
 331   struct
 332   {
 333     u32 transport_proto;
 334     ip46_address_t ip;
 335     u32 port;
 336     u8 is_ip4;
 337   } uri_elts;
 338 } echo_main_t;
 339
 340 extern echo_main_t echo_main;
 341
 342 typedef void (*echo_rpc_t) (void *arg, u32 opaque);
 343
 344 typedef struct
 345 {
 346   void *fp;
 347   void *arg;
 348   u32 opaque;
 349 } echo_rpc_msg_t;
 350
 351 u8 *format_ip4_address (u8 * s, va_list * args);
 352 u8 *format_ip6_address (u8 * s, va_list * args);
 353 u8 *format_ip46_address (u8 * s, va_list * args);
 354 uword unformat_data (unformat_input_t * input, va_list * args);
 355 u8 *format_api_error (u8 * s, va_list * args);
 356 void init_error_string_table ();
 357 u8 *echo_format_app_state (u8 * s, va_list * args);
 358 uword echo_unformat_close (unformat_input_t * input, va_list * args);
 359 uword echo_unformat_timing_event (unformat_input_t * input, va_list * args);
 360 u8 *echo_format_timing_event (u8 * s, va_list * args);
 361 uword unformat_transport_proto (unformat_input_t * input, va_list * args);
 362 u8 *format_transport_proto (u8 * s, va_list * args);
 363 uword unformat_ip4_address (unformat_input_t * input, va_list * args);
 364 uword unformat_ip6_address (unformat_input_t * input, va_list * args);
 365
 366 void echo_session_handle_add_del (echo_main_t * em, u64 handle, u32 sid);
 367 echo_session_t *echo_session_new (echo_main_t * em);
 368 int echo_send_rpc (echo_main_t * em, void *fp, void *arg, u32 opaque);
 369 echo_session_t *echo_get_session_from_handle (echo_main_t * em, u64 handle);
 370 int wait_for_segment_allocation (u64 segment_handle);
 371 int wait_for_state_change (echo_main_t * em, connection_state_t state,
 372                            f64 timeout);
 373 void echo_notify_event (echo_main_t * em, echo_test_evt_t e);
 374 void echo_session_print_stats (echo_main_t * em, echo_session_t * session);
 375
 376 /* Binary API */
 377
 378 void echo_send_attach (echo_main_t * em);
 379 void echo_send_detach (echo_main_t * em);
 380 void echo_send_listen (echo_main_t * em);
 381 void echo_send_unbind (echo_main_t * em);
 382 void echo_send_connect (u8 * uri, u32 opaque);
 383 void echo_send_disconnect_session (u64 handle, u32 opaque);
 384 void echo_api_hookup (echo_main_t * em);
 385
 386 #endif /* __included_vpp_echo_common_h__ */
 387
 388 /*
 389  * fd.io coding-style-patch-verification: ON
 390  *
 391  * Local Variables:
 392  * eval: (c-set-style "gnu")
 393  * End:
 394  */