GETIFADDRS - Linux手册页

时间:2019-08-20 18:00:22  来源:igfitidea点击:

Linux程序员手册 第3部分
更新日期: 2020-04-11

名称

getifaddrs,freeifaddrs-获取接口地址

语法

#include <sys/types.h>
#include <ifaddrs.h>

int getifaddrs(struct ifaddrs **ifap);

void freeifaddrs(struct ifaddrs *ifa);

说明

getifaddrs()函数创建描述本地系统网络接口的结构的链接列表,并将列表第一项的地址存储在* ifap中。该列表由ifaddrs结构组成,定义如下:

struct ifaddrs {
    struct ifaddrs  *ifa_next;    /* Next item in list */
    char            *ifa_name;    /* Name of interface */
    unsigned int     ifa_flags;   /* Flags from SIOCGIFFLAGS */
    struct sockaddr *ifa_addr;    /* Address of interface */
    struct sockaddr *ifa_netmask; /* Netmask of interface */
    union {
        struct sockaddr *ifu_broadaddr;
                         /* Broadcast address of interface */
        struct sockaddr *ifu_dstaddr;
                         /* Point-to-point destination address */
    } ifa_ifu;
#define              ifa_broadaddr ifa_ifu.ifu_broadaddr
#define              ifa_dstaddr   ifa_ifu.ifu_dstaddr
    void            *ifa_data;    /* Address-specific data */
};

ifa_next字段包含一个指向列表下一个结构的指针,如果这是列表的最后一项,则为NULL。

ifa_name指向以空值终止的接口名称。

ifa_flags字段包含接口标志,由SIOCGIFFLAGS ioctl(2)操作返回(有关这些标志的列表,请参见netdevice(7))。

ifa_addr字段指向包含接口地址的结构。 (应咨询sa_family子字段以确定地址结构的格式。)此字段可能包含空指针。

ifa_netmask字段指向包含与ifa_addr关联的网络掩码的结构(如果适用于地址族)。该字段可以包含空指针。

根据是否在ifa_flags中设置了IFF_BROADCAST或IFF_POINTOPOINT位(一次只能设置一个),ifa_broadaddr将包含与ifa_addr关联的广播地址(如果适用于地址族),或者ifa_dstaddr将包含该地址的目标地址。点对点接口。

ifa_data字段指向一个包含特定于地址族的数据的缓冲区;如果此接口没有此类数据,则此字段可以为NULL。

getifaddrs()返回的数据是动态分配的,应在不再需要时使用freeifaddrs()释放。

返回值

成功时,getifaddrs()返回零;否则,返回0。如果出错,则返回-1,并正确设置errno。

错误说明

getifaddrs()可能会失败,并为为socket(2),bind(2),getsockname(2),recvmsg(2),sendto(2),malloc(3)或realloc(3)指定的任何错误设置errno。 。

版本

getifaddrs()函数首先出现在glibc 2.3中,但在glibc 2.3.3之前,该实现仅支持IPv4地址;它只支持IPv4地址。在glibc 2.3.3中添加了对IPv6的支持。 IPv4以外的地址族的支持仅在支持netlink的内核上可用。

属性

有关本节中使用的术语的说明,请参见attribute(7)。

InterfaceAttributeValue
getifaddrs(),freeifaddrs()Thread safetyMT-Safe

遵循规范

不在POSIX.1中。此功能首先出现在BSDi中,并出现在BSD系统中,但是其语义有所记录,即每个接口而不是每个地址返回一个条目。这意味着如果接口没有地址,则ifa_addr和其他字段实际上可以为NULL,如果接口分配了IP地址,则不返回链接级地址。同样,在各种系统上选择ifa_broadaddr或ifa_dstaddr的方式也有所不同。

备注

在Linux上返回的地址通常是分配给接口的IPv4和IPv6地址,但每个接口一个AF_PACKET地址也包含有关接口及其物理层的下层详细信息。在这种情况下,ifa_data字段可能包含一个指向rtnl_link_stats的指针,该指针在中定义(在Linux 2.4和更早版本中,struct net_device_stats在linux中定义),其中包含各种接口属性和统计信息。

示例

下面的程序演示了getifaddrs(),freeifaddrs()和getnameinfo(3)的用法。这是我们在一个系统上运行该程序时看到的内容:

$ ./a.out
lo       AF_PACKET (17)
                tx_packets =        524; rx_packets =        524
                tx_bytes   =      38788; rx_bytes   =      38788
wlp3s0   AF_PACKET (17)
                tx_packets =     108391; rx_packets =     130245
                tx_bytes   =   30420659; rx_bytes   =   94230014
em1      AF_PACKET (17)
                tx_packets =          0; rx_packets =          0
                tx_bytes   =          0; rx_bytes   =          0
lo       AF_INET (2)
                address: <127.0.0.1>
wlp3s0   AF_INET (2)
                address: <192.168.235.137>
lo       AF_INET6 (10)
                address: <::1>
wlp3s0   AF_INET6 (10)
                address: <fe80::7ee9:d3ff:fef5:1a91%wlp3s0>

Program source

#define _GNU_SOURCE     /* To get defns of NI_MAXSERV and NI_MAXHOST */
#include <arpa/inet.h>
#include <sys/socket.h>
#include <netdb.h>
#include <ifaddrs.h>
#include <stdio.h>
#include <stdlib.h>
#include <unistd.h>
#include <linux/if_link.h>

int main(int argc, char *argv[])
{
    struct ifaddrs *ifaddr, *ifa;
    int family, s;
    char host[NI_MAXHOST];

    if (getifaddrs(&ifaddr) == -1) {
        perror("getifaddrs");
        exit(EXIT_FAILURE);
    }

    /* Walk through linked list, maintaining head pointer so we
       can free list later */

    for (ifa = ifaddr; ifa != NULL; ifa = ifa->ifa_next) {
        if (ifa->ifa_addr == NULL)
            continue;

        family = ifa->ifa_addr->sa_family;

        /* Display interface name and family (including symbolic
           form of the latter for the common families) */

        printf("%-8s %s (%d)\n",
               ifa->ifa_name,
               (family == AF_PACKET) ? "AF_PACKET" :
               (family == AF_INET) ? "AF_INET" :
               (family == AF_INET6) ? "AF_INET6" : "???",
               family);

        /* For an AF_INET* interface address, display the address */

        if (family == AF_INET || family == AF_INET6) {
            s = getnameinfo(ifa->ifa_addr,
                    (family == AF_INET) ? sizeof(struct sockaddr_in) :
                                          sizeof(struct sockaddr_in6),
                    host, NI_MAXHOST,
                    NULL, 0, NI_NUMERICHOST);
            if (s != 0) {
                printf("getnameinfo() failed: %s\n", gai_strerror(s));
                exit(EXIT_FAILURE);
            }

            printf("\t\taddress: <%s>\n", host);

        } else if (family == AF_PACKET && ifa->ifa_data != NULL) {
            struct rtnl_link_stats *stats = ifa->ifa_data;

            printf("\t\ttx_packets = %10u; rx_packets = %10u\n"
                   "\t\ttx_bytes   = %10u; rx_bytes   = %10u\n",
                   stats->tx_packets, stats->rx_packets,
                   stats->tx_bytes, stats->rx_bytes);
        }
    }

    freeifaddrs(ifaddr);
    exit(EXIT_SUCCESS);
}

另外参见

bind(2),getsockname(2),socket(2),packet(7),ifconfig(8)

出版信息

这个页面是Linux手册页项目5.08版的一部分。有关项目的说明、有关报告错误的信息以及此页面的最新版本,请访问https://www.kernel.org/doc/man-pages/