gnrc_sock_internal.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2016 Martine Lenders <mlenders@inf.fu-berlin.de>
 * SPDX-License-Identifier: LGPL-2.1-only
 */
 
#pragma once

 
#include <stdbool.h>
#include <stdint.h>
#include <string.h>
#include "mbox.h"
#include "net/af.h"
#include "net/gnrc.h"
#include "net/gnrc/netreg.h"
#include "net/iana/portrange.h"
#include "net/sock/ip.h"
 
#include "sock_types.h"
 
#ifdef __cplusplus
extern "C" {
#endif

#define GNRC_SOCK_DYN_PORTRANGE_MIN (IANA_DYNAMIC_PORTRANGE_MIN)
#define GNRC_SOCK_DYN_PORTRANGE_MAX (IANA_DYNAMIC_PORTRANGE_MAX)

#define GNRC_SOCK_DYN_PORTRANGE_NUM (GNRC_SOCK_DYN_PORTRANGE_MAX - GNRC_SOCK_DYN_PORTRANGE_MIN + 1)

#define GNRC_SOCK_DYN_PORTRANGE_ERR (0)

#ifndef CONFIG_GNRC_SOCK_UDP_CHECK_REMOTE_ADDR
#define CONFIG_GNRC_SOCK_UDP_CHECK_REMOTE_ADDR (1)
#endif

typedef struct {
#if IS_USED(MODULE_SOCK_AUX_LOCAL) || DOXYGEN
    sock_ip_ep_t *local;
#endif
#if IS_USED(MODULE_SOCK_AUX_TIMESTAMP) || DOXYGEN
    uint64_t *timestamp;    
#endif
#if IS_USED(MODULE_SOCK_AUX_RSSI) || DOXYGEN
    int16_t *rssi;          
#endif
    uint8_t flags;
} gnrc_sock_recv_aux_t;
 
#define GNRC_SOCK_RECV_AUX_FLAG_TIMESTAMP   0x01    
#define GNRC_SOCK_RECV_AUX_FLAG_RSSI        0x02    

static inline bool gnrc_af_not_supported(int af)
{
    /* TODO: add AF_INET support */
    return (af != AF_INET6);
}

static inline bool gnrc_ep_addr_any(const sock_ip_ep_t *ep)
{
    assert(ep != NULL);
    const uint8_t *p = (uint8_t *)&ep->addr;
    for (uint8_t i = 0; i < sizeof(ep->addr); i++) {
        if (p[i] != 0) {
            return false;
        }
    }
    return true;
}

static inline void gnrc_ep_set(sock_ip_ep_t *out, const sock_ip_ep_t *in,
                               size_t in_size)
{
    memcpy(out, in, in_size);
    if (out->netif != SOCK_ADDR_ANY_NETIF) {
        return;
    }
 
    /* set interface implicitly */
    gnrc_netif_t *netif = gnrc_netif_iter(NULL);
    if ((netif != NULL) &&
        (gnrc_netif_highlander() || (gnrc_netif_iter(netif) == NULL))) {
        out->netif = netif->pid;
    }
}

void gnrc_sock_create(gnrc_sock_reg_t *reg, gnrc_nettype_t type, uint32_t demux_ctx);

ssize_t gnrc_sock_recv(gnrc_sock_reg_t *reg, gnrc_pktsnip_t **pkt, uint32_t timeout,
                       sock_ip_ep_t *remote, gnrc_sock_recv_aux_t *aux);

ssize_t gnrc_sock_send(gnrc_pktsnip_t *payload, sock_ip_ep_t *local,
                       const sock_ip_ep_t *remote, uint8_t nh);
 
#ifdef __cplusplus
}
#endif