Home | History | Annotate | Line # | Download | only in netinet
ip_mroute.h revision 1.18
      1 /*	$NetBSD: ip_mroute.h,v 1.18 2000/03/23 07:03:29 thorpej Exp $	*/
      2 
      3 /*
      4  * Definitions for IP multicast forwarding.
      5  *
      6  * Written by David Waitzman, BBN Labs, August 1988.
      7  * Modified by Steve Deering, Stanford, February 1989.
      8  * Modified by Ajit Thyagarajan, PARC, August 1993.
      9  * Modified by Ajit Thyagarajan, PARC, August 1994.
     10  *
     11  * MROUTING Revision: 1.2
     12  */
     13 
     14 #ifndef _NETINET_IP_MROUTE_H_
     15 #define _NETINET_IP_MROUTE_H_
     16 
     17 #include <sys/queue.h>
     18 #include <sys/callout.h>
     19 
     20 /*
     21  * Multicast Routing set/getsockopt commands.
     22  */
     23 #define	MRT_INIT		100	/* initialize forwarder */
     24 #define	MRT_DONE		101	/* shut down forwarder */
     25 #define	MRT_ADD_VIF		102	/* create virtual interface */
     26 #define	MRT_DEL_VIF		103	/* delete virtual interface */
     27 #define	MRT_ADD_MFC		104	/* insert forwarding cache entry */
     28 #define	MRT_DEL_MFC		105	/* delete forwarding cache entry */
     29 #define	MRT_VERSION		106	/* get kernel version number */
     30 #define	MRT_ASSERT		107	/* enable PIM assert processing */
     31 
     32 
     33 /*
     34  * Types and macros for handling bitmaps with one bit per virtual interface.
     35  */
     36 #define	MAXVIFS 32
     37 typedef u_int32_t vifbitmap_t;
     38 typedef u_int16_t vifi_t;		/* type of a vif index */
     39 
     40 #define	VIFM_SET(n, m)			((m) |= (1 << (n)))
     41 #define	VIFM_CLR(n, m)			((m) &= ~(1 << (n)))
     42 #define	VIFM_ISSET(n, m)		((m) & (1 << (n)))
     43 #define	VIFM_SETALL(m)			((m) = 0xffffffff)
     44 #define	VIFM_CLRALL(m)			((m) = 0x00000000)
     45 #define	VIFM_COPY(mfrom, mto)		((mto) = (mfrom))
     46 #define	VIFM_SAME(m1, m2)		((m1) == (m2))
     47 
     48 #define	VIFF_TUNNEL	0x1		/* vif represents a tunnel end-point */
     49 #define	VIFF_SRCRT	0x2		/* tunnel uses IP src routing */
     50 
     51 /*
     52  * Argument structure for MRT_ADD_VIF.
     53  * (MRT_DEL_VIF takes a single vifi_t argument.)
     54  */
     55 struct vifctl {
     56 	vifi_t	  vifc_vifi;	    	/* the index of the vif to be added */
     57 	u_int8_t  vifc_flags;     	/* VIFF_ flags defined below */
     58 	u_int8_t  vifc_threshold; 	/* min ttl required to forward on vif */
     59 	u_int32_t vifc_rate_limit;	/* max rate */
     60 	struct	  in_addr vifc_lcl_addr;/* local interface address */
     61 	struct	  in_addr vifc_rmt_addr;/* remote address (tunnels only) */
     62 };
     63 
     64 /*
     65  * Argument structure for MRT_ADD_MFC and MRT_DEL_MFC.
     66  * (mfcc_tos to be added at a future point)
     67  */
     68 struct mfcctl {
     69 	struct	 in_addr mfcc_origin;	/* ip origin of mcasts */
     70 	struct	 in_addr mfcc_mcastgrp;	/* multicast group associated */
     71 	vifi_t	 mfcc_parent;		/* incoming vif */
     72 	u_int8_t mfcc_ttls[MAXVIFS];	/* forwarding ttls on vifs */
     73 };
     74 
     75 /*
     76  * Argument structure used by mrouted to get src-grp pkt counts.
     77  */
     78 struct sioc_sg_req {
     79 	struct	in_addr src;
     80 	struct	in_addr grp;
     81 	u_long	pktcnt;
     82 	u_long	bytecnt;
     83 	u_long	wrong_if;
     84 };
     85 
     86 /*
     87  * Argument structure used by mrouted to get vif pkt counts.
     88  */
     89 struct sioc_vif_req {
     90 	vifi_t	vifi;			/* vif number */
     91 	u_long	icount;			/* input packet count on vif */
     92 	u_long	ocount;			/* output packet count on vif */
     93 	u_long	ibytes;			/* input byte count on vif */
     94 	u_long	obytes;			/* output byte count on vif */
     95 };
     96 
     97 
     98 /*
     99  * The kernel's multicast routing statistics.
    100  */
    101 struct mrtstat {
    102 	u_long	mrts_mfc_lookups;	/* # forw. cache hash table hits */
    103 	u_long	mrts_mfc_misses;	/* # forw. cache hash table misses */
    104 	u_long	mrts_upcalls;		/* # calls to mrouted */
    105 	u_long	mrts_no_route;		/* no route for packet's origin */
    106 	u_long	mrts_bad_tunnel;	/* malformed tunnel options */
    107 	u_long	mrts_cant_tunnel;	/* no room for tunnel options */
    108 	u_long	mrts_wrong_if;		/* arrived on wrong interface */
    109 	u_long	mrts_upq_ovflw;		/* upcall Q overflow */
    110 	u_long	mrts_cache_cleanups;	/* # entries with no upcalls */
    111 	u_long	mrts_drop_sel;     	/* pkts dropped selectively */
    112 	u_long	mrts_q_overflow;    	/* pkts dropped - Q overflow */
    113 	u_long	mrts_pkt2large;     	/* pkts dropped - size > BKT SIZE */
    114 	u_long	mrts_upq_sockfull;	/* upcalls dropped - socket full */
    115 };
    116 
    117 
    118 #ifdef _KERNEL
    119 
    120 /*
    121  * The kernel's virtual-interface structure.
    122  */
    123 struct vif {
    124 	struct	  mbuf *tbf_q, **tbf_t;	/* packet queue */
    125 	struct	  timeval tbf_last_pkt_t; /* arr. time of last pkt */
    126 	u_int32_t tbf_n_tok;		/* no of tokens in bucket */
    127 	u_int32_t tbf_q_len;		/* length of queue at this vif */
    128 	u_int32_t tbf_max_q_len;	/* max. queue length */
    129 
    130 	u_int8_t  v_flags;		/* VIFF_ flags defined above */
    131 	u_int8_t  v_threshold;		/* min ttl required to forward on vif */
    132 	u_int32_t v_rate_limit;		/* max rate */
    133 	struct	  in_addr v_lcl_addr;	/* local interface address */
    134 	struct	  in_addr v_rmt_addr;	/* remote address (tunnels only) */
    135 	struct	  ifnet *v_ifp;		/* pointer to interface */
    136 	u_long	  v_pkt_in;		/* # pkts in on interface */
    137 	u_long	  v_pkt_out;		/* # pkts out on interface */
    138 	u_long	  v_bytes_in;		/* # bytes in on interface */
    139 	u_long	  v_bytes_out;		/* # bytes out on interface */
    140 	struct	  route v_route;	/* cached route if this is a tunnel */
    141 	struct	  callout v_repq_ch;	/* for tbf_reprocess_q() */
    142 #ifdef RSVP_ISI
    143 	int	  v_rsvp_on;		/* # RSVP listening on this vif */
    144 	struct	  socket *v_rsvpd;	/* # RSVPD daemon */
    145 #endif /* RSVP_ISI */
    146 };
    147 
    148 /*
    149  * The kernel's multicast forwarding cache entry structure.
    150  * (A field for the type of service (mfc_tos) is to be added
    151  * at a future point.)
    152  */
    153 struct mfc {
    154 	LIST_ENTRY(mfc) mfc_hash;
    155 	struct	 in_addr mfc_origin;	 	/* ip origin of mcasts */
    156 	struct	 in_addr mfc_mcastgrp;  	/* multicast group associated */
    157 	vifi_t	 mfc_parent;			/* incoming vif */
    158 	u_int8_t mfc_ttls[MAXVIFS]; 		/* forwarding ttls on vifs */
    159 	u_long	 mfc_pkt_cnt;			/* pkt count for src-grp */
    160 	u_long	 mfc_byte_cnt;			/* byte count for src-grp */
    161 	u_long	 mfc_wrong_if;			/* wrong if for src-grp	*/
    162 	int	 mfc_expire;			/* time to clean entry up */
    163 	struct	 timeval mfc_last_assert;	/* last time I sent an assert */
    164 	struct	 rtdetq *mfc_stall;		/* pkts waiting for route */
    165 };
    166 
    167 /*
    168  * Structure used to communicate from kernel to multicast router.
    169  * (Note the convenient similarity to an IP packet.)
    170  */
    171 struct igmpmsg {
    172 	u_int32_t unused1;
    173 	u_int32_t unused2;
    174 	u_int8_t  im_msgtype;		/* what type of message */
    175 #define IGMPMSG_NOCACHE		1
    176 #define IGMPMSG_WRONGVIF	2
    177 	u_int8_t  im_mbz;		/* must be zero */
    178 	u_int8_t  im_vif;		/* vif rec'd on */
    179 	u_int8_t  unused3;
    180 	struct	  in_addr im_src, im_dst;
    181 } __attribute__((__packed__));
    182 
    183 /*
    184  * Argument structure used for pkt info. while upcall is made.
    185  */
    186 struct rtdetq {
    187 	struct	mbuf *m;		/* a copy of the packet */
    188 	struct	ifnet *ifp;		/* interface pkt came in on */
    189 #ifdef UPCALL_TIMING
    190 	struct	timeval t;		/* timestamp */
    191 #endif /* UPCALL_TIMING */
    192 	struct	rtdetq *next;
    193 };
    194 
    195 #define	MFCTBLSIZ	256
    196 #define	MAX_UPQ		4		/* max. no of pkts in upcall Q */
    197 
    198 /*
    199  * Token bucket filter code
    200  */
    201 #define	MAX_BKT_SIZE    10000		/* 10K bytes size */
    202 #define	MAXQSIZE        10		/* max. no of pkts in token queue */
    203 
    204 
    205 int ip_mrouter_set __P((struct socket *, int, struct mbuf **));
    206 int ip_mrouter_get __P((struct socket *, int, struct mbuf **));
    207 int mrt_ioctl __P((struct socket *, u_long, caddr_t));
    208 int ip_mrouter_done __P((void));
    209 void reset_vif __P((struct vif *));
    210 #ifdef RSVP_ISI
    211 int ip_mforward __P((struct mbuf *, struct ifnet *, struct ip_moptions *));
    212 int legal_vif_num __P((int));
    213 int ip_rsvp_vif_init __P((struct socket *, struct mbuf *));
    214 int ip_rsvp_vif_done __P((struct socket *, struct mbuf *));
    215 void ip_rsvp_force_done __P((struct socket *));
    216 /*int rsvp_input __P((struct mbuf *, struct ifnet *));*/
    217 void rsvp_input __P((struct mbuf *, int, int));
    218 #else
    219 int ip_mforward __P((struct mbuf *, struct ifnet *));
    220 #endif
    221 int mrt_ipip_input __P((struct mbuf *, int));
    222 
    223 #endif /* _KERNEL */
    224 
    225 #endif /* _NETINET_IP_MROUTE_H_ */
    226