src/plugins/cdp/cdp_periodic.c

   1 /*
   2  * Copyright (c) 2011-2018 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 #include <cdp/cdp.h>
  16 #include <vppinfra/hash.h>
  17 #include <vppinfra/pcap.h>
  18 #include <vnet/srp/srp.h>
  19 #include <vnet/ppp/ppp.h>
  20 #include <vnet/hdlc/hdlc.h>
  21 #include <vnet/srp/packet.h>
  22
  23 /*
  24  * Generate a set of specific CDP TLVs.
  25  *
  26  * $$$ eventually these need to fish better data from
  27  * other data structures; e.g. the hostname, software version info
  28  * etc.
  29  */
  30
  31 static void
  32 add_device_name_tlv (vnet_hw_interface_t * hw, u8 ** t0p)
  33 {
  34   cdp_tlv_t *t = (cdp_tlv_t *) * t0p;
  35
  36   t->t = htons (CDP_TLV_device_name);
  37   t->l = htons (3 + sizeof (*t));
  38   clib_memcpy (&t->v, "VPP", 3);
  39
  40   *t0p += ntohs (t->l);
  41 }
  42
  43 static void
  44 add_port_id_tlv (vnet_hw_interface_t * hw, u8 ** t0p)
  45 {
  46   cdp_tlv_t *t = (cdp_tlv_t *) * t0p;
  47
  48   t->t = htons (CDP_TLV_port_id);
  49   t->l = htons (vec_len (hw->name) + sizeof (*t));
  50   clib_memcpy (&t->v, hw->name, vec_len (hw->name));
  51   *t0p += ntohs (t->l);
  52 }
  53
  54 static void
  55 add_version_tlv (vnet_hw_interface_t * hw, u8 ** t0p)
  56 {
  57   cdp_tlv_t *t = (cdp_tlv_t *) * t0p;
  58
  59   t->t = htons (CDP_TLV_version);
  60   t->l = htons (12 + sizeof (*t));
  61   clib_memcpy (&t->v, "VPP Software", 12);
  62   *t0p += ntohs (t->l);
  63 }
  64
  65 static void
  66 add_platform_tlv (vnet_hw_interface_t * hw, u8 ** t0p)
  67 {
  68   cdp_tlv_t *t = (cdp_tlv_t *) * t0p;
  69
  70   t->t = htons (CDP_TLV_platform);
  71   t->l = htons (2 + sizeof (*t));
  72   clib_memcpy (&t->v, "SW", 2);
  73   *t0p += ntohs (t->l);
  74 }
  75
  76 static void
  77 add_capability_tlv (vnet_hw_interface_t * hw, u8 ** t0p)
  78 {
  79   cdp_tlv_t *t = (cdp_tlv_t *) * t0p;
  80   u32 capabilities;
  81
  82   t->t = htons (CDP_TLV_capabilities);
  83   t->l = htons (4 + sizeof (*t));
  84   capabilities = CDP_ROUTER_DEVICE;
  85   capabilities = htonl (capabilities);
  86   clib_memcpy (&t->v, &capabilities, sizeof (capabilities));
  87   *t0p += ntohs (t->l);
  88 }
  89
  90 static void
  91 add_tlvs (cdp_main_t * cm, vnet_hw_interface_t * hw, u8 ** t0p)
  92 {
  93   add_device_name_tlv (hw, t0p);
  94   add_port_id_tlv (hw, t0p);
  95   add_version_tlv (hw, t0p);
  96   add_platform_tlv (hw, t0p);
  97   add_capability_tlv (hw, t0p);
  98 }
  99
 100 /*
 101  * send a cdp pkt on an ethernet interface
 102  */
 103 static void
 104 send_ethernet_hello (cdp_main_t * cm, cdp_neighbor_t * n, int count)
 105 {
 106   u32 *to_next;
 107   ethernet_llc_snap_and_cdp_header_t *h0;
 108   vnet_hw_interface_t *hw;
 109   u32 bi0;
 110   vlib_buffer_t *b0;
 111   u8 *t0;
 112   u16 checksum;
 113   int nbytes_to_checksum;
 114   int i;
 115   vlib_frame_t *f;
 116   vlib_main_t *vm = cm->vlib_main;
 117   vnet_main_t *vnm = cm->vnet_main;
 118
 119   for (i = 0; i < count; i++)
 120     {
 121       /*
 122        * see cdp_periodic_init() to understand what's already painted
 123        * into the buffer by the packet template mechanism
 124        */
 125       h0 = vlib_packet_template_get_packet
 126         (vm, &cm->packet_templates[n->packet_template_index], &bi0);
 127
 128       if (!h0)
 129         break;
 130
 131       /* Add the interface's ethernet source address */
 132       hw = vnet_get_sup_hw_interface (vnm, n->sw_if_index);
 133
 134       clib_memcpy (h0->ethernet.src_address, hw->hw_address,
 135                    vec_len (hw->hw_address));
 136
 137       t0 = (u8 *) & h0->cdp.data;
 138
 139       /* add TLVs */
 140       add_tlvs (cm, hw, &t0);
 141
 142       /* add the cdp packet checksum */
 143       nbytes_to_checksum = t0 - (u8 *) & h0->cdp;
 144       checksum = cdp_checksum (&h0->cdp, nbytes_to_checksum);
 145       h0->cdp.checksum = htons (checksum);
 146
 147       /* Set the outbound packet length */
 148       b0 = vlib_get_buffer (vm, bi0);
 149       b0->current_length = nbytes_to_checksum + sizeof (*h0)
 150         - sizeof (cdp_hdr_t);
 151
 152       /* And the outbound interface */
 153       vnet_buffer (b0)->sw_if_index[VLIB_TX] = hw->sw_if_index;
 154
 155       /* Set the 802.3 ethernet length */
 156       h0->ethernet.len = htons (b0->current_length
 157                                 - sizeof (ethernet_802_3_header_t));
 158
 159       /* And output the packet on the correct interface */
 160       f = vlib_get_frame_to_node (vm, hw->output_node_index);
 161       to_next = vlib_frame_vector_args (f);
 162       to_next[0] = bi0;
 163       f->n_vectors = 1;
 164
 165       vlib_put_frame_to_node (vm, hw->output_node_index, f);
 166       n->last_sent = vlib_time_now (vm);
 167     }
 168 }
 169
 170 /*
 171  * send a cdp pkt on an hdlc interface
 172  */
 173 static void
 174 send_hdlc_hello (cdp_main_t * cm, cdp_neighbor_t * n, int count)
 175 {
 176   u32 *to_next;
 177   hdlc_and_cdp_header_t *h0;
 178   vnet_hw_interface_t *hw;
 179   u32 bi0;
 180   vlib_buffer_t *b0;
 181   u8 *t0;
 182   u16 checksum;
 183   int nbytes_to_checksum;
 184   int i;
 185   vlib_frame_t *f;
 186   vlib_main_t *vm = cm->vlib_main;
 187   vnet_main_t *vnm = cm->vnet_main;
 188
 189   for (i = 0; i < count; i++)
 190     {
 191       /*
 192        * see cdp_periodic_init() to understand what's already painted
 193        * into the buffer by the packet template mechanism
 194        */
 195       h0 = vlib_packet_template_get_packet
 196         (vm, &cm->packet_templates[n->packet_template_index], &bi0);
 197
 198       if (!h0)
 199         break;
 200
 201       hw = vnet_get_sup_hw_interface (vnm, n->sw_if_index);
 202
 203       t0 = (u8 *) & h0->cdp.data;
 204
 205       /* add TLVs */
 206       add_tlvs (cm, hw, &t0);
 207
 208       /* add the cdp packet checksum */
 209       nbytes_to_checksum = t0 - (u8 *) & h0->cdp;
 210       checksum = cdp_checksum (&h0->cdp, nbytes_to_checksum);
 211       h0->cdp.checksum = htons (checksum);
 212
 213       /* Set the outbound packet length */
 214       b0 = vlib_get_buffer (vm, bi0);
 215       b0->current_length = nbytes_to_checksum + sizeof (*h0)
 216         - sizeof (cdp_hdr_t);
 217
 218       /* And output the packet on the correct interface */
 219       f = vlib_get_frame_to_node (vm, hw->output_node_index);
 220       to_next = vlib_frame_vector_args (f);
 221       to_next[0] = bi0;
 222       f->n_vectors = 1;
 223
 224       vlib_put_frame_to_node (vm, hw->output_node_index, f);
 225       n->last_sent = vlib_time_now (vm);
 226     }
 227 }
 228
 229 /*
 230  * send a cdp pkt on an srp interface
 231  */
 232 static void
 233 send_srp_hello (cdp_main_t * cm, cdp_neighbor_t * n, int count)
 234 {
 235   u32 *to_next;
 236   srp_and_cdp_header_t *h0;
 237   vnet_hw_interface_t *hw;
 238   u32 bi0;
 239   vlib_buffer_t *b0;
 240   u8 *t0;
 241   u16 checksum;
 242   int nbytes_to_checksum;
 243   int i;
 244   vlib_frame_t *f;
 245   vlib_main_t *vm = cm->vlib_main;
 246   vnet_main_t *vnm = cm->vnet_main;
 247
 248   for (i = 0; i < count; i++)
 249     {
 250       /*
 251        * see cdp_periodic_init() to understand what's already painted
 252        * into the buffer by the packet template mechanism
 253        */
 254       h0 = vlib_packet_template_get_packet
 255         (vm, &cm->packet_templates[n->packet_template_index], &bi0);
 256
 257       if (!h0)
 258         break;
 259
 260       hw = vnet_get_sup_hw_interface (vnm, n->sw_if_index);
 261
 262       t0 = (u8 *) & h0->cdp.data;
 263
 264       /* add TLVs */
 265       add_tlvs (cm, hw, &t0);
 266
 267       /* Add the interface's ethernet source address */
 268       clib_memcpy (h0->ethernet.src_address, hw->hw_address,
 269                    vec_len (hw->hw_address));
 270
 271       /* add the cdp packet checksum */
 272       nbytes_to_checksum = t0 - (u8 *) & h0->cdp;
 273       checksum = cdp_checksum (&h0->cdp, nbytes_to_checksum);
 274       h0->cdp.checksum = htons (checksum);
 275
 276       /* Set the outbound packet length */
 277       b0 = vlib_get_buffer (vm, bi0);
 278       b0->current_length = nbytes_to_checksum + sizeof (*h0)
 279         - sizeof (cdp_hdr_t);
 280
 281       /* And output the packet on the correct interface */
 282       f = vlib_get_frame_to_node (vm, hw->output_node_index);
 283       to_next = vlib_frame_vector_args (f);
 284       to_next[0] = bi0;
 285       f->n_vectors = 1;
 286
 287       vlib_put_frame_to_node (vm, hw->output_node_index, f);
 288       n->last_sent = vlib_time_now (vm);
 289     }
 290 }
 291
 292 /*
 293  * Decide which cdp packet template to use
 294  */
 295 static int
 296 pick_packet_template (cdp_main_t * cm, cdp_neighbor_t * n)
 297 {
 298   n->packet_template_index = CDP_PACKET_TEMPLATE_ETHERNET;
 299
 300   return 0;
 301 }
 302
 303 /* Send a cdp neighbor announcement */
 304 static void
 305 send_hello (cdp_main_t * cm, cdp_neighbor_t * n, int count)
 306 {
 307   if (n->packet_template_index == (u8) ~ 0)
 308     {
 309       /* If we don't know how to talk to this peer, don't try again */
 310       if (pick_packet_template (cm, n))
 311         {
 312           n->last_sent = 1e70;
 313           return;
 314         }
 315     }
 316
 317   switch (n->packet_template_index)
 318     {
 319     case CDP_PACKET_TEMPLATE_ETHERNET:
 320       send_ethernet_hello (cm, n, count);
 321       break;
 322
 323     case CDP_PACKET_TEMPLATE_HDLC:
 324       send_hdlc_hello (cm, n, count);
 325       break;
 326
 327     case CDP_PACKET_TEMPLATE_SRP:
 328       send_srp_hello (cm, n, count);
 329       break;
 330
 331     default:
 332       ASSERT (0);
 333     }
 334   n->last_sent = vlib_time_now (cm->vlib_main);
 335 }
 336
 337 static void
 338 delete_neighbor (cdp_main_t * cm, cdp_neighbor_t * n, int want_broadcast)
 339 {
 340   hash_unset (cm->neighbor_by_sw_if_index, n->sw_if_index);
 341   vec_free (n->device_name);
 342   vec_free (n->version);
 343   vec_free (n->port_id);
 344   vec_free (n->platform);
 345   vec_free (n->last_rx_pkt);
 346   pool_put (cm->neighbors, n);
 347 }
 348
 349 void
 350 cdp_periodic (vlib_main_t * vm)
 351 {
 352   cdp_main_t *cm = &cdp_main;
 353   cdp_neighbor_t *n;
 354   f64 now = vlib_time_now (vm);
 355   vnet_sw_interface_t *sw;
 356   static u32 *delete_list = 0;
 357   int i;
 358   static cdp_neighbor_t **n_list = 0;
 359
 360   pool_foreach (n, cm->neighbors)
 361    {
 362     vec_add1 (n_list, n);
 363   }
 364
 365   /* Across all cdp neighbors known to the system */
 366   for (i = 0; i < vec_len (n_list); i++)
 367     {
 368       n = n_list[i];
 369
 370       /* "no cdp run" provisioned on the interface? */
 371       if (n->disabled == 1)
 372         continue;
 373
 374       sw = vnet_get_sw_interface (cm->vnet_main, n->sw_if_index);
 375
 376       /* Interface shutdown or rx timeout? */
 377       if (!(sw->flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP)
 378           || (now > (n->last_heard + (f64) n->ttl_in_seconds)))
 379         /* add to list of neighbors to delete */
 380         vec_add1 (delete_list, n - cm->neighbors);
 381       else if (n->last_sent == 0.0)
 382         /* First time, send 3 hellos */
 383         send_hello (cm, n, 3 /* three to begin with */ );
 384       else if (now > (n->last_sent + (((f64) n->ttl_in_seconds) / 6.0)))
 385         /* Normal keepalive, send one */
 386         send_hello (cm, n, 1 /* one as a keepalive */ );
 387     }
 388
 389   for (i = 0; i < vec_len (delete_list); i++)
 390     {
 391       n = vec_elt_at_index (cm->neighbors, delete_list[i]);
 392       delete_neighbor (cm, n, 1);
 393     }
 394   if (delete_list)
 395     vec_set_len (delete_list, 0);
 396   if (n_list)
 397     vec_set_len (n_list, 0);
 398 }
 399
 400 static clib_error_t *
 401 cdp_periodic_init (vlib_main_t * vm)
 402 {
 403   cdp_main_t *cm = &cdp_main;
 404
 405   /* Create the ethernet cdp hello packet template */
 406   {
 407     ethernet_llc_snap_and_cdp_header_t h;
 408
 409     clib_memset (&h, 0, sizeof (h));
 410
 411     /* Send to 01:00:0c:cc:cc */
 412     h.ethernet.dst_address[0] = 0x01;
 413     /* h.ethernet.dst_address[1] = 0x00; (clib_memset) */
 414     h.ethernet.dst_address[2] = 0x0C;
 415     h.ethernet.dst_address[3] = 0xCC;
 416     h.ethernet.dst_address[4] = 0xCC;
 417     h.ethernet.dst_address[5] = 0xCC;
 418
 419     /* leave src address blank (fill in at send time) */
 420
 421     /* leave length blank (fill in at send time) */
 422
 423     /* LLC */
 424     h.llc.dst_sap = h.llc.src_sap = 0xAA;       /* SNAP */
 425     h.llc.control = 0x03;       /* UI (no extended control bytes) */
 426
 427     /* SNAP */
 428     /* h.snap.oui[0] = 0x00; (clib_memset) */
 429     /* h.snap.oui[1] = 0x00; (clib_memset) */
 430     h.snap.oui[2] = 0x0C;       /* Cisco = 0x00000C */
 431     h.snap.protocol = htons (0x2000);   /* CDP = 0x2000 */
 432
 433     /* CDP */
 434     h.cdp.version = 2;
 435     h.cdp.ttl = 180;
 436
 437     vlib_packet_template_init
 438       (vm, &cm->packet_templates[CDP_PACKET_TEMPLATE_ETHERNET],
 439        /* data */ &h,
 440        sizeof (h),
 441        /* alloc chunk size */ 8,
 442        "cdp-ethernet");
 443   }
 444
 445 #if 0                           /* retain for reference */
 446
 447   /* Create the hdlc cdp hello packet template */
 448   {
 449     hdlc_and_cdp_header_t h;
 450
 451     clib_memset (&h, 0, sizeof (h));
 452
 453     h.hdlc.address = 0x0f;
 454     /* h.hdlc.control = 0; (clib_memset) */
 455     h.hdlc.protocol = htons (0x2000);   /* CDP = 0x2000 */
 456
 457     /* CDP */
 458     h.cdp.version = 2;
 459     h.cdp.ttl = 180;
 460
 461     vlib_packet_template_init
 462       (vm, &cm->packet_templates[CDP_PACKET_TEMPLATE_HDLC],
 463        /* data */ &h,
 464        sizeof (h),
 465        /* alloc chunk size */ 8,
 466        "cdp-hdlc");
 467   }
 468
 469   /* Create the srp cdp hello packet template */
 470   {
 471     srp_and_cdp_header_t h;
 472
 473     clib_memset (&h, 0, sizeof (h));
 474
 475     /* Send to 01:00:0c:cc:cc */
 476     h.ethernet.dst_address[0] = 0x01;
 477     /* h.ethernet.dst_address[1] = 0x00; (clib_memset) */
 478     h.ethernet.dst_address[2] = 0x0C;
 479     h.ethernet.dst_address[3] = 0xCC;
 480     h.ethernet.dst_address[4] = 0xCC;
 481     h.ethernet.dst_address[5] = 0xCC;
 482
 483     /* leave src address blank (fill in at send time) */
 484
 485     /* The srp header is filled in at xmt */
 486     h.srp.ttl = 1;
 487     h.srp.priority = 7;
 488     h.srp.mode = SRP_MODE_data;
 489     srp_header_compute_parity (&h.srp);
 490
 491     /* Inner ring and parity will be set at send time */
 492
 493     h.ethernet.type = htons (0x2000);   /* CDP = 0x2000 */
 494
 495     /* CDP */
 496     h.cdp.version = 2;
 497     h.cdp.ttl = 180;
 498
 499     vlib_packet_template_init
 500       (vm, &cm->packet_templates[CDP_PACKET_TEMPLATE_SRP],
 501        /* data */ &h,
 502        sizeof (h),
 503        /* alloc chunk size */ 8,
 504        "cdp-srp");
 505   }
 506 #endif
 507
 508   return 0;
 509 }
 510
 511 VLIB_INIT_FUNCTION (cdp_periodic_init);
 512
 513 /*
 514  * fd.io coding-style-patch-verification: ON
 515  *
 516  * Local Variables:
 517  * eval: (c-set-style "gnu")
 518  * End:
 519  */