/* $OpenBSD: ip_mroute.h,v 1.34 2025/05/09 14:43:47 jan Exp $ */ /* $NetBSD: ip_mroute.h,v 1.23 2004/04/21 17:49:46 itojun Exp $ */ #ifndef _NETINET_IP_MROUTE_H_ #define _NETINET_IP_MROUTE_H_ /* * Definitions for IP multicast forwarding. * * Written by David Waitzman, BBN Labs, August 1988. * Modified by Steve Deering, Stanford, February 1989. * Modified by Ajit Thyagarajan, PARC, August 1993. * Modified by Ajit Thyagarajan, PARC, August 1994. * Modified by Ahmed Helmy, SGI, June 1996. * Modified by Pavlin Radoslavov, ICSI, October 2002. * * MROUTING Revision: 1.2 * advanced API support, bandwidth metering and signaling. */ /* * Multicast Routing set/getsockopt commands. */ #define MRT_INIT 100 /* initialize forwarder */ #define MRT_DONE 101 /* shut down forwarder */ #define MRT_ADD_VIF 102 /* create virtual interface */ #define MRT_DEL_VIF 103 /* delete virtual interface */ #define MRT_ADD_MFC 104 /* insert forwarding cache entry */ #define MRT_DEL_MFC 105 /* delete forwarding cache entry */ #define MRT_VERSION 106 /* get kernel version number */ #define MRT_ASSERT 107 /* enable assert processing */ #define MRT_API_SUPPORT 109 /* supported MRT API */ #define MRT_API_CONFIG 110 /* config MRT API */ /* * Types and macros for handling bitmaps with one bit per virtual interface. */ #define MAXVIFS 32 typedef u_int32_t vifbitmap_t; typedef u_int16_t vifi_t; /* type of a vif index */ #define VIFM_SET(n, m) ((m) |= (1 << (n))) #define VIFM_CLR(n, m) ((m) &= ~(1 << (n))) #define VIFM_ISSET(n, m) ((m) & (1 << (n))) #define VIFM_CLRALL(m) ((m) = 0x00000000) #define VIFM_COPY(mfrom, mto) ((mto) = (mfrom)) #define VIFM_SAME(m1, m2) ((m1) == (m2)) #define VIFF_TUNNEL 0x1 /* vif represents a tunnel end-point */ #define VIFF_SRCRT 0x2 /* tunnel uses IP src routing */ /* * Argument structure for MRT_ADD_VIF. * (MRT_DEL_VIF takes a single vifi_t argument.) */ struct vifctl { vifi_t vifc_vifi; /* the index of the vif to be added */ u_int8_t vifc_flags; /* VIFF_ flags defined above */ u_int8_t vifc_threshold; /* min ttl required to forward on vif */ u_int32_t vifc_rate_limit; /* ignored */ struct in_addr vifc_lcl_addr;/* local interface address */ struct in_addr vifc_rmt_addr;/* remote address (tunnels only) */ }; /* * Argument structure for MRT_ADD_MFC and MRT_DEL_MFC. * XXX if you change this, make sure to change struct mfcctl2 as well. */ struct mfcctl { struct in_addr mfcc_origin; /* ip origin of mcasts */ struct in_addr mfcc_mcastgrp; /* multicast group associated */ vifi_t mfcc_parent; /* incoming vif */ u_int8_t mfcc_ttls[MAXVIFS]; /* forwarding ttls on vifs */ }; /* * The new argument structure for MRT_ADD_MFC and MRT_DEL_MFC overlays * and extends the old struct mfcctl. */ struct mfcctl2 { /* the mfcctl fields */ struct in_addr mfcc_origin; /* ip origin of mcasts */ struct in_addr mfcc_mcastgrp; /* multicast group associated*/ vifi_t mfcc_parent; /* incoming vif */ u_int8_t mfcc_ttls[MAXVIFS]; /* forwarding ttls on vifs */ /* extension fields */ u_int8_t mfcc_flags[MAXVIFS]; /* the MRT_MFC_FLAGS_* flags */ struct in_addr mfcc_rp; /* the RP address */ }; /* * The advanced-API flags. * * The MRT_MFC_FLAGS_XXX API flags are also used as flags * for the mfcc_flags field. */ #define MRT_MFC_FLAGS_DISABLE_WRONGVIF (1 << 0) /* disable WRONGVIF signals */ #define MRT_MFC_RP (1 << 8) /* enable RP address */ #define MRT_MFC_BW_UPCALL (1 << 9) /* enable bw upcalls */ #define MRT_MFC_FLAGS_ALL (MRT_MFC_FLAGS_DISABLE_WRONGVIF) #define MRT_API_FLAGS_ALL (MRT_MFC_FLAGS_ALL | \ MRT_MFC_RP | \ MRT_MFC_BW_UPCALL) /* structure used to get all the mfc entries */ struct mfcinfo { struct in_addr mfc_origin; /* ip origin of mcasts */ struct in_addr mfc_mcastgrp; /* multicast group associated */ vifi_t mfc_parent; /* incoming vif */ u_long mfc_pkt_cnt; /* pkt count for src-grp */ u_long mfc_byte_cnt; /* byte count for src-grp */ u_int8_t mfc_ttls[MAXVIFS]; /* forwarding ttls on vifs */ }; /* structure used to get all the vif entries */ struct vifinfo { vifi_t v_vifi; /* the index of the vif to be added */ u_int8_t v_flags; /* VIFF_ flags defined above */ u_int8_t v_threshold; /* min ttl required to forward on vif */ struct in_addr v_lcl_addr; /* local interface address */ struct in_addr v_rmt_addr; /* remote address (tunnels only) */ u_long v_pkt_in; /* # pkts in on interface */ u_long v_pkt_out; /* # pkts out on interface */ u_long v_bytes_in; /* # bytes in on interface */ u_long v_bytes_out; /* # bytes out on interface */ }; /* * Argument structure used by mrouted to get src-grp pkt counts. */ struct sioc_sg_req { struct in_addr src; struct in_addr grp; u_long pktcnt; u_long bytecnt; u_long wrong_if; }; /* * Argument structure used by mrouted to get vif pkt counts. */ struct sioc_vif_req { vifi_t vifi; /* vif number */ u_long icount; /* input packet count on vif */ u_long ocount; /* output packet count on vif */ u_long ibytes; /* input byte count on vif */ u_long obytes; /* output byte count on vif */ }; /* * The kernel's multicast routing statistics. */ struct mrtstat { u_long mrts_mfc_lookups; /* # forw. cache hash table hits */ u_long mrts_mfc_misses; /* # forw. cache hash table misses */ u_long mrts_upcalls; /* # calls to mrouted */ u_long mrts_no_route; /* no route for packet's origin */ u_long mrts_bad_tunnel; /* malformed tunnel options */ u_long mrts_cant_tunnel; /* no room for tunnel options */ u_long mrts_wrong_if; /* arrived on wrong interface */ u_long mrts_upq_ovflw; /* upcall Q overflow */ u_long mrts_cache_cleanups; /* # entries with no upcalls */ u_long mrts_drop_sel; /* pkts dropped selectively */ u_long mrts_q_overflow; /* pkts dropped - Q overflow */ u_long mrts_pkt2large; /* pkts dropped - size > BKT SIZE */ u_long mrts_upq_sockfull; /* upcalls dropped - socket full */ }; #ifdef _KERNEL enum mrtstat_counters { mrts_mfc_lookups, mrts_mfc_misses, mrts_upcalls, mrts_no_route, mrts_bad_tunnel, mrts_cant_tunnel, mrts_wrong_if, mrts_upq_ovflw, mrts_cache_cleanups, mrts_drop_sel, mrts_q_overflow, mrts_pkt2large, mrts_upq_sockfull, mrts_ncounters }; extern struct cpumem *mrtcounters; static inline void mrtstat_inc(enum mrtstat_counters c) { counters_inc(mrtcounters, c); } /* How frequent should we look for expired entries (in seconds). */ #define MCAST_EXPIRE_FREQUENCY 30 extern int ip_mrtproto; /* * The kernel's virtual-interface structure. */ struct vif { vifi_t v_id; /* Virtual interface index */ u_int8_t v_flags; /* VIFF_ flags defined above */ u_int8_t v_threshold; /* min ttl required to forward on vif */ struct in_addr v_lcl_addr; /* local interface address */ struct in_addr v_rmt_addr; /* remote address (tunnels only) */ u_long v_pkt_in; /* # pkts in on interface */ u_long v_pkt_out; /* # pkts out on interface */ u_long v_bytes_in; /* # bytes in on interface */ u_long v_bytes_out; /* # bytes out on interface */ }; /* * The kernel's multicast forwarding cache entry structure. * (A field for the type of service (mfc_tos) is to be added * at a future point.) */ struct mfc { vifi_t mfc_parent; /* incoming vif */ u_long mfc_pkt_cnt; /* pkt count for src-grp */ u_long mfc_byte_cnt; /* byte count for src-grp */ u_long mfc_wrong_if; /* wrong if for src-grp */ uint8_t mfc_ttl; /* route interface ttl */ uint8_t mfc_flags; /* MRT_MFC_FLAGS_* flags */ struct in_addr mfc_rp; /* the RP address */ u_long mfc_expire; /* expire timer */ }; /* * Structure used to communicate from kernel to multicast router. * (Note the convenient similarity to an IP packet.) */ struct igmpmsg { u_int32_t unused1; u_int32_t unused2; u_int8_t im_msgtype; /* what type of message */ #define IGMPMSG_NOCACHE 1 /* no MFC in the kernel */ #define IGMPMSG_WRONGVIF 2 /* packet came from wrong interface */ #define IGMPMSG_BW_UPCALL 4 /* BW monitoring upcall */ u_int8_t im_mbz; /* must be zero */ u_int8_t im_vif; /* vif rec'd on */ u_int8_t unused3; struct in_addr im_src, im_dst; }; int ip_mrouter_set(struct socket *, int, struct mbuf *); int ip_mrouter_get(struct socket *, int, struct mbuf *); void mrt_init(void); int mrt_ioctl(struct socket *, u_long, caddr_t); int mrt_sysctl_vif(void *, size_t *); int mrt_sysctl_mrtstat(void *, size_t *, void *); int mrt_sysctl_mfc(void *, size_t *); int ip_mrouter_done(struct socket *); void vif_delete(struct ifnet *); #endif /* _KERNEL */ #endif /* _NETINET_IP_MROUTE_H_ */
