2 * Copyright (c) 2015-2019 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.7.0";
18 /** \brief client->vpp, attach application to session layer
19 ### WILL BE DEPRECATED POST 20.01 ###
20 @param client_index - opaque cookie to identify the sender
21 @param context - sender context, to match reply w/ request
22 @param initial_segment_size - size of the initial shm segment to be
24 @param options - segment size, fifo sizes, etc.
25 @param namespace_id_len - length of the namespace id c-string
26 @param namespace_id - 0 terminted c-string
28 define application_attach {
31 u32 initial_segment_size;
37 /** \brief Application attach reply
38 ### WILL BE DEPRECATED POST 20.01 ###
39 @param context - sender context, to match reply w/ request
40 @param retval - return code for the request
41 @param app_event_queue_address - vpp event queue address or 0 if this
42 connection shouldn't send events
43 @param n_fds - number of fds exchanged
44 @param fd_flags - set of flags that indicate which fds are to be expected
45 over the socket (set only if socket transport available)
46 @param segment_size - size of first shm segment
47 @param segment_name_length - length of segment name
48 @param segment_name - name of segment client needs to attach to
49 @param app_index - index of the newly created app
50 @param segment_handle - handle for segment
52 define application_attach_reply {
55 u64 app_event_queue_address;
59 u8 segment_name_length;
65 /** \brief Application attach to session layer
66 @param client_index - opaque cookie to identify the sender
67 @param context - sender context, to match reply w/ request
68 @param options - segment size, fifo sizes, etc.
69 @param namespace_id_len - length of the namespace id c-string
70 @param namespace_id - 0 terminted c-string
80 /** \brief Application attach reply
81 @param context - sender context, to match reply w/ request
82 @param retval - return code for the request
83 @param app_mq - app message queue
84 @param vpp_ctrl_mq - vpp message queue for control events that should
85 be handled in main thread, i.e., bind/connect
86 @param vpp_ctrl_mq_thread_index - thread index of the ctrl mq
87 @param app_index - index of the newly created app
88 @param n_fds - number of fds exchanged
89 @param fd_flags - set of flags that indicate which fds are to be expected
90 over the socket (set only if socket transport available)
91 @param segment_size - size of first shm segment
92 @param segment_name_length - length of segment name
93 @param segment_name - name of segment client needs to attach to
94 @param segment_handle - handle for segment
96 define app_attach_reply {
101 u8 vpp_ctrl_mq_thread;
106 u8 segment_name_length;
107 u8 segment_name[128];
111 /** \brief Add certificate and key
112 @param client_index - opaque cookie to identify the sender
113 @param context - sender context, to match reply w/ request
114 @param engine - crypto engine
115 @param cert_len - cert length (comes first)
116 @param certkey_len - cert and key length
117 @param certkey - cert & key data (due to API limitation)
119 define app_add_cert_key_pair {
124 u8 certkey[certkey_len];
127 /** \brief Add certificate and key
128 @param context - sender context, to match reply w/ request
129 @param retval - return code for the request
130 @param index - index in certificate store
132 define app_add_cert_key_pair_reply {
138 /** \brief Delete certificate and key
139 @param client_index - opaque cookie to identify the sender
140 @param context - sender context, to match reply w/ request
141 @param index - index in certificate store
143 autoreply define app_del_cert_key_pair {
149 /** \brief Application add TLS certificate
150 ### WILL BE DEPRECATED POST 20.01 ###
151 @param client_index - opaque cookie to identify the sender
152 @param context - sender context, to match reply w/ request
153 @param cert_len - certificate length
154 @param cert - certificate as a string
156 autoreply define application_tls_cert_add {
164 /** \brief Application add TLS key
165 ### WILL BE DEPRECATED POST 20.01 ###
166 @param client_index - opaque cookie to identify the sender
167 @param context - sender context, to match reply w/ request
168 @param key_len - certificate length
169 @param key - PEM encoded key as a string
171 autoreply define application_tls_key_add {
179 /** \brief client->vpp, attach application to session layer
180 ### WILL BE DEPRECATED POST 20.01 ###
181 @param client_index - opaque cookie to identify the sender
182 @param context - sender context, to match reply w/ request
184 autoreply define application_detach {
189 /** \brief vpp->client, please map an additional shared memory segment
190 @param client_index - opaque cookie to identify the sender
191 @param context - sender context, to match reply w/ request
192 @param fd_flags - set of flags that indicate which, if any, fds are
193 to be expected over the socket. This is set only if
194 socket transport available
195 @param segment_size - size of the segment to be mapped
196 @param segment_name - name of the segment to be mapped
197 @param segment_handle - unique identifier for segment
199 autoreply define map_another_segment {
204 u8 segment_name[128];
208 /** \brief vpp->client unmap shared memory segment
209 @param client_index - opaque cookie to identify the sender
210 @param context - sender context, to match reply w/ request
211 @param segment_name - segment name
212 @param segment_handle - handle of the segment to be unmapped
214 autoreply define unmap_segment {
220 /** \brief Bind to a given URI
221 ### WILL BE DEPRECATED POST 20.01 ###
222 @param client_index - opaque cookie to identify the sender
223 @param context - sender context, to match reply w/ request
224 @param accept_cookie - sender accept cookie, to identify this bind flavor
225 @param uri - a URI, e.g. "tcp://0.0.0.0/0/80" [ipv4]
226 "tcp://::/0/80" [ipv6] etc.
227 @param options - socket options, fifo sizes, etc.
229 autoreply define bind_uri {
236 /** \brief Unbind a given URI
237 ### WILL BE DEPRECATED POST 20.01 ###
238 @param client_index - opaque cookie to identify the sender
239 @param context - sender context, to match reply w/ request
240 @param uri - a URI, e.g. "tcp://0.0.0.0/0/80" [ipv4]
241 "tcp://::/0/80" [ipv6], etc.
242 @param options - socket options, fifo sizes, etc.
244 autoreply define unbind_uri {
250 /** \brief Connect to a given URI
251 ### WILL BE DEPRECATED POST 20.01 ###
252 @param client_index - opaque cookie to identify the sender
253 @param context - sender context, to match reply w/ request
254 @param client_queue_address - binary API client queue address. Used by
255 local server when connect was redirected.
256 @param options - socket options, fifo sizes, etc. passed by vpp to the
257 server when redirecting connects
258 @param uri - a URI, e.g. "tcp4://0.0.0.0/0/80"
259 "tcp6://::/0/80" [ipv6], etc.
261 autoreply define connect_uri {
264 u64 client_queue_address;
269 /** \brief bidirectional disconnect API
270 ### WILL BE DEPRECATED POST 20.01 ###
271 @param client_index - opaque cookie to identify the sender
272 client to vpp direction only
273 @param context - sender context, to match reply w/ request
274 @param handle - session handle obtained from accept/connect
276 define disconnect_session {
282 /** \brief bidirectional disconnect reply API
283 ### WILL BE DEPRECATED POST 20.01 ###
284 @param client_index - opaque cookie to identify the sender
285 client to vpp direction only
286 @param context - sender context, to match reply w/ request
287 @param retval - return code for the request
288 @param handle - session handle
290 define disconnect_session_reply {
296 /** \brief Bind to an ip:port pair for a given transport protocol
297 ### WILL BE DEPRECATED POST 20.01 ###
298 @param client_index - opaque cookie to identify the sender
299 @param context - sender context, to match reply w/ request
300 @param wrk_index - index of worker requesting the bind
301 @param vrf - bind namespace
302 @param is_ip4 - flag that is 1 if ip address family is IPv4
303 @param ip - ip address
305 @param proto - protocol 0 - TCP 1 - UDP
306 @param options - socket options, fifo sizes, etc.
308 autoreply define bind_sock {
321 ### WILL BE DEPRECATED POST 20.01 ###s
322 @param client_index - opaque cookie to identify the sender
323 @param context - sender context, to match reply w/ request
324 @param wrk_index - index of worker requesting the bind
325 @param handle - bind handle obtained from bind reply
327 autoreply define unbind_sock {
334 /** \brief Connect to a remote peer
335 ### WILL BE DEPRECATED POST 20.01 ###
336 @param client_index - opaque cookie to identify the sender
337 @param context - sender context, to match reply w/ request
338 @param wrk_index - worker that requests the connect
339 @param client_queue_address - client's API queue address. Non-zero when
340 used to perform redirects
341 @param options - socket options, fifo sizes, etc. when doing redirects
342 @param vrf - connection namespace
343 @param is_ip4 - flag that is 1 if ip address family is IPv4
344 @param ip - ip address
346 @param proto - protocol 0 - TCP 1 - UDP
347 @param hostname-len - length of hostname
348 @param hostname - destination's hostname. If present, used by protocols
350 @param parent_handle - handle of parent session (e.g. for opening quic streams).
352 autoreply define connect_sock {
356 u64 client_queue_address;
365 u8 hostname[hostname_len];
368 /** \brief ask app to add a new cut-through registration
369 ### WILL BE DEPRECATED POST 20.01 ###
370 @param client_index - opaque cookie to identify the sender
371 client to vpp direction only
372 @param context - sender context, to match reply w/ request
373 @param evt_q_address - address of the mq in ssvm segment
374 @param peer_evt_q_address - address of peer's mq in ssvm segment
375 @param wrk_index - index of worker to receive the registration
376 @param n_fds - number of fds exchanged
377 @param fd_flags - flag indicating the fds that will be exchanged over
380 autoreply define app_cut_through_registration_add
385 u64 peer_evt_q_address;
391 /** \brief add/del application worker
392 @param client_index - opaque cookie to identify the sender
393 client to vpp direction only
394 @param context - sender context, to match reply w/ request
395 @param app_index - application index
396 @param wrk_index - worker index, if a delete
397 @param is_add - set if an add
399 define app_worker_add_del
408 /** \brief Reply for app worker add/del
409 @param context - returned sender context, to match reply w/ request
410 @param retval - return code
411 @param wrk_index - worker index, if add
412 @param app_event_queue_address - vpp event queue address of new worker
413 @param n_fds - number of fds exchanged
414 @param fd_flags - set of flags that indicate which fds are to be expected
415 over the socket (set only if socket transport available)
416 @param segment_name_length - length of segment name
417 @param segment_name - name of segment client needs to attach to
418 @param segment_handle - handle for segment
420 define app_worker_add_del_reply
425 u64 app_event_queue_address;
428 u8 segment_name_length;
429 u8 segment_name[128];
434 /** \brief enable/disable session layer
435 @param client_index - opaque cookie to identify the sender
436 client to vpp direction only
437 @param context - sender context, to match reply w/ request
438 @param is_enable - disable session layer if 0, enable otherwise
440 autoreply define session_enable_disable {
446 /** \brief add/del application namespace
447 @param client_index - opaque cookie to identify the sender
448 client to vpp direction only
449 @param context - sender context, to match reply w/ request
450 @param secret - secret shared between app and vpp
451 @param sw_if_index - local interface that "supports" namespace. Set to
453 @param ip4_fib_id - id of ip4 fib that "supports" the namespace. Ignored
455 @param ip6_fib_id - id of ip6 fib that "supports" the namespace. Ignored
457 @param namespace_id_len - length of namespace id lower
458 @param namespace_id - namespace id
460 define app_namespace_add_del {
471 /** \brief Reply for app namespace add/del
472 @param context - returned sender context, to match reply w/ request
473 @param retval - return code
474 @param appns_index - app namespace index
476 define app_namespace_add_del_reply
483 /** \brief add/del session rule
484 @param client_index - opaque cookie to identify the sender
485 client to vpp direction only
486 @param context - sender context, to match reply w/ request
487 @param transport_proto - transport protocol (0 - tcp 1 - udp)
488 @param is_ip4 - flag to indicate if ip addresses are ip4 or 6
489 @param lcl_ip - local ip
490 @param lcl_plen - local prefix length
491 @param rmt_ip - remote ip
492 @param rmt_ple - remote prefix length
493 @param lcl_port - local port
494 @param rmt_port - remote port
495 @param action_index - the only action defined now is forward to
496 application with index action_index
497 @param is_add - flag to indicate if add or del
498 @param appns_index - application namespace where rule is to be applied to
499 @param scope - flag that indicates scope of the rule: global or local.
500 If 0, default is global, 1 is global 2 is local, 3 is both
502 autoreply define session_rule_add_del {
520 /** \brief Dump session rules
521 @param client_index - opaque cookie to identify the sender
522 @param context - sender context, to match reply w/ request
524 define session_rules_dump
530 /** \brief Session rules details
531 @param context - sender context, to match reply w/ request
532 @param transport_proto - transport protocol (0 - tcp 1 - udp)
533 @param is_ip4 - flag to indicate if ip addresses are ip4 or 6
534 @param lcl_ip - local ip
535 @param lcl_plen - local prefix length
536 @param rmt_ip - remote ip
537 @param rmt_ple - remote prefix length
538 @param lcl_port - local port
539 @param rmt_port - remote port
540 @param action_index - the only action defined now is forward to
541 application with index action_index
542 @param appns_index - application namespace where rule is to be applied to
543 @param scope - flag that indicates scope of the rule: global or local.
544 If 0, default is global, 1 is global 2 is local, 3 is both
546 define session_rules_details
565 * eval: (c-set-style "gnu")