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.6.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
47 @param app_index - index of the newly created app
48 @param segment_handle - handle for segment
50 define application_attach_reply {
53 u64 app_event_queue_address;
57 u8 segment_name_length;
63 /** \brief Application add TLS certificate
64 @param client_index - opaque cookie to identify the sender
65 @param context - sender context, to match reply w/ request
66 @param cert_len - certificate length
67 @param cert - certificate as a string
69 autoreply define application_tls_cert_add {
77 /** \brief Application add TLS key
78 @param client_index - opaque cookie to identify the sender
79 @param context - sender context, to match reply w/ request
80 @param key_len - certificate length
81 @param key - PEM encoded key as a string
83 autoreply define application_tls_key_add {
91 /** \brief client->vpp, attach application to session layer
92 @param client_index - opaque cookie to identify the sender
93 @param context - sender context, to match reply w/ request
95 autoreply define application_detach {
100 /** \brief vpp->client, please map an additional shared memory segment
101 @param client_index - opaque cookie to identify the sender
102 @param context - sender context, to match reply w/ request
103 @param fd_flags - set of flags that indicate which, if any, fds are
104 to be expected over the socket. This is set only if
105 socket transport available
106 @param segment_size - size of the segment to be mapped
107 @param segment_name - name of the segment to be mapped
108 @param segment_handle - unique identifier for segment
110 autoreply define map_another_segment {
115 u8 segment_name[128];
119 /** \brief vpp->client unmap shared memory segment
120 @param client_index - opaque cookie to identify the sender
121 @param context - sender context, to match reply w/ request
122 @param segment_name - segment name
123 @param segment_handle - handle of the segment to be unmapped
125 autoreply define unmap_segment {
131 /** \brief Bind to a given URI
132 @param client_index - opaque cookie to identify the sender
133 @param context - sender context, to match reply w/ request
134 @param accept_cookie - sender accept cookie, to identify this bind flavor
135 @param uri - a URI, e.g. "tcp://0.0.0.0/0/80" [ipv4]
136 "tcp://::/0/80" [ipv6] etc.
137 @param options - socket options, fifo sizes, etc.
139 autoreply define bind_uri {
146 /** \brief Unbind a given URI
147 @param client_index - opaque cookie to identify the sender
148 @param context - sender context, to match reply w/ request
149 @param uri - a URI, e.g. "tcp://0.0.0.0/0/80" [ipv4]
150 "tcp://::/0/80" [ipv6], etc.
151 @param options - socket options, fifo sizes, etc.
153 autoreply define unbind_uri {
159 /** \brief Connect to a given URI
160 @param client_index - opaque cookie to identify the sender
161 @param context - sender context, to match reply w/ request
162 @param client_queue_address - binary API client queue address. Used by
163 local server when connect was redirected.
164 @param options - socket options, fifo sizes, etc. passed by vpp to the
165 server when redirecting connects
166 @param uri - a URI, e.g. "tcp4://0.0.0.0/0/80"
167 "tcp6://::/0/80" [ipv6], etc.
169 autoreply define connect_uri {
172 u64 client_queue_address;
177 /** \brief bidirectional disconnect API
178 @param client_index - opaque cookie to identify the sender
179 client to vpp direction only
180 @param context - sender context, to match reply w/ request
181 @param handle - session handle obtained from accept/connect
183 define disconnect_session {
189 /** \brief bidirectional disconnect reply API
190 @param client_index - opaque cookie to identify the sender
191 client to vpp direction only
192 @param context - sender context, to match reply w/ request
193 @param retval - return code for the request
194 @param handle - session handle
196 define disconnect_session_reply {
202 /** \brief Bind to an ip:port pair for a given transport protocol
203 @param client_index - opaque cookie to identify the sender
204 @param context - sender context, to match reply w/ request
205 @param wrk_index - index of worker requesting the bind
206 @param vrf - bind namespace
207 @param is_ip4 - flag that is 1 if ip address family is IPv4
208 @param ip - ip address
210 @param proto - protocol 0 - TCP 1 - UDP
211 @param options - socket options, fifo sizes, etc.
213 autoreply define bind_sock {
226 @param client_index - opaque cookie to identify the sender
227 @param context - sender context, to match reply w/ request
228 @param wrk_index - index of worker requesting the bind
229 @param handle - bind handle obtained from bind reply
231 autoreply define unbind_sock {
238 /** \brief Connect to a remote peer
239 @param client_index - opaque cookie to identify the sender
240 @param context - sender context, to match reply w/ request
241 @param wrk_index - worker that requests the connect
242 @param client_queue_address - client's API queue address. Non-zero when
243 used to perform redirects
244 @param options - socket options, fifo sizes, etc. when doing redirects
245 @param vrf - connection namespace
246 @param is_ip4 - flag that is 1 if ip address family is IPv4
247 @param ip - ip address
249 @param proto - protocol 0 - TCP 1 - UDP
250 @param hostname-len - length of hostname
251 @param hostname - destination's hostname. If present, used by protocols
253 @param transport_opts - transport option (e.g. session id for quic).
255 autoreply define connect_sock {
259 u64 client_queue_address;
267 u8 hostname[hostname_len];
271 /** \brief ask app to add a new cut-through registration
272 @param client_index - opaque cookie to identify the sender
273 client to vpp direction only
274 @param context - sender context, to match reply w/ request
275 @param evt_q_address - address of the mq in ssvm segment
276 @param peer_evt_q_address - address of peer's mq in ssvm segment
277 @param wrk_index - index of worker to receive the registration
278 @param n_fds - number of fds exchanged
279 @param fd_flags - flag indicating the fds that will be exchanged over
282 autoreply define app_cut_through_registration_add
287 u64 peer_evt_q_address;
293 /** \brief add/del application worker
294 @param client_index - opaque cookie to identify the sender
295 client to vpp direction only
296 @param context - sender context, to match reply w/ request
297 @param app_index - application index
298 @param wrk_index - worker index, if a delete
299 @param is_add - set if an add
301 define app_worker_add_del
310 /** \brief Reply for app worker add/del
311 @param context - returned sender context, to match reply w/ request
312 @param retval - return code
313 @param wrk_index - worker index, if add
314 @param app_event_queue_address - vpp event queue address of new worker
315 @param n_fds - number of fds exchanged
316 @param fd_flags - set of flags that indicate which fds are to be expected
317 over the socket (set only if socket transport available)
318 @param segment_name_length - length of segment name
319 @param segment_name - name of segment client needs to attach to
320 @param segment_handle - handle for segment
322 define app_worker_add_del_reply
327 u64 app_event_queue_address;
330 u8 segment_name_length;
331 u8 segment_name[128];
336 /** \brief enable/disable session layer
337 @param client_index - opaque cookie to identify the sender
338 client to vpp direction only
339 @param context - sender context, to match reply w/ request
340 @param is_enable - disable session layer if 0, enable otherwise
342 autoreply define session_enable_disable {
348 /** \brief add/del application namespace
349 @param client_index - opaque cookie to identify the sender
350 client to vpp direction only
351 @param context - sender context, to match reply w/ request
352 @param secret - secret shared between app and vpp
353 @param sw_if_index - local interface that "supports" namespace. Set to
355 @param ip4_fib_id - id of ip4 fib that "supports" the namespace. Ignored
357 @param ip6_fib_id - id of ip6 fib that "supports" the namespace. Ignored
359 @param namespace_id_len - length of namespace id lower
360 @param namespace_id - namespace id
362 define app_namespace_add_del {
373 /** \brief Reply for app namespace add/del
374 @param context - returned sender context, to match reply w/ request
375 @param retval - return code
376 @param appns_index - app namespace index
378 define app_namespace_add_del_reply
385 /** \brief add/del session rule
386 @param client_index - opaque cookie to identify the sender
387 client to vpp direction only
388 @param context - sender context, to match reply w/ request
389 @param transport_proto - transport protocol (0 - tcp 1 - udp)
390 @param is_ip4 - flag to indicate if ip addresses are ip4 or 6
391 @param lcl_ip - local ip
392 @param lcl_plen - local prefix length
393 @param rmt_ip - remote ip
394 @param rmt_ple - remote prefix length
395 @param lcl_port - local port
396 @param rmt_port - remote port
397 @param action_index - the only action defined now is forward to
398 application with index action_index
399 @param is_add - flag to indicate if add or del
400 @param appns_index - application namespace where rule is to be applied to
401 @param scope - flag that indicates scope of the rule: global or local.
402 If 0, default is global, 1 is global 2 is local, 3 is both
404 autoreply define session_rule_add_del {
422 /** \brief Dump session rules
423 @param client_index - opaque cookie to identify the sender
424 @param context - sender context, to match reply w/ request
426 define session_rules_dump
432 /** \brief Session rules details
433 @param context - sender context, to match reply w/ request
434 @param transport_proto - transport protocol (0 - tcp 1 - udp)
435 @param is_ip4 - flag to indicate if ip addresses are ip4 or 6
436 @param lcl_ip - local ip
437 @param lcl_plen - local prefix length
438 @param rmt_ip - remote ip
439 @param rmt_ple - remote prefix length
440 @param lcl_port - local port
441 @param rmt_port - remote port
442 @param action_index - the only action defined now is forward to
443 application with index action_index
444 @param appns_index - application namespace where rule is to be applied to
445 @param scope - flag that indicates scope of the rule: global or local.
446 If 0, default is global, 1 is global 2 is local, 3 is both
448 define session_rules_details
467 * eval: (c-set-style "gnu")