]>
Commit | Line | Data |
---|---|---|
52ad194e | 1 | /* SPDX-License-Identifier: LGPL-2.1+ */ |
db2df898 MP |
2 | #ifndef foosdlldphfoo |
3 | #define foosdlldphfoo | |
4 | ||
e735f4d4 | 5 | /*** |
e735f4d4 MP |
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 | ||
db2df898 | 20 | #include <inttypes.h> |
4c89c718 | 21 | #include <net/ethernet.h> |
5a920b42 | 22 | #include <sys/types.h> |
e735f4d4 MP |
23 | |
24 | #include "sd-event.h" | |
4c89c718 | 25 | |
db2df898 MP |
26 | #include "_sd-common.h" |
27 | ||
28 | _SD_BEGIN_DECLARATIONS; | |
e735f4d4 | 29 | |
aa27b158 | 30 | /* IEEE 802.3AB Clause 9: TLV Types */ |
6300502b | 31 | enum { |
aa27b158 MP |
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, | |
6300502b | 42 | }; |
e735f4d4 | 43 | |
aa27b158 | 44 | /* IEEE 802.3AB Clause 9.5.2: Chassis subtypes */ |
e735f4d4 | 45 | enum { |
aa27b158 MP |
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, | |
e735f4d4 MP |
54 | }; |
55 | ||
aa27b158 MP |
56 | /* IEEE 802.3AB Clause 9.5.3: Port subtype */ |
57 | enum { | |
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, | |
66 | }; | |
6300502b | 67 | |
aa27b158 MP |
68 | enum { |
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, | |
80 | }; | |
e735f4d4 | 81 | |
aa27b158 | 82 | #define SD_LLDP_SYSTEM_CAPABILITIES_ALL ((uint16_t) -1) |
e735f4d4 | 83 | |
aa27b158 MP |
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)) | |
e735f4d4 | 94 | |
aa27b158 MP |
95 | #define SD_LLDP_OUI_802_1 (uint8_t[]) { 0x00, 0x80, 0xc2 } |
96 | #define SD_LLDP_OUI_802_3 (uint8_t[]) { 0x00, 0x12, 0x0f } | |
e735f4d4 | 97 | |
aa27b158 MP |
98 | enum { |
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, | |
106 | }; | |
6300502b | 107 | |
5a920b42 MP |
108 | typedef struct sd_lldp sd_lldp; |
109 | typedef struct sd_lldp_neighbor sd_lldp_neighbor; | |
110 | ||
aa27b158 | 111 | typedef enum sd_lldp_event { |
6e866b33 MB |
112 | SD_LLDP_EVENT_ADDED, |
113 | SD_LLDP_EVENT_REMOVED, | |
114 | SD_LLDP_EVENT_UPDATED, | |
115 | SD_LLDP_EVENT_REFRESHED, | |
116 | _SD_LLDP_EVENT_MAX, | |
117 | _SD_LLDP_EVENT_INVALID = -1, | |
aa27b158 | 118 | } sd_lldp_event; |
6300502b | 119 | |
aa27b158 | 120 | typedef void (*sd_lldp_callback_t)(sd_lldp *lldp, sd_lldp_event event, sd_lldp_neighbor *n, void *userdata); |
6300502b | 121 | |
5a920b42 MP |
122 | int sd_lldp_new(sd_lldp **ret); |
123 | sd_lldp* sd_lldp_ref(sd_lldp *lldp); | |
aa27b158 | 124 | sd_lldp* sd_lldp_unref(sd_lldp *lldp); |
6300502b | 125 | |
aa27b158 MP |
126 | int sd_lldp_start(sd_lldp *lldp); |
127 | int sd_lldp_stop(sd_lldp *lldp); | |
128 | ||
129 | int sd_lldp_attach_event(sd_lldp *lldp, sd_event *event, int64_t priority); | |
130 | int sd_lldp_detach_event(sd_lldp *lldp); | |
5a920b42 | 131 | sd_event *sd_lldp_get_event(sd_lldp *lldp); |
6300502b | 132 | |
aa27b158 | 133 | int sd_lldp_set_callback(sd_lldp *lldp, sd_lldp_callback_t cb, void *userdata); |
5a920b42 | 134 | int sd_lldp_set_ifindex(sd_lldp *lldp, int ifindex); |
aa27b158 MP |
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); | |
5a920b42 | 150 | int sd_lldp_neighbor_get_timestamp(sd_lldp_neighbor *n, clockid_t clock, uint64_t *ret); |
aa27b158 MP |
151 | int sd_lldp_neighbor_get_raw(sd_lldp_neighbor *n, const void **ret, size_t *size); |
152 | ||
153 | /* High-level, direct, parsed out field access. These fields exist at most once, hence may be queried directly. */ | |
154 | int sd_lldp_neighbor_get_chassis_id(sd_lldp_neighbor *n, uint8_t *type, const void **ret, size_t *size); | |
155 | int sd_lldp_neighbor_get_chassis_id_as_string(sd_lldp_neighbor *n, const char **ret); | |
156 | int sd_lldp_neighbor_get_port_id(sd_lldp_neighbor *n, uint8_t *type, const void **ret, size_t *size); | |
157 | int sd_lldp_neighbor_get_port_id_as_string(sd_lldp_neighbor *n, const char **ret); | |
5a920b42 | 158 | int sd_lldp_neighbor_get_ttl(sd_lldp_neighbor *n, uint16_t *ret_sec); |
aa27b158 MP |
159 | int sd_lldp_neighbor_get_system_name(sd_lldp_neighbor *n, const char **ret); |
160 | int sd_lldp_neighbor_get_system_description(sd_lldp_neighbor *n, const char **ret); | |
161 | int sd_lldp_neighbor_get_port_description(sd_lldp_neighbor *n, const char **ret); | |
162 | int sd_lldp_neighbor_get_system_capabilities(sd_lldp_neighbor *n, uint16_t *ret); | |
163 | int sd_lldp_neighbor_get_enabled_capabilities(sd_lldp_neighbor *n, uint16_t *ret); | |
164 | ||
165 | /* Low-level, iterative TLV access. This is for evertyhing else, it iteratively goes through all available TLVs | |
166 | * (including the ones covered with the calls above), and allows multiple TLVs for the same fields. */ | |
167 | int sd_lldp_neighbor_tlv_rewind(sd_lldp_neighbor *n); | |
168 | int sd_lldp_neighbor_tlv_next(sd_lldp_neighbor *n); | |
169 | int sd_lldp_neighbor_tlv_get_type(sd_lldp_neighbor *n, uint8_t *type); | |
170 | int sd_lldp_neighbor_tlv_is_type(sd_lldp_neighbor *n, uint8_t type); | |
171 | int sd_lldp_neighbor_tlv_get_oui(sd_lldp_neighbor *n, uint8_t oui[3], uint8_t *subtype); | |
172 | int sd_lldp_neighbor_tlv_is_oui(sd_lldp_neighbor *n, const uint8_t oui[3], uint8_t subtype); | |
173 | int sd_lldp_neighbor_tlv_get_raw(sd_lldp_neighbor *n, const void **ret, size_t *size); | |
db2df898 | 174 | |
4c89c718 | 175 | _SD_DEFINE_POINTER_CLEANUP_FUNC(sd_lldp, sd_lldp_unref); |
aa27b158 | 176 | _SD_DEFINE_POINTER_CLEANUP_FUNC(sd_lldp_neighbor, sd_lldp_neighbor_unref); |
4c89c718 | 177 | |
db2df898 MP |
178 | _SD_END_DECLARATIONS; |
179 | ||
180 | #endif |