36 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__) 43 #define foreach_session_api_msg \ 44 _(MAP_ANOTHER_SEGMENT_REPLY, map_another_segment_reply) \ 45 _(APPLICATION_ATTACH, application_attach) \ 46 _(APP_ATTACH, app_attach) \ 47 _(APPLICATION_DETACH, application_detach) \ 48 _(BIND_URI, bind_uri) \ 49 _(UNBIND_URI, unbind_uri) \ 50 _(CONNECT_URI, connect_uri) \ 51 _(DISCONNECT_SESSION, disconnect_session) \ 52 _(DISCONNECT_SESSION_REPLY, disconnect_session_reply) \ 53 _(BIND_SOCK, bind_sock) \ 54 _(UNBIND_SOCK, unbind_sock) \ 55 _(CONNECT_SOCK, connect_sock) \ 56 _(SESSION_ENABLE_DISABLE, session_enable_disable) \ 57 _(APP_NAMESPACE_ADD_DEL, app_namespace_add_del) \ 58 _(SESSION_RULE_ADD_DEL, session_rule_add_del) \ 59 _(SESSION_RULES_DUMP, session_rules_dump) \ 60 _(APPLICATION_TLS_CERT_ADD, application_tls_cert_add) \ 61 _(APPLICATION_TLS_KEY_ADD, application_tls_key_add) \ 62 _(APP_WORKER_ADD_DEL, app_worker_add_del) \ 95 clib_warning (
"no api registration for client: %u", api_client_index);
109 fd_flags |= SESSION_FD_F_MEMFD_SEGMENT;
116 mp->_vl_msg_id = clib_host_to_net_u16 (VL_API_MAP_ANOTHER_SEGMENT);
146 mp->_vl_msg_id = clib_host_to_net_u16 (VL_API_UNMAP_SEGMENT);
180 session_event_t *evt;
224 mp->
rmt.port = ct->c_rmt_port;
241 session_event_t *evt;
248 evt->event_type = evt_type;
267 for (i = 0; i < f->n_subscribers; i++)
311 session_event_t *evt;
361 mp->
lcl.port = cct->c_lcl_port;
362 mp->
lcl.is_ip4 = cct->c_is_ip4;
376 clib_host_to_net_u32 (VNET_API_ERROR_SESSION_CONNECT) : 0;
391 session_event_t *evt;
449 session_event_t *evt;
484 vl_api_session_enable_disable_reply_t *rmp;
509 rv = VNET_API_ERROR_FEATURE_DISABLED;
515 "Out of options, fix api message definition");
523 rv = VNET_API_ERROR_INVALID_VALUE;
545 fd_flags |= SESSION_FD_F_VPP_MQ_SEGMENT;
546 fds[n_fds] = evt_q_segment->
fd;
552 fd_flags |= SESSION_FD_F_MEMFD_SEGMENT;
553 fds[n_fds] = a->segment->fd;
558 fd_flags |= SESSION_FD_F_MQ_EVENTFD;
570 rmp->
app_index = clib_host_to_net_u32 (a->app_index);
597 u8 fd_flags = 0, ctrl_thread;
607 rv = VNET_API_ERROR_FEATURE_DISABLED;
613 "Out of options, fix api message definition");
621 rv = VNET_API_ERROR_INVALID_VALUE;
643 fd_flags |= SESSION_FD_F_VPP_MQ_SEGMENT;
644 fds[n_fds] = evt_q_segment->
fd;
650 fd_flags |= SESSION_FD_F_MEMFD_SEGMENT;
651 fds[n_fds] = a->segment->fd;
656 fd_flags |= SESSION_FD_F_MQ_EVENTFD;
669 rmp->
app_index = clib_host_to_net_u32 (a->app_index);
694 vl_api_application_detach_reply_t *rmp;
695 int rv = VNET_API_ERROR_INVALID_VALUE_2;
701 rv = VNET_API_ERROR_FEATURE_DISABLED;
721 vl_api_bind_uri_reply_t *rmp;
729 rv = VNET_API_ERROR_FEATURE_DISABLED;
737 a->uri = (
char *) mp->
uri;
743 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
762 vl_api_unbind_uri_reply_t *rmp;
769 rv = VNET_API_ERROR_FEATURE_DISABLED;
776 a->uri = (
char *) mp->
uri;
778 a->wrk_map_index = 0;
783 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
794 vl_api_connect_uri_reply_t *rmp;
801 rv = VNET_API_ERROR_FEATURE_DISABLED;
809 a->uri = (
char *) mp->
uri;
817 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
843 rv = VNET_API_ERROR_FEATURE_DISABLED;
856 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
900 vl_api_bind_sock_reply_t *rmp;
903 ip46_address_t *ip46;
908 rv = VNET_API_ERROR_FEATURE_DISABLED;
915 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
919 ip46 = (ip46_address_t *) mp->
ip;
921 a->sep.is_ip4 = mp->
is_ip4;
923 a->sep.port = mp->
port;
924 a->sep.fib_index = mp->
vrf;
926 a->sep.transport_proto = mp->
proto;
949 vl_api_unbind_sock_reply_t *rmp;
957 rv = VNET_API_ERROR_FEATURE_DISABLED;
972 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
992 vl_api_connect_sock_reply_t *rmp;
999 rv = VNET_API_ERROR_FEATURE_DISABLED;
1007 ip46_address_t *ip46 = (ip46_address_t *) mp->
ip;
1012 a->sep.is_ip4 = mp->
is_ip4;
1014 a->sep.port = mp->
port;
1015 a->sep.transport_proto = mp->
proto;
1016 a->sep.peer.fib_index = mp->
vrf;
1034 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
1063 rv = VNET_API_ERROR_FEATURE_DISABLED;
1074 rv = VNET_API_ERROR_INVALID_VALUE;
1080 .wrk_map_index = clib_net_to_host_u32 (mp->
wrk_index),
1097 fd_flags |= SESSION_FD_F_MEMFD_SEGMENT;
1098 fds[n_fds] = args.segment->fd;
1103 fd_flags |= SESSION_FD_F_MQ_EVENTFD;
1112 rmp->
wrk_index = clib_host_to_net_u32 (args.wrk_map_index);
1113 rmp->
segment_handle = clib_host_to_net_u64 (args.segment_handle);
1116 if (
vec_len (args.segment->name))
1119 vec_len (args.segment->name));
1137 u32 appns_index = 0;
1142 rv = VNET_API_ERROR_FEATURE_DISABLED;
1148 rv = VNET_API_ERROR_INVALID_VALUE;
1156 .secret = clib_net_to_host_u64 (mp->
secret),
1157 .sw_if_index = clib_net_to_host_u32 (mp->
sw_if_index),
1158 .ip4_fib_id = clib_net_to_host_u32 (mp->
ip4_fib_id),
1159 .ip6_fib_id = clib_net_to_host_u32 (mp->
ip6_fib_id),
1169 rv = VNET_API_ERROR_UNSPECIFIED;
1178 rmp->
appns_index = clib_host_to_net_u32 (appns_index);
1186 vl_api_session_rule_add_del_reply_t *rmp;
1195 table_args->lcl.fp_len = mp->
lcl_plen;
1196 table_args->lcl.fp_proto = fib_proto;
1197 table_args->rmt.fp_len = mp->
rmt_plen;
1198 table_args->rmt.fp_proto = fib_proto;
1199 table_args->lcl_port = mp->
lcl_port;
1200 table_args->rmt_port = mp->
rmt_port;
1201 table_args->action_index = clib_net_to_host_u32 (mp->
action_index);
1202 table_args->is_add = mp->
is_add;
1203 mp->
tag[
sizeof (mp->
tag) - 1] = 0;
1204 table_args->tag =
format (0,
"%s", mp->
tag);
1205 args.appns_index = clib_net_to_host_u32 (mp->
appns_index);
1206 args.scope = mp->
scope;
1209 clib_memset (&table_args->lcl.fp_addr, 0, sizeof (table_args->lcl.fp_addr));
1210 clib_memset (&table_args->rmt.fp_addr, 0, sizeof (table_args->rmt.fp_addr));
1222 u8 transport_proto,
u32 appns_index,
u8 * tag,
1226 session_mask_or_match_4_t *match =
1227 (session_mask_or_match_4_t *) & rule->match;
1228 session_mask_or_match_4_t *mask =
1229 (session_mask_or_match_4_t *) & rule->mask;
1233 rmp->_vl_msg_id = ntohs (VL_API_SESSION_RULES_DETAILS);
1243 rmp->
action_index = clib_host_to_net_u32 (rule->action_index);
1247 rmp->
appns_index = clib_host_to_net_u32 (appns_index);
1259 u8 transport_proto,
u32 appns_index,
u8 * tag,
1263 session_mask_or_match_6_t *match =
1264 (session_mask_or_match_6_t *) & rule->match;
1265 session_mask_or_match_6_t *mask =
1266 (session_mask_or_match_6_t *) & rule->mask;
1270 rmp->_vl_msg_id = ntohs (VL_API_SESSION_RULES_DETAILS);
1280 rmp->
action_index = clib_host_to_net_u32 (rule->action_index);
1284 rmp->
appns_index = clib_host_to_net_u32 (appns_index);
1296 u8 tp,
u8 is_local,
u32 appns_index,
1299 mma_rule_16_t *rule16;
1300 mma_rule_40_t *rule40;
1301 mma_rules_table_16_t *srt16;
1302 mma_rules_table_40_t *srt40;
1309 srt16 = &srt->session_rules_tables_16;
1311 ri = mma_rules_table_rule_index_16 (srt16, rule16);
1312 tag = session_rules_table_rule_tag (srt, ri, 1);
1313 send_session_rule_details4 (rule16, is_local, tp, appns_index, tag,
1322 srt40 = &srt->session_rules_tables_40;
1324 ri = mma_rules_table_rule_index_40 (srt40, rule40);
1325 tag = session_rules_table_rule_tag (srt, ri, 1);
1326 send_session_rule_details6 (rule40, is_local, tp, appns_index, tag,
1349 st->active_fib_proto, tp,
1350 st->is_local, st->appns_index, reg,
1369 rv = VNET_API_ERROR_FEATURE_DISABLED;
1374 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
1379 cert_len = clib_net_to_host_u16 (mp->
cert_len);
1380 if (cert_len > 10000)
1382 rv = VNET_API_ERROR_INVALID_VALUE;
1394 REPLY_MACRO (VL_API_APPLICATION_TLS_CERT_ADD_REPLY);
1409 rv = VNET_API_ERROR_FEATURE_DISABLED;
1414 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
1419 key_len = clib_net_to_host_u16 (mp->
key_len);
1420 if (key_len > 10000)
1422 rv = VNET_API_ERROR_INVALID_VALUE;
1434 REPLY_MACRO (VL_API_APPLICATION_TLS_KEY_ADD_REPLY);
1445 a->api_client_index = client_index;
1453 #define vl_msg_name_crc_list 1455 #undef vl_msg_name_crc_list 1460 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id); 1461 foreach_vl_msg_name_crc_session;
1478 vl_msg_api_set_handlers(VL_API_##N, #n, \ 1479 vl_api_##n##_t_handler, \ 1481 vl_api_##n##_t_endian, \ 1482 vl_api_##n##_t_print, \ 1483 sizeof(vl_api_##n##_t), 1);
#define vec_validate(V, I)
Make sure vector is long enough for given index (no header, unspecified alignment) ...
static void vl_api_disconnect_session_reply_t_handler(vl_api_disconnect_session_reply_t *mp)
struct _vnet_app_worker_add_del_args vnet_app_worker_add_del_args_t
#define ENDPOINT_INVALID_INDEX
#define APP_NAMESPACE_INVALID_INDEX
static clib_error_t * session_api_hookup(vlib_main_t *vm)
void * svm_msg_q_msg_data(svm_msg_q_t *mq, svm_msg_q_msg_t *msg)
Get data for message in queue.
session_type_t session_type
Type built from transport and network protocol types.
static int send_del_segment_callback(u32 api_client_index, u64 segment_handle)
void mq_send_unlisten_reply(app_worker_t *app_wrk, session_handle_t sh, u32 context, int rv)
static void mq_notify_close_subscribers(u32 app_index, session_handle_t sh, svm_fifo_t *f, session_evt_type_t evt_type)
VL_MSG_API_REAPER_FUNCTION(application_reaper_cb)
struct _session_rules_table_t session_rules_table_t
struct _vnet_connect_args vnet_connect_args_t
struct _vnet_unlisten_args_t vnet_unlisten_args_t
static void vl_api_app_namespace_add_del_t_handler(vl_api_app_namespace_add_del_t *mp)
int vnet_app_namespace_add_del(vnet_app_namespace_add_del_args_t *a)
static svm_msg_q_t * session_main_get_vpp_event_queue(u32 thread_index)
uword vpp_event_queue_address
void ip_set(ip46_address_t *dst, void *src, u8 is_ip4)
#define clib_memcpy_fast(a, b, c)
static void mq_send_session_close_evt(app_worker_t *app_wrk, session_handle_t sh, session_evt_type_t evt_type)
#define REPLY_MACRO2(t, body)
clib_memset(h->entries, 0, sizeof(h->entries[0]) *entries)
transport_connection_t * session_get_transport(session_t *s)
svm_fifo_t * rx_fifo
Pointers to rx/tx buffers.
static void vl_api_send_msg(vl_api_registration_t *rp, u8 *elem)
u8 * message_bounce
Don't automatically free message buffer vetor.
fifo_segment_t * segment_manager_get_segment_w_handle(u64 segment_handle)
static session_t * listen_session_get_from_handle(session_handle_t handle)
static void vl_api_map_another_segment_reply_t_handler(vl_api_map_another_segment_reply_t *mp)
Bind to an ip:port pair for a given transport protocol WILL BE DEPRECATED POST 20.01
static int svm_msg_q_get_producer_eventfd(svm_msg_q_t *mq)
static transport_proto_t session_get_transport_proto(session_t *s)
struct _vnet_app_namespace_add_del_args vnet_app_namespace_add_del_args_t
application_t * application_lookup(u32 api_client_index)
Request for map server summary status.
static void vl_api_unbind_sock_t_handler(vl_api_unbind_sock_t *mp)
int vnet_unlisten(vnet_unlisten_args_t *a)
#define foreach_session_api_msg
struct _vnet_application_add_tls_cert_args_t vnet_app_add_tls_cert_args_t
void * vl_msg_api_alloc(int nbytes)
u64 app_event_queue_address
clib_error_t * vnet_app_add_tls_cert(vnet_app_add_tls_cert_args_t *a)
app_worker_t * application_get_worker(application_t *app, u32 wrk_map_index)
application_t * application_get_if_valid(u32 app_index)
struct _vnet_bind_args_t vnet_listen_args_t
segment_manager_props_t * application_segment_manager_properties(application_t *app)
static session_handle_t session_handle(session_t *s)
struct _svm_fifo svm_fifo_t
void session_get_endpoint(session_t *s, transport_endpoint_t *tep, u8 is_lcl)
int svm_msg_q_lock_and_alloc_msg_w_ring(svm_msg_q_t *mq, u32 ring_index, u8 noblock, svm_msg_q_msg_t *msg)
Lock message queue and allocate message buffer on ring.
Reply for app worker add/del.
int application_is_proxy(application_t *app)
static void vl_api_connect_uri_t_handler(vl_api_connect_uri_t *mp)
static void mq_send_session_reset_cb(session_t *s)
static void vl_api_session_enable_disable_t_handler(vl_api_session_enable_disable_t *mp)
#define pool_foreach(VAR, POOL, BODY)
Iterate through pool.
struct _vnet_disconnect_args_t vnet_disconnect_args_t
Application attach reply.
u32 session_index
global listening session index
vl_api_registration_t * vl_mem_api_client_index_to_registration(u32 handle)
add/del application namespace
static void vl_api_application_tls_cert_add_t_handler(vl_api_application_tls_cert_add_t *mp)
static void send_session_rule_details4(mma_rule_16_t *rule, u8 is_local, u8 transport_proto, u32 appns_index, u8 *tag, vl_api_registration_t *reg, u32 context)
u32 app_namespace_index_from_id(const u8 *ns_id)
void vl_msg_api_send_shmem(svm_queue_t *q, u8 *elem)
struct _vnet_app_attach_args_t vnet_app_attach_args_t
static void vl_api_app_worker_add_del_t_handler(vl_api_app_worker_add_del_t *mp)
vpp->client unmap shared memory segment
static void vl_api_session_rules_dump_t_handler(vl_api_one_map_server_dump_t *mp)
clib_error_t * vnet_app_add_tls_key(vnet_app_add_tls_key_args_t *a)
Unbind WILL BE DEPRECATED POST 20.01 ###s
session_t * app_listener_get_local_session(app_listener_t *al)
#define VL_API_INVALID_FI
svm_queue_t * vl_input_queue
shared memory only: pointer to client input queue
session_t * app_listener_get_session(app_listener_t *al)
struct _session_rule_add_del_args session_rule_add_del_args_t
client->vpp, attach application to session layer WILL BE DEPRECATED POST 20.01
u8 hostname[hostname_len]
static void vl_api_disconnect_session_t_handler(vl_api_disconnect_session_t *mp)
static int session_send_fds(vl_api_registration_t *reg, int fds[], int n_fds)
int vnet_session_rule_add_del(session_rule_add_del_args_t *args)
static clib_error_t * application_reaper_cb(u32 client_index)
Unbind a given URI WILL BE DEPRECATED POST 20.01
u32 wrk_index
Worker index in global worker pool.
#define SESSION_INVALID_INDEX
static u8 * format_vnet_api_errno(u8 *s, va_list *args)
uword vpp_event_queue_address
u64 session_segment_handle(session_t *s)
clib_error_t * vnet_session_enable_disable(vlib_main_t *vm, u8 is_en)
session_handle_t app_listen_session_handle(session_t *ls)
Get app listener handle for listening session.
static u64 listen_session_get_handle(session_t *s)
u32 ip6_mask_to_preflen(ip6_address_t *mask)
API main structure, used by both vpp and binary API clients.
int vnet_application_attach(vnet_app_attach_args_t *a)
Attach application to vpp.
static int mq_try_lock_and_alloc_msg(svm_msg_q_t *app_mq, svm_msg_q_msg_t *msg)
An API client registration, only in vpp/vlib.
ssvm_private_t ssvm
ssvm segment data
session_handle_t listener_handle
Parent listener session index if the result of an accept.
session_t * app_worker_first_listener(app_worker_t *app, u8 fib_proto, u8 transport_proto)
svm_queue_t * vl_api_client_index_to_input_queue(u32 index)
#define vec_free(V)
Free vector's memory (no header).
#define clib_warning(format, args...)
struct _stream_session_cb_vft session_cb_vft_t
struct _transport_connection transport_connection_t
static void mq_send_session_disconnected_cb(session_t *s)
u32 ip4_mask_to_preflen(ip4_address_t *mask)
static void send_session_rules_table_details(session_rules_table_t *srt, u8 fib_proto, u8 tp, u8 is_local, u32 appns_index, vl_api_registration_t *reg, u32 context)
static vl_api_registration_t * vl_api_client_index_to_registration(u32 index)
Application attach reply WILL BE DEPRECATED POST 20.01
static clib_error_t * vl_api_send_fd_msg(vl_api_registration_t *reg, int fds[], int n_fds)
static u32 vl_api_registration_file_index(vl_api_registration_t *reg)
application_t * application_get(u32 app_index)
int vnet_unbind_uri(vnet_unlisten_args_t *a)
static void send_session_rule_details6(mma_rule_40_t *rule, u8 is_local, u8 transport_proto, u32 appns_index, u8 *tag, vl_api_registration_t *reg, u32 context)
app_listener_t * app_listener_get_w_handle(session_handle_t handle)
Get app listener for listener session handle.
void svm_msg_q_add_and_unlock(svm_msg_q_t *mq, svm_msg_q_msg_t *msg)
Producer enqueue one message to queue with mutex held.
enable/disable session layer
static void vl_api_connect_sock_t_handler(vl_api_connect_sock_t *mp)
session_t * ct_session_get_peer(session_t *s)
Reply for app namespace add/del.
u64 app_event_queue_address
client->vpp, attach application to session layer WILL BE DEPRECATED POST 20.01
int vnet_listen(vnet_listen_args_t *a)
static fib_protocol_t session_get_fib_proto(session_t *s)
static void mq_send_session_migrate_cb(session_t *s, session_handle_t new_sh)
int vnet_application_detach(vnet_app_detach_args_t *a)
Detach application from vpp.
struct _vnet_application_add_tls_key_args_t vnet_app_add_tls_key_args_t
static void vl_api_bind_sock_t_handler(vl_api_bind_sock_t *mp)
vpp->client, please map an additional shared memory segment
#define clib_error_report(e)
static int mq_send_session_accepted_cb(session_t *s)
static void vl_api_app_attach_t_handler(vl_api_app_attach_t *mp)
struct _vnet_app_detach_args_t vnet_app_detach_args_t
static uword pointer_to_uword(const void *p)
int vnet_connect(vnet_connect_args_t *a)
Connect to a remote peer WILL BE DEPRECATED POST 20.01
static vlib_main_t * vlib_get_main(void)
u8 thread_index
Index of the thread that allocated the session.
static void vl_api_application_attach_t_handler(vl_api_application_attach_t *mp)
static void setup_message_id_table(api_main_t *am)
u32 app_index
App index in app pool.
static u8 session_type_is_ip4(session_type_t st)
bidirectional disconnect API WILL BE DEPRECATED POST 20.01
static session_cb_vft_t session_mq_cb_vft
add/del application worker
app_worker_t * app_worker_get(u32 wrk_index)
#define vec_len(v)
Number of elements in vector (rvalue-only, NULL tolerant)
Bind to a given URI WILL BE DEPRECATED POST 20.01
#define STATIC_ASSERT(truth,...)
static void vl_api_application_tls_key_add_t_handler(vl_api_application_tls_key_add_t *mp)
int vnet_bind_uri(vnet_listen_args_t *a)
ssvm_private_t * session_main_get_evt_q_segment(void)
#define clib_error_get_code(err)
int vnet_disconnect_session(vnet_disconnect_args_t *a)
VLIB_API_INIT_FUNCTION(session_api_hookup)
struct _session_lookup_table session_table_t
int vnet_app_worker_add_del(vnet_app_worker_add_del_args_t *a)
struct _svm_queue svm_queue_t
void * vl_mem_api_alloc_as_if_client_w_reg(vl_api_registration_t *reg, int nbytes)
static void vl_api_application_detach_t_handler(vl_api_application_detach_t *mp)
static u8 session_has_transport(session_t *s)
struct _session_rules_table_add_del_args session_rule_table_add_del_args_t
u32 app_index
Index of owning app.
static u8 svm_fifo_n_subscribers(svm_fifo_t *f)
#define session_table_foreach(VAR, BODY)
Application add TLS certificate.
static u32 vlib_num_workers()
static int send_add_segment_callback(u32 api_client_index, u64 segment_handle)
u32 app_wrk_index
Index of the app worker that owns the session.
Connect to a given URI WILL BE DEPRECATED POST 20.01
static void vl_api_session_rule_add_del_t_handler(vl_api_session_rule_add_del_t *mp)
bidirectional disconnect reply API WILL BE DEPRECATED POST 20.01
u32 api_client_index
API index for the worker.
int mq_send_session_bound_cb(u32 app_wrk_index, u32 api_context, session_handle_t handle, int rv)
int vnet_connect_uri(vnet_connect_args_t *a)
svm_msg_q_t * event_queue
Application listens for events on this svm queue.
static transport_service_type_t session_transport_service_type(session_t *s)
Application attach to session layer.
static void vl_api_bind_uri_t_handler(vl_api_bind_uri_t *mp)
int mq_send_session_connected_cb(u32 app_wrk_index, u32 api_context, session_t *s, u8 is_fail)
non-blocking call - works with both condvar and eventfd signaling
static u8 session_main_is_enabled()
static void vl_api_unbind_uri_t_handler(vl_api_unbind_uri_t *mp)
ssvm_segment_type_t ssvm_type(const ssvm_private_t *ssvm)