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 #include <sys/types.h>
  27
  28 #include "sd-event.h"
  29
  30 #include "_sd-common.h"
  31
  32 _SD_BEGIN_DECLARATIONS;
  33
  34 /* IEEE 802.3AB Clause 9: TLV Types */
  35 enum {
  36         SD_LLDP_TYPE_END                 = 0,
  37         SD_LLDP_TYPE_CHASSIS_ID          = 1,
  38         SD_LLDP_TYPE_PORT_ID             = 2,
  39         SD_LLDP_TYPE_TTL                 = 3,
  40         SD_LLDP_TYPE_PORT_DESCRIPTION    = 4,
  41         SD_LLDP_TYPE_SYSTEM_NAME         = 5,
  42         SD_LLDP_TYPE_SYSTEM_DESCRIPTION  = 6,
  43         SD_LLDP_TYPE_SYSTEM_CAPABILITIES = 7,
  44         SD_LLDP_TYPE_MGMT_ADDRESS        = 8,
  45         SD_LLDP_TYPE_PRIVATE             = 127,
  46 };
  47
  48 /* IEEE 802.3AB Clause 9.5.2: Chassis subtypes */
  49 enum {
  50         SD_LLDP_CHASSIS_SUBTYPE_RESERVED            = 0,
  51         SD_LLDP_CHASSIS_SUBTYPE_CHASSIS_COMPONENT   = 1,
  52         SD_LLDP_CHASSIS_SUBTYPE_INTERFACE_ALIAS     = 2,
  53         SD_LLDP_CHASSIS_SUBTYPE_PORT_COMPONENT      = 3,
  54         SD_LLDP_CHASSIS_SUBTYPE_MAC_ADDRESS         = 4,
  55         SD_LLDP_CHASSIS_SUBTYPE_NETWORK_ADDRESS     = 5,
  56         SD_LLDP_CHASSIS_SUBTYPE_INTERFACE_NAME      = 6,
  57         SD_LLDP_CHASSIS_SUBTYPE_LOCALLY_ASSIGNED    = 7,
  58 };
  59
  60 /* IEEE 802.3AB Clause 9.5.3: Port subtype */
  61 enum {
  62         SD_LLDP_PORT_SUBTYPE_RESERVED         = 0,
  63         SD_LLDP_PORT_SUBTYPE_INTERFACE_ALIAS  = 1,
  64         SD_LLDP_PORT_SUBTYPE_PORT_COMPONENT   = 2,
  65         SD_LLDP_PORT_SUBTYPE_MAC_ADDRESS      = 3,
  66         SD_LLDP_PORT_SUBTYPE_NETWORK_ADDRESS  = 4,
  67         SD_LLDP_PORT_SUBTYPE_INTERFACE_NAME   = 5,
  68         SD_LLDP_PORT_SUBTYPE_AGENT_CIRCUIT_ID = 6,
  69         SD_LLDP_PORT_SUBTYPE_LOCALLY_ASSIGNED = 7,
  70 };
  71
  72 enum {
  73         SD_LLDP_SYSTEM_CAPABILITIES_OTHER    = 1 << 0,
  74         SD_LLDP_SYSTEM_CAPABILITIES_REPEATER = 1 << 1,
  75         SD_LLDP_SYSTEM_CAPABILITIES_BRIDGE   = 1 << 2,
  76         SD_LLDP_SYSTEM_CAPABILITIES_WLAN_AP  = 1 << 3,
  77         SD_LLDP_SYSTEM_CAPABILITIES_ROUTER   = 1 << 4,
  78         SD_LLDP_SYSTEM_CAPABILITIES_PHONE    = 1 << 5,
  79         SD_LLDP_SYSTEM_CAPABILITIES_DOCSIS   = 1 << 6,
  80         SD_LLDP_SYSTEM_CAPABILITIES_STATION  = 1 << 7,
  81         SD_LLDP_SYSTEM_CAPABILITIES_CVLAN    = 1 << 8,
  82         SD_LLDP_SYSTEM_CAPABILITIES_SVLAN    = 1 << 9,
  83         SD_LLDP_SYSTEM_CAPABILITIES_TPMR     = 1 << 10,
  84 };
  85
  86 #define SD_LLDP_SYSTEM_CAPABILITIES_ALL ((uint16_t) -1)
  87
  88 #define SD_LLDP_SYSTEM_CAPABILITIES_ALL_ROUTERS                         \
  89         ((uint16_t)                                                     \
  90          (SD_LLDP_SYSTEM_CAPABILITIES_REPEATER|                         \
  91           SD_LLDP_SYSTEM_CAPABILITIES_BRIDGE|                           \
  92           SD_LLDP_SYSTEM_CAPABILITIES_WLAN_AP|                          \
  93           SD_LLDP_SYSTEM_CAPABILITIES_ROUTER|                           \
  94           SD_LLDP_SYSTEM_CAPABILITIES_DOCSIS|                           \
  95           SD_LLDP_SYSTEM_CAPABILITIES_CVLAN|                            \
  96           SD_LLDP_SYSTEM_CAPABILITIES_SVLAN|                            \
  97           SD_LLDP_SYSTEM_CAPABILITIES_TPMR))
  98
  99 #define SD_LLDP_OUI_802_1 (uint8_t[]) { 0x00, 0x80, 0xc2 }
 100 #define SD_LLDP_OUI_802_3 (uint8_t[]) { 0x00, 0x12, 0x0f }
 101
 102 enum {
 103         SD_LLDP_OUI_802_1_SUBTYPE_PORT_VLAN_ID          = 1,
 104         SD_LLDP_OUI_802_1_SUBTYPE_PORT_PROTOCOL_VLAN_ID = 2,
 105         SD_LLDP_OUI_802_1_SUBTYPE_VLAN_NAME             = 3,
 106         SD_LLDP_OUI_802_1_SUBTYPE_PROTOCOL_IDENTITY     = 4,
 107         SD_LLDP_OUI_802_1_SUBTYPE_VID_USAGE_DIGEST      = 5,
 108         SD_LLDP_OUI_802_1_SUBTYPE_MANAGEMENT_VID        = 6,
 109         SD_LLDP_OUI_802_1_SUBTYPE_LINK_AGGREGATION      = 7,
 110 };
 111
 112 typedef struct sd_lldp sd_lldp;
 113 typedef struct sd_lldp_neighbor sd_lldp_neighbor;
 114
 115 typedef enum sd_lldp_event {
 116         SD_LLDP_EVENT_ADDED     = 'a',
 117         SD_LLDP_EVENT_REMOVED   = 'r',
 118         SD_LLDP_EVENT_UPDATED   = 'u',
 119         SD_LLDP_EVENT_REFRESHED = 'f',
 120 } sd_lldp_event;
 121
 122 typedef void (*sd_lldp_callback_t)(sd_lldp *lldp, sd_lldp_event event, sd_lldp_neighbor *n, void *userdata);
 123
 124 int sd_lldp_new(sd_lldp **ret);
 125 sd_lldp* sd_lldp_ref(sd_lldp *lldp);
 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 sd_event *sd_lldp_get_event(sd_lldp *lldp);
 134
 135 int sd_lldp_set_callback(sd_lldp *lldp, sd_lldp_callback_t cb, void *userdata);
 136 int sd_lldp_set_ifindex(sd_lldp *lldp, int ifindex);
 137
 138 /* Controls how much and what to store in the neighbors database */
 139 int sd_lldp_set_neighbors_max(sd_lldp *lldp, uint64_t n);
 140 int sd_lldp_match_capabilities(sd_lldp *lldp, uint16_t mask);
 141 int sd_lldp_set_filter_address(sd_lldp *lldp, const struct ether_addr *address);
 142
 143 int sd_lldp_get_neighbors(sd_lldp *lldp, sd_lldp_neighbor ***neighbors);
 144
 145 int sd_lldp_neighbor_from_raw(sd_lldp_neighbor **ret, const void *raw, size_t raw_size);
 146 sd_lldp_neighbor *sd_lldp_neighbor_ref(sd_lldp_neighbor *n);
 147 sd_lldp_neighbor *sd_lldp_neighbor_unref(sd_lldp_neighbor *n);
 148
 149 /* Access to LLDP frame metadata */
 150 int sd_lldp_neighbor_get_source_address(sd_lldp_neighbor *n, struct ether_addr* address);
 151 int sd_lldp_neighbor_get_destination_address(sd_lldp_neighbor *n, struct ether_addr* address);
 152 int sd_lldp_neighbor_get_timestamp(sd_lldp_neighbor *n, clockid_t clock, uint64_t *ret);
 153 int sd_lldp_neighbor_get_raw(sd_lldp_neighbor *n, const void **ret, size_t *size);
 154
 155 /* High-level, direct, parsed out field access. These fields exist at most once, hence may be queried directly. */
 156 int sd_lldp_neighbor_get_chassis_id(sd_lldp_neighbor *n, uint8_t *type, const void **ret, size_t *size);
 157 int sd_lldp_neighbor_get_chassis_id_as_string(sd_lldp_neighbor *n, const char **ret);
 158 int sd_lldp_neighbor_get_port_id(sd_lldp_neighbor *n, uint8_t *type, const void **ret, size_t *size);
 159 int sd_lldp_neighbor_get_port_id_as_string(sd_lldp_neighbor *n, const char **ret);
 160 int sd_lldp_neighbor_get_ttl(sd_lldp_neighbor *n, uint16_t *ret_sec);
 161 int sd_lldp_neighbor_get_system_name(sd_lldp_neighbor *n, const char **ret);
 162 int sd_lldp_neighbor_get_system_description(sd_lldp_neighbor *n, const char **ret);
 163 int sd_lldp_neighbor_get_port_description(sd_lldp_neighbor *n, const char **ret);
 164 int sd_lldp_neighbor_get_system_capabilities(sd_lldp_neighbor *n, uint16_t *ret);
 165 int sd_lldp_neighbor_get_enabled_capabilities(sd_lldp_neighbor *n, uint16_t *ret);
 166
 167 /* Low-level, iterative TLV access. This is for evertyhing else, it iteratively goes through all available TLVs
 168  * (including the ones covered with the calls above), and allows multiple TLVs for the same fields. */
 169 int sd_lldp_neighbor_tlv_rewind(sd_lldp_neighbor *n);
 170 int sd_lldp_neighbor_tlv_next(sd_lldp_neighbor *n);
 171 int sd_lldp_neighbor_tlv_get_type(sd_lldp_neighbor *n, uint8_t *type);
 172 int sd_lldp_neighbor_tlv_is_type(sd_lldp_neighbor *n, uint8_t type);
 173 int sd_lldp_neighbor_tlv_get_oui(sd_lldp_neighbor *n, uint8_t oui[3], uint8_t *subtype);
 174 int sd_lldp_neighbor_tlv_is_oui(sd_lldp_neighbor *n, const uint8_t oui[3], uint8_t subtype);
 175 int sd_lldp_neighbor_tlv_get_raw(sd_lldp_neighbor *n, const void **ret, size_t *size);
 176
 177 _SD_DEFINE_POINTER_CLEANUP_FUNC(sd_lldp, sd_lldp_unref);
 178 _SD_DEFINE_POINTER_CLEANUP_FUNC(sd_lldp_neighbor, sd_lldp_neighbor_unref);
 179
 180 _SD_END_DECLARATIONS;
 181
 182 #endif