1.\" Copyright (c) 1983, 1991, 1993 2.\" The Regents of the University of California. All rights reserved. 3.\" 4.\" Redistribution and use in source and binary forms, with or without 5.\" modification, are permitted provided that the following conditions 6.\" are met: 7.\" 1. Redistributions of source code must retain the above copyright 8.\" notice, this list of conditions and the following disclaimer. 9.\" 2. Redistributions in binary form must reproduce the above copyright 10.\" notice, this list of conditions and the following disclaimer in the 11.\" documentation and/or other materials provided with the distribution. 12.\" 3. All advertising materials mentioning features or use of this software 13.\" must display the following acknowledgement: 14.\" This product includes software developed by the University of 15.\" California, Berkeley and its contributors. 16.\" 4. Neither the name of the University nor the names of its contributors 17.\" may be used to endorse or promote products derived from this software 18.\" without specific prior written permission. 19.\" 20.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 23.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 30.\" SUCH DAMAGE. 31.\" 32.\" From: @(#)rcmd.3 8.1 (Berkeley) 6/4/93 33.\" $FreeBSD$ 34.\" 35.Dd May 21, 1998 36.Dt IF_NAMETOINDEX 3 37.Os KAME 38.Sh NAME 39.Nm if_nametoindex , 40.Nm if_indextoname , 41.Nm if_nameindex , 42.Nm if_freenameindex 43.Nd convert interface index to name, and vice versa 44.Sh SYNOPSIS 45.Fd #include <sys/types.h> 46.Fd #include <sys/socket.h> 47.Fd #include <net/if.h> 48.Ft "unsigned int" 49.Fn if_nametoindex "const char *ifname" 50.Ft "char *" 51.Fn if_indextoname "unsigned int ifindex" "char *ifname" 52.Ft "struct if_nameindex *" 53.Fn if_nameindex "void" 54.Ft "void" 55.Fn if_freenameindex "struct if_nameindex *ptr" 56.Sh DESCRIPTION 57The functions map interface index to readable interface name 58.Po 59such as 60.Li ``lo0'' 61.Pc 62, and vice versa. 63.Pp 64.Fn if_nametoindex 65converts readable interface name to interface index 66.Pp positive integer value . 67If the specified interface does not exist, 0 will be returned. 68.Pp 69.Fn if_indextoname 70converts interface index to readable interface name. 71The 72.Fa ifname 73argument must point to a buffer of at least 74.Dv IF_NAMESIZE 75bytes into which the interface name corresponding to the specified index is 76returned. 77.Po 78.Dv IF_NAMESIZE 79is also defined in 80.Li <net/if.h> 81and its value includes a terminating null byte at the end of the 82interface name. 83.Pc 84This pointer is also the return value of the function. 85If there is no interface corresponding to the specified index, 86.Dv NULL 87is returned. 88.Pp 89.Fn if_nameindex 90returns an array of 91.Fa if_nameindex 92structures. 93.Fa if_nametoindex 94is also defined in 95.Li <net/if.h> , 96and is as follows: 97.Bd -literal -offset 98struct if_nameindex { 99 unsigned int if_index; /* 1, 2, ... */ 100 char *if_name; /* null terminated name: "le0", ... */ 101}; 102.Ed 103.Pp 104The end of the array of structures is indicated by a structure with 105an 106.Fa if_index 107of 0 and an 108.Fa if_name 109of 110.Dv NULL . 111The function returns a 112.Dv NULL 113pointer upon an error. 114The memory used for this array of structures along with the interface 115names pointed to by the 116.Fa if_name 117members is obtained dynamically. 118This memory is freed by the 119.Fn if_freenameindex 120function. 121.Pp 122.Fn if_freenameindex 123takes a pointer that was returned by 124.Fn if_nameindex 125as argument 126.Pq Fa ptr , 127and it reclaims the region allocated. 128.Sh DIAGNOSTICS 129.Fn if_nametoindex 130returns 0 on error, positive integer on success. 131.Fn if_indextoname 132and 133.Fn if_nameindex 134return 135.Dv NULL 136on errors. 137.Sh SEE ALSO 138R. Gilligan, S. Thomson, J. Bound, and W. Stevens, 139``Basic Socket Interface Extensions for IPv6,'' RFC2553, March 1999. 140.Sh HISTORY 141The implementation first appeared in WIDE Hydrangea IPv6 protocol stack kit. 142.Sh STANDARDS 143These functions are defined in ``Basic Socket Interface Extensions for IPv6'' 144.Pq RFC2533 . 145