netif.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2016 Kaspar Schleiser <kaspar@schleiser.de>
 * SPDX-FileCopyrightText: 2017 Freie Universität Berlin
 * SPDX-License-Identifier: LGPL-2.1-only
 */
 
#pragma once
 
#include <stdint.h>
#include <string.h>
#include <unistd.h>
 
#include "list.h"
#include "net/netopt.h"
#include "net/ipv6.h"
 
#ifdef MODULE_NETSTATS_NEIGHBOR
#include "cib.h"
#include "net/netstats.h"
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
#ifndef CONFIG_NETIF_NAMELENMAX
#define CONFIG_NETIF_NAMELENMAX    (8U)
#endif
typedef struct {
    list_node_t node;               
#ifdef MODULE_NETSTATS_NEIGHBOR
    netstats_nb_table_t neighbors;  
#endif
} netif_t;
 
netif_t *netif_iter(const netif_t *last);
 
int netif_get_name(const netif_t *netif, char *name);
 
int16_t netif_get_id(const netif_t *netif);
 
netif_t *netif_get_by_name_buffer(const char *name, size_t name_len);
 
static inline netif_t *netif_get_by_name(const char *name)
{
    return netif_get_by_name_buffer(name, strlen(name));
}
 
netif_t *netif_get_by_id(int16_t id);
 
int netif_get_opt(const netif_t *netif, netopt_t opt, uint16_t context,
                  void *value, size_t max_len);
 
int netif_set_opt(const netif_t *netif, netopt_t opt, uint16_t context,
                  void *value, size_t value_len);
 
int netif_register(netif_t *netif);
 
static inline ssize_t netif_get_ipv6(netif_t *netif, ipv6_addr_t *dest,
                                     size_t numof)
{
    int res = netif_get_opt(netif, NETOPT_IPV6_ADDR, 0, dest, sizeof(*dest) * numof);
    if (res < 0) {
        /* standard says at ssize_t's value range is [-1, SSIZE_MAX], so do
         * not rely on smaller numbers that -1 being passed through correctly */
        return -1;
    }
 
    return res / sizeof(*dest);
}
 
ssize_t netifs_get_ipv6(ipv6_addr_t *dest, size_t numof);
 
void netif_print_ipv6(netif_t *netif, const char *separator);
 
void netifs_print_ipv6(const char *separator);
 
#ifdef __cplusplus
}
#endif