X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=src%2Fvnet%2Fsession%2Fsession.api;h=905ab5630d934bb07d2dda37e246ee00ea670703;hb=07063b8ea;hp=53d05dfe426b36c9e883b2e51d608811908caf37;hpb=ba65ca496af5766932a762bb99a758dbfcb580ec;p=vpp.git diff --git a/src/vnet/session/session.api b/src/vnet/session/session.api index 53d05dfe426..905ab5630d9 100644 --- a/src/vnet/session/session.api +++ b/src/vnet/session/session.api @@ -13,39 +13,52 @@ * limitations under the License. */ -option version = "1.6.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_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 ### @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request - @param initial_segment_size - size of the initial shm segment to be + @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[16]; - u8 namespace_id_len; - u8 namespace_id [64]; + u64 options[17]; + string namespace_id[]; }; - + /** \brief Application attach reply + ### WILL BE DEPRECATED POST 20.01 ### @param context - sender context, to match reply w/ request @param retval - return code for the request - @param app_event_queue_address - vpp event queue address or 0 if this + @param app_event_queue_address - vpp event queue address or 0 if this connection shouldn't send events @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) + 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; @@ -54,13 +67,93 @@ 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 - string +*/ + define app_attach { + u32 client_index; + u32 context; + u64 options[17]; + string namespace_id[]; + }; + + /** \brief Application attach reply + @param context - sender context, to match reply w/ request + @param retval - return code for the request + @param app_mq - app message queue + @param vpp_ctrl_mq - vpp message queue for control events that should + be handled in main thread, i.e., bind/connect + @param vpp_ctrl_mq_thread_index - thread index of the ctrl mq + @param app_index - index of the newly created app + @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_size - size of first shm segment + @param segment_handle - handle for segment + @param segment_name - name of segment client needs to attach to +*/ +define app_attach_reply { + u32 context; + i32 retval; + u64 app_mq; + u64 vpp_ctrl_mq; + u8 vpp_ctrl_mq_thread; + u32 app_index; + u8 n_fds; + u8 fd_flags; + u32 segment_size; + u64 segment_handle; + string segment_name[]; +}; + +/** \brief Add certificate and key + @param client_index - opaque cookie to identify the sender + @param context - sender context, to match reply w/ request + @param engine - crypto engine + @param cert_len - cert length (comes first) + @param certkey_len - cert and key length + @param certkey - cert & key data (due to API limitation) +*/ +define app_add_cert_key_pair { + u32 client_index; + u32 context; + u16 cert_len; + u16 certkey_len; + u8 certkey[certkey_len]; +}; + +/** \brief Add certificate and key + @param context - sender context, to match reply w/ request + @param retval - return code for the request + @param index - index in certificate store +*/ +define app_add_cert_key_pair_reply { + u32 context; + i32 retval; + u32 index; +}; + +/** \brief Delete certificate and key + @param client_index - opaque cookie to identify the sender + @param context - sender context, to match reply w/ request + @param index - index in certificate store +*/ +autoreply define app_del_cert_key_pair { + u32 client_index; + u32 context; + u32 index; }; /** \brief Application add TLS certificate + ### WILL BE DEPRECATED POST 20.01 ### @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request @param cert_len - certificate length @@ -75,6 +168,7 @@ autoreply define application_tls_cert_add { }; /** \brief Application add TLS key + ### WILL BE DEPRECATED POST 20.01 ### @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request @param key_len - certificate length @@ -89,6 +183,7 @@ autoreply define application_tls_key_add { }; /** \brief client->vpp, attach application to session layer + ### WILL BE DEPRECATED POST 20.01 ### @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request */ @@ -96,12 +191,13 @@ autoreply define application_detach { u32 client_index; u32 context; }; - + /** \brief vpp->client, please map an additional shared memory segment + ### WILL BE DEPRECATED POST 20.01 ### @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request - @param fd_flags - set of flags that indicate which, if any, fds are - to be expected over the socket. This is set only if + @param fd_flags - set of flags that indicate which, if any, fds are + to be expected over the socket. This is set only if socket transport available @param segment_size - size of the segment to be mapped @param segment_name - name of the segment to be mapped @@ -112,15 +208,16 @@ autoreply define map_another_segment { u32 context; u8 fd_flags; u32 segment_size; - u8 segment_name[128]; + string segment_name[128]; u64 segment_handle; }; /** \brief vpp->client unmap shared memory segment + ### WILL BE DEPRECATED POST 20.01 ### @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request @param segment_name - segment name - @param segment_handle - handle of the segment to be unmapped + @param segment_handle - handle of the segment to be unmapped */ autoreply define unmap_segment { u32 client_index; @@ -129,6 +226,7 @@ autoreply define unmap_segment { }; /** \brief Bind to a given URI + ### WILL BE DEPRECATED POST 20.01 ### @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request @param accept_cookie - sender accept cookie, to identify this bind flavor @@ -144,6 +242,7 @@ autoreply define bind_uri { }; /** \brief Unbind a given URI + ### WILL BE DEPRECATED POST 20.01 ### @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request @param uri - a URI, e.g. "tcp://0.0.0.0/0/80" [ipv4] @@ -157,12 +256,13 @@ autoreply define unbind_uri { }; /** \brief Connect to a given URI + ### WILL BE DEPRECATED POST 20.01 ### @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request - @param client_queue_address - binary API client queue address. Used by + @param client_queue_address - binary API client queue address. Used by local server when connect was redirected. @param options - socket options, fifo sizes, etc. passed by vpp to the - server when redirecting connects + server when redirecting connects @param uri - a URI, e.g. "tcp4://0.0.0.0/0/80" "tcp6://::/0/80" [ipv6], etc. */ @@ -175,6 +275,7 @@ autoreply define connect_uri { }; /** \brief bidirectional disconnect API + ### WILL BE DEPRECATED POST 20.01 ### @param client_index - opaque cookie to identify the sender client to vpp direction only @param context - sender context, to match reply w/ request @@ -187,6 +288,7 @@ define disconnect_session { }; /** \brief bidirectional disconnect reply API + ### WILL BE DEPRECATED POST 20.01 ### @param client_index - opaque cookie to identify the sender client to vpp direction only @param context - sender context, to match reply w/ request @@ -200,13 +302,13 @@ define disconnect_session_reply { }; /** \brief Bind to an ip:port pair for a given transport protocol + ### WILL BE DEPRECATED POST 20.01 ### @param client_index - opaque cookie to identify the sender @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 port - port @param proto - protocol 0 - TCP 1 - UDP @param options - socket options, fifo sizes, etc. */ @@ -215,14 +317,14 @@ 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]; }; -/** \brief Unbind +/** \brief Unbind + ### WILL BE DEPRECATED POST 20.01 ###s @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request @param wrk_index - index of worker requesting the bind @@ -236,21 +338,21 @@ autoreply define unbind_sock { }; /** \brief Connect to a remote peer + ### WILL BE DEPRECATED POST 20.01 ### @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request @param wrk_index - worker that requests the connect - @param client_queue_address - client's API queue address. Non-zero when + @param client_queue_address - client's API queue address. Non-zero when 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 port - port @param proto - protocol 0 - TCP 1 - UDP @param hostname-len - length of hostname @param hostname - destination's hostname. If present, used by protocols like tls. - @param transport_opts - transport option (e.g. session id for quic). + @param parent_handle - handle of parent session (e.g. for opening quic streams). */ autoreply define connect_sock { u32 client_index; @@ -259,16 +361,15 @@ 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; - u8 hostname_len; - u8 hostname[hostname_len]; - u64 transport_opts; + vl_api_transport_proto_t proto; + u64 parent_handle; + string hostname[]; }; /** \brief ask app to add a new cut-through registration + ### WILL BE DEPRECATED POST 20.01 ### @param client_index - opaque cookie to identify the sender client to vpp direction only @param context - sender context, to match reply w/ request @@ -304,7 +405,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 @@ -314,10 +415,10 @@ define app_worker_add_del @param app_event_queue_address - vpp event queue address of new worker @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 + over the socket (set only if socket transport available) @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 { @@ -327,10 +428,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 @@ -342,7 +442,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 @@ -356,18 +456,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 @@ -382,11 +480,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 @@ -398,25 +502,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 @@ -431,7 +533,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 @@ -442,24 +544,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]; }; /*