/* * CDDL HEADER START * * The contents of this file are subject to the terms of the * Common Development and Distribution License (the "License"). * You may not use this file except in compliance with the License. * * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE * or http://www.opensolaris.org/os/licensing. * See the License for the specific language governing permissions * and limitations under the License. * * When distributing Covered Code, include this CDDL HEADER in each * file and include the License file at usr/src/OPENSOLARIS.LICENSE. * If applicable, add the following below this CDDL HEADER, with the * fields enclosed by brackets "[]" replaced with your own identifying * information: Portions Copyright [yyyy] [name of copyright owner] * * CDDL HEADER END */ /* * Copyright 2009 Sun Microsystems, Inc. All rights reserved. * Use is subject to license terms. */ /* Copyright (c) 1990 Mentat Inc. */ #ifndef _NETINET_IP_MROUTE_H #define _NETINET_IP_MROUTE_H #ifdef __cplusplus extern "C" { #endif /* * Definitions for the kernel part of DVMRP, * a Distance-Vector Multicast Routing Protocol. * (See RFC-1075.) * * 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. * * MROUTING 3.5 */ /* * DVMRP-specific setsockopt 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 PIM assert processing */ /* * Types and macros for handling bitmaps with one bit per virtual interface. */ #define MAXVIFS 32 typedef uint_t vifbitmap_t; typedef ushort_t vifi_t; /* type of a vif index */ #define ALL_VIFS (vifi_t)-1 #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)) /* * Argument structure for MRT_ADD_VIF. Also used for netstat. * (MRT_DEL_VIF takes a single vifi_t argument.) */ struct vifctl { vifi_t vifc_vifi; /* the index of the vif to be added */ uchar_t vifc_flags; /* VIFF_ flags defined below */ uchar_t vifc_threshold; /* min ttl required to forward on vif */ uint_t vifc_rate_limit; /* max rate */ struct in_addr vifc_lcl_addr; /* local interface address */ struct in_addr vifc_rmt_addr; /* remote address(tunnels only) */ /* * vifc_pkt_in/out in Solaris, to report out of the kernel. * Not nec. in BSD. */ uint_t vifc_pkt_in; /* # Pkts in on interface */ uint_t vifc_pkt_out; /* # Pkts out on interface */ }; #define VIFF_TUNNEL 0x1 /* vif represents a tunnel end-point */ #define VIFF_SRCRT 0x2 /* tunnel uses IP src routing */ #define VIFF_REGISTER 0x4 /* for RPF check of PIM Register msg */ /* * Argument structure for MRT_ADD_MFC and MRT_DEL_MFC * (mfcc_tos to be added at a future point) */ 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 */ uint_t mfcc_pkt_cnt; /* pkt count for src-grp */ uchar_t mfcc_ttls[MAXVIFS]; /* forwarding ttls on vifs */ }; /* * The kernel's multicast routing statistics. */ struct mrtstat { uint_t mrts_mfcfind_lookups; /* #forwarding cache table lookups */ uint_t mrts_mfcfind_misses; /* # forwarding cache table misses */ uint_t mrts_mfc_hits; /* forwarding pkt mfctable hits */ uint_t mrts_mfc_misses; /* forwarding pkt mfctable misses */ uint_t mrts_upcalls; /* # calls to mrouted */ uint_t mrts_fwd_in; /* # packets potentially forwarded */ uint_t mrts_fwd_out; /* # resulting outgoing packets */ uint_t mrts_fwd_drop; /* # dropped for lack of resources */ uint_t mrts_bad_tunnel; /* malformed tunnel options */ uint_t mrts_cant_tunnel; /* no room for tunnel options */ uint_t mrts_wrong_if; /* arrived on wrong interface */ uint_t mrts_upq_ovflw; /* upcall Q overflow */ uint_t mrts_cache_cleanups; /* # entries with no upcalls */ uint_t mrts_drop_sel; /* pkts dropped selectively */ uint_t mrts_q_overflow; /* pkts dropped - Q overflow */ uint_t mrts_pkt2large; /* pkts dropped - size > BKT SIZE */ uint_t mrts_vifctlSize; /* Size of vifctl */ uint_t mrts_mfcctlSize; /* Size of mfcctl */ uint_t mrts_pim_badversion; /* dtgrms dropped - bad version */ uint_t mrts_pim_rcv_badcsum; /* dtgrms dropped - bad checksum */ uint_t mrts_pim_badregisters; /* dtgrms dropped - bad register pkts */ uint_t mrts_pim_regforwards; /* dtgrms to be forwd - register pkts */ uint_t mrts_pim_regsend_drops; /* dtgrms dropped - register send */ uint_t mrts_pim_malformed; /* dtgrms dropped - packet malformed */ uint_t mrts_pim_nomemory; /* dtgrms dropped - no memory to fwd. */ }; /* * Argument structure used by mrouted to get src-grp pkt counts */ struct sioc_sg_req { struct in_addr src; struct in_addr grp; uint_t pktcnt; uint_t bytecnt; uint_t wrong_if; }; /* * Argument structure used by mrouted to get vif pkt counts */ struct sioc_vif_req { vifi_t vifi; /* vif number */ uint_t icount; /* Input packet count on vif */ uint_t ocount; /* Output packet count on vif */ uint_t ibytes; /* Input byte count on vif */ uint_t obytes; /* Output byte count on vif */ }; #ifdef _KERNEL /* * The kernel's virtual-interface structure. */ struct vif { uchar_t v_flags; /* VIFF_ flags defined above */ uchar_t v_threshold; /* Min ttl required to forward on vif */ uint_t v_rate_limit; /* Max rate, in kbits/sec */ struct tbf *v_tbf; /* Token bkt structure at intf. */ struct in_addr v_lcl_addr; /* Local interface address */ struct in_addr v_rmt_addr; /* Remote address(tunnels only) */ struct ipif_s *v_ipif; /* Pointer to logical interface */ uint_t v_pkt_in; /* # Pkts in on interface */ uint_t v_pkt_out; /* # Pkts out on interface */ uint_t v_bytes_in; /* # Bytes in on interface */ uint_t v_bytes_out; /* # Bytes out on interface */ timeout_id_t v_timeout_id; /* Qtimeout return id */ /* * struct route v_route; Cached route if this is a tunnel * Used in bsd for performance */ uint_t v_refcnt; uchar_t v_marks; kmutex_t v_lock; ilm_t *v_ilm; /* allmulti join */ }; /* * vif is not being used. However if refcnt != 0 than its being initalized. */ #define VIF_MARK_NOTINUSE 0x0 /* see comment above */ #define VIF_MARK_CONDEMNED 0x1 /* delete when refcnt goes to zero. */ #define VIF_MARK_GOOD 0x2 /* vif is good */ #define VIF_MARK_INUSE VIF_MARK_CONDEMNED | VIF_MARK_GOOD /* * 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 { struct in_addr mfc_origin; /* ip origin of mcasts */ struct in_addr mfc_mcastgrp; /* multicast group associated */ vifi_t mfc_parent; /* incoming vif */ uchar_t mfc_ttls[MAXVIFS]; /* forwarding ttls on vifs */ uint_t mfc_pkt_cnt; /* pkt count for src-grp */ uint_t mfc_byte_cnt; /* byte count for src-grp */ uint_t mfc_wrong_if; /* wrong if for src-grp */ struct timespec mfc_last_assert; /* last time I sent an assert */ struct rtdetq *mfc_rte; /* pending upcall */ timeout_id_t mfc_timeout_id; /* qtimeout return id */ struct mfc *mfc_next; uchar_t mfc_marks; kmutex_t mfc_mutex; /* protects fields and rte list */ }; /* * mfc bucket structure. */ struct mfcb { struct mfc *mfcb_mfc; /* first mfc in this bucket */ kmutex_t mfcb_lock; uint_t mfcb_refcnt; /* protected by mfcb_lock */ uchar_t mfcb_marks; /* protected by mfcb_lock */ }; #define MFCB_MARK_CONDEMNED 0x1 /* * Argument structure used for pkt info. while upcall is made */ struct rtdetq { mblk_t *mp; /* A copy of the packet */ ill_t *ill; /* Interface pkt came in on */ struct rtdetq *rte_next; }; #endif /* * Struct used to communicate from kernel to multicast router * note the convenient similarity to an IP packet */ struct igmpmsg { uint_t unused1; uint_t unused2; uchar_t im_msgtype; /* what type of message */ #define IGMPMSG_NOCACHE 1 #define IGMPMSG_WRONGVIF 2 #define IGMPMSG_WHOLEPKT 3 uchar_t im_mbz; /* must be zero */ uchar_t im_vif; /* vif rec'd on */ uchar_t unused3; struct in_addr im_src, im_dst; }; #ifdef _KERNEL #define MFCTBLSIZ 256 #if (MFCTBLSIZ & (MFCTBLSIZ - 1)) == 0 /* from sys:route.h */ #define MFCHASHMOD(h) ((h) & (MFCTBLSIZ - 1)) #else #define MFCHASHMOD(h) ((h) % MFCTBLSIZ) #endif #define MAX_UPQ 4 /* max. no of pkts in upcall Q */ /* * Token Bucket filter code */ #define MAX_BKT_SIZE 10000 /* 10K bytes size */ #define MAXQSIZE 10 /* max # of pkts in queue */ #define TOKEN_SIZE 8 /* number of bits in token */ /* * The token bucket filter at each vif */ struct tbf { timespec_t tbf_last_pkt_t; /* arr. time of last pkt */ uint_t tbf_n_tok; /* no of tokens in bucket */ uint_t tbf_q_len; /* length of queue at this vif */ uint_t tbf_max_q_len; /* max queue length */ mblk_t *tbf_q; /* Packet queue */ mblk_t *tbf_t; /* Tail-insertion pointer */ kmutex_t tbf_lock; /* lock on the tbf */ }; #endif /* _KERNEL */ #ifdef __cplusplus } #endif #endif /* _NETINET_IP_MROUTE_H */
