]> git.ipfire.org Git - thirdparty/lldpd.git/blob - src/lldpd-structs.h
lldpd: convert 'oui_info' member to dynamic array
[thirdparty/lldpd.git] / src / lldpd-structs.h
1 /* -*- mode: c; c-file-style: "openbsd" -*- */
2 /*
3 * Copyright (c) 2008 Vincent Bernat <bernat@luffy.cx>
4 *
5 * Permission to use, copy, modify, and/or distribute this software for any
6 * purpose with or without fee is hereby granted, provided that the above
7 * copyright notice and this permission notice appear in all copies.
8 *
9 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16 */
17
18 #ifndef _LLDPD_STRUCTS_H
19 #define _LLDPD_STRUCTS_H
20
21 #if HAVE_CONFIG_H
22 # include <config.h>
23 #endif
24
25 #include <sys/types.h>
26 #include <sys/socket.h>
27
28 /* This is not very convenient, but we need net/if.h for IFNAMSIZ and others but
29 * we may also need linux/if.h in some modules. And they conflict each others.
30 */
31 #ifdef HOST_OS_LINUX
32 # include <linux/if.h>
33 #else
34 # include <net/if.h>
35 #endif
36
37 #include <netinet/in.h>
38 #include <netinet/if_ether.h>
39 #include <sys/queue.h>
40
41 #include "compat/compat.h"
42 #include "marshal.h"
43 #include "lldp-const.h"
44
45 #ifdef ENABLE_DOT1
46 struct lldpd_ppvid {
47 TAILQ_ENTRY(lldpd_ppvid) p_entries;
48 u_int8_t p_cap_status;
49 u_int16_t p_ppvid;
50 };
51 MARSHAL_BEGIN(lldpd_ppvid)
52 MARSHAL_TQE(lldpd_ppvid, p_entries)
53 MARSHAL_END(lldpd_ppvid);
54
55 struct lldpd_vlan {
56 TAILQ_ENTRY(lldpd_vlan) v_entries;
57 char *v_name;
58 u_int16_t v_vid;
59 };
60 MARSHAL_BEGIN(lldpd_vlan)
61 MARSHAL_TQE(lldpd_vlan, v_entries)
62 MARSHAL_STR(lldpd_vlan, v_name)
63 MARSHAL_END(lldpd_vlan);
64
65 struct lldpd_pi {
66 TAILQ_ENTRY(lldpd_pi) p_entries;
67 char *p_pi;
68 int p_pi_len;
69 };
70 MARSHAL_BEGIN(lldpd_pi)
71 MARSHAL_TQE(lldpd_pi, p_entries)
72 MARSHAL_FSTR(lldpd_pi, p_pi, p_pi_len)
73 MARSHAL_END(lldpd_pi);
74 #endif
75
76 #ifdef ENABLE_LLDPMED
77 struct lldpd_med_policy {
78 u_int8_t index; /* Not used. */
79 u_int8_t type;
80 u_int8_t unknown;
81 u_int8_t tagged;
82 u_int16_t vid;
83 u_int8_t priority;
84 u_int8_t dscp;
85 };
86 MARSHAL(lldpd_med_policy);
87
88 struct lldpd_med_loc {
89 u_int8_t index; /* Not used. */
90 u_int8_t format;
91 char *data;
92 int data_len;
93 };
94 MARSHAL_BEGIN(lldpd_med_loc)
95 MARSHAL_FSTR(lldpd_med_loc, data, data_len)
96 MARSHAL_END(lldpd_med_loc);
97
98 struct lldpd_med_power {
99 u_int8_t devicetype; /* PD or PSE */
100 u_int8_t source;
101 u_int8_t priority;
102 u_int16_t val;
103 };
104 MARSHAL(lldpd_med_power);
105 #endif
106
107 #ifdef ENABLE_DOT3
108 struct lldpd_dot3_macphy {
109 u_int8_t autoneg_support;
110 u_int8_t autoneg_enabled;
111 u_int16_t autoneg_advertised;
112 u_int16_t mau_type;
113 };
114
115 struct lldpd_dot3_power {
116 u_int8_t devicetype;
117 u_int8_t supported;
118 u_int8_t enabled;
119 u_int8_t paircontrol;
120 u_int8_t pairs;
121 u_int8_t class;
122 u_int8_t powertype; /* If set to LLDP_DOT3_POWER_8023AT_OFF,
123 following fields have no meaning */
124 u_int8_t source;
125 u_int8_t priority;
126 u_int16_t requested;
127 u_int16_t allocated;
128 };
129 MARSHAL(lldpd_dot3_power);
130 #endif
131
132 enum {
133 LLDPD_AF_UNSPEC = 0,
134 LLDPD_AF_IPV4,
135 LLDPD_AF_IPV6,
136 LLDPD_AF_LAST
137 };
138
139 inline static int
140 lldpd_af(int af)
141 {
142 switch (af) {
143 case LLDPD_AF_IPV4: return AF_INET;
144 case LLDPD_AF_IPV6: return AF_INET6;
145 case LLDPD_AF_LAST: return AF_MAX;
146 default: return AF_UNSPEC;
147 }
148 }
149
150 #define LLDPD_MGMT_MAXADDRSIZE 16 /* sizeof(struct in6_addr) */
151 struct lldpd_mgmt {
152 TAILQ_ENTRY(lldpd_mgmt) m_entries;
153 int m_family;
154 union {
155 struct in_addr inet;
156 struct in6_addr inet6;
157 u_int8_t octets[LLDPD_MGMT_MAXADDRSIZE]; /* network byte order! */
158 } m_addr;
159 size_t m_addrsize;
160 u_int32_t m_iface;
161 };
162 MARSHAL_BEGIN(lldpd_mgmt)
163 MARSHAL_TQE(lldpd_mgmt, m_entries)
164 MARSHAL_END(lldpd_mgmt);
165
166 struct lldpd_chassis {
167 TAILQ_ENTRY(lldpd_chassis) c_entries;
168 u_int16_t c_refcount; /* Reference count by ports */
169 u_int16_t c_index; /* Monotonic index */
170 u_int8_t c_protocol; /* Protocol used to get this chassis */
171 u_int8_t c_id_subtype;
172 char *c_id;
173 int c_id_len;
174 char *c_name;
175 char *c_descr;
176
177 u_int16_t c_cap_available;
178 u_int16_t c_cap_enabled;
179
180 u_int16_t c_ttl;
181
182 TAILQ_HEAD(, lldpd_mgmt) c_mgmt;
183
184 #ifdef ENABLE_LLDPMED
185 u_int16_t c_med_cap_available;
186 u_int8_t c_med_type;
187 char *c_med_hw;
188 char *c_med_fw;
189 char *c_med_sw;
190 char *c_med_sn;
191 char *c_med_manuf;
192 char *c_med_model;
193 char *c_med_asset;
194 #endif
195
196 };
197 /* WARNING: any change to this structure should also be reflected into
198 `lldpd_copy_chassis()` which is not using marshaling. */
199 MARSHAL_BEGIN(lldpd_chassis)
200 MARSHAL_IGNORE(lldpd_chassis, c_entries.tqe_next)
201 MARSHAL_IGNORE(lldpd_chassis, c_entries.tqe_prev)
202 MARSHAL_FSTR(lldpd_chassis, c_id, c_id_len)
203 MARSHAL_STR(lldpd_chassis, c_name)
204 MARSHAL_STR(lldpd_chassis, c_descr)
205 MARSHAL_SUBTQ(lldpd_chassis, lldpd_mgmt, c_mgmt)
206 #ifdef ENABLE_LLDPMED
207 MARSHAL_STR(lldpd_chassis, c_med_hw)
208 MARSHAL_STR(lldpd_chassis, c_med_fw)
209 MARSHAL_STR(lldpd_chassis, c_med_sw)
210 MARSHAL_STR(lldpd_chassis, c_med_sn)
211 MARSHAL_STR(lldpd_chassis, c_med_manuf)
212 MARSHAL_STR(lldpd_chassis, c_med_model)
213 MARSHAL_STR(lldpd_chassis, c_med_asset)
214 #endif
215 MARSHAL_END(lldpd_chassis);
216
217 #ifdef ENABLE_CUSTOM
218 /* Custom TLV struct as defined on page 35 of IEEE 802.1AB-2005 */
219 struct lldpd_custom {
220 TAILQ_ENTRY(lldpd_custom) next; /* Pointer to next custom TLV */
221
222 /* Organizationally Unique Identifier */
223 u_int8_t oui[LLDP_TLV_ORG_OUI_LEN];
224 /* Organizationally Defined Subtype */
225 u_int8_t subtype;
226 /* Organizationally Defined Information String; for now/simplicity static array */
227 u_int8_t *oui_info;
228 /* Organizationally Defined Information String length */
229 int oui_info_len;
230 };
231 MARSHAL_BEGIN(lldpd_custom)
232 MARSHAL_TQE(lldpd_custom, next)
233 MARSHAL_FSTR(lldpd_custom, oui_info, oui_info_len)
234 MARSHAL_END(lldpd_custom);
235 #endif
236
237 struct lldpd_port {
238 TAILQ_ENTRY(lldpd_port) p_entries;
239 struct lldpd_chassis *p_chassis; /* Attached chassis */
240 time_t p_lastchange; /* Time of last change of values */
241 time_t p_lastupdate; /* Time of last update received */
242 struct lldpd_frame *p_lastframe; /* Frame received during last update */
243 u_int8_t p_protocol; /* Protocol used to get this port */
244 u_int8_t p_hidden_in:1; /* Considered as hidden for reception */
245 u_int8_t p_hidden_out:2; /* Considered as hidden for emission */
246 /* Important: all fields that should be ignored to check if a port has
247 * been changed should be before this mark. */
248 #define LLDPD_PORT_START_MARKER (offsetof(struct lldpd_port, p_id_subtype))
249 u_int8_t p_id_subtype;
250 char *p_id;
251 int p_id_len;
252 char *p_descr;
253 u_int16_t p_mfs;
254
255 #ifdef ENABLE_DOT3
256 /* Dot3 stuff */
257 u_int32_t p_aggregid;
258 struct lldpd_dot3_macphy p_macphy;
259 struct lldpd_dot3_power p_power;
260 #endif
261
262 #ifdef ENABLE_LLDPMED
263 u_int16_t p_med_cap_enabled;
264 struct lldpd_med_policy p_med_policy[LLDP_MED_APPTYPE_LAST];
265 struct lldpd_med_loc p_med_location[LLDP_MED_LOCFORMAT_LAST];
266 struct lldpd_med_power p_med_power;
267 #endif
268
269 #ifdef ENABLE_DOT1
270 u_int16_t p_pvid;
271 TAILQ_HEAD(, lldpd_vlan) p_vlans;
272 TAILQ_HEAD(, lldpd_ppvid) p_ppvids;
273 TAILQ_HEAD(, lldpd_pi) p_pids;
274 #endif
275 #ifdef ENABLE_CUSTOM
276 TAILQ_HEAD(, lldpd_custom) p_custom_list;
277 #endif
278 };
279 MARSHAL_BEGIN(lldpd_port)
280 MARSHAL_TQE(lldpd_port, p_entries)
281 MARSHAL_POINTER(lldpd_port, lldpd_chassis, p_chassis)
282 MARSHAL_IGNORE(lldpd_port, p_lastframe)
283 MARSHAL_FSTR(lldpd_port, p_id, p_id_len)
284 MARSHAL_STR(lldpd_port, p_descr)
285 #ifdef ENABLE_LLDPMED
286 MARSHAL_SUBSTRUCT(lldpd_port, lldpd_med_loc, p_med_location[0])
287 MARSHAL_SUBSTRUCT(lldpd_port, lldpd_med_loc, p_med_location[1])
288 MARSHAL_SUBSTRUCT(lldpd_port, lldpd_med_loc, p_med_location[2])
289 #endif
290 #ifdef ENABLE_DOT1
291 MARSHAL_SUBTQ(lldpd_port, lldpd_vlan, p_vlans)
292 MARSHAL_SUBTQ(lldpd_port, lldpd_ppvid, p_ppvids)
293 MARSHAL_SUBTQ(lldpd_port, lldpd_pi, p_pids)
294 #endif
295 #ifdef ENABLE_CUSTOM
296 MARSHAL_SUBTQ(lldpd_port, lldpd_custom, p_custom_list)
297 #endif
298 MARSHAL_END(lldpd_port);
299
300 /* Used to modify some port related settings */
301 struct lldpd_port_set {
302 char *ifname;
303 char *local_id;
304 char *local_descr;
305 #ifdef ENABLE_LLDPMED
306 struct lldpd_med_policy *med_policy;
307 struct lldpd_med_loc *med_location;
308 struct lldpd_med_power *med_power;
309 #endif
310 #ifdef ENABLE_DOT3
311 struct lldpd_dot3_power *dot3_power;
312 #endif
313 #ifdef ENABLE_CUSTOM
314 struct lldpd_custom *custom;
315 int custom_list_clear;
316 #endif
317 };
318 MARSHAL_BEGIN(lldpd_port_set)
319 MARSHAL_STR(lldpd_port_set, ifname)
320 MARSHAL_STR(lldpd_port_set, local_id)
321 MARSHAL_STR(lldpd_port_set, local_descr)
322 #ifdef ENABLE_LLDPMED
323 MARSHAL_POINTER(lldpd_port_set, lldpd_med_policy, med_policy)
324 MARSHAL_POINTER(lldpd_port_set, lldpd_med_loc, med_location)
325 MARSHAL_POINTER(lldpd_port_set, lldpd_med_power, med_power)
326 #endif
327 #ifdef ENABLE_DOT3
328 MARSHAL_POINTER(lldpd_port_set, lldpd_dot3_power, dot3_power)
329 #endif
330 #ifdef ENABLE_CUSTOM
331 MARSHAL_POINTER(lldpd_port_set, lldpd_custom, custom)
332 #endif
333 MARSHAL_END(lldpd_port_set);
334
335 /* Smart mode / Hide mode */
336 #define SMART_INCOMING_FILTER (1<<0) /* Incoming filtering enabled */
337 #define SMART_INCOMING_ONE_PROTO (1<<1) /* On reception, keep only one proto */
338 #define SMART_INCOMING_ONE_NEIGH (1<<2) /* On reception, keep only one neighbor */
339 #define SMART_OUTGOING_FILTER (1<<3) /* Outgoing filtering enabled */
340 #define SMART_OUTGOING_ONE_PROTO (1<<4) /* On emission, keep only one proto */
341 #define SMART_OUTGOING_ONE_NEIGH (1<<5) /* On emission, consider only one neighbor */
342 #define SMART_INCOMING (SMART_INCOMING_FILTER | \
343 SMART_INCOMING_ONE_PROTO | \
344 SMART_INCOMING_ONE_NEIGH)
345 #define SMART_OUTGOING (SMART_OUTGOING_FILTER | \
346 SMART_OUTGOING_ONE_PROTO | \
347 SMART_OUTGOING_ONE_NEIGH)
348
349 struct lldpd_config {
350 int c_paused; /* lldpd is paused */
351 int c_tx_interval; /* Transmit interval */
352 int c_smart; /* Bitmask for smart configuration (see SMART_*) */
353 int c_receiveonly; /* Receive only mode */
354 int c_max_neighbors; /* Maximum number of neighbors (per protocol) */
355
356 char *c_mgmt_pattern; /* Pattern to match a management address */
357 char *c_cid_pattern; /* Pattern to match interfaces to use for chassis ID */
358 char *c_iface_pattern; /* Pattern to match interfaces to use */
359
360 char *c_platform; /* Override platform description (for CDP) */
361 char *c_description; /* Override chassis description */
362 char *c_hostname; /* Override system name */
363 int c_advertise_version; /* Should the precise version be advertised? */
364 int c_set_ifdescr; /* Set interface description */
365 int c_promisc; /* Interfaces should be in promiscuous mode */
366 int c_cap_advertise; /* Chassis capabilities advertisement */
367 int c_mgmt_advertise; /* Management addresses advertisement */
368
369 #ifdef ENABLE_LLDPMED
370 int c_noinventory; /* Don't send inventory with LLDP-MED */
371 int c_enable_fast_start; /* enable fast start */
372 int c_tx_fast_init; /* Num of lldpd lldppdu's for fast start */
373 int c_tx_fast_interval; /* Time intr between sends during fast start */
374 #endif
375 int c_tx_hold; /* Transmit hold */
376 int c_bond_slave_src_mac_type; /* Src mac type in lldp frames over bond
377 slaves */
378 int c_lldp_portid_type; /* The PortID type */
379 };
380 MARSHAL_BEGIN(lldpd_config)
381 MARSHAL_STR(lldpd_config, c_mgmt_pattern)
382 MARSHAL_STR(lldpd_config, c_cid_pattern)
383 MARSHAL_STR(lldpd_config, c_iface_pattern)
384 MARSHAL_STR(lldpd_config, c_hostname)
385 MARSHAL_STR(lldpd_config, c_platform)
386 MARSHAL_STR(lldpd_config, c_description)
387 MARSHAL_END(lldpd_config);
388
389 struct lldpd_frame {
390 int size;
391 unsigned char frame[1];
392 };
393
394 struct lldpd_hardware;
395 struct lldpd;
396 struct lldpd_ops {
397 int(*send)(struct lldpd *,
398 struct lldpd_hardware*,
399 char *, size_t); /* Function to send a frame */
400 int(*recv)(struct lldpd *,
401 struct lldpd_hardware*,
402 int, char *, size_t); /* Function to receive a frame */
403 int(*cleanup)(struct lldpd *, struct lldpd_hardware *); /* Cleanup function. */
404 };
405
406 /* An interface is uniquely identified by h_ifindex, h_ifname and h_ops. This
407 * means if an interface becomes enslaved, it will be considered as a new
408 * interface. The same applies for renaming and we include the index in case of
409 * renaming to an existing interface. */
410 struct lldpd_hardware {
411 TAILQ_ENTRY(lldpd_hardware) h_entries;
412
413 struct lldpd *h_cfg; /* Pointer to main configuration */
414 void *h_recv; /* FD for reception */
415 int h_sendfd; /* FD for sending, only used by h_ops */
416 int h_mangle; /* 1 if we have to mangle the MAC address */
417 struct lldpd_ops *h_ops; /* Hardware-dependent functions */
418 void *h_data; /* Hardware-dependent data */
419 void *h_timer; /* Timer for this port */
420
421 int h_mtu;
422 int h_flags; /* Packets will be sent only
423 if IFF_RUNNING. Will be
424 removed if this is left
425 to 0. */
426 int h_ifindex; /* Interface index, used by SNMP */
427 char h_ifname[IFNAMSIZ]; /* Should be unique */
428 u_int8_t h_lladdr[ETHER_ADDR_LEN];
429
430 u_int64_t h_tx_cnt;
431 u_int64_t h_rx_cnt;
432 u_int64_t h_rx_discarded_cnt;
433 u_int64_t h_rx_unrecognized_cnt;
434 u_int64_t h_ageout_cnt;
435 u_int64_t h_insert_cnt;
436 u_int64_t h_delete_cnt;
437 u_int64_t h_drop_cnt;
438
439 /* Previous values of different stuff. */
440 /* Backup of the previous local port. Used to check if there was a
441 * change to send an immediate update. All those are not marshalled to
442 * the client. */
443 void *h_lport_previous;
444 ssize_t h_lport_previous_len;
445 /* Backup of the previous chassis ID. Used to check if there was a
446 * change and send an LLDP shutdown. */
447 u_int8_t h_lchassis_previous_id_subtype;
448 char *h_lchassis_previous_id;
449 int h_lchassis_previous_id_len;
450 /* Backup of the previous port ID. Used to check if there was a change
451 * and send an LLDP shutdown. */
452 u_int8_t h_lport_previous_id_subtype;
453 char *h_lport_previous_id;
454 int h_lport_previous_id_len;
455
456 struct lldpd_port h_lport; /* Port attached to this hardware port */
457 TAILQ_HEAD(, lldpd_port) h_rports; /* Remote ports */
458
459 #ifdef ENABLE_LLDPMED
460 int h_tx_fast; /* current tx fast start count */
461 #endif
462 };
463 MARSHAL_BEGIN(lldpd_hardware)
464 MARSHAL_IGNORE(lldpd_hardware, h_entries.tqe_next)
465 MARSHAL_IGNORE(lldpd_hardware, h_entries.tqe_prev)
466 MARSHAL_IGNORE(lldpd_hardware, h_ops)
467 MARSHAL_IGNORE(lldpd_hardware, h_data)
468 MARSHAL_IGNORE(lldpd_hardware, h_cfg)
469 MARSHAL_IGNORE(lldpd_hardware, h_lport_previous)
470 MARSHAL_IGNORE(lldpd_hardware, h_lport_previous_len)
471 MARSHAL_IGNORE(lldpd_hardware, h_lchassis_previous_id_subtype)
472 MARSHAL_IGNORE(lldpd_hardware, h_lchassis_previous_id)
473 MARSHAL_IGNORE(lldpd_hardware, h_lchassis_previous_id_len)
474 MARSHAL_IGNORE(lldpd_hardware, h_lport_previous_id_subtype)
475 MARSHAL_IGNORE(lldpd_hardware, h_lport_previous_id)
476 MARSHAL_IGNORE(lldpd_hardware, h_lport_previous_id_len)
477 MARSHAL_SUBSTRUCT(lldpd_hardware, lldpd_port, h_lport)
478 MARSHAL_SUBTQ(lldpd_hardware, lldpd_port, h_rports)
479 MARSHAL_END(lldpd_hardware);
480
481 struct lldpd_interface {
482 TAILQ_ENTRY(lldpd_interface) next;
483 char *name;
484 };
485 MARSHAL_BEGIN(lldpd_interface)
486 MARSHAL_TQE(lldpd_interface, next)
487 MARSHAL_STR(lldpd_interface, name)
488 MARSHAL_END(lldpd_interface);
489 TAILQ_HEAD(lldpd_interface_list, lldpd_interface);
490 MARSHAL_TQ(lldpd_interface_list, lldpd_interface);
491
492 struct lldpd_neighbor_change {
493 char *ifname;
494 #define NEIGHBOR_CHANGE_DELETED -1
495 #define NEIGHBOR_CHANGE_ADDED 1
496 #define NEIGHBOR_CHANGE_UPDATED 0
497 int state;
498 struct lldpd_port *neighbor;
499 };
500 MARSHAL_BEGIN(lldpd_neighbor_change)
501 MARSHAL_STR(lldpd_neighbor_change, ifname)
502 MARSHAL_POINTER(lldpd_neighbor_change, lldpd_port, neighbor)
503 MARSHAL_END(lldpd_neighbor_change);
504
505 /* Cleanup functions */
506 void lldpd_chassis_mgmt_cleanup(struct lldpd_chassis *);
507 void lldpd_chassis_cleanup(struct lldpd_chassis *, int);
508 void lldpd_remote_cleanup(struct lldpd_hardware *,
509 void(*expire)(struct lldpd_hardware *, struct lldpd_port *),
510 int);
511 void lldpd_port_cleanup(struct lldpd_port *, int);
512 void lldpd_config_cleanup(struct lldpd_config *);
513 #ifdef ENABLE_DOT1
514 void lldpd_ppvid_cleanup(struct lldpd_port *);
515 void lldpd_vlan_cleanup(struct lldpd_port *);
516 void lldpd_pi_cleanup(struct lldpd_port *);
517 #endif
518 #ifdef ENABLE_CUSTOM
519 void lldpd_custom_list_cleanup(struct lldpd_port *);
520 #endif
521
522 #endif