src/vnet/ip-neighbor/ip4_neighbor.c

   1 /*
   2  * Copyright (c) 2015 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  * ip/ip4_forward.c: IP v4 forwarding
  17  *
  18  * Copyright (c) 2008 Eliot Dresselhaus
  19  *
  20  * Permission is hereby granted, free of charge, to any person obtaining
  21  * a copy of this software and associated documentation files (the
  22  * "Software"), to deal in the Software without restriction, including
  23  * without limitation the rights to use, copy, modify, merge, publish,
  24  * distribute, sublicense, and/or sell copies of the Software, and to
  25  * permit persons to whom the Software is furnished to do so, subject to
  26  * the following conditions:
  27  *
  28  * The above copyright notice and this permission notice shall be
  29  * included in all copies or substantial portions of the Software.
  30  *
  31  *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  32  *  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  33  *  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  34  *  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  35  *  LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  36  *  OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  37  *  WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  38  */
  39
  40 #include <vnet/ip-neighbor/ip4_neighbor.h>
  41 #include <vnet/ethernet/ethernet.h>
  42 #include <vnet/util/throttle.h>
  43 #include <vnet/fib/fib_sas.h>
  44
  45 /** ARP throttling */
  46 static throttle_t arp_throttle;
  47
  48 void
  49 ip4_neighbor_probe_dst (u32 sw_if_index, const ip4_address_t * dst)
  50 {
  51   ip4_address_t src;
  52   adj_index_t ai;
  53
  54   /* any glean will do, it's just for the rewrite */
  55   ai = adj_glean_get (FIB_PROTOCOL_IP4, sw_if_index, NULL);
  56
  57   if (ADJ_INDEX_INVALID != ai && fib_sas4_get (sw_if_index, dst, &src))
  58     ip4_neighbor_probe (vlib_get_main (),
  59                         vnet_get_main (), adj_get (ai), &src, dst);
  60 }
  61
  62 void
  63 ip4_neighbor_advertise (vlib_main_t * vm,
  64                         vnet_main_t * vnm,
  65                         u32 sw_if_index, const ip4_address_t * addr)
  66 {
  67   vnet_hw_interface_t *hi = vnet_get_sup_hw_interface (vnm, sw_if_index);
  68   ip4_main_t *i4m = &ip4_main;
  69   u8 *rewrite, rewrite_len;
  70   ip4_address_t tmp;
  71
  72   if (NULL == addr)
  73     {
  74       fib_sas4_get (sw_if_index, NULL, &tmp);
  75       addr = &tmp;
  76     }
  77
  78   if (addr)
  79     {
  80       clib_warning ("Sending GARP for IP4 address %U on sw_if_idex %d",
  81                     format_ip4_address, addr, sw_if_index);
  82
  83       /* Form GARP packet for output - Gratuitous ARP is an ARP request packet
  84          where the interface IP/MAC pair is used for both source and request
  85          MAC/IP pairs in the request */
  86       u32 bi = 0;
  87       ethernet_arp_header_t *h = vlib_packet_template_get_packet
  88         (vm, &i4m->ip4_arp_request_packet_template, &bi);
  89
  90       if (!h)
  91         return;
  92
  93       mac_address_from_bytes (&h->ip4_over_ethernet[0].mac, hi->hw_address);
  94       mac_address_from_bytes (&h->ip4_over_ethernet[1].mac, hi->hw_address);
  95       h->ip4_over_ethernet[0].ip4 = addr[0];
  96       h->ip4_over_ethernet[1].ip4 = addr[0];
  97
  98       /* Setup MAC header with ARP Etype and broadcast DMAC */
  99       vlib_buffer_t *b = vlib_get_buffer (vm, bi);
 100       rewrite =
 101         ethernet_build_rewrite (vnm, sw_if_index, VNET_LINK_ARP,
 102                                 VNET_REWRITE_FOR_SW_INTERFACE_ADDRESS_BROADCAST);
 103       rewrite_len = vec_len (rewrite);
 104       vlib_buffer_advance (b, -rewrite_len);
 105       ethernet_header_t *e = vlib_buffer_get_current (b);
 106       clib_memcpy_fast (e->dst_address, rewrite, rewrite_len);
 107       vec_free (rewrite);
 108
 109       /* Send GARP packet out the specified interface */
 110       vnet_buffer (b)->sw_if_index[VLIB_RX] =
 111         vnet_buffer (b)->sw_if_index[VLIB_TX] = sw_if_index;
 112       vlib_frame_t *f = vlib_get_frame_to_node (vm, hi->output_node_index);
 113       u32 *to_next = vlib_frame_vector_args (f);
 114       to_next[0] = bi;
 115       f->n_vectors = 1;
 116       vlib_put_frame_to_node (vm, hi->output_node_index, f);
 117     }
 118 }
 119
 120 always_inline uword
 121 ip4_arp_inline (vlib_main_t * vm,
 122                 vlib_node_runtime_t * node,
 123                 vlib_frame_t * frame, int is_glean)
 124 {
 125   vnet_main_t *vnm = vnet_get_main ();
 126   u32 *from, *to_next_drop;
 127   uword n_left_from, n_left_to_next_drop, next_index;
 128   u32 thread_index = vm->thread_index;
 129   u64 seed;
 130
 131   if (node->flags & VLIB_NODE_FLAG_TRACE)
 132     ip4_forward_next_trace (vm, node, frame, VLIB_TX);
 133
 134   seed = throttle_seed (&arp_throttle, thread_index, vlib_time_now (vm));
 135
 136   from = vlib_frame_vector_args (frame);
 137   n_left_from = frame->n_vectors;
 138   next_index = node->cached_next_index;
 139   if (next_index == IP4_ARP_NEXT_DROP)
 140     next_index = IP4_ARP_N_NEXT;        /* point to first interface */
 141
 142   while (n_left_from > 0)
 143     {
 144       vlib_get_next_frame (vm, node, IP4_ARP_NEXT_DROP,
 145                            to_next_drop, n_left_to_next_drop);
 146
 147       while (n_left_from > 0 && n_left_to_next_drop > 0)
 148         {
 149           u32 pi0, adj_index0, sw_if_index0;
 150           ip4_address_t resolve0, src0;
 151           vlib_buffer_t *p0, *b0;
 152           ip_adjacency_t *adj0;
 153           u64 r0;
 154
 155           pi0 = from[0];
 156           p0 = vlib_get_buffer (vm, pi0);
 157
 158           from += 1;
 159           n_left_from -= 1;
 160           to_next_drop[0] = pi0;
 161           to_next_drop += 1;
 162           n_left_to_next_drop -= 1;
 163
 164           adj_index0 = vnet_buffer (p0)->ip.adj_index[VLIB_TX];
 165           adj0 = adj_get (adj_index0);
 166           sw_if_index0 = adj0->rewrite_header.sw_if_index;
 167
 168           if (is_glean)
 169             {
 170               /* resolve the packet's destination */
 171               ip4_header_t *ip0 = vlib_buffer_get_current (p0);
 172               resolve0 = ip0->dst_address;
 173               src0 = adj0->sub_type.glean.rx_pfx.fp_addr.ip4;
 174             }
 175           else
 176             {
 177               /* resolve the incomplete adj */
 178               resolve0 = adj0->sub_type.nbr.next_hop.ip4;
 179               /* Src IP address in ARP header. */
 180               if (!fib_sas4_get (sw_if_index0, &resolve0, &src0))
 181                 {
 182                   /* No source address available */
 183                   p0->error = node->errors[IP4_ARP_ERROR_NO_SOURCE_ADDRESS];
 184                   continue;
 185                 }
 186             }
 187
 188           /* combine the address and interface for the hash key */
 189           r0 = (u64) resolve0.data_u32 << 32;
 190           r0 |= sw_if_index0;
 191
 192           if (throttle_check (&arp_throttle, thread_index, r0, seed))
 193             {
 194               p0->error = node->errors[IP4_ARP_ERROR_THROTTLED];
 195               continue;
 196             }
 197
 198           /*
 199            * the adj has been updated to a rewrite but the node the DPO that got
 200            * us here hasn't - yet. no big deal. we'll drop while we wait.
 201            */
 202           if (IP_LOOKUP_NEXT_REWRITE == adj0->lookup_next_index)
 203             {
 204               p0->error = node->errors[IP4_ARP_ERROR_RESOLVED];
 205               continue;
 206             }
 207
 208           /*
 209            * Can happen if the control-plane is programming tables
 210            * with traffic flowing; at least that's today's lame excuse.
 211            */
 212           if ((is_glean && adj0->lookup_next_index != IP_LOOKUP_NEXT_GLEAN)
 213               || (!is_glean && adj0->lookup_next_index != IP_LOOKUP_NEXT_ARP))
 214             {
 215               p0->error = node->errors[IP4_ARP_ERROR_NON_ARP_ADJ];
 216               continue;
 217             }
 218
 219           /* Send ARP request. */
 220           b0 = ip4_neighbor_probe (vm, vnm, adj0, &src0, &resolve0);
 221
 222           if (PREDICT_TRUE (NULL != b0))
 223             {
 224               /* copy the persistent fields from the original */
 225               clib_memcpy_fast (b0->opaque2, p0->opaque2,
 226                                 sizeof (p0->opaque2));
 227               p0->error = node->errors[IP4_ARP_ERROR_REQUEST_SENT];
 228             }
 229           else
 230             {
 231               p0->error = node->errors[IP4_ARP_ERROR_NO_BUFFERS];
 232               continue;
 233             }
 234         }
 235
 236       vlib_put_next_frame (vm, node, IP4_ARP_NEXT_DROP, n_left_to_next_drop);
 237     }
 238
 239   return frame->n_vectors;
 240 }
 241
 242 VLIB_NODE_FN (ip4_arp_node) (vlib_main_t * vm, vlib_node_runtime_t * node,
 243                              vlib_frame_t * frame)
 244 {
 245   return (ip4_arp_inline (vm, node, frame, 0));
 246 }
 247
 248 VLIB_NODE_FN (ip4_glean_node) (vlib_main_t * vm, vlib_node_runtime_t * node,
 249                                vlib_frame_t * frame)
 250 {
 251   return (ip4_arp_inline (vm, node, frame, 1));
 252 }
 253
 254 static char *ip4_arp_error_strings[] = {
 255   [IP4_ARP_ERROR_THROTTLED] = "ARP requests throttled",
 256   [IP4_ARP_ERROR_RESOLVED] = "ARP requests resolved",
 257   [IP4_ARP_ERROR_NO_BUFFERS] = "ARP requests out of buffer",
 258   [IP4_ARP_ERROR_REQUEST_SENT] = "ARP requests sent",
 259   [IP4_ARP_ERROR_NON_ARP_ADJ] = "ARPs to non-ARP adjacencies",
 260   [IP4_ARP_ERROR_NO_SOURCE_ADDRESS] = "no source address for ARP request",
 261 };
 262
 263 /* *INDENT-OFF* */
 264 VLIB_REGISTER_NODE (ip4_arp_node) =
 265 {
 266   .name = "ip4-arp",
 267   .vector_size = sizeof (u32),
 268   .format_trace = format_ip4_forward_next_trace,
 269   .n_errors = ARRAY_LEN (ip4_arp_error_strings),
 270   .error_strings = ip4_arp_error_strings,
 271   .n_next_nodes = IP4_ARP_N_NEXT,
 272   .next_nodes = {
 273     [IP4_ARP_NEXT_DROP] = "ip4-drop",
 274   },
 275 };
 276
 277 VLIB_REGISTER_NODE (ip4_glean_node) =
 278 {
 279   .name = "ip4-glean",
 280   .vector_size = sizeof (u32),
 281   .format_trace = format_ip4_forward_next_trace,
 282   .n_errors = ARRAY_LEN (ip4_arp_error_strings),
 283   .error_strings = ip4_arp_error_strings,
 284   .n_next_nodes = IP4_ARP_N_NEXT,
 285   .next_nodes = {
 286     [IP4_ARP_NEXT_DROP] = "ip4-drop",
 287   },
 288 };
 289 /* *INDENT-ON* */
 290
 291 #define foreach_notrace_ip4_arp_error           \
 292 _(THROTTLED)                                    \
 293 _(RESOLVED)                                     \
 294 _(NO_BUFFERS)                                   \
 295 _(REQUEST_SENT)                                 \
 296 _(NON_ARP_ADJ)                                  \
 297 _(NO_SOURCE_ADDRESS)
 298
 299 static clib_error_t *
 300 arp_notrace_init (vlib_main_t * vm)
 301 {
 302   vlib_node_runtime_t *rt = vlib_node_get_runtime (vm, ip4_arp_node.index);
 303
 304   /* don't trace ARP request packets */
 305 #define _(a)                                    \
 306     vnet_pcap_drop_trace_filter_add_del         \
 307         (rt->errors[IP4_ARP_ERROR_##a],         \
 308          1 /* is_add */);
 309   foreach_notrace_ip4_arp_error;
 310 #undef _
 311   return 0;
 312 }
 313
 314 VLIB_INIT_FUNCTION (arp_notrace_init);
 315
 316 static clib_error_t *
 317 ip4_neighbor_main_loop_enter (vlib_main_t * vm)
 318 {
 319   vlib_thread_main_t *tm = &vlib_thread_main;
 320   u32 n_vlib_mains = tm->n_vlib_mains;
 321
 322   throttle_init (&arp_throttle, n_vlib_mains, 1e-3);
 323
 324   return (NULL);
 325 }
 326
 327 VLIB_MAIN_LOOP_ENTER_FUNCTION (ip4_neighbor_main_loop_enter);
 328
 329
 330 /*
 331  * fd.io coding-style-patch-verification: ON
 332  *
 333  * Local Variables:
 334  * eval: (c-set-style "gnu")
 335  * End:
 336  */