xref: /openbsd/usr.sbin/dvmrpd/dvmrpd.h (revision 09467b48)
1 /*	$OpenBSD: dvmrpd.h,v 1.22 2016/09/02 16:20:34 benno Exp $ */
2 
3 /*
4  * Copyright (c) 2004, 2005, 2006 Esben Norby <norby@openbsd.org>
5  * Copyright (c) 2003, 2004 Henning Brauer <henning@openbsd.org>
6  *
7  * Permission to use, copy, modify, and distribute this software for any
8  * purpose with or without fee is hereby granted, provided that the above
9  * copyright notice and this permission notice appear in all copies.
10  *
11  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
12  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
13  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
14  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
15  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
16  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
17  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
18  */
19 
20 #ifndef _DVMRPD_H_
21 #define _DVMRPD_H_
22 
23 #include <sys/queue.h>
24 #include <sys/socket.h>
25 #include <sys/time.h>
26 #include <sys/tree.h>
27 #include <net/if.h>
28 #include <netinet/in.h>
29 #include <event.h>
30 
31 #include <imsg.h>
32 
33 #define CONF_FILE		"/etc/dvmrpd.conf"
34 #define	DVMRPD_SOCKET		"/var/run/dvmrpd.sock"
35 #define DVMRPD_USER		"_dvmrpd"
36 
37 #define NBR_HASHSIZE		128
38 
39 #define NBR_IDSELF		1
40 #define NBR_CNTSTART		(NBR_IDSELF + 1)
41 
42 #define	RT_BUF_SIZE		16384
43 
44 #define	DVMRPD_FLAG_NO_FIB_UPDATE	0x0001
45 
46 #define	F_DVMRPD_INSERTED	0x0001
47 #define	F_KERNEL		0x0002
48 #define	F_CONNECTED		0x0004
49 #define	F_DOWN			0x0010
50 #define	F_STATIC		0x0020
51 #define	F_LONGER		0x0040
52 
53 #define MAXVIFS			32	/* XXX */
54 
55 static const char * const log_procnames[] = {
56 	"parent",
57 	"dvmrpe",
58 	"rde"
59 };
60 
61 struct imsgev {
62 	struct imsgbuf		 ibuf;
63 	void			(*handler)(int, short, void *);
64 	struct event		 ev;
65 	void			*data;
66 	short			 events;
67 };
68 
69 enum imsg_type {
70 	IMSG_NONE,
71 	IMSG_CTL_RELOAD,
72 	IMSG_CTL_SHOW_IFACE,
73 	IMSG_CTL_SHOW_IGMP,
74 	IMSG_CTL_SHOW_NBR,
75 	IMSG_CTL_SHOW_RIB,
76 	IMSG_CTL_SHOW_MFC,
77 	IMSG_CTL_MFC_COUPLE,
78 	IMSG_CTL_MFC_DECOUPLE,
79 	IMSG_CTL_KROUTE,
80 	IMSG_CTL_KROUTE_ADDR,
81 	IMSG_CTL_IFINFO,
82 	IMSG_CTL_SHOW_SUM,
83 	IMSG_CTL_END,
84 	IMSG_CTL_LOG_VERBOSE,
85 	IMSG_IFINFO,
86 	IMSG_ROUTE_REPORT,
87 	IMSG_FULL_ROUTE_REPORT,
88 	IMSG_FULL_ROUTE_REPORT_END,
89 	IMSG_MFC_ADD,
90 	IMSG_MFC_DEL,
91 	IMSG_GROUP_ADD,
92 	IMSG_GROUP_DEL,
93 	IMSG_NBR_DEL,
94 	IMSG_SEND_PRUNE,
95 	IMSG_RECV_PRUNE,
96 	IMSG_FLASH_UPDATE,
97 	IMSG_FLASH_UPDATE_DS
98 };
99 
100 /* interface states */
101 #define	IF_STA_DOWN		0x01
102 #define IF_STA_QUERIER		0x02
103 #define	IF_STA_NONQUERIER	0x04
104 #define	IF_STA_ANY		0x07
105 #define	IF_STA_ACTIVE		(~IF_STA_DOWN)
106 
107 /* interface events */
108 enum iface_event {
109 	IF_EVT_NOTHING,
110 	IF_EVT_UP,
111 	IF_EVT_QTMOUT,		/* query timer expired */
112 	IF_EVT_QRECVD,		/* query received, check for lower IP */
113 	IF_EVT_QPRSNTTMOUT,	/* other querier present timeout */
114 	IF_EVT_DOWN
115 };
116 
117 /* interface actions */
118 enum iface_action {
119 	IF_ACT_NOTHING,
120 	IF_ACT_STRT,
121 	IF_ACT_QPRSNT,
122 	IF_ACT_RST
123 };
124 
125 /* interface types */
126 enum iface_type {
127 	IF_TYPE_POINTOPOINT,
128 	IF_TYPE_BROADCAST
129 };
130 
131 /* neighbor states */
132 #define	NBR_STA_DOWN		0x01
133 #define	NBR_STA_1_WAY		0x02
134 #define	NBR_STA_2_WAY		0x04
135 #define NBR_STA_ACTIVE		(~NBR_STA_DOWN)
136 #define NBR_STA_ANY		0xff
137 
138 struct group {
139 	TAILQ_ENTRY(group)	 entry;
140 	struct event		 dead_timer;
141 	struct event		 v1_host_timer;
142 	struct event		 retrans_timer;
143 
144 	struct in_addr		 addr;
145 
146 	struct iface		*iface;
147 
148 	time_t			 uptime;
149 	int			 state;
150 };
151 
152 struct rde_group {
153 	TAILQ_ENTRY(rde_group)	 entry;
154 	struct in_addr		 rde_group;
155 };
156 
157 struct mfc {
158 	struct in_addr		 origin;
159 	struct in_addr		 group;
160 	u_short			 ifindex;
161 	u_int8_t		 ttls[MAXVIFS];
162 };
163 
164 struct prune {
165 	struct in_addr		 origin;
166 	struct in_addr		 netmask;
167 	struct in_addr		 group;
168 	struct in_addr		 nexthop;
169 	u_short			 ifindex;
170 	u_int32_t		 lifetime;
171 };
172 
173 struct nbr_msg {
174 	struct in_addr		 address;
175 	unsigned int		 ifindex;
176 };
177 
178 TAILQ_HEAD(rr_head, rr_entry);
179 RB_HEAD(src_head, src_node);
180 
181 struct iface {
182 	LIST_ENTRY(iface)	 entry;
183 	struct event		 probe_timer;
184 	struct event		 query_timer;
185 	struct event		 querier_present_timer;
186 	time_t			 uptime;
187 	LIST_HEAD(, nbr)	 nbr_list;
188 	TAILQ_HEAD(, group)	 group_list;
189 	TAILQ_HEAD(, rde_group)	 rde_group_list;
190 	struct rr_head		 rr_list;
191 
192 	char			 name[IF_NAMESIZE];
193 	struct in_addr		 addr;
194 	struct in_addr		 dst;
195 	struct in_addr		 mask;
196 	struct in_addr		 querier;	/* designated querier */
197 
198 	u_int64_t		 baudrate;
199 	u_int32_t		 gen_id;
200 	u_int32_t		 group_cnt;
201 	u_int32_t		 probe_interval;
202 
203 	u_int32_t		 query_interval;
204 	u_int32_t		 query_resp_interval;
205 	u_int32_t		 recv_query_resp_interval;
206 	u_int32_t		 group_member_interval;
207 	u_int32_t		 querier_present_interval;
208 	u_int32_t		 startup_query_interval;
209 	u_int32_t		 startup_query_cnt;
210 	u_int32_t		 last_member_query_interval;
211 	u_int32_t		 last_member_query_cnt;
212 	u_int32_t		 last_member_query_time;
213 	u_int32_t		 v1_querier_present_tmout;
214 	u_int32_t		 v1_host_present_interval;
215 	u_int32_t		 startup_query_counter; /* actual counter */
216 	u_int32_t		 dead_interval;
217 
218 	unsigned int		 ifindex;		/* ifindex and vif */
219 	int			 fd;
220 	int			 state;
221 	int			 mtu;
222 	int			 nbr_cnt;
223 	int			 adj_cnt;
224 
225 	u_int16_t		 flags;
226 	u_int16_t		 metric;
227 	enum iface_type		 type;
228 
229 	u_int8_t		 robustness;
230 	u_int8_t		 linkstate;
231 	u_int8_t		 if_type;
232 	u_int8_t		 passive;
233 	u_int8_t		 igmp_version;
234 };
235 
236 /* dvmrp_conf */
237 enum {
238 	PROC_MAIN,
239 	PROC_DVMRP_ENGINE,
240 	PROC_RDE_ENGINE
241 } dvmrpd_process;
242 
243 struct dvmrpd_conf {
244 	struct event		 ev;
245 	struct event		 report_timer;
246 	u_int32_t		 gen_id;
247 	u_int32_t		 opts;
248 #define DVMRPD_OPT_VERBOSE	 0x00000001
249 #define DVMRPD_OPT_VERBOSE2	 0x00000002
250 #define DVMRPD_OPT_NOACTION	 0x00000004
251 	int			 maxdepth;
252 	LIST_HEAD(, iface)	 iface_list;
253 	int			 dvmrp_socket;
254 	int			 mroute_socket;
255 	int			 flags;
256 };
257 
258 /* kroute */
259 struct kroute {
260 	struct in_addr		 prefix;
261 	struct in_addr		 nexthop;
262 	u_int16_t		 flags;
263 	u_short			 ifindex;
264 	u_int8_t		 prefixlen;
265 };
266 
267 struct kif {
268 	char			 ifname[IF_NAMESIZE];
269 	u_int64_t		 baudrate;
270 	int			 flags;
271 	int			 mtu;
272 	u_short			 ifindex;
273 	u_int8_t		 if_type;
274 	u_int8_t		 link_state;
275 	u_int8_t		 nh_reachable;	/* for nexthop verification */
276 };
277 
278 /* control data structures */
279 struct ctl_iface {
280 	char			 name[IF_NAMESIZE];
281 	struct in_addr		 addr;
282 	struct in_addr		 mask;
283 	struct in_addr		 querier;
284 
285 	time_t			 probe_timer;
286 	time_t			 query_timer;
287 	time_t			 querier_present_timer;
288 	time_t			 uptime;
289 
290 	u_int64_t		 baudrate;
291 	u_int32_t		 gen_id;
292 	u_int32_t		 group_cnt;
293 	u_int32_t		 probe_interval;
294 	u_int32_t		 query_interval;
295 	u_int32_t		 query_resp_interval;
296 	u_int32_t		 recv_query_resp_interval;
297 	u_int32_t		 group_member_interval;
298 	u_int32_t		 querier_present_interval;
299 	u_int32_t		 startup_query_interval;
300 	u_int32_t		 startup_query_cnt;
301 	u_int32_t		 last_member_query_interval;
302 	u_int32_t		 last_member_query_cnt;
303 	u_int32_t		 last_member_query_time;
304 	u_int32_t		 v1_querier_present_tmout;
305 	u_int32_t		 v1_host_present_interval;
306 	u_int32_t		 dead_interval;
307 
308 	unsigned int		 ifindex;
309 	int			 state;
310 	int			 mtu;
311 	int			 nbr_cnt;
312 	int			 adj_cnt;
313 
314 	u_int16_t		 flags;
315 	u_int16_t		 metric;
316 	enum iface_type		 type;
317 	u_int8_t		 robustness;
318 	u_int8_t		 linkstate;
319 	u_int8_t		 if_type;
320 	u_int8_t		 passive;
321 	u_int8_t		 igmp_version;
322 };
323 
324 struct ctl_group {
325 	time_t			 dead_timer;
326 	time_t			 v1_host_timer;
327 	time_t			 retrans_timer;
328 	time_t			 uptime;
329 	struct in_addr		 addr;
330 	int			 state;
331 };
332 
333 struct ctl_nbr {
334 	char			 name[IF_NAMESIZE];
335 	struct in_addr		 id;
336 	struct in_addr		 addr;
337 	time_t			 dead_timer;
338 	time_t			 uptime;
339 	int			 state;
340 };
341 
342 struct ctl_rt {
343 	struct in_addr		 prefix;
344 	struct in_addr		 nexthop;
345 	struct in_addr		 area;
346 	struct in_addr		 adv_rtr;
347 	time_t			 uptime;
348 	time_t			 expire;
349 	u_int32_t		 cost;
350 	u_int8_t		 flags;
351 	u_int8_t		 prefixlen;
352 };
353 
354 struct ctl_mfc {
355 	u_int8_t		 ttls[MAXVIFS];	/* outgoing vif(s) */
356 	struct in_addr		 origin;
357 	struct in_addr		 group;
358 	time_t			 uptime;
359 	time_t			 expire;
360 	u_short			 ifindex;	/* incoming vif */
361 };
362 
363 struct ctl_sum {
364 	struct in_addr		 rtr_id;
365 	u_int32_t		 hold_time;
366 };
367 
368 /* dvmrpd.c */
369 void main_imsg_compose_dvmrpe(int, pid_t, void *, u_int16_t);
370 
371 /* parse.y */
372 struct dvmrpd_conf	*parse_config(char *, int);
373 int			 cmdline_symset(char *);
374 
375 int	 imsg_compose_event(struct imsgev *, u_int16_t, u_int32_t, pid_t,
376 	    int, void *, u_int16_t);
377 void	 imsg_event_add(struct imsgev *);
378 
379 /* in_cksum.c */
380 u_int16_t	 in_cksum(void *, size_t);
381 
382 /* kroute.c */
383 int		 kif_init(void);
384 void		 kif_clear(void);
385 int		 kr_init(void);
386 void		 kr_shutdown(void);
387 void		 kr_dispatch_msg(int, short, void *);
388 void		 kr_ifinfo(char *);
389 struct kif	*kif_findname(char *);
390 
391 u_int8_t	 prefixlen_classful(in_addr_t);
392 u_int8_t	 mask2prefixlen(in_addr_t);
393 in_addr_t	 prefixlen2mask(u_int8_t);
394 
395 /* kmroute.c */
396 int		 kmr_init(int);
397 void		 kmr_shutdown(void);
398 void		 kmr_recv_msg(int, short, void *);
399 void		 kmr_mfc_couple(void);
400 void		 kmr_mfc_decouple(void);
401 void		 kmroute_clear(void);
402 int		 mrt_init(int);
403 int		 mrt_done(int);
404 int		 mrt_add_vif(int, struct iface *);
405 void		 mrt_del_vif(int, struct iface *);
406 int		 mrt_add_mfc(int, struct mfc *);
407 int		 mrt_del_mfc(int, struct mfc *);
408 
409 /* log.h */
410 const char	*nbr_state_name(int);
411 const char	*if_state_name(int);
412 const char	*if_type_name(enum iface_type);
413 const char	*group_state_name(int);
414 
415 /* printconf.c */
416 void		 print_config(struct dvmrpd_conf *);
417 
418 /* interface.c */
419 struct iface	*if_find_index(u_short);
420 
421 #define	PREFIX_SIZE(x)	(((x) + 7) / 8)
422 
423 #endif	/* _DVMRPD_H_ */
424