2 * Copyright (c) 2011-2016 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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
15 #include <vnet/cdp/cdp_node.h>
16 #include <vppinfra/hash.h>
17 #include <vnet/unix/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>
24 * Generate a set of specific CDP TLVs.
26 * $$$ eventually these need to fish better data from
27 * other data structures; e.g. the hostname, software version info
32 add_device_name_tlv (vnet_hw_interface_t * hw, u8 ** t0p)
34 cdp_tlv_t *t = (cdp_tlv_t *) * t0p;
36 t->t = htons (CDP_TLV_device_name);
37 t->l = htons (3 + sizeof (*t));
38 clib_memcpy (&t->v, "VPP", 3);
44 add_port_id_tlv (vnet_hw_interface_t * hw, u8 ** t0p)
46 cdp_tlv_t *t = (cdp_tlv_t *) * t0p;
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));
55 add_version_tlv (vnet_hw_interface_t * hw, u8 ** t0p)
57 cdp_tlv_t *t = (cdp_tlv_t *) * t0p;
59 t->t = htons (CDP_TLV_version);
60 t->l = htons (12 + sizeof (*t));
61 clib_memcpy (&t->v, "VPP Software", 12);
66 add_platform_tlv (vnet_hw_interface_t * hw, u8 ** t0p)
68 cdp_tlv_t *t = (cdp_tlv_t *) * t0p;
70 t->t = htons (CDP_TLV_platform);
71 t->l = htons (2 + sizeof (*t));
72 clib_memcpy (&t->v, "SW", 2);
77 add_capability_tlv (vnet_hw_interface_t * hw, u8 ** t0p)
79 cdp_tlv_t *t = (cdp_tlv_t *) * t0p;
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));
91 add_tlvs (cdp_main_t * cm, vnet_hw_interface_t * hw, u8 ** t0p)
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);
101 * send a cdp pkt on an ethernet interface
104 send_ethernet_hello (cdp_main_t * cm, cdp_neighbor_t * n, int count)
107 ethernet_llc_snap_and_cdp_header_t *h0;
108 vnet_hw_interface_t *hw;
113 int nbytes_to_checksum;
116 vlib_main_t *vm = cm->vlib_main;
117 vnet_main_t *vnm = cm->vnet_main;
119 for (i = 0; i < count; i++)
122 * see cdp_periodic_init() to understand what's already painted
123 * into the buffer by the packet template mechanism
125 h0 = vlib_packet_template_get_packet
126 (vm, &cm->packet_templates[n->packet_template_index], &bi0);
128 /* Add the interface's ethernet source address */
129 hw = vnet_get_sup_hw_interface (vnm, n->sw_if_index);
131 clib_memcpy (h0->ethernet.src_address, hw->hw_address,
132 vec_len (hw->hw_address));
134 t0 = (u8 *) & h0->cdp.data;
137 add_tlvs (cm, hw, &t0);
139 /* add the cdp packet checksum */
140 nbytes_to_checksum = t0 - (u8 *) & h0->cdp;
141 checksum = cdp_checksum (&h0->cdp, nbytes_to_checksum);
142 h0->cdp.checksum = htons (checksum);
144 /* Set the outbound packet length */
145 b0 = vlib_get_buffer (vm, bi0);
146 b0->current_length = nbytes_to_checksum + sizeof (*h0)
147 - sizeof (cdp_hdr_t);
149 /* And the outbound interface */
150 vnet_buffer (b0)->sw_if_index[VLIB_TX] = hw->sw_if_index;
152 /* Set the 802.3 ethernet length */
153 h0->ethernet.len = htons (b0->current_length
154 - sizeof (ethernet_802_3_header_t));
156 /* And output the packet on the correct interface */
157 f = vlib_get_frame_to_node (vm, hw->output_node_index);
158 to_next = vlib_frame_vector_args (f);
162 vlib_put_frame_to_node (vm, hw->output_node_index, f);
163 n->last_sent = vlib_time_now (vm);
168 * send a cdp pkt on an hdlc interface
171 send_hdlc_hello (cdp_main_t * cm, cdp_neighbor_t * n, int count)
174 hdlc_and_cdp_header_t *h0;
175 vnet_hw_interface_t *hw;
180 int nbytes_to_checksum;
183 vlib_main_t *vm = cm->vlib_main;
184 vnet_main_t *vnm = cm->vnet_main;
186 for (i = 0; i < count; i++)
189 * see cdp_periodic_init() to understand what's already painted
190 * into the buffer by the packet template mechanism
192 h0 = vlib_packet_template_get_packet
193 (vm, &cm->packet_templates[n->packet_template_index], &bi0);
195 hw = vnet_get_sup_hw_interface (vnm, n->sw_if_index);
197 t0 = (u8 *) & h0->cdp.data;
200 add_tlvs (cm, hw, &t0);
202 /* add the cdp packet checksum */
203 nbytes_to_checksum = t0 - (u8 *) & h0->cdp;
204 checksum = cdp_checksum (&h0->cdp, nbytes_to_checksum);
205 h0->cdp.checksum = htons (checksum);
207 /* Set the outbound packet length */
208 b0 = vlib_get_buffer (vm, bi0);
209 b0->current_length = nbytes_to_checksum + sizeof (*h0)
210 - sizeof (cdp_hdr_t);
212 /* And output the packet on the correct interface */
213 f = vlib_get_frame_to_node (vm, hw->output_node_index);
214 to_next = vlib_frame_vector_args (f);
218 vlib_put_frame_to_node (vm, hw->output_node_index, f);
219 n->last_sent = vlib_time_now (vm);
224 * send a cdp pkt on an srp interface
227 send_srp_hello (cdp_main_t * cm, cdp_neighbor_t * n, int count)
230 srp_and_cdp_header_t *h0;
231 vnet_hw_interface_t *hw;
236 int nbytes_to_checksum;
239 vlib_main_t *vm = cm->vlib_main;
240 vnet_main_t *vnm = cm->vnet_main;
242 for (i = 0; i < count; i++)
245 * see cdp_periodic_init() to understand what's already painted
246 * into the buffer by the packet template mechanism
248 h0 = vlib_packet_template_get_packet
249 (vm, &cm->packet_templates[n->packet_template_index], &bi0);
251 hw = vnet_get_sup_hw_interface (vnm, n->sw_if_index);
253 t0 = (u8 *) & h0->cdp.data;
256 add_tlvs (cm, hw, &t0);
258 /* Add the interface's ethernet source address */
259 clib_memcpy (h0->ethernet.src_address, hw->hw_address,
260 vec_len (hw->hw_address));
262 /* add the cdp packet checksum */
263 nbytes_to_checksum = t0 - (u8 *) & h0->cdp;
264 checksum = cdp_checksum (&h0->cdp, nbytes_to_checksum);
265 h0->cdp.checksum = htons (checksum);
267 /* Set the outbound packet length */
268 b0 = vlib_get_buffer (vm, bi0);
269 b0->current_length = nbytes_to_checksum + sizeof (*h0)
270 - sizeof (cdp_hdr_t);
272 /* And output the packet on the correct interface */
273 f = vlib_get_frame_to_node (vm, hw->output_node_index);
274 to_next = vlib_frame_vector_args (f);
278 vlib_put_frame_to_node (vm, hw->output_node_index, f);
279 n->last_sent = vlib_time_now (vm);
284 * Decide which cdp packet template to use
287 pick_packet_template (cdp_main_t * cm, cdp_neighbor_t * n)
289 n->packet_template_index = CDP_PACKET_TEMPLATE_ETHERNET;
294 /* Send a cdp neighbor announcement */
296 send_hello (cdp_main_t * cm, cdp_neighbor_t * n, int count)
298 if (n->packet_template_index == (u8) ~ 0)
300 /* If we don't know how to talk to this peer, don't try again */
301 if (pick_packet_template (cm, n))
308 switch (n->packet_template_index)
310 case CDP_PACKET_TEMPLATE_ETHERNET:
311 send_ethernet_hello (cm, n, count);
314 case CDP_PACKET_TEMPLATE_HDLC:
315 send_hdlc_hello (cm, n, count);
318 case CDP_PACKET_TEMPLATE_SRP:
319 send_srp_hello (cm, n, count);
325 n->last_sent = vlib_time_now (cm->vlib_main);
329 delete_neighbor (cdp_main_t * cm, cdp_neighbor_t * n, int want_broadcast)
331 hash_unset (cm->neighbor_by_sw_if_index, n->sw_if_index);
332 vec_free (n->device_name);
333 vec_free (n->version);
334 vec_free (n->port_id);
335 vec_free (n->platform);
336 vec_free (n->last_rx_pkt);
337 pool_put (cm->neighbors, n);
341 cdp_periodic (vlib_main_t * vm)
343 cdp_main_t *cm = &cdp_main;
345 f64 now = vlib_time_now (vm);
346 vnet_sw_interface_t *sw;
347 static u32 *delete_list = 0;
349 static cdp_neighbor_t **n_list = 0;
352 pool_foreach (n, cm->neighbors,
354 vec_add1 (n_list, n);
358 /* Across all cdp neighbors known to the system */
359 for (i = 0; i < vec_len (n_list); i++)
363 /* "no cdp run" provisioned on the interface? */
364 if (n->disabled == 1)
367 sw = vnet_get_sw_interface (cm->vnet_main, n->sw_if_index);
369 /* Interface shutdown or rx timeout? */
370 if (!(sw->flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP)
371 || (now > (n->last_heard + (f64) n->ttl_in_seconds)))
372 /* add to list of neighbors to delete */
373 vec_add1 (delete_list, n - cm->neighbors);
374 else if (n->last_sent == 0.0)
375 /* First time, send 3 hellos */
376 send_hello (cm, n, 3 /* three to begin with */ );
377 else if (now > (n->last_sent + (((f64) n->ttl_in_seconds) / 6.0)))
378 /* Normal keepalive, send one */
379 send_hello (cm, n, 1 /* one as a keepalive */ );
382 for (i = 0; i < vec_len (delete_list); i++)
384 n = vec_elt_at_index (cm->neighbors, delete_list[i]);
385 delete_neighbor (cm, n, 1);
388 _vec_len (delete_list) = 0;
390 _vec_len (n_list) = 0;
393 static clib_error_t *
394 cdp_periodic_init (vlib_main_t * vm)
396 cdp_main_t *cm = &cdp_main;
398 /* Create the ethernet cdp hello packet template */
400 ethernet_llc_snap_and_cdp_header_t h;
402 memset (&h, 0, sizeof (h));
404 /* Send to 01:00:0c:cc:cc */
405 h.ethernet.dst_address[0] = 0x01;
406 /* h.ethernet.dst_address[1] = 0x00; (memset) */
407 h.ethernet.dst_address[2] = 0x0C;
408 h.ethernet.dst_address[3] = 0xCC;
409 h.ethernet.dst_address[4] = 0xCC;
410 h.ethernet.dst_address[5] = 0xCC;
412 /* leave src address blank (fill in at send time) */
414 /* leave length blank (fill in at send time) */
417 h.llc.dst_sap = h.llc.src_sap = 0xAA; /* SNAP */
418 h.llc.control = 0x03; /* UI (no extended control bytes) */
421 /* h.snap.oui[0] = 0x00; (memset) */
422 /* h.snap.oui[1] = 0x00; (memset) */
423 h.snap.oui[2] = 0x0C; /* Cisco = 0x00000C */
424 h.snap.protocol = htons (0x2000); /* CDP = 0x2000 */
430 vlib_packet_template_init
431 (vm, &cm->packet_templates[CDP_PACKET_TEMPLATE_ETHERNET],
434 /* alloc chunk size */ 8,
438 #if 0 /* retain for reference */
440 /* Create the hdlc cdp hello packet template */
442 hdlc_and_cdp_header_t h;
444 memset (&h, 0, sizeof (h));
446 h.hdlc.address = 0x0f;
447 /* h.hdlc.control = 0; (memset) */
448 h.hdlc.protocol = htons (0x2000); /* CDP = 0x2000 */
454 vlib_packet_template_init
455 (vm, &cm->packet_templates[CDP_PACKET_TEMPLATE_HDLC],
458 /* alloc chunk size */ 8,
462 /* Create the srp cdp hello packet template */
464 srp_and_cdp_header_t h;
466 memset (&h, 0, sizeof (h));
468 /* Send to 01:00:0c:cc:cc */
469 h.ethernet.dst_address[0] = 0x01;
470 /* h.ethernet.dst_address[1] = 0x00; (memset) */
471 h.ethernet.dst_address[2] = 0x0C;
472 h.ethernet.dst_address[3] = 0xCC;
473 h.ethernet.dst_address[4] = 0xCC;
474 h.ethernet.dst_address[5] = 0xCC;
476 /* leave src address blank (fill in at send time) */
478 /* The srp header is filled in at xmt */
481 h.srp.mode = SRP_MODE_data;
482 srp_header_compute_parity (&h.srp);
484 /* Inner ring and parity will be set at send time */
486 h.ethernet.type = htons (0x2000); /* CDP = 0x2000 */
492 vlib_packet_template_init
493 (vm, &cm->packet_templates[CDP_PACKET_TEMPLATE_SRP],
496 /* alloc chunk size */ 8,
504 VLIB_INIT_FUNCTION (cdp_periodic_init);
507 * fd.io coding-style-patch-verification: ON
510 * eval: (c-set-style "gnu")