[apple/xnu.git] / bsd / netinet6 / ip6protosw.h

/*
 * Copyright (c) 2008-2013 Apple Inc. All rights reserved.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
 *
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. The rights granted to you under the License
 * may not be used to create, or enable the creation or redistribution of,
 * unlawful or unlicensed copies of an Apple operating system, or to
 * circumvent, violate, or enable the circumvention or violation of, any
 * terms of an Apple operating system software license agreement.
 *
 * Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this file.
 *
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
 */

/*	$KAME: ip6protosw.h,v 1.22 2001/02/08 18:02:08 itojun Exp $	*/

/*
 * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the name of the project nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 */

/*	BSDI protosw.h,v 2.3 1996/10/11 16:02:40 pjd Exp	*/

/*-
 * Copyright (c) 1982, 1986, 1993
 *	The Regents of the University of California.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *	This product includes software developed by the University of
 *	California, Berkeley and its contributors.
 * 4. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 *	@(#)protosw.h	8.1 (Berkeley) 6/2/93
 */

#ifndef _NETINET6_IP6PROTOSW_H_
#define	_NETINET6_IP6PROTOSW_H_
#include <sys/appleapiopts.h>

#ifdef BSD_KERNEL_PRIVATE
#include <kern/locks.h>

/*
 * Protocol switch table for IPv6.
 * All other definitions should refer to sys/protosw.h
 */

struct mbuf;
struct sockaddr;
struct socket;
struct domain;
struct ip6_hdr;
struct icmp6_hdr;
struct in6_addr;
struct pr_usrreqs;

/*
 * argument type for the last arg of pr_ctlinput().
 * should be consulted only with AF_INET6 family.
 *
 * IPv6 ICMP IPv6 [exthdrs] finalhdr payload
 * ^    ^    ^              ^
 * |    |    ip6c_ip6       ip6c_off
 * |    ip6c_icmp6
 * ip6c_m
 *
 * ip6c_finaldst usually points to ip6c_ip6->ip6_dst.  if the original
 * (internal) packet carries a routing header, it may point the final
 * dstination address in the routing header.
 *
 * ip6c_src: ip6c_ip6->ip6_src + scope info + flowlabel in ip6c_ip6
 *	(beware of flowlabel, if you try to compare it against others)
 * ip6c_dst: ip6c_finaldst + scope info
 */
struct ip6ctlparam {
	struct mbuf *ip6c_m;		/* start of mbuf chain */
	struct icmp6_hdr *ip6c_icmp6;	/* icmp6 header of target packet */
	struct ip6_hdr *ip6c_ip6;	/* ip6 header of target packet */
	int ip6c_off;			/* offset of the target proto header */
	struct sockaddr_in6 *ip6c_src;	/* srcaddr w/ additional info */
	struct sockaddr_in6 *ip6c_dst;	/* (final) dstaddr w/ additional info */
	struct in6_addr *ip6c_finaldst;	/* final destination address */
	void *ip6c_cmdarg;		/* control command dependent data */
	u_int8_t ip6c_nxt;		/* final next header field */
};

/*
 * TODO:
 *
 * This closesly resembles protosw; we should merge them one day.  Offsets
 * must be exactly equivalent, due to casting.
 */
struct ip6protosw {
	TAILQ_ENTRY(ip6protosw) pr_entry; /* chain for domain */
	struct	domain *pr_domain;	/* domain protocol a member of */
	struct protosw *pr_protosw;	/* pointer to self */
	u_int16_t pr_type;		/* socket type used for */
	u_int16_t pr_protocol;		/* protocol number */
	u_int32_t pr_flags;		/* see below */
	/*
	 * protocol-protocol hooks
	 */
	int	(*pr_input)		/* input to protocol (from below) */
		    (struct mbuf **, int *, int);
	int	(*pr_output)		/* output to protocol (from above) */
		    (struct mbuf *m, struct socket *so,
		    struct sockaddr_in6 *, struct mbuf *);
	void	(*pr_ctlinput)		/* control input (from below) */
		    (int, struct sockaddr *, void *);
	int	(*pr_ctloutput)		/* control output (from above) */
		    (struct socket *, struct sockopt *);
	/*
	 * user-protocol hook
	 */
	struct	pr_usrreqs *pr_usrreqs;	/* user request; see list below */
	/*
	 * utility hooks
	 */
	void	(*pr_init)		/* initialization hook */
		    (struct ip6protosw *, struct domain *);
	void	(*pr_drain)(void);	/* flush any excess space possible */
	/* for compat. with IPv4 protosw */
	int	(*pr_sysctl)(void);	/* sysctl for protocol */
	int	(*pr_lock)		/* lock function for protocol */
		    (struct socket *so, int locktype, void *debug);
	int	(*pr_unlock)		/* unlock for protocol */
		    (struct socket *so, int locktype, void *debug);
	lck_mtx_t *(*pr_getlock)	/* retrieve protocol lock */
		    (struct socket *so, int locktype);
	/*
	 * misc
	 */
	TAILQ_HEAD(, socket_filter) pr_filter_head;
	struct protosw_old *pr_old;
};
#endif /* BSD_KERNEL_PRIVATE */
#endif /* _NETINET6_IP6PROTOSW_H_ */
Commit	Line	Data
b0d623f7	1	/*
39236c6e	2	* Copyright (c) 2008-2013 Apple Inc. All rights reserved.
b0d623f7 A	3	*
b0d623f7 A	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
39236c6e	5	*
b0d623f7 A	6	* This file contains Original Code and/or Modifications of Original Code
	7	* as defined in and that are subject to the Apple Public Source License
	8	* Version 2.0 (the 'License'). You may not use this file except in
	9	* compliance with the License. The rights granted to you under the License
	10	* may not be used to create, or enable the creation or redistribution of,
	11	* unlawful or unlicensed copies of an Apple operating system, or to
	12	* circumvent, violate, or enable the circumvention or violation of, any
	13	* terms of an Apple operating system software license agreement.
39236c6e	14	*
b0d623f7 A	15	* Please obtain a copy of the License at
b0d623f7 A	16	* http://www.opensource.apple.com/apsl/ and read it before using this file.
39236c6e	17	*
b0d623f7 A	18	* The Original Code and all software distributed under the License are
	19	* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
	20	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
	21	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
	22	* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
	23	* Please see the License for the specific language governing rights and
	24	* limitations under the License.
39236c6e	25	*
b0d623f7 A	26	* @APPLE_OSREFERENCE_LICENSE_HEADER_END@
	27	*/
	28
9bccf70c A	29	/* $KAME: ip6protosw.h,v 1.22 2001/02/08 18:02:08 itojun Exp $ */
9bccf70c A	30
1c79356b A	31	/*
	32	* Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
	33	* All rights reserved.
9bccf70c	34	*
1c79356b A	35	* Redistribution and use in source and binary forms, with or without
	36	* modification, are permitted provided that the following conditions
	37	* are met:
	38	* 1. Redistributions of source code must retain the above copyright
	39	* notice, this list of conditions and the following disclaimer.
	40	* 2. Redistributions in binary form must reproduce the above copyright
	41	* notice, this list of conditions and the following disclaimer in the
	42	* documentation and/or other materials provided with the distribution.
	43	* 3. Neither the name of the project nor the names of its contributors
	44	* may be used to endorse or promote products derived from this software
	45	* without specific prior written permission.
9bccf70c	46	*
1c79356b A	47	* THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
	48	* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	49	* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	50	* ARE DISCLAIMED. IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
	51	* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	52	* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	53	* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	54	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	55	* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	56	* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	57	* SUCH DAMAGE.
	58	*
	59	*/
	60
	61	/* BSDI protosw.h,v 2.3 1996/10/11 16:02:40 pjd Exp */
	62
	63	/*-
	64	* Copyright (c) 1982, 1986, 1993
	65	* The Regents of the University of California. All rights reserved.
	66	*
	67	* Redistribution and use in source and binary forms, with or without
	68	* modification, are permitted provided that the following conditions
	69	* are met:
	70	* 1. Redistributions of source code must retain the above copyright
	71	* notice, this list of conditions and the following disclaimer.
	72	* 2. Redistributions in binary form must reproduce the above copyright
	73	* notice, this list of conditions and the following disclaimer in the
	74	* documentation and/or other materials provided with the distribution.
	75	* 3. All advertising materials mentioning features or use of this software
	76	* must display the following acknowledgement:
	77	* This product includes software developed by the University of
	78	* California, Berkeley and its contributors.
	79	* 4. Neither the name of the University nor the names of its contributors
	80	* may be used to endorse or promote products derived from this software
	81	* without specific prior written permission.
	82	*
	83	* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	84	* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	85	* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	86	* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	87	* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	88	* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	89	* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	90	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	91	* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	92	* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	93	* SUCH DAMAGE.
	94	*
	95	* @(#)protosw.h 8.1 (Berkeley) 6/2/93
1c79356b A	96	*/
	97
	98	#ifndef _NETINET6_IP6PROTOSW_H_
39236c6e	99	#define _NETINET6_IP6PROTOSW_H_
9bccf70c	100	#include <sys/appleapiopts.h>
91447636	101
39236c6e	102	#ifdef BSD_KERNEL_PRIVATE
91447636	103	#include <kern/locks.h>
1c79356b A	104
	105	/*
	106	* Protocol switch table for IPv6.
	107	* All other definitions should refer to sys/protosw.h
	108	*/
	109
	110	struct mbuf;
	111	struct sockaddr;
	112	struct socket;
	113	struct domain;
1c79356b	114	struct ip6_hdr;
9bccf70c A	115	struct icmp6_hdr;
9bccf70c A	116	struct in6_addr;
1c79356b	117	struct pr_usrreqs;
1c79356b	118
1c79356b A	119	/*
	120	* argument type for the last arg of pr_ctlinput().
	121	* should be consulted only with AF_INET6 family.
9bccf70c	122	*
6d2010ae	123	* IPv6 ICMP IPv6 [exthdrs] finalhdr payload
9bccf70c A	124	* ^ ^ ^ ^
	125	* \| \| ip6c_ip6 ip6c_off
	126	* \| ip6c_icmp6
	127	* ip6c_m
	128	*
	129	* ip6c_finaldst usually points to ip6c_ip6->ip6_dst. if the original
	130	* (internal) packet carries a routing header, it may point the final
	131	* dstination address in the routing header.
	132	*
	133	* ip6c_src: ip6c_ip6->ip6_src + scope info + flowlabel in ip6c_ip6
	134	* (beware of flowlabel, if you try to compare it against others)
	135	* ip6c_dst: ip6c_finaldst + scope info
1c79356b A	136	*/
	137	struct ip6ctlparam {
	138	struct mbuf ip6c_m; / start of mbuf chain */
9bccf70c	139	struct icmp6_hdr ip6c_icmp6; / icmp6 header of target packet */
1c79356b A	140	struct ip6_hdr ip6c_ip6; / ip6 header of target packet */
1c79356b A	141	int ip6c_off; /* offset of the target proto header */
9bccf70c A	142	struct sockaddr_in6 ip6c_src; / srcaddr w/ additional info */
	143	struct sockaddr_in6 ip6c_dst; / (final) dstaddr w/ additional info */
	144	struct in6_addr ip6c_finaldst; / final destination address */
	145	void ip6c_cmdarg; / control command dependent data */
	146	u_int8_t ip6c_nxt; /* final next header field */
1c79356b A	147	};
1c79356b A	148
39236c6e A	149	/*
	150	* TODO:
	151	*
	152	* This closesly resembles protosw; we should merge them one day. Offsets
	153	* must be exactly equivalent, due to casting.
	154	*/
1c79356b	155	struct ip6protosw {
39236c6e	156	TAILQ_ENTRY(ip6protosw) pr_entry; /* chain for domain */
1c79356b	157	struct domain pr_domain; / domain protocol a member of */
39236c6e A	158	struct protosw pr_protosw; / pointer to self */
	159	u_int16_t pr_type; /* socket type used for */
	160	u_int16_t pr_protocol; /* protocol number */
	161	u_int32_t pr_flags; /* see below */
	162	/*
	163	* protocol-protocol hooks
	164	*/
	165	int (pr_input) / input to protocol (from below) */
	166	(struct mbuf *, int , int);
	167	int (pr_output) / output to protocol (from above) */
	168	(struct mbuf m, struct socket so,
	169	struct sockaddr_in6 , struct mbuf );
	170	void (pr_ctlinput) / control input (from below) */
	171	(int, struct sockaddr , void );
	172	int (pr_ctloutput) / control output (from above) */
	173	(struct socket , struct sockopt );
	174	/*
	175	* user-protocol hook
	176	*/
	177	struct pr_usrreqs pr_usrreqs; / user request; see list below */
	178	/*
	179	* utility hooks
	180	*/
	181	void (pr_init) / initialization hook */
	182	(struct ip6protosw , struct domain );
	183	void (pr_drain)(void); / flush any excess space possible */
9bccf70c	184	/* for compat. with IPv4 protosw */
39236c6e A	185	int (pr_sysctl)(void); / sysctl for protocol */
	186	int (pr_lock) / lock function for protocol */
	187	(struct socket so, int locktype, void debug);
	188	int (pr_unlock) / unlock for protocol */
	189	(struct socket so, int locktype, void debug);
	190	lck_mtx_t (pr_getlock) /* retrieve protocol lock */
	191	(struct socket *so, int locktype);
	192	/*
	193	* misc
	194	*/
	195	TAILQ_HEAD(, socket_filter) pr_filter_head;
	196	struct protosw_old *pr_old;
1c79356b	197	};
39236c6e	198	#endif /* BSD_KERNEL_PRIVATE */
b0d623f7	199	#endif /* _NETINET6_IP6PROTOSW_H_ */