2 *------------------------------------------------------------------
3 * map_api.c - vnet map api
5 * Copyright (c) 2016 Cisco and/or its affiliates.
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at:
10 * http://www.apache.org/licenses/LICENSE-2.0
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
17 *------------------------------------------------------------------
20 #include <vnet/ip/ip_types_api.h>
22 #include <map/map.api_enum.h>
23 #include <map/map.api_types.h>
24 #include <vnet/ip/ip.h>
25 #include <vnet/ip/reass/ip4_sv_reass.h>
26 #include <vnet/ip/reass/ip6_sv_reass.h>
27 #include <vnet/ip/reass/ip6_full_reass.h>
28 #include <vnet/fib/fib_table.h>
29 #include <vlibmemory/api.h>
31 #define REPLY_MSG_ID_BASE mm->msg_id_base
32 #include <vlibapi/api_helper_macros.h>
35 vl_api_map_add_domain_t_handler (vl_api_map_add_domain_t * mp)
37 map_main_t *mm = &map_main;
38 vl_api_map_add_domain_reply_t *rmp;
43 u8 *tag = format (0, "%s", mp->tag);
45 map_create_domain ((ip4_address_t *) & mp->ip4_prefix.address,
47 (ip6_address_t *) & mp->ip6_prefix.address,
49 (ip6_address_t *) & mp->ip6_src.address,
50 mp->ip6_src.len, mp->ea_bits_len, mp->psid_offset,
51 mp->psid_length, &index, ntohs (mp->mtu), flags, tag);
54 REPLY_MACRO2(VL_API_MAP_ADD_DOMAIN_REPLY,
56 rmp->index = ntohl(index);
62 vl_api_map_del_domain_t_handler (vl_api_map_del_domain_t * mp)
64 map_main_t *mm = &map_main;
65 vl_api_map_del_domain_reply_t *rmp;
68 rv = map_delete_domain (ntohl (mp->index));
70 REPLY_MACRO (VL_API_MAP_DEL_DOMAIN_REPLY);
74 vl_api_map_add_del_rule_t_handler (vl_api_map_add_del_rule_t * mp)
76 map_main_t *mm = &map_main;
77 vl_api_map_del_domain_reply_t *rmp;
81 map_add_del_psid (ntohl (mp->index), ntohs (mp->psid),
82 (ip6_address_t *) & mp->ip6_dst, mp->is_add);
84 REPLY_MACRO (VL_API_MAP_ADD_DEL_RULE_REPLY);
88 vl_api_map_domain_dump_t_handler (vl_api_map_domain_dump_t * mp)
90 vl_api_map_domain_details_t *rmp;
91 map_main_t *mm = &map_main;
93 map_domain_extra_t *de;
94 vl_api_registration_t *reg;
97 if (pool_elts (mm->domains) == 0)
100 reg = vl_api_client_index_to_registration (mp->client_index);
105 pool_foreach(d, mm->domains,
107 map_domain_index = d - mm->domains;
108 de = vec_elt_at_index(mm->domain_extras, map_domain_index);
109 int tag_len = clib_min(ARRAY_LEN(rmp->tag), vec_len(de->tag) + 1);
111 /* Make sure every field is initiated (or don't skip the clib_memset()) */
112 rmp = vl_msg_api_alloc (sizeof (*rmp) + tag_len);
114 rmp->_vl_msg_id = htons(VL_API_MAP_DOMAIN_DETAILS + mm->msg_id_base);
115 rmp->context = mp->context;
116 rmp->domain_index = htonl(map_domain_index);
117 clib_memcpy(&rmp->ip6_prefix.address, &d->ip6_prefix, sizeof(rmp->ip6_prefix.address));
118 clib_memcpy(&rmp->ip4_prefix.address, &d->ip4_prefix, sizeof(rmp->ip4_prefix.address));
119 clib_memcpy(&rmp->ip6_src.address, &d->ip6_src, sizeof(rmp->ip6_src.address));
120 rmp->ip6_prefix.len = d->ip6_prefix_len;
121 rmp->ip4_prefix.len = d->ip4_prefix_len;
122 rmp->ip6_src.len = d->ip6_src_len;
123 rmp->ea_bits_len = d->ea_bits_len;
124 rmp->psid_offset = d->psid_offset;
125 rmp->psid_length = d->psid_length;
126 rmp->flags = d->flags;
127 rmp->mtu = htons(d->mtu);
128 memcpy(rmp->tag, de->tag, tag_len-1);
129 rmp->tag[tag_len-1] = '\0';
131 vl_api_send_msg (reg, (u8 *) rmp);
137 vl_api_map_rule_dump_t_handler (vl_api_map_rule_dump_t * mp)
139 vl_api_registration_t *reg;
142 vl_api_map_rule_details_t *rmp;
143 map_main_t *mm = &map_main;
144 u32 domain_index = ntohl (mp->domain_index);
147 if (pool_elts (mm->domains) == 0)
150 d = pool_elt_at_index (mm->domains, domain_index);
156 reg = vl_api_client_index_to_registration (mp->client_index);
160 for (i = 0; i < (0x1 << d->psid_length); i++)
163 if (dst.as_u64[0] == 0 && dst.as_u64[1] == 0)
167 rmp = vl_msg_api_alloc (sizeof (*rmp));
168 clib_memset (rmp, 0, sizeof (*rmp));
169 rmp->_vl_msg_id = ntohs (VL_API_MAP_RULE_DETAILS + mm->msg_id_base);
170 rmp->psid = htons (i);
171 clib_memcpy (&rmp->ip6_dst, &dst, sizeof (rmp->ip6_dst));
172 rmp->context = mp->context;
173 vl_api_send_msg (reg, (u8 *) rmp);
178 vl_api_map_summary_stats_t_handler (vl_api_map_summary_stats_t * mp)
180 vl_api_map_summary_stats_reply_t *rmp;
181 vlib_combined_counter_main_t *cm;
184 u64 total_pkts[VLIB_N_RX_TX];
185 u64 total_bytes[VLIB_N_RX_TX];
186 map_main_t *mm = &map_main;
187 vl_api_registration_t *reg;
189 reg = vl_api_client_index_to_registration (mp->client_index);
193 rmp = vl_msg_api_alloc (sizeof (*rmp));
194 rmp->_vl_msg_id = htons (VL_API_MAP_SUMMARY_STATS_REPLY + mm->msg_id_base);
195 rmp->context = mp->context;
198 if (pool_elts (mm->domains) == 0)
204 clib_memset (total_pkts, 0, sizeof (total_pkts));
205 clib_memset (total_bytes, 0, sizeof (total_bytes));
207 map_domain_counter_lock (mm);
208 vec_foreach (cm, mm->domain_counters)
210 which = cm - mm->domain_counters;
212 for (i = 0; i < vlib_combined_counter_n_counters (cm); i++)
214 vlib_get_combined_counter (cm, i, &v);
215 total_pkts[which] += v.packets;
216 total_bytes[which] += v.bytes;
220 map_domain_counter_unlock (mm);
222 /* Note: in network byte order! */
223 rmp->total_pkts[MAP_DOMAIN_COUNTER_RX] =
224 clib_host_to_net_u64 (total_pkts[MAP_DOMAIN_COUNTER_RX]);
225 rmp->total_bytes[MAP_DOMAIN_COUNTER_RX] =
226 clib_host_to_net_u64 (total_bytes[MAP_DOMAIN_COUNTER_RX]);
227 rmp->total_pkts[MAP_DOMAIN_COUNTER_TX] =
228 clib_host_to_net_u64 (total_pkts[MAP_DOMAIN_COUNTER_TX]);
229 rmp->total_bytes[MAP_DOMAIN_COUNTER_TX] =
230 clib_host_to_net_u64 (total_bytes[MAP_DOMAIN_COUNTER_TX]);
231 rmp->total_bindings = clib_host_to_net_u64 (pool_elts (mm->domains));
232 rmp->total_ip4_fragments = 0; // Not yet implemented. Should be a simple counter.
233 rmp->total_security_check[MAP_DOMAIN_COUNTER_TX] =
234 clib_host_to_net_u64 (map_error_counter_get
235 (ip4_map_node.index, MAP_ERROR_ENCAP_SEC_CHECK));
236 rmp->total_security_check[MAP_DOMAIN_COUNTER_RX] =
237 clib_host_to_net_u64 (map_error_counter_get
238 (ip4_map_node.index, MAP_ERROR_DECAP_SEC_CHECK));
241 vl_api_send_msg (reg, (u8 *) rmp);
246 map_param_set_fragmentation (bool inner, bool ignore_df)
248 map_main_t *mm = &map_main;
250 mm->frag_inner = ! !inner;
251 mm->frag_ignore_df = ! !ignore_df;
257 vl_api_map_param_set_fragmentation_t_handler
258 (vl_api_map_param_set_fragmentation_t * mp)
260 map_main_t *mm = &map_main;
261 vl_api_map_param_set_fragmentation_reply_t *rmp;
264 rv = map_param_set_fragmentation (mp->inner, mp->ignore_df);
266 REPLY_MACRO (VL_API_MAP_PARAM_SET_FRAGMENTATION_REPLY);
271 map_param_set_icmp (ip4_address_t * icmp_src_address)
273 map_main_t *mm = &map_main;
275 if (icmp_src_address == 0)
278 mm->icmp4_src_address = *icmp_src_address;
285 vl_api_map_param_set_icmp_t_handler (vl_api_map_param_set_icmp_t * mp)
287 map_main_t *mm = &map_main;
288 vl_api_map_param_set_icmp_reply_t *rmp;
291 rv = map_param_set_icmp ((ip4_address_t *) & mp->ip4_err_relay_src);
293 REPLY_MACRO (VL_API_MAP_PARAM_SET_ICMP_REPLY);
298 map_param_set_icmp6 (u8 enable_unreachable)
300 map_main_t *mm = &map_main;
302 mm->icmp6_enabled = ! !enable_unreachable;
308 vl_api_map_param_set_icmp6_t_handler (vl_api_map_param_set_icmp6_t * mp)
310 map_main_t *mm = &map_main;
311 vl_api_map_param_set_icmp6_reply_t *rmp;
314 rv = map_param_set_icmp6 (mp->enable_unreachable);
316 REPLY_MACRO (VL_API_MAP_PARAM_SET_ICMP6_REPLY);
321 vl_api_map_param_add_del_pre_resolve_t_handler
322 (vl_api_map_param_add_del_pre_resolve_t * mp)
324 map_main_t *mm = &map_main;
325 vl_api_map_param_add_del_pre_resolve_reply_t *rmp;
328 map_pre_resolve ((ip4_address_t *) & mp->ip4_nh_address,
329 (ip6_address_t *) & mp->ip6_nh_address, !mp->is_add);
331 REPLY_MACRO (VL_API_MAP_PARAM_ADD_DEL_PRE_RESOLVE_REPLY);
335 map_param_set_security_check (bool enable, bool fragments)
337 map_main_t *mm = &map_main;
339 mm->sec_check = ! !enable;
340 mm->sec_check_frag = ! !fragments;
346 vl_api_map_param_set_security_check_t_handler
347 (vl_api_map_param_set_security_check_t * mp)
349 map_main_t *mm = &map_main;
350 vl_api_map_param_set_security_check_reply_t *rmp;
353 rv = map_param_set_security_check (mp->enable, mp->fragments);
355 REPLY_MACRO (VL_API_MAP_PARAM_SET_SECURITY_CHECK_REPLY);
360 map_param_set_traffic_class (bool copy, u8 tc)
362 map_main_t *mm = &map_main;
364 mm->tc_copy = ! !copy;
371 vl_api_map_param_set_traffic_class_t_handler
372 (vl_api_map_param_set_traffic_class_t * mp)
374 map_main_t *mm = &map_main;
375 vl_api_map_param_set_traffic_class_reply_t *rmp;
378 rv = map_param_set_traffic_class (mp->copy, mp->tc_class);
380 REPLY_MACRO (VL_API_MAP_PARAM_SET_TRAFFIC_CLASS_REPLY);
385 map_param_set_tcp (u16 tcp_mss)
387 map_main_t *mm = &map_main;
389 mm->tcp_mss = tcp_mss;
396 vl_api_map_param_set_tcp_t_handler (vl_api_map_param_set_tcp_t * mp)
398 map_main_t *mm = &map_main;
399 vl_api_map_param_set_tcp_reply_t *rmp;
402 map_param_set_tcp (ntohs (mp->tcp_mss));
403 REPLY_MACRO (VL_API_MAP_PARAM_SET_TCP_REPLY);
408 vl_api_map_param_get_t_handler (vl_api_map_param_get_t * mp)
410 map_main_t *mm = &map_main;
411 vl_api_map_param_get_reply_t *rmp;
412 vl_api_registration_t *reg;
414 reg = vl_api_client_index_to_registration (mp->client_index);
418 rmp = vl_msg_api_alloc (sizeof (*rmp));
419 rmp->_vl_msg_id = htons (VL_API_MAP_PARAM_GET_REPLY + mm->msg_id_base);
420 rmp->context = mp->context;
423 rmp->frag_inner = mm->frag_inner;
424 rmp->frag_ignore_df = mm->frag_ignore_df;
426 clib_memcpy (&rmp->icmp_ip4_err_relay_src,
427 &mm->icmp4_src_address, sizeof (rmp->icmp_ip4_err_relay_src));
429 rmp->icmp6_enable_unreachable = mm->icmp6_enabled;
432 * FIXME: How are these addresses re-extracted from the FIB?
433 * Or should a local map_main copy be kept?
435 clib_memset (&rmp->ip4_nh_address, 0, sizeof (rmp->ip4_nh_address));
436 clib_memset (&rmp->ip6_nh_address, 0, sizeof (rmp->ip6_nh_address));
438 rmp->sec_check_enable = mm->sec_check;
439 rmp->sec_check_fragments = mm->sec_check_frag;
441 rmp->tc_copy = mm->tc_copy;
442 rmp->tc_class = mm->tc;
444 vl_api_send_msg (reg, (u8 *) rmp);
449 map_if_enable_disable (bool is_enable, u32 sw_if_index, bool is_translation)
451 map_main_t *mm = &map_main;
453 if (pool_is_free_index (mm->vnet_main->interface_main.sw_interfaces,
455 return VNET_API_ERROR_INVALID_SW_IF_INDEX;
457 is_enable = ! !is_enable;
461 if (clib_bitmap_get (mm->bm_trans_enabled_by_sw_if, sw_if_index)
467 if (clib_bitmap_get (mm->bm_encap_enabled_by_sw_if, sw_if_index)
472 if (is_translation == false)
474 ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, is_enable);
475 ip6_full_reass_enable_disable_with_refcnt (sw_if_index, is_enable);
476 vnet_feature_enable_disable ("ip4-unicast", "ip4-map", sw_if_index,
477 is_enable ? 1 : 0, 0, 0);
478 vnet_feature_enable_disable ("ip6-unicast", "ip6-map", sw_if_index,
479 is_enable ? 1 : 0, 0, 0);
480 mm->bm_encap_enabled_by_sw_if =
481 clib_bitmap_set (mm->bm_encap_enabled_by_sw_if, sw_if_index,
486 ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, is_enable);
487 ip6_sv_reass_enable_disable_with_refcnt (sw_if_index, is_enable);
488 vnet_feature_enable_disable ("ip4-unicast", "ip4-map-t", sw_if_index,
489 is_enable ? 1 : 0, 0, 0);
490 vnet_feature_enable_disable ("ip6-unicast", "ip6-map-t", sw_if_index,
491 is_enable ? 1 : 0, 0, 0);
492 mm->bm_trans_enabled_by_sw_if =
493 clib_bitmap_set (mm->bm_trans_enabled_by_sw_if, sw_if_index,
502 vl_api_map_if_enable_disable_t_handler (vl_api_map_if_enable_disable_t * mp)
504 map_main_t *mm = &map_main;
505 vl_api_map_if_enable_disable_reply_t *rmp;
508 VALIDATE_SW_IF_INDEX (mp);
511 map_if_enable_disable (mp->is_enable, htonl (mp->sw_if_index),
514 BAD_SW_IF_INDEX_LABEL;
515 REPLY_MACRO (VL_API_MAP_IF_ENABLE_DISABLE_REPLY);
518 /* API definitions */
519 #include <vnet/format_fns.h>
520 #include <map/map.api.c>
522 /* Set up the API message handling tables */
524 map_plugin_api_hookup (vlib_main_t * vm)
526 map_main_t *mm = &map_main;
528 mm->msg_id_base = setup_message_id_table ();
533 * fd.io coding-style-patch-verification: ON
536 * eval: (c-set-style "gnu")