1 .\" $FreeBSD: src/lib/libc/net/getifaddrs.3,v 1.1.2.5 2001/12/14 18:33:55 ru Exp $
2 .\" $DragonFly: src/lib/libc/net/getifaddrs.3,v 1.5 2007/08/18 20:48:47 swildner Exp $
3 .\" $KAME: getifaddrs.3,v 1.4 2000/05/17 14:13:14 itojun Exp $
4 .\" BSDI getifaddrs.3,v 2.5 2000/02/23 14:51:59 dab Exp
6 .\" Copyright (c) 1995, 1999
7 .\" Berkeley Software Design, Inc. All rights reserved.
9 .\" Redistribution and use in source and binary forms, with or without
10 .\" modification, are permitted provided that the following conditions
12 .\" 1. Redistributions of source code must retain the above copyright
13 .\" notice, this list of conditions and the following disclaimer.
15 .\" THIS SOFTWARE IS PROVIDED BY Berkeley Software Design, Inc. ``AS IS'' AND
16 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 .\" ARE DISCLAIMED. IN NO EVENT SHALL Berkeley Software Design, Inc. BE LIABLE
19 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 .Nd get interface addresses
39 .Fn getifaddrs "struct ifaddrs **ifap"
41 .Fn freeifaddrs "struct ifaddrs *ifp"
45 function stores a reference to a linked list of the network interfaces
46 on the local machine in the memory referenced by
50 structures, as defined in the include file
54 structure contains at least the following entries:
56 struct ifaddrs *ifa_next; /* Pointer to next struct */
57 char *ifa_name; /* Interface name */
58 u_int ifa_flags; /* Interface flags */
59 struct sockaddr *ifa_addr; /* Interface address */
60 struct sockaddr *ifa_netmask; /* Interface netmask */
61 struct sockaddr *ifa_broadaddr; /* Interface broadcast address */
62 struct sockaddr *ifa_dstaddr; /* P2P interface destination */
63 void *ifa_data; /* Address specific data */
68 field contains a pointer to the next structure on the list.
71 in last structure on the list.
75 field contains the interface name.
79 field contains the interface flags, as set by
85 field references either the address of the interface or the link level
86 address of the interface, if one exists, otherwise it is NULL.
91 field should be consulted to determine the format of the
97 field references the netmask associated with
99 if one is set, otherwise it is NULL.
104 which should only be referenced for non-P2P interfaces,
105 references the broadcast address associated with
107 if one exists, otherwise it is NULL.
111 field references the destination address on a P2P interface,
112 if one exists, otherwise it is NULL.
116 field references address family specific data. For
118 addresses it contains a pointer to the
120 (as defined in include file
122 which contains various interface attributes and statistics.
123 For all other address families, it contains a pointer to the
125 (as defined in include file
127 which contains per-address interface statistics.
131 is dynamically allocated and should be freed using
133 when no longer needed.
141 for any of the errors specified for the library routines
156 implementation first appeared in BSDi