[apple/xnu.git] / bsd / netinet / udp_var.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@
 */
/*
 * Copyright (c) 1982, 1986, 1989, 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.
 *
 *	@(#)udp_var.h	8.1 (Berkeley) 6/10/93
 */

#ifndef _NETINET_UDP_VAR_H_
#define _NETINET_UDP_VAR_H_

#include <sys/appleapiopts.h>
#include <sys/sysctl.h>

/*
 * UDP kernel structures and variables.
 */
struct	udpiphdr {
	struct	ipovly ui_i;		/* overlaid ip structure */
	struct	udphdr ui_u;		/* udp header */
};
#define	ui_x1		ui_i.ih_x1
#define	ui_pr		ui_i.ih_pr
#define	ui_len		ui_i.ih_len
#define	ui_src		ui_i.ih_src
#define	ui_dst		ui_i.ih_dst
#define	ui_sport	ui_u.uh_sport
#define	ui_dport	ui_u.uh_dport
#define	ui_ulen		ui_u.uh_ulen
#define	ui_sum		ui_u.uh_sum
#define ui_next		ui_i.ih_next
#define ui_prev		ui_i.ih_prev

struct	udpstat {
	/* input statistics: */
	u_int32_t udps_ipackets;	/* total input packets */
	u_int32_t udps_hdrops;		/* packet shorter than header */
	u_int32_t udps_badsum;		/* checksum error */
	u_int32_t udps_badlen;		/* data length larger than packet */
	u_int32_t udps_noport;		/* no socket on port */
	u_int32_t udps_noportbcast;	/* of above, arrived as broadcast */
	u_int32_t udps_fullsock;	/* not delivered, input socket full */
	u_int32_t udpps_pcbcachemiss;	/* input packets missing pcb cache */
	u_int32_t udpps_pcbhashmiss;	/* input packets not for hashed pcb */
	/* output statistics: */
	u_int32_t udps_opackets;	/* total output packets */
	u_int32_t udps_fastout;		/* output packets on fast path */
	u_int32_t udps_nosum;		/* no checksum */
	u_int32_t udps_noportmcast;	/* of no socket on port, multicast */
	u_int32_t udps_filtermcast;	/* blocked by multicast filter */
	/* checksum statistics: */
	u_int32_t udps_rcv_swcsum;	  /* udp swcksum (inbound), packets */
	u_int32_t udps_rcv_swcsum_bytes;  /* udp swcksum (inbound), bytes */
	u_int32_t udps_rcv6_swcsum;	  /* udp6 swcksum (inbound), packets */
	u_int32_t udps_rcv6_swcsum_bytes; /* udp6 swcksum (inbound), bytes */
	u_int32_t udps_snd_swcsum;	  /* udp swcksum (outbound), packets */
	u_int32_t udps_snd_swcsum_bytes;  /* udp swcksum (outbound), bytes */
	u_int32_t udps_snd6_swcsum;	  /* udp6 swcksum (outbound), packets */
	u_int32_t udps_snd6_swcsum_bytes; /* udp6 swcksum (outbound), bytes */
};

/*
 * Names for UDP sysctl objects
 */
#define	UDPCTL_CHECKSUM		1	/* checksum UDP packets */
#define UDPCTL_STATS		2	/* statistics (read-only) */
#define	UDPCTL_MAXDGRAM		3	/* max datagram size */
#define	UDPCTL_RECVSPACE	4	/* default receive buffer space */
#define	UDPCTL_PCBLIST		5	/* list of PCBs for UDP sockets */
#define UDPCTL_MAXID		6

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

#define UDPCTL_NAMES {							\
	{ 0, 0 },							\
	{ "checksum", CTLTYPE_INT },					\
	{ "stats", CTLTYPE_STRUCT },					\
	{ "maxdgram", CTLTYPE_INT },					\
	{ "recvspace", CTLTYPE_INT },					\
	{ "pcblist", CTLTYPE_STRUCT },					\
}

#ifdef INET6
#define	udp6stat	udpstat
#define	udp6s_opackets	udps_opackets
#endif /* INET6 */

SYSCTL_DECL(_net_inet_udp);

struct udpstat_local {
	u_int64_t	port_unreach;
	u_int64_t	faithprefix;	/* deprecated */
	u_int64_t	port0;
	u_int64_t	badlength;
	u_int64_t	badchksum;
	u_int64_t	badmcast;
	u_int64_t	cleanup;
	u_int64_t	badipsec;
};

extern struct pr_usrreqs udp_usrreqs;
extern struct inpcbhead udb;
extern struct inpcbinfo udbinfo;
extern u_int32_t udp_sendspace;
extern u_int32_t udp_recvspace;
extern struct udpstat udpstat;
extern int udp_log_in_vain;

__BEGIN_DECLS
extern void udp_ctlinput(int, struct sockaddr *, void *);
extern int udp_ctloutput(struct socket *, struct sockopt *);
extern void udp_init(struct protosw *, struct domain *);
extern void udp_input(struct mbuf *, int);
extern int udp_connectx_common(struct socket *, int, struct sockaddr_list **,
    struct sockaddr_list **, struct proc *, uint32_t, associd_t, connid_t *,
    uint32_t, void *, uint32_t);
extern void udp_notify(struct inpcb *inp, int errno);
extern int udp_shutdown(struct socket *so);
extern int udp_lock(struct socket *, int, void *);
extern int udp_unlock(struct socket *, int, void *);
extern lck_mtx_t *udp_getlock(struct socket *, int);
extern void udp_get_ports_used(u_int32_t, int, u_int32_t, bitstr_t *);
extern uint32_t udp_count_opportunistic(unsigned int, u_int32_t);
extern uint32_t udp_find_anypcb_byaddr(struct ifaddr *);
__END_DECLS
#endif /* BSD_KERNEL_PRIVATE */
#endif /* _NETINET_UDP_VAR_H_ */
Commit	Line	Data
1c79356b	1	/*
39236c6e	2	* Copyright (c) 2008-2013 Apple Inc. All rights reserved.
5d5c5d0d	3	*
2d21ac55	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
1c79356b	5	*
2d21ac55 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.
8f6c56a5	14	*
2d21ac55 A	15	* Please obtain a copy of the License at
	16	* http://www.opensource.apple.com/apsl/ and read it before using this file.
	17	*
	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
8f6c56a5 A	20	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
8f6c56a5 A	21	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
2d21ac55 A	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.
8f6c56a5	25	*
2d21ac55	26	* @APPLE_OSREFERENCE_LICENSE_HEADER_END@
1c79356b A	27	*/
	28	/*
	29	* Copyright (c) 1982, 1986, 1989, 1993
	30	* The Regents of the University of California. All rights reserved.
	31	*
	32	* Redistribution and use in source and binary forms, with or without
	33	* modification, are permitted provided that the following conditions
	34	* are met:
	35	* 1. Redistributions of source code must retain the above copyright
	36	* notice, this list of conditions and the following disclaimer.
	37	* 2. Redistributions in binary form must reproduce the above copyright
	38	* notice, this list of conditions and the following disclaimer in the
	39	* documentation and/or other materials provided with the distribution.
	40	* 3. All advertising materials mentioning features or use of this software
	41	* must display the following acknowledgement:
	42	* This product includes software developed by the University of
	43	* California, Berkeley and its contributors.
	44	* 4. Neither the name of the University nor the names of its contributors
	45	* may be used to endorse or promote products derived from this software
	46	* without specific prior written permission.
	47	*
	48	* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	49	* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	50	* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	51	* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	52	* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	53	* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	54	* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	55	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	56	* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	57	* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	58	* SUCH DAMAGE.
	59	*
	60	* @(#)udp_var.h 8.1 (Berkeley) 6/10/93
	61	*/
	62
	63	#ifndef _NETINET_UDP_VAR_H_
	64	#define _NETINET_UDP_VAR_H_
	65
39236c6e	66	#include <sys/appleapiopts.h>
1c79356b A	67	#include <sys/sysctl.h>
	68
	69	/*
	70	* UDP kernel structures and variables.
	71	*/
	72	struct udpiphdr {
39236c6e	73	struct ipovly ui_i; /* overlaid ip structure */
1c79356b A	74	struct udphdr ui_u; /* udp header */
	75	};
	76	#define ui_x1 ui_i.ih_x1
	77	#define ui_pr ui_i.ih_pr
	78	#define ui_len ui_i.ih_len
	79	#define ui_src ui_i.ih_src
	80	#define ui_dst ui_i.ih_dst
	81	#define ui_sport ui_u.uh_sport
	82	#define ui_dport ui_u.uh_dport
	83	#define ui_ulen ui_u.uh_ulen
	84	#define ui_sum ui_u.uh_sum
	85	#define ui_next ui_i.ih_next
	86	#define ui_prev ui_i.ih_prev
	87
1c79356b	88	struct udpstat {
39236c6e A	89	/* input statistics: */
	90	u_int32_t udps_ipackets; /* total input packets */
	91	u_int32_t udps_hdrops; /* packet shorter than header */
	92	u_int32_t udps_badsum; /* checksum error */
	93	u_int32_t udps_badlen; /* data length larger than packet */
	94	u_int32_t udps_noport; /* no socket on port */
	95	u_int32_t udps_noportbcast; /* of above, arrived as broadcast */
	96	u_int32_t udps_fullsock; /* not delivered, input socket full */
	97	u_int32_t udpps_pcbcachemiss; /* input packets missing pcb cache */
	98	u_int32_t udpps_pcbhashmiss; /* input packets not for hashed pcb */
	99	/* output statistics: */
	100	u_int32_t udps_opackets; /* total output packets */
	101	u_int32_t udps_fastout; /* output packets on fast path */
	102	u_int32_t udps_nosum; /* no checksum */
	103	u_int32_t udps_noportmcast; /* of no socket on port, multicast */
	104	u_int32_t udps_filtermcast; /* blocked by multicast filter */
	105	/* checksum statistics: */
	106	u_int32_t udps_rcv_swcsum; /* udp swcksum (inbound), packets */
	107	u_int32_t udps_rcv_swcsum_bytes; /* udp swcksum (inbound), bytes */
	108	u_int32_t udps_rcv6_swcsum; /* udp6 swcksum (inbound), packets */
	109	u_int32_t udps_rcv6_swcsum_bytes; /* udp6 swcksum (inbound), bytes */
	110	u_int32_t udps_snd_swcsum; /* udp swcksum (outbound), packets */
	111	u_int32_t udps_snd_swcsum_bytes; /* udp swcksum (outbound), bytes */
	112	u_int32_t udps_snd6_swcsum; /* udp6 swcksum (outbound), packets */
	113	u_int32_t udps_snd6_swcsum_bytes; /* udp6 swcksum (outbound), bytes */
1c79356b A	114	};
	115
	116	/*
	117	* Names for UDP sysctl objects
	118	*/
	119	#define UDPCTL_CHECKSUM 1 /* checksum UDP packets */
	120	#define UDPCTL_STATS 2 /* statistics (read-only) */
	121	#define UDPCTL_MAXDGRAM 3 /* max datagram size */
	122	#define UDPCTL_RECVSPACE 4 /* default receive buffer space */
	123	#define UDPCTL_PCBLIST 5 /* list of PCBs for UDP sockets */
	124	#define UDPCTL_MAXID 6
	125
39236c6e A	126	#ifdef BSD_KERNEL_PRIVATE
	127	#include <kern/locks.h>
	128	#include <sys/bitstring.h>
	129
	130	#define UDPCTL_NAMES { \
	131	{ 0, 0 }, \
	132	{ "checksum", CTLTYPE_INT }, \
	133	{ "stats", CTLTYPE_STRUCT }, \
	134	{ "maxdgram", CTLTYPE_INT }, \
	135	{ "recvspace", CTLTYPE_INT }, \
	136	{ "pcblist", CTLTYPE_STRUCT }, \
1c79356b A	137	}
1c79356b A	138
39236c6e A	139	#ifdef INET6
	140	#define udp6stat udpstat
	141	#define udp6s_opackets udps_opackets
	142	#endif /* INET6 */
	143
1c79356b A	144	SYSCTL_DECL(_net_inet_udp);
1c79356b A	145
316670eb A	146	struct udpstat_local {
	147	u_int64_t port_unreach;
	148	u_int64_t faithprefix; /* deprecated */
	149	u_int64_t port0;
	150	u_int64_t badlength;
	151	u_int64_t badchksum;
	152	u_int64_t badmcast;
	153	u_int64_t cleanup;
	154	u_int64_t badipsec;
39236c6e	155	};
1c79356b	156
39236c6e A	157	extern struct pr_usrreqs udp_usrreqs;
	158	extern struct inpcbhead udb;
	159	extern struct inpcbinfo udbinfo;
	160	extern u_int32_t udp_sendspace;
	161	extern u_int32_t udp_recvspace;
	162	extern struct udpstat udpstat;
	163	extern int udp_log_in_vain;
1c79356b	164
39236c6e A	165	__BEGIN_DECLS
	166	extern void udp_ctlinput(int, struct sockaddr , void );
	167	extern int udp_ctloutput(struct socket , struct sockopt );
	168	extern void udp_init(struct protosw , struct domain );
	169	extern void udp_input(struct mbuf *, int);
	170	extern int udp_connectx_common(struct socket , int, struct sockaddr_list *,
	171	struct sockaddr_list *, struct proc , uint32_t, associd_t, connid_t *,
	172	uint32_t, void *, uint32_t);
	173	extern void udp_notify(struct inpcb *inp, int errno);
	174	extern int udp_shutdown(struct socket *so);
	175	extern int udp_lock(struct socket , int, void );
	176	extern int udp_unlock(struct socket , int, void );
	177	extern lck_mtx_t udp_getlock(struct socket , int);
	178	extern void udp_get_ports_used(u_int32_t, int, u_int32_t, bitstr_t *);
	179	extern uint32_t udp_count_opportunistic(unsigned int, u_int32_t);
	180	extern uint32_t udp_find_anypcb_byaddr(struct ifaddr *);
	181	__END_DECLS
	182	#endif /* BSD_KERNEL_PRIVATE */
0c530ab8	183	#endif /* _NETINET_UDP_VAR_H_ */