xref: /xnu-11215.41.3/bsd/net/if_dl.h (revision 33de042d024d46de5ff4e89f2471de6608e37fa4)
1 /*
2  * Copyright (c) 2000-2011 Apple Inc. All rights reserved.
3  *
4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5  *
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.
14  *
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
20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
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.
25  *
26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27  */
28 /*
29  * Copyright (c) 1990, 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  *	@(#)if_dl.h	8.1 (Berkeley) 6/10/93
61  * $FreeBSD: src/sys/net/if_dl.h,v 1.10 2000/03/01 02:46:25 archie Exp $
62  */
63 
64 #ifndef _NET_IF_DL_H_
65 #define _NET_IF_DL_H_
66 #include <sys/appleapiopts.h>
67 
68 #include <sys/_types.h> /* __offsetof() */
69 #include <sys/types.h>
70 
71 #ifdef BSD_KERNEL_PRIVATE
72 #define DLIL_SDLMAXLEN  64
73 #endif /* BSD_KERNEL_PRIVATE */
74 
75 /*
76  * A Link-Level Sockaddr may specify the interface in one of two
77  * ways: either by means of a system-provided index number (computed
78  * anew and possibly differently on every reboot), or by a human-readable
79  * string such as "il0" (for managerial convenience).
80  *
81  * Census taking actions, such as something akin to SIOCGCONF would return
82  * both the index and the human name.
83  *
84  * High volume transactions (such as giving a link-level ``from'' address
85  * in a recvfrom or recvmsg call) may be likely only to provide the indexed
86  * form, (which requires fewer copy operations and less space).
87  *
88  * The form and interpretation  of the link-level address is purely a matter
89  * of convention between the device driver and its consumers; however, it is
90  * expected that all drivers for an interface of a given if_type will agree.
91  */
92 
93 /*
94  * Structure of a Link-Level sockaddr:
95  */
96 struct sockaddr_dl {
97 	u_char  sdl_len;        /* Total length of sockaddr */
98 	u_char  sdl_family;     /* AF_LINK */
99 	u_short sdl_index;      /* if != 0, system given index for interface */
100 	u_char  sdl_type;       /* interface type */
101 	u_char  sdl_nlen;       /* interface name length, no trailing 0 reqd. */
102 	u_char  sdl_alen;       /* link level address length */
103 	u_char  sdl_slen;       /* link layer selector length */
104 	char    sdl_data[12];
105 	/* minimum work area, can be larger;
106 	 *  contains both if name and ll address */
107 #ifndef __APPLE__
108 	/* For TokenRing */
109 	u_short sdl_rcf;        /* source routing control */
110 	u_short sdl_route[16];  /* source routing information */
111 #endif
112 };
113 
114 #define LLADDR(s) ((caddr_t)(s) + __offsetof(struct sockaddr_dl, sdl_data) + (s)->sdl_nlen)
115 #ifdef KERNEL_PRIVATE
116 #define CONST_LLADDR(s) ((const u_char*)(s) + __offsetof(struct sockaddr_dl, sdl_data) + (s)->sdl_nlen)
117 #endif
118 
119 #ifdef BSD_KERNEL_PRIVATE
120 #define SDL(s) ((struct sockaddr_dl *)(void *)s)
121 #endif
122 
123 #ifndef KERNEL
124 
125 #include <sys/cdefs.h>
126 
127 __BEGIN_DECLS
128 void    link_addr(const char *, struct sockaddr_dl *);
129 char    *link_ntoa(const struct sockaddr_dl *);
130 __END_DECLS
131 
132 #endif /* !KERNEL */
133 
134 #endif
135