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 *------------------------------------------------------------------
21 #include <map/map_msg_enum.h>
22 #include <vnet/ip/ip.h>
23 #include <vnet/fib/fib_table.h>
24 #include <vlibmemory/api.h>
26 #define vl_typedefs /* define message structures */
27 #include <map/map_all_api_h.h>
30 #define vl_endianfun /* define message structures */
31 #include <map/map_all_api_h.h>
34 /* instantiate all the print functions we know about */
35 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
37 #include <map/map_all_api_h.h>
40 /* Get the API version number */
41 #define vl_api_version(n,v) static u32 api_version=(v);
42 #include <map/map_all_api_h.h>
45 #define REPLY_MSG_ID_BASE mm->msg_id_base
46 #include <vlibapi/api_helper_macros.h>
49 vl_api_map_add_domain_t_handler (vl_api_map_add_domain_t * mp)
51 map_main_t *mm = &map_main;
52 vl_api_map_add_domain_reply_t *rmp;
58 map_create_domain ((ip4_address_t *) & mp->ip4_prefix.prefix,
60 (ip6_address_t *) & mp->ip6_prefix.prefix,
62 (ip6_address_t *) & mp->ip6_src.prefix,
63 mp->ip6_src.len, mp->ea_bits_len, mp->psid_offset,
64 mp->psid_length, &index, ntohs (mp->mtu), flags,
65 vl_api_from_api_string_c (&mp->tag));
68 REPLY_MACRO2(VL_API_MAP_ADD_DOMAIN_REPLY,
70 rmp->index = ntohl(index);
76 vl_api_map_del_domain_t_handler (vl_api_map_del_domain_t * mp)
78 map_main_t *mm = &map_main;
79 vl_api_map_del_domain_reply_t *rmp;
82 rv = map_delete_domain (ntohl (mp->index));
84 REPLY_MACRO (VL_API_MAP_DEL_DOMAIN_REPLY);
88 vl_api_map_add_del_rule_t_handler (vl_api_map_add_del_rule_t * mp)
90 map_main_t *mm = &map_main;
91 vl_api_map_del_domain_reply_t *rmp;
95 map_add_del_psid (ntohl (mp->index), ntohs (mp->psid),
96 (ip6_address_t *) & mp->ip6_dst, mp->is_add);
98 REPLY_MACRO (VL_API_MAP_ADD_DEL_RULE_REPLY);
102 vl_api_map_domain_dump_t_handler (vl_api_map_domain_dump_t * mp)
104 vl_api_map_domain_details_t *rmp;
105 map_main_t *mm = &map_main;
107 map_domain_extra_t *de;
108 vl_api_registration_t *reg;
109 u32 map_domain_index;
111 if (pool_elts (mm->domains) == 0)
114 reg = vl_api_client_index_to_registration (mp->client_index);
119 pool_foreach(d, mm->domains,
123 map_domain_index = d - mm->domains;
124 de = vec_elt_at_index(mm->domain_extras, map_domain_index);
126 len = strnlen_s(de->tag, 64);
128 /* Make sure every field is initiated (or don't skip the clib_memset()) */
129 rmp = vl_msg_api_alloc (sizeof (*rmp) + len);
131 rmp->_vl_msg_id = htons(VL_API_MAP_DOMAIN_DETAILS + mm->msg_id_base);
132 rmp->context = mp->context;
133 rmp->domain_index = htonl(map_domain_index);
134 clib_memcpy(&rmp->ip6_prefix.prefix, &d->ip6_prefix, sizeof(rmp->ip6_prefix.prefix));
135 clib_memcpy(&rmp->ip4_prefix.prefix, &d->ip4_prefix, sizeof(rmp->ip4_prefix.prefix));
136 clib_memcpy(&rmp->ip6_src.prefix, &d->ip6_src, sizeof(rmp->ip6_src.prefix));
137 rmp->ip6_prefix.len = d->ip6_prefix_len;
138 rmp->ip4_prefix.len = d->ip4_prefix_len;
139 rmp->ip6_src.len = d->ip6_src_len;
140 rmp->ea_bits_len = d->ea_bits_len;
141 rmp->psid_offset = d->psid_offset;
142 rmp->psid_length = d->psid_length;
143 rmp->flags = d->flags;
144 rmp->mtu = htons(d->mtu);
146 vl_api_to_api_string (len, de->tag, &rmp->tag );
148 vl_api_send_msg (reg, (u8 *) rmp);
154 vl_api_map_rule_dump_t_handler (vl_api_map_rule_dump_t * mp)
156 vl_api_registration_t *reg;
159 vl_api_map_rule_details_t *rmp;
160 map_main_t *mm = &map_main;
161 u32 domain_index = ntohl (mp->domain_index);
164 if (pool_elts (mm->domains) == 0)
167 d = pool_elt_at_index (mm->domains, domain_index);
173 reg = vl_api_client_index_to_registration (mp->client_index);
177 for (i = 0; i < (0x1 << d->psid_length); i++)
180 if (dst.as_u64[0] == 0 && dst.as_u64[1] == 0)
184 rmp = vl_msg_api_alloc (sizeof (*rmp));
185 clib_memset (rmp, 0, sizeof (*rmp));
186 rmp->_vl_msg_id = ntohs (VL_API_MAP_RULE_DETAILS + mm->msg_id_base);
187 rmp->psid = htons (i);
188 clib_memcpy (&rmp->ip6_dst, &dst, sizeof (rmp->ip6_dst));
189 rmp->context = mp->context;
190 vl_api_send_msg (reg, (u8 *) rmp);
195 vl_api_map_summary_stats_t_handler (vl_api_map_summary_stats_t * mp)
197 vl_api_map_summary_stats_reply_t *rmp;
198 vlib_combined_counter_main_t *cm;
201 u64 total_pkts[VLIB_N_RX_TX];
202 u64 total_bytes[VLIB_N_RX_TX];
203 map_main_t *mm = &map_main;
204 vl_api_registration_t *reg;
206 reg = vl_api_client_index_to_registration (mp->client_index);
210 rmp = vl_msg_api_alloc (sizeof (*rmp));
211 rmp->_vl_msg_id = htons (VL_API_MAP_SUMMARY_STATS_REPLY + mm->msg_id_base);
212 rmp->context = mp->context;
215 if (pool_elts (mm->domains) == 0)
221 clib_memset (total_pkts, 0, sizeof (total_pkts));
222 clib_memset (total_bytes, 0, sizeof (total_bytes));
224 map_domain_counter_lock (mm);
225 vec_foreach (cm, mm->domain_counters)
227 which = cm - mm->domain_counters;
229 for (i = 0; i < vlib_combined_counter_n_counters (cm); i++)
231 vlib_get_combined_counter (cm, i, &v);
232 total_pkts[which] += v.packets;
233 total_bytes[which] += v.bytes;
237 map_domain_counter_unlock (mm);
239 /* Note: in network byte order! */
240 rmp->total_pkts[MAP_DOMAIN_COUNTER_RX] =
241 clib_host_to_net_u64 (total_pkts[MAP_DOMAIN_COUNTER_RX]);
242 rmp->total_bytes[MAP_DOMAIN_COUNTER_RX] =
243 clib_host_to_net_u64 (total_bytes[MAP_DOMAIN_COUNTER_RX]);
244 rmp->total_pkts[MAP_DOMAIN_COUNTER_TX] =
245 clib_host_to_net_u64 (total_pkts[MAP_DOMAIN_COUNTER_TX]);
246 rmp->total_bytes[MAP_DOMAIN_COUNTER_TX] =
247 clib_host_to_net_u64 (total_bytes[MAP_DOMAIN_COUNTER_TX]);
248 rmp->total_bindings = clib_host_to_net_u64 (pool_elts (mm->domains));
249 rmp->total_ip4_fragments = 0; // Not yet implemented. Should be a simple counter.
250 rmp->total_security_check[MAP_DOMAIN_COUNTER_TX] =
251 clib_host_to_net_u64 (map_error_counter_get
252 (ip4_map_node.index, MAP_ERROR_ENCAP_SEC_CHECK));
253 rmp->total_security_check[MAP_DOMAIN_COUNTER_RX] =
254 clib_host_to_net_u64 (map_error_counter_get
255 (ip4_map_node.index, MAP_ERROR_DECAP_SEC_CHECK));
258 vl_api_send_msg (reg, (u8 *) rmp);
263 map_param_set_fragmentation (bool inner, bool ignore_df)
265 map_main_t *mm = &map_main;
267 mm->frag_inner = ! !inner;
268 mm->frag_ignore_df = ! !ignore_df;
274 vl_api_map_param_set_fragmentation_t_handler
275 (vl_api_map_param_set_fragmentation_t * mp)
277 map_main_t *mm = &map_main;
278 vl_api_map_param_set_fragmentation_reply_t *rmp;
281 rv = map_param_set_fragmentation (mp->inner, mp->ignore_df);
283 REPLY_MACRO (VL_API_MAP_PARAM_SET_FRAGMENTATION_REPLY);
288 map_param_set_icmp (ip4_address_t * icmp_src_address)
290 map_main_t *mm = &map_main;
292 if (icmp_src_address == 0)
295 mm->icmp4_src_address = *icmp_src_address;
302 vl_api_map_param_set_icmp_t_handler (vl_api_map_param_set_icmp_t * mp)
304 map_main_t *mm = &map_main;
305 vl_api_map_param_set_icmp_reply_t *rmp;
308 rv = map_param_set_icmp ((ip4_address_t *) & mp->ip4_err_relay_src);
310 REPLY_MACRO (VL_API_MAP_PARAM_SET_ICMP_REPLY);
315 map_param_set_icmp6 (u8 enable_unreachable)
317 map_main_t *mm = &map_main;
319 mm->icmp6_enabled = ! !enable_unreachable;
325 vl_api_map_param_set_icmp6_t_handler (vl_api_map_param_set_icmp6_t * mp)
327 map_main_t *mm = &map_main;
328 vl_api_map_param_set_icmp6_reply_t *rmp;
331 rv = map_param_set_icmp6 (mp->enable_unreachable);
333 REPLY_MACRO (VL_API_MAP_PARAM_SET_ICMP6_REPLY);
338 vl_api_map_param_add_del_pre_resolve_t_handler
339 (vl_api_map_param_add_del_pre_resolve_t * mp)
341 map_main_t *mm = &map_main;
342 vl_api_map_param_add_del_pre_resolve_reply_t *rmp;
345 map_pre_resolve ((ip4_address_t *) & mp->ip4_nh_address,
346 (ip6_address_t *) & mp->ip6_nh_address, !mp->is_add);
348 REPLY_MACRO (VL_API_MAP_PARAM_ADD_DEL_PRE_RESOLVE_REPLY);
353 map_param_set_reassembly (bool is_ipv6,
357 f64 ht_ratio, u32 * reass, u32 * packets)
359 u32 ps_reass = 0, ps_packets = 0;
360 u32 ht_reass = 0, ht_packets = 0;
364 if (pool_size != (u16) ~ 0)
366 if (pool_size > MAP_IP6_REASS_CONF_POOL_SIZE_MAX)
367 return MAP_ERR_BAD_POOL_SIZE;
368 if (map_ip6_reass_conf_pool_size
369 (pool_size, &ps_reass, &ps_packets))
370 return MAP_ERR_BAD_POOL_SIZE;
373 if (ht_ratio != (MAP_IP6_REASS_CONF_HT_RATIO_MAX + 1))
375 if (ht_ratio > MAP_IP6_REASS_CONF_HT_RATIO_MAX)
376 return MAP_ERR_BAD_HT_RATIO;
377 if (map_ip6_reass_conf_ht_ratio (ht_ratio, &ht_reass, &ht_packets))
378 return MAP_ERR_BAD_HT_RATIO;
381 if (lifetime_ms != (u16) ~ 0)
383 if (lifetime_ms > MAP_IP6_REASS_CONF_LIFETIME_MAX)
384 return MAP_ERR_BAD_LIFETIME;
385 if (map_ip6_reass_conf_lifetime (lifetime_ms))
386 return MAP_ERR_BAD_LIFETIME;
391 if (buffers > MAP_IP6_REASS_CONF_BUFFERS_MAX)
392 return MAP_ERR_BAD_BUFFERS;
393 if (map_ip6_reass_conf_buffers (buffers))
394 return MAP_ERR_BAD_BUFFERS;
397 if (map_main.ip6_reass_conf_buffers >
398 map_main.ip6_reass_conf_pool_size *
399 MAP_IP6_REASS_MAX_FRAGMENTS_PER_REASSEMBLY)
401 return MAP_ERR_BAD_BUFFERS_TOO_LARGE;
406 if (pool_size != (u16) ~ 0)
408 if (pool_size > MAP_IP4_REASS_CONF_POOL_SIZE_MAX)
409 return MAP_ERR_BAD_POOL_SIZE;
410 if (map_ip4_reass_conf_pool_size
411 (pool_size, &ps_reass, &ps_packets))
412 return MAP_ERR_BAD_POOL_SIZE;
415 if (ht_ratio != (MAP_IP4_REASS_CONF_HT_RATIO_MAX + 1))
417 if (ht_ratio > MAP_IP4_REASS_CONF_HT_RATIO_MAX)
418 return MAP_ERR_BAD_HT_RATIO;
419 if (map_ip4_reass_conf_ht_ratio (ht_ratio, &ht_reass, &ht_packets))
420 return MAP_ERR_BAD_HT_RATIO;
423 if (lifetime_ms != (u16) ~ 0)
425 if (lifetime_ms > MAP_IP4_REASS_CONF_LIFETIME_MAX)
426 return MAP_ERR_BAD_LIFETIME;
427 if (map_ip4_reass_conf_lifetime (lifetime_ms))
428 return MAP_ERR_BAD_LIFETIME;
433 if (buffers > MAP_IP4_REASS_CONF_BUFFERS_MAX)
434 return MAP_ERR_BAD_BUFFERS;
435 if (map_ip4_reass_conf_buffers (buffers))
436 return MAP_ERR_BAD_BUFFERS;
439 if (map_main.ip4_reass_conf_buffers >
440 map_main.ip4_reass_conf_pool_size *
441 MAP_IP4_REASS_MAX_FRAGMENTS_PER_REASSEMBLY)
443 return MAP_ERR_BAD_BUFFERS_TOO_LARGE;
448 *reass = ps_reass + ht_reass;
451 *packets = ps_packets + ht_packets;
458 vl_api_map_param_set_reassembly_t_handler
459 (vl_api_map_param_set_reassembly_t * mp)
461 map_main_t *mm = &map_main;
462 vl_api_map_param_set_reassembly_reply_t *rmp;
463 u32 reass = 0, packets = 0;
467 ht_ratio = (f64) clib_net_to_host_u64 (mp->ht_ratio);
469 ht_ratio = MAP_IP6_REASS_CONF_HT_RATIO_MAX + 1;
471 rv = map_param_set_reassembly (mp->is_ip6,
472 clib_net_to_host_u16 (mp->lifetime_ms),
473 clib_net_to_host_u16 (mp->pool_size),
474 clib_net_to_host_u32 (mp->buffers),
475 ht_ratio, &reass, &packets);
478 * FIXME: Should the lost reass and packet counts be returned in the API?
481 REPLY_MACRO (VL_API_MAP_PARAM_SET_REASSEMBLY_REPLY);
486 map_param_set_security_check (bool enable, bool fragments)
488 map_main_t *mm = &map_main;
490 mm->sec_check = ! !enable;
491 mm->sec_check_frag = ! !fragments;
497 vl_api_map_param_set_security_check_t_handler
498 (vl_api_map_param_set_security_check_t * mp)
500 map_main_t *mm = &map_main;
501 vl_api_map_param_set_security_check_reply_t *rmp;
504 rv = map_param_set_security_check (mp->enable, mp->fragments);
506 REPLY_MACRO (VL_API_MAP_PARAM_SET_SECURITY_CHECK_REPLY);
511 map_param_set_traffic_class (bool copy, u8 tc)
513 map_main_t *mm = &map_main;
515 mm->tc_copy = ! !copy;
522 vl_api_map_param_set_traffic_class_t_handler
523 (vl_api_map_param_set_traffic_class_t * mp)
525 map_main_t *mm = &map_main;
526 vl_api_map_param_set_traffic_class_reply_t *rmp;
529 rv = map_param_set_traffic_class (mp->copy, mp->class);
531 REPLY_MACRO (VL_API_MAP_PARAM_SET_TRAFFIC_CLASS_REPLY);
536 map_param_set_tcp (u16 tcp_mss)
538 map_main_t *mm = &map_main;
540 mm->tcp_mss = tcp_mss;
547 vl_api_map_param_set_tcp_t_handler (vl_api_map_param_set_tcp_t * mp)
549 map_main_t *mm = &map_main;
550 vl_api_map_param_set_tcp_reply_t *rmp;
553 map_param_set_tcp (ntohs (mp->tcp_mss));
554 REPLY_MACRO (VL_API_MAP_PARAM_SET_TCP_REPLY);
559 vl_api_map_param_get_t_handler (vl_api_map_param_get_t * mp)
561 map_main_t *mm = &map_main;
562 vl_api_map_param_get_reply_t *rmp;
563 vl_api_registration_t *reg;
565 reg = vl_api_client_index_to_registration (mp->client_index);
569 rmp = vl_msg_api_alloc (sizeof (*rmp));
570 rmp->_vl_msg_id = htons (VL_API_MAP_PARAM_GET_REPLY + mm->msg_id_base);
571 rmp->context = mp->context;
574 rmp->frag_inner = mm->frag_inner;
575 rmp->frag_ignore_df = mm->frag_ignore_df;
577 clib_memcpy (&rmp->icmp_ip4_err_relay_src,
578 &mm->icmp4_src_address, sizeof (rmp->icmp_ip4_err_relay_src));
580 rmp->icmp6_enable_unreachable = mm->icmp6_enabled;
583 * FIXME: How are these addresses re-extracted from the FIB?
584 * Or should a local map_main copy be kept?
586 clib_memset (&rmp->ip4_nh_address, 0, sizeof (rmp->ip4_nh_address));
587 clib_memset (&rmp->ip6_nh_address, 0, sizeof (rmp->ip6_nh_address));
589 rmp->ip4_lifetime_ms =
590 clib_net_to_host_u16 (mm->ip4_reass_conf_lifetime_ms);
591 rmp->ip4_pool_size = clib_net_to_host_u16 (mm->ip4_reass_conf_pool_size);
592 rmp->ip4_buffers = clib_net_to_host_u32 (mm->ip4_reass_conf_buffers);
594 clib_net_to_host_u64 ((u64) mm->ip4_reass_conf_ht_ratio);
596 rmp->ip6_lifetime_ms =
597 clib_net_to_host_u16 (mm->ip6_reass_conf_lifetime_ms);
598 rmp->ip6_pool_size = clib_net_to_host_u16 (mm->ip6_reass_conf_pool_size);
599 rmp->ip6_buffers = clib_net_to_host_u32 (mm->ip6_reass_conf_buffers);
601 clib_net_to_host_u64 ((u64) mm->ip6_reass_conf_ht_ratio);
603 rmp->sec_check_enable = mm->sec_check;
604 rmp->sec_check_fragments = mm->sec_check_frag;
606 rmp->tc_copy = mm->tc_copy;
607 rmp->tc_class = mm->tc;
609 vl_api_send_msg (reg, (u8 *) rmp);
614 map_if_enable_disable (bool is_enable, u32 sw_if_index, bool is_translation)
616 map_main_t *mm = &map_main;
618 if (pool_is_free_index (mm->vnet_main->interface_main.sw_interfaces,
620 return VNET_API_ERROR_INVALID_SW_IF_INDEX;
622 is_enable = ! !is_enable;
626 if (clib_bitmap_get (mm->bm_trans_enabled_by_sw_if, sw_if_index)
632 if (clib_bitmap_get (mm->bm_encap_enabled_by_sw_if, sw_if_index)
637 if (is_translation == false)
639 vnet_feature_enable_disable ("ip4-unicast", "ip4-map", sw_if_index,
640 is_enable ? 1 : 0, 0, 0);
641 vnet_feature_enable_disable ("ip6-unicast", "ip6-map", sw_if_index,
642 is_enable ? 1 : 0, 0, 0);
643 mm->bm_encap_enabled_by_sw_if =
644 clib_bitmap_set (mm->bm_encap_enabled_by_sw_if, sw_if_index,
649 vnet_feature_enable_disable ("ip4-unicast", "ip4-map-t", sw_if_index,
650 is_enable ? 1 : 0, 0, 0);
651 vnet_feature_enable_disable ("ip6-unicast", "ip6-map-t", sw_if_index,
652 is_enable ? 1 : 0, 0, 0);
653 mm->bm_trans_enabled_by_sw_if =
654 clib_bitmap_set (mm->bm_trans_enabled_by_sw_if, sw_if_index,
663 vl_api_map_if_enable_disable_t_handler (vl_api_map_if_enable_disable_t * mp)
665 map_main_t *mm = &map_main;
666 vl_api_map_if_enable_disable_reply_t *rmp;
669 VALIDATE_SW_IF_INDEX (mp);
672 map_if_enable_disable (mp->is_enable, htonl (mp->sw_if_index),
675 BAD_SW_IF_INDEX_LABEL;
676 REPLY_MACRO (VL_API_MAP_IF_ENABLE_DISABLE_REPLY);
680 #define foreach_map_plugin_api_msg \
681 _(MAP_ADD_DOMAIN, map_add_domain) \
682 _(MAP_DEL_DOMAIN, map_del_domain) \
683 _(MAP_ADD_DEL_RULE, map_add_del_rule) \
684 _(MAP_DOMAIN_DUMP, map_domain_dump) \
685 _(MAP_RULE_DUMP, map_rule_dump) \
686 _(MAP_IF_ENABLE_DISABLE, map_if_enable_disable) \
687 _(MAP_SUMMARY_STATS, map_summary_stats) \
688 _(MAP_PARAM_SET_FRAGMENTATION, map_param_set_fragmentation) \
689 _(MAP_PARAM_SET_ICMP, map_param_set_icmp) \
690 _(MAP_PARAM_SET_ICMP6, map_param_set_icmp6) \
691 _(MAP_PARAM_ADD_DEL_PRE_RESOLVE, map_param_add_del_pre_resolve) \
692 _(MAP_PARAM_SET_REASSEMBLY, map_param_set_reassembly) \
693 _(MAP_PARAM_SET_SECURITY_CHECK, map_param_set_security_check) \
694 _(MAP_PARAM_SET_TRAFFIC_CLASS, map_param_set_traffic_class) \
695 _(MAP_PARAM_SET_TCP, map_param_set_tcp) \
696 _(MAP_PARAM_GET, map_param_get)
698 #define vl_msg_name_crc_list
699 #include <map/map_all_api_h.h>
700 #undef vl_msg_name_crc_list
703 setup_message_id_table (map_main_t * mm, api_main_t * am)
705 #define _(id,n,crc) \
706 vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id + mm->msg_id_base);
707 foreach_vl_msg_name_crc_map;
711 /* Set up the API message handling tables */
713 map_plugin_api_hookup (vlib_main_t * vm)
715 map_main_t *mm = &map_main;
716 u8 *name = format (0, "map_%08x%c", api_version, 0);
718 /* Ask for a correctly-sized block of API message decode slots */
720 vl_msg_api_get_msg_ids ((char *) name, VL_MSG_FIRST_AVAILABLE);
722 vl_msg_api_set_handlers((VL_API_##N + mm->msg_id_base), \
724 vl_api_##n##_t_handler, \
726 vl_api_##n##_t_endian, \
727 vl_api_##n##_t_print, \
728 sizeof(vl_api_##n##_t), 1);
729 foreach_map_plugin_api_msg;
733 * Set up the (msg_name, crc, message-id) table
735 setup_message_id_table (mm, &api_main);
742 * fd.io coding-style-patch-verification: ON
745 * eval: (c-set-style "gnu")