X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=src%2Fvnet%2Fsession%2Fsession.api;h=bf88e82f336692cfb35a28b50110015bcdc9dcd0;hb=8f89dd0;hp=e01cc75e28b6835588ecb30ac8841dde6e5834ef;hpb=2fcc49d9c6a66c49148d5790f6af38ab2f3b4be6;p=vpp.git diff --git a/src/vnet/session/session.api b/src/vnet/session/session.api index e01cc75e28b..bf88e82f336 100644 --- a/src/vnet/session/session.api +++ b/src/vnet/session/session.api @@ -12,19 +12,25 @@ * See the License for the specific language governing permissions and * limitations under the License. */ - + +option version = "1.0.2"; + /** \brief client->vpp, attach application to session layer @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 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 */ define application_attach { u32 client_index; u32 context; u32 initial_segment_size; u64 options[16]; + u8 namespace_id_len; + u8 namespace_id [64]; }; /** \brief Application attach reply @@ -45,6 +51,34 @@ define application_attach_reply { u8 segment_name[128]; }; +/** \brief Application add TLS certificate + @param client_index - opaque cookie to identify the sender + @param context - sender context, to match reply w/ request + @param cert_len - certificate length + @param cert - certificate as a string +*/ +autoreply define application_tls_cert_add { + u32 client_index; + u32 context; + u32 app_index; + u16 cert_len; + u8 cert[cert_len]; +}; + +/** \brief Application add TLS key + @param client_index - opaque cookie to identify the sender + @param context - sender context, to match reply w/ request + @param key_len - certificate length + @param key - PEM encoded key as a string +*/ +autoreply define application_tls_key_add { + u32 client_index; + u32 context; + u32 app_index; + u16 key_len; + u8 key[key_len]; +}; + /** \brief client->vpp, attach application to session layer @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request @@ -66,6 +100,17 @@ autoreply define map_another_segment { u8 segment_name[128]; }; +/** \brief vpp->client unmap shared memory segment + @param client_index - opaque cookie to identify the sender + @param context - sender context, to match reply w/ request + @param segment_name - +*/ +autoreply define unmap_segment { + u32 client_index; + u32 context; + u8 segment_name[128]; +}; + /** \brief Bind to a given URI @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request @@ -97,55 +142,31 @@ autoreply define unbind_uri { /** \brief Connect to a given URI @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 - @param uri - a URI, e.g. "tcp4://0.0.0.0/0/80" - "tcp6://::/0/80" [ipv6], etc. - @param options - socket options, fifo sizes, etc. passed by vpp to the - server when redirecting connects @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 + @param uri - a URI, e.g. "tcp4://0.0.0.0/0/80" + "tcp6://::/0/80" [ipv6], etc. */ -define connect_uri { +autoreply define connect_uri { u32 client_index; u32 context; - u8 uri[128]; u64 client_queue_address; u64 options[16]; -}; - -/** \brief vpp->client, connect reply - @param context - sender context, to match reply w/ request - @param retval - return code for the request - @param handle - session handle - @param server_rx_fifo - rx (vpp -> vpp-client) fifo address - @param server_tx_fifo - tx (vpp-client -> vpp) fifo address - @param vpp_event_queue_address - vpp's event queue address - @param segment_size - size of segment to be attached. Only for redirects. - @param segment_name_length - non-zero if the client needs to attach to - the fifo segment. This should only happen - if session was redirected. - @param segment_name - set if the client needs to attach to the segment -*/ -define connect_uri_reply { - u32 context; - i32 retval; - u64 handle; - u64 server_rx_fifo; - u64 server_tx_fifo; - u64 vpp_event_queue_address; - u32 segment_size; - u8 segment_name_length; - u8 segment_name[128]; + u8 uri[128]; }; /** \brief vpp->client, accept this session @param context - sender context, to match reply w/ request @param listener_handle - tells client which listener this pertains to @param handle - unique session identifier - @param session_thread_index - thread index of new session @param rx_fifo_address - rx (vpp -> vpp-client) fifo address @param tx_fifo_address - tx (vpp-client -> vpp) fifo address - @param vpp_event_queue_address - vpp's event queue address + @param vpp_event_queue_address - vpp's event queue address or client's + event queue for cut through + @param server_event_queue_address - server's event queue address for + cut through sessions @param port - remote port @param is_ip4 - 1 if the ip is ip4 @param ip - remote ip @@ -158,6 +179,7 @@ define accept_session { u64 server_rx_fifo; u64 server_tx_fifo; u64 vpp_event_queue_address; + u64 server_event_queue_address; u16 port; u8 is_ip4; u8 ip[16]; @@ -196,7 +218,6 @@ define disconnect_session { @param handle - session handle */ define disconnect_session_reply { - u32 client_index; u32 context; i32 retval; u64 handle; @@ -263,27 +284,30 @@ autoreply define unbind_sock { /** \brief Connect to a remote peer @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request - @param app_connect - application connection id to be returned in reply + @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 proto - protocol 0 - TCP 1 - UDP - @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 hostname-len - length of hostname + @param hostname - destination's hostname. If present, used by protocols + like tls. */ -define connect_sock { +autoreply define connect_sock { u32 client_index; u32 context; - u32 app_connect; + u64 client_queue_address; + u64 options[16]; u32 vrf; u8 is_ip4; u8 ip[16]; u16 port; u8 proto; - u64 client_queue_address; - u64 options[16]; + u8 hostname_len; + u8 hostname[hostname_len]; }; /** \brief Bind reply @@ -300,35 +324,53 @@ define bind_sock_reply { u64 handle; i32 retval; u64 server_event_queue_address; + u8 lcl_is_ip4; + u8 lcl_ip[16]; + u16 lcl_port; u32 segment_size; u8 segment_name_length; u8 segment_name[128]; }; -/** \brief vpp/server->client, connect reply +/* Dummy connect message -- needed to satisfy api generators +* +* NEVER USED, doxygen tags elided on purpose. +*/ +define connect_session { + u32 client_index; + u32 context; +}; + +/** \brief vpp/server->client, connect reply -- used for all connect_* messages @param context - sender context, to match reply w/ request @param retval - return code for the request @param handle - connection handle - @param app_connect - application connection id from connect msg @param server_rx_fifo - rx (vpp -> vpp-client) fifo address @param server_tx_fifo - tx (vpp-client -> vpp) fifo address @param vpp_event_queue_address - vpp's event queue address + @param client_event_queue_address - client's event queue address @param segment_size - size of segment to be attached. Only for redirects. @param segment_name_length - non-zero if the client needs to attach to the fifo segment @param segment_name - set if the client needs to attach to the segment + @param lcl_ip - local ip for connection + @param is_ip4 - flag to indicate if ip is v4 or v6 + @param lcl_port - local port */ -define connect_sock_reply { +define connect_session_reply { u32 context; i32 retval; u64 handle; - u32 app_connect; u64 server_rx_fifo; u64 server_tx_fifo; u64 vpp_event_queue_address; + u64 client_event_queue_address; u32 segment_size; u8 segment_name_length; u8 segment_name[128]; + u8 lcl_ip[16]; + u8 is_ip4; + u16 lcl_port; }; /** \brief enable/disable session layer @@ -343,6 +385,127 @@ autoreply define session_enable_disable { u8 is_enable; }; +/** \brief add/del application namespace + @param client_index - opaque cookie to identify the sender + client to vpp direction only + @param context - sender context, to match reply w/ request + @param secret - secret shared between app and vpp + @param sw_if_index - local interface that "supports" namespace. Set to + ~0 if no preference + @param ip4_fib_id - id of ip4 fib that "supports" the namespace. Ignored + 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; + u32 ip4_fib_id; + u32 ip6_fib_id; + u8 namespace_id_len; + u8 namespace_id[64]; +}; + +/** \brief Reply for app namespace add/del + @param context - returned sender context, to match reply w/ request + @param retval - return code + @param appns_index - app namespace index +*/ +define app_namespace_add_del_reply +{ + u32 context; + i32 retval; + u32 appns_index; +}; + +/** \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 is_ip4 - flag to indicate if ip addresses are ip4 or 6 + @param lcl_ip - local ip + @param lcl_plen - local prefix length + @param rmt_ip - remote ip + @param rmt_ple - remote prefix length + @param lcl_port - local port + @param rmt_port - remote port + @param action_index - the only action defined now is forward to + 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. + If 0, default is global, 1 is global 2 is local, 3 is + both +*/ +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; + u16 lcl_port; + u16 rmt_port; + u32 action_index; + u8 is_add; + u32 appns_index; + u8 scope; + u8 tag[64]; +}; + +/** \brief Dump session rules + @param client_index - opaque cookie to identify the sender + @param context - sender context, to match reply w/ request + */ +define session_rules_dump +{ + u32 client_index; + u32 context; +}; + +/** \brief Session rules details + @param context - sender context, to match reply w/ request + @param transport_proto - transport protocol (0 - tcp 1 - udp) + @param is_ip4 - flag to indicate if ip addresses are ip4 or 6 + @param lcl_ip - local ip + @param lcl_plen - local prefix length + @param rmt_ip - remote ip + @param rmt_ple - remote prefix length + @param lcl_port - local port + @param rmt_port - remote port + @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. + If 0, default is global, 1 is global 2 is local, 3 is + both + */ +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; + u16 lcl_port; + u16 rmt_port; + u32 action_index; + u32 appns_index; + u8 scope; + u8 tag[64]; +}; + /* * Local Variables: * eval: (c-set-style "gnu")