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