Initial import from FreeBSD RELENG_4:
[dragonfly.git] / sys / netinet6 / ip6protosw.h
1 /*      $FreeBSD: src/sys/netinet6/ip6protosw.h,v 1.2.2.4 2002/04/28 05:40:27 suz Exp $ */
2 /*      $KAME: ip6protosw.h,v 1.25 2001/09/26 06:13:03 keiichi 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
74 /*
75  * Protocol switch table for IPv6.
76  * All other definitions should refer to sys/protosw.h
77  */
78
79 struct mbuf;
80 struct sockaddr;
81 struct socket;
82 struct domain;
83 struct proc;
84 struct ip6_hdr;
85 struct icmp6_hdr;
86 struct in6_addr;
87 struct pr_usrreqs;
88
89 /*
90  * argument type for the last arg of pr_ctlinput().
91  * should be consulted only with AF_INET6 family.
92  *
93  * IPv6 ICMP IPv6 [exthdrs] finalhdr paylaod
94  * ^    ^    ^              ^
95  * |    |    ip6c_ip6       ip6c_off
96  * |    ip6c_icmp6
97  * ip6c_m
98  *
99  * ip6c_finaldst usually points to ip6c_ip6->ip6_dst.  if the original
100  * (internal) packet carries a routing header, it may point the final
101  * dstination address in the routing header.
102  *
103  * ip6c_src: ip6c_ip6->ip6_src + scope info + flowlabel in ip6c_ip6
104  *      (beware of flowlabel, if you try to compare it against others)
105  * ip6c_dst: ip6c_finaldst + scope info
106  */
107 struct ip6ctlparam {
108         struct mbuf *ip6c_m;            /* start of mbuf chain */
109         struct icmp6_hdr *ip6c_icmp6;   /* icmp6 header of target packet */
110         struct ip6_hdr *ip6c_ip6;       /* ip6 header of target packet */
111         int ip6c_off;                   /* offset of the target proto header */
112         struct sockaddr_in6 *ip6c_src;  /* srcaddr w/ additional info */
113         struct sockaddr_in6 *ip6c_dst;  /* (final) dstaddr w/ additional info */
114         struct in6_addr *ip6c_finaldst; /* final destination address */
115         void *ip6c_cmdarg;              /* control command dependent data */
116         u_int8_t ip6c_nxt;              /* final next header field */
117 };
118
119 struct ip6protosw {
120         short   pr_type;                /* socket type used for */
121         struct  domain *pr_domain;      /* domain protocol a member of */
122         short   pr_protocol;            /* protocol number */
123         short   pr_flags;               /* see below */
124
125 /* protocol-protocol hooks */
126         int     (*pr_input)             /* input to protocol (from below) */
127                         __P((struct mbuf **, int *, int));
128         int     (*pr_output)            /* output to protocol (from above) */
129                         __P((struct mbuf *, ...));
130         void    (*pr_ctlinput)          /* control input (from below) */
131                         __P((int, struct sockaddr *, void *));
132         int     (*pr_ctloutput)         /* control output (from above) */
133                         __P((struct socket *, struct sockopt *));
134
135 /* user-protocol hook */
136         int     (*pr_usrreq)            /* user request: see list below */
137                         __P((struct socket *, int, struct mbuf *,
138                              struct mbuf *, struct mbuf *, struct proc *));
139
140 /* utility hooks */
141         void    (*pr_init)              /* initialization hook */
142                         __P((void));
143
144         void    (*pr_fasttimo)          /* fast timeout (200ms) */
145                         __P((void));
146         void    (*pr_slowtimo)          /* slow timeout (500ms) */
147                         __P((void));
148         void    (*pr_drain)             /* flush any excess space possible */
149                         __P((void));
150         struct  pr_usrreqs *pr_usrreqs; /* supersedes pr_usrreq() */
151 };
152
153 #endif /* !_NETINET6_IP6PROTOSW_H_ */