bsd/netinet6/ip6_mroute.h

   1 /*      $FreeBSD: src/sys/netinet6/ip6_mroute.h,v 1.2.2.2 2001/07/03 11:01:53 ume Exp $ */
   2 /*      $KAME: ip6_mroute.h,v 1.17 2001/02/10 02:05:52 itojun Exp $     */
   3
   4 /*
   5  * Copyright (C) 1998 WIDE Project.
   6  * All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  * 3. Neither the name of the project nor the names of its contributors
  17  *    may be used to endorse or promote products derived from this software
  18  *    without specific prior written permission.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
  21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
  24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30  * SUCH DAMAGE.
  31  */
  32
  33 /*      BSDI ip_mroute.h,v 2.5 1996/10/11 16:01:48 pjd Exp      */
  34
  35 /*
  36  * Definitions for IP multicast forwarding.
  37  *
  38  * Written by David Waitzman, BBN Labs, August 1988.
  39  * Modified by Steve Deering, Stanford, February 1989.
  40  * Modified by Ajit Thyagarajan, PARC, August 1993.
  41  * Modified by Ajit Thyagarajan, PARC, August 1994.
  42  * Modified by Ahmed Helmy, USC, September 1996.
  43  *
  44  * MROUTING Revision: 1.2
  45  */
  46
  47 #ifndef _NETINET6_IP6_MROUTE_H_
  48 #define _NETINET6_IP6_MROUTE_H_
  49 #include <sys/appleapiopts.h>
  50
  51 /*
  52  * Multicast Routing set/getsockopt commands.
  53  */
  54 #ifdef KERNEL_PRIVATE
  55 #define MRT6_OINIT              100     /* initialize forwarder (omrt6msg) */
  56 #endif
  57 #define MRT6_DONE               101     /* shut down forwarder */
  58 #define MRT6_ADD_MIF            102     /* add multicast interface */
  59 #define MRT6_DEL_MIF            103     /* delete multicast interface */
  60 #define MRT6_ADD_MFC            104     /* insert forwarding cache entry */
  61 #define MRT6_DEL_MFC            105     /* delete forwarding cache entry */
  62 #define MRT6_PIM                107     /* enable pim code */
  63 #define MRT6_INIT               108     /* initialize forwarder (mrt6msg) */
  64
  65 #ifdef __APPLE__
  66 #define GET_TIME(t)     getmicrotime(&t)
  67 #endif
  68
  69 /*
  70  * Types and macros for handling bitmaps with one bit per multicast interface.
  71  */
  72 typedef u_short mifi_t;         /* type of a mif index */
  73 #define MAXMIFS         64
  74
  75 #ifndef IF_SETSIZE
  76 #define IF_SETSIZE      256
  77 #endif
  78
  79 typedef u_int32_t       if_mask;
  80 #define NIFBITS (sizeof(if_mask) * NBBY)        /* bits per mask */
  81
  82 #ifndef howmany
  83 #define howmany(x, y)   (((x) + ((y) - 1)) / (y))
  84 #endif
  85
  86 typedef struct if_set {
  87         if_mask ifs_bits[howmany(IF_SETSIZE, NIFBITS)];
  88 } if_set;
  89
  90 #define IF_SET(n, p)    ((p)->ifs_bits[(n)/NIFBITS] |= (1 << ((n) % NIFBITS)))
  91 #define IF_CLR(n, p)    ((p)->ifs_bits[(n)/NIFBITS] &= ~(1 << ((n) % NIFBITS)))
  92 #define IF_ISSET(n, p)  ((p)->ifs_bits[(n)/NIFBITS] & (1 << ((n) % NIFBITS)))
  93 #define IF_COPY(f, t)   bcopy(f, t, sizeof(*(f)))
  94 #define IF_ZERO(p)      bzero(p, sizeof(*(p)))
  95
  96 /*
  97  * Argument structure for MRT6_ADD_IF.
  98  */
  99 struct mif6ctl {
 100         mifi_t      mif6c_mifi;         /* the index of the mif to be added  */
 101         u_char      mif6c_flags;        /* MIFF_ flags defined below         */
 102         u_short     mif6c_pifi;         /* the index of the physical IF */
 103 #if notyet
 104         u_int       mif6c_rate_limit;    /* max rate                         */
 105 #endif
 106 };
 107
 108 #define MIFF_REGISTER   0x1     /* mif represents a register end-point */
 109
 110 /*
 111  * Argument structure for MRT6_ADD_MFC and MRT6_DEL_MFC
 112  */
 113 struct mf6cctl {
 114         struct sockaddr_in6 mf6cc_origin;       /* IPv6 origin of mcasts */
 115         struct sockaddr_in6 mf6cc_mcastgrp; /* multicast group associated */
 116         mifi_t          mf6cc_parent;   /* incoming ifindex */
 117         struct if_set   mf6cc_ifset;    /* set of forwarding ifs */
 118 };
 119
 120 /*
 121  * The kernel's multicast routing statistics.
 122  */
 123 struct mrt6stat {
 124         u_quad_t mrt6s_mfc_lookups;     /* # forw. cache hash table hits   */
 125         u_quad_t mrt6s_mfc_misses;      /* # forw. cache hash table misses */
 126         u_quad_t mrt6s_upcalls;         /* # calls to mrouted              */
 127         u_quad_t mrt6s_no_route;        /* no route for packet's origin    */
 128         u_quad_t mrt6s_bad_tunnel;      /* malformed tunnel options        */
 129         u_quad_t mrt6s_cant_tunnel;     /* no room for tunnel options      */
 130         u_quad_t mrt6s_wrong_if;        /* arrived on wrong interface      */
 131         u_quad_t mrt6s_upq_ovflw;       /* upcall Q overflow               */
 132         u_quad_t mrt6s_cache_cleanups;  /* # entries with no upcalls       */
 133         u_quad_t mrt6s_drop_sel;        /* pkts dropped selectively        */
 134         u_quad_t mrt6s_q_overflow;      /* pkts dropped - Q overflow       */
 135         u_quad_t mrt6s_pkt2large;       /* pkts dropped - size > BKT SIZE  */
 136         u_quad_t mrt6s_upq_sockfull;    /* upcalls dropped - socket full   */
 137 };
 138
 139 #ifdef KERNEL_PRIVATE
 140 #if MRT6_OINIT
 141 /*
 142  * Struct used to communicate from kernel to multicast router
 143  * note the convenient similarity to an IPv6 header.
 144  * XXX old version, superseded by mrt6msg.
 145  */
 146 struct omrt6msg {
 147         u_long      unused1;
 148         u_char      im6_msgtype;                /* what type of message     */
 149 #if 0
 150 #define MRT6MSG_NOCACHE 1
 151 #define MRT6MSG_WRONGMIF        2
 152 #define MRT6MSG_WHOLEPKT        3               /* used for user level encap*/
 153 #endif
 154         u_char      im6_mbz;                    /* must be zero             */
 155         u_char      im6_mif;                    /* mif rec'd on             */
 156         u_char      unused2;
 157         struct in6_addr  im6_src, im6_dst;
 158 };
 159 #endif
 160 #endif KERNEL_PRIVATE
 161
 162 /*
 163  * Structure used to communicate from kernel to multicast router.
 164  * We'll overlay the structure onto an MLD header (not an IPv6 header
 165  * like igmpmsg{} used for IPv4 implementation). This is because this
 166  * structure will be passed via an IPv6 raw socket, on which an application
 167  * will only receive the payload i.e. the data after the IPv6 header and all
 168  * the extension headers. (see Section 3 of draft-ietf-ipngwg-2292bis-01)
 169  */
 170 struct mrt6msg {
 171 #define MRT6MSG_NOCACHE         1
 172 #define MRT6MSG_WRONGMIF        2
 173 #define MRT6MSG_WHOLEPKT        3               /* used for user level encap*/
 174         u_char      im6_mbz;                    /* must be zero             */
 175         u_char      im6_msgtype;                /* what type of message     */
 176         u_int16_t   im6_mif;                    /* mif rec'd on             */
 177         u_int32_t   im6_pad;                    /* padding for 64bit arch   */
 178         struct in6_addr  im6_src, im6_dst;
 179 };
 180
 181 /*
 182  * Argument structure used by multicast routing daemon to get src-grp
 183  * packet counts
 184  */
 185 struct sioc_sg_req6 {
 186         struct sockaddr_in6 src;
 187         struct sockaddr_in6 grp;
 188         u_quad_t pktcnt;
 189         u_quad_t bytecnt;
 190         u_quad_t wrong_if;
 191 };
 192
 193 /*
 194  * Argument structure used by mrouted to get mif pkt counts
 195  */
 196 struct sioc_mif_req6 {
 197         mifi_t mifi;            /* mif number                           */
 198         u_quad_t icount;        /* Input packet count on mif            */
 199         u_quad_t ocount;        /* Output packet count on mif           */
 200         u_quad_t ibytes;        /* Input byte count on mif              */
 201         u_quad_t obytes;        /* Output byte count on mif             */
 202 };
 203
 204 #ifdef PRIVATE
 205 /*
 206  * The kernel's multicast-interface structure.
 207  */
 208 struct mif6 {
 209         u_char          m6_flags;       /* MIFF_ flags defined above         */
 210         u_int           m6_rate_limit;  /* max rate                          */
 211 #if notyet
 212         struct tbf      *m6_tbf;        /* token bucket structure at intf.   */
 213 #endif
 214         struct in6_addr m6_lcl_addr;    /* local interface address           */
 215         struct ifnet    *m6_ifp;        /* pointer to interface              */
 216         u_quad_t        m6_pkt_in;      /* # pkts in on interface            */
 217         u_quad_t        m6_pkt_out;     /* # pkts out on interface           */
 218         u_quad_t        m6_bytes_in;    /* # bytes in on interface           */
 219         u_quad_t        m6_bytes_out;   /* # bytes out on interface          */
 220         struct route_in6 m6_route;/* cached route if this is a tunnel */
 221 #if notyet
 222         u_int           m6_rsvp_on;     /* RSVP listening on this vif */
 223         struct socket   *m6_rsvpd;      /* RSVP daemon socket */
 224 #endif
 225 };
 226
 227 /*
 228  * The kernel's multicast forwarding cache entry structure
 229  */
 230 struct mf6c {
 231         struct sockaddr_in6  mf6c_origin;       /* IPv6 origin of mcasts     */
 232         struct sockaddr_in6  mf6c_mcastgrp;     /* multicast group associated*/
 233         mifi_t           mf6c_parent;           /* incoming IF               */
 234         struct if_set    mf6c_ifset;            /* set of outgoing IFs */
 235
 236         u_quad_t        mf6c_pkt_cnt;           /* pkt count for src-grp     */
 237         u_quad_t        mf6c_byte_cnt;          /* byte count for src-grp    */
 238         u_quad_t        mf6c_wrong_if;          /* wrong if for src-grp      */
 239         int             mf6c_expire;            /* time to clean entry up    */
 240         struct timeval  mf6c_last_assert;       /* last time I sent an assert*/
 241         struct rtdetq  *mf6c_stall;             /* pkts waiting for route */
 242         struct mf6c    *mf6c_next;              /* hash table linkage */
 243 };
 244
 245 #define MF6C_INCOMPLETE_PARENT ((mifi_t)-1)
 246
 247 #define MF6CTBLSIZ      256
 248 #if (MF6CTBLSIZ & (MF6CTBLSIZ - 1)) == 0          /* from sys:route.h */
 249 #define MF6CHASHMOD(h)  ((h) & (MF6CTBLSIZ - 1))
 250 #else
 251 #define MF6CHASHMOD(h)  ((h) % MF6CTBLSIZ)
 252 #endif
 253
 254 #define MAX_UPQ6        4               /* max. no of pkts in upcall Q */
 255
 256 /*
 257  * Argument structure used for pkt info. while upcall is made
 258  */
 259 #ifndef _NETINET_IP_MROUTE_H_
 260 struct rtdetq {         /* XXX: rtdetq is also defined in ip_mroute.h */
 261     struct mbuf         *m;             /* A copy of the packet             */
 262     struct ifnet        *ifp;           /* Interface pkt came in on         */
 263 #if UPCALL_TIMING
 264     struct timeval      t;              /* Timestamp */
 265 #endif /* UPCALL_TIMING */
 266     struct rtdetq       *next;
 267 };
 268 #endif /* _NETINET_IP_MROUTE_H_ */
 269
 270 #ifdef KERNEL
 271 extern struct mrt6stat mrt6stat;
 272
 273 int     ip6_mrouter_set(struct socket *so, struct sockopt *sopt);
 274 int     ip6_mrouter_get(struct socket *so, struct sockopt *sopt);
 275 int     ip6_mrouter_done(void);
 276 int     mrt6_ioctl(int, caddr_t);
 277 #endif /* KERNEL */
 278 #endif /* PRIVATE */
 279
 280 #endif /* !_NETINET6_IP6_MROUTE_H_ */