bsd/netinet/ip_mroute.h

   1 /*
   2  * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * Copyright (c) 1999-2003 Apple Computer, Inc.  All Rights Reserved.
   7  *
   8  * This file contains Original Code and/or Modifications of Original Code
   9  * as defined in and that are subject to the Apple Public Source License
  10  * Version 2.0 (the 'License'). You may not use this file except in
  11  * compliance with the License. Please obtain a copy of the License at
  12  * http://www.opensource.apple.com/apsl/ and read it before using this
  13  * file.
  14  *
  15  * The Original Code and all software distributed under the License are
  16  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  17  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  18  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  20  * Please see the License for the specific language governing rights and
  21  * limitations under the License.
  22  *
  23  * @APPLE_LICENSE_HEADER_END@
  24  */
  25 /*
  26  * Copyright (c) 1989 Stephen Deering.
  27  * Copyright (c) 1992, 1993
  28  *      The Regents of the University of California.  All rights reserved.
  29  *
  30  * This code is derived from software contributed to Berkeley by
  31  * Stephen Deering of Stanford University.
  32  *
  33  * Redistribution and use in source and binary forms, with or without
  34  * modification, are permitted provided that the following conditions
  35  * are met:
  36  * 1. Redistributions of source code must retain the above copyright
  37  *    notice, this list of conditions and the following disclaimer.
  38  * 2. Redistributions in binary form must reproduce the above copyright
  39  *    notice, this list of conditions and the following disclaimer in the
  40  *    documentation and/or other materials provided with the distribution.
  41  * 3. All advertising materials mentioning features or use of this software
  42  *    must display the following acknowledgement:
  43  *      This product includes software developed by the University of
  44  *      California, Berkeley and its contributors.
  45  * 4. Neither the name of the University nor the names of its contributors
  46  *    may be used to endorse or promote products derived from this software
  47  *    without specific prior written permission.
  48  *
  49  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  50  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  51  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  52  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  53  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  54  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  55  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  56  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  57  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  58  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  59  * SUCH DAMAGE.
  60  *
  61  *      @(#)ip_mroute.h 8.1 (Berkeley) 6/10/93
  62  */
  63
  64 #ifndef _NETINET_IP_MROUTE_H_
  65 #define _NETINET_IP_MROUTE_H_
  66 #include <sys/appleapiopts.h>
  67
  68 /*
  69  * Definitions for IP multicast forwarding.
  70  *
  71  * Written by David Waitzman, BBN Labs, August 1988.
  72  * Modified by Steve Deering, Stanford, February 1989.
  73  * Modified by Ajit Thyagarajan, PARC, August 1993.
  74  * Modified by Ajit Thyagarajan, PARC, August 1994.
  75  *
  76  * MROUTING Revision: 3.3.1.3
  77  */
  78
  79
  80 /*
  81  * Multicast Routing set/getsockopt commands.
  82  */
  83 #define MRT_INIT        100     /* initialize forwarder */
  84 #define MRT_DONE        101     /* shut down forwarder */
  85 #define MRT_ADD_VIF     102     /* create virtual interface */
  86 #define MRT_DEL_VIF     103     /* delete virtual interface */
  87 #define MRT_ADD_MFC     104     /* insert forwarding cache entry */
  88 #define MRT_DEL_MFC     105     /* delete forwarding cache entry */
  89 #define MRT_VERSION     106     /* get kernel version number */
  90 #define MRT_ASSERT      107     /* enable PIM assert processing */
  91
  92
  93 #define GET_TIME(t)     microtime(&t)
  94
  95 /*
  96  * Types and macros for handling bitmaps with one bit per virtual interface.
  97  */
  98 #define MAXVIFS 32
  99 typedef u_long vifbitmap_t;
 100 typedef u_short vifi_t;         /* type of a vif index */
 101 #define ALL_VIFS (vifi_t)-1
 102
 103 #define VIFM_SET(n, m)          ((m) |= (1 << (n)))
 104 #define VIFM_CLR(n, m)          ((m) &= ~(1 << (n)))
 105 #define VIFM_ISSET(n, m)        ((m) & (1 << (n)))
 106 #define VIFM_CLRALL(m)          ((m) = 0x00000000)
 107 #define VIFM_COPY(mfrom, mto)   ((mto) = (mfrom))
 108 #define VIFM_SAME(m1, m2)       ((m1) == (m2))
 109
 110
 111 /*
 112  * Argument structure for MRT_ADD_VIF.
 113  * (MRT_DEL_VIF takes a single vifi_t argument.)
 114  */
 115 struct vifctl {
 116         vifi_t  vifc_vifi;              /* the index of the vif to be added */
 117         u_char  vifc_flags;             /* VIFF_ flags defined below */
 118         u_char  vifc_threshold;         /* min ttl required to forward on vif */
 119         u_int   vifc_rate_limit;        /* max rate */
 120         struct  in_addr vifc_lcl_addr;  /* local interface address */
 121         struct  in_addr vifc_rmt_addr;  /* remote address (tunnels only) */
 122 };
 123
 124 #define VIFF_TUNNEL     0x1             /* vif represents a tunnel end-point */
 125 #define VIFF_SRCRT      0x2             /* tunnel uses IP source routing */
 126
 127 /*
 128  * Argument structure for MRT_ADD_MFC and MRT_DEL_MFC
 129  * (mfcc_tos to be added at a future point)
 130  */
 131 struct mfcctl {
 132     struct in_addr  mfcc_origin;                /* ip origin of mcasts       */
 133     struct in_addr  mfcc_mcastgrp;              /* multicast group associated*/
 134     vifi_t          mfcc_parent;                /* incoming vif              */
 135     u_char          mfcc_ttls[MAXVIFS];         /* forwarding ttls on vifs   */
 136 };
 137
 138 /*
 139  * The kernel's multicast routing statistics.
 140  */
 141 struct mrtstat {
 142     u_long      mrts_mfc_lookups;       /* # forw. cache hash table hits   */
 143     u_long      mrts_mfc_misses;        /* # forw. cache hash table misses */
 144     u_long      mrts_upcalls;           /* # calls to mrouted              */
 145     u_long      mrts_no_route;          /* no route for packet's origin    */
 146     u_long      mrts_bad_tunnel;        /* malformed tunnel options        */
 147     u_long      mrts_cant_tunnel;       /* no room for tunnel options      */
 148     u_long      mrts_wrong_if;          /* arrived on wrong interface      */
 149     u_long      mrts_upq_ovflw;         /* upcall Q overflow               */
 150     u_long      mrts_cache_cleanups;    /* # entries with no upcalls       */
 151     u_long      mrts_drop_sel;          /* pkts dropped selectively        */
 152     u_long      mrts_q_overflow;        /* pkts dropped - Q overflow       */
 153     u_long      mrts_pkt2large;         /* pkts dropped - size > BKT SIZE  */
 154     u_long      mrts_upq_sockfull;      /* upcalls dropped - socket full */
 155 };
 156
 157 /*
 158  * Argument structure used by mrouted to get src-grp pkt counts
 159  */
 160 struct sioc_sg_req {
 161     struct in_addr src;
 162     struct in_addr grp;
 163     u_long pktcnt;
 164     u_long bytecnt;
 165     u_long wrong_if;
 166 };
 167
 168 /*
 169  * Argument structure used by mrouted to get vif pkt counts
 170  */
 171 struct sioc_vif_req {
 172     vifi_t vifi;                /* vif number                           */
 173     u_long icount;              /* Input packet count on vif            */
 174     u_long ocount;              /* Output packet count on vif           */
 175     u_long ibytes;              /* Input byte count on vif              */
 176     u_long obytes;              /* Output byte count on vif             */
 177 };
 178
 179
 180 /*
 181  * The kernel's virtual-interface structure.
 182  */
 183 struct vif {
 184     u_char              v_flags;        /* VIFF_ flags defined above         */
 185     u_char              v_threshold;    /* min ttl required to forward on vif*/
 186     u_int               v_rate_limit;   /* max rate                          */
 187     struct tbf         *v_tbf;          /* token bucket structure at intf.   */
 188     struct in_addr      v_lcl_addr;     /* local interface address           */
 189     struct in_addr      v_rmt_addr;     /* remote address (tunnels only)     */
 190     struct ifnet       *v_ifp;          /* pointer to interface              */
 191     u_long              v_pkt_in;       /* # pkts in on interface            */
 192     u_long              v_pkt_out;      /* # pkts out on interface           */
 193     u_long              v_bytes_in;     /* # bytes in on interface           */
 194     u_long              v_bytes_out;    /* # bytes out on interface          */
 195     struct route        v_route;        /* cached route if this is a tunnel */
 196     u_int               v_rsvp_on;      /* RSVP listening on this vif */
 197     struct socket      *v_rsvpd;        /* RSVP daemon socket */
 198 };
 199
 200 /*
 201  * The kernel's multicast forwarding cache entry structure
 202  * (A field for the type of service (mfc_tos) is to be added
 203  * at a future point)
 204  */
 205 struct mfc {
 206     struct in_addr  mfc_origin;                 /* IP origin of mcasts   */
 207     struct in_addr  mfc_mcastgrp;               /* multicast group associated*/
 208     vifi_t          mfc_parent;                 /* incoming vif              */
 209     u_char          mfc_ttls[MAXVIFS];          /* forwarding ttls on vifs   */
 210     u_long          mfc_pkt_cnt;                /* pkt count for src-grp     */
 211     u_long          mfc_byte_cnt;               /* byte count for src-grp    */
 212     u_long          mfc_wrong_if;               /* wrong if for src-grp      */
 213     int             mfc_expire;                 /* time to clean entry up    */
 214     struct timeval  mfc_last_assert;            /* last time I sent an assert*/
 215     struct rtdetq  *mfc_stall;                  /* q of packets awaiting mfc */
 216     struct mfc     *mfc_next;                   /* next mfc entry            */
 217 };
 218
 219 /*
 220  * Struct used to communicate from kernel to multicast router
 221  * note the convenient similarity to an IP packet
 222  */
 223 struct igmpmsg {
 224     u_long          unused1;
 225     u_long          unused2;
 226     u_char          im_msgtype;                 /* what type of message     */
 227 #define IGMPMSG_NOCACHE         1
 228 #define IGMPMSG_WRONGVIF        2
 229     u_char          im_mbz;                     /* must be zero             */
 230     u_char          im_vif;                     /* vif rec'd on             */
 231     u_char          unused3;
 232     struct in_addr  im_src, im_dst;
 233 };
 234
 235 /*
 236  * Argument structure used for pkt info. while upcall is made
 237  */
 238 struct rtdetq {
 239     struct mbuf         *m;             /* A copy of the packet             */
 240     struct ifnet        *ifp;           /* Interface pkt came in on         */
 241     vifi_t              xmt_vif;        /* Saved copy of imo_multicast_vif  */
 242 #if UPCALL_TIMING
 243     struct timeval      t;              /* Timestamp */
 244 #endif /* UPCALL_TIMING */
 245     struct rtdetq       *next;          /* Next in list of packets          */
 246 };
 247
 248 #define MFCTBLSIZ       256
 249 #if (MFCTBLSIZ & (MFCTBLSIZ - 1)) == 0    /* from sys:route.h */
 250 #define MFCHASHMOD(h)   ((h) & (MFCTBLSIZ - 1))
 251 #else
 252 #define MFCHASHMOD(h)   ((h) % MFCTBLSIZ)
 253 #endif
 254
 255 #define MAX_UPQ 4               /* max. no of pkts in upcall Q */
 256
 257 /*
 258  * Token Bucket filter code
 259  */
 260 #define MAX_BKT_SIZE    10000             /* 10K bytes size             */
 261 #define MAXQSIZE        10                /* max # of pkts in queue     */
 262
 263 /*
 264  * the token bucket filter at each vif
 265  */
 266 struct tbf
 267 {
 268     struct timeval tbf_last_pkt_t; /* arr. time of last pkt     */
 269     u_long tbf_n_tok;           /* no of tokens in bucket       */
 270     u_long tbf_q_len;           /* length of queue at this vif  */
 271     u_long tbf_max_q_len;       /* max. queue length            */
 272     struct mbuf *tbf_q;         /* Packet queue                 */
 273     struct mbuf *tbf_t;         /* tail-insertion pointer       */
 274 };
 275
 276 #ifdef KERNEL
 277 #ifdef __APPLE_API_PRIVATE
 278
 279 struct sockopt;
 280
 281 extern int      (*ip_mrouter_set) __P((struct socket *, struct sockopt *));
 282 extern int      (*ip_mrouter_get) __P((struct socket *, struct sockopt *));
 283 extern int      (*ip_mrouter_done) __P((void));
 284 #if MROUTING
 285 extern int      (*mrt_ioctl) __P((int, caddr_t));
 286 #else
 287 extern int      (*mrt_ioctl) __P((int, caddr_t, struct proc *));
 288 #endif
 289
 290 #endif /* __APPLE_API_PRIVATE */
 291 #endif /* KERNEL */
 292
 293 #endif /* _NETINET_IP_MROUTE_H_ */