bsd/netinet/ip_mroute.h

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