xref: /openbsd-src/usr.sbin/ldpd/ldp.h (revision f2da64fbbbf1b03f09f390ab01267c93dfd77c4c)
1 /*	$OpenBSD: ldp.h,v 1.35 2016/09/03 16:07:08 renato Exp $ */
2 
3 /*
4  * Copyright (c) 2013, 2016 Renato Westphal <renato@openbsd.org>
5  * Copyright (c) 2009 Michele Marchetto <michele@openbsd.org>
6  * Copyright (c) 2004, 2005, 2008 Esben Norby <norby@openbsd.org>
7  *
8  * Permission to use, copy, modify, and distribute this software for any
9  * purpose with or without fee is hereby granted, provided that the above
10  * copyright notice and this permission notice appear in all copies.
11  *
12  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
13  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
14  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
15  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
16  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
17  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
18  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
19  */
20 
21 /* LDP protocol definitions */
22 
23 #ifndef _LDP_H_
24 #define _LDP_H_
25 
26 #include <sys/types.h>
27 
28 /* misc */
29 #define LDP_VERSION		1
30 #define LDP_PORT		646
31 #define LDP_MAX_LEN		4096
32 
33 /* All Routers on this Subnet group multicast addresses */
34 #define AllRouters_v4		"224.0.0.2"
35 #define AllRouters_v6		"ff02::2"
36 
37 #define LINK_DFLT_HOLDTIME	15
38 #define TARGETED_DFLT_HOLDTIME	45
39 #define MIN_HOLDTIME		3
40 #define MAX_HOLDTIME		0xffff
41 #define	INFINITE_HOLDTIME	0xffff
42 
43 #define DEFAULT_KEEPALIVE	180
44 #define MIN_KEEPALIVE		3
45 #define MAX_KEEPALIVE		0xffff
46 #define KEEPALIVE_PER_PERIOD	3
47 #define INIT_FSM_TIMEOUT	15
48 
49 #define	DEFAULT_HELLO_INTERVAL	5
50 #define	MIN_HELLO_INTERVAL	1
51 #define	MAX_HELLO_INTERVAL	0xffff
52 
53 #define	INIT_DELAY_TMR		15
54 #define	MAX_DELAY_TMR		120
55 
56 #define	MIN_PWID_ID		1
57 #define	MAX_PWID_ID		0xffffffff
58 
59 #define	DEFAULT_L2VPN_MTU	1500
60 #define	MIN_L2VPN_MTU		512
61 #define	MAX_L2VPN_MTU		0xffff
62 
63 /* LDP message types */
64 #define MSG_TYPE_NOTIFICATION	0x0001
65 #define MSG_TYPE_HELLO		0x0100
66 #define MSG_TYPE_INIT		0x0200
67 #define MSG_TYPE_KEEPALIVE	0x0201
68 #define MSG_TYPE_ADDR		0x0300
69 #define MSG_TYPE_ADDRWITHDRAW	0x0301
70 #define MSG_TYPE_LABELMAPPING	0x0400
71 #define MSG_TYPE_LABELREQUEST	0x0401
72 #define MSG_TYPE_LABELWITHDRAW	0x0402
73 #define MSG_TYPE_LABELRELEASE	0x0403
74 #define MSG_TYPE_LABELABORTREQ	0x0404
75 
76 /* LDP TLV types */
77 #define TLV_TYPE_FEC		0x0100
78 #define TLV_TYPE_ADDRLIST	0x0101
79 #define TLV_TYPE_HOPCOUNT	0x0103
80 #define TLV_TYPE_PATHVECTOR	0x0104
81 #define TLV_TYPE_GENERICLABEL	0x0200
82 #define TLV_TYPE_ATMLABEL	0x0201
83 #define TLV_TYPE_FRLABEL	0x0202
84 #define TLV_TYPE_STATUS		0x0300
85 #define TLV_TYPE_EXTSTATUS	0x0301
86 #define TLV_TYPE_RETURNEDPDU	0x0302
87 #define TLV_TYPE_RETURNEDMSG	0x0303
88 #define TLV_TYPE_COMMONHELLO	0x0400
89 #define TLV_TYPE_IPV4TRANSADDR	0x0401
90 #define TLV_TYPE_CONFIG		0x0402
91 #define TLV_TYPE_IPV6TRANSADDR	0x0403
92 #define TLV_TYPE_COMMONSESSION	0x0500
93 #define TLV_TYPE_ATMSESSIONPAR	0x0501
94 #define TLV_TYPE_FRSESSION	0x0502
95 #define TLV_TYPE_LABELREQUEST	0x0600
96 /* RFC 4447 */
97 #define TLV_TYPE_PW_STATUS	0x096A
98 #define TLV_TYPE_PW_IF_PARAM	0x096B
99 #define TLV_TYPE_PW_GROUP_ID	0x096C
100 /* RFC 7552 */
101 #define TLV_TYPE_DUALSTACK	0x8701
102 
103 /* LDP header */
104 struct ldp_hdr {
105 	uint16_t	version;
106 	uint16_t	length;
107 	uint32_t	lsr_id;
108 	uint16_t	lspace_id;
109 } __packed;
110 
111 #define	LDP_HDR_SIZE		10	/* actual size of the LDP header */
112 #define	LDP_HDR_PDU_LEN		6	/* minimum "PDU Length" */
113 #define LDP_HDR_DEAD_LEN	4
114 
115 /* TLV record */
116 struct tlv {
117 	uint16_t	type;
118 	uint16_t	length;
119 };
120 #define	TLV_HDR_SIZE		4
121 
122 struct ldp_msg {
123 	uint16_t	type;
124 	uint16_t	length;
125 	uint32_t	id;
126 	/* Mandatory Parameters */
127 	/* Optional Parameters */
128 } __packed;
129 
130 #define LDP_MSG_SIZE		8	/* minimum size of LDP message */
131 #define LDP_MSG_LEN		4	/* minimum "Message Length" */
132 #define LDP_MSG_DEAD_LEN	4
133 
134 #define	UNKNOWN_FLAG		0x8000
135 #define	FORWARD_FLAG		0xc000
136 
137 struct hello_prms_tlv {
138 	uint16_t	type;
139 	uint16_t	length;
140 	uint16_t	holdtime;
141 	uint16_t	flags;
142 };
143 #define F_HELLO_TARGETED	0x8000
144 #define F_HELLO_REQ_TARG	0x4000
145 #define F_HELLO_GTSM		0x2000
146 
147 struct hello_prms_opt4_tlv {
148 	uint16_t	type;
149 	uint16_t	length;
150 	uint32_t	value;
151 };
152 
153 struct hello_prms_opt16_tlv {
154 	uint16_t	type;
155 	uint16_t	length;
156 	uint8_t		value[16];
157 };
158 
159 #define DUAL_STACK_LDPOV4	4
160 #define DUAL_STACK_LDPOV6	6
161 
162 #define F_HELLO_TLV_RCVD_ADDR	0x01
163 #define F_HELLO_TLV_RCVD_CONF	0x02
164 #define F_HELLO_TLV_RCVD_DS	0x04
165 
166 #define	S_SUCCESS	0x00000000
167 #define	S_BAD_LDP_ID	0x80000001
168 #define	S_BAD_PROTO_VER	0x80000002
169 #define	S_BAD_PDU_LEN	0x80000003
170 #define	S_UNKNOWN_MSG	0x00000004
171 #define	S_BAD_MSG_LEN	0x80000005
172 #define	S_UNKNOWN_TLV	0x00000006
173 #define	S_BAD_TLV_LEN	0x80000007
174 #define	S_BAD_TLV_VAL	0x80000008
175 #define	S_HOLDTIME_EXP	0x80000009
176 #define	S_SHUTDOWN	0x8000000A
177 #define	S_LOOP_DETECTED	0x0000000B
178 #define	S_UNKNOWN_FEC	0x0000000C
179 #define	S_NO_ROUTE	0x0000000D
180 #define	S_NO_LABEL_RES	0x0000000E
181 #define	S_AVAILABLE	0x0000000F
182 #define	S_NO_HELLO	0x80000010
183 #define	S_PARM_ADV_MODE	0x80000011
184 #define	S_MAX_PDU_LEN	0x80000012
185 #define	S_PARM_L_RANGE	0x80000013
186 #define	S_KEEPALIVE_TMR	0x80000014
187 #define	S_LAB_REQ_ABRT	0x00000015
188 #define	S_MISS_MSG	0x00000016
189 #define	S_UNSUP_ADDR	0x00000017
190 #define	S_KEEPALIVE_BAD	0x80000018
191 #define	S_INTERN_ERR	0x80000019
192 /* RFC 4447 */
193 #define S_ILLEGAL_CBIT	0x00000024
194 #define S_WRONG_CBIT	0x00000025
195 #define S_INCPT_BITRATE	0x00000026
196 #define S_CEP_MISCONF	0x00000027
197 #define S_PW_STATUS	0x00000028
198 #define S_UNASSIGN_TAI	0x00000029
199 #define S_MISCONF_ERR	0x0000002A
200 #define S_WITHDRAW_MTHD	0x0000002B
201 /* RFC 7552 */
202 #define	S_TRANS_MISMTCH	0x80000032
203 #define	S_DS_NONCMPLNCE	0x80000033
204 
205 struct sess_prms_tlv {
206 	uint16_t	type;
207 	uint16_t	length;
208 	uint16_t	proto_version;
209 	uint16_t	keepalive_time;
210 	uint8_t		reserved;
211 	uint8_t		pvlim;
212 	uint16_t	max_pdu_len;
213 	uint32_t	lsr_id;
214 	uint16_t	lspace_id;
215 } __packed;
216 
217 #define SESS_PRMS_SIZE		18
218 #define SESS_PRMS_LEN		14
219 
220 struct status_tlv {
221 	uint16_t	type;
222 	uint16_t	length;
223 	uint32_t	status_code;
224 	uint32_t	msg_id;
225 	uint16_t	msg_type;
226 } __packed;
227 
228 #define STATUS_SIZE		14
229 #define STATUS_TLV_LEN		10
230 #define	STATUS_FATAL		0x80000000
231 
232 #define	AF_IPV4			0x1
233 #define	AF_IPV6			0x2
234 
235 struct address_list_tlv {
236 	uint16_t	type;
237 	uint16_t	length;
238 	uint16_t	family;
239 	/* address entries */
240 } __packed;
241 
242 #define ADDR_LIST_SIZE		6
243 
244 #define FEC_ELM_WCARD_LEN	1
245 #define FEC_ELM_PREFIX_MIN_LEN	4
246 #define FEC_PWID_ELM_MIN_LEN	8
247 
248 #define	MAP_TYPE_WILDCARD	0x01
249 #define	MAP_TYPE_PREFIX		0x02
250 #define	MAP_TYPE_PWID		0x80
251 #define	MAP_TYPE_GENPWID	0x81
252 
253 #define CONTROL_WORD_FLAG	0x8000
254 #define PW_TYPE_ETHERNET_TAGGED	0x0004
255 #define PW_TYPE_ETHERNET	0x0005
256 #define DEFAULT_PW_TYPE		PW_TYPE_ETHERNET
257 
258 /* RFC 4447 Sub-TLV record */
259 struct subtlv {
260 	uint8_t		type;
261 	uint8_t		length;
262 };
263 #define	SUBTLV_HDR_SIZE		2
264 
265 #define SUBTLV_IFMTU		0x01
266 #define SUBTLV_VLANID		0x06
267 
268 #define FEC_SUBTLV_IFMTU_SIZE	4
269 #define FEC_SUBTLV_VLANID_SIZE	4
270 
271 struct label_tlv {
272 	uint16_t	type;
273 	uint16_t	length;
274 	uint32_t	label;
275 };
276 #define LABEL_TLV_SIZE		8
277 #define LABEL_TLV_LEN		4
278 
279 struct reqid_tlv {
280 	uint16_t	type;
281 	uint16_t	length;
282 	uint32_t	reqid;
283 };
284 #define REQID_TLV_SIZE		8
285 #define REQID_TLV_LEN		4
286 
287 struct pw_status_tlv {
288 	uint16_t	type;
289 	uint16_t	length;
290 	uint32_t	value;
291 };
292 #define PW_STATUS_TLV_SIZE	8
293 #define PW_STATUS_TLV_LEN	4
294 
295 #define PW_FORWARDING		0
296 #define PW_NOT_FORWARDING	(1 << 0)
297 #define PW_LOCAL_RX_FAULT	(1 << 1)
298 #define PW_LOCAL_TX_FAULT	(1 << 2)
299 #define PW_PSN_RX_FAULT		(1 << 3)
300 #define PW_PSN_TX_FAULT		(1 << 4)
301 
302 #define	NO_LABEL		UINT32_MAX
303 
304 #endif /* !_LDP_H_ */
305