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.4 2006/05/26 19:39:37 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
37 .Fn getifaddrs "struct ifaddrs **ifap"
39 .Fn freeifaddrs "struct ifaddrs *ifp"
43 function stores a reference to a linked list of the network interfaces
44 on the local machine in the memory referenced by
48 structures, as defined in the include file
52 structure contains at least the following entries:
54 struct ifaddrs *ifa_next; /* Pointer to next struct */
55 char *ifa_name; /* Interface name */
56 u_int ifa_flags; /* Interface flags */
57 struct sockaddr *ifa_addr; /* Interface address */
58 struct sockaddr *ifa_netmask; /* Interface netmask */
59 struct sockaddr *ifa_broadaddr; /* Interface broadcast address */
60 struct sockaddr *ifa_dstaddr; /* P2P interface destination */
61 void *ifa_data; /* Address specific data */
66 field contains a pointer to the next structure on the list.
69 in last structure on the list.
73 field contains the interface name.
77 field contains the interface flags, as set by
83 field references either the address of the interface or the link level
84 address of the interface, if one exists, otherwise it is NULL.
89 field should be consulted to determine the format of the
95 field references the netmask associated with
97 if one is set, otherwise it is NULL.
102 which should only be referenced for non-P2P interfaces,
103 references the broadcast address associated with
105 if one exists, otherwise it is NULL.
109 field references the destination address on a P2P interface,
110 if one exists, otherwise it is NULL.
114 field references address family specific data. For
116 addresses it contains a pointer to the
118 (as defined in include file
120 which contains various interface attributes and statistics.
121 For all other address families, it contains a pointer to the
123 (as defined in include file
125 which contains per-address interface statistics.
129 is dynamically allocated and should be freed using
131 when no longer needed.
139 for any of the errors specified for the library routines
154 implementation first appeared in BSDi