FD.io VPP  v19.04.1-1-ge4a0f9f
Vector Packet Processing
cdp.h
Go to the documentation of this file.
1 
2 /*
3  * cdp.h - cdp protocol plug-in
4  *
5  * Copyright (c) 2011-2018 by 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:
9  *
10  * http://www.apache.org/licenses/LICENSE-2.0
11  *
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  */
18 #ifndef __included_cdp_h__
19 #define __included_cdp_h__
20 
21 #include <vlib/vlib.h>
22 #include <vlib/unix/unix.h>
23 
24 #include <vnet/snap/snap.h>
25 #include <vnet/hdlc/hdlc.h>
26 #include <vnet/hdlc/packet.h>
27 
28 #include <vppinfra/format.h>
29 #include <vppinfra/hash.h>
30 
31 #include "cdp_protocol.h"
32 
33 typedef enum
34 {
40 
41 typedef struct
42 {
43  /* neighbor's vlib software interface index */
45 
46  /* Timers */
49 
50  /* Neighbor time-to-live (usually 180s) */
52 
53  /* "no cdp run" or similar */
55 
56  /* tx packet template id for this neighbor */
58 
59  /* Jenkins hash optimization: avoid tlv scan, send short keepalive msg */
62 
63  /* Info we actually keep about each neighbor */
68 
69  /* last received packet, for the J-hash optimization */
72 
73 #define foreach_neighbor_string_field \
74 _(device_name) \
75 _(version) \
76 _(port_id) \
77 _(platform)
78 
79 typedef struct
80 {
81  /* pool of cdp neighbors */
83 
84  /* plugin message id base */
86 
87  /* tx pcap debug enable */
89 
90  /* rapidly find a neighbor by vlib software interface index */
92 
93  /* Background process node index */
95 
96  /* top-level state */
97  int enabled;
99 
100  /* Packet templates for different encap types */
102 
103  /* convenience variables */
106 } cdp_main_t;
107 
108 extern cdp_main_t cdp_main;
110 
111 /* Packet counters */
112 #define foreach_cdp_error \
113 _ (NONE, "good cdp packets (processed)") \
114 _ (CACHE_HIT, "good cdp packets (cache hit)") \
115 _ (BAD_TLV, "cdp packets with bad TLVs") \
116 _ (PROTOCOL_VERSION, "cdp packets with bad protocol versions") \
117 _ (CHECKSUM, "cdp packets with bad checksums") \
118 _ (DISABLED, "cdp packets received on disabled interfaces")
119 
120 typedef enum
121 {
122 #define _(sym,str) CDP_ERROR_##sym,
124 #undef _
126 } cdp_error_t;
127 
128 /* cdp packet trace capture */
129 typedef struct
130 {
132  u8 data[400];
134 
135 typedef enum
136 {
140 
142 void cdp_periodic (vlib_main_t * vm);
143 void cdp_keepalive (cdp_main_t * cm, cdp_neighbor_t * n);
144 u16 cdp_checksum (void *p, int count);
145 u8 *cdp_input_format_trace (u8 * s, va_list * args);
146 
147 #endif /* __included_cdp_h__ */
148 
149 /*
150  * fd.io coding-style-patch-verification: ON
151  *
152  * Local Variables:
153  * eval: (c-set-style "gnu")
154  * End:
155  */
u16 msg_id_base
Definition: cdp.h:85
cdp_error_t
Definition: cdp.h:120
int enabled
Definition: cdp.h:97
cdp_error_t cdp_input(vlib_main_t *vm, vlib_buffer_t *b0, u32 bi0)
Definition: cdp_input.c:323
cdp_main_t cdp_main
Definition: cdp_input.c:17
f64 last_sent
Definition: cdp.h:48
u8 * version
Definition: cdp.h:65
u32 cdp_process_node_index
Definition: cdp.h:94
u16 cdp_checksum(void *p, int count)
Definition: cdp_input.c:26
u8 packet_template_index
Definition: cdp.h:57
u8 data[128]
Definition: ipsec.api:248
unsigned char u8
Definition: types.h:56
uword * neighbor_by_sw_if_index
Definition: cdp.h:91
double f64
Definition: types.h:142
void cdp_periodic(vlib_main_t *vm)
Definition: cdp_periodic.c:350
unsigned int u32
Definition: types.h:88
u8 last_packet_signature_valid
Definition: cdp.h:60
u8 * cdp_input_format_trace(u8 *s, va_list *args)
Definition: cdp_input.c:486
vnet_main_t * vnet_main
Definition: cdp.h:105
unsigned short u16
Definition: types.h:57
f64 last_heard
Definition: cdp.h:47
cdp_neighbor_t * neighbors
Definition: cdp.h:82
#define foreach_cdp_error
Definition: cdp.h:112
uword last_packet_signature
Definition: cdp.h:61
u8 tx_pcap_debug
Definition: cdp.h:88
cdp_process_event_t
Definition: cdp.h:135
vlib_main_t * vm
Definition: buffer.c:312
u8 * last_rx_pkt
Definition: cdp.h:70
void cdp_keepalive(cdp_main_t *cm, cdp_neighbor_t *n)
u8 * device_name
Definition: cdp.h:64
u8 ttl_in_seconds
Definition: cdp.h:51
vlib_main_t * vlib_main
Definition: cdp.h:104
vlib_node_registration_t cdp_process_node
(constructor) VLIB_REGISTER_NODE (cdp_process_node)
Definition: cdp_node.c:207
size_t count
Definition: vapi.c:47
cdp_packet_template_id_t
Definition: cdp.h:33
u8 disabled
Definition: cdp.h:54
struct _vlib_node_registration vlib_node_registration_t
u8 * port_id
Definition: cdp.h:66
VLIB buffer representation.
Definition: buffer.h:102
u64 uword
Definition: types.h:112
Definition: cdp.h:79
int cdp_protocol_registered
Definition: cdp.h:98
u8 * platform
Definition: cdp.h:67
u32 sw_if_index
Definition: cdp.h:44