man3/if_nameindex.3

   1 .\" Copyright (c) 2012 YOSHIFUJI Hideaki <yoshfuji@linux-ipv6.org>
   2 .\" and Copyright (c) 2012 Michael Kerrisk <mtk.manpages@gmail.com>
   3 .\"
   4 .\" %%%LICENSE_START(VERBATIM)
   5 .\" Permission is granted to make and distribute verbatim copies of this
   6 .\" manual provided the copyright notice and this permission notice are
   7 .\" preserved on all copies.
   8 .\"
   9 .\" Permission is granted to copy and distribute modified versions of
  10 .\" this manual under the conditions for verbatim copying, provided that
  11 .\" the entire resulting derived work is distributed under the terms of
  12 .\" a permission notice identical to this one.
  13 .\"
  14 .\" Since the Linux kernel and libraries are constantly changing, this
  15 .\" manual page may be incorrect or out-of-date.  The author(s) assume
  16 .\" no responsibility for errors or omissions, or for damages resulting
  17 .\" from the use of the information contained herein.  The author(s) may
  18 .\" not have taken the same level of care in the production of this
  19 .\" manual, which is licensed free of charge, as they might when working
  20 .\" professionally.
  21 .\"
  22 .\" Formatted or processed versions of this manual, if unaccompanied by
  23 .\" the source, must acknowledge the copyright and authors of this work.
  24 .\" %%%LICENSE_END
  25 .\"
  26 .TH IF_NAMEINDEX 3 2021-03-22 "GNU" "Linux Programmer's Manual"
  27 .SH NAME
  28 if_nameindex, if_freenameindex \- get network interface names and indexes
  29 .SH SYNOPSIS
  30 .nf
  31 .B #include <net/if.h>
  32 .PP
  33 .BI "struct if_nameindex *if_nameindex(" void );
  34 .BI "void if_freenameindex(struct if_nameindex *" "ptr" );
  35 .fi
  36 .SH DESCRIPTION
  37 The
  38 .BR if_nameindex ()
  39 function returns an array of
  40 .I if_nameindex
  41 structures, each containing information
  42 about one of the network interfaces on the local system.
  43 The
  44 .I if_nameindex
  45 structure contains at least the following entries:
  46 .PP
  47 .in +4n
  48 .EX
  49 unsigned int if_index; /* Index of interface (1, 2, ...) */
  50 char        *if_name;  /* Null\-terminated name ("eth0", etc.) */
  51 .EE
  52 .in
  53 .PP
  54 The
  55 .I if_index
  56 field contains the interface index.
  57 The
  58 .I if_name
  59 field points to the null-terminated interface name.
  60 The end of the array is indicated by entry with
  61 .I if_index
  62 set to zero and
  63 .I if_name
  64 set to NULL.
  65 .PP
  66 The data structure returned by
  67 .BR if_nameindex ()
  68 is dynamically allocated and should be freed using
  69 .BR if_freenameindex ()
  70 when no longer needed.
  71 .SH RETURN VALUE
  72 On success,
  73 .BR if_nameindex ()
  74 returns pointer to the array;
  75 on error, NULL is returned, and
  76 .I errno
  77 is set to indicate the error.
  78 .SH ERRORS
  79 .BR if_nameindex ()
  80 may fail and set
  81 .I errno
  82 if:
  83 .TP
  84 .B ENOBUFS
  85 Insufficient resources available.
  86 .PP
  87 .BR if_nameindex ()
  88 may also fail for any of the errors specified for
  89 .BR socket (2),
  90 .BR bind (2),
  91 .BR ioctl (2),
  92 .BR getsockname (2),
  93 .BR recvmsg (2),
  94 .BR sendto (2),
  95 or
  96 .BR malloc (3).
  97 .SH VERSIONS
  98 The
  99 .BR if_nameindex ()
 100 function first appeared in glibc 2.1, but before glibc 2.3.4,
 101 the implementation supported only interfaces with IPv4 addresses.
 102 Support of interfaces that don't have IPv4 addresses is available only
 103 on kernels that support netlink.
 104 .SH ATTRIBUTES
 105 For an explanation of the terms used in this section, see
 106 .BR attributes (7).
 107 .ad l
 108 .nh
 109 .TS
 110 allbox;
 111 lbx lb lb
 112 l l l.
 113 Interface       Attribute       Value
 114 T{
 115 .BR if_nameindex (),
 116 .BR if_freenameindex ()
 117 T}      Thread safety   MT-Safe
 118 .TE
 119 .hy
 120 .ad
 121 .sp 1
 122 .SH CONFORMING TO
 123 POSIX.1-2001, POSIX.1-2008, RFC\ 3493.
 124 .PP
 125 This function first appeared in BSDi.
 126 .SH EXAMPLES
 127 The program below demonstrates the use of the functions described
 128 on this page.
 129 An example of the output this program might produce is the following:
 130 .PP
 131 .in +4n
 132 .EX
 133 $ \fB./a.out\fI
 134 1: lo
 135 2: wlan0
 136 3: em1
 137 .EE
 138 .in
 139 .SS Program source
 140 .EX
 141 #include <net/if.h>
 142 #include <stdio.h>
 143 #include <stdlib.h>
 144 #include <unistd.h>
 145
 146 int
 147 main(int argc, char *argv[])
 148 {
 149     struct if_nameindex *if_ni, *i;
 150
 151     if_ni = if_nameindex();
 152     if (if_ni == NULL) {
 153         perror("if_nameindex");
 154         exit(EXIT_FAILURE);
 155     }
 156
 157     for (i = if_ni; ! (i\->if_index == 0 && i\->if_name == NULL); i++)
 158         printf("%u: %s\en", i\->if_index, i\->if_name);
 159
 160     if_freenameindex(if_ni);
 161
 162     exit(EXIT_SUCCESS);
 163 }
 164 .EE
 165 .SH SEE ALSO
 166 .BR getsockopt (2),
 167 .BR setsockopt (2),
 168 .BR getifaddrs (3),
 169 .BR if_indextoname (3),
 170 .BR if_nametoindex (3),
 171 .BR ifconfig (8)