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 VLIB_REGISTER_LOG_CLASS (ip4_neighbor_log, static) = {
  49   .class_name = "ip4",
  50   .subclass_name = "neighbor",
  51 };
  52
  53 #define log_debug(fmt, ...)                                                   \
  54   vlib_log_debug (ip4_neighbor_log.class, fmt, __VA_ARGS__)
  55
  56 void
  57 ip4_neighbor_probe_dst (u32 sw_if_index, const ip4_address_t * dst)
  58 {
  59   ip4_address_t src;
  60   adj_index_t ai;
  61
  62   /* any glean will do, it's just for the rewrite */
  63   ai = adj_glean_get (FIB_PROTOCOL_IP4, sw_if_index, NULL);
  64
  65   if (ADJ_INDEX_INVALID != ai && fib_sas4_get (sw_if_index, dst, &src))
  66     ip4_neighbor_probe (vlib_get_main (),
  67                         vnet_get_main (), adj_get (ai), &src, dst);
  68 }
  69
  70 void
  71 ip4_neighbor_advertise (vlib_main_t * vm,
  72                         vnet_main_t * vnm,
  73                         u32 sw_if_index, const ip4_address_t * addr)
  74 {
  75   vnet_hw_interface_t *hi = vnet_get_sup_hw_interface (vnm, sw_if_index);
  76   ip4_main_t *i4m = &ip4_main;
  77   u8 *rewrite, rewrite_len;
  78   ip4_address_t tmp;
  79
  80   if (NULL == addr)
  81     {
  82       fib_sas4_get (sw_if_index, NULL, &tmp);
  83       addr = &tmp;
  84     }
  85
  86   if (addr)
  87     {
  88       log_debug ("Sending GARP for IP4 address %U on sw_if_idex %d",
  89                  format_ip4_address, addr, sw_if_index);
  90
  91       /* Form GARP packet for output - Gratuitous ARP is an ARP request packet
  92          where the interface IP/MAC pair is used for both source and request
  93          MAC/IP pairs in the request */
  94       u32 bi = 0;
  95       ethernet_arp_header_t *h = vlib_packet_template_get_packet
  96         (vm, &i4m->ip4_arp_request_packet_template, &bi);
  97
  98       if (!h)
  99         return;
 100
 101       mac_address_from_bytes (&h->ip4_over_ethernet[0].mac, hi->hw_address);
 102       mac_address_from_bytes (&h->ip4_over_ethernet[1].mac, hi->hw_address);
 103       h->ip4_over_ethernet[0].ip4 = addr[0];
 104       h->ip4_over_ethernet[1].ip4 = addr[0];
 105
 106       /* Setup MAC header with ARP Etype and broadcast DMAC */
 107       vlib_buffer_t *b = vlib_get_buffer (vm, bi);
 108       rewrite =
 109         ethernet_build_rewrite (vnm, sw_if_index, VNET_LINK_ARP,
 110                                 VNET_REWRITE_FOR_SW_INTERFACE_ADDRESS_BROADCAST);
 111       rewrite_len = vec_len (rewrite);
 112       vlib_buffer_advance (b, -rewrite_len);
 113       ethernet_header_t *e = vlib_buffer_get_current (b);
 114       clib_memcpy_fast (e->dst_address, rewrite, rewrite_len);
 115       vec_free (rewrite);
 116
 117       /* Send GARP packet out the specified interface */
 118       vnet_buffer (b)->sw_if_index[VLIB_RX] =
 119         vnet_buffer (b)->sw_if_index[VLIB_TX] = sw_if_index;
 120       vlib_frame_t *f = vlib_get_frame_to_node (vm, hi->output_node_index);
 121       u32 *to_next = vlib_frame_vector_args (f);
 122       to_next[0] = bi;
 123       f->n_vectors = 1;
 124       vlib_put_frame_to_node (vm, hi->output_node_index, f);
 125     }
 126 }
 127
 128 always_inline uword
 129 ip4_arp_inline (vlib_main_t * vm,
 130                 vlib_node_runtime_t * node,
 131                 vlib_frame_t * frame, int is_glean)
 132 {
 133   vnet_main_t *vnm = vnet_get_main ();
 134   u32 *from, *to_next_drop;
 135   uword n_left_from, n_left_to_next_drop, next_index;
 136   u32 thread_index = vm->thread_index;
 137   u64 seed;
 138
 139   if (node->flags & VLIB_NODE_FLAG_TRACE)
 140     ip4_forward_next_trace (vm, node, frame, VLIB_TX);
 141
 142   seed = throttle_seed (&arp_throttle, thread_index, vlib_time_now (vm));
 143
 144   from = vlib_frame_vector_args (frame);
 145   n_left_from = frame->n_vectors;
 146   next_index = node->cached_next_index;
 147   if (next_index == IP4_ARP_NEXT_DROP)
 148     next_index = IP4_ARP_N_NEXT;        /* point to first interface */
 149
 150   while (n_left_from > 0)
 151     {
 152       vlib_get_next_frame (vm, node, IP4_ARP_NEXT_DROP,
 153                            to_next_drop, n_left_to_next_drop);
 154
 155       while (n_left_from > 0 && n_left_to_next_drop > 0)
 156         {
 157           u32 pi0, adj_index0, sw_if_index0;
 158           ip4_address_t resolve0, src0;
 159           vlib_buffer_t *p0, *b0;
 160           ip_adjacency_t *adj0;
 161           u64 r0;
 162
 163           pi0 = from[0];
 164           p0 = vlib_get_buffer (vm, pi0);
 165
 166           from += 1;
 167           n_left_from -= 1;
 168           to_next_drop[0] = pi0;
 169           to_next_drop += 1;
 170           n_left_to_next_drop -= 1;
 171
 172           adj_index0 = vnet_buffer (p0)->ip.adj_index[VLIB_TX];
 173           adj0 = adj_get (adj_index0);
 174           sw_if_index0 = adj0->rewrite_header.sw_if_index;
 175
 176           if (is_glean)
 177             {
 178               /* resolve the packet's destination */
 179               ip4_header_t *ip0 = vlib_buffer_get_current (p0);
 180               resolve0 = ip0->dst_address;
 181               src0 = adj0->sub_type.glean.rx_pfx.fp_addr.ip4;
 182             }
 183           else
 184             {
 185               /* resolve the incomplete adj */
 186               resolve0 = adj0->sub_type.nbr.next_hop.ip4;
 187               /* Src IP address in ARP header. */
 188               if (!fib_sas4_get (sw_if_index0, &resolve0, &src0))
 189                 {
 190                   /* No source address available */
 191                   p0->error = node->errors[IP4_ARP_ERROR_NO_SOURCE_ADDRESS];
 192                   continue;
 193                 }
 194             }
 195
 196           /* combine the address and interface for the hash key */
 197           r0 = (u64) resolve0.data_u32 << 32;
 198           r0 |= sw_if_index0;
 199
 200           if (throttle_check (&arp_throttle, thread_index, r0, seed))
 201             {
 202               p0->error = node->errors[IP4_ARP_ERROR_THROTTLED];
 203               continue;
 204             }
 205
 206           /*
 207            * the adj has been updated to a rewrite but the node the DPO that got
 208            * us here hasn't - yet. no big deal. we'll drop while we wait.
 209            */
 210           if (IP_LOOKUP_NEXT_REWRITE == adj0->lookup_next_index)
 211             {
 212               p0->error = node->errors[IP4_ARP_ERROR_RESOLVED];
 213               continue;
 214             }
 215
 216           /*
 217            * Can happen if the control-plane is programming tables
 218            * with traffic flowing; at least that's today's lame excuse.
 219            */
 220           if ((is_glean && adj0->lookup_next_index != IP_LOOKUP_NEXT_GLEAN)
 221               || (!is_glean && adj0->lookup_next_index != IP_LOOKUP_NEXT_ARP))
 222             {
 223               p0->error = node->errors[IP4_ARP_ERROR_NON_ARP_ADJ];
 224               continue;
 225             }
 226
 227           /* Send ARP request. */
 228           b0 = ip4_neighbor_probe (vm, vnm, adj0, &src0, &resolve0);
 229
 230           if (PREDICT_TRUE (NULL != b0))
 231             {
 232               /* copy the persistent fields from the original */
 233               clib_memcpy_fast (b0->opaque2, p0->opaque2,
 234                                 sizeof (p0->opaque2));
 235               p0->error = node->errors[IP4_ARP_ERROR_REQUEST_SENT];
 236             }
 237           else
 238             {
 239               p0->error = node->errors[IP4_ARP_ERROR_NO_BUFFERS];
 240               continue;
 241             }
 242         }
 243
 244       vlib_put_next_frame (vm, node, IP4_ARP_NEXT_DROP, n_left_to_next_drop);
 245     }
 246
 247   return frame->n_vectors;
 248 }
 249
 250 VLIB_NODE_FN (ip4_arp_node) (vlib_main_t * vm, vlib_node_runtime_t * node,
 251                              vlib_frame_t * frame)
 252 {
 253   return (ip4_arp_inline (vm, node, frame, 0));
 254 }
 255
 256 VLIB_NODE_FN (ip4_glean_node) (vlib_main_t * vm, vlib_node_runtime_t * node,
 257                                vlib_frame_t * frame)
 258 {
 259   return (ip4_arp_inline (vm, node, frame, 1));
 260 }
 261
 262 static char *ip4_arp_error_strings[] = {
 263   [IP4_ARP_ERROR_THROTTLED] = "ARP requests throttled",
 264   [IP4_ARP_ERROR_RESOLVED] = "ARP requests resolved",
 265   [IP4_ARP_ERROR_NO_BUFFERS] = "ARP requests out of buffer",
 266   [IP4_ARP_ERROR_REQUEST_SENT] = "ARP requests sent",
 267   [IP4_ARP_ERROR_NON_ARP_ADJ] = "ARPs to non-ARP adjacencies",
 268   [IP4_ARP_ERROR_NO_SOURCE_ADDRESS] = "no source address for ARP request",
 269 };
 270
 271 /* *INDENT-OFF* */
 272 VLIB_REGISTER_NODE (ip4_arp_node) =
 273 {
 274   .name = "ip4-arp",
 275   .vector_size = sizeof (u32),
 276   .format_trace = format_ip4_forward_next_trace,
 277   .n_errors = ARRAY_LEN (ip4_arp_error_strings),
 278   .error_strings = ip4_arp_error_strings,
 279   .n_next_nodes = IP4_ARP_N_NEXT,
 280   .next_nodes = {
 281     [IP4_ARP_NEXT_DROP] = "ip4-drop",
 282   },
 283 };
 284
 285 VLIB_REGISTER_NODE (ip4_glean_node) =
 286 {
 287   .name = "ip4-glean",
 288   .vector_size = sizeof (u32),
 289   .format_trace = format_ip4_forward_next_trace,
 290   .n_errors = ARRAY_LEN (ip4_arp_error_strings),
 291   .error_strings = ip4_arp_error_strings,
 292   .n_next_nodes = IP4_ARP_N_NEXT,
 293   .next_nodes = {
 294     [IP4_ARP_NEXT_DROP] = "ip4-drop",
 295   },
 296 };
 297 /* *INDENT-ON* */
 298
 299 #define foreach_notrace_ip4_arp_error           \
 300 _(THROTTLED)                                    \
 301 _(RESOLVED)                                     \
 302 _(NO_BUFFERS)                                   \
 303 _(REQUEST_SENT)                                 \
 304 _(NON_ARP_ADJ)                                  \
 305 _(NO_SOURCE_ADDRESS)
 306
 307 static clib_error_t *
 308 arp_notrace_init (vlib_main_t * vm)
 309 {
 310   vlib_node_runtime_t *rt = vlib_node_get_runtime (vm, ip4_arp_node.index);
 311
 312   /* don't trace ARP request packets */
 313 #define _(a)                                    \
 314     vnet_pcap_drop_trace_filter_add_del         \
 315         (rt->errors[IP4_ARP_ERROR_##a],         \
 316          1 /* is_add */);
 317   foreach_notrace_ip4_arp_error;
 318 #undef _
 319   return 0;
 320 }
 321
 322 VLIB_INIT_FUNCTION (arp_notrace_init);
 323
 324 static clib_error_t *
 325 ip4_neighbor_main_loop_enter (vlib_main_t * vm)
 326 {
 327   vlib_thread_main_t *tm = &vlib_thread_main;
 328   u32 n_vlib_mains = tm->n_vlib_mains;
 329
 330   throttle_init (&arp_throttle, n_vlib_mains, 1e-3);
 331
 332   return (NULL);
 333 }
 334
 335 VLIB_MAIN_LOOP_ENTER_FUNCTION (ip4_neighbor_main_loop_enter);
 336
 337
 338 /*
 339  * fd.io coding-style-patch-verification: ON
 340  *
 341  * Local Variables:
 342  * eval: (c-set-style "gnu")
 343  * End:
 344  */