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