bsd/net/if_dl.h

   1 /*
   2  * Copyright (c) 2006 Apple Computer, Inc. All Rights Reserved.
   3  *
   4  * @APPLE_LICENSE_OSREFERENCE_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
  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@
  29  */
  30 /*
  31  * Copyright (c) 1990, 1993
  32  *      The Regents of the University of California.  All rights reserved.
  33  *
  34  * Redistribution and use in source and binary forms, with or without
  35  * modification, are permitted provided that the following conditions
  36  * are met:
  37  * 1. Redistributions of source code must retain the above copyright
  38  *    notice, this list of conditions and the following disclaimer.
  39  * 2. Redistributions in binary form must reproduce the above copyright
  40  *    notice, this list of conditions and the following disclaimer in the
  41  *    documentation and/or other materials provided with the distribution.
  42  * 3. All advertising materials mentioning features or use of this software
  43  *    must display the following acknowledgement:
  44  *      This product includes software developed by the University of
  45  *      California, Berkeley and its contributors.
  46  * 4. Neither the name of the University nor the names of its contributors
  47  *    may be used to endorse or promote products derived from this software
  48  *    without specific prior written permission.
  49  *
  50  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  51  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  52  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  53  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  54  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  55  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  56  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  57  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  58  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  59  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  60  * SUCH DAMAGE.
  61  *
  62  *      @(#)if_dl.h     8.1 (Berkeley) 6/10/93
  63  * $FreeBSD: src/sys/net/if_dl.h,v 1.10 2000/03/01 02:46:25 archie Exp $
  64  */
  65
  66 #ifndef _NET_IF_DL_H_
  67 #define _NET_IF_DL_H_
  68 #include <sys/appleapiopts.h>
  69
  70 /*
  71  * A Link-Level Sockaddr may specify the interface in one of two
  72  * ways: either by means of a system-provided index number (computed
  73  * anew and possibly differently on every reboot), or by a human-readable
  74  * string such as "il0" (for managerial convenience).
  75  *
  76  * Census taking actions, such as something akin to SIOCGCONF would return
  77  * both the index and the human name.
  78  *
  79  * High volume transactions (such as giving a link-level ``from'' address
  80  * in a recvfrom or recvmsg call) may be likely only to provide the indexed
  81  * form, (which requires fewer copy operations and less space).
  82  *
  83  * The form and interpretation  of the link-level address is purely a matter
  84  * of convention between the device driver and its consumers; however, it is
  85  * expected that all drivers for an interface of a given if_type will agree.
  86  */
  87
  88 /*
  89  * Structure of a Link-Level sockaddr:
  90  */
  91 struct sockaddr_dl {
  92         u_char  sdl_len;        /* Total length of sockaddr */
  93         u_char  sdl_family;     /* AF_LINK */
  94         u_short sdl_index;      /* if != 0, system given index for interface */
  95         u_char  sdl_type;       /* interface type */
  96         u_char  sdl_nlen;       /* interface name length, no trailing 0 reqd. */
  97         u_char  sdl_alen;       /* link level address length */
  98         u_char  sdl_slen;       /* link layer selector length */
  99         char    sdl_data[12];   /* minimum work area, can be larger;
 100                                    contains both if name and ll address */
 101 #ifndef __APPLE__
 102         /* For TokenRing */
 103         u_short sdl_rcf;        /* source routing control */
 104         u_short sdl_route[16];  /* source routing information */
 105 #endif
 106 };
 107
 108 #define LLADDR(s) ((caddr_t)((s)->sdl_data + (s)->sdl_nlen))
 109 #ifdef KERNEL_PRIVATE
 110 #define CONST_LLADDR(s) ((const u_char*)((s)->sdl_data + (s)->sdl_nlen))
 111 #endif
 112
 113 #ifdef BSD_KERNEL_PRIVATE
 114 #define SDL(s) ((struct sockaddr_dl *)s)
 115 #endif
 116
 117 #ifndef KERNEL
 118
 119 #include <sys/cdefs.h>
 120
 121 __BEGIN_DECLS
 122 void    link_addr(const char *, struct sockaddr_dl *);
 123 char    *link_ntoa(const struct sockaddr_dl *);
 124 __END_DECLS
 125
 126 #endif /* !KERNEL */
 127
 128 #endif