eeb89c18eefe6e11c68adc66bc1f5d11a56ea52d
[dragonfly.git] / usr.sbin / mrouted / defs.h
1 /*
2  * The mrouted program is covered by the license in the accompanying file
3  * named "LICENSE".  Use of the mrouted program represents acceptance of
4  * the terms and conditions listed in that file.
5  *
6  * The mrouted program is COPYRIGHT 1989 by The Board of Trustees of
7  * Leland Stanford Junior University.
8  *
9  *
10  * $FreeBSD: src/usr.sbin/mrouted/defs.h,v 1.12.2.1 2001/07/19 01:41:11 kris Exp $
11  * $DragonFly: src/usr.sbin/mrouted/defs.h,v 1.4 2003/11/03 19:31:38 eirikn Exp $
12  * defs.h,v 3.8.4.15 1998/03/01 02:51:42 fenner Exp
13  */
14
15
16 #include <stdio.h>
17 #include <stdlib.h>
18 #include <unistd.h>
19 #include <ctype.h>
20 #include <errno.h>
21 #include <syslog.h>
22 #include <signal.h>
23 #include <string.h>
24 #include <sys/param.h>
25 #include <sys/types.h>
26 #include <sys/socket.h>
27 #include <sys/ioctl.h>
28 #ifdef SYSV
29 #include <sys/sockio.h>
30 #endif
31 #ifdef _AIX
32 #include <time.h>
33 #endif
34 #include <sys/time.h>
35 #include <sys/uio.h>
36 #include <net/if.h>
37 #define rtentry kern_rtentry    /* XXX !!! UGH */
38 #include <net/route.h>
39 #undef rtentry
40 #include <netinet/in.h>
41 #include <netinet/in_systm.h>
42 #include <netinet/ip.h>
43 #include <netinet/ip_icmp.h>
44 #include <netinet/igmp.h>
45 #ifdef __FreeBSD__      /* sigh */
46 #include <osreldate.h>
47 #if __FreeBSD_version >= 220000
48 #define rtentry kernel_rtentry
49 #include <net/route.h>
50 #undef rtentry
51 #endif
52 #endif
53 #include <net/ip_mroute/ip_mroute.h>
54 #ifdef RSRR
55 #include <sys/un.h>
56 #endif /* RSRR */
57
58 /*XXX*/
59 typedef u_int u_int32;
60
61 #ifndef __P
62 #ifdef __STDC__
63 #define __P(x)  x
64 #else
65 #define __P(x)  ()
66 #endif
67 #endif
68
69 typedef void (*cfunc_t)(void *);
70 typedef void (*ihfunc_t)(int, fd_set *);
71
72 #include "dvmrp.h"
73 #include "igmpv2.h"
74 #include "vif.h"
75 #include "route.h"
76 #include "prune.h"
77 #include "pathnames.h"
78 #ifdef RSRR
79 #include "rsrr.h"
80 #include "rsrr_var.h"
81 #endif /* RSRR */
82
83 /*
84  * Miscellaneous constants and macros.
85  */
86 #define FALSE           0
87 #define TRUE            1
88
89 #define EQUAL(s1, s2)   (strcmp((s1), (s2)) == 0)
90
91 #define TIMER_INTERVAL  ROUTE_MAX_REPORT_DELAY
92
93 #define PROTOCOL_VERSION 3  /* increment when packet format/content changes */
94 #define MROUTED_VERSION  9  /* not in DVMRP packets at all */
95
96 #define DVMRP_CONSTANT  0x000eff00      /* constant portion of 'group' field */
97
98 #define MROUTED_LEVEL  (DVMRP_CONSTANT | PROTOCOL_VERSION)
99                             /* for IGMP 'group' field of DVMRP messages */
100
101 #define LEAF_FLAGS      (( vifs_with_neighbors == 1 ) ? 0x010000 : 0)
102                             /* more for IGMP 'group' field of DVMRP messages */
103
104 #define DEL_RTE_GROUP           0
105 #define DEL_ALL_ROUTES          1
106                             /* for Deleting kernel table entries */
107
108 /* obnoxious gcc gives an extraneous warning about this constant... */
109 #if defined(__STDC__) || defined(__GNUC__)
110 #define JAN_1970        2208988800UL    /* 1970 - 1900 in seconds */
111 #else
112 #define JAN_1970        2208988800L     /* 1970 - 1900 in seconds */
113 #define const           /**/
114 #endif
115
116 #ifdef RSRR
117 #define BIT_ZERO(X)      ((X) = 0)
118 #define BIT_SET(X,n)     ((X) |= 1 << (n))
119 #define BIT_CLR(X,n)     ((X) &= ~(1 << (n)))
120 #define BIT_TST(X,n)     ((X) & 1 << (n))
121 #endif /* RSRR */
122
123 #ifdef SYSV
124 #define bcopy(a, b, c)  memcpy(b, a, c)
125 #define bzero(s, n)     memset((s), 0, (n))
126 #define setlinebuf(s)   setvbuf(s, NULL, _IOLBF, 0)
127 #endif
128
129 #if defined(_AIX) || (defined(BSD) && (BSD >= 199103))
130 #define HAVE_SA_LEN
131 #endif
132
133 /*
134  * External declarations for global variables and functions.
135  */
136 #define RECV_BUF_SIZE 8192
137 extern char             *recv_buf;
138 extern char             *send_buf;
139 extern int              igmp_socket;
140 #ifdef RSRR
141 extern int              rsrr_socket;
142 #endif /* RSRR */
143 extern u_int32          allhosts_group;
144 extern u_int32          allrtrs_group;
145 extern u_int32          dvmrp_group;
146 extern u_int32          dvmrp_genid;
147
148 #define IF_DEBUG(l)     if (debug && debug & (l))
149
150 #define DEBUG_PKT       0x0001
151 #define DEBUG_PRUNE     0x0002
152 #define DEBUG_ROUTE     0x0004
153 #define DEBUG_PEER      0x0008
154 #define DEBUG_CACHE     0x0010
155 #define DEBUG_TIMEOUT   0x0020
156 #define DEBUG_IF        0x0040
157 #define DEBUG_MEMBER    0x0080
158 #define DEBUG_TRACE     0x0100
159 #define DEBUG_IGMP      0x0200
160 #define DEBUG_RTDETAIL  0x0400
161 #define DEBUG_KERN      0x0800
162 #define DEBUG_RSRR      0x1000
163 #define DEBUG_ICMP      0x2000
164
165 #define DEFAULT_DEBUG   0x02de  /* default if "-d" given without value */
166
167 extern int              debug;
168 extern int              did_final_init;
169
170 extern int              routes_changed;
171 extern int              delay_change_reports;
172 extern unsigned         nroutes;
173
174 extern struct uvif      uvifs[MAXVIFS];
175 extern vifi_t           numvifs;
176 extern int              vifs_down;
177 extern int              udp_socket;
178 extern int              vifs_with_neighbors;
179
180 extern char             s1[];
181 extern char             s2[];
182 extern char             s3[];
183 extern char             s4[];
184
185 #if !(defined(BSD) && (BSD >= 199103))
186 extern int              errno;
187 extern int              sys_nerr;
188 extern char *           sys_errlist[];
189 #endif
190
191 #ifdef OLD_KERNEL
192 #define MRT_INIT        DVMRP_INIT
193 #define MRT_DONE        DVMRP_DONE
194 #define MRT_ADD_VIF     DVMRP_ADD_VIF
195 #define MRT_DEL_VIF     DVMRP_DEL_VIF
196 #define MRT_ADD_MFC     DVMRP_ADD_MFC
197 #define MRT_DEL_MFC     DVMRP_DEL_MFC
198 #endif
199
200 #ifndef IGMP_PIM
201 #define IGMP_PIM        0x14
202 #endif
203 #ifndef IPPROTO_IPIP
204 #define IPPROTO_IPIP    4
205 #endif
206
207 /*
208  * The original multicast releases defined
209  * IGMP_HOST_{MEMBERSHIP_QUERY,MEMBERSHIP_REPORT,NEW_MEMBERSHIP_REPORT
210  *   ,LEAVE_MESSAGE}.  Later releases removed the HOST and inserted
211  * the IGMP version number.  NetBSD inserted the version number in
212  * a different way.  mrouted uses the new names, so we #define them
213  * to the old ones if needed.
214  */
215 #if !defined(IGMP_MEMBERSHIP_QUERY) && defined(IGMP_HOST_MEMBERSHIP_QUERY)
216 #define IGMP_MEMBERSHIP_QUERY           IGMP_HOST_MEMBERSHIP_QUERY
217 #define IGMP_V2_LEAVE_GROUP             IGMP_HOST_LEAVE_MESSAGE
218 #endif
219 #ifndef IGMP_V1_MEMBERSHIP_REPORT
220 #ifdef  IGMP_HOST_MEMBERSHIP_REPORT
221 #define IGMP_V1_MEMBERSHIP_REPORT       IGMP_HOST_MEMBERSHIP_REPORT
222 #define IGMP_V2_MEMBERSHIP_REPORT       IGMP_HOST_NEW_MEMBERSHIP_REPORT
223 #endif
224 #ifdef  IGMP_v1_HOST_MEMBERSHIP_REPORT
225 #define IGMP_V1_MEMBERSHIP_REPORT       IGMP_v1_HOST_MEMBERSHIP_REPORT
226 #define IGMP_V2_MEMBERSHIP_REPORT       IGMP_v2_HOST_MEMBERSHIP_REPORT
227 #endif
228 #endif
229
230 /*
231  * NetBSD also renamed the mtrace types.
232  */
233 #if !defined(IGMP_MTRACE_RESP) && defined(IGMP_MTRACE_REPLY)
234 #define IGMP_MTRACE_RESP                IGMP_MTRACE_REPLY
235 #define IGMP_MTRACE                     IGMP_MTRACE_QUERY
236 #endif
237
238 /* main.c */
239 extern char *           scaletime(u_long);
240 extern void             log(int, int, char *, ...) __printflike(3, 4);
241 extern int              register_input_handler(int, ihfunc_t);
242
243 /* igmp.c */
244 extern void             init_igmp(void);
245 extern void             accept_igmp(int);
246 extern void             build_igmp(u_int32, u_int32, int, int, u_int32,
247                                                 int);
248 extern void             send_igmp(u_int32, u_int32, int, int, u_int32,
249                                                 int);
250 extern char *           igmp_packet_kind(u_int, u_int);
251 extern int              igmp_debug_kind(u_int, u_int);
252
253 /* icmp.c */
254 extern void             init_icmp(void);
255
256 /* ipip.c */
257 extern void             init_ipip(void);
258 extern void             init_ipip_on_vif(struct uvif *);
259 extern void             send_ipip(u_int32, u_int32, int, int, u_int32,
260                                                 int, struct uvif *);
261
262 /* callout.c */
263 extern void             callout_init(void);
264 extern void             free_all_callouts(void);
265 extern void             age_callout_queue(int);
266 extern int              timer_nextTimer(void);
267 extern int              timer_setTimer(int, cfunc_t, void *);
268 extern int              timer_clearTimer(int);
269 extern int              timer_leftTimer(int);
270
271 /* route.c */
272 extern void             init_routes(void);
273 extern void             start_route_updates(void);
274 extern void             update_route(u_int32, u_int32, u_int, u_int32,
275                                                 vifi_t, struct listaddr *);
276 extern void             age_routes(void);
277 extern void             expire_all_routes(void);
278 extern void             free_all_routes(void);
279 extern void             accept_probe(u_int32, u_int32, char *, int,
280                                                 u_int32);
281 extern void             accept_report(u_int32, u_int32, char *, int,
282                                                 u_int32);
283 extern struct rtentry * determine_route(u_int32 src);
284 extern void             report(int, vifi_t, u_int32);
285 extern void             report_to_all_neighbors(int);
286 extern int              report_next_chunk(void);
287 extern void             blaster_alloc(vifi_t);
288 extern void             add_vif_to_routes(vifi_t);
289 extern void             delete_vif_from_routes(vifi_t);
290 extern void             add_neighbor_to_routes(vifi_t, int);
291 extern void             delete_neighbor_from_routes(u_int32,
292                                                 vifi_t, int);
293 extern void             dump_routes(FILE *fp);
294
295 /* vif.c */
296 extern void             init_vifs(void);
297 extern void             zero_vif(struct uvif *, int);
298 extern void             init_installvifs(void);
299 extern void             check_vif_state(void);
300 extern void             send_on_vif(struct uvif *, u_int32, int, int);
301 extern vifi_t           find_vif(u_int32, u_int32);
302 extern void             age_vifs(void);
303 extern void             dump_vifs(FILE *);
304 extern void             stop_all_vifs(void);
305 extern struct listaddr *neighbor_info(vifi_t, u_int32);
306 extern void             accept_group_report(u_int32, u_int32,
307                                         u_int32, int);
308 extern void             query_groups(void);
309 extern void             probe_for_neighbors(void);
310 extern struct listaddr *update_neighbor(vifi_t, u_int32, int, char *, int,
311                                         u_int32);
312 extern void             accept_neighbor_request(u_int32, u_int32);
313 extern void             accept_neighbor_request2(u_int32, u_int32);
314 extern void             accept_info_request(u_int32, u_int32,
315                                         u_char *, int);
316 extern void             accept_info_reply(u_int32, u_int32,
317                                         u_char *, int);
318 extern void             accept_neighbors(u_int32, u_int32,
319                                         u_char *, int, u_int32);
320 extern void             accept_neighbors2(u_int32, u_int32,
321                                         u_char *, int, u_int32);
322 extern void             accept_leave_message(u_int32, u_int32,
323                                         u_int32);
324 extern void             accept_membership_query(u_int32, u_int32,
325                                         u_int32, int);
326
327 /* config.c */
328 extern void             config_vifs_from_kernel(void);
329
330 /* cfparse.y */
331 extern void             config_vifs_from_file(void);
332
333 /* inet.c */
334 extern int              inet_valid_host(u_int32);
335 extern int              inet_valid_mask(u_int32);
336 extern int              inet_valid_subnet(u_int32, u_int32);
337 extern char *           inet_fmt(u_int32, char *);
338 extern char *           inet_fmts(u_int32, u_int32, char *);
339 extern u_int32          inet_parse(char *, int);
340 extern int              inet_cksum(u_short *, u_int);
341
342 /* prune.c */
343 extern unsigned         kroutes;
344 extern void             determine_forwvifs(struct gtable *);
345 extern void             send_prune_or_graft(struct gtable *);
346 extern void             add_table_entry(u_int32, u_int32);
347 extern void             del_table_entry(struct rtentry *,
348                                         u_int32, u_int);
349 extern void             update_table_entry(struct rtentry *, u_int32);
350 extern int              find_src_grp(u_int32, u_int32, u_int32);
351 extern void             init_ktable(void);
352 extern void             steal_sources(struct rtentry *);
353 extern void             reset_neighbor_state(vifi_t, u_int32);
354 extern int              grplst_mem(vifi_t, u_int32);
355 extern void             free_all_prunes(void);
356 extern void             age_table_entry(void);
357 extern void             dump_cache(FILE *);
358 extern void             update_lclgrp(vifi_t, u_int32);
359 extern void             delete_lclgrp(vifi_t, u_int32);
360 extern void             chkgrp_graft(vifi_t, u_int32);
361 extern void             accept_prune(u_int32, u_int32, char *, int);
362 extern void             accept_graft(u_int32, u_int32, char *, int);
363 extern void             accept_g_ack(u_int32, u_int32, char *, int);
364 /* u_int is promoted u_char */
365 extern void             accept_mtrace(u_int32, u_int32,
366                                         u_int32, char *, u_int, int);
367
368 /* kern.c */
369 extern void             k_set_rcvbuf(int, int);
370 extern void             k_hdr_include(int);
371 extern void             k_set_ttl(int);
372 extern void             k_set_loop(int);
373 extern void             k_set_if(u_int32);
374 extern void             k_join(u_int32, u_int32);
375 extern void             k_leave(u_int32, u_int32);
376 extern void             k_init_dvmrp(void);
377 extern void             k_stop_dvmrp(void);
378 extern void             k_add_vif(vifi_t, struct uvif *);
379 extern void             k_del_vif(vifi_t);
380 extern void             k_add_rg(u_int32, struct gtable *);
381 extern int              k_del_rg(u_int32, struct gtable *);
382 extern int              k_get_version(void);
383
384 #ifdef SNMP
385 /* prune.c */
386 extern struct gtable *  find_grp(u_int32);
387 extern struct stable *  find_grp_src(struct gtable *, u_int32);
388 extern int              next_grp_src_mask(struct gtable **,
389                                         struct stable **, u_int32,
390                                         u_int32, u_int32);
391 extern void             refresh_sg(struct sioc_sg_req *, struct gtable *,
392                                         struct stable *);
393 extern int              next_child(struct gtable **, struct stable **,
394                                         u_int32, u_int32, u_int32,
395                                         vifi_t *);
396
397 /* route.c */
398 extern struct rtentry * snmp_find_route(u_int32, u_int32);
399 extern int              next_route(struct rtentry **, u_int32, u_int32);
400 extern int              next_route_child(struct rtentry **,
401                                 u_int32, u_int32, vifi_t *);
402 #endif
403
404 #ifdef RSRR
405 /* prune.c */
406 extern struct gtable    *kernel_table;
407 extern struct gtable    *gtp;
408
409 /* rsrr.c */
410 extern void             rsrr_init(void);
411 extern void             rsrr_clean(void);
412 extern void             rsrr_cache_send(struct gtable *, int);
413 extern void             rsrr_cache_clean(struct gtable *);
414 #endif /* RSRR */