[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_
#include <sys/appleapiopts.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 */
};

#ifdef KERNEL_PRIVATE
/*
 * 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	ipq_nfrags;
	TAILQ_ENTRY(ipq) ipq_list;
	u_long	reserved[1];		/* for future use */
#if IPDIVERT
#ifdef IPDIVERT_44
	u_int32_t ipq_div_info;		/* ipfw divert port & flags */
#else
	u_int16_t ipq_divert;		/* ipfw divert port (Maintain backward compat.) */
#endif
	u_int16_t ipq_div_cookie;	/* ipfw divert 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.
 */
#endif /* KERNEL_PRIVATE */
#define MAX_IPOPTLEN	40
#ifdef KERNEL_PRIVATE

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	in_addr imo_multicast_addr; /* ifindex/addr on MULTICAST_IF */
};

/* mbuf tag for ip_forwarding info */
struct ip_fwd_tag {
	struct sockaddr_in *next_hop;	/* next_hop */
};

#endif /* KERNEL_PRIVATE */

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 */
	u_long	ips_badaddr;		/* invalid address on header */
};

struct ip_linklocal_stat {
	u_long iplls_in_total;
	u_long iplls_in_badttl;
	u_long iplls_out_total;
	u_long iplls_out_badttl;
};

#ifdef KERNEL_PRIVATE
/* 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_NOIPSEC			0x4		/* No IPSec processing */
#define	IP_ROUTETOIF		SO_DONTROUTE	/* bypass routing tables (0x0010) */
#define	IP_ALLOWBROADCAST	SO_BROADCAST	/* can send broadcast packets (0x0020) */

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

extern struct	ipstat	ipstat;
#if !defined(RANDOM_IP_ID) || RANDOM_IP_ID == 0
extern u_short	ip_id;				/* ip packet ctr, for ids */
#endif
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)(int);
extern u_long	(*ip_mcast_src)(int);
extern int rsvp_on;
extern struct	pr_usrreqs rip_usrreqs;

int	 ip_ctloutput(struct socket *, struct sockopt *sopt);
void	 ip_drain(void);
void	 ip_freemoptions(struct ip_moptions *);
void	 ip_init(void);
extern int	 (*ip_mforward)(struct ip *, struct ifnet *, struct mbuf *,
			  struct ip_moptions *);
int	 ip_output(struct mbuf *,
	    struct mbuf *, struct route *, int, struct ip_moptions *);
int	 ip_output_list(struct mbuf *, int,
	    struct mbuf *, struct route *, int, struct ip_moptions *);
struct in_ifaddr *
	 ip_rtaddr(struct in_addr, struct route *);
void	 ip_savecontrol(struct inpcb *, struct mbuf **, struct ip *,
		struct mbuf *);
void	 ip_slowtimo(void);
struct mbuf *
	 ip_srcroute(void);
void	 ip_stripoptions(struct mbuf *, struct mbuf *);
#if RANDOM_IP_ID
u_int16_t	
	 ip_randomid(void);
#endif
int	rip_ctloutput(struct socket *, struct sockopt *);
void	rip_ctlinput(int, struct sockaddr *, void *);
void	rip_init(void);
void	rip_input(struct mbuf *, int);
int	rip_output(struct mbuf *, struct socket *, u_long);
int	rip_unlock(struct socket *, int, int);
void	ipip_input(struct mbuf *, int);
void	rsvp_input(struct mbuf *, int);
int	ip_rsvp_init(struct socket *);
int	ip_rsvp_done(void);
int	ip_rsvp_vif_init(struct socket *, struct sockopt *);
int	ip_rsvp_vif_done(struct socket *, struct sockopt *);
void	ip_rsvp_force_done(struct socket *);

void	in_delayed_cksum(struct mbuf *m);

#endif /* KERNEL_PRIVATE */
#endif /* !_NETINET_IP_VAR_H_ */
Commit	Line	Data
1c79356b	1	/*
5d5c5d0d A	2	* Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
5d5c5d0d A	3	*
6601e61a	4	* @APPLE_LICENSE_HEADER_START@
1c79356b	5	*
6601e61a A	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.
8f6c56a5	11	*
6601e61a A	12	* This Original Code and all software distributed under the License are
6601e61a A	13	* distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
8f6c56a5 A	14	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
8f6c56a5 A	15	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
6601e61a A	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.
8f6c56a5	19	*
6601e61a	20	* @APPLE_LICENSE_HEADER_END@
1c79356b A	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_
9bccf70c	59	#include <sys/appleapiopts.h>
1c79356b A	60
	61	/*
	62	* Overlay for ip header used by other protocols (tcp, udp).
	63	*/
	64	struct ipovly {
	65	u_char ih_x1[9]; /* (unused) */
	66	u_char ih_pr; /* protocol */
	67	u_short ih_len; /* protocol length */
	68	struct in_addr ih_src; /* source internet address */
	69	struct in_addr ih_dst; /* destination internet address */
	70	};
	71
91447636	72	#ifdef KERNEL_PRIVATE
1c79356b A	73	/*
	74	* Ip reassembly queue structure. Each fragment
	75	* being reassembled is attached to one of these structures.
	76	* They are timed out after ipq_ttl drops to 0, and may also
	77	* be reclaimed if memory becomes tight.
	78	*/
	79	struct ipq {
	80	struct ipq next,prev; /* to other reass headers */
	81	u_char ipq_ttl; /* time for reass q to live */
	82	u_char ipq_p; /* protocol of this fragment */
	83	u_short ipq_id; /* sequence id for reassembly */
	84	struct mbuf ipq_frags; / to ip headers of fragments */
	85	struct in_addr ipq_src,ipq_dst;
483a1d10	86	u_long ipq_nfrags;
91447636 A	87	TAILQ_ENTRY(ipq) ipq_list;
91447636 A	88	u_long reserved[1]; /* for future use */
1c79356b	89	#if IPDIVERT
9bccf70c A	90	#ifdef IPDIVERT_44
	91	u_int32_t ipq_div_info; /* ipfw divert port & flags */
	92	#else
	93	u_int16_t ipq_divert; /* ipfw divert port (Maintain backward compat.) */
	94	#endif
	95	u_int16_t ipq_div_cookie; /* ipfw divert cookie */
1c79356b A	96	#endif
	97	};
	98
	99	/*
	100	* Structure stored in mbuf in inpcb.ip_options
	101	* and passed to ip_output when ip options are in use.
	102	* The actual length of the options (including ipopt_dst)
	103	* is in m_len.
	104	*/
91447636	105	#endif /* KERNEL_PRIVATE */
1c79356b	106	#define MAX_IPOPTLEN 40
91447636	107	#ifdef KERNEL_PRIVATE
1c79356b A	108
	109	struct ipoption {
	110	struct in_addr ipopt_dst; /* first-hop dst if source routed */
	111	char ipopt_list[MAX_IPOPTLEN]; /* options proper */
	112	};
	113
	114	/*
	115	* Structure attached to inpcb.ip_moptions and
	116	* passed to ip_output when IP multicast options are in use.
	117	*/
	118	struct ip_moptions {
	119	struct ifnet imo_multicast_ifp; / ifp for outgoing multicasts */
	120	u_char imo_multicast_ttl; /* TTL for outgoing multicasts */
	121	u_char imo_multicast_loop; /* 1 => hear sends if a member */
	122	u_short imo_num_memberships; /* no. memberships this socket */
	123	struct in_multi *imo_membership[IP_MAX_MEMBERSHIPS];
	124	u_long imo_multicast_vif; /* vif num outgoing multicasts */
9bccf70c	125	struct in_addr imo_multicast_addr; /* ifindex/addr on MULTICAST_IF */
1c79356b A	126	};
1c79356b A	127
91447636 A	128	/* mbuf tag for ip_forwarding info */
	129	struct ip_fwd_tag {
	130	struct sockaddr_in next_hop; / next_hop */
	131	};
	132
	133	#endif /* KERNEL_PRIVATE */
	134
1c79356b A	135	struct ipstat {
	136	u_long ips_total; /* total packets received */
	137	u_long ips_badsum; /* checksum bad */
	138	u_long ips_tooshort; /* packet too short */
	139	u_long ips_toosmall; /* not enough data */
	140	u_long ips_badhlen; /* ip header length < data size */
	141	u_long ips_badlen; /* ip length < ip header length */
	142	u_long ips_fragments; /* fragments received */
	143	u_long ips_fragdropped; /* frags dropped (dups, out of space) */
	144	u_long ips_fragtimeout; /* fragments timed out */
	145	u_long ips_forward; /* packets forwarded */
	146	u_long ips_fastforward; /* packets fast forwarded */
	147	u_long ips_cantforward; /* packets rcvd for unreachable dest */
	148	u_long ips_redirectsent; /* packets forwarded on same net */
	149	u_long ips_noproto; /* unknown or unsupported protocol */
	150	u_long ips_delivered; /* datagrams delivered to upper level*/
	151	u_long ips_localout; /* total ip packets generated here */
	152	u_long ips_odropped; /* lost packets due to nobufs, etc. */
	153	u_long ips_reassembled; /* total packets reassembled ok */
	154	u_long ips_fragmented; /* datagrams successfully fragmented */
	155	u_long ips_ofragments; /* output fragments created */
	156	u_long ips_cantfrag; /* don't fragment flag was set, etc. */
	157	u_long ips_badoptions; /* error in option processing */
	158	u_long ips_noroute; /* packets discarded due to no route */
	159	u_long ips_badvers; /* ip version != 4 */
	160	u_long ips_rawout; /* total raw ip packets generated */
	161	u_long ips_toolong; /* ip length > max ip packet size */
	162	u_long ips_notmember; /* multicasts for unregistered grps */
	163	u_long ips_nogif; /* no match gif found */
9bccf70c	164	u_long ips_badaddr; /* invalid address on header */
1c79356b A	165	};
1c79356b A	166
9bccf70c A	167	struct ip_linklocal_stat {
	168	u_long iplls_in_total;
	169	u_long iplls_in_badttl;
	170	u_long iplls_out_total;
	171	u_long iplls_out_badttl;
	172	};
1c79356b	173
91447636	174	#ifdef KERNEL_PRIVATE
1c79356b A	175	/* flags passed to ip_output as last parameter */
	176	#define IP_FORWARDING 0x1 /* most of ip header exists */
	177	#define IP_RAWOUTPUT 0x2 /* raw ip header exists */
55e303ae A	178	#define IP_NOIPSEC 0x4 /* No IPSec processing */
	179	#define IP_ROUTETOIF SO_DONTROUTE /* bypass routing tables (0x0010) */
	180	#define IP_ALLOWBROADCAST SO_BROADCAST /* can send broadcast packets (0x0020) */
1c79356b A	181
	182	struct ip;
	183	struct inpcb;
	184	struct route;
	185	struct sockopt;
	186
	187	extern struct ipstat ipstat;
9bccf70c	188	#if !defined(RANDOM_IP_ID) \|\| RANDOM_IP_ID == 0
1c79356b	189	extern u_short ip_id; /* ip packet ctr, for ids */
9bccf70c	190	#endif
1c79356b A	191	extern int ip_defttl; /* default IP ttl */
	192	extern int ipforwarding; /* ip forwarding */
	193	extern struct protosw *ip_protox[];
	194	extern struct socket ip_rsvpd; / reservation protocol daemon */
	195	extern struct socket ip_mrouter; / multicast routing daemon */
91447636 A	196	extern int (*legal_vif_num)(int);
91447636 A	197	extern u_long (*ip_mcast_src)(int);
1c79356b A	198	extern int rsvp_on;
	199	extern struct pr_usrreqs rip_usrreqs;
	200
91447636 A	201	int ip_ctloutput(struct socket , struct sockopt sopt);
	202	void ip_drain(void);
	203	void ip_freemoptions(struct ip_moptions *);
	204	void ip_init(void);
	205	extern int (ip_mforward)(struct ip , struct ifnet , struct mbuf ,
	206	struct ip_moptions *);
	207	int ip_output(struct mbuf *,
	208	struct mbuf , struct route , int, struct ip_moptions *);
	209	int ip_output_list(struct mbuf *, int,
	210	struct mbuf , struct route , int, struct ip_moptions *);
	211	struct in_ifaddr *
	212	ip_rtaddr(struct in_addr, struct route *);
	213	void ip_savecontrol(struct inpcb , struct mbuf , struct ip ,
	214	struct mbuf *);
	215	void ip_slowtimo(void);
1c79356b	216	struct mbuf *
91447636 A	217	ip_srcroute(void);
91447636 A	218	void ip_stripoptions(struct mbuf , struct mbuf );
9bccf70c A	219	#if RANDOM_IP_ID
9bccf70c A	220	u_int16_t
91447636	221	ip_randomid(void);
9bccf70c	222	#endif
91447636 A	223	int rip_ctloutput(struct socket , struct sockopt );
	224	void rip_ctlinput(int, struct sockaddr , void );
	225	void rip_init(void);
	226	void rip_input(struct mbuf *, int);
	227	int rip_output(struct mbuf , struct socket , u_long);
	228	int rip_unlock(struct socket *, int, int);
	229	void ipip_input(struct mbuf *, int);
	230	void rsvp_input(struct mbuf *, int);
	231	int ip_rsvp_init(struct socket *);
	232	int ip_rsvp_done(void);
	233	int ip_rsvp_vif_init(struct socket , struct sockopt );
	234	int ip_rsvp_vif_done(struct socket , struct sockopt );
	235	void ip_rsvp_force_done(struct socket *);
1c79356b	236
9bccf70c A	237	void in_delayed_cksum(struct mbuf *m);
9bccf70c A	238
0c530ab8 A	239	#endif /* KERNEL_PRIVATE */
0c530ab8 A	240	#endif /* !_NETINET_IP_VAR_H_ */