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 */
63 u8 **rx_buf; /**< Per-thread RX buffer */
66 vlib_main_t *vlib_main;
67 } builtin_server_main_t;
69 builtin_server_main_t builtin_server_main;
72 builtin_session_accept_callback (stream_session_t * s)
74 builtin_server_main_t *bsm = &builtin_server_main;
76 bsm->vpp_queue[s->thread_index] =
77 session_manager_get_vpp_event_queue (s->thread_index);
78 s->session_state = SESSION_STATE_READY;
84 builtin_session_disconnect_callback (stream_session_t * s)
86 builtin_server_main_t *bsm = &builtin_server_main;
87 vnet_disconnect_args_t _a, *a = &_a;
89 a->handle = stream_session_handle (s);
90 a->app_index = bsm->app_index;
91 vnet_disconnect_session (a);
95 builtin_session_reset_callback (stream_session_t * s)
97 clib_warning ("called.. ");
99 stream_session_cleanup (s);
104 builtin_session_connected_callback (u32 app_index, u32 api_context,
105 stream_session_t * s, u8 is_fail)
107 clib_warning ("called...");
112 builtin_add_segment_callback (u32 client_index,
113 const u8 * seg_name, u32 seg_size)
115 clib_warning ("called...");
120 builtin_redirect_connect_callback (u32 client_index, void *mp)
122 clib_warning ("called...");
127 test_bytes (builtin_server_main_t * bsm, int actual_transfer)
130 u32 my_thread_id = vlib_get_thread_index ();
132 for (i = 0; i < actual_transfer; i++)
134 if (bsm->rx_buf[my_thread_id][i] != ((bsm->byte_index + i) & 0xff))
136 clib_warning ("at %lld expected %d got %d", bsm->byte_index + i,
137 (bsm->byte_index + i) & 0xff,
138 bsm->rx_buf[my_thread_id][i]);
141 bsm->byte_index += actual_transfer;
145 * If no-echo, just read the data and be done with it
148 builtin_server_rx_callback_no_echo (stream_session_t * s)
150 builtin_server_main_t *bsm = &builtin_server_main;
151 u32 my_thread_id = vlib_get_thread_index ();
155 rx_fifo = s->server_rx_fifo;
160 svm_fifo_dequeue_nowait (rx_fifo, bsm->rcv_buffer_size,
161 bsm->rx_buf[my_thread_id]);
163 while (actual_transfer > 0);
168 builtin_server_rx_callback (stream_session_t * s)
170 u32 n_written, max_dequeue, max_enqueue, max_transfer;
172 svm_fifo_t *tx_fifo, *rx_fifo;
173 builtin_server_main_t *bsm = &builtin_server_main;
174 session_fifo_event_t evt;
175 static int serial_number = 0;
176 u32 my_thread_id = vlib_get_thread_index ();
178 rx_fifo = s->server_rx_fifo;
179 tx_fifo = s->server_tx_fifo;
181 max_dequeue = svm_fifo_max_dequeue (s->server_rx_fifo);
182 max_enqueue = svm_fifo_max_enqueue (s->server_tx_fifo);
184 if (PREDICT_FALSE (max_dequeue == 0))
187 /* Number of bytes we're going to copy */
188 max_transfer = (max_dequeue < max_enqueue) ? max_dequeue : max_enqueue;
190 /* No space in tx fifo */
191 if (PREDICT_FALSE (max_transfer == 0))
193 /* XXX timeout for session that are stuck */
196 /* Program self-tap to retry */
197 if (svm_fifo_set_event (rx_fifo))
199 unix_shared_memory_queue_t *q;
201 evt.event_type = FIFO_EVENT_BUILTIN_RX;
204 q = bsm->vpp_queue[s->thread_index];
205 if (PREDICT_FALSE (q->cursize == q->maxsize))
206 clib_warning ("out of event queue space");
208 unix_shared_memory_queue_add (q, (u8 *) & evt,
209 0 /* don't wait for mutex */ );
215 _vec_len (bsm->rx_buf[my_thread_id]) = max_transfer;
217 actual_transfer = svm_fifo_dequeue_nowait (rx_fifo, max_transfer,
218 bsm->rx_buf[my_thread_id]);
219 ASSERT (actual_transfer == max_transfer);
221 // test_bytes (bsm, actual_transfer);
227 n_written = svm_fifo_enqueue_nowait (tx_fifo, actual_transfer,
228 bsm->rx_buf[my_thread_id]);
230 if (n_written != max_transfer)
231 clib_warning ("short trout!");
233 if (svm_fifo_set_event (tx_fifo))
235 /* Fabricate TX event, send to vpp */
237 evt.event_type = FIFO_EVENT_APP_TX;
238 evt.event_id = serial_number++;
240 unix_shared_memory_queue_add (bsm->vpp_queue[s->thread_index],
241 (u8 *) & evt, 0 /* do wait for mutex */ );
244 if (PREDICT_FALSE (max_enqueue < max_dequeue))
250 static session_cb_vft_t builtin_session_cb_vft = {
251 .session_accept_callback = builtin_session_accept_callback,
252 .session_disconnect_callback = builtin_session_disconnect_callback,
253 .session_connected_callback = builtin_session_connected_callback,
254 .add_segment_callback = builtin_add_segment_callback,
255 .redirect_connect_callback = builtin_redirect_connect_callback,
256 .builtin_server_rx_callback = builtin_server_rx_callback,
257 .session_reset_callback = builtin_session_reset_callback
260 /* Abuse VPP's input queue */
262 create_api_loopback (vlib_main_t * vm)
264 builtin_server_main_t *bsm = &builtin_server_main;
265 vl_api_memclnt_create_t _m, *mp = &_m;
266 extern void vl_api_memclnt_create_t_handler (vl_api_memclnt_create_t *);
267 api_main_t *am = &api_main;
268 vl_shmem_hdr_t *shmem_hdr;
269 uword *event_data = 0, event_type;
273 * Create a "loopback" API client connection
274 * Don't do things like this unless you know what you're doing...
277 shmem_hdr = am->shmem_hdr;
278 bsm->vl_input_queue = shmem_hdr->vl_input_queue;
279 memset (mp, 0, sizeof (*mp));
280 mp->_vl_msg_id = VL_API_MEMCLNT_CREATE;
281 mp->context = 0xFEEDFACE;
282 mp->input_queue = pointer_to_uword (bsm->vl_input_queue);
283 strncpy ((char *) mp->name, "tcp_test_server", sizeof (mp->name) - 1);
285 vl_api_memclnt_create_t_handler (mp);
288 bsm->node_index = vlib_get_current_process (vm)->node_runtime.node_index;
289 vlib_process_wait_for_event_or_clock (vm, 1.0);
290 event_type = vlib_process_get_events (vm, &event_data);
300 clib_warning ("unknown event_type %d", event_type);
311 builtin_server_main_t *bsm = &builtin_server_main;
312 u8 segment_name[128];
313 u64 options[SESSION_OPTIONS_N_OPTIONS];
314 vnet_app_attach_args_t _a, *a = &_a;
316 memset (a, 0, sizeof (*a));
317 memset (options, 0, sizeof (options));
320 builtin_session_cb_vft.builtin_server_rx_callback =
321 builtin_server_rx_callback_no_echo;
323 builtin_session_cb_vft.builtin_server_rx_callback =
324 builtin_server_rx_callback;
325 a->api_client_index = bsm->my_client_index;
326 a->session_cb_vft = &builtin_session_cb_vft;
327 a->options = options;
328 a->options[SESSION_OPTIONS_SEGMENT_SIZE] = 512 << 20;
329 a->options[SESSION_OPTIONS_RX_FIFO_SIZE] = bsm->fifo_size;
330 a->options[SESSION_OPTIONS_TX_FIFO_SIZE] = bsm->fifo_size;
331 a->options[APP_OPTIONS_FLAGS] = APP_OPTIONS_FLAGS_BUILTIN_APP;
332 a->options[APP_OPTIONS_PREALLOC_FIFO_PAIRS] =
333 bsm->prealloc_fifos ? bsm->prealloc_fifos : 1;
334 a->segment_name = segment_name;
335 a->segment_name_length = ARRAY_LEN (segment_name);
337 if (vnet_application_attach (a))
339 clib_warning ("failed to attach server");
342 bsm->app_index = a->app_index;
349 builtin_server_main_t *bsm = &builtin_server_main;
350 vnet_bind_args_t _a, *a = &_a;
351 memset (a, 0, sizeof (*a));
352 a->app_index = bsm->app_index;
353 a->uri = "tcp://0.0.0.0/1234";
354 return vnet_bind_uri (a);
358 server_create (vlib_main_t * vm)
360 builtin_server_main_t *bsm = &builtin_server_main;
361 vlib_thread_main_t *vtm = vlib_get_thread_main ();
365 if (bsm->my_client_index == (u32) ~ 0)
367 if (create_api_loopback (vm))
369 clib_warning ("failed to create api loopback");
374 num_threads = 1 /* main thread */ + vtm->n_threads;
375 vec_validate (builtin_server_main.vpp_queue, num_threads - 1);
376 vec_validate (bsm->rx_buf, num_threads - 1);
377 for (i = 0; i < num_threads; i++)
378 vec_validate (bsm->rx_buf[i], bsm->rcv_buffer_size);
380 if (server_attach ())
382 clib_warning ("failed to attach server");
385 if (server_listen ())
387 clib_warning ("failed to start listening");
393 /* Get our api client index */
395 vl_api_memclnt_create_reply_t_handler (vl_api_memclnt_create_reply_t * mp)
397 vlib_main_t *vm = vlib_get_main ();
398 builtin_server_main_t *bsm = &builtin_server_main;
399 bsm->my_client_index = mp->index;
400 vlib_process_signal_event (vm, bsm->node_index, 1 /* evt */ ,
404 #define foreach_tcp_builtin_server_api_msg \
405 _(MEMCLNT_CREATE_REPLY, memclnt_create_reply) \
407 static clib_error_t *
408 tcp_builtin_server_api_hookup (vlib_main_t * vm)
410 vl_msg_api_msg_config_t _c, *c = &_c;
412 /* Hook up client-side static APIs to our handlers */
413 #define _(N,n) do { \
414 c->id = VL_API_##N; \
416 c->handler = vl_api_##n##_t_handler; \
417 c->cleanup = vl_noop_handler; \
418 c->endian = vl_api_##n##_t_endian; \
419 c->print = vl_api_##n##_t_print; \
420 c->size = sizeof(vl_api_##n##_t); \
421 c->traced = 1; /* trace, so these msgs print */ \
422 c->replay = 0; /* don't replay client create/delete msgs */ \
423 c->message_bounce = 0; /* don't bounce this message */ \
424 vl_msg_api_config(c);} while (0);
426 foreach_tcp_builtin_server_api_msg;
432 static clib_error_t *
433 server_create_command_fn (vlib_main_t * vm, unformat_input_t * input,
434 vlib_cli_command_t * cmd)
436 builtin_server_main_t *bsm = &builtin_server_main;
440 bsm->fifo_size = 64 << 10;
441 bsm->rcv_buffer_size = 128 << 10;
442 bsm->prealloc_fifos = 0;
444 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
446 if (unformat (input, "no-echo"))
448 else if (unformat (input, "fifo-size %d", &bsm->fifo_size))
449 bsm->fifo_size <<= 10;
450 else if (unformat (input, "rcv-buf-size %d", &bsm->rcv_buffer_size))
452 else if (unformat (input, "prealloc-fifos", &bsm->prealloc_fifos))
455 return clib_error_return (0, "unknown input `%U'",
456 format_unformat_error, input);
459 tcp_builtin_server_api_hookup (vm);
460 vnet_session_enable_disable (vm, 1 /* turn on TCP, etc. */ );
462 rv = server_create (vm);
468 return clib_error_return (0, "server_create returned %d", rv);
475 VLIB_CLI_COMMAND (server_create_command, static) =
477 .path = "test tcp server",
478 .short_help = "test tcp server",
479 .function = server_create_command_fn,
484 builtin_tcp_server_main_init (vlib_main_t * vm)
486 builtin_server_main_t *bsm = &builtin_server_main;
487 bsm->my_client_index = ~0;
491 VLIB_INIT_FUNCTION (builtin_tcp_server_main_init);
494 * fd.io coding-style-patch-verification: ON
497 * eval: (c-set-style "gnu")