2 * Copyright (c) 2015-2016 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
16 option version = "1.2.0";
18 /** \brief client->vpp, attach application to session layer
19 @param client_index - opaque cookie to identify the sender
20 @param context - sender context, to match reply w/ request
21 @param initial_segment_size - size of the initial shm segment to be
23 @param options - segment size, fifo sizes, etc.
24 @param namespace_id_len - length of the namespace id c-string
25 @param namespace_id - 0 terminted c-string
27 define application_attach {
30 u32 initial_segment_size;
36 /** \brief Application attach reply
37 @param context - sender context, to match reply w/ request
38 @param retval - return code for the request
39 @param app_event_queue_address - vpp event queue address or 0 if this
40 connection shouldn't send events
41 @param n_fds - number of fds exchanged
42 @param fd_flags - set of flags that indicate which fds are to be expected
43 over the socket (set only if socket transport available)
44 @param segment_size - size of first shm segment
45 @param segment_name_length - length of segment name
46 @param segment_name - name of segment client needs to attach to
48 define application_attach_reply {
51 u64 app_event_queue_address;
55 u8 segment_name_length;
59 /** \brief Application add TLS certificate
60 @param client_index - opaque cookie to identify the sender
61 @param context - sender context, to match reply w/ request
62 @param cert_len - certificate length
63 @param cert - certificate as a string
65 autoreply define application_tls_cert_add {
73 /** \brief Application add TLS key
74 @param client_index - opaque cookie to identify the sender
75 @param context - sender context, to match reply w/ request
76 @param key_len - certificate length
77 @param key - PEM encoded key as a string
79 autoreply define application_tls_key_add {
87 /** \brief client->vpp, attach application to session layer
88 @param client_index - opaque cookie to identify the sender
89 @param context - sender context, to match reply w/ request
91 autoreply define application_detach {
96 /** \brief vpp->client, please map an additional shared memory segment
97 @param client_index - opaque cookie to identify the sender
98 @param context - sender context, to match reply w/ request
99 @param fd_flags - set of flags that indicate which, if any, fds are
100 to be expected over the socket. This is set only if
101 socket transport available
102 @param segment_size - size of the segment to be mapped
103 @param segment_name - name of the segment to be mapped
105 autoreply define map_another_segment {
110 u8 segment_name[128];
113 /** \brief vpp->client unmap shared memory segment
114 @param client_index - opaque cookie to identify the sender
115 @param context - sender context, to match reply w/ request
116 @param segment_name -
118 autoreply define unmap_segment {
121 u8 segment_name[128];
124 /** \brief Bind to a given URI
125 @param client_index - opaque cookie to identify the sender
126 @param context - sender context, to match reply w/ request
127 @param accept_cookie - sender accept cookie, to identify this bind flavor
128 @param uri - a URI, e.g. "tcp://0.0.0.0/0/80" [ipv4]
129 "tcp://::/0/80" [ipv6] etc.
130 @param options - socket options, fifo sizes, etc.
139 define bind_uri_reply {
151 /** \brief Unbind a given URI
152 @param client_index - opaque cookie to identify the sender
153 @param context - sender context, to match reply w/ request
154 @param uri - a URI, e.g. "tcp://0.0.0.0/0/80" [ipv4]
155 "tcp://::/0/80" [ipv6], etc.
156 @param options - socket options, fifo sizes, etc.
158 autoreply define unbind_uri {
164 /** \brief Connect to a given URI
165 @param client_index - opaque cookie to identify the sender
166 @param context - sender context, to match reply w/ request
167 @param client_queue_address - binary API client queue address. Used by
168 local server when connect was redirected.
169 @param options - socket options, fifo sizes, etc. passed by vpp to the
170 server when redirecting connects
171 @param uri - a URI, e.g. "tcp4://0.0.0.0/0/80"
172 "tcp6://::/0/80" [ipv6], etc.
174 autoreply define connect_uri {
177 u64 client_queue_address;
182 /** \brief vpp->client, accept this session
183 @param context - sender context, to match reply w/ request
184 @param listener_handle - tells client which listener this pertains to
185 @param handle - unique session identifier
186 @param rx_fifo_address - rx (vpp -> vpp-client) fifo address
187 @param tx_fifo_address - tx (vpp-client -> vpp) fifo address
188 @param vpp_event_queue_address - vpp's event queue address or client's
189 event queue for cut through
190 @param server_event_queue_address - server's event queue address for
192 @param port - remote port
193 @param is_ip4 - 1 if the ip is ip4
194 @param ip - remote ip
196 define accept_session {
203 u64 vpp_event_queue_address;
204 u64 server_event_queue_address;
210 /** \brief client->vpp, reply to an accept message
211 @param context - sender context, to match reply w/ request
212 @param retval - return code for the request
213 @param session_index - session index from accept_session / connect_reply
214 @param session_thread_index - thread index from accept_session /
217 define accept_session_reply {
223 /** \brief bidirectional disconnect API
224 @param client_index - opaque cookie to identify the sender
225 client to vpp direction only
226 @param context - sender context, to match reply w/ request
227 @param handle - session handle obtained from accept/connect
229 define disconnect_session {
235 /** \brief bidirectional disconnect reply API
236 @param client_index - opaque cookie to identify the sender
237 client to vpp direction only
238 @param context - sender context, to match reply w/ request
239 @param retval - return code for the request
240 @param handle - session handle
242 define disconnect_session_reply {
248 /** \brief vpp->client reset session API
249 @param client_index - opaque cookie to identify the sender
250 client to vpp direction only
251 @param context - sender context, to match reply w/ request
252 @param handle - session handle obtained via accept/connects
254 define reset_session {
260 /** \brief client->vpp reset session reply
261 @param context - sender context, to match reply w/ request
262 @param retval - return code for the request
263 @param handle - session handle obtained via accept/connect
265 define reset_session_reply {
271 /** \brief Bind to an ip:port pair for a given transport protocol
272 @param client_index - opaque cookie to identify the sender
273 @param context - sender context, to match reply w/ request
274 @param wrk_index - index of worker requesting the bind
275 @param vrf - bind namespace
276 @param is_ip4 - flag that is 1 if ip address family is IPv4
277 @param ip - ip address
279 @param proto - protocol 0 - TCP 1 - UDP
280 @param options - socket options, fifo sizes, etc.
295 @param client_index - opaque cookie to identify the sender
296 @param context - sender context, to match reply w/ request
297 @param wrk_index - index of worker requesting the bind
298 @param handle - bind handle obtained from bind reply
300 autoreply define unbind_sock {
307 /** \brief Connect to a remote peer
308 @param client_index - opaque cookie to identify the sender
309 @param context - sender context, to match reply w/ request
310 @param wrk_index - worker that requests the connect
311 @param client_queue_address - client's API queue address. Non-zero when
312 used to perform redirects
313 @param options - socket options, fifo sizes, etc. when doing redirects
314 @param vrf - connection namespace
315 @param is_ip4 - flag that is 1 if ip address family is IPv4
316 @param ip - ip address
318 @param proto - protocol 0 - TCP 1 - UDP
319 @param hostname-len - length of hostname
320 @param hostname - destination's hostname. If present, used by protocols
323 autoreply define connect_sock {
327 u64 client_queue_address;
335 u8 hostname[hostname_len];
338 /** \brief Bind reply
339 @param context - sender context, to match reply w/ request
340 @param handle - bind handle
341 @param retval - return code for the request
342 @param lcl_is_ip4 - local ip address type
343 @param lcl_ip6 - local ip address
344 @param lcl_port - local port
345 @param rx_fifo - rx fifo address if allocated (connectionless)
346 @param tx_fifo - tx fifo address if allocated (connectionless)
347 @param vpp_evt_q - vpp event queue address (connectionless)
348 @param segment_name_length - length of segment name
349 @param segment_name - name of segment client needs to attach to
351 define bind_sock_reply {
362 u8 segment_name_length;
363 u8 segment_name[128];
366 /* Dummy connect message -- needed to satisfy api generators
368 * NEVER USED, doxygen tags elided on purpose.
370 define connect_session {
375 /** \brief vpp/server->client, connect reply -- used for all connect_* messages
376 @param context - sender context, to match reply w/ request
377 @param retval - return code for the request
378 @param handle - connection handle
379 @param server_rx_fifo - rx (vpp -> vpp-client) fifo address
380 @param server_tx_fifo - tx (vpp-client -> vpp) fifo address
381 @param vpp_event_queue_address - vpp's event queue address
382 @param client_event_queue_address - client's event queue address
383 @param segment_size - size of segment to be attached. Only for redirects.
384 @param segment_name_length - non-zero if the client needs to attach to
386 @param segment_name - set if the client needs to attach to the segment
387 @param lcl_ip - local ip for connection
388 @param is_ip4 - flag to indicate if ip is v4 or v6
389 @param lcl_port - local port
391 define connect_session_reply {
397 u64 vpp_event_queue_address;
398 u64 client_event_queue_address;
400 u8 segment_name_length;
401 u8 segment_name[128];
407 /** \brief ask app to add a new cut-through registration
408 @param client_index - opaque cookie to identify the sender
409 client to vpp direction only
410 @param context - sender context, to match reply w/ request
411 @param evt_q_address - address of the mq in ssvm segment
412 @param peer_evt_q_address - address of peer's mq in ssvm segment
413 @param wrk_index - index of worker to receive the registration
414 @param n_fds - number of fds exchanged
415 @param fd_flags - flag indicating the fds that will be exchanged over
418 autoreply define app_cut_through_registration_add
423 u64 peer_evt_q_address;
429 /** \brief add/del application worker
430 @param client_index - opaque cookie to identify the sender
431 client to vpp direction only
432 @param context - sender context, to match reply w/ request
433 @param app_api_index - explicit client api index
434 @param wrk_index - worker index, if a delete
435 @param is_add - set if an add
437 define app_worker_add_del
446 /** \brief Reply for app worker add/del
447 @param context - returned sender context, to match reply w/ request
448 @param retval - return code
449 @param wrk_index - worker index, if add
450 @param app_event_queue_address - vpp event queue address of new worker
451 @param n_fds - number of fds exchanged
452 @param fd_flags - set of flags that indicate which fds are to be expected
453 over the socket (set only if socket transport available)
454 @param segment_name_length - length of segment name
455 @param segment_name - name of segment client needs to attach to
457 define app_worker_add_del_reply
462 u64 app_event_queue_address;
465 u8 segment_name_length;
466 u8 segment_name[128];
470 /** \brief enable/disable session layer
471 @param client_index - opaque cookie to identify the sender
472 client to vpp direction only
473 @param context - sender context, to match reply w/ request
474 @param is_enable - disable session layer if 0, enable otherwise
476 autoreply define session_enable_disable {
482 /** \brief add/del application namespace
483 @param client_index - opaque cookie to identify the sender
484 client to vpp direction only
485 @param context - sender context, to match reply w/ request
486 @param secret - secret shared between app and vpp
487 @param sw_if_index - local interface that "supports" namespace. Set to
489 @param ip4_fib_id - id of ip4 fib that "supports" the namespace. Ignored
491 @param ip6_fib_id - id of ip6 fib that "supports" the namespace. Ignored
493 @param namespace_id_len - length of namespace id lower
494 @param namespace_id - namespace id
496 define app_namespace_add_del {
507 /** \brief Reply for app namespace add/del
508 @param context - returned sender context, to match reply w/ request
509 @param retval - return code
510 @param appns_index - app namespace index
512 define app_namespace_add_del_reply
519 /** \brief add/del session rule
520 @param client_index - opaque cookie to identify the sender
521 client to vpp direction only
522 @param context - sender context, to match reply w/ request
523 @param transport_proto - transport protocol (0 - tcp 1 - udp)
524 @param is_ip4 - flag to indicate if ip addresses are ip4 or 6
525 @param lcl_ip - local ip
526 @param lcl_plen - local prefix length
527 @param rmt_ip - remote ip
528 @param rmt_ple - remote prefix length
529 @param lcl_port - local port
530 @param rmt_port - remote port
531 @param action_index - the only action defined now is forward to
532 application with index action_index
533 @param is_add - flag to indicate if add or del
534 @param appns_index - application namespace where rule is to be applied
536 @param scope - flag that indicates scope of the rule: global or local.
537 If 0, default is global, 1 is global 2 is local, 3 is
540 autoreply define session_rule_add_del {
558 /** \brief Dump session rules
559 @param client_index - opaque cookie to identify the sender
560 @param context - sender context, to match reply w/ request
562 define session_rules_dump
568 /** \brief Session rules details
569 @param context - sender context, to match reply w/ request
570 @param transport_proto - transport protocol (0 - tcp 1 - udp)
571 @param is_ip4 - flag to indicate if ip addresses are ip4 or 6
572 @param lcl_ip - local ip
573 @param lcl_plen - local prefix length
574 @param rmt_ip - remote ip
575 @param rmt_ple - remote prefix length
576 @param lcl_port - local port
577 @param rmt_port - remote port
578 @param action_index - the only action defined now is forward to
579 application with index action_index
580 @param appns_index - application namespace where rule is to be applied
582 @param scope - flag that indicates scope of the rule: global or local.
583 If 0, default is global, 1 is global 2 is local, 3 is
586 define session_rules_details
605 * eval: (c-set-style "gnu")