src/systemd/sd-lldp.h

   1 #ifndef foosdlldphfoo
   2 #define foosdlldphfoo
   3
   4 /***
   5   This file is part of systemd.
   6
   7   Copyright (C) 2014 Tom Gundersen
   8   Copyright (C) 2014 Susant Sahani
   9
  10   systemd is free software; you can redistribute it and/or modify it
  11   under the terms of the GNU Lesser General Public License as published by
  12   the Free Software Foundation; either version 2.1 of the License, or
  13   (at your option) any later version.
  14
  15   systemd is distributed in the hope that it will be useful, but
  16   WITHOUT ANY WARRANTY; without even the implied warranty of
  17   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  18   Lesser General Public License for more details.
  19
  20   You should have received a copy of the GNU Lesser General Public License
  21   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  22 ***/
  23
  24 #include <inttypes.h>
  25 #include <net/ethernet.h>
  26
  27 #include "sd-event.h"
  28
  29 #include "_sd-common.h"
  30
  31 _SD_BEGIN_DECLARATIONS;
  32
  33 typedef struct sd_lldp sd_lldp;
  34 typedef struct sd_lldp_neighbor sd_lldp_neighbor;
  35
  36 #define SD_LLDP_MULTICAST_ADDR     { 0x01, 0x80, 0xc2, 0x00, 0x00, 0x0e }
  37
  38 /* IEEE 802.3AB Clause 9: TLV Types */
  39 enum {
  40         SD_LLDP_TYPE_END                  =   0,
  41         SD_LLDP_TYPE_CHASSIS_ID           =   1,
  42         SD_LLDP_TYPE_PORT_ID              =   2,
  43         SD_LLDP_TYPE_TTL                  =   3,
  44         SD_LLDP_TYPE_PORT_DESCRIPTION     =   4,
  45         SD_LLDP_TYPE_SYSTEM_NAME          =   5,
  46         SD_LLDP_TYPE_SYSTEM_DESCRIPTION   =   6,
  47         SD_LLDP_TYPE_SYSTEM_CAPABILITIES  =   7,
  48         SD_LLDP_TYPE_MGMT_ADDRESS         =   8,
  49         SD_LLDP_TYPE_PRIVATE              =   127,
  50 };
  51
  52 /* IEEE 802.3AB Clause 9.5.2: Chassis subtypes */
  53 enum {
  54         SD_LLDP_CHASSIS_SUBTYPE_RESERVED            = 0,
  55         SD_LLDP_CHASSIS_SUBTYPE_CHASSIS_COMPONENT   = 1,
  56         SD_LLDP_CHASSIS_SUBTYPE_INTERFACE_ALIAS     = 2,
  57         SD_LLDP_CHASSIS_SUBTYPE_PORT_COMPONENT      = 3,
  58         SD_LLDP_CHASSIS_SUBTYPE_MAC_ADDRESS         = 4,
  59         SD_LLDP_CHASSIS_SUBTYPE_NETWORK_ADDRESS     = 5,
  60         SD_LLDP_CHASSIS_SUBTYPE_INTERFACE_NAME      = 6,
  61         SD_LLDP_CHASSIS_SUBTYPE_LOCALLY_ASSIGNED    = 7,
  62 };
  63
  64 /* IEEE 802.3AB Clause 9.5.3: Port subtype */
  65 enum {
  66         SD_LLDP_PORT_SUBTYPE_RESERVED           = 0,
  67         SD_LLDP_PORT_SUBTYPE_INTERFACE_ALIAS    = 1,
  68         SD_LLDP_PORT_SUBTYPE_PORT_COMPONENT     = 2,
  69         SD_LLDP_PORT_SUBTYPE_MAC_ADDRESS        = 3,
  70         SD_LLDP_PORT_SUBTYPE_NETWORK_ADDRESS    = 4,
  71         SD_LLDP_PORT_SUBTYPE_INTERFACE_NAME     = 5,
  72         SD_LLDP_PORT_SUBTYPE_AGENT_CIRCUIT_ID   = 6,
  73         SD_LLDP_PORT_SUBTYPE_LOCALLY_ASSIGNED   = 7,
  74 };
  75
  76 enum {
  77         SD_LLDP_SYSTEM_CAPABILITIES_OTHER        = 1 << 0,
  78         SD_LLDP_SYSTEM_CAPABILITIES_REPEATER     = 1 << 1,
  79         SD_LLDP_SYSTEM_CAPABILITIES_BRIDGE       = 1 << 2,
  80         SD_LLDP_SYSTEM_CAPABILITIES_WLAN_AP      = 1 << 3,
  81         SD_LLDP_SYSTEM_CAPABILITIES_ROUTER       = 1 << 4,
  82         SD_LLDP_SYSTEM_CAPABILITIES_PHONE        = 1 << 5,
  83         SD_LLDP_SYSTEM_CAPABILITIES_DOCSIS       = 1 << 6,
  84         SD_LLDP_SYSTEM_CAPABILITIES_STATION      = 1 << 7,
  85         SD_LLDP_SYSTEM_CAPABILITIES_CVLAN        = 1 << 8,
  86         SD_LLDP_SYSTEM_CAPABILITIES_SVLAN        = 1 << 9,
  87         SD_LLDP_SYSTEM_CAPABILITIES_TPMR         = 1 << 10,
  88 };
  89
  90 #define SD_LLDP_SYSTEM_CAPABILITIES_ALL ((uint16_t) -1)
  91
  92 #define SD_LLDP_SYSTEM_CAPABILITIES_ALL_ROUTERS                         \
  93         ((uint16_t)                                                     \
  94          (SD_LLDP_SYSTEM_CAPABILITIES_REPEATER|                         \
  95           SD_LLDP_SYSTEM_CAPABILITIES_BRIDGE|                           \
  96           SD_LLDP_SYSTEM_CAPABILITIES_WLAN_AP|                          \
  97           SD_LLDP_SYSTEM_CAPABILITIES_ROUTER|                           \
  98           SD_LLDP_SYSTEM_CAPABILITIES_DOCSIS|                           \
  99           SD_LLDP_SYSTEM_CAPABILITIES_CVLAN|                            \
 100           SD_LLDP_SYSTEM_CAPABILITIES_SVLAN|                            \
 101           SD_LLDP_SYSTEM_CAPABILITIES_TPMR))
 102
 103 #define SD_LLDP_OUI_802_1 (uint8_t[]) { 0x00, 0x80, 0xc2 }
 104 #define SD_LLDP_OUI_802_3 (uint8_t[]) { 0x00, 0x12, 0x0f }
 105
 106 enum {
 107         SD_LLDP_OUI_802_1_SUBTYPE_PORT_VLAN_ID            = 1,
 108         SD_LLDP_OUI_802_1_SUBTYPE_PORT_PROTOCOL_VLAN_ID   = 2,
 109         SD_LLDP_OUI_802_1_SUBTYPE_VLAN_NAME               = 3,
 110         SD_LLDP_OUI_802_1_SUBTYPE_PROTOCOL_IDENTITY       = 4,
 111         SD_LLDP_OUI_802_1_SUBTYPE_VID_USAGE_DIGEST        = 5,
 112         SD_LLDP_OUI_802_1_SUBTYPE_MANAGEMENT_VID          = 6,
 113         SD_LLDP_OUI_802_1_SUBTYPE_LINK_AGGREGATION        = 7,
 114 };
 115
 116 typedef enum sd_lldp_event {
 117         SD_LLDP_EVENT_ADDED     = 'a',
 118         SD_LLDP_EVENT_REMOVED   = 'r',
 119         SD_LLDP_EVENT_UPDATED   = 'u',
 120         SD_LLDP_EVENT_REFRESHED = 'f',
 121 } sd_lldp_event;
 122
 123 typedef void (*sd_lldp_callback_t)(sd_lldp *lldp, sd_lldp_event event, sd_lldp_neighbor *n, void *userdata);
 124
 125 int sd_lldp_new(sd_lldp **ret, int ifindex);
 126 sd_lldp* sd_lldp_unref(sd_lldp *lldp);
 127
 128 int sd_lldp_start(sd_lldp *lldp);
 129 int sd_lldp_stop(sd_lldp *lldp);
 130
 131 int sd_lldp_attach_event(sd_lldp *lldp, sd_event *event, int64_t priority);
 132 int sd_lldp_detach_event(sd_lldp *lldp);
 133
 134 int sd_lldp_set_callback(sd_lldp *lldp, sd_lldp_callback_t cb, void *userdata);
 135
 136 /* Controls how much and what to store in the neighbors database */
 137 int sd_lldp_set_neighbors_max(sd_lldp *lldp, uint64_t n);
 138 int sd_lldp_match_capabilities(sd_lldp *lldp, uint16_t mask);
 139 int sd_lldp_set_filter_address(sd_lldp *lldp, const struct ether_addr *address);
 140
 141 int sd_lldp_get_neighbors(sd_lldp *lldp, sd_lldp_neighbor ***neighbors);
 142
 143 int sd_lldp_neighbor_from_raw(sd_lldp_neighbor **ret, const void *raw, size_t raw_size);
 144 sd_lldp_neighbor *sd_lldp_neighbor_ref(sd_lldp_neighbor *n);
 145 sd_lldp_neighbor *sd_lldp_neighbor_unref(sd_lldp_neighbor *n);
 146
 147 /* Access to LLDP frame metadata */
 148 int sd_lldp_neighbor_get_source_address(sd_lldp_neighbor *n, struct ether_addr* address);
 149 int sd_lldp_neighbor_get_destination_address(sd_lldp_neighbor *n, struct ether_addr* address);
 150 int sd_lldp_neighbor_get_raw(sd_lldp_neighbor *n, const void **ret, size_t *size);
 151
 152 /* High-level, direct, parsed out field access. These fields exist at most once, hence may be queried directly. */
 153 int sd_lldp_neighbor_get_chassis_id(sd_lldp_neighbor *n, uint8_t *type, const void **ret, size_t *size);
 154 int sd_lldp_neighbor_get_chassis_id_as_string(sd_lldp_neighbor *n, const char **ret);
 155 int sd_lldp_neighbor_get_port_id(sd_lldp_neighbor *n, uint8_t *type, const void **ret, size_t *size);
 156 int sd_lldp_neighbor_get_port_id_as_string(sd_lldp_neighbor *n, const char **ret);
 157 int sd_lldp_neighbor_get_ttl(sd_lldp_neighbor *n, uint16_t *ret);
 158 int sd_lldp_neighbor_get_system_name(sd_lldp_neighbor *n, const char **ret);
 159 int sd_lldp_neighbor_get_system_description(sd_lldp_neighbor *n, const char **ret);
 160 int sd_lldp_neighbor_get_port_description(sd_lldp_neighbor *n, const char **ret);
 161 int sd_lldp_neighbor_get_system_capabilities(sd_lldp_neighbor *n, uint16_t *ret);
 162 int sd_lldp_neighbor_get_enabled_capabilities(sd_lldp_neighbor *n, uint16_t *ret);
 163
 164 /* Low-level, iterative TLV access. This is for evertyhing else, it iteratively goes through all available TLVs
 165  * (including the ones covered with the calls above), and allows multiple TLVs for the same fields. */
 166 int sd_lldp_neighbor_tlv_rewind(sd_lldp_neighbor *n);
 167 int sd_lldp_neighbor_tlv_next(sd_lldp_neighbor *n);
 168 int sd_lldp_neighbor_tlv_get_type(sd_lldp_neighbor *n, uint8_t *type);
 169 int sd_lldp_neighbor_tlv_is_type(sd_lldp_neighbor *n, uint8_t type);
 170 int sd_lldp_neighbor_tlv_get_oui(sd_lldp_neighbor *n, uint8_t oui[3], uint8_t *subtype);
 171 int sd_lldp_neighbor_tlv_is_oui(sd_lldp_neighbor *n, const uint8_t oui[3], uint8_t subtype);
 172 int sd_lldp_neighbor_tlv_get_raw(sd_lldp_neighbor *n, const void **ret, size_t *size);
 173
 174 _SD_DEFINE_POINTER_CLEANUP_FUNC(sd_lldp, sd_lldp_unref);
 175 _SD_DEFINE_POINTER_CLEANUP_FUNC(sd_lldp_neighbor, sd_lldp_neighbor_unref);
 176
 177 _SD_END_DECLARATIONS;
 178
 179 #endif