[apple/xnu.git] / bsd / net / if_arp.h

/*
 * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_LICENSE_HEADER_START@
 * 
 * Copyright (c) 1999-2003 Apple Computer, Inc.  All Rights Reserved.
 * 
 * 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. 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_HEADER_END@
 */
/*
 * Copyright (c) 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.
 *
 *	@(#)if_arp.h	8.1 (Berkeley) 6/10/93
 * $FreeBSD: src/sys/net/if_arp.h,v 1.14.2.1 2000/07/11 20:46:55 archie Exp $
 */

#ifndef _NET_IF_ARP_H_
#define	_NET_IF_ARP_H_
#include <sys/appleapiopts.h>
#include <netinet/in.h>

/*
 * Address Resolution Protocol.
 *
 * See RFC 826 for protocol description.  ARP packets are variable
 * in size; the arphdr structure defines the fixed-length portion.
 * Protocol type values are the same as those for 10 Mb/s Ethernet.
 * It is followed by the variable-sized fields ar_sha, arp_spa,
 * arp_tha and arp_tpa in that order, according to the lengths
 * specified.  Field names used correspond to RFC 826.
 */
struct	arphdr {
	u_short	ar_hrd;		/* format of hardware address */
#define ARPHRD_ETHER 	1	/* ethernet hardware format */
#define ARPHRD_IEEE802	6	/* token-ring hardware format */
#define ARPHRD_FRELAY 	15	/* frame relay hardware format */
#define ARPHRD_IEEE1394	24	/* IEEE1394 hardware address */
#define ARPHRD_IEEE1394_EUI64 27 /* IEEE1394 EUI-64 */
	u_short	ar_pro;		/* format of protocol address */
	u_char	ar_hln;		/* length of hardware address */
	u_char	ar_pln;		/* length of protocol address */
	u_short	ar_op;		/* one of: */
#define	ARPOP_REQUEST	1	/* request to resolve address */
#define	ARPOP_REPLY	2	/* response to previous request */
#define	ARPOP_REVREQUEST 3	/* request protocol address given hardware */
#define	ARPOP_REVREPLY	4	/* response giving protocol address */
#define ARPOP_INVREQUEST 8 	/* request to identify peer */
#define ARPOP_INVREPLY	9	/* response identifying peer */
/*
 * The remaining fields are variable in size,
 * according to the sizes above.
 */
#ifdef COMMENT_ONLY
	u_char	ar_sha[];	/* sender hardware address */
	u_char	ar_spa[];	/* sender protocol address */
	u_char	ar_tha[];	/* target hardware address */
	u_char	ar_tpa[];	/* target protocol address */
#endif
};

/*
 * ARP ioctl request
 */
struct arpreq {
	struct	sockaddr arp_pa;		/* protocol address */
	struct	sockaddr arp_ha;		/* hardware address */
	int	arp_flags;			/* flags */
};
/*  arp_flags and at_flags field values */
#define	ATF_INUSE	0x01	/* entry in use */
#define ATF_COM		0x02	/* completed entry (enaddr valid) */
#define	ATF_PERM	0x04	/* permanent entry */
#define	ATF_PUBL	0x08	/* publish entry (respond for other host) */
#define	ATF_USETRAILERS	0x10	/* has requested trailers */

#ifdef __APPLE_API_UNSTABLE

#ifdef __APPLE__
/*
 * Ethernet multicast address structure.  There is one of these for each
 * multicast address or range of multicast addresses that we are supposed
 * to listen to on a particular interface.  They are kept in a linked list,
 * rooted in the interface's arpcom structure.  (This really has nothing to
 * do with ARP, or with the Internet address family, but this appears to be
 * the minimally-disrupting place to put it.)
 */
struct ether_multi {
	u_char	enm_addrlo[6];		/* low  or only address of range */
	u_char	enm_addrhi[6];		/* high or only address of range */
	struct	arpcom *enm_ac;		/* back pointer to arpcom */
	u_int	enm_refcount;		/* no. claims to this addr/range */
	struct	ether_multi *enm_next;	/* ptr to next ether_multi */
};

/*
 * Structure used by macros below to remember position when stepping through
 * all of the ether_multi records.
 */
struct ether_multistep {
	struct ether_multi  *e_enm;
};
#endif /* __APPLE__ */

#ifdef KERNEL
/*
 * Structure shared between the ethernet driver modules and
 * the address resolution code.  For example, each ec_softc or il_softc
 * begins with this structure.
 */
struct	arpcom {
	/*
	 * The ifnet struct _must_ be at the head of this structure.
	 */
	struct 	ifnet ac_if;		/* network-visible interface */
	u_char	ac_enaddr[6];		/* ethernet hardware address */
#ifdef __APPLE__
	struct	in_addr ac_ipaddr;	/* copy of ip address- XXX */
	struct	ether_multi *ac_multiaddrs; /* list of ether multicast addrs */
#endif
	int	ac_multicnt;		/* length of ac_multiaddrs list */
#ifndef __APPLE__
	void	*ac_netgraph;		/* ng_ether(4) netgraph node info */
#endif
};


#endif
#endif /* __APPLE_API_UNSTABLE */

#endif /* !_NET_IF_ARP_H_ */
Commit	Line	Data
1c79356b A	1	/*
	2	* Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
	3	*
	4	* @APPLE_LICENSE_HEADER_START@
	5	*
43866e37	6	* Copyright (c) 1999-2003 Apple Computer, Inc. All Rights Reserved.
1c79356b	7	*
43866e37 A	8	* This file contains Original Code and/or Modifications of Original Code
	9	* as defined in and that are subject to the Apple Public Source License
	10	* Version 2.0 (the 'License'). You may not use this file except in
	11	* compliance with the License. Please obtain a copy of the License at
	12	* http://www.opensource.apple.com/apsl/ and read it before using this
	13	* file.
	14	*
	15	* The Original Code and all software distributed under the License are
	16	* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
1c79356b A	17	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
1c79356b A	18	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
43866e37 A	19	* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
	20	* Please see the License for the specific language governing rights and
	21	* limitations under the License.
1c79356b A	22	*
	23	* @APPLE_LICENSE_HEADER_END@
	24	*/
	25	/*
	26	* Copyright (c) 1986, 1993
	27	* The Regents of the University of California. All rights reserved.
	28	*
	29	* Redistribution and use in source and binary forms, with or without
	30	* modification, are permitted provided that the following conditions
	31	* are met:
	32	* 1. Redistributions of source code must retain the above copyright
	33	* notice, this list of conditions and the following disclaimer.
	34	* 2. Redistributions in binary form must reproduce the above copyright
	35	* notice, this list of conditions and the following disclaimer in the
	36	* documentation and/or other materials provided with the distribution.
	37	* 3. All advertising materials mentioning features or use of this software
	38	* must display the following acknowledgement:
	39	* This product includes software developed by the University of
	40	* California, Berkeley and its contributors.
	41	* 4. Neither the name of the University nor the names of its contributors
	42	* may be used to endorse or promote products derived from this software
	43	* without specific prior written permission.
	44	*
	45	* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	46	* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	47	* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	48	* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	49	* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	50	* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	51	* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	52	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	53	* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	54	* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	55	* SUCH DAMAGE.
	56	*
	57	* @(#)if_arp.h 8.1 (Berkeley) 6/10/93
9bccf70c	58	* $FreeBSD: src/sys/net/if_arp.h,v 1.14.2.1 2000/07/11 20:46:55 archie Exp $
1c79356b A	59	*/
	60
	61	#ifndef _NET_IF_ARP_H_
	62	#define _NET_IF_ARP_H_
9bccf70c A	63	#include <sys/appleapiopts.h>
9bccf70c A	64	#include <netinet/in.h>
1c79356b A	65
	66	/*
	67	* Address Resolution Protocol.
	68	*
	69	* See RFC 826 for protocol description. ARP packets are variable
	70	* in size; the arphdr structure defines the fixed-length portion.
	71	* Protocol type values are the same as those for 10 Mb/s Ethernet.
	72	* It is followed by the variable-sized fields ar_sha, arp_spa,
	73	* arp_tha and arp_tpa in that order, according to the lengths
	74	* specified. Field names used correspond to RFC 826.
	75	*/
	76	struct arphdr {
	77	u_short ar_hrd; /* format of hardware address */
	78	#define ARPHRD_ETHER 1 /* ethernet hardware format */
9bccf70c	79	#define ARPHRD_IEEE802 6 /* token-ring hardware format */
1c79356b	80	#define ARPHRD_FRELAY 15 /* frame relay hardware format */
55e303ae A	81	#define ARPHRD_IEEE1394 24 /* IEEE1394 hardware address */
55e303ae A	82	#define ARPHRD_IEEE1394_EUI64 27 /* IEEE1394 EUI-64 */
1c79356b A	83	u_short ar_pro; /* format of protocol address */
	84	u_char ar_hln; /* length of hardware address */
	85	u_char ar_pln; /* length of protocol address */
	86	u_short ar_op; /* one of: */
	87	#define ARPOP_REQUEST 1 /* request to resolve address */
	88	#define ARPOP_REPLY 2 /* response to previous request */
	89	#define ARPOP_REVREQUEST 3 /* request protocol address given hardware */
	90	#define ARPOP_REVREPLY 4 /* response giving protocol address */
	91	#define ARPOP_INVREQUEST 8 /* request to identify peer */
	92	#define ARPOP_INVREPLY 9 /* response identifying peer */
	93	/*
	94	* The remaining fields are variable in size,
	95	* according to the sizes above.
	96	*/
	97	#ifdef COMMENT_ONLY
	98	u_char ar_sha[]; /* sender hardware address */
	99	u_char ar_spa[]; /* sender protocol address */
	100	u_char ar_tha[]; /* target hardware address */
	101	u_char ar_tpa[]; /* target protocol address */
	102	#endif
	103	};
	104
	105	/*
	106	* ARP ioctl request
	107	*/
	108	struct arpreq {
	109	struct sockaddr arp_pa; /* protocol address */
	110	struct sockaddr arp_ha; /* hardware address */
	111	int arp_flags; /* flags */
	112	};
	113	/* arp_flags and at_flags field values */
	114	#define ATF_INUSE 0x01 /* entry in use */
	115	#define ATF_COM 0x02 /* completed entry (enaddr valid) */
	116	#define ATF_PERM 0x04 /* permanent entry */
	117	#define ATF_PUBL 0x08 /* publish entry (respond for other host) */
	118	#define ATF_USETRAILERS 0x10 /* has requested trailers */
	119
9bccf70c	120	#ifdef __APPLE_API_UNSTABLE
1c79356b	121
9bccf70c	122	#ifdef __APPLE__
1c79356b A	123	/*
	124	* Ethernet multicast address structure. There is one of these for each
	125	* multicast address or range of multicast addresses that we are supposed
	126	* to listen to on a particular interface. They are kept in a linked list,
	127	* rooted in the interface's arpcom structure. (This really has nothing to
	128	* do with ARP, or with the Internet address family, but this appears to be
	129	* the minimally-disrupting place to put it.)
	130	*/
	131	struct ether_multi {
	132	u_char enm_addrlo[6]; /* low or only address of range */
	133	u_char enm_addrhi[6]; /* high or only address of range */
	134	struct arpcom enm_ac; / back pointer to arpcom */
	135	u_int enm_refcount; /* no. claims to this addr/range */
	136	struct ether_multi enm_next; / ptr to next ether_multi */
	137	};
	138
	139	/*
	140	* Structure used by macros below to remember position when stepping through
	141	* all of the ether_multi records.
	142	*/
	143	struct ether_multistep {
	144	struct ether_multi *e_enm;
	145	};
9bccf70c	146	#endif /* __APPLE__ */
1c79356b A	147
	148	#ifdef KERNEL
	149	/*
	150	* Structure shared between the ethernet driver modules and
	151	* the address resolution code. For example, each ec_softc or il_softc
	152	* begins with this structure.
	153	*/
	154	struct arpcom {
	155	/*
	156	* The ifnet struct _must_ be at the head of this structure.
	157	*/
	158	struct ifnet ac_if; /* network-visible interface */
	159	u_char ac_enaddr[6]; /* ethernet hardware address */
9bccf70c	160	#ifdef __APPLE__
1c79356b A	161	struct in_addr ac_ipaddr; /* copy of ip address- XXX */
1c79356b A	162	struct ether_multi ac_multiaddrs; / list of ether multicast addrs */
9bccf70c	163	#endif
1c79356b	164	int ac_multicnt; /* length of ac_multiaddrs list */
9bccf70c A	165	#ifndef __APPLE__
	166	void ac_netgraph; / ng_ether(4) netgraph node info */
	167	#endif
1c79356b A	168	};
	169
	170
	171	#endif
9bccf70c	172	#endif /* __APPLE_API_UNSTABLE */
1c79356b A	173
1c79356b A	174	#endif /* !_NET_IF_ARP_H_ */