[apple/xnu.git] / bsd / netinet / ip_var.h

/*
 * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_LICENSE_HEADER_START@
 * 
 * The contents of this file constitute Original Code as defined in and
 * are subject to the Apple Public Source License Version 1.1 (the
 * "License").  You may not use this file except in compliance with the
 * License.  Please obtain a copy of the License at
 * http://www.apple.com/publicsource and read it before using this file.
 * 
 * This 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 OR NON-INFRINGEMENT.  Please see the
 * License for the specific language governing rights and limitations
 * under the License.
 * 
 * @APPLE_LICENSE_HEADER_END@
 */
/*
 * 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.
 *
 *	@(#)ip_var.h	8.2 (Berkeley) 1/9/95
 */

#ifndef _NETINET_IP_VAR_H_
#define	_NETINET_IP_VAR_H_

/*
 * Overlay for ip header used by other protocols (tcp, udp).
 */
struct ipovly {
	u_char	ih_x1[9];		/* (unused) */
	u_char	ih_pr;			/* protocol */
	u_short	ih_len;			/* protocol length */
	struct	in_addr ih_src;		/* source internet address */
	struct	in_addr ih_dst;		/* destination internet address */
};

/*
 * Ip reassembly queue structure.  Each fragment
 * being reassembled is attached to one of these structures.
 * They are timed out after ipq_ttl drops to 0, and may also
 * be reclaimed if memory becomes tight.
 */
struct ipq {
	struct	ipq *next,*prev;	/* to other reass headers */
	u_char	ipq_ttl;		/* time for reass q to live */
	u_char	ipq_p;			/* protocol of this fragment */
	u_short	ipq_id;			/* sequence id for reassembly */
	struct mbuf *ipq_frags;		/* to ip headers of fragments */
	struct	in_addr ipq_src,ipq_dst;
	u_long	reserved[4];		/* for future use */
#if IPDIVERT
	u_short ipq_divert;		/* divert protocol port */
	u_short ipq_div_cookie;		/* divert protocol cookie */
#endif
};

/*
 * Structure stored in mbuf in inpcb.ip_options
 * and passed to ip_output when ip options are in use.
 * The actual length of the options (including ipopt_dst)
 * is in m_len.
 */
#define MAX_IPOPTLEN	40

struct ipoption {
	struct	in_addr ipopt_dst;	/* first-hop dst if source routed */
	char	ipopt_list[MAX_IPOPTLEN];	/* options proper */
};

/*
 * Structure attached to inpcb.ip_moptions and
 * passed to ip_output when IP multicast options are in use.
 */
struct ip_moptions {
	struct	ifnet *imo_multicast_ifp; /* ifp for outgoing multicasts */
	u_char	imo_multicast_ttl;	/* TTL for outgoing multicasts */
	u_char	imo_multicast_loop;	/* 1 => hear sends if a member */
	u_short	imo_num_memberships;	/* no. memberships this socket */
	struct	in_multi *imo_membership[IP_MAX_MEMBERSHIPS];
	u_long	imo_multicast_vif;	/* vif num outgoing multicasts */
};

struct	ipstat {
	u_long	ips_total;		/* total packets received */
	u_long	ips_badsum;		/* checksum bad */
	u_long	ips_tooshort;		/* packet too short */
	u_long	ips_toosmall;		/* not enough data */
	u_long	ips_badhlen;		/* ip header length < data size */
	u_long	ips_badlen;		/* ip length < ip header length */
	u_long	ips_fragments;		/* fragments received */
	u_long	ips_fragdropped;	/* frags dropped (dups, out of space) */
	u_long	ips_fragtimeout;	/* fragments timed out */
	u_long	ips_forward;		/* packets forwarded */
	u_long	ips_fastforward;	/* packets fast forwarded */
	u_long	ips_cantforward;	/* packets rcvd for unreachable dest */
	u_long	ips_redirectsent;	/* packets forwarded on same net */
	u_long	ips_noproto;		/* unknown or unsupported protocol */
	u_long	ips_delivered;		/* datagrams delivered to upper level*/
	u_long	ips_localout;		/* total ip packets generated here */
	u_long	ips_odropped;		/* lost packets due to nobufs, etc. */
	u_long	ips_reassembled;	/* total packets reassembled ok */
	u_long	ips_fragmented;		/* datagrams successfully fragmented */
	u_long	ips_ofragments;		/* output fragments created */
	u_long	ips_cantfrag;		/* don't fragment flag was set, etc. */
	u_long	ips_badoptions;		/* error in option processing */
	u_long	ips_noroute;		/* packets discarded due to no route */
	u_long	ips_badvers;		/* ip version != 4 */
	u_long	ips_rawout;		/* total raw ip packets generated */
	u_long	ips_toolong;		/* ip length > max ip packet size */
	u_long	ips_notmember;		/* multicasts for unregistered grps */
	u_long	ips_nogif;		/* no match gif found */
};

#if KERNEL

/* flags passed to ip_output as last parameter */
#define	IP_FORWARDING		0x1		/* most of ip header exists */
#define	IP_RAWOUTPUT		0x2		/* raw ip header exists */
#define	IP_ROUTETOIF		SO_DONTROUTE	/* bypass routing tables */
#define	IP_ALLOWBROADCAST	SO_BROADCAST	/* can send broadcast packets */

struct ip;
struct inpcb;
struct route;
struct sockopt;

extern struct	ipstat	ipstat;
extern u_short	ip_id;				/* ip packet ctr, for ids */
extern int	ip_defttl;			/* default IP ttl */
extern int	ipforwarding;			/* ip forwarding */
extern struct protosw *ip_protox[];
extern struct socket *ip_rsvpd;	/* reservation protocol daemon */
extern struct socket *ip_mrouter; /* multicast routing daemon */
extern int	(*legal_vif_num) __P((int));
extern u_long	(*ip_mcast_src) __P((int));
extern int rsvp_on;
extern struct	pr_usrreqs rip_usrreqs;

int	 ip_ctloutput __P((struct socket *, struct sockopt *sopt));
void	 ip_drain __P((void));
void	 ip_freemoptions __P((struct ip_moptions *));
void	 ip_init __P((void));
extern int	 (*ip_mforward) __P((struct ip *, struct ifnet *, struct mbuf *,
			  struct ip_moptions *));
int	 ip_output __P((struct mbuf *,
	    struct mbuf *, struct route *, int, struct ip_moptions *));
void	 ip_savecontrol __P((struct inpcb *, struct mbuf **, struct ip *,
		struct mbuf *));
void	 ip_slowtimo __P((void));
struct mbuf *
	 ip_srcroute __P((void));
void	 ip_stripoptions __P((struct mbuf *, struct mbuf *));
int	 rip_ctloutput __P((struct socket *, struct sockopt *));
void	 rip_ctlinput __P((int, struct sockaddr *, void *));
void	 rip_init __P((void));
void	 rip_input __P((struct mbuf *, int));
int	 rip_output __P((struct mbuf *, struct socket *, u_long));
void	ipip_input __P((struct mbuf *, int));
void	rsvp_input __P((struct mbuf *, int));
int	ip_rsvp_init __P((struct socket *));
int	ip_rsvp_done __P((void));
int	ip_rsvp_vif_init __P((struct socket *, struct sockopt *));
int	ip_rsvp_vif_done __P((struct socket *, struct sockopt *));
void	ip_rsvp_force_done __P((struct socket *));

#if IPDIVERT
void	div_init __P((void));
void	div_input __P((struct mbuf *, int));
extern struct pr_usrreqs div_usrreqs;
extern u_short ip_divert_port;
extern u_short ip_divert_cookie;
#endif

extern struct sockaddr_in *ip_fw_fwd_addr;

#endif /* KERNEL */

#endif /* !_NETINET_IP_VAR_H_ */
Commit	Line	Data
1c79356b A	1	/*
	2	* Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
	3	*
	4	* @APPLE_LICENSE_HEADER_START@
	5	*
	6	* The contents of this file constitute Original Code as defined in and
	7	* are subject to the Apple Public Source License Version 1.1 (the
	8	* "License"). You may not use this file except in compliance with the
	9	* License. Please obtain a copy of the License at
	10	* http://www.apple.com/publicsource and read it before using this file.
	11	*
	12	* This Original Code and all software distributed under the License are
	13	* distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
	14	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
	15	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
	16	* FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT. Please see the
	17	* License for the specific language governing rights and limitations
	18	* under the License.
	19	*
	20	* @APPLE_LICENSE_HEADER_END@
	21	*/
	22	/*
	23	* Copyright (c) 1982, 1986, 1993
	24	* The Regents of the University of California. All rights reserved.
	25	*
	26	* Redistribution and use in source and binary forms, with or without
	27	* modification, are permitted provided that the following conditions
	28	* are met:
	29	* 1. Redistributions of source code must retain the above copyright
	30	* notice, this list of conditions and the following disclaimer.
	31	* 2. Redistributions in binary form must reproduce the above copyright
	32	* notice, this list of conditions and the following disclaimer in the
	33	* documentation and/or other materials provided with the distribution.
	34	* 3. All advertising materials mentioning features or use of this software
	35	* must display the following acknowledgement:
	36	* This product includes software developed by the University of
	37	* California, Berkeley and its contributors.
	38	* 4. Neither the name of the University nor the names of its contributors
	39	* may be used to endorse or promote products derived from this software
	40	* without specific prior written permission.
	41	*
	42	* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	43	* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	44	* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	45	* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	46	* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	47	* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	48	* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	49	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	50	* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	51	* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	52	* SUCH DAMAGE.
	53	*
	54	* @(#)ip_var.h 8.2 (Berkeley) 1/9/95
	55	*/
	56
	57	#ifndef _NETINET_IP_VAR_H_
	58	#define _NETINET_IP_VAR_H_
	59
	60	/*
	61	* Overlay for ip header used by other protocols (tcp, udp).
	62	*/
	63	struct ipovly {
	64	u_char ih_x1[9]; /* (unused) */
65	u_char ih_pr; /* protocol */
66	u_short ih_len; /* protocol length */
67	struct in_addr ih_src; /* source internet address */
68	struct in_addr ih_dst; /* destination internet address */
69	};
70
71	/*
72	* Ip reassembly queue structure. Each fragment
73	* being reassembled is attached to one of these structures.
74	* They are timed out after ipq_ttl drops to 0, and may also
75	* be reclaimed if memory becomes tight.
76	*/
77	struct ipq {
78	struct ipq next,prev; /* to other reass headers */
79	u_char ipq_ttl; /* time for reass q to live */
80	u_char ipq_p; /* protocol of this fragment */
81	u_short ipq_id; /* sequence id for reassembly */
82	struct mbuf ipq_frags; / to ip headers of fragments */
83	struct in_addr ipq_src,ipq_dst;
0b4e3aa0	84	u_long reserved[4]; /* for future use */
1c79356b A	85	#if IPDIVERT
	86	u_short ipq_divert; /* divert protocol port */
	87	u_short ipq_div_cookie; /* divert protocol cookie */
	88	#endif
	89	};
	90
	91	/*
	92	* Structure stored in mbuf in inpcb.ip_options
	93	* and passed to ip_output when ip options are in use.
	94	* The actual length of the options (including ipopt_dst)
	95	* is in m_len.
	96	*/
	97	#define MAX_IPOPTLEN 40
	98
	99	struct ipoption {
	100	struct in_addr ipopt_dst; /* first-hop dst if source routed */
	101	char ipopt_list[MAX_IPOPTLEN]; /* options proper */
	102	};
	103
	104	/*
	105	* Structure attached to inpcb.ip_moptions and
	106	* passed to ip_output when IP multicast options are in use.
	107	*/
	108	struct ip_moptions {
	109	struct ifnet imo_multicast_ifp; / ifp for outgoing multicasts */
	110	u_char imo_multicast_ttl; /* TTL for outgoing multicasts */
	111	u_char imo_multicast_loop; /* 1 => hear sends if a member */
	112	u_short imo_num_memberships; /* no. memberships this socket */
	113	struct in_multi *imo_membership[IP_MAX_MEMBERSHIPS];
	114	u_long imo_multicast_vif; /* vif num outgoing multicasts */
	115	};
	116
	117	struct ipstat {
	118	u_long ips_total; /* total packets received */
	119	u_long ips_badsum; /* checksum bad */
	120	u_long ips_tooshort; /* packet too short */
	121	u_long ips_toosmall; /* not enough data */
	122	u_long ips_badhlen; /* ip header length < data size */
	123	u_long ips_badlen; /* ip length < ip header length */
	124	u_long ips_fragments; /* fragments received */
	125	u_long ips_fragdropped; /* frags dropped (dups, out of space) */
	126	u_long ips_fragtimeout; /* fragments timed out */
	127	u_long ips_forward; /* packets forwarded */
	128	u_long ips_fastforward; /* packets fast forwarded */
	129	u_long ips_cantforward; /* packets rcvd for unreachable dest */
	130	u_long ips_redirectsent; /* packets forwarded on same net */
	131	u_long ips_noproto; /* unknown or unsupported protocol */
	132	u_long ips_delivered; /* datagrams delivered to upper level*/
	133	u_long ips_localout; /* total ip packets generated here */
	134	u_long ips_odropped; /* lost packets due to nobufs, etc. */
	135	u_long ips_reassembled; /* total packets reassembled ok */
	136	u_long ips_fragmented; /* datagrams successfully fragmented */
	137	u_long ips_ofragments; /* output fragments created */
	138	u_long ips_cantfrag; /* don't fragment flag was set, etc. */
	139	u_long ips_badoptions; /* error in option processing */
	140	u_long ips_noroute; /* packets discarded due to no route */
	141	u_long ips_badvers; /* ip version != 4 */
	142	u_long ips_rawout; /* total raw ip packets generated */
	143	u_long ips_toolong; /* ip length > max ip packet size */
	144	u_long ips_notmember; /* multicasts for unregistered grps */
	145	u_long ips_nogif; /* no match gif found */
	146	};
	147
	148	#if KERNEL
149
150	/* flags passed to ip_output as last parameter */
151	#define IP_FORWARDING 0x1 /* most of ip header exists */
152	#define IP_RAWOUTPUT 0x2 /* raw ip header exists */
153	#define IP_ROUTETOIF SO_DONTROUTE /* bypass routing tables */
154	#define IP_ALLOWBROADCAST SO_BROADCAST /* can send broadcast packets */
155
156	struct ip;
157	struct inpcb;
158	struct route;
159	struct sockopt;
160
161	extern struct ipstat ipstat;
162	extern u_short ip_id; /* ip packet ctr, for ids */
163	extern int ip_defttl; /* default IP ttl */
164	extern int ipforwarding; /* ip forwarding */
165	extern struct protosw *ip_protox[];
166	extern struct socket ip_rsvpd; / reservation protocol daemon */
167	extern struct socket ip_mrouter; / multicast routing daemon */
168	extern int (*legal_vif_num) __P((int));
169	extern u_long (*ip_mcast_src) __P((int));
170	extern int rsvp_on;
171	extern struct pr_usrreqs rip_usrreqs;
172
173	int ip_ctloutput __P((struct socket , struct sockopt sopt));
174	void ip_drain __P((void));
175	void ip_freemoptions __P((struct ip_moptions *));
176	void ip_init __P((void));
177	extern int (ip_mforward) __P((struct ip , struct ifnet , struct mbuf ,
178	struct ip_moptions *));
179	int ip_output __P((struct mbuf *,
180	struct mbuf , struct route , int, struct ip_moptions *));
181	void ip_savecontrol __P((struct inpcb , struct mbuf , struct ip ,
182	struct mbuf *));
183	void ip_slowtimo __P((void));
184	struct mbuf *
185	ip_srcroute __P((void));
186	void ip_stripoptions __P((struct mbuf , struct mbuf ));
187	int rip_ctloutput __P((struct socket , struct sockopt ));
188	void rip_ctlinput __P((int, struct sockaddr , void ));
189	void rip_init __P((void));
190	void rip_input __P((struct mbuf *, int));
191	int rip_output __P((struct mbuf , struct socket , u_long));
192	void ipip_input __P((struct mbuf *, int));
193	void rsvp_input __P((struct mbuf *, int));
194	int ip_rsvp_init __P((struct socket *));
195	int ip_rsvp_done __P((void));
196	int ip_rsvp_vif_init __P((struct socket , struct sockopt ));
197	int ip_rsvp_vif_done __P((struct socket , struct sockopt ));
198	void ip_rsvp_force_done __P((struct socket *));
199
200	#if IPDIVERT
201	void div_init __P((void));
202	void div_input __P((struct mbuf *, int));
203	extern struct pr_usrreqs div_usrreqs;
204	extern u_short ip_divert_port;
205	extern u_short ip_divert_cookie;
206	#endif
207
208	extern struct sockaddr_in *ip_fw_fwd_addr;
209
210	#endif /* KERNEL */
211
212	#endif /* !_NETINET_IP_VAR_H_ */