FD.io VPP  v18.04-17-g3a0d853
Vector Packet Processing
map.api
Go to the documentation of this file.
1 /*
2  * Copyright (c) 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:
6  *
7  * http://www.apache.org/licenses/LICENSE-2.0
8  *
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.
14  */
15 
16 option version = "1.1.0";
17 
18 /** \brief Add MAP domains
19  @param client_index - opaque cookie to identify the sender
20  @param context - sender context, to match reply w/ request
21  @param ip6_prefix - Rule IPv6 prefix
22  @param ip4_prefix - Rule IPv4 prefix
23  @param ip6_src - MAP domain IPv6 BR address / Tunnel source
24  @param ip6_prefix_len - Rule IPv6 prefix length
25  @param ip4_prefix_len - Rule IPv4 prefix length
26  @param ea_bits_len - Embedded Address bits length
27  @param psid_offset - Port Set Identifider (PSID) offset
28  @param psid_length - PSID length
29  @param is_translation - MAP-E / MAP-T
30  @param is_rfc6052 - rfc6052 translation
31  @param mtu - MTU
32 */
33 define map_add_domain
34 {
37  u8 ip6_prefix[16];
38  u8 ip4_prefix[4];
39  u8 ip6_src[16];
49 };
50 
51 /** \brief Reply for MAP domain add
52  @param context - returned sender context, to match reply w/ request
53  @param index - MAP domain index
54  @param retval - return code
55 */
56 define map_add_domain_reply
57 {
61 };
62 
63 /** \brief Delete MAP domain
64  @param client_index - opaque cookie to identify the sender
65  @param context - sender context, to match reply w/ request
66  @param index - MAP Domain index
67 */
68 autoreply define map_del_domain
69 {
73 };
74 
75 
76 /** \brief Add or Delete MAP rule from a domain (Only used for shared IPv4 per subscriber)
77  @param client_index - opaque cookie to identify the sender
78  @param context - sender context, to match reply w/ request
79  @param index - MAP Domain index
80  @param is_add - If 1 add rule, if 0 delete rule
81  @param ip6_dst - MAP CE IPv6 address
82  @param psid - Rule PSID
83 */
84 autoreply define map_add_del_rule
85 {
90  u8 ip6_dst[16];
92 };
93 
94 
95 /** \brief Get list of map domains
96  @param client_index - opaque cookie to identify the sender
97 */
98 define map_domain_dump
99 {
102 };
103 
104 define map_domain_details
105 {
108  u8 ip6_prefix[16];
109  u8 ip4_prefix[4];
110  u8 ip6_src[16];
120 };
121 
122 define map_rule_dump
123 {
127 };
128 
129 define map_rule_details
130 {
132  u8 ip6_dst[16];
134 };
135 
136 /** \brief Request for a single block of summary stats
137  @param client_index - opaque cookie to identify the sender
138  @param context - sender context, to match reply w/ request
139 */
140 define map_summary_stats
141 {
144 };
145 
146 /** \brief Reply for map_summary_stats request
147  @param context - sender context, to match reply w/ request
148  @param retval - return code for request
149  @param total_bindings -
150  @param total_pkts -
151  @param total_ip4_fragments -
152  @param total_security_check -
153 */
154 define map_summary_stats_reply
155 {
159  u64 total_pkts[2];
160  u64 total_bytes[2];
162  u64 total_security_check[2];
163 };
int i32
Definition: types.h:81
unsigned long u64
Definition: types.h:89
option version
Definition: map.api:16
unsigned int u32
Definition: types.h:88
unsigned short u16
Definition: types.h:57
unsigned char u8
Definition: types.h:56