FD.io VPP  v17.04-9-g99c0734
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 
17 /** \brief Add MAP domains
18  @param client_index - opaque cookie to identify the sender
19  @param context - sender context, to match reply w/ request
20  @param ip6_prefix - Rule IPv6 prefix
21  @param ip4_prefix - Rule IPv4 prefix
22  @param ip6_src - MAP domain IPv6 BR address / Tunnel source
23  @param ip6_prefix_len - Rule IPv6 prefix length
24  @param ip4_prefix_len - Rule IPv4 prefix length
25  @param ea_bits_len - Embedded Address bits length
26  @param psid_offset - Port Set Identifider (PSID) offset
27  @param psid_length - PSID length
28  @param is_translation - MAP-E / MAP-T
29  @param mtu - MTU
30 */
31 define map_add_domain
32 {
35  u8 ip6_prefix[16];
36  u8 ip4_prefix[4];
37  u8 ip6_src[16];
46 };
47 
48 /** \brief Reply for MAP domain add
49  @param context - returned sender context, to match reply w/ request
50  @param index - MAP domain index
51  @param retval - return code
52 */
53 define map_add_domain_reply
54 {
58 };
59 
60 /** \brief Delete MAP domain
61  @param client_index - opaque cookie to identify the sender
62  @param context - sender context, to match reply w/ request
63  @param index - MAP Domain index
64 */
65 define map_del_domain
66 {
70 };
71 
72 /** \brief Reply for MAP domain del
73  @param context - returned sender context, to match reply w/ request
74  @param retval - return code
75 */
76 define map_del_domain_reply
77 {
80 };
81 
82 /** \brief Add or Delete MAP rule from a domain (Only used for shared IPv4 per subscriber)
83  @param client_index - opaque cookie to identify the sender
84  @param context - sender context, to match reply w/ request
85  @param index - MAP Domain index
86  @param is_add - If 1 add rule, if 0 delete rule
87  @param ip6_dst - MAP CE IPv6 address
88  @param psid - Rule PSID
89 */
90 define map_add_del_rule
91 {
96  u8 ip6_dst[16];
98 };
99 
100 /** \brief Reply for MAP rule add/del
101  @param context - returned sender context, to match reply w/ request
102  @param retval - return code
103 */
104 define map_add_del_rule_reply
105 {
108 };
109 
110 /** \brief Get list of map domains
111  @param client_index - opaque cookie to identify the sender
112 */
113 define map_domain_dump
114 {
117 };
118 
119 define map_domain_details
120 {
123  u8 ip6_prefix[16];
124  u8 ip4_prefix[4];
125  u8 ip6_src[16];
135 };
136 
137 define map_rule_dump
138 {
142 };
143 
144 define map_rule_details
145 {
147  u8 ip6_dst[16];
149 };
150 
151 /** \brief Request for a single block of summary stats
152  @param client_index - opaque cookie to identify the sender
153  @param context - sender context, to match reply w/ request
154 */
155 define map_summary_stats
156 {
159 };
160 
161 /** \brief Reply for map_summary_stats request
162  @param context - sender context, to match reply w/ request
163  @param retval - return code for request
164  @param total_bindings -
165  @param total_pkts -
166  @param total_ip4_fragments -
167  @param total_security_check -
168 */
169 define map_summary_stats_reply
170 {
174  u64 total_pkts[2];
175  u64 total_bytes[2];
177  u64 total_security_check[2];
178 };
int i32
Definition: types.h:81
unsigned long u64
Definition: types.h:89
unsigned int u32
Definition: types.h:88
unsigned short u16
Definition: types.h:57
unsigned char u8
Definition: types.h:56