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

/*
 * Copyright (c) 2004 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_LICENSE_OSREFERENCE_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_LICENSE_OSREFERENCE_HEADER_END@
 */

#ifndef _NETINET_IN_ARP_H_
#define	_NETINET_IN_ARP_H_
#include <sys/kernel_types.h>

struct sockaddr_dl;
struct sockaddr_in;

/*!
	@function inet_arp_lookup
	@discussion This function will check the routing table for a cached
		arp entry or trigger an arp query to resolve the ip address to a
		link-layer address.
		
		Arp entries are stored in the routing table. This function will
		lookup the ip destination in the routing table. If the
		destination requires forwarding to a gateway, the route of the
		gateway will be looked up. The route entry is inspected to
		determine if the link layer destination address is known. If
		unknown, the arp generation function for IP attached to the
		interface is called to create an arp request packet.
	@param interface The interface the packet is being sent on.
	@param ip_dest The ip destination of the packet.
	@param ll_dest On output, the link-layer destination.
	@param ll_dest_len The length of the buffer for ll_dest.
	@param hint Any routing hint passed down from the protocol.
	@param packet The packet being transmitted.
	@result May return an error such as EHOSTDOWN or ENETUNREACH. If
		this function returns EJUSTRETURN, the packet has been queued
		and will be sent when an arp response is received. If any other
		value is returned, the caller is responsible for disposing of
		the packet.
 */
#ifdef BSD_KERNEL_PRIVATE
#define inet_arp_lookup arp_lookup_ip
#else
errno_t inet_arp_lookup(ifnet_t interface, const struct sockaddr_in *ip_dest,
			struct sockaddr_dl *ll_dest, size_t ll_dest_len, route_t hint,
			mbuf_t packet);
#endif /* BSD_KERNEL_PRIVATE */
#ifdef KERNEL_PRIVATE
/* arp_lookup_ip is obsolete, use inet_arp_lookup */
errno_t arp_lookup_ip(ifnet_t interface, const struct sockaddr_in *ip_dest,
			struct sockaddr_dl *ll_dest, size_t ll_dest_len, route_t hint,
			mbuf_t packet);
#endif /* KERNEL_PRIVATE */

/*!
	@function inet_arp_handle_input
	@discussion This function should be called by code that handles
		inbound arp packets. The caller should parse the ARP packet to
		pull out the operation and the relevant addresses. If a response
		is required, the proto_media_send_arp function will be called.
		
		This function will lookup the sender in the routing table and
		add an arp entry if necessary. Any queued packets waiting for
		the arp resolution will also be transmitted.
	@param interface The interface the packet was received on.
	@param arp_op The arp operation, ARPOP_REQUEST or ARPOP_REPLY
	@param sender_hw The sender hardware address from the arp payload.
	@param sender_ip The sender IP address from the arp payload.
	@param target_ip The target IP address from the arp payload.
	@result 0 on success or an errno error value on failure.
 */
#ifdef BSD_KERNEL_PRIVATE
#define inet_arp_handle_input arp_ip_handle_input
#else
errno_t inet_arp_handle_input(ifnet_t ifp, u_int16_t arpop,
			const struct sockaddr_dl *sender_hw,
			const struct sockaddr_in *sender_ip,
			const struct sockaddr_in *target_ip);
#endif /* KERNEL_PRIVATE */
#ifdef KERNEL_PRIVATE
/* arp_ip_handle_input is obsolete, use inet_arp_handle_input */
errno_t arp_ip_handle_input(ifnet_t ifp, u_int16_t arpop,
			const struct sockaddr_dl *sender_hw,
			const struct sockaddr_in *sender_ip,
			const struct sockaddr_in *target_ip);
#endif /* BSD_KERNEL_PRIVATE */

/*!
	@function inet_arp_init_ifaddr
	@discussion This function should be called in two places, when an IP
		address is added and when the hardware address changes. This
		function will setup the ifaddr_t for use with the IP ARP
		functions. This function will also trigger the transmission of a
		gratuitous ARP packet.
		
		When the SIOCSIFADDR ioctl is handled, the data parameter will
		be an ifaddr_t. If this is an IP address, inet_arp_init_ifaddr
		should be called. This is usually performed in the protocol
		attachment's ioctl handler.
		
		When the event handler for the protocol attachment receives a
		KEV_DL_LINK_ADDRESS_CHANGED event, the event handler should call
		inet_arp_init_ifaddr for each interface ip address.
		
		For an example, see bsd/net/ether_inet_pr_module.c in xnu.
		Search for inet_arp_init_ifaddr.
	@param interface The interface the packet was received on.
	@param ipaddr The ip interface address.
 */
#ifdef BSD_KERNEL_PRIVATE
/* inet_arp_init_ifaddr is aliased to arp_ifinit */
#define	inet_arp_init_ifaddr	arp_ifinit
#else
void	inet_arp_init_ifaddr(ifnet_t interface, ifaddr_t ipaddr);
#endif

#endif _NETINET_IN_ARP_H_
Commit	Line	Data
91447636	1	/*
5d5c5d0d A	2	* Copyright (c) 2004 Apple Computer, Inc. All rights reserved.
5d5c5d0d A	3	*
8ad349bb	4	* @APPLE_LICENSE_OSREFERENCE_HEADER_START@
91447636	5	*
8ad349bb 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
	10	* License may not be used to create, or enable the creation or
	11	* redistribution of, unlawful or unlicensed copies of an Apple operating
	12	* system, or to circumvent, violate, or enable the circumvention or
	13	* violation of, any terms of an Apple operating system software license
	14	* agreement.
	15	*
	16	* Please obtain a copy of the License at
	17	* http://www.opensource.apple.com/apsl/ and read it before using this
	18	* file.
	19	*
	20	* The Original Code and all software distributed under the License are
	21	* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
	22	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
	23	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
	24	* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
	25	* Please see the License for the specific language governing rights and
	26	* limitations under the License.
	27	*
	28	* @APPLE_LICENSE_OSREFERENCE_HEADER_END@
91447636 A	29	*/
	30
	31	#ifndef _NETINET_IN_ARP_H_
	32	#define _NETINET_IN_ARP_H_
	33	#include <sys/kernel_types.h>
	34
	35	struct sockaddr_dl;
	36	struct sockaddr_in;
	37
	38	/*!
	39	@function inet_arp_lookup
	40	@discussion This function will check the routing table for a cached
	41	arp entry or trigger an arp query to resolve the ip address to a
	42	link-layer address.
	43
	44	Arp entries are stored in the routing table. This function will
	45	lookup the ip destination in the routing table. If the
	46	destination requires forwarding to a gateway, the route of the
	47	gateway will be looked up. The route entry is inspected to
	48	determine if the link layer destination address is known. If
	49	unknown, the arp generation function for IP attached to the
	50	interface is called to create an arp request packet.
	51	@param interface The interface the packet is being sent on.
	52	@param ip_dest The ip destination of the packet.
	53	@param ll_dest On output, the link-layer destination.
	54	@param ll_dest_len The length of the buffer for ll_dest.
	55	@param hint Any routing hint passed down from the protocol.
	56	@param packet The packet being transmitted.
	57	@result May return an error such as EHOSTDOWN or ENETUNREACH. If
	58	this function returns EJUSTRETURN, the packet has been queued
	59	and will be sent when an arp response is received. If any other
	60	value is returned, the caller is responsible for disposing of
	61	the packet.
	62	*/
	63	#ifdef BSD_KERNEL_PRIVATE
	64	#define inet_arp_lookup arp_lookup_ip
	65	#else
	66	errno_t inet_arp_lookup(ifnet_t interface, const struct sockaddr_in *ip_dest,
	67	struct sockaddr_dl *ll_dest, size_t ll_dest_len, route_t hint,
	68	mbuf_t packet);
	69	#endif /* BSD_KERNEL_PRIVATE */
	70	#ifdef KERNEL_PRIVATE
	71	/* arp_lookup_ip is obsolete, use inet_arp_lookup */
	72	errno_t arp_lookup_ip(ifnet_t interface, const struct sockaddr_in *ip_dest,
	73	struct sockaddr_dl *ll_dest, size_t ll_dest_len, route_t hint,
	74	mbuf_t packet);
	75	#endif /* KERNEL_PRIVATE */
	76
	77	/*!
	78	@function inet_arp_handle_input
	79	@discussion This function should be called by code that handles
	80	inbound arp packets. The caller should parse the ARP packet to
	81	pull out the operation and the relevant addresses. If a response
	82	is required, the proto_media_send_arp function will be called.
	83
	84	This function will lookup the sender in the routing table and
	85	add an arp entry if necessary. Any queued packets waiting for
	86	the arp resolution will also be transmitted.
	87	@param interface The interface the packet was received on.
	88	@param arp_op The arp operation, ARPOP_REQUEST or ARPOP_REPLY
	89	@param sender_hw The sender hardware address from the arp payload.
	90	@param sender_ip The sender IP address from the arp payload.
	91	@param target_ip The target IP address from the arp payload.
	92	@result 0 on success or an errno error value on failure.
93	*/
94	#ifdef BSD_KERNEL_PRIVATE
95	#define inet_arp_handle_input arp_ip_handle_input
96	#else
97	errno_t inet_arp_handle_input(ifnet_t ifp, u_int16_t arpop,
98	const struct sockaddr_dl *sender_hw,
99	const struct sockaddr_in *sender_ip,
100	const struct sockaddr_in *target_ip);
101	#endif /* KERNEL_PRIVATE */
102	#ifdef KERNEL_PRIVATE
103	/* arp_ip_handle_input is obsolete, use inet_arp_handle_input */
104	errno_t arp_ip_handle_input(ifnet_t ifp, u_int16_t arpop,
105	const struct sockaddr_dl *sender_hw,
106	const struct sockaddr_in *sender_ip,
107	const struct sockaddr_in *target_ip);
108	#endif /* BSD_KERNEL_PRIVATE */
109
110	/*!
111	@function inet_arp_init_ifaddr
112	@discussion This function should be called in two places, when an IP
113	address is added and when the hardware address changes. This
114	function will setup the ifaddr_t for use with the IP ARP
115	functions. This function will also trigger the transmission of a
116	gratuitous ARP packet.
117
118	When the SIOCSIFADDR ioctl is handled, the data parameter will
119	be an ifaddr_t. If this is an IP address, inet_arp_init_ifaddr
120	should be called. This is usually performed in the protocol
121	attachment's ioctl handler.
122
123	When the event handler for the protocol attachment receives a
124	KEV_DL_LINK_ADDRESS_CHANGED event, the event handler should call
125	inet_arp_init_ifaddr for each interface ip address.
126
127	For an example, see bsd/net/ether_inet_pr_module.c in xnu.
128	Search for inet_arp_init_ifaddr.
129	@param interface The interface the packet was received on.
130	@param ipaddr The ip interface address.
131	*/
132	#ifdef BSD_KERNEL_PRIVATE
133	/* inet_arp_init_ifaddr is aliased to arp_ifinit */
134	#define inet_arp_init_ifaddr arp_ifinit
135	#else
136	void inet_arp_init_ifaddr(ifnet_t interface, ifaddr_t ipaddr);
137	#endif
138
139	#endif _NETINET_IN_ARP_H_