FD.io VPP  v17.01-9-ge7dcee4
Vector Packet Processing
lldp_node.h
Go to the documentation of this file.
1 /*
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:
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  * @file
17  * @brief LLDP global declarations
18  */
19 #ifndef __included_lldp_node_h__
20 #define __included_lldp_node_h__
21 
22 #include <vlib/vlib.h>
23 #include <vlib/unix/unix.h>
24 #include <vnet/snap/snap.h>
25 #include <vppinfra/format.h>
26 #include <vppinfra/hash.h>
27 
29 
30 typedef struct lldp_intf
31 {
32  /* hw interface index */
34 
35  /* Timers */
38 
39  /* Info received from peer */
45 
46 } lldp_intf_t;
47 
48 typedef struct
49 {
50  /* pool of lldp-enabled interface context data */
52 
53  /* rapidly find an interface by vlib hw interface index */
55 
56  /* Background process node index */
58 
59  /* interface idxs (into intfs pool) in the order of timing out */
61 
62  /* index of the interface which will time out next */
64 
65  /* packet template for sending out packets */
67 
68  /* convenience variables */
71 
72  /* system name advertised over LLDP (default is none) */
74 
75  /* IEEE Std 802.1AB-2009:
76  * 9.2.5.6 msgTxHold
77  * This variable is used, as a multiplier of msgTxInterval, to determine the
78  * value of txTTL that is carried in LLDP frames transmitted by the LLDP
79  * agent. The recommended default value of msgTxHold is 4; this value can
80  * be changed by management to any value in the range 1 through 100.
81  */
83 
84  /* IEEE Std 802.1AB-2009:
85  * 9.2.5.7 msgTxInterval
86  * This variable defines the time interval in timer ticks between
87  * transmissions during normal transmission periods (i.e., txFast is zero).
88  * The recommended default value for msgTxInterval is 30 s; this value can
89  * be changed by management to any value in the range 1 through 3600.
90  */
92 } lldp_main_t;
93 
94 #define LLDP_MIN_TX_HOLD (1)
95 #define LLDP_MAX_TX_HOLD (100)
96 #define LLDP_MIN_TX_INTERVAL (1)
97 #define LLDP_MAX_TX_INTERVAL (3600)
98 
99 extern lldp_main_t lldp_main;
100 
101 /* Packet counters */
102 #define foreach_lldp_error(F) \
103  F(NONE, "good lldp packets (processed)") \
104  F(CACHE_HIT, "good lldp packets (cache hit)") \
105  F(BAD_TLV, "lldp packets with bad TLVs") \
106  F(DISABLED, "lldp packets received on disabled interfaces")
107 
108 typedef enum
109 {
110 #define F(sym, str) LLDP_ERROR_##sym,
112 #undef F
113  LLDP_N_ERROR,
114 } lldp_error_t;
115 
116 /* lldp packet trace capture */
117 typedef struct
118 {
120  u8 data[400];
122 
123 enum
124 {
127 
130 void lldp_delete_intf (lldp_main_t * lm, lldp_intf_t * n);
131 lldp_error_t lldp_input (vlib_main_t * vm, vlib_buffer_t * b0, u32 bi0);
132 u8 *lldp_input_format_trace (u8 * s, va_list * args);
133 void lldp_send_ethernet (lldp_main_t * lm, lldp_intf_t * n, int shutdown);
136 
137 #endif /* __included_lldp_node_h__ */
138 
139 /*
140  * fd.io coding-style-patch-verification: ON
141  *
142  * Local Variables:
143  * eval: (c-set-style "gnu")
144  * End:
145  */
vnet_main_t * vnet_main
Definition: lldp_node.h:70
u32 hw_if_index
Definition: lldp_node.h:33
lldp_chassis_id_subtype_t
Definition: lldp_protocol.h:85
u32 intfs_timeouts_idx
Definition: lldp_node.h:63
u8 * chassis_id
Definition: lldp_node.h:40
lldp_intf_t * intfs
Definition: lldp_node.h:51
f64 last_sent
Definition: lldp_node.h:37
u32 * intfs_timeouts
Definition: lldp_node.h:60
u16 ttl
Definition: lldp_node.h:42
void lldp_unschedule_intf(lldp_main_t *lm, lldp_intf_t *n)
Definition: lldp_node.c:267
void lldp_send_ethernet(lldp_main_t *lm, lldp_intf_t *n, int shutdown)
Definition: lldp_output.c:115
u8 msg_tx_hold
Definition: lldp_node.h:82
u8 * lldp_input_format_trace(u8 *s, va_list *args)
Definition: lldp_cli.c:610
u8 * port_id
Definition: lldp_node.h:41
lldp_error_t lldp_input(vlib_main_t *vm, vlib_buffer_t *b0, u32 bi0)
Definition: lldp_input.c:249
void lldp_delete_intf(lldp_main_t *lm, lldp_intf_t *n)
Definition: lldp_output.c:162
enum @237 lldp_process_event_t
lldp_error_t
Definition: lldp_node.h:108
u16 msg_tx_interval
Definition: lldp_node.h:91
uword * intf_by_hw_if_index
Definition: lldp_node.h:54
lldp_main_t lldp_main
Definition: lldp_input.c:117
void lldp_schedule_intf(lldp_main_t *lm, lldp_intf_t *n)
Definition: lldp_node.c:242
lldp_intf_t * lldp_get_intf(lldp_main_t *lm, u32 hw_if_index)
Definition: lldp_input.c:212
LLDP protocol declarations.
unsigned int u32
Definition: types.h:88
#define foreach_lldp_error(F)
Definition: lldp_node.h:102
u32 lldp_process_node_index
Definition: lldp_node.h:57
lldp_port_id_subtype_t
u64 uword
Definition: types.h:112
vlib_main_t * vlib_main
Definition: lldp_node.h:69
struct lldp_intf lldp_intf_t
unsigned short u16
Definition: types.h:57
lldp_port_id_subtype_t port_id_subtype
Definition: lldp_node.h:43
double f64
Definition: types.h:142
unsigned char u8
Definition: types.h:56
#define F(sym, str)
Definition: lldp_node.h:110
lldp_chassis_id_subtype_t chassis_id_subtype
Definition: lldp_node.h:44
lldp_intf_t * lldp_create_intf(lldp_main_t *lm, u32 hw_if_index)
Definition: lldp_input.c:224
vlib_packet_template_t packet_template
Definition: lldp_node.h:66
u8 * sys_name
Definition: lldp_node.h:73
f64 last_heard
Definition: lldp_node.h:36