bsd/netinet6/ip6protosw.h

   1 /*      $FreeBSD: src/sys/netinet6/ip6protosw.h,v 1.2.2.3 2001/07/03 11:01:54 ume Exp $ */
   2 /*      $KAME: ip6protosw.h,v 1.22 2001/02/08 18:02:08 itojun Exp $     */
   3
   4 /*
   5  * Copyright (C) 1995, 1996, 1997, and 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
  34 /*      BSDI protosw.h,v 2.3 1996/10/11 16:02:40 pjd Exp        */
  35
  36 /*-
  37  * Copyright (c) 1982, 1986, 1993
  38  *      The Regents of the University of California.  All rights reserved.
  39  *
  40  * Redistribution and use in source and binary forms, with or without
  41  * modification, are permitted provided that the following conditions
  42  * are met:
  43  * 1. Redistributions of source code must retain the above copyright
  44  *    notice, this list of conditions and the following disclaimer.
  45  * 2. Redistributions in binary form must reproduce the above copyright
  46  *    notice, this list of conditions and the following disclaimer in the
  47  *    documentation and/or other materials provided with the distribution.
  48  * 3. All advertising materials mentioning features or use of this software
  49  *    must display the following acknowledgement:
  50  *      This product includes software developed by the University of
  51  *      California, Berkeley and its contributors.
  52  * 4. Neither the name of the University nor the names of its contributors
  53  *    may be used to endorse or promote products derived from this software
  54  *    without specific prior written permission.
  55  *
  56  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  57  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  58  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  59  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  60  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  61  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  62  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  63  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  64  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  65  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  66  * SUCH DAMAGE.
  67  *
  68  *      @(#)protosw.h   8.1 (Berkeley) 6/2/93
  69  */
  70
  71 #ifndef _NETINET6_IP6PROTOSW_H_
  72 #define _NETINET6_IP6PROTOSW_H_
  73 #include <sys/appleapiopts.h>
  74
  75 #ifdef KERNEL_PRIVATE
  76 #include <kern/locks.h>
  77
  78 /*
  79  * Protocol switch table for IPv6.
  80  * All other definitions should refer to sys/protosw.h
  81  */
  82
  83 struct mbuf;
  84 struct sockaddr;
  85 struct socket;
  86 struct domain;
  87 struct proc;
  88 struct ip6_hdr;
  89 struct icmp6_hdr;
  90 struct in6_addr;
  91 struct pr_usrreqs;
  92
  93 /*
  94  * argument type for the last arg of pr_ctlinput().
  95  * should be consulted only with AF_INET6 family.
  96  *
  97  * IPv6 ICMP IPv6 [exthdrs] finalhdr paylaod
  98  * ^    ^    ^              ^
  99  * |    |    ip6c_ip6       ip6c_off
 100  * |    ip6c_icmp6
 101  * ip6c_m
 102  *
 103  * ip6c_finaldst usually points to ip6c_ip6->ip6_dst.  if the original
 104  * (internal) packet carries a routing header, it may point the final
 105  * dstination address in the routing header.
 106  *
 107  * ip6c_src: ip6c_ip6->ip6_src + scope info + flowlabel in ip6c_ip6
 108  *      (beware of flowlabel, if you try to compare it against others)
 109  * ip6c_dst: ip6c_finaldst + scope info
 110  */
 111 struct ip6ctlparam {
 112         struct mbuf *ip6c_m;            /* start of mbuf chain */
 113         struct icmp6_hdr *ip6c_icmp6;   /* icmp6 header of target packet */
 114         struct ip6_hdr *ip6c_ip6;       /* ip6 header of target packet */
 115         int ip6c_off;                   /* offset of the target proto header */
 116         struct sockaddr_in6 *ip6c_src;  /* srcaddr w/ additional info */
 117         struct sockaddr_in6 *ip6c_dst;  /* (final) dstaddr w/ additional info */
 118         struct in6_addr *ip6c_finaldst; /* final destination address */
 119         void *ip6c_cmdarg;              /* control command dependent data */
 120         u_int8_t ip6c_nxt;              /* final next header field */
 121 };
 122
 123 struct ip6protosw {
 124         short   pr_type;                /* socket type used for */
 125         struct  domain *pr_domain;      /* domain protocol a member of */
 126         short   pr_protocol;            /* protocol number */
 127         unsigned int pr_flags;          /* see below */
 128 /* protocol-protocol hooks */
 129         int     (*pr_input)(struct mbuf **, int *);
 130                                         /* input to protocol (from below) */
 131         int     (*pr_output)(struct mbuf *m, struct socket *so,
 132                                      struct sockaddr_in6 *, struct mbuf *);
 133                                         /* output to protocol (from above) */
 134         void    (*pr_ctlinput)(int, struct sockaddr *, void *);
 135                                         /* control input (from below) */
 136         int     (*pr_ctloutput)(struct socket *, struct sockopt *);
 137                                         /* control output (from above) */
 138 /* user-protocol hook */
 139         int     (*pr_usrreq)(struct socket *, int, struct mbuf *,
 140                              struct mbuf *, struct mbuf *, struct proc *);
 141                                         /* user request: see list below */
 142
 143 /* utility hooks */
 144         void    (*pr_init)(void);       /* initialization hook */
 145         void    (*pr_fasttimo)(void);
 146                                         /* fast timeout (200ms) */
 147         void    (*pr_slowtimo)(void);
 148                                         /* slow timeout (500ms) */
 149         void    (*pr_drain)(void);
 150                                         /* flush any excess space possible */
 151 #ifdef __APPLE__
 152         /* for compat. with IPv4 protosw */
 153         int     (*pr_sysctl)(void);             /* sysctl for protocol */
 154 #endif
 155
 156         struct  pr_usrreqs *pr_usrreqs; /* supersedes pr_usrreq() */
 157 #ifdef __APPLE__
 158         int             (*pr_lock)      (struct socket *so, int locktype, int debug); /* lock function for protocol */
 159         int             (*pr_unlock)    (struct socket *so, int locktype, int debug); /* unlock for protocol */
 160 #ifdef _KERN_LOCKS_H_
 161         lck_mtx_t *     (*pr_getlock)   (struct socket *so, int locktype); /* unlock for protocol */
 162 #else
 163         void *  (*pr_getlock)   (struct socket *so, int locktype); /* unlock for protocol */
 164 #endif
 165         /* Filter hooks */
 166         TAILQ_HEAD(pr6_sfilter, NFDescriptor) pr_sfilter;
 167         struct ip6protosw *pr_next;     /* Chain for domain */
 168         u_long reserved[1];
 169 #endif
 170 };
 171
 172 #endif KERNEL_PRIVATE
 173 #endif _NETINET6_IP6PROTOSW_H_