X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=src%2Fvnet%2Fsession%2Fsession.api;h=2f5e452533c1d599ca191d780aece0d8495aaddf;hb=c0e9441e7;hp=358103a4f56061fb2296de452229e44ca4a83362;hpb=6e8c6679883f59542d85d1de3edabc7e811108d2;p=vpp.git diff --git a/src/vnet/session/session.api b/src/vnet/session/session.api index 358103a4f56..2f5e452533c 100644 --- a/src/vnet/session/session.api +++ b/src/vnet/session/session.api @@ -1,5 +1,5 @@ /* - * Copyright (c) 2015-2016 Cisco and/or its affiliates. + * Copyright (c) 2015-2019 Cisco and/or its affiliates. * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at: @@ -13,42 +13,61 @@ * limitations under the License. */ -vl_api_version 1.0.0 +option version = "3.1.0"; -/** \brief client->vpp, attach application to session layer +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_QUIC, +}; + +/** \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 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 { + define app_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 @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 - connection shouldn't send events + @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_name_length - length of segment name + @param segment_handle - handle for segment @param segment_name - name of segment client needs to attach to */ -define application_attach_reply { +define app_attach_reply { u32 context; i32 retval; - u64 app_event_queue_address; + u64 app_mq; + u64 vpp_ctrl_mq; + u8 vpp_ctrl_mq_thread; + u32 app_index; + u8 n_fds; + u8 fd_flags; u32 segment_size; - u8 segment_name_length; - u8 segment_name[128]; + u64 segment_handle; + string segment_name[]; }; /** \brief client->vpp, attach application to session layer @@ -58,268 +77,116 @@ define application_attach_reply { autoreply define application_detach { u32 client_index; u32 context; - }; - -/** \brief vpp->client, please map an additional 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 map_another_segment { - u32 client_index; - u32 context; - u32 segment_size; - 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 - @param accept_cookie - sender accept cookie, to identify this bind flavor - @param uri - a URI, e.g. "tcp://0.0.0.0/0/80" [ipv4] - "tcp://::/0/80" [ipv6] etc. - @param options - socket options, fifo sizes, etc. -*/ -autoreply define bind_uri { - u32 client_index; - u32 context; - u32 accept_cookie; - u8 uri[128]; -}; - -/** \brief Unbind a given URI - @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] - "tcp://::/0/80" [ipv6], etc. - @param options - socket options, fifo sizes, etc. -*/ -autoreply define unbind_uri { - u32 client_index; - u32 context; - u8 uri[128]; }; -/** \brief Connect to a given URI +/** \brief Add certificate and key @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 - 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. + @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) */ -autoreply define connect_uri { - u32 client_index; - u32 context; - u64 client_queue_address; - u64 options[16]; - 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 port - remote port - @param is_ip4 - 1 if the ip is ip4 - @param ip - remote ip -*/ -define accept_session { - u32 client_index; - u32 context; - u64 listener_handle; - u64 handle; - u64 server_rx_fifo; - u64 server_tx_fifo; - u64 vpp_event_queue_address; - u16 port; - u8 is_ip4; - u8 ip[16]; +define app_add_cert_key_pair { + u32 client_index; + u32 context; + u16 cert_len; + u16 certkey_len; + u8 certkey[certkey_len]; }; -/** \brief client->vpp, reply to an accept message +/** \brief Add certificate and key @param context - sender context, to match reply w/ request @param retval - return code for the request - @param session_index - session index from accept_session / connect_reply - @param session_thread_index - thread index from accept_session / - connect_reply + @param index - index in certificate store */ -define accept_session_reply { - u32 context; - i32 retval; - u64 handle; +define app_add_cert_key_pair_reply { + u32 context; + i32 retval; + u32 index; }; -/** \brief bidirectional disconnect API +/** \brief Delete certificate and key @param client_index - opaque cookie to identify the sender - client to vpp direction only @param context - sender context, to match reply w/ request - @param handle - session handle obtained from accept/connect + @param index - index in certificate store */ -define disconnect_session { - u32 client_index; - u32 context; - u64 handle; +autoreply define app_del_cert_key_pair { + u32 client_index; + u32 context; + u32 index; }; -/** \brief bidirectional disconnect reply API +/** \brief Application add TLS certificate + ### 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 - @param retval - return code for the request - @param handle - session handle + @param cert_len - certificate length + @param cert - certificate as a string */ -define disconnect_session_reply { - u32 client_index; - u32 context; - i32 retval; - u64 handle; +autoreply define application_tls_cert_add { + u32 client_index; + u32 context; + u32 app_index; + u16 cert_len; + u8 cert[cert_len]; }; -/** \brief vpp->client reset session API +/** \brief Application add TLS key + ### 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 - @param handle - session handle obtained via accept/connects + @param key_len - certificate length + @param key - PEM encoded key as a string */ -define reset_session { - u32 client_index; - u32 context; - u64 handle; +autoreply define application_tls_key_add { + u32 client_index; + u32 context; + u32 app_index; + u16 key_len; + u8 key[key_len]; }; -/** \brief client->vpp reset session reply +/** \brief add/del application worker @param client_index - opaque cookie to identify the sender client to vpp direction only @param context - sender context, to match reply w/ request - @param retval - return code for the request - @param handle - session handle obtained via accept/connect -*/ -define reset_session_reply { - u32 client_index; - u32 context; - i32 retval; - u64 handle; -}; - -/** \brief Bind to an ip:port pair for a given transport protocol - @param client_index - opaque cookie to identify the sender - @param context - sender context, to match reply w/ request - @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 - @param options - socket options, fifo sizes, etc. -*/ -define bind_sock { - u32 client_index; - u32 context; - u32 vrf; - u8 is_ip4; - u8 ip[16]; - u16 port; - u8 proto; - u64 options[16]; -}; - -/** \brief Unbind - @param client_index - opaque cookie to identify the sender - @param context - sender context, to match reply w/ request - @param handle - bind handle obtained from bind reply -*/ -autoreply define unbind_sock { - u32 client_index; - u32 context; - u64 handle; -}; - -/** \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 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 app_index - application index + @param wrk_index - worker index, if a delete + @param is_add - set if an add */ -autoreply define connect_sock { +define app_worker_add_del +{ u32 client_index; u32 context; - u64 client_queue_address; - u64 options[16]; - u32 vrf; - u8 is_ip4; - u8 ip[16]; - u16 port; - u8 proto; + u32 app_index; + u32 wrk_index; + bool is_add [default=true]; }; -/** \brief Bind reply - @param context - sender context, to match reply w/ request - @param handle - bind handle - @param retval - return code for the request - @param event_queue_address - vpp event queue address or 0 if this - connection shouldn't send events - @param segment_name_length - length of segment name +/** \brief Reply for app worker add/del + @param context - returned sender context, to match reply w/ request + @param retval - return code + @param wrk_index - worker index, if add + @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_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 bind_sock_reply { - u32 context; - u64 handle; - i32 retval; - u64 server_event_queue_address; - u32 segment_size; - u8 segment_name_length; - u8 segment_name[128]; -}; - -/* 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 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 - @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_session_reply { +define app_worker_add_del_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 lcl_ip[16]; - u8 is_ip4; - u16 lcl_port; + u32 wrk_index; + u64 app_event_queue_address; + u8 n_fds; + u8 fd_flags; + u64 segment_handle; + bool is_add [default=true]; + string segment_name[]; }; /** \brief enable/disable session layer @@ -331,32 +198,30 @@ define connect_session_reply { autoreply define session_enable_disable { u32 client_index; u32 context; - u8 is_enable; + bool is_enable [default=true]; }; /** \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 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 + ~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 - 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 [default=0xffffffff]; 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 @@ -371,11 +236,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 @@ -383,31 +254,27 @@ define app_namespace_add_del_reply @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 + @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 - 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 @@ -421,8 +288,8 @@ 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 context - sender context, to match reply w/ request + @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 @@ -431,28 +298,24 @@ define session_rules_dump @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 + application with index action_index + @param appns_index - application namespace where rule is to be applied to + @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]; }; /*