lib/libc/net/getifaddrs.3

   1 .\"     $NetBSD: getifaddrs.3,v 1.10 2009/04/21 23:27:09 dyoung Exp $
   2 .\"     BSDI    getifaddrs.3,v 2.5 2000/02/23 14:51:59 dab Exp
   3 .\"
   4 .\" Copyright (c) 1995, 1999
   5 .\"     Berkeley Software Design, Inc.  All rights reserved.
   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 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY Berkeley Software Design, Inc. ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL Berkeley Software Design, Inc. BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .Dd April 21, 2009
  25 .Dt GETIFADDRS 3
  26 .Os
  27 .Sh NAME
  28 .Nm getifaddrs
  29 .Nd get interface addresses
  30 .Sh SYNOPSIS
  31 .In sys/types.h
  32 .In sys/socket.h
  33 .In ifaddrs.h
  34 .Ft int
  35 .Fn getifaddrs "struct ifaddrs **ifap"
  36 .Ft void
  37 .Fn freeifaddrs "struct ifaddrs *ifp"
  38 .Sh DESCRIPTION
  39 The
  40 .Fn getifaddrs
  41 function stores a reference to a linked list of the network interfaces
  42 on the local machine in the memory referenced by
  43 .Fa ifap .
  44 The list consists of
  45 .Nm ifaddrs
  46 structures, as defined in the include file
  47 .Aq Pa ifaddrs.h .
  48 The
  49 .Nm ifaddrs
  50 structure contains at least the following entries:
  51 .Bd -literal
  52     struct ifaddrs   *ifa_next;         /* Pointer to next struct */
  53     char             *ifa_name;         /* Interface name */
  54     u_int             ifa_flags;        /* Interface flags */
  55     struct sockaddr  *ifa_addr;         /* Interface address */
  56     struct sockaddr  *ifa_netmask;      /* Interface netmask */
  57     struct sockaddr  *ifa_broadaddr;    /* Interface broadcast address */
  58     struct sockaddr  *ifa_dstaddr;      /* P2P interface destination */
  59     void             *ifa_data;         /* Address specific data */
  60 .Ed
  61 .Pp
  62 The
  63 .Li ifa_next
  64 field contains a pointer to the next structure on the list.
  65 This field is
  66 .Dv NULL
  67 in last structure on the list.
  68 .Pp
  69 The
  70 .Li ifa_name
  71 field contains the interface name.
  72 .Pp
  73 The
  74 .Li ifa_flags
  75 field contains the interface flags, as set by
  76 .Xr ifconfig 8
  77 utility.
  78 .Pp
  79 The
  80 .Li ifa_addr
  81 field references either the address of the interface or the link level
  82 address of the interface, if one exists, otherwise it is
  83 .Dv NULL .
  84 (The
  85 .Li sa_family
  86 field of the
  87 .Li ifa_addr
  88 field should be consulted to determine the format of the
  89 .Li ifa_addr
  90 address.)
  91 .Pp
  92 The
  93 .Li ifa_netmask
  94 field references the netmask associated with
  95 .Li ifa_addr ,
  96 if one is set, otherwise it is
  97 .Dv NULL .
  98 .Pp
  99 The
 100 .Li ifa_broadaddr
 101 field,
 102 which should only be referenced for non-P2P interfaces,
 103 references the broadcast address associated with
 104 .Li ifa_addr ,
 105 if one exists, otherwise it is
 106 .Dv NULL .
 107 .Pp
 108 The
 109 .Li ifa_dstaddr
 110 field references the destination address on a P2P interface,
 111 if one exists, otherwise it is
 112 .Dv NULL .
 113 .Pp
 114 The
 115 .Li ifa_data
 116 field references address family specific data.
 117 For
 118 .Dv AF_LINK
 119 addresses it contains a pointer to the
 120 .Fa struct if_data
 121 .Pq as defined in include file Aq Pa net/if.h
 122 which contains various interface attributes and statistics.
 123 For all other address families, it is
 124 .Dv NULL .
 125 .Pp
 126 The data returned by
 127 .Fn getifaddrs
 128 is dynamically allocated and should be freed using
 129 .Fn freeifaddrs
 130 when no longer needed.
 131 .Sh RETURN VALUES
 132 Upon successful completion, a value of 0 is returned.
 133 Otherwise, a value of -1 is returned and
 134 .Va errno
 135 is set to indicate the error.
 136 .Sh ERRORS
 137 The
 138 .Fn getifaddrs
 139 may fail and set
 140 .Va errno
 141 for any of the errors specified for the library routines
 142 .Xr ioctl 2 ,
 143 .Xr socket 2 ,
 144 .Xr malloc 3
 145 or
 146 .Xr sysctl 3 .
 147 .Sh SEE ALSO
 148 .Xr ioctl 2 ,
 149 .Xr socket 2 ,
 150 .Xr sysctl 3 ,
 151 .Xr networking 4 ,
 152 .Xr ifconfig 8
 153 .Sh HISTORY
 154 The
 155 .Nm
 156 implementation first appeared in
 157 .Bsx .
 158 .Sh BUGS
 159 If both
 160 .Aq Pa net/if.h
 161 and
 162 .Aq Pa ifaddrs.h
 163 are being included,
 164 .Aq Pa net/if.h
 165 .Em must
 166 be included before
 167 .Aq Pa ifaddrs.h .