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 Application add TLS certificate
112 @param client_index - opaque cookie to identify the sender
113 @param context - sender context, to match reply w/ request
114 @param cert_len - certificate length
115 @param cert - certificate as a string
117 autoreply define application_tls_cert_add {
125 /** \brief Application add TLS key
126 @param client_index - opaque cookie to identify the sender
127 @param context - sender context, to match reply w/ request
128 @param key_len - certificate length
129 @param key - PEM encoded key as a string
131 autoreply define application_tls_key_add {
139 /** \brief client->vpp, attach application to session layer
140 ### WILL BE DEPRECATED POST 20.01 ###
141 @param client_index - opaque cookie to identify the sender
142 @param context - sender context, to match reply w/ request
144 autoreply define application_detach {
149 /** \brief vpp->client, please map an additional shared memory segment
150 @param client_index - opaque cookie to identify the sender
151 @param context - sender context, to match reply w/ request
152 @param fd_flags - set of flags that indicate which, if any, fds are
153 to be expected over the socket. This is set only if
154 socket transport available
155 @param segment_size - size of the segment to be mapped
156 @param segment_name - name of the segment to be mapped
157 @param segment_handle - unique identifier for segment
159 autoreply define map_another_segment {
164 u8 segment_name[128];
168 /** \brief vpp->client unmap shared memory segment
169 @param client_index - opaque cookie to identify the sender
170 @param context - sender context, to match reply w/ request
171 @param segment_name - segment name
172 @param segment_handle - handle of the segment to be unmapped
174 autoreply define unmap_segment {
180 /** \brief Bind to a given URI
181 ### WILL BE DEPRECATED POST 20.01 ###
182 @param client_index - opaque cookie to identify the sender
183 @param context - sender context, to match reply w/ request
184 @param accept_cookie - sender accept cookie, to identify this bind flavor
185 @param uri - a URI, e.g. "tcp://0.0.0.0/0/80" [ipv4]
186 "tcp://::/0/80" [ipv6] etc.
187 @param options - socket options, fifo sizes, etc.
189 autoreply define bind_uri {
196 /** \brief Unbind a given URI
197 ### WILL BE DEPRECATED POST 20.01 ###
198 @param client_index - opaque cookie to identify the sender
199 @param context - sender context, to match reply w/ request
200 @param uri - a URI, e.g. "tcp://0.0.0.0/0/80" [ipv4]
201 "tcp://::/0/80" [ipv6], etc.
202 @param options - socket options, fifo sizes, etc.
204 autoreply define unbind_uri {
210 /** \brief Connect to a given URI
211 ### WILL BE DEPRECATED POST 20.01 ###
212 @param client_index - opaque cookie to identify the sender
213 @param context - sender context, to match reply w/ request
214 @param client_queue_address - binary API client queue address. Used by
215 local server when connect was redirected.
216 @param options - socket options, fifo sizes, etc. passed by vpp to the
217 server when redirecting connects
218 @param uri - a URI, e.g. "tcp4://0.0.0.0/0/80"
219 "tcp6://::/0/80" [ipv6], etc.
221 autoreply define connect_uri {
224 u64 client_queue_address;
229 /** \brief bidirectional disconnect API
230 ### WILL BE DEPRECATED POST 20.01 ###
231 @param client_index - opaque cookie to identify the sender
232 client to vpp direction only
233 @param context - sender context, to match reply w/ request
234 @param handle - session handle obtained from accept/connect
236 define disconnect_session {
242 /** \brief bidirectional disconnect reply API
243 ### WILL BE DEPRECATED POST 20.01 ###
244 @param client_index - opaque cookie to identify the sender
245 client to vpp direction only
246 @param context - sender context, to match reply w/ request
247 @param retval - return code for the request
248 @param handle - session handle
250 define disconnect_session_reply {
256 /** \brief Bind to an ip:port pair for a given transport protocol
257 ### WILL BE DEPRECATED POST 20.01 ###
258 @param client_index - opaque cookie to identify the sender
259 @param context - sender context, to match reply w/ request
260 @param wrk_index - index of worker requesting the bind
261 @param vrf - bind namespace
262 @param is_ip4 - flag that is 1 if ip address family is IPv4
263 @param ip - ip address
265 @param proto - protocol 0 - TCP 1 - UDP
266 @param options - socket options, fifo sizes, etc.
268 autoreply define bind_sock {
281 ### WILL BE DEPRECATED POST 20.01 ###s
282 @param client_index - opaque cookie to identify the sender
283 @param context - sender context, to match reply w/ request
284 @param wrk_index - index of worker requesting the bind
285 @param handle - bind handle obtained from bind reply
287 autoreply define unbind_sock {
294 /** \brief Connect to a remote peer
295 ### WILL BE DEPRECATED POST 20.01 ###
296 @param client_index - opaque cookie to identify the sender
297 @param context - sender context, to match reply w/ request
298 @param wrk_index - worker that requests the connect
299 @param client_queue_address - client's API queue address. Non-zero when
300 used to perform redirects
301 @param options - socket options, fifo sizes, etc. when doing redirects
302 @param vrf - connection namespace
303 @param is_ip4 - flag that is 1 if ip address family is IPv4
304 @param ip - ip address
306 @param proto - protocol 0 - TCP 1 - UDP
307 @param hostname-len - length of hostname
308 @param hostname - destination's hostname. If present, used by protocols
310 @param parent_handle - handle of parent session (e.g. for opening quic streams).
312 autoreply define connect_sock {
316 u64 client_queue_address;
324 u8 hostname[hostname_len];
328 /** \brief ask app to add a new cut-through registration
329 ### WILL BE DEPRECATED POST 20.01 ###
330 @param client_index - opaque cookie to identify the sender
331 client to vpp direction only
332 @param context - sender context, to match reply w/ request
333 @param evt_q_address - address of the mq in ssvm segment
334 @param peer_evt_q_address - address of peer's mq in ssvm segment
335 @param wrk_index - index of worker to receive the registration
336 @param n_fds - number of fds exchanged
337 @param fd_flags - flag indicating the fds that will be exchanged over
340 autoreply define app_cut_through_registration_add
345 u64 peer_evt_q_address;
351 /** \brief add/del application worker
352 @param client_index - opaque cookie to identify the sender
353 client to vpp direction only
354 @param context - sender context, to match reply w/ request
355 @param app_index - application index
356 @param wrk_index - worker index, if a delete
357 @param is_add - set if an add
359 define app_worker_add_del
368 /** \brief Reply for app worker add/del
369 @param context - returned sender context, to match reply w/ request
370 @param retval - return code
371 @param wrk_index - worker index, if add
372 @param app_event_queue_address - vpp event queue address of new worker
373 @param n_fds - number of fds exchanged
374 @param fd_flags - set of flags that indicate which fds are to be expected
375 over the socket (set only if socket transport available)
376 @param segment_name_length - length of segment name
377 @param segment_name - name of segment client needs to attach to
378 @param segment_handle - handle for segment
380 define app_worker_add_del_reply
385 u64 app_event_queue_address;
388 u8 segment_name_length;
389 u8 segment_name[128];
394 /** \brief enable/disable session layer
395 @param client_index - opaque cookie to identify the sender
396 client to vpp direction only
397 @param context - sender context, to match reply w/ request
398 @param is_enable - disable session layer if 0, enable otherwise
400 autoreply define session_enable_disable {
406 /** \brief add/del application namespace
407 @param client_index - opaque cookie to identify the sender
408 client to vpp direction only
409 @param context - sender context, to match reply w/ request
410 @param secret - secret shared between app and vpp
411 @param sw_if_index - local interface that "supports" namespace. Set to
413 @param ip4_fib_id - id of ip4 fib that "supports" the namespace. Ignored
415 @param ip6_fib_id - id of ip6 fib that "supports" the namespace. Ignored
417 @param namespace_id_len - length of namespace id lower
418 @param namespace_id - namespace id
420 define app_namespace_add_del {
431 /** \brief Reply for app namespace add/del
432 @param context - returned sender context, to match reply w/ request
433 @param retval - return code
434 @param appns_index - app namespace index
436 define app_namespace_add_del_reply
443 /** \brief add/del session rule
444 @param client_index - opaque cookie to identify the sender
445 client to vpp direction only
446 @param context - sender context, to match reply w/ request
447 @param transport_proto - transport protocol (0 - tcp 1 - udp)
448 @param is_ip4 - flag to indicate if ip addresses are ip4 or 6
449 @param lcl_ip - local ip
450 @param lcl_plen - local prefix length
451 @param rmt_ip - remote ip
452 @param rmt_ple - remote prefix length
453 @param lcl_port - local port
454 @param rmt_port - remote port
455 @param action_index - the only action defined now is forward to
456 application with index action_index
457 @param is_add - flag to indicate if add or del
458 @param appns_index - application namespace where rule is to be applied to
459 @param scope - flag that indicates scope of the rule: global or local.
460 If 0, default is global, 1 is global 2 is local, 3 is both
462 autoreply define session_rule_add_del {
480 /** \brief Dump session rules
481 @param client_index - opaque cookie to identify the sender
482 @param context - sender context, to match reply w/ request
484 define session_rules_dump
490 /** \brief Session rules details
491 @param context - sender context, to match reply w/ request
492 @param transport_proto - transport protocol (0 - tcp 1 - udp)
493 @param is_ip4 - flag to indicate if ip addresses are ip4 or 6
494 @param lcl_ip - local ip
495 @param lcl_plen - local prefix length
496 @param rmt_ip - remote ip
497 @param rmt_ple - remote prefix length
498 @param lcl_port - local port
499 @param rmt_port - remote port
500 @param action_index - the only action defined now is forward to
501 application with index action_index
502 @param appns_index - application namespace where rule is to be applied to
503 @param scope - flag that indicates scope of the rule: global or local.
504 If 0, default is global, 1 is global 2 is local, 3 is both
506 define session_rules_details
525 * eval: (c-set-style "gnu")