2 * Copyright (c) 2015-2017 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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
16 #include <vnet/vnet.h>
17 #include <vlibmemory/api.h>
18 #include <vnet/session/application.h>
19 #include <vnet/session/application_interface.h>
21 /* define message IDs */
22 #include <vpp/api/vpe_msg_enum.h>
24 /* define message structures */
26 #include <vpp/api/vpe_all_api_h.h>
29 /* define generated endian-swappers */
31 #include <vpp/api/vpe_all_api_h.h>
34 /* instantiate all the print functions we know about */
35 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
37 #include <vpp/api/vpe_all_api_h.h>
43 * Server app parameters
45 unix_shared_memory_queue_t **vpp_queue;
46 unix_shared_memory_queue_t *vl_input_queue; /**< Sever's event queue */
48 u32 app_index; /**< Server app index */
49 u32 my_client_index; /**< API client handle */
50 u32 node_index; /**< process node index for evnt scheduling */
55 u8 no_echo; /**< Don't echo traffic */
56 u32 fifo_size; /**< Fifo size */
57 u32 rcv_buffer_size; /**< Rcv buffer size */
58 u32 prealloc_fifos; /**< Preallocate fifos */
59 u32 private_segment_count; /**< Number of private segments */
60 u32 private_segment_size; /**< Size of private segments */
65 u8 **rx_buf; /**< Per-thread RX buffer */
69 vlib_main_t *vlib_main;
70 } builtin_server_main_t;
72 builtin_server_main_t builtin_server_main;
75 builtin_session_accept_callback (stream_session_t * s)
77 builtin_server_main_t *bsm = &builtin_server_main;
79 bsm->vpp_queue[s->thread_index] =
80 session_manager_get_vpp_event_queue (s->thread_index);
81 s->session_state = SESSION_STATE_READY;
83 vec_validate (bsm->rx_retries[s->thread_index], s->session_index);
84 bsm->rx_retries[s->thread_index][s->session_index] = 0;
89 builtin_session_disconnect_callback (stream_session_t * s)
91 builtin_server_main_t *bsm = &builtin_server_main;
92 vnet_disconnect_args_t _a, *a = &_a;
94 a->handle = stream_session_handle (s);
95 a->app_index = bsm->app_index;
96 vnet_disconnect_session (a);
100 builtin_session_reset_callback (stream_session_t * s)
102 clib_warning ("called.. ");
104 stream_session_cleanup (s);
109 builtin_session_connected_callback (u32 app_index, u32 api_context,
110 stream_session_t * s, u8 is_fail)
112 clib_warning ("called...");
117 builtin_add_segment_callback (u32 client_index,
118 const u8 * seg_name, u32 seg_size)
120 clib_warning ("called...");
125 builtin_redirect_connect_callback (u32 client_index, void *mp)
127 clib_warning ("called...");
132 test_bytes (builtin_server_main_t * bsm, int actual_transfer)
135 u32 my_thread_id = vlib_get_thread_index ();
137 for (i = 0; i < actual_transfer; i++)
139 if (bsm->rx_buf[my_thread_id][i] != ((bsm->byte_index + i) & 0xff))
141 clib_warning ("at %lld expected %d got %d", bsm->byte_index + i,
142 (bsm->byte_index + i) & 0xff,
143 bsm->rx_buf[my_thread_id][i]);
146 bsm->byte_index += actual_transfer;
150 * If no-echo, just read the data and be done with it
153 builtin_server_rx_callback_no_echo (stream_session_t * s)
155 builtin_server_main_t *bsm = &builtin_server_main;
156 u32 my_thread_id = vlib_get_thread_index ();
160 rx_fifo = s->server_rx_fifo;
165 svm_fifo_dequeue_nowait (rx_fifo, bsm->rcv_buffer_size,
166 bsm->rx_buf[my_thread_id]);
168 while (actual_transfer > 0);
173 builtin_server_rx_callback (stream_session_t * s)
175 u32 n_written, max_dequeue, max_enqueue, max_transfer;
177 svm_fifo_t *tx_fifo, *rx_fifo;
178 builtin_server_main_t *bsm = &builtin_server_main;
179 session_fifo_event_t evt;
180 static int serial_number = 0;
181 u32 thread_index = vlib_get_thread_index ();
183 ASSERT (s->thread_index == thread_index);
185 rx_fifo = s->server_rx_fifo;
186 tx_fifo = s->server_tx_fifo;
188 ASSERT (rx_fifo->master_thread_index == thread_index);
189 ASSERT (tx_fifo->master_thread_index == thread_index);
191 max_dequeue = svm_fifo_max_dequeue (s->server_rx_fifo);
192 max_enqueue = svm_fifo_max_enqueue (s->server_tx_fifo);
194 if (PREDICT_FALSE (max_dequeue == 0))
197 /* Number of bytes we're going to copy */
198 max_transfer = (max_dequeue < max_enqueue) ? max_dequeue : max_enqueue;
200 /* No space in tx fifo */
201 if (PREDICT_FALSE (max_transfer == 0))
203 /* XXX timeout for session that are stuck */
206 /* Program self-tap to retry */
207 if (svm_fifo_set_event (rx_fifo))
209 unix_shared_memory_queue_t *q;
211 evt.event_type = FIFO_EVENT_BUILTIN_RX;
214 q = bsm->vpp_queue[thread_index];
215 if (PREDICT_FALSE (q->cursize == q->maxsize))
216 clib_warning ("out of event queue space");
217 else if (unix_shared_memory_queue_add (q, (u8 *) & evt, 0 /* don't wait for mutex */
219 clib_warning ("failed to enqueue self-tap");
221 bsm->rx_retries[thread_index][s->session_index]++;
222 if (bsm->rx_retries[thread_index][s->session_index] == 500000)
224 clib_warning ("session stuck: %U", format_stream_session, s, 2);
229 bsm->rx_retries[thread_index][s->session_index] = 0;
235 _vec_len (bsm->rx_buf[thread_index]) = max_transfer;
237 actual_transfer = svm_fifo_dequeue_nowait (rx_fifo, max_transfer,
238 bsm->rx_buf[thread_index]);
239 ASSERT (actual_transfer == max_transfer);
241 // test_bytes (bsm, actual_transfer);
247 n_written = svm_fifo_enqueue_nowait (tx_fifo, actual_transfer,
248 bsm->rx_buf[thread_index]);
250 if (n_written != max_transfer)
251 clib_warning ("short trout!");
253 if (svm_fifo_set_event (tx_fifo))
255 /* Fabricate TX event, send to vpp */
257 evt.event_type = FIFO_EVENT_APP_TX;
258 evt.event_id = serial_number++;
260 if (unix_shared_memory_queue_add (bsm->vpp_queue[s->thread_index],
262 0 /* do wait for mutex */ ))
263 clib_warning ("failed to enqueue tx evt");
266 if (PREDICT_FALSE (n_written < max_dequeue))
272 static session_cb_vft_t builtin_session_cb_vft = {
273 .session_accept_callback = builtin_session_accept_callback,
274 .session_disconnect_callback = builtin_session_disconnect_callback,
275 .session_connected_callback = builtin_session_connected_callback,
276 .add_segment_callback = builtin_add_segment_callback,
277 .redirect_connect_callback = builtin_redirect_connect_callback,
278 .builtin_server_rx_callback = builtin_server_rx_callback,
279 .session_reset_callback = builtin_session_reset_callback
282 /* Abuse VPP's input queue */
284 create_api_loopback (vlib_main_t * vm)
286 builtin_server_main_t *bsm = &builtin_server_main;
287 vl_api_memclnt_create_t _m, *mp = &_m;
288 extern void vl_api_memclnt_create_t_handler (vl_api_memclnt_create_t *);
289 api_main_t *am = &api_main;
290 vl_shmem_hdr_t *shmem_hdr;
291 uword *event_data = 0, event_type;
295 * Create a "loopback" API client connection
296 * Don't do things like this unless you know what you're doing...
299 shmem_hdr = am->shmem_hdr;
300 bsm->vl_input_queue = shmem_hdr->vl_input_queue;
301 memset (mp, 0, sizeof (*mp));
302 mp->_vl_msg_id = VL_API_MEMCLNT_CREATE;
303 mp->context = 0xFEEDFACE;
304 mp->input_queue = pointer_to_uword (bsm->vl_input_queue);
305 strncpy ((char *) mp->name, "tcp_test_server", sizeof (mp->name) - 1);
307 vl_api_memclnt_create_t_handler (mp);
310 bsm->node_index = vlib_get_current_process (vm)->node_runtime.node_index;
311 vlib_process_wait_for_event_or_clock (vm, 1.0);
312 event_type = vlib_process_get_events (vm, &event_data);
322 clib_warning ("unknown event_type %d", event_type);
333 builtin_server_main_t *bsm = &builtin_server_main;
334 u8 segment_name[128];
335 u64 options[SESSION_OPTIONS_N_OPTIONS];
336 vnet_app_attach_args_t _a, *a = &_a;
338 memset (a, 0, sizeof (*a));
339 memset (options, 0, sizeof (options));
342 builtin_session_cb_vft.builtin_server_rx_callback =
343 builtin_server_rx_callback_no_echo;
345 builtin_session_cb_vft.builtin_server_rx_callback =
346 builtin_server_rx_callback;
347 a->api_client_index = bsm->my_client_index;
348 a->session_cb_vft = &builtin_session_cb_vft;
349 a->options = options;
350 a->options[SESSION_OPTIONS_SEGMENT_SIZE] = 512 << 20;
351 a->options[SESSION_OPTIONS_RX_FIFO_SIZE] = bsm->fifo_size;
352 a->options[SESSION_OPTIONS_TX_FIFO_SIZE] = bsm->fifo_size;
353 a->options[APP_OPTIONS_PRIVATE_SEGMENT_COUNT] = bsm->private_segment_count;
354 a->options[APP_OPTIONS_PRIVATE_SEGMENT_SIZE] = bsm->private_segment_size;
355 a->options[APP_OPTIONS_PREALLOC_FIFO_PAIRS] =
356 bsm->prealloc_fifos ? bsm->prealloc_fifos : 1;
358 a->options[APP_OPTIONS_FLAGS] = APP_OPTIONS_FLAGS_BUILTIN_APP;
360 a->segment_name = segment_name;
361 a->segment_name_length = ARRAY_LEN (segment_name);
363 if (vnet_application_attach (a))
365 clib_warning ("failed to attach server");
368 bsm->app_index = a->app_index;
375 builtin_server_main_t *bsm = &builtin_server_main;
376 vnet_bind_args_t _a, *a = &_a;
377 memset (a, 0, sizeof (*a));
378 a->app_index = bsm->app_index;
379 a->uri = "tcp://0.0.0.0/1234";
380 return vnet_bind_uri (a);
384 server_create (vlib_main_t * vm)
386 builtin_server_main_t *bsm = &builtin_server_main;
387 vlib_thread_main_t *vtm = vlib_get_thread_main ();
391 if (bsm->my_client_index == (u32) ~ 0)
393 if (create_api_loopback (vm))
395 clib_warning ("failed to create api loopback");
400 num_threads = 1 /* main thread */ + vtm->n_threads;
401 vec_validate (builtin_server_main.vpp_queue, num_threads - 1);
402 vec_validate (bsm->rx_buf, num_threads - 1);
403 vec_validate (bsm->rx_retries, num_threads - 1);
405 for (i = 0; i < num_threads; i++)
406 vec_validate (bsm->rx_buf[i], bsm->rcv_buffer_size);
408 if (server_attach ())
410 clib_warning ("failed to attach server");
413 if (server_listen ())
415 clib_warning ("failed to start listening");
421 /* Get our api client index */
423 vl_api_memclnt_create_reply_t_handler (vl_api_memclnt_create_reply_t * mp)
425 vlib_main_t *vm = vlib_get_main ();
426 builtin_server_main_t *bsm = &builtin_server_main;
427 bsm->my_client_index = mp->index;
428 vlib_process_signal_event (vm, bsm->node_index, 1 /* evt */ ,
432 #define foreach_tcp_builtin_server_api_msg \
433 _(MEMCLNT_CREATE_REPLY, memclnt_create_reply) \
435 static clib_error_t *
436 tcp_builtin_server_api_hookup (vlib_main_t * vm)
438 vl_msg_api_msg_config_t _c, *c = &_c;
440 /* Hook up client-side static APIs to our handlers */
441 #define _(N,n) do { \
442 c->id = VL_API_##N; \
444 c->handler = vl_api_##n##_t_handler; \
445 c->cleanup = vl_noop_handler; \
446 c->endian = vl_api_##n##_t_endian; \
447 c->print = vl_api_##n##_t_print; \
448 c->size = sizeof(vl_api_##n##_t); \
449 c->traced = 1; /* trace, so these msgs print */ \
450 c->replay = 0; /* don't replay client create/delete msgs */ \
451 c->message_bounce = 0; /* don't bounce this message */ \
452 vl_msg_api_config(c);} while (0);
454 foreach_tcp_builtin_server_api_msg;
460 static clib_error_t *
461 server_create_command_fn (vlib_main_t * vm, unformat_input_t * input,
462 vlib_cli_command_t * cmd)
464 builtin_server_main_t *bsm = &builtin_server_main;
469 bsm->fifo_size = 64 << 10;
470 bsm->rcv_buffer_size = 128 << 10;
471 bsm->prealloc_fifos = 0;
472 bsm->private_segment_count = 0;
473 bsm->private_segment_size = 0;
475 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
477 if (unformat (input, "no-echo"))
479 else if (unformat (input, "fifo-size %d", &bsm->fifo_size))
480 bsm->fifo_size <<= 10;
481 else if (unformat (input, "rcv-buf-size %d", &bsm->rcv_buffer_size))
483 else if (unformat (input, "prealloc-fifos %d", &bsm->prealloc_fifos))
485 else if (unformat (input, "private-segment-count %d",
486 &bsm->private_segment_count))
488 else if (unformat (input, "private-segment-size %dm", &tmp))
489 bsm->private_segment_size = tmp << 20;
490 else if (unformat (input, "private-segment-size %dg", &tmp))
491 bsm->private_segment_size = tmp << 30;
492 else if (unformat (input, "private-segment-size %d", &tmp))
493 bsm->private_segment_size = tmp;
495 return clib_error_return (0, "unknown input `%U'",
496 format_unformat_error, input);
499 tcp_builtin_server_api_hookup (vm);
500 vnet_session_enable_disable (vm, 1 /* turn on TCP, etc. */ );
502 rv = server_create (vm);
508 return clib_error_return (0, "server_create returned %d", rv);
515 VLIB_CLI_COMMAND (server_create_command, static) =
517 .path = "test tcp server",
518 .short_help = "test tcp server",
519 .function = server_create_command_fn,
524 builtin_tcp_server_main_init (vlib_main_t * vm)
526 builtin_server_main_t *bsm = &builtin_server_main;
527 bsm->my_client_index = ~0;
531 VLIB_INIT_FUNCTION (builtin_tcp_server_main_init);
534 * fd.io coding-style-patch-verification: ON
537 * eval: (c-set-style "gnu")