lib/libc/net/linkaddr.3

   1 .\" Copyright (c) 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" This code is derived from software contributed to Berkeley by
   5 .\" Donn Seeley at BSDI.
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\" 1. Redistributions of source code must retain the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer.
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in the
  14 .\"    documentation and/or other materials provided with the distribution.
  15 .\" 3. All advertising materials mentioning features or use of this software
  16 .\"    must display the following acknowledgement:
  17 .\"     This product includes software developed by the University of
  18 .\"     California, Berkeley and its contributors.
  19 .\" 4. Neither the name of the University nor the names of its contributors
  20 .\"    may be used to endorse or promote products derived from this software
  21 .\"    without specific prior written permission.
  22 .\"
  23 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  24 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  25 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  26 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  27 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  28 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  29 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  30 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  31 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  32 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  33 .\" SUCH DAMAGE.
  34 .\"
  35 .\"     From: @(#)linkaddr.3    8.1 (Berkeley) 7/28/93
  36 .\" $FreeBSD: src/lib/libc/net/linkaddr.3,v 1.8.2.4 2001/12/14 18:33:55 ru Exp $
  37 .\" $DragonFly: src/lib/libc/net/linkaddr.3,v 1.3 2008/11/23 21:55:52 swildner Exp $
  38 .\"
  39 .Dd June 17, 1996
  40 .Dt LINK_ADDR 3
  41 .Os
  42 .Sh NAME
  43 .Nm link_addr ,
  44 .Nm link_ntoa
  45 .Nd elementary address specification routines for link level access
  46 .Sh LIBRARY
  47 .Lb libc
  48 .Sh SYNOPSIS
  49 .In sys/types.h
  50 .In sys/socket.h
  51 .In net/if_dl.h
  52 .Ft void
  53 .Fn link_addr "const char *addr" "struct sockaddr_dl *sdl"
  54 .Ft char *
  55 .Fn link_ntoa "const struct sockaddr_dl *sdl"
  56 .Sh DESCRIPTION
  57 The routine
  58 .Fn link_addr
  59 interprets character strings representing
  60 link-level addresses, returning binary information suitable
  61 for use in system calls.
  62 The routine
  63 .Fn link_ntoa
  64 takes
  65 a link-level
  66 address and returns an
  67 .Tn ASCII
  68 string representing some of the information present,
  69 including the link level address itself, and the interface name
  70 or number, if present.
  71 This facility is experimental and is
  72 still subject to change.
  73 .Pp
  74 For
  75 .Fn link_addr ,
  76 the string
  77 .Fa addr
  78 may contain
  79 an optional network interface identifier of the form
  80 .Dq "name unit-number" ,
  81 suitable for the first argument to
  82 .Xr ifconfig 8 ,
  83 followed in all cases by a colon and
  84 an interface address in the form of
  85 groups of hexadecimal digits
  86 separated by periods.
  87 Each group represents a byte of address;
  88 address bytes are filled left to right from
  89 low order bytes through high order bytes.
  90 .Pp
  91 .\" A regular expression may make this format clearer:
  92 .\" .Bd -literal -offset indent
  93 .\" ([a-z]+[0-9]+:)?[0-9a-f]+(\e.[0-9a-f]+)*
  94 .\" .Ed
  95 .\" .Pp
  96 Thus
  97 .Li le0:8.0.9.13.d.30
  98 represents an ethernet address
  99 to be transmitted on the first Lance ethernet interface.
 100 .Pp
 101 The direct use of these functions is deprecated in favor of the
 102 .Xr addr2ascii 3
 103 interface; however, portable programs cannot rely on the latter as it is
 104 not yet widely implemented.
 105 .Sh RETURN VALUES
 106 .Fn link_ntoa
 107 always returns a null terminated string.
 108 .Fn link_addr
 109 has no return value.
 110 (See
 111 .Sx BUGS . )
 112 .Sh SEE ALSO
 113 .Xr addr2ascii 3
 114 .\" .Xr iso 4
 115 .Sh HISTORY
 116 The
 117 .Fn link_addr
 118 and
 119 .Fn link_ntoa
 120 functions appeared in
 121 .Bx 4.3 Reno  .
 122 .Sh BUGS
 123 The returned values for
 124 .Fn link_ntoa
 125 reside in a static memory area.
 126 .Pp
 127 The function
 128 .Fn link_addr
 129 should diagnose improperly formed input, and there should be an unambiguous
 130 way to recognize this.
 131 .Pp
 132 If the
 133 .Va sdl_len
 134 field of the link socket address
 135 .Fa sdl
 136 is 0,
 137 .Fn link_ntoa
 138 will not insert a colon before the interface address bytes.
 139 If this translated address is given to
 140 .Fn link_addr
 141 without inserting an initial colon,
 142 the latter will not interpret it correctly.