git.mutantstargoat.com Git - oftp/blob - watt32/netinet6/ip6_mrou.h

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