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 unix_shared_memory_queue_t **vpp_queue;
46 /* Sever's event queue */
47 unix_shared_memory_queue_t *vl_input_queue;
49 /* API client handle */
54 /* process node index for evnt scheduling */
56 vlib_main_t *vlib_main;
57 } builtin_server_main_t;
59 builtin_server_main_t builtin_server_main;
62 builtin_session_accept_callback (stream_session_t * s)
64 builtin_server_main_t *bsm = &builtin_server_main;
66 bsm->vpp_queue[s->thread_index] =
67 session_manager_get_vpp_event_queue (s->thread_index);
68 s->session_state = SESSION_STATE_READY;
74 builtin_session_disconnect_callback (stream_session_t * s)
76 builtin_server_main_t *bsm = &builtin_server_main;
77 vnet_disconnect_args_t _a, *a = &_a;
79 a->handle = stream_session_handle (s);
80 a->app_index = bsm->app_index;
81 vnet_disconnect_session (a);
85 builtin_session_reset_callback (stream_session_t * s)
87 clib_warning ("called.. ");
89 stream_session_cleanup (s);
94 builtin_session_connected_callback (u32 app_index, u32 api_context,
95 stream_session_t * s, u8 is_fail)
97 clib_warning ("called...");
102 builtin_add_segment_callback (u32 client_index,
103 const u8 * seg_name, u32 seg_size)
105 clib_warning ("called...");
110 builtin_redirect_connect_callback (u32 client_index, void *mp)
112 clib_warning ("called...");
117 test_bytes (builtin_server_main_t * bsm, int actual_transfer)
121 for (i = 0; i < actual_transfer; i++)
123 if (bsm->rx_buf[i] != ((bsm->byte_index + i) & 0xff))
125 clib_warning ("at %lld expected %d got %d", bsm->byte_index + i,
126 (bsm->byte_index + i) & 0xff, bsm->rx_buf[i]);
129 bsm->byte_index += actual_transfer;
133 builtin_server_rx_callback (stream_session_t * s)
135 u32 n_written, max_dequeue, max_enqueue, max_transfer;
137 svm_fifo_t *tx_fifo, *rx_fifo;
138 builtin_server_main_t *bsm = &builtin_server_main;
139 session_fifo_event_t evt;
140 static int serial_number = 0;
142 tx_fifo = s->server_tx_fifo;
143 rx_fifo = s->server_rx_fifo;
145 max_dequeue = svm_fifo_max_dequeue (s->server_rx_fifo);
146 max_enqueue = svm_fifo_max_enqueue (s->server_tx_fifo);
148 if (PREDICT_FALSE (max_dequeue == 0))
151 /* Number of bytes we're going to copy */
152 max_transfer = (max_dequeue < max_enqueue) ? max_dequeue : max_enqueue;
154 /* No space in tx fifo */
155 if (PREDICT_FALSE (max_transfer == 0))
157 /* XXX timeout for session that are stuck */
160 /* Program self-tap to retry */
161 if (svm_fifo_set_event (rx_fifo))
164 evt.event_type = FIFO_EVENT_BUILTIN_RX;
166 unix_shared_memory_queue_add (bsm->vpp_queue[s->thread_index],
168 0 /* do wait for mutex */ );
174 vec_validate (bsm->rx_buf, max_transfer - 1);
175 _vec_len (bsm->rx_buf) = max_transfer;
177 actual_transfer = svm_fifo_dequeue_nowait (rx_fifo, max_transfer,
179 ASSERT (actual_transfer == max_transfer);
181 // test_bytes (bsm, actual_transfer);
187 n_written = svm_fifo_enqueue_nowait (tx_fifo, actual_transfer, bsm->rx_buf);
189 if (n_written != max_transfer)
190 clib_warning ("short trout!");
192 if (svm_fifo_set_event (tx_fifo))
194 /* Fabricate TX event, send to vpp */
196 evt.event_type = FIFO_EVENT_APP_TX;
197 evt.event_id = serial_number++;
199 unix_shared_memory_queue_add (bsm->vpp_queue[s->thread_index],
200 (u8 *) & evt, 0 /* do wait for mutex */ );
203 if (PREDICT_FALSE (max_enqueue < max_dequeue))
209 static session_cb_vft_t builtin_session_cb_vft = {
210 .session_accept_callback = builtin_session_accept_callback,
211 .session_disconnect_callback = builtin_session_disconnect_callback,
212 .session_connected_callback = builtin_session_connected_callback,
213 .add_segment_callback = builtin_add_segment_callback,
214 .redirect_connect_callback = builtin_redirect_connect_callback,
215 .builtin_server_rx_callback = builtin_server_rx_callback,
216 .session_reset_callback = builtin_session_reset_callback
219 /* Abuse VPP's input queue */
221 create_api_loopback (vlib_main_t * vm)
223 builtin_server_main_t *bsm = &builtin_server_main;
224 vl_api_memclnt_create_t _m, *mp = &_m;
225 extern void vl_api_memclnt_create_t_handler (vl_api_memclnt_create_t *);
226 api_main_t *am = &api_main;
227 vl_shmem_hdr_t *shmem_hdr;
228 uword *event_data = 0, event_type;
232 * Create a "loopback" API client connection
233 * Don't do things like this unless you know what you're doing...
236 shmem_hdr = am->shmem_hdr;
237 bsm->vl_input_queue = shmem_hdr->vl_input_queue;
238 memset (mp, 0, sizeof (*mp));
239 mp->_vl_msg_id = VL_API_MEMCLNT_CREATE;
240 mp->context = 0xFEEDFACE;
241 mp->input_queue = pointer_to_uword (bsm->vl_input_queue);
242 strncpy ((char *) mp->name, "tcp_test_server", sizeof (mp->name) - 1);
244 vl_api_memclnt_create_t_handler (mp);
247 bsm->node_index = vlib_get_current_process (vm)->node_runtime.node_index;
248 vlib_process_wait_for_event_or_clock (vm, 1.0);
249 event_type = vlib_process_get_events (vm, &event_data);
259 clib_warning ("unknown event_type %d", event_type);
270 builtin_server_main_t *bsm = &builtin_server_main;
271 u8 segment_name[128];
272 u64 options[SESSION_OPTIONS_N_OPTIONS];
273 vnet_app_attach_args_t _a, *a = &_a;
275 memset (a, 0, sizeof (*a));
276 memset (options, 0, sizeof (options));
278 a->api_client_index = bsm->my_client_index;
279 a->session_cb_vft = &builtin_session_cb_vft;
280 a->options = options;
281 a->options[SESSION_OPTIONS_SEGMENT_SIZE] = 512 << 20;
282 a->options[SESSION_OPTIONS_RX_FIFO_SIZE] = 64 << 10;
283 a->options[SESSION_OPTIONS_TX_FIFO_SIZE] = 64 << 10;
284 a->options[APP_OPTIONS_FLAGS] = APP_OPTIONS_FLAGS_BUILTIN_APP;
285 a->options[APP_OPTIONS_PREALLOC_FIFO_PAIRS] = 8192;
286 a->segment_name = segment_name;
287 a->segment_name_length = ARRAY_LEN (segment_name);
289 if (vnet_application_attach (a))
291 clib_warning ("failed to attach server");
294 bsm->app_index = a->app_index;
301 builtin_server_main_t *bsm = &builtin_server_main;
302 vnet_bind_args_t _a, *a = &_a;
303 memset (a, 0, sizeof (*a));
304 a->app_index = bsm->app_index;
305 a->uri = "tcp://0.0.0.0/1234";
306 return vnet_bind_uri (a);
310 server_create (vlib_main_t * vm)
312 builtin_server_main_t *bsm = &builtin_server_main;
314 vlib_thread_main_t *vtm = vlib_get_thread_main ();
316 if (bsm->my_client_index == (u32) ~ 0)
318 if (create_api_loopback (vm))
322 num_threads = 1 /* main thread */ + vtm->n_threads;
323 vec_validate (builtin_server_main.vpp_queue, num_threads - 1);
325 if (server_attach ())
327 clib_warning ("failed to attach server");
330 if (server_listen ())
332 clib_warning ("failed to start listening");
338 /* Get our api client index */
340 vl_api_memclnt_create_reply_t_handler (vl_api_memclnt_create_reply_t * mp)
342 vlib_main_t *vm = vlib_get_main ();
343 builtin_server_main_t *bsm = &builtin_server_main;
344 bsm->my_client_index = mp->index;
345 vlib_process_signal_event (vm, bsm->node_index, 1 /* evt */ ,
349 #define foreach_tcp_builtin_server_api_msg \
350 _(MEMCLNT_CREATE_REPLY, memclnt_create_reply) \
352 static clib_error_t *
353 tcp_builtin_server_api_hookup (vlib_main_t * vm)
355 vl_msg_api_msg_config_t _c, *c = &_c;
357 /* Hook up client-side static APIs to our handlers */
358 #define _(N,n) do { \
359 c->id = VL_API_##N; \
361 c->handler = vl_api_##n##_t_handler; \
362 c->cleanup = vl_noop_handler; \
363 c->endian = vl_api_##n##_t_endian; \
364 c->print = vl_api_##n##_t_print; \
365 c->size = sizeof(vl_api_##n##_t); \
366 c->traced = 1; /* trace, so these msgs print */ \
367 c->replay = 0; /* don't replay client create/delete msgs */ \
368 c->message_bounce = 0; /* don't bounce this message */ \
369 vl_msg_api_config(c);} while (0);
371 foreach_tcp_builtin_server_api_msg;
377 static clib_error_t *
378 server_create_command_fn (vlib_main_t * vm,
379 unformat_input_t * input, vlib_cli_command_t * cmd)
383 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
385 if (unformat (input, "whatever %d", &whatever))
388 return clib_error_return (0, "unknown input `%U'",
389 format_unformat_error, input);
393 tcp_builtin_server_api_hookup (vm);
394 vnet_session_enable_disable (vm, 1 /* turn on TCP, etc. */ );
395 rv = server_create (vm);
401 return clib_error_return (0, "server_create returned %d", rv);
407 VLIB_CLI_COMMAND (server_create_command, static) =
409 .path = "test tcp server",
410 .short_help = "test tcp server",
411 .function = server_create_command_fn,
416 builtin_tcp_server_main_init (vlib_main_t * vm)
418 builtin_server_main_t *bsm = &builtin_server_main;
419 bsm->my_client_index = ~0;
423 VLIB_INIT_FUNCTION (builtin_tcp_server_main_init);
426 * fd.io coding-style-patch-verification: ON
429 * eval: (c-set-style "gnu")