From b4e5e50fe898bf905aa7087e17740394b97e5cf9 Mon Sep 17 00:00:00 2001 From: Jakub Grajciar Date: Fri, 31 Jan 2020 09:35:29 +0100 Subject: session: API cleanup Use consistent API types. Type: fix Signed-off-by: Jakub Grajciar Change-Id: Ib752a3425c076eb53bc5255a48039cbb74b1fcce Signed-off-by: Jakub Grajciar --- src/vnet/session/session.api | 121 ++++++++++++++-------------- src/vnet/session/session_api.c | 173 ++++++++++++++++++++++------------------- 2 files changed, 153 insertions(+), 141 deletions(-) (limited to 'src/vnet') diff --git a/src/vnet/session/session.api b/src/vnet/session/session.api index 8cfac3d048d..4ff6367fa27 100644 --- a/src/vnet/session/session.api +++ b/src/vnet/session/session.api @@ -13,7 +13,22 @@ * limitations under the License. */ -option version = "1.7.0"; +option version = "2.0.0"; + +import "vnet/interface_types.api"; +import "vnet/ip/ip_types.api"; + + +enum transport_proto : u8 +{ + TRANSPORT_PROTO_API_TCP, + TRANSPORT_PROTO_API_UDP, + TRANSPORT_PROTO_API_SCTP, + TRANSPORT_PROTO_API_NONE, + TRANSPORT_PROTO_API_TLS, + TRANSPORT_PROTO_API_UDPC, + TRANSPORT_PROTO_API_QUIC, +}; /** \brief client->vpp, attach application to session layer ### WILL BE DEPRECATED POST 20.01 ### @@ -22,16 +37,14 @@ option version = "1.7.0"; @param initial_segment_size - size of the initial shm segment to be allocated @param options - segment size, fifo sizes, etc. - @param namespace_id_len - length of the namespace id c-string - @param namespace_id - 0 terminted c-string + @param namespace_id - string */ define application_attach { u32 client_index; u32 context; u32 initial_segment_size; u64 options[17]; - u8 namespace_id_len; - u8 namespace_id [64]; + string namespace_id[]; }; /** \brief Application attach reply @@ -44,10 +57,9 @@ option version = "1.7.0"; @param fd_flags - set of flags that indicate which fds are to be expected over the socket (set only if socket transport available) @param segment_size - size of first shm segment - @param segment_name_length - length of segment name - @param segment_name - name of segment client needs to attach to @param app_index - index of the newly created app @param segment_handle - handle for segment + @param segment_name - name of segment client needs to attach to */ define application_attach_reply { u32 context; @@ -56,25 +68,22 @@ define application_attach_reply { u8 n_fds; u8 fd_flags; u32 segment_size; - u8 segment_name_length; - u8 segment_name[128]; u32 app_index; u64 segment_handle; + string segment_name[]; }; /** \brief Application attach to session layer @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request @param options - segment size, fifo sizes, etc. - @param namespace_id_len - length of the namespace id c-string - @param namespace_id - 0 terminted c-string + @param namespace_id - string */ define app_attach { u32 client_index; u32 context; u64 options[17]; - u8 namespace_id_len; - u8 namespace_id[64]; + string namespace_id[]; }; /** \brief Application attach reply @@ -89,9 +98,8 @@ define application_attach_reply { @param fd_flags - set of flags that indicate which fds are to be expected over the socket (set only if socket transport available) @param segment_size - size of first shm segment - @param segment_name_length - length of segment name - @param segment_name - name of segment client needs to attach to @param segment_handle - handle for segment + @param segment_name - name of segment client needs to attach to */ define app_attach_reply { u32 context; @@ -103,9 +111,8 @@ define app_attach_reply { u8 n_fds; u8 fd_flags; u32 segment_size; - u8 segment_name_length; - u8 segment_name[128]; u64 segment_handle; + string segment_name[]; }; /** \brief Add certificate and key @@ -202,7 +209,7 @@ autoreply define map_another_segment { u32 context; u8 fd_flags; u32 segment_size; - u8 segment_name[128]; + string segment_name[128]; u64 segment_handle; }; @@ -301,7 +308,6 @@ define disconnect_session_reply { @param context - sender context, to match reply w/ request @param wrk_index - index of worker requesting the bind @param vrf - bind namespace - @param is_ip4 - flag that is 1 if ip address family is IPv4 @param ip - ip address @param port - port @param proto - protocol 0 - TCP 1 - UDP @@ -312,10 +318,9 @@ autoreply define bind_sock { u32 context; u32 wrk_index; u32 vrf; - u8 is_ip4; - u8 ip[16]; + vl_api_address_t ip; u16 port; - u8 proto; + vl_api_transport_proto_t proto; u64 options[16]; }; @@ -342,7 +347,6 @@ autoreply define unbind_sock { used to perform redirects @param options - socket options, fifo sizes, etc. when doing redirects @param vrf - connection namespace - @param is_ip4 - flag that is 1 if ip address family is IPv4 @param ip - ip address @param port - port @param proto - protocol 0 - TCP 1 - UDP @@ -358,13 +362,11 @@ autoreply define connect_sock { u64 client_queue_address; u64 options[16]; u32 vrf; - u8 is_ip4; - u8 ip[16]; + vl_api_address_t ip; u16 port; - u8 proto; + vl_api_transport_proto_t proto; u64 parent_handle; - u8 hostname_len; - u8 hostname[hostname_len]; + string hostname[]; }; /** \brief ask app to add a new cut-through registration @@ -404,7 +406,7 @@ define app_worker_add_del u32 context; u32 app_index; u32 wrk_index; - u8 is_add; + bool is_add [default=true]; }; /** \brief Reply for app worker add/del @@ -415,9 +417,9 @@ define app_worker_add_del @param n_fds - number of fds exchanged @param fd_flags - set of flags that indicate which fds are to be expected over the socket (set only if socket transport available) - @param segment_name_length - length of segment name - @param segment_name - name of segment client needs to attach to @param segment_handle - handle for segment + @param is_add - add if non zero, else delete + @param segment_name - name of segment client needs to attach to */ define app_worker_add_del_reply { @@ -427,10 +429,9 @@ define app_worker_add_del_reply u64 app_event_queue_address; u8 n_fds; u8 fd_flags; - u8 segment_name_length; - u8 segment_name[128]; u64 segment_handle; - u8 is_add; + bool is_add [default=true]; + string segment_name[]; }; /** \brief enable/disable session layer @@ -442,7 +443,7 @@ define app_worker_add_del_reply autoreply define session_enable_disable { u32 client_index; u32 context; - u8 is_enable; + bool is_enable [default=true]; }; /** \brief add/del application namespace @@ -456,18 +457,16 @@ autoreply define session_enable_disable { if sw_if_index set. @param ip6_fib_id - id of ip6 fib that "supports" the namespace. Ignored if sw_if_index set. - @param namespace_id_len - length of namespace id lower @param namespace_id - namespace id */ define app_namespace_add_del { u32 client_index; u32 context; u64 secret; - u32 sw_if_index; + vl_api_interface_index_t sw_if_index; u32 ip4_fib_id; u32 ip6_fib_id; - u8 namespace_id_len; - u8 namespace_id[64]; + string namespace_id[]; }; /** \brief Reply for app namespace add/del @@ -482,11 +481,17 @@ define app_namespace_add_del_reply u32 appns_index; }; +enum session_rule_scope { + SESSION_RULE_SCOPE_API_GLOBAL = 0, + SESSION_RULE_SCOPE_API_LOCAL = 1, + SESSION_RULE_SCOPE_API_BOTH = 2, +}; + /** \brief add/del session rule @param client_index - opaque cookie to identify the sender client to vpp direction only @param context - sender context, to match reply w/ request - @param transport_proto - transport protocol (0 - tcp 1 - udp) + @param transport_proto - transport protocol @param is_ip4 - flag to indicate if ip addresses are ip4 or 6 @param lcl_ip - local ip @param lcl_plen - local prefix length @@ -498,25 +503,23 @@ define app_namespace_add_del_reply application with index action_index @param is_add - flag to indicate if add or del @param appns_index - application namespace where rule is to be applied to - @param scope - flag that indicates scope of the rule: global or local. + @param scope - enum that indicates scope of the rule: global or local. If 0, default is global, 1 is global 2 is local, 3 is both + @param tag - tag */ autoreply define session_rule_add_del { u32 client_index; u32 context; - u8 transport_proto; - u8 is_ip4; - u8 lcl_ip[16]; - u8 lcl_plen; - u8 rmt_ip[16]; - u8 rmt_plen; + vl_api_transport_proto_t transport_proto; + vl_api_prefix_t lcl; + vl_api_prefix_t rmt; u16 lcl_port; u16 rmt_port; u32 action_index; - u8 is_add; + bool is_add [default=true]; u32 appns_index; - u8 scope; - u8 tag[64]; + vl_api_session_rule_scope_t scope; + string tag[64]; }; /** \brief Dump session rules @@ -531,7 +534,7 @@ define session_rules_dump /** \brief Session rules details @param context - sender context, to match reply w/ request - @param transport_proto - transport protocol (0 - tcp 1 - udp) + @param transport_proto - transport protocol @param is_ip4 - flag to indicate if ip addresses are ip4 or 6 @param lcl_ip - local ip @param lcl_plen - local prefix length @@ -542,24 +545,22 @@ define session_rules_dump @param action_index - the only action defined now is forward to application with index action_index @param appns_index - application namespace where rule is to be applied to - @param scope - flag that indicates scope of the rule: global or local. + @param scope - enum that indicates scope of the rule: global or local. If 0, default is global, 1 is global 2 is local, 3 is both + @param tag - tag */ define session_rules_details { u32 context; - u8 transport_proto; - u8 is_ip4; - u8 lcl_ip[16]; - u8 lcl_plen; - u8 rmt_ip[16]; - u8 rmt_plen; + vl_api_transport_proto_t transport_proto; + vl_api_prefix_t lcl; + vl_api_prefix_t rmt; u16 lcl_port; u16 rmt_port; u32 action_index; u32 appns_index; - u8 scope; - u8 tag[64]; + vl_api_session_rule_scope_t scope; + string tag[64]; }; /* diff --git a/src/vnet/session/session_api.c b/src/vnet/session/session_api.c index a95faada9ae..eb5b2c36f99 100644 --- a/src/vnet/session/session_api.c +++ b/src/vnet/session/session_api.c @@ -22,6 +22,8 @@ #include #include +#include + #include #define vl_typedefs /* define message structures */ @@ -63,6 +65,50 @@ _(APP_ADD_CERT_KEY_PAIR, app_add_cert_key_pair) \ _(APP_DEL_CERT_KEY_PAIR, app_del_cert_key_pair) \ _(APP_WORKER_ADD_DEL, app_worker_add_del) \ +static transport_proto_t +api_session_transport_proto_decode (const vl_api_transport_proto_t * api_tp) +{ + switch (*api_tp) + { + case TRANSPORT_PROTO_API_TCP: + return TRANSPORT_PROTO_TCP; + case TRANSPORT_PROTO_API_UDP: + return TRANSPORT_PROTO_UDP; + case TRANSPORT_PROTO_API_SCTP: + return TRANSPORT_PROTO_SCTP; + case TRANSPORT_PROTO_API_TLS: + return TRANSPORT_PROTO_TLS; + case TRANSPORT_PROTO_API_UDPC: + return TRANSPORT_PROTO_UDPC; + case TRANSPORT_PROTO_API_QUIC: + return TRANSPORT_PROTO_QUIC; + default: + return TRANSPORT_PROTO_NONE; + } +} + +static vl_api_transport_proto_t +api_session_transport_proto_encode (const transport_proto_t tp) +{ + switch (tp) + { + case TRANSPORT_PROTO_TCP: + return TRANSPORT_PROTO_API_TCP; + case TRANSPORT_PROTO_UDP: + return TRANSPORT_PROTO_API_UDP; + case TRANSPORT_PROTO_SCTP: + return TRANSPORT_PROTO_API_SCTP; + case TRANSPORT_PROTO_TLS: + return TRANSPORT_PROTO_API_TLS; + case TRANSPORT_PROTO_UDPC: + return TRANSPORT_PROTO_API_UDPC; + case TRANSPORT_PROTO_QUIC: + return TRANSPORT_PROTO_API_QUIC; + default: + return TRANSPORT_PROTO_API_NONE; + } +} + static int session_send_fds (vl_api_registration_t * reg, int fds[], int n_fds) { @@ -680,18 +726,8 @@ vl_api_application_attach_t_handler (vl_api_application_attach_t * mp) a->api_client_index = mp->client_index; a->options = mp->options; a->session_cb_vft = &session_mq_cb_vft_old; - if (mp->namespace_id_len > 64) - { - rv = VNET_API_ERROR_INVALID_VALUE; - goto done; - } - - if (mp->namespace_id_len) - { - vec_validate (a->namespace_id, mp->namespace_id_len - 1); - clib_memcpy_fast (a->namespace_id, mp->namespace_id, - mp->namespace_id_len); - } + a->namespace_id = + (u8 *) vl_api_from_api_to_new_c_string (&mp->namespace_id); if ((rv = vnet_application_attach (a))) { @@ -730,13 +766,8 @@ done: { segp = a->segment; rmp->app_index = clib_host_to_net_u32 (a->app_index); - rmp->segment_name_length = 0; + vl_api_vec_to_api_string (segp->name, &rmp->segment_name); rmp->segment_size = segp->ssvm_size; - if (vec_len (segp->name)) - { - memcpy (rmp->segment_name, segp->name, vec_len (segp->name)); - rmp->segment_name_length = vec_len (segp->name); - } rmp->app_event_queue_address = pointer_to_uword (a->app_evt_q); rmp->n_fds = n_fds; rmp->fd_flags = fd_flags; @@ -778,18 +809,8 @@ vl_api_app_attach_t_handler (vl_api_app_attach_t * mp) a->api_client_index = mp->client_index; a->options = mp->options; a->session_cb_vft = &session_mq_cb_vft; - if (mp->namespace_id_len > 64) - { - rv = VNET_API_ERROR_INVALID_VALUE; - goto done; - } - if (mp->namespace_id_len) - { - vec_validate (a->namespace_id, mp->namespace_id_len - 1); - clib_memcpy_fast (a->namespace_id, mp->namespace_id, - mp->namespace_id_len); - } + a->namespace_id = vl_api_from_api_to_new_vec (&mp->namespace_id); if ((rv = vnet_application_attach (a))) { @@ -836,8 +857,7 @@ done: rmp->fd_flags = fd_flags; if (vec_len (segp->name)) { - memcpy (rmp->segment_name, segp->name, vec_len (segp->name)); - rmp->segment_name_length = vec_len (segp->name); + vl_api_vec_to_api_string (segp->name, &rmp->segment_name); } rmp->segment_size = segp->ssvm_size; rmp->segment_handle = clib_host_to_net_u64 (a->segment_handle); @@ -1063,7 +1083,6 @@ vl_api_bind_sock_t_handler (vl_api_bind_sock_t * mp) vl_api_bind_sock_reply_t *rmp; application_t *app = 0; app_worker_t *app_wrk; - ip46_address_t *ip46; int rv = 0; if (session_main_is_enabled () == 0) @@ -1079,14 +1098,13 @@ vl_api_bind_sock_t_handler (vl_api_bind_sock_t * mp) goto done; } - ip46 = (ip46_address_t *) mp->ip; clib_memset (a, 0, sizeof (*a)); - a->sep.is_ip4 = mp->is_ip4; - a->sep.ip = *ip46; + ip_address_decode (&mp->ip, &a->sep.ip); + a->sep.is_ip4 = ip46_address_is_ip4 (&a->sep.ip); a->sep.port = mp->port; a->sep.fib_index = mp->vrf; a->sep.sw_if_index = ENDPOINT_INVALID_INDEX; - a->sep.transport_proto = mp->proto; + a->sep.transport_proto = api_session_transport_proto_decode (&mp->proto); a->app_index = app->app_index; a->wrk_map_index = mp->wrk_index; @@ -1167,24 +1185,20 @@ vl_api_connect_sock_t_handler (vl_api_connect_sock_t * mp) if (app) { svm_queue_t *client_q; - ip46_address_t *ip46 = (ip46_address_t *) mp->ip; clib_memset (a, 0, sizeof (*a)); client_q = vl_api_client_index_to_input_queue (mp->client_index); mp->client_queue_address = pointer_to_uword (client_q); - a->sep.is_ip4 = mp->is_ip4; - a->sep.ip = *ip46; + ip_address_decode (&mp->ip, &a->sep.ip); + a->sep.is_ip4 = ip46_address_is_ip4 (&a->sep.ip); a->sep.port = mp->port; - a->sep.transport_proto = mp->proto; + a->sep.transport_proto = + api_session_transport_proto_decode (&mp->proto); a->sep.peer.fib_index = mp->vrf; a->sep.peer.sw_if_index = ENDPOINT_INVALID_INDEX; a->sep_ext.parent_handle = mp->parent_handle; - if (mp->hostname_len) - { - vec_validate (a->sep_ext.hostname, mp->hostname_len - 1); - clib_memcpy_fast (a->sep_ext.hostname, mp->hostname, - mp->hostname_len); - } + a->sep_ext.hostname = + (u8 *) vl_api_from_api_to_new_c_string (&mp->hostname); a->api_context = mp->context; a->app_index = app->app_index; a->wrk_map_index = mp->wrk_index; @@ -1278,9 +1292,7 @@ done: { if (vec_len (args.segment->name)) { - memcpy (rmp->segment_name, args.segment->name, - vec_len (args.segment->name)); - rmp->segment_name_length = vec_len (args.segment->name); + vl_api_vec_to_api_string (args.segment->name, &rmp->segment_name); } rmp->app_event_queue_address = pointer_to_uword (args.evt_q); rmp->n_fds = n_fds; @@ -1306,14 +1318,8 @@ vl_api_app_namespace_add_del_t_handler (vl_api_app_namespace_add_del_t * mp) goto done; } - if (mp->namespace_id_len > ARRAY_LEN (mp->namespace_id)) - { - rv = VNET_API_ERROR_INVALID_VALUE; - goto done; - } + ns_id = vl_api_from_api_to_new_vec (&mp->namespace_id); - vec_validate (ns_id, mp->namespace_id_len - 1); - clib_memcpy_fast (ns_id, mp->namespace_id, mp->namespace_id_len); vnet_app_namespace_add_del_args_t args = { .ns_id = ns_id, .secret = clib_net_to_host_u64 (mp->secret), @@ -1349,16 +1355,13 @@ vl_api_session_rule_add_del_t_handler (vl_api_session_rule_add_del_t * mp) vl_api_session_rule_add_del_reply_t *rmp; session_rule_add_del_args_t args; session_rule_table_add_del_args_t *table_args = &args.table_args; - u8 fib_proto; int rv = 0; clib_memset (&args, 0, sizeof (args)); - fib_proto = mp->is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6; - table_args->lcl.fp_len = mp->lcl_plen; - table_args->lcl.fp_proto = fib_proto; - table_args->rmt.fp_len = mp->rmt_plen; - table_args->rmt.fp_proto = fib_proto; + ip_prefix_decode (&mp->lcl, &table_args->lcl); + ip_prefix_decode (&mp->rmt, &table_args->rmt); + table_args->lcl_port = mp->lcl_port; table_args->rmt_port = mp->rmt_port; table_args->action_index = clib_net_to_host_u32 (mp->action_index); @@ -1367,12 +1370,10 @@ vl_api_session_rule_add_del_t_handler (vl_api_session_rule_add_del_t * mp) table_args->tag = format (0, "%s", mp->tag); args.appns_index = clib_net_to_host_u32 (mp->appns_index); args.scope = mp->scope; - args.transport_proto = mp->transport_proto; + args.transport_proto = + api_session_transport_proto_decode (&mp->transport_proto) == + TRANSPORT_PROTO_UDP ? 1 : 0; - clib_memset (&table_args->lcl.fp_addr, 0, sizeof (table_args->lcl.fp_addr)); - clib_memset (&table_args->rmt.fp_addr, 0, sizeof (table_args->rmt.fp_addr)); - ip_set (&table_args->lcl.fp_addr, mp->lcl_ip, mp->is_ip4); - ip_set (&table_args->rmt.fp_addr, mp->rmt_ip, mp->is_ip4); rv = vnet_session_rule_add_del (&args); if (rv) clib_warning ("rule add del returned: %d", rv); @@ -1390,23 +1391,28 @@ send_session_rule_details4 (mma_rule_16_t * rule, u8 is_local, (session_mask_or_match_4_t *) & rule->match; session_mask_or_match_4_t *mask = (session_mask_or_match_4_t *) & rule->mask; + fib_prefix_t lcl, rmt; rmp = vl_msg_api_alloc (sizeof (*rmp)); clib_memset (rmp, 0, sizeof (*rmp)); rmp->_vl_msg_id = ntohs (VL_API_SESSION_RULES_DETAILS); rmp->context = context; - rmp->is_ip4 = 1; - clib_memcpy_fast (rmp->lcl_ip, &match->lcl_ip, sizeof (match->lcl_ip)); - clib_memcpy_fast (rmp->rmt_ip, &match->rmt_ip, sizeof (match->rmt_ip)); - rmp->lcl_plen = ip4_mask_to_preflen (&mask->lcl_ip); - rmp->rmt_plen = ip4_mask_to_preflen (&mask->rmt_ip); + clib_memset (&lcl, 0, sizeof (lcl)); + clib_memset (&rmt, 0, sizeof (rmt)); + ip_set (&lcl.fp_addr, &match->lcl_ip, 1); + ip_set (&rmt.fp_addr, &match->rmt_ip, 1); + lcl.fp_len = ip4_mask_to_preflen (&mask->lcl_ip); + rmt.fp_len = ip4_mask_to_preflen (&mask->rmt_ip); + + ip_prefix_encode (&lcl, &rmp->lcl); + ip_prefix_encode (&rmt, &rmp->rmt); rmp->lcl_port = match->lcl_port; rmp->rmt_port = match->rmt_port; rmp->action_index = clib_host_to_net_u32 (rule->action_index); rmp->scope = - is_local ? SESSION_RULE_SCOPE_LOCAL : SESSION_RULE_SCOPE_GLOBAL; - rmp->transport_proto = transport_proto; + is_local ? SESSION_RULE_SCOPE_API_LOCAL : SESSION_RULE_SCOPE_API_GLOBAL; + rmp->transport_proto = api_session_transport_proto_encode (transport_proto); rmp->appns_index = clib_host_to_net_u32 (appns_index); if (tag) { @@ -1427,23 +1433,28 @@ send_session_rule_details6 (mma_rule_40_t * rule, u8 is_local, (session_mask_or_match_6_t *) & rule->match; session_mask_or_match_6_t *mask = (session_mask_or_match_6_t *) & rule->mask; + fib_prefix_t lcl, rmt; rmp = vl_msg_api_alloc (sizeof (*rmp)); clib_memset (rmp, 0, sizeof (*rmp)); rmp->_vl_msg_id = ntohs (VL_API_SESSION_RULES_DETAILS); rmp->context = context; - rmp->is_ip4 = 0; - clib_memcpy_fast (rmp->lcl_ip, &match->lcl_ip, sizeof (match->lcl_ip)); - clib_memcpy_fast (rmp->rmt_ip, &match->rmt_ip, sizeof (match->rmt_ip)); - rmp->lcl_plen = ip6_mask_to_preflen (&mask->lcl_ip); - rmp->rmt_plen = ip6_mask_to_preflen (&mask->rmt_ip); + clib_memset (&lcl, 0, sizeof (lcl)); + clib_memset (&rmt, 0, sizeof (rmt)); + ip_set (&lcl.fp_addr, &match->lcl_ip, 0); + ip_set (&rmt.fp_addr, &match->rmt_ip, 0); + lcl.fp_len = ip6_mask_to_preflen (&mask->lcl_ip); + rmt.fp_len = ip6_mask_to_preflen (&mask->rmt_ip); + + ip_prefix_encode (&lcl, &rmp->lcl); + ip_prefix_encode (&rmt, &rmp->rmt); rmp->lcl_port = match->lcl_port; rmp->rmt_port = match->rmt_port; rmp->action_index = clib_host_to_net_u32 (rule->action_index); rmp->scope = - is_local ? SESSION_RULE_SCOPE_LOCAL : SESSION_RULE_SCOPE_GLOBAL; - rmp->transport_proto = transport_proto; + is_local ? SESSION_RULE_SCOPE_API_LOCAL : SESSION_RULE_SCOPE_API_GLOBAL; + rmp->transport_proto = api_session_transport_proto_encode (transport_proto); rmp->appns_index = clib_host_to_net_u32 (appns_index); if (tag) { -- cgit 1.2.3-korg