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];
 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
 218 struct lldpd_port {
 219         TAILQ_ENTRY(lldpd_port)  p_entries;
 220         struct lldpd_chassis    *p_chassis;    /* Attached chassis */
 221         time_t                   p_lastchange; /* Time of last change of values */
 222         time_t                   p_lastupdate; /* Time of last update received */
 223         struct lldpd_frame      *p_lastframe;  /* Frame received during last update */
 224         u_int8_t                 p_protocol;   /* Protocol used to get this port */
 225         u_int8_t                 p_hidden_in:1; /* Considered as hidden for reception */
 226         u_int8_t                 p_hidden_out:2; /* Considered as hidden for emission */
 227         /* Important: all fields that should be ignored to check if a port has
 228          * been changed should be before this mark. */
 229 #define LLDPD_PORT_START_MARKER (offsetof(struct lldpd_port, p_id_subtype))
 230         u_int8_t                 p_id_subtype;
 231         char                    *p_id;
 232         int                      p_id_len;
 233         char                    *p_descr;
 234         u_int16_t                p_mfs;
 235
 236 #ifdef ENABLE_DOT3
 237         /* Dot3 stuff */
 238         u_int32_t                p_aggregid;
 239         struct lldpd_dot3_macphy p_macphy;
 240         struct lldpd_dot3_power  p_power;
 241 #endif
 242
 243 #ifdef ENABLE_LLDPMED
 244         u_int16_t                p_med_cap_enabled;
 245         struct lldpd_med_policy  p_med_policy[LLDP_MED_APPTYPE_LAST];
 246         struct lldpd_med_loc     p_med_location[LLDP_MED_LOCFORMAT_LAST];
 247         struct lldpd_med_power   p_med_power;
 248 #endif
 249
 250 #ifdef ENABLE_DOT1
 251         u_int16_t                p_pvid;
 252         TAILQ_HEAD(, lldpd_vlan) p_vlans;
 253         TAILQ_HEAD(, lldpd_ppvid) p_ppvids;
 254         TAILQ_HEAD(, lldpd_pi)    p_pids;
 255 #endif
 256 };
 257 MARSHAL_BEGIN(lldpd_port)
 258 MARSHAL_TQE(lldpd_port, p_entries)
 259 MARSHAL_POINTER(lldpd_port, lldpd_chassis, p_chassis)
 260 MARSHAL_IGNORE(lldpd_port, p_lastframe)
 261 MARSHAL_FSTR(lldpd_port, p_id, p_id_len)
 262 MARSHAL_STR(lldpd_port, p_descr)
 263 #ifdef ENABLE_LLDPMED
 264 MARSHAL_SUBSTRUCT(lldpd_port, lldpd_med_loc, p_med_location[0])
 265 MARSHAL_SUBSTRUCT(lldpd_port, lldpd_med_loc, p_med_location[1])
 266 MARSHAL_SUBSTRUCT(lldpd_port, lldpd_med_loc, p_med_location[2])
 267 #endif
 268 #ifdef ENABLE_DOT1
 269 MARSHAL_SUBTQ(lldpd_port, lldpd_vlan, p_vlans)
 270 MARSHAL_SUBTQ(lldpd_port, lldpd_ppvid, p_ppvids)
 271 MARSHAL_SUBTQ(lldpd_port, lldpd_pi, p_pids)
 272 #endif
 273 MARSHAL_END(lldpd_port);
 274
 275 /* Used to modify some port related settings */
 276 struct lldpd_port_set {
 277         char *ifname;
 278         char *local_id;
 279         char *local_descr;
 280 #ifdef ENABLE_LLDPMED
 281         struct lldpd_med_policy *med_policy;
 282         struct lldpd_med_loc    *med_location;
 283         struct lldpd_med_power  *med_power;
 284 #endif
 285 #ifdef ENABLE_DOT3
 286         struct lldpd_dot3_power *dot3_power;
 287 #endif
 288 };
 289 MARSHAL_BEGIN(lldpd_port_set)
 290 MARSHAL_STR(lldpd_port_set, ifname)
 291 MARSHAL_STR(lldpd_port_set, local_id)
 292 MARSHAL_STR(lldpd_port_set, local_descr)
 293 #ifdef ENABLE_LLDPMED
 294 MARSHAL_POINTER(lldpd_port_set, lldpd_med_policy, med_policy)
 295 MARSHAL_POINTER(lldpd_port_set, lldpd_med_loc,    med_location)
 296 MARSHAL_POINTER(lldpd_port_set, lldpd_med_power,  med_power)
 297 #endif
 298 #ifdef ENABLE_DOT3
 299 MARSHAL_POINTER(lldpd_port_set, lldpd_dot3_power, dot3_power)
 300 #endif
 301 MARSHAL_END(lldpd_port_set);
 302
 303 /* Smart mode / Hide mode */
 304 #define SMART_INCOMING_FILTER           (1<<0) /* Incoming filtering enabled */
 305 #define SMART_INCOMING_ONE_PROTO        (1<<1) /* On reception, keep only one proto */
 306 #define SMART_INCOMING_ONE_NEIGH        (1<<2) /* On reception, keep only one neighbor */
 307 #define SMART_OUTGOING_FILTER           (1<<3) /* Outgoing filtering enabled */
 308 #define SMART_OUTGOING_ONE_PROTO        (1<<4) /* On emission, keep only one proto */
 309 #define SMART_OUTGOING_ONE_NEIGH        (1<<5) /* On emission, consider only one neighbor */
 310 #define SMART_INCOMING (SMART_INCOMING_FILTER |    \
 311                          SMART_INCOMING_ONE_PROTO | \
 312                          SMART_INCOMING_ONE_NEIGH)
 313 #define SMART_OUTGOING (SMART_OUTGOING_FILTER |         \
 314                         SMART_OUTGOING_ONE_PROTO |      \
 315                         SMART_OUTGOING_ONE_NEIGH)
 316
 317 struct lldpd_config {
 318         int c_paused;           /* lldpd is paused */
 319         int c_tx_interval;      /* Transmit interval */
 320         int c_smart;            /* Bitmask for smart configuration (see SMART_*) */
 321         int c_receiveonly;      /* Receive only mode */
 322         int c_max_neighbors;    /* Maximum number of neighbors (per protocol) */
 323
 324         char *c_mgmt_pattern;   /* Pattern to match a management address */
 325         char *c_cid_pattern;    /* Pattern to match interfaces to use for chassis ID */
 326         char *c_iface_pattern;  /* Pattern to match interfaces to use */
 327
 328         char *c_platform;       /* Override platform description (for CDP) */
 329         char *c_description;    /* Override chassis description */
 330         char *c_hostname;       /* Override system name */
 331         int c_advertise_version; /* Should the precise version be advertised? */
 332         int c_set_ifdescr;       /* Set interface description */
 333         int c_promisc;           /* Interfaces should be in promiscuous mode */
 334         int c_cap_advertise;     /* Chassis capabilities advertisement */
 335         int c_mgmt_advertise;    /* Management addresses advertisement */
 336
 337 #ifdef ENABLE_LLDPMED
 338         int c_noinventory;      /* Don't send inventory with LLDP-MED */
 339         int c_enable_fast_start; /* enable fast start */
 340         int c_tx_fast_init;     /* Num of lldpd lldppdu's for fast start */
 341         int c_tx_fast_interval; /* Time intr between sends during fast start */
 342 #endif
 343         int c_tx_hold;          /* Transmit hold */
 344         int c_bond_slave_src_mac_type; /* Src mac type in lldp frames over bond
 345                                           slaves */
 346         int c_lldp_portid_type; /* The PortID type */
 347 };
 348 MARSHAL_BEGIN(lldpd_config)
 349 MARSHAL_STR(lldpd_config, c_mgmt_pattern)
 350 MARSHAL_STR(lldpd_config, c_cid_pattern)
 351 MARSHAL_STR(lldpd_config, c_iface_pattern)
 352 MARSHAL_STR(lldpd_config, c_hostname)
 353 MARSHAL_STR(lldpd_config, c_platform)
 354 MARSHAL_STR(lldpd_config, c_description)
 355 MARSHAL_END(lldpd_config);
 356
 357 struct lldpd_frame {
 358         int size;
 359         unsigned char frame[1];
 360 };
 361
 362 struct lldpd_hardware;
 363 struct lldpd;
 364 struct lldpd_ops {
 365         int(*send)(struct lldpd *,
 366                    struct lldpd_hardware*,
 367                    char *, size_t); /* Function to send a frame */
 368         int(*recv)(struct lldpd *,
 369                    struct lldpd_hardware*,
 370                    int, char *, size_t); /* Function to receive a frame */
 371         int(*cleanup)(struct lldpd *, struct lldpd_hardware *); /* Cleanup function. */
 372 };
 373
 374 /* An interface is uniquely identified by h_ifindex, h_ifname and h_ops. This
 375  * means if an interface becomes enslaved, it will be considered as a new
 376  * interface. The same applies for renaming and we include the index in case of
 377  * renaming to an existing interface. */
 378 struct lldpd_hardware {
 379         TAILQ_ENTRY(lldpd_hardware)      h_entries;
 380
 381         struct lldpd            *h_cfg;     /* Pointer to main configuration */
 382         void                    *h_recv;    /* FD for reception */
 383         int                      h_sendfd;  /* FD for sending, only used by h_ops */
 384         int                      h_mangle;  /* 1 if we have to mangle the MAC address */
 385         struct lldpd_ops        *h_ops;     /* Hardware-dependent functions */
 386         void                    *h_data;    /* Hardware-dependent data */
 387         void                    *h_timer;   /* Timer for this port */
 388
 389         int                      h_mtu;
 390         int                      h_flags; /* Packets will be sent only
 391                                              if IFF_RUNNING. Will be
 392                                              removed if this is left
 393                                              to 0. */
 394         int                      h_ifindex; /* Interface index, used by SNMP */
 395         char                     h_ifname[IFNAMSIZ]; /* Should be unique */
 396         u_int8_t                 h_lladdr[ETHER_ADDR_LEN];
 397
 398         u_int64_t                h_tx_cnt;
 399         u_int64_t                h_rx_cnt;
 400         u_int64_t                h_rx_discarded_cnt;
 401         u_int64_t                h_rx_unrecognized_cnt;
 402         u_int64_t                h_ageout_cnt;
 403         u_int64_t                h_insert_cnt;
 404         u_int64_t                h_delete_cnt;
 405         u_int64_t                h_drop_cnt;
 406
 407         /* Previous values of different stuff. */
 408         /* Backup of the previous local port. Used to check if there was a
 409          * change to send an immediate update. All those are not marshalled to
 410          * the client. */
 411         void                    *h_lport_previous;
 412         ssize_t                  h_lport_previous_len;
 413         /* Backup of the previous chassis ID. Used to check if there was a
 414          * change and send an LLDP shutdown. */
 415         u_int8_t                 h_lchassis_previous_id_subtype;
 416         char                    *h_lchassis_previous_id;
 417         int                      h_lchassis_previous_id_len;
 418         /* Backup of the previous port ID. Used to check if there was a change
 419          * and send an LLDP shutdown. */
 420         u_int8_t                 h_lport_previous_id_subtype;
 421         char                    *h_lport_previous_id;
 422         int                      h_lport_previous_id_len;
 423
 424         struct lldpd_port        h_lport;  /* Port attached to this hardware port */
 425         TAILQ_HEAD(, lldpd_port) h_rports; /* Remote ports */
 426
 427 #ifdef ENABLE_LLDPMED
 428         int                     h_tx_fast; /* current tx fast start count */
 429 #endif
 430 };
 431 MARSHAL_BEGIN(lldpd_hardware)
 432 MARSHAL_IGNORE(lldpd_hardware, h_entries.tqe_next)
 433 MARSHAL_IGNORE(lldpd_hardware, h_entries.tqe_prev)
 434 MARSHAL_IGNORE(lldpd_hardware, h_ops)
 435 MARSHAL_IGNORE(lldpd_hardware, h_data)
 436 MARSHAL_IGNORE(lldpd_hardware, h_cfg)
 437 MARSHAL_IGNORE(lldpd_hardware, h_lport_previous)
 438 MARSHAL_IGNORE(lldpd_hardware, h_lport_previous_len)
 439 MARSHAL_IGNORE(lldpd_hardware, h_lchassis_previous_id_subtype)
 440 MARSHAL_IGNORE(lldpd_hardware, h_lchassis_previous_id)
 441 MARSHAL_IGNORE(lldpd_hardware, h_lchassis_previous_id_len)
 442 MARSHAL_IGNORE(lldpd_hardware, h_lport_previous_id_subtype)
 443 MARSHAL_IGNORE(lldpd_hardware, h_lport_previous_id)
 444 MARSHAL_IGNORE(lldpd_hardware, h_lport_previous_id_len)
 445 MARSHAL_SUBSTRUCT(lldpd_hardware, lldpd_port, h_lport)
 446 MARSHAL_SUBTQ(lldpd_hardware, lldpd_port, h_rports)
 447 MARSHAL_END(lldpd_hardware);
 448
 449 struct lldpd_interface {
 450         TAILQ_ENTRY(lldpd_interface) next;
 451         char                    *name;
 452 };
 453 MARSHAL_BEGIN(lldpd_interface)
 454 MARSHAL_TQE(lldpd_interface, next)
 455 MARSHAL_STR(lldpd_interface, name)
 456 MARSHAL_END(lldpd_interface);
 457 TAILQ_HEAD(lldpd_interface_list, lldpd_interface);
 458 MARSHAL_TQ(lldpd_interface_list, lldpd_interface);
 459
 460 struct lldpd_neighbor_change {
 461         char *ifname;
 462 #define NEIGHBOR_CHANGE_DELETED -1
 463 #define NEIGHBOR_CHANGE_ADDED    1
 464 #define NEIGHBOR_CHANGE_UPDATED  0
 465         int state;
 466         struct lldpd_port *neighbor;
 467 };
 468 MARSHAL_BEGIN(lldpd_neighbor_change)
 469 MARSHAL_STR(lldpd_neighbor_change, ifname)
 470 MARSHAL_POINTER(lldpd_neighbor_change, lldpd_port, neighbor)
 471 MARSHAL_END(lldpd_neighbor_change);
 472
 473 /* Cleanup functions */
 474 void     lldpd_chassis_mgmt_cleanup(struct lldpd_chassis *);
 475 void     lldpd_chassis_cleanup(struct lldpd_chassis *, int);
 476 void     lldpd_remote_cleanup(struct lldpd_hardware *,
 477     void(*expire)(struct lldpd_hardware *, struct lldpd_port *),
 478     int);
 479 void     lldpd_port_cleanup(struct lldpd_port *, int);
 480 void     lldpd_config_cleanup(struct lldpd_config *);
 481 #ifdef ENABLE_DOT1
 482 void     lldpd_ppvid_cleanup(struct lldpd_port *);
 483 void     lldpd_vlan_cleanup(struct lldpd_port *);
 484 void     lldpd_pi_cleanup(struct lldpd_port *);
 485 #endif
 486
 487 #endif