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