FD.io VPP  v18.01.2-1-g9b554f3
Vector Packet Processing
session_api.c
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2015-2016 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 #include <vnet/vnet.h>
17 #include <vlibmemory/api.h>
22 
23 #include <vnet/vnet_msg_enum.h>
24 
25 #define vl_typedefs /* define message structures */
26 #include <vnet/vnet_all_api_h.h>
27 #undef vl_typedefs
28 
29 #define vl_endianfun /* define message structures */
30 #include <vnet/vnet_all_api_h.h>
31 #undef vl_endianfun
32 
33 /* instantiate all the print functions we know about */
34 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
35 #define vl_printfun
36 #include <vnet/vnet_all_api_h.h>
37 #undef vl_printfun
38 
40 
41 #define foreach_session_api_msg \
42 _(MAP_ANOTHER_SEGMENT_REPLY, map_another_segment_reply) \
43 _(APPLICATION_ATTACH, application_attach) \
44 _(APPLICATION_DETACH, application_detach) \
45 _(BIND_URI, bind_uri) \
46 _(UNBIND_URI, unbind_uri) \
47 _(CONNECT_URI, connect_uri) \
48 _(DISCONNECT_SESSION, disconnect_session) \
49 _(DISCONNECT_SESSION_REPLY, disconnect_session_reply) \
50 _(ACCEPT_SESSION_REPLY, accept_session_reply) \
51 _(RESET_SESSION_REPLY, reset_session_reply) \
52 _(BIND_SOCK, bind_sock) \
53 _(UNBIND_SOCK, unbind_sock) \
54 _(CONNECT_SOCK, connect_sock) \
55 _(SESSION_ENABLE_DISABLE, session_enable_disable) \
56 _(APP_NAMESPACE_ADD_DEL, app_namespace_add_del) \
57 _(SESSION_RULE_ADD_DEL, session_rule_add_del) \
58 _(SESSION_RULES_DUMP, session_rules_dump) \
59 
60 static int
61 send_add_segment_callback (u32 api_client_index, const u8 * segment_name,
62  u32 segment_size)
63 {
66 
67  q = vl_api_client_index_to_input_queue (api_client_index);
68 
69  if (!q)
70  return -1;
71 
72  mp = vl_msg_api_alloc_as_if_client (sizeof (*mp));
73  memset (mp, 0, sizeof (*mp));
74  mp->_vl_msg_id = clib_host_to_net_u16 (VL_API_MAP_ANOTHER_SEGMENT);
75  mp->segment_size = segment_size;
76  strncpy ((char *) mp->segment_name, (char *) segment_name,
77  sizeof (mp->segment_name) - 1);
78 
79  vl_msg_api_send_shmem (q, (u8 *) & mp);
80 
81  return 0;
82 }
83 
84 static int
86 {
88  unix_shared_memory_queue_t *q, *vpp_queue;
89  application_t *server = application_get (s->app_index);
91  transport_proto_vft_t *tp_vft;
92  stream_session_t *listener;
93 
94  q = vl_api_client_index_to_input_queue (server->api_client_index);
95  vpp_queue = session_manager_get_vpp_event_queue (s->thread_index);
96 
97  if (!q)
98  return -1;
99 
100  mp = vl_msg_api_alloc_as_if_client (sizeof (*mp));
101  memset (mp, 0, sizeof (*mp));
102 
103  mp->_vl_msg_id = clib_host_to_net_u16 (VL_API_ACCEPT_SESSION);
104  mp->context = server->index;
105  listener = listen_session_get (s->session_type, s->listener_index);
107  tc = tp_vft->get_connection (s->connection_index, s->thread_index);
109 
110  if (application_is_proxy (server))
111  {
112  listener =
115  tc->proto);
116  if (listener)
118  }
119  mp->handle = session_handle (s);
120  mp->server_rx_fifo = pointer_to_uword (s->server_rx_fifo);
121  mp->server_tx_fifo = pointer_to_uword (s->server_tx_fifo);
122  mp->vpp_event_queue_address = pointer_to_uword (vpp_queue);
123  mp->port = tc->rmt_port;
124  mp->is_ip4 = tc->is_ip4;
125  clib_memcpy (&mp->ip, &tc->rmt_ip, sizeof (tc->rmt_ip));
126  vl_msg_api_send_shmem (q, (u8 *) & mp);
127 
128  return 0;
129 }
130 
131 static void
133 {
136  application_t *app = application_get (s->app_index);
137 
138  q = vl_api_client_index_to_input_queue (app->api_client_index);
139 
140  if (!q)
141  return;
142 
143  mp = vl_msg_api_alloc_as_if_client (sizeof (*mp));
144  memset (mp, 0, sizeof (*mp));
145  mp->_vl_msg_id = clib_host_to_net_u16 (VL_API_DISCONNECT_SESSION);
146  mp->handle = session_handle (s);
147  vl_msg_api_send_shmem (q, (u8 *) & mp);
148 }
149 
150 static void
152 {
155  application_t *app = application_get (s->app_index);
156 
157  q = vl_api_client_index_to_input_queue (app->api_client_index);
158 
159  if (!q)
160  return;
161 
162  mp = vl_msg_api_alloc_as_if_client (sizeof (*mp));
163  memset (mp, 0, sizeof (*mp));
164  mp->_vl_msg_id = clib_host_to_net_u16 (VL_API_RESET_SESSION);
165  mp->handle = session_handle (s);
166  vl_msg_api_send_shmem (q, (u8 *) & mp);
167 }
168 
169 int
171  stream_session_t * s, u8 is_fail)
172 {
175  application_t *app;
176  unix_shared_memory_queue_t *vpp_queue;
178 
179  app = application_get (app_index);
180  q = vl_api_client_index_to_input_queue (app->api_client_index);
181 
182  if (!q)
183  return -1;
184 
185  mp = vl_msg_api_alloc_as_if_client (sizeof (*mp));
186  mp->_vl_msg_id = clib_host_to_net_u16 (VL_API_CONNECT_SESSION_REPLY);
187  mp->context = api_context;
188 
189  if (is_fail)
190  goto done;
191 
192  tc = session_get_transport (s);
193  if (!tc)
194  {
195  is_fail = 1;
196  goto done;
197  }
198 
199  vpp_queue = session_manager_get_vpp_event_queue (s->thread_index);
200  mp->server_rx_fifo = pointer_to_uword (s->server_rx_fifo);
201  mp->server_tx_fifo = pointer_to_uword (s->server_tx_fifo);
202  mp->handle = session_handle (s);
203  mp->vpp_event_queue_address = pointer_to_uword (vpp_queue);
204  clib_memcpy (mp->lcl_ip, &tc->lcl_ip, sizeof (tc->lcl_ip));
205  mp->is_ip4 = tc->is_ip4;
206  mp->lcl_port = tc->lcl_port;
207 
208 done:
209  mp->retval = is_fail ?
210  clib_host_to_net_u32 (VNET_API_ERROR_SESSION_CONNECT) : 0;
211  vl_msg_api_send_shmem (q, (u8 *) & mp);
212  return 0;
213 }
214 
215 /**
216  * Redirect a connect_uri message to the indicated server.
217  * Only sent if the server has bound the related port with
218  * URI_OPTIONS_FLAGS_USE_FIFO
219  */
220 static int
221 redirect_connect_callback (u32 server_api_client_index, void *mp_arg)
222 {
223  vl_api_connect_sock_t *mp = mp_arg;
224  unix_shared_memory_queue_t *server_q, *client_q;
227  f64 timeout = vlib_time_now (vm) + 0.5;
228  application_t *app;
229  int rv = 0;
230 
231  server_q = vl_api_client_index_to_input_queue (server_api_client_index);
232 
233  if (!server_q)
234  {
235  rv = VNET_API_ERROR_INVALID_VALUE;
236  goto out;
237  }
238 
240  if (!client_q)
241  {
242  rv = VNET_API_ERROR_INVALID_VALUE_2;
243  goto out;
244  }
245 
246  /* Tell the server the client's API queue address, so it can reply */
247  mp->client_queue_address = pointer_to_uword (client_q);
248  app = application_lookup (mp->client_index);
249  if (!app)
250  {
251  clib_warning ("no client application");
252  return -1;
253  }
254 
255  props = segment_manager_properties_get (app->sm_properties);
256  mp->options[APP_OPTIONS_RX_FIFO_SIZE] = props->rx_fifo_size;
257  mp->options[APP_OPTIONS_TX_FIFO_SIZE] = props->tx_fifo_size;
258 
259  /*
260  * Bounce message handlers MUST NOT block the data-plane.
261  * Spin waiting for the queue lock, but
262  */
263 
264  while (vlib_time_now (vm) < timeout)
265  {
266  rv =
267  unix_shared_memory_queue_add (server_q, (u8 *) & mp, 1 /*nowait */ );
268  switch (rv)
269  {
270  /* correctly enqueued */
271  case 0:
272  return VNET_API_ERROR_SESSION_REDIRECT;
273 
274  /* continue spinning, wait for pthread_mutex_trylock to work */
275  case -1:
276  continue;
277 
278  /* queue stuffed, drop the msg */
279  case -2:
280  rv = VNET_API_ERROR_QUEUE_FULL;
281  goto out;
282  }
283  }
284 out:
285  /* Dispose of the message */
286  vl_msg_api_free (mp);
287  return rv;
288 }
289 
291  .session_accept_callback = send_session_accept_callback,
292  .session_disconnect_callback = send_session_disconnect_callback,
293  .session_connected_callback = send_session_connected_callback,
294  .session_reset_callback = send_session_reset_callback,
295  .add_segment_callback = send_add_segment_callback,
296  .redirect_connect_callback = redirect_connect_callback
297 };
298 
299 static void
301 {
302  vl_api_session_enable_disable_reply_t *rmp;
304  int rv = 0;
305 
307  REPLY_MACRO (VL_API_SESSION_ENABLE_DISABLE_REPLY);
308 }
309 
310 static void
312 {
314  vnet_app_attach_args_t _a, *a = &_a;
315  clib_error_t *error = 0;
316  int rv = 0;
317 
318  if (session_manager_is_enabled () == 0)
319  {
320  rv = VNET_API_ERROR_FEATURE_DISABLED;
321  goto done;
322  }
323 
325  sizeof (mp->options),
326  "Out of options, fix api message definition");
327 
328  memset (a, 0, sizeof (*a));
329  a->api_client_index = mp->client_index;
330  a->options = mp->options;
331  a->session_cb_vft = &session_cb_vft;
332 
333  if (mp->namespace_id_len > 64)
334  {
335  rv = VNET_API_ERROR_INVALID_VALUE;
336  goto done;
337  }
338 
339  if (mp->namespace_id_len)
340  {
341  vec_validate (a->namespace_id, mp->namespace_id_len - 1);
342  clib_memcpy (a->namespace_id, mp->namespace_id, mp->namespace_id_len);
343  }
344 
345  if ((error = vnet_application_attach (a)))
346  {
347  rv = clib_error_get_code (error);
348  clib_error_report (error);
349  }
350  vec_free (a->namespace_id);
351 
352 done:
353 
354  /* *INDENT-OFF* */
355  REPLY_MACRO2 (VL_API_APPLICATION_ATTACH_REPLY, ({
356  if (!rv)
357  {
358  rmp->segment_name_length = 0;
359  rmp->segment_size = a->segment_size;
360  if (a->segment_name_length)
361  {
362  memcpy (rmp->segment_name, a->segment_name,
363  a->segment_name_length);
364  rmp->segment_name_length = a->segment_name_length;
365  }
366  rmp->app_event_queue_address = a->app_event_queue_address;
367  }
368  }));
369  /* *INDENT-ON* */
370 }
371 
372 static void
374 {
375  vl_api_application_detach_reply_t *rmp;
376  int rv = VNET_API_ERROR_INVALID_VALUE_2;
377  vnet_app_detach_args_t _a, *a = &_a;
378  application_t *app;
379 
380  if (session_manager_is_enabled () == 0)
381  {
382  rv = VNET_API_ERROR_FEATURE_DISABLED;
383  goto done;
384  }
385 
386  app = application_lookup (mp->client_index);
387  if (app)
388  {
389  a->app_index = app->index;
390  rv = vnet_application_detach (a);
391  }
392 
393 done:
394  REPLY_MACRO (VL_API_APPLICATION_DETACH_REPLY);
395 }
396 
397 static void
399 {
400  vl_api_bind_uri_reply_t *rmp;
401  vnet_bind_args_t _a, *a = &_a;
402  application_t *app;
403  int rv;
404 
405  if (session_manager_is_enabled () == 0)
406  {
407  rv = VNET_API_ERROR_FEATURE_DISABLED;
408  goto done;
409  }
410 
411  app = application_lookup (mp->client_index);
412  if (app)
413  {
414  memset (a, 0, sizeof (*a));
415  a->uri = (char *) mp->uri;
416  a->app_index = app->index;
417  rv = vnet_bind_uri (a);
418  }
419  else
420  {
421  rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
422  }
423 
424 done:
425  REPLY_MACRO (VL_API_BIND_URI_REPLY);
426 }
427 
428 static void
430 {
431  vl_api_unbind_uri_reply_t *rmp;
432  application_t *app;
433  vnet_unbind_args_t _a, *a = &_a;
434  int rv;
435 
436  if (session_manager_is_enabled () == 0)
437  {
438  rv = VNET_API_ERROR_FEATURE_DISABLED;
439  goto done;
440  }
441 
442  app = application_lookup (mp->client_index);
443  if (app)
444  {
445  a->uri = (char *) mp->uri;
446  a->app_index = app->index;
447  rv = vnet_unbind_uri (a);
448  }
449  else
450  {
451  rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
452  }
453 
454 done:
455  REPLY_MACRO (VL_API_UNBIND_URI_REPLY);
456 }
457 
458 static void
460 {
462  vnet_connect_args_t _a, *a = &_a;
463  application_t *app;
464  clib_error_t *error = 0;
465  int rv = 0;
466 
467  if (session_manager_is_enabled () == 0)
468  {
469  rv = VNET_API_ERROR_FEATURE_DISABLED;
470  goto done;
471  }
472 
473  app = application_lookup (mp->client_index);
474  if (app)
475  {
476  a->uri = (char *) mp->uri;
477  a->api_context = mp->context;
478  a->app_index = app->index;
479  a->mp = mp;
480  if ((error = vnet_connect_uri (a)))
481  {
482  rv = clib_error_get_code (error);
483  if (rv != VNET_API_ERROR_SESSION_REDIRECT)
484  clib_error_report (error);
485  }
486  }
487  else
488  {
489  rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
490  }
491 
492  /*
493  * Don't reply to stream (tcp) connects. The reply will come once
494  * the connection is established. In case of the redirects, the reply
495  * will come from the server app.
496  */
497  if (rv == 0 || rv == VNET_API_ERROR_SESSION_REDIRECT)
498  return;
499 
500 done:
501  /* *INDENT-OFF* */
502  REPLY_MACRO (VL_API_CONNECT_SESSION_REPLY);
503  /* *INDENT-ON* */
504 }
505 
506 static void
508 {
510  vnet_disconnect_args_t _a, *a = &_a;
511  application_t *app;
512  int rv = 0;
513 
514  if (session_manager_is_enabled () == 0)
515  {
516  rv = VNET_API_ERROR_FEATURE_DISABLED;
517  goto done;
518  }
519 
520  app = application_lookup (mp->client_index);
521  if (app)
522  {
523  a->handle = mp->handle;
524  a->app_index = app->index;
525  rv = vnet_disconnect_session (a);
526  }
527  else
528  {
529  rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
530  }
531 
532 done:
533  REPLY_MACRO2 (VL_API_DISCONNECT_SESSION_REPLY, rmp->handle = mp->handle);
534 }
535 
536 static void
538  mp)
539 {
540  vnet_disconnect_args_t _a, *a = &_a;
541  application_t *app;
542 
543  /* Client objected to disconnecting the session, log and continue */
544  if (mp->retval)
545  {
546  clib_warning ("client retval %d", mp->retval);
547  return;
548  }
549 
550  /* Disconnect has been confirmed. Confirm close to transport */
551  app = application_lookup (mp->client_index);
552  if (app)
553  {
554  a->handle = mp->handle;
555  a->app_index = app->index;
557  }
558 }
559 
560 static void
562 {
563  application_t *app;
564  stream_session_t *s;
565  u32 index, thread_index;
566 
567  app = application_lookup (mp->client_index);
568  if (!app)
569  return;
570 
571  session_parse_handle (mp->handle, &index, &thread_index);
572  s = session_get_if_valid (index, thread_index);
573  if (s == 0 || app->index != s->app_index)
574  {
575  clib_warning ("Invalid session!");
576  return;
577  }
578 
579  /* Client objected to resetting the session, log and continue */
580  if (mp->retval)
581  {
582  clib_warning ("client retval %d", mp->retval);
583  return;
584  }
585 
586  /* This comes as a response to a reset, transport only waiting for
587  * confirmation to remove connection state, no need to disconnect */
589 }
590 
591 static void
593 {
594  stream_session_t *s;
595  u32 session_index, thread_index;
596  vnet_disconnect_args_t _a, *a = &_a;
597 
598  /* Server isn't interested, kill the session */
599  if (mp->retval)
600  {
601  a->app_index = mp->context;
602  a->handle = mp->handle;
604  }
605  else
606  {
607  session_parse_handle (mp->handle, &session_index, &thread_index);
608  s = session_get_if_valid (session_index, thread_index);
609  if (!s)
610  {
611  clib_warning ("session doesn't exist");
612  return;
613  }
614  if (s->app_index != mp->context)
615  {
616  clib_warning ("app doesn't own session");
617  return;
618  }
619  s->session_state = SESSION_STATE_READY;
620  }
621 }
622 
623 static void
624 vl_api_map_another_segment_reply_t_handler (vl_api_map_another_segment_reply_t
625  * mp)
626 {
627  clib_warning ("not implemented");
628 }
629 
630 static void
632 {
634  vnet_bind_args_t _a, *a = &_a;
635  int rv = 0;
636  clib_error_t *error;
637  application_t *app = 0;
638  stream_session_t *s;
639  transport_connection_t *tc = 0;
640  ip46_address_t *ip46;
641 
642  if (session_manager_is_enabled () == 0)
643  {
644  rv = VNET_API_ERROR_FEATURE_DISABLED;
645  goto done;
646  }
647 
648  app = application_lookup (mp->client_index);
649  if (!app)
650  {
651  rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
652  goto done;
653  }
654 
655  ip46 = (ip46_address_t *) mp->ip;
656  memset (a, 0, sizeof (*a));
657  a->sep.is_ip4 = mp->is_ip4;
658  a->sep.ip = *ip46;
659  a->sep.port = mp->port;
660  a->sep.fib_index = mp->vrf;
661  a->sep.sw_if_index = ENDPOINT_INVALID_INDEX;
662  a->sep.transport_proto = mp->proto;
663  a->app_index = app->index;
664 
665  if ((error = vnet_bind (a)))
666  {
667  rv = clib_error_get_code (error);
668  clib_error_report (error);
669  }
670 
671 done:
672  /* *INDENT-OFF* */
673  REPLY_MACRO2 (VL_API_BIND_SOCK_REPLY,({
674  if (!rv)
675  {
676  rmp->handle = a->handle;
677  rmp->lcl_port = mp->port;
678  if (app && application_has_global_scope (app))
679  {
680  s = listen_session_get_from_handle (a->handle);
682  rmp->lcl_is_ip4 = tc->is_ip4;
683  clib_memcpy (rmp->lcl_ip, &tc->lcl_ip, sizeof (tc->lcl_ip));
684  }
685  }
686  }));
687  /* *INDENT-ON* */
688 }
689 
690 static void
692 {
693  vl_api_unbind_sock_reply_t *rmp;
694  vnet_unbind_args_t _a, *a = &_a;
695  application_t *app;
696  clib_error_t *error;
697  int rv = 0;
698 
699  if (session_manager_is_enabled () == 0)
700  {
701  rv = VNET_API_ERROR_FEATURE_DISABLED;
702  goto done;
703  }
704 
705  app = application_lookup (mp->client_index);
706  if (app)
707  {
708  a->app_index = app->index;
709  a->handle = mp->handle;
710  if ((error = vnet_unbind (a)))
711  {
712  rv = clib_error_get_code (error);
713  clib_error_report (error);
714  }
715  }
716 
717 done:
718  REPLY_MACRO (VL_API_UNBIND_SOCK_REPLY);
719 }
720 
721 static void
723 {
725  vnet_connect_args_t _a, *a = &_a;
726  application_t *app;
727  clib_error_t *error = 0;
728  int rv = 0;
729 
730  if (session_manager_is_enabled () == 0)
731  {
732  rv = VNET_API_ERROR_FEATURE_DISABLED;
733  goto done;
734  }
735 
736  app = application_lookup (mp->client_index);
737  if (app)
738  {
739  unix_shared_memory_queue_t *client_q;
740  ip46_address_t *ip46 = (ip46_address_t *) mp->ip;
741 
743  mp->client_queue_address = pointer_to_uword (client_q);
744  a->sep.is_ip4 = mp->is_ip4;
745  a->sep.ip = *ip46;
746  a->sep.port = mp->port;
747  a->sep.transport_proto = mp->proto;
748  a->sep.fib_index = mp->vrf;
749  a->sep.sw_if_index = ENDPOINT_INVALID_INDEX;
750  a->api_context = mp->context;
751  a->app_index = app->index;
752  a->mp = mp;
753  if ((error = vnet_connect (a)))
754  {
755  rv = clib_error_get_code (error);
756  if (rv != VNET_API_ERROR_SESSION_REDIRECT)
757  clib_error_report (error);
758  }
759  }
760  else
761  {
762  rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
763  }
764 
765  if (rv == 0 || rv == VNET_API_ERROR_SESSION_REDIRECT)
766  return;
767 
768  /* Got some error, relay it */
769 
770 done:
771  REPLY_MACRO (VL_API_CONNECT_SESSION_REPLY);
772 }
773 
774 static void
776 {
778  clib_error_t *error = 0;
779  u32 appns_index = 0;
780  u8 *ns_id = 0;
781  int rv = 0;
783  {
784  rv = VNET_API_ERROR_FEATURE_DISABLED;
785  goto done;
786  }
787 
788  if (mp->namespace_id_len > ARRAY_LEN (mp->namespace_id))
789  {
790  rv = VNET_API_ERROR_INVALID_VALUE;
791  goto done;
792  }
793 
794  vec_validate (ns_id, mp->namespace_id_len - 1);
795  clib_memcpy (ns_id, mp->namespace_id, mp->namespace_id_len);
797  .ns_id = ns_id,
798  .secret = clib_net_to_host_u64 (mp->secret),
799  .sw_if_index = clib_net_to_host_u32 (mp->sw_if_index),
800  .ip4_fib_id = clib_net_to_host_u32 (mp->ip4_fib_id),
801  .ip6_fib_id = clib_net_to_host_u32 (mp->ip6_fib_id),
802  .is_add = 1
803  };
804  error = vnet_app_namespace_add_del (&args);
805  if (error)
806  {
807  rv = clib_error_get_code (error);
808  clib_error_report (error);
809  }
810  else
811  {
812  appns_index = app_namespace_index_from_id (ns_id);
813  if (appns_index == APP_NAMESPACE_INVALID_INDEX)
814  {
815  clib_warning ("app ns lookup failed");
816  rv = VNET_API_ERROR_UNSPECIFIED;
817  }
818  }
819  vec_free (ns_id);
820 
821  /* *INDENT-OFF* */
822 done:
823  REPLY_MACRO2 (VL_API_APP_NAMESPACE_ADD_DEL_REPLY, ({
824  if (!rv)
825  rmp->appns_index = clib_host_to_net_u32 (appns_index);
826  }));
827  /* *INDENT-ON* */
828 }
829 
830 static void
832 {
833  vl_api_session_rule_add_del_reply_t *rmp;
835  session_rule_table_add_del_args_t *table_args = &args.table_args;
836  clib_error_t *error;
837  u8 fib_proto;
838  int rv = 0;
839 
840  memset (&args, 0, sizeof (args));
841  fib_proto = mp->is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
842 
843  table_args->lcl.fp_len = mp->lcl_plen;
844  table_args->lcl.fp_proto = fib_proto;
845  table_args->rmt.fp_len = mp->rmt_plen;
846  table_args->rmt.fp_proto = fib_proto;
847  table_args->lcl_port = mp->lcl_port;
848  table_args->rmt_port = mp->rmt_port;
849  table_args->action_index = clib_net_to_host_u32 (mp->action_index);
850  table_args->is_add = mp->is_add;
851  mp->tag[sizeof (mp->tag) - 1] = 0;
852  table_args->tag = format (0, "%s", mp->tag);
853  args.appns_index = clib_net_to_host_u32 (mp->appns_index);
854  args.scope = mp->scope;
855  args.transport_proto = mp->transport_proto;
856 
857  memset (&table_args->lcl.fp_addr, 0, sizeof (table_args->lcl.fp_addr));
858  memset (&table_args->rmt.fp_addr, 0, sizeof (table_args->rmt.fp_addr));
859  ip_set (&table_args->lcl.fp_addr, mp->lcl_ip, mp->is_ip4);
860  ip_set (&table_args->rmt.fp_addr, mp->rmt_ip, mp->is_ip4);
861  error = vnet_session_rule_add_del (&args);
862  if (error)
863  {
864  rv = clib_error_get_code (error);
865  clib_error_report (error);
866  }
867  vec_free (table_args->tag);
868  REPLY_MACRO (VL_API_SESSION_RULE_ADD_DEL_REPLY);
869 }
870 
871 static void
872 send_session_rule_details4 (mma_rule_16_t * rule, u8 is_local,
873  u8 transport_proto, u32 appns_index, u8 * tag,
874  unix_shared_memory_queue_t * q, u32 context)
875 {
877  session_mask_or_match_4_t *match =
878  (session_mask_or_match_4_t *) & rule->match;
879  session_mask_or_match_4_t *mask =
880  (session_mask_or_match_4_t *) & rule->mask;
881 
882  rmp = vl_msg_api_alloc (sizeof (*rmp));
883  memset (rmp, 0, sizeof (*rmp));
884  rmp->_vl_msg_id = ntohs (VL_API_SESSION_RULES_DETAILS);
885  rmp->context = context;
886 
887  rmp->is_ip4 = 1;
888  clib_memcpy (rmp->lcl_ip, &match->lcl_ip, sizeof (match->lcl_ip));
889  clib_memcpy (rmp->rmt_ip, &match->rmt_ip, sizeof (match->rmt_ip));
890  rmp->lcl_plen = ip4_mask_to_preflen (&mask->lcl_ip);
891  rmp->rmt_plen = ip4_mask_to_preflen (&mask->rmt_ip);
892  rmp->lcl_port = match->lcl_port;
893  rmp->rmt_port = match->rmt_port;
894  rmp->action_index = clib_host_to_net_u32 (rule->action_index);
895  rmp->scope =
897  rmp->transport_proto = transport_proto;
898  rmp->appns_index = clib_host_to_net_u32 (appns_index);
899  if (tag)
900  {
901  clib_memcpy (rmp->tag, tag, vec_len (tag));
902  rmp->tag[vec_len (tag)] = 0;
903  }
904 
905  vl_msg_api_send_shmem (q, (u8 *) & rmp);
906 }
907 
908 static void
909 send_session_rule_details6 (mma_rule_40_t * rule, u8 is_local,
910  u8 transport_proto, u32 appns_index, u8 * tag,
911  unix_shared_memory_queue_t * q, u32 context)
912 {
914  session_mask_or_match_6_t *match =
915  (session_mask_or_match_6_t *) & rule->match;
916  session_mask_or_match_6_t *mask =
917  (session_mask_or_match_6_t *) & rule->mask;
918 
919  rmp = vl_msg_api_alloc (sizeof (*rmp));
920  memset (rmp, 0, sizeof (*rmp));
921  rmp->_vl_msg_id = ntohs (VL_API_SESSION_RULES_DETAILS);
922  rmp->context = context;
923 
924  rmp->is_ip4 = 0;
925  clib_memcpy (rmp->lcl_ip, &match->lcl_ip, sizeof (match->lcl_ip));
926  clib_memcpy (rmp->rmt_ip, &match->rmt_ip, sizeof (match->rmt_ip));
927  rmp->lcl_plen = ip6_mask_to_preflen (&mask->lcl_ip);
928  rmp->rmt_plen = ip6_mask_to_preflen (&mask->rmt_ip);
929  rmp->lcl_port = match->lcl_port;
930  rmp->rmt_port = match->rmt_port;
931  rmp->action_index = clib_host_to_net_u32 (rule->action_index);
932  rmp->scope =
934  rmp->transport_proto = transport_proto;
935  rmp->appns_index = clib_host_to_net_u32 (appns_index);
936  if (tag)
937  {
938  clib_memcpy (rmp->tag, tag, vec_len (tag));
939  rmp->tag[vec_len (tag)] = 0;
940  }
941 
942  vl_msg_api_send_shmem (q, (u8 *) & rmp);
943 }
944 
945 static void
947  u8 tp, u8 is_local, u32 appns_index,
948  unix_shared_memory_queue_t * q, u32 context)
949 {
950  mma_rule_16_t *rule16;
951  mma_rule_40_t *rule40;
952  mma_rules_table_16_t *srt16;
953  mma_rules_table_40_t *srt40;
954  u32 ri;
955 
956  if (is_local || fib_proto == FIB_PROTOCOL_IP4)
957  {
958  u8 *tag = 0;
959  /* *INDENT-OFF* */
960  srt16 = &srt->session_rules_tables_16;
961  pool_foreach (rule16, srt16->rules, ({
962  ri = mma_rules_table_rule_index_16 (srt16, rule16);
963  tag = session_rules_table_rule_tag (srt, ri, 1);
964  send_session_rule_details4 (rule16, is_local, tp, appns_index, tag,
965  q, context);
966  }));
967  /* *INDENT-ON* */
968  }
969  if (is_local || fib_proto == FIB_PROTOCOL_IP6)
970  {
971  u8 *tag = 0;
972  /* *INDENT-OFF* */
973  srt40 = &srt->session_rules_tables_40;
974  pool_foreach (rule40, srt40->rules, ({
975  ri = mma_rules_table_rule_index_40 (srt40, rule40);
976  tag = session_rules_table_rule_tag (srt, ri, 1);
977  send_session_rule_details6 (rule40, is_local, tp, appns_index, tag,
978  q, context);
979  }));
980  /* *INDENT-ON* */
981  }
982 }
983 
984 static void
986 {
988  session_table_t *st;
989  u8 tp;
990 
992  if (q == 0)
993  return;
994 
995  /* *INDENT-OFF* */
996  session_table_foreach (st, ({
997  for (tp = 0; tp < TRANSPORT_N_PROTO; tp++)
998  {
999  send_session_rules_table_details (&st->session_rules[tp],
1000  st->active_fib_proto, tp,
1001  st->is_local, st->appns_index, q,
1002  mp->context);
1003  }
1004  }));
1005  /* *INDENT-ON* */
1006 }
1007 
1008 static clib_error_t *
1010 {
1011  application_t *app = application_lookup (client_index);
1012  vnet_app_detach_args_t _a, *a = &_a;
1013  if (app)
1014  {
1015  a->app_index = app->index;
1017  }
1018  return 0;
1019 }
1020 
1022 
1023 #define vl_msg_name_crc_list
1024 #include <vnet/vnet_all_api_h.h>
1025 #undef vl_msg_name_crc_list
1026 
1027 static void
1029 {
1030 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
1031  foreach_vl_msg_name_crc_session;
1032 #undef _
1033 }
1034 
1035 /*
1036  * session_api_hookup
1037  * Add uri's API message handlers to the table.
1038  * vlib has alread mapped shared memory and
1039  * added the client registration handlers.
1040  * See .../open-repo/vlib/memclnt_vlib.c:memclnt_process()
1041  */
1042 static clib_error_t *
1044 {
1045  api_main_t *am = &api_main;
1046 
1047 #define _(N,n) \
1048  vl_msg_api_set_handlers(VL_API_##N, #n, \
1049  vl_api_##n##_t_handler, \
1050  vl_noop_handler, \
1051  vl_api_##n##_t_endian, \
1052  vl_api_##n##_t_print, \
1053  sizeof(vl_api_##n##_t), 1);
1055 #undef _
1056 
1057  /*
1058  * Messages which bounce off the data-plane to
1059  * an API client. Simply tells the message handling infra not
1060  * to free the message.
1061  *
1062  * Bounced message handlers MUST NOT block the data plane
1063  */
1064  am->message_bounce[VL_API_CONNECT_URI] = 1;
1065  am->message_bounce[VL_API_CONNECT_SOCK] = 1;
1066 
1067  /*
1068  * Set up the (msg_name, crc, message-id) table
1069  */
1071 
1072  return 0;
1073 }
1074 
1076 
1077 /*
1078  * fd.io coding-style-patch-verification: ON
1079  *
1080  * Local Variables:
1081  * eval: (c-set-style "gnu")
1082  * End:
1083  */
#define vec_validate(V, I)
Make sure vector is long enough for given index (no header, unspecified alignment) ...
Definition: vec.h:432
static void vl_api_disconnect_session_reply_t_handler(vl_api_disconnect_session_reply_t *mp)
Definition: session_api.c:537
void * vl_msg_api_alloc_as_if_client(int nbytes)
#define APP_NAMESPACE_INVALID_INDEX
static clib_error_t * session_api_hookup(vlib_main_t *vm)
Definition: session_api.c:1043
static stream_session_t * listen_session_get_from_handle(u64 handle)
Definition: session.h:474
clib_error_t * vnet_app_namespace_add_del(vnet_app_namespace_add_del_args_t *a)
vpp->client reset session API
Definition: session.api:191
a
Definition: bitmap.h:516
VL_MSG_API_REAPER_FUNCTION(application_reaper_cb)
struct _session_rules_table_t session_rules_table_t
u8 application_has_global_scope(application_t *app)
Definition: application.c:499
struct _transport_connection transport_connection_t
struct _segment_manager_properties segment_manager_properties_t
struct _vnet_connect_args vnet_connect_args_t
static void send_session_rule_details4(mma_rule_16_t *rule, u8 is_local, u8 transport_proto, u32 appns_index, u8 *tag, unix_shared_memory_queue_t *q, u32 context)
Definition: session_api.c:872
int vnet_bind_uri(vnet_bind_args_t *a)
static void vl_api_app_namespace_add_del_t_handler(vl_api_app_namespace_add_del_t *mp)
Definition: session_api.c:775
void ip_set(ip46_address_t *dst, void *src, u8 is_ip4)
Definition: ip.c:76
clib_error_t * vnet_unbind(vnet_unbind_args_t *a)
#define REPLY_MACRO2(t, body)
#define NULL
Definition: clib.h:55
static f64 vlib_time_now(vlib_main_t *vm)
Definition: main.h:224
add/del session rule
Definition: session.api:398
u8 * message_bounce
Don&#39;t automatically free message buffer vetor.
Definition: api_common.h:218
Session rules details.
Definition: session.api:444
static void vl_api_map_another_segment_reply_t_handler(vl_api_map_another_segment_reply_t *mp)
Definition: session_api.c:624
struct _transport_proto_vft transport_proto_vft_t
Bind to an ip:port pair for a given transport protocol.
Definition: session.api:221
struct _vnet_app_namespace_add_del_args vnet_app_namespace_add_del_args_t
client->vpp, reply to an accept message
Definition: session.api:153
application_t * application_lookup(u32 api_client_index)
Definition: application.c:122
Request for map server summary status.
Definition: one.api:885
static void vl_api_unbind_sock_t_handler(vl_api_unbind_sock_t *mp)
Definition: session_api.c:691
transport_connection_t * session_get_transport(stream_session_t *s)
Definition: session.c:1026
u8 * format(u8 *s, const char *fmt,...)
Definition: format.c:419
#define foreach_session_api_msg
Definition: session_api.c:41
static u8 session_manager_is_enabled()
Definition: session.h:545
int application_is_proxy(application_t *app)
Definition: application.c:460
clib_error_t * vnet_session_rule_add_del(session_rule_add_del_args_t *args)
static void vl_api_connect_uri_t_handler(vl_api_connect_uri_t *mp)
Definition: session_api.c:459
int vnet_unbind_uri(vnet_unbind_args_t *a)
static void vl_api_session_enable_disable_t_handler(vl_api_session_enable_disable_t *mp)
Definition: session_api.c:300
#define pool_foreach(VAR, POOL, BODY)
Iterate through pool.
Definition: pool.h:438
struct _vnet_disconnect_args_t vnet_disconnect_args_t
static void send_session_reset_callback(stream_session_t *s)
Definition: session_api.c:151
struct _stream_session_cb_vft session_cb_vft_t
struct _vnet_unbind_args_t vnet_unbind_args_t
vpp/server->client, connect reply – used for all connect_* messages
Definition: session.api:313
add/del application namespace
Definition: session.api:354
unsigned long u64
Definition: types.h:89
void stream_session_cleanup(stream_session_t *s)
Cleanup transport and session state.
Definition: session.c:948
u32 app_namespace_index_from_id(const u8 *ns_id)
struct _stream_session_t stream_session_t
static uword pointer_to_uword(const void *p)
Definition: types.h:131
void * vl_msg_api_alloc(int nbytes)
struct _vnet_app_attach_args_t vnet_app_attach_args_t
transport_proto_vft_t * transport_protocol_get_vft(transport_proto_t transport_proto)
Get transport virtual function table.
Definition: transport.c:167
int unix_shared_memory_queue_add(unix_shared_memory_queue_t *q, u8 *elem, int nowait)
static transport_proto_t session_get_transport_proto(stream_session_t *s)
Definition: session.h:283
static void vl_api_session_rules_dump_t_handler(vl_api_one_map_server_dump_t *mp)
Definition: session_api.c:985
static void session_parse_handle(u64 handle, u32 *index, u32 *thread_index)
Definition: session.h:267
static session_cb_vft_t session_cb_vft
Definition: session_api.c:290
static void vl_api_accept_session_reply_t_handler(vl_api_accept_session_reply_t *mp)
Definition: session_api.c:592
struct _session_rule_add_del_args session_rule_add_del_args_t
client->vpp, attach application to session layer
Definition: session.api:27
static void vl_api_disconnect_session_t_handler(vl_api_disconnect_session_t *mp)
Definition: session_api.c:507
void vl_msg_api_free(void *)
stream_session_t * application_first_listener(application_t *app, u8 fib_proto, u8 transport_proto)
Definition: application.c:511
#define REPLY_MACRO(t)
static clib_error_t * application_reaper_cb(u32 client_index)
Definition: session_api.c:1009
clib_error_t * vnet_connect(vnet_connect_args_t *a)
Unbind a given URI.
Definition: session.api:97
static stream_session_t * session_get_if_valid(u64 si, u32 thread_index)
Definition: session.h:236
clib_error_t * vnet_session_enable_disable(vlib_main_t *vm, u8 is_en)
Definition: session.c:1171
vpp->client, accept this session
Definition: session.api:133
u32 ip6_mask_to_preflen(ip6_address_t *mask)
Definition: ip.c:252
int send_session_connected_callback(u32 app_index, u32 api_context, stream_session_t *s, u8 is_fail)
Definition: session_api.c:170
API main structure, used by both vpp and binary API clients.
Definition: api_common.h:198
static int send_session_accept_callback(stream_session_t *s)
Definition: session_api.c:85
static unix_shared_memory_queue_t * session_manager_get_vpp_event_queue(u32 thread_index)
Definition: session.h:459
api_main_t api_main
Definition: api_shared.c:35
vlib_main_t * vm
Definition: buffer.c:283
#define vec_free(V)
Free vector&#39;s memory (no header).
Definition: vec.h:336
#define ENDPOINT_INVALID_INDEX
Definition: transport.h:97
#define clib_warning(format, args...)
Definition: error.h:59
static int redirect_connect_callback(u32 server_api_client_index, void *mp_arg)
Redirect a connect_uri message to the indicated server.
Definition: session_api.c:221
#define clib_memcpy(a, b, c)
Definition: string.h:75
unix_shared_memory_queue_t * vl_api_client_index_to_input_queue(u32 index)
static u8 transport_connection_fib_proto(transport_connection_t *tc)
Definition: transport.h:100
static void send_session_rules_table_details(session_rules_table_t *srt, u8 fib_proto, u8 tp, u8 is_local, u32 appns_index, unix_shared_memory_queue_t *q, u32 context)
Definition: session_api.c:946
u32 ip4_mask_to_preflen(ip4_address_t *mask)
Definition: ip.c:191
struct _application application_t
int vnet_disconnect_session(vnet_disconnect_args_t *a)
#define ARRAY_LEN(x)
Definition: clib.h:59
Application attach reply.
Definition: session.api:45
void vl_msg_api_send_shmem(unix_shared_memory_queue_t *q, u8 *elem)
unsigned int u32
Definition: types.h:88
enable/disable session layer
Definition: session.api:334
static void vl_api_connect_sock_t_handler(vl_api_connect_sock_t *mp)
Definition: session_api.c:722
clib_error_t * vnet_bind(vnet_bind_args_t *a)
Reply for app namespace add/del.
Definition: session.api:370
client->vpp, attach application to session layer
Definition: session.api:58
static void vl_api_bind_sock_t_handler(vl_api_bind_sock_t *mp)
Definition: session_api.c:631
vpp->client, please map an additional shared memory segment
Definition: session.api:68
#define clib_error_report(e)
Definition: error.h:113
static int app_index
struct _vnet_app_detach_args_t vnet_app_detach_args_t
Connect to a remote peer.
Definition: session.api:255
static vlib_main_t * vlib_get_main(void)
Definition: global_funcs.h:23
static void vl_api_application_attach_t_handler(vl_api_application_attach_t *mp)
Definition: session_api.c:311
static void setup_message_id_table(api_main_t *am)
Definition: session_api.c:1028
bidirectional disconnect API
Definition: session.api:165
static u64 session_handle(stream_session_t *s)
Definition: session.h:249
clib_error_t * vnet_connect_uri(vnet_connect_args_t *a)
transport_connection_t * listen_session_get_transport(stream_session_t *s)
Definition: session.c:1039
#define vec_len(v)
Number of elements in vector (rvalue-only, NULL tolerant)
double f64
Definition: types.h:142
static stream_session_t * listen_session_get(session_type_t type, u32 index)
Definition: session.h:506
unsigned char u8
Definition: types.h:56
Bind to a given URI.
Definition: session.api:83
clib_error_t * vnet_application_attach(vnet_app_attach_args_t *a)
Attach application to vpp.
#define STATIC_ASSERT(truth,...)
application_t * application_get(u32 index)
Definition: application.c:297
#define clib_error_get_code(err)
Definition: error.h:77
VLIB_API_INIT_FUNCTION(session_api_hookup)
struct _session_lookup_table session_table_t
static int send_add_segment_callback(u32 api_client_index, const u8 *segment_name, u32 segment_size)
Definition: session_api.c:61
static void send_session_disconnect_callback(stream_session_t *s)
Definition: session_api.c:132
static void vl_api_application_detach_t_handler(vl_api_application_detach_t *mp)
Definition: session_api.c:373
struct _session_rules_table_add_del_args session_rule_table_add_del_args_t
#define session_table_foreach(VAR, BODY)
Definition: session_table.h:74
static void send_session_rule_details6(mma_rule_40_t *rule, u8 is_local, u8 transport_proto, u32 appns_index, u8 *tag, unix_shared_memory_queue_t *q, u32 context)
Definition: session_api.c:909
client->vpp reset session reply
Definition: session.api:204
Connect to a given URI.
Definition: session.api:113
static void vl_api_session_rule_add_del_t_handler(vl_api_session_rule_add_del_t *mp)
Definition: session_api.c:831
bidirectional disconnect reply API
Definition: session.api:178
int vnet_application_detach(vnet_app_detach_args_t *a)
Detach application from vpp.
struct _vnet_bind_args_t vnet_bind_args_t
static u64 listen_session_get_handle(stream_session_t *s)
Definition: session.h:467
static void vl_api_bind_uri_t_handler(vl_api_bind_uri_t *mp)
Definition: session_api.c:398
static void vl_api_reset_session_reply_t_handler(vl_api_reset_session_reply_t *mp)
Definition: session_api.c:561
struct _unix_shared_memory_queue unix_shared_memory_queue_t
segment_manager_properties_t * segment_manager_properties_get(u32 smp_index)
static void vl_api_unbind_uri_t_handler(vl_api_unbind_uri_t *mp)
Definition: session_api.c:429