RIOT/sys/posix/include/arpa/inet.h

/*
 * Copyright (C) 2013-15 Freie Universität Berlin
 *
 * This file is subject to the terms and conditions of the GNU Lesser
 * General Public License v2.1. See the file LICENSE in the top level
 * directory for more details.
 */

/**
 * @addtogroup  pnet
 * @{
 */

/**
 * @file
 * @brief   Definitions for internet operations
 * @see     <a href="http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/arpa_inet.h.html">
 *              The Open Group Base Specifications Issue 7, <arpa/inet.h>
 *          </a>
 *
 * @author  Martine Lenders <mlenders@inf.fu-berlin.de>
 */
#ifndef ARPA_INET_H
#define ARPA_INET_H

#include <errno.h>
#include <inttypes.h>
#include <stdio.h>

#include "byteorder.h"
#include "net/af.h"
#include "net/ipv4/addr.h"
#include "net/ipv6/addr.h"
#include "socket_base/socket.h"

#ifdef __cplusplus
extern "C" {
#endif

typedef uint16_t in_port_t;         /**< Internet port type */
typedef uint32_t in_addr_t;         /**< IPv4 address type */

/**
 * @brief   Alias to @ref IPV4_ADDR_MAX_STR_LEN
 */
#ifndef INET_ADDRSTRLEN
#define INET_ADDRSTRLEN     (IPV4_ADDR_MAX_STR_LEN)
#endif

/**
 * @brief   Alias to @ref IPV6_ADDR_MAX_STR_LEN
 */
#ifndef INET6_ADDRSTRLEN
#define INET6_ADDRSTRLEN    (IPV6_ADDR_MAX_STR_LEN)
#endif

/**
 * @brief   Size in byte of an IPv4 address
 */
#ifndef INADDRSZ
#define INADDRSZ            (sizeof(ipv4_addr_t))
#endif

/**
 * @brief   Size in byte of an IPv6 address
 */
#ifndef IN6ADDRSZ
#define IN6ADDRSZ           (sizeof(ipv6_addr_t))
#endif


/**
 * @brief   IPv4 address structure type.
 */
struct in_addr {
    in_addr_t s_addr;       ///< an IPv4 address
};

/**
 * @brief   Convert values between host and network byte order.
 *
 * @see <a href="http://pubs.opengroup.org/onlinepubs/9699919799/functions/htonl.html">
 *          The Open Group Base Specification Issue 7, htonl
 *      </a>
 *
 * @param[in] hostlong  A 32 bit number.
 * @return              The argument value converted from host to network byte
 *                      order.
 */
#define htonl(hostlong)     HTONL(hostlong)

/**
 * @brief   Convert values between host and network byte order.
 *
 * @see <a href="http://pubs.opengroup.org/onlinepubs/9699919799/functions/htons.html">
 *          The Open Group Base Specification Issue 7, htons
 *      </a>
 *
 * @param[in] hostshort A 16 bit number.
 * @return              The argument value converted from host to network byte
 *                      order.
 */
#define htons(hostshort)    HTONS(hostshort)

/**
 * @brief   Convert values between host and network byte order.
 *
 * @see <a href="http://pubs.opengroup.org/onlinepubs/9699919799/functions/ntohl.html">
 *          The Open Group Base Specification Issue 7, ntohl
 *      </a>
 *
 * @param[in] netlong   A 32-bit integer number.
 * @return              The argument value converted from network to host byte
 *                      order.
 */
#define ntohl(netlong)      NTOHL(netlong)

/**
 * @brief   Convert values between host and network byte order.
 *
 * @see <a href="http://pubs.opengroup.org/onlinepubs/9699919799/functions/ntohs.html">
 *          The Open Group Base Specification Issue 7, ntohs
 *      </a>
 *
 * @param[in] netshort  A 16-bit integer number.
 * @return              The argument value converted from network to host byte
 *                      order.
 */
#define ntohs(netshort)     NTOHS(netshort)

/**
 * @brief   Converts an IP address to its string representation
 *
 * @pre (af == AF_INET) || (af == AF_INET6)
 *
 * @param[in] af    Address family of @p src. Must be @ref AF_INET or @ref AF_INET6.
 * @param[in] src   An IP address.
 * @param[out] dst  The resulting string representation.
 * @param[in] size  Length of @p result.
 *
 * @return  @p dst, on success
 * @return  NULL, if @p size was smaller than needed
 * @return  NULL, if @p src or @p dst was NULL
 */
static inline const char *inet_ntop(int af, const void *restrict src, char *restrict dst,
                                    socklen_t size)
{
    switch (af) {
#ifdef MODULE_IPV4_ADDR
        case AF_INET:
            if (ipv4_addr_to_str(dst, src, (size_t)size) == NULL) {
                errno = ENOSPC;
                return NULL;
            }
            break;
#endif
#ifdef MODULE_IPV6_ADDR
        case AF_INET6:
            if (ipv6_addr_to_str(dst, src, (size_t)size) == NULL) {
                errno = ENOSPC;
                return NULL;
            }
            break;
#endif
        default:
            (void)src;
            (void)dst;
            (void)size;
            errno = EAFNOSUPPORT;
            return NULL;
    }
    return dst;
}

/**
 * @brief   Converts an IP address string representation to a byte-represented
 *          IP address
 *
 * @pre (af == AF_INET) || (af == AF_INET6)
 *
 * @param[in] af    Address family of @p src. Must be @ref AF_INET or @ref AF_INET6.
 * @param[in] src   An IP address string representation
 * @param[out] dst   The resulting byte representation
 *
 * @return  1, on success.
 * @return  0, if @p src was malformed or input pointers were NULL.
 * @return  -1, if @p af is not supported.
 */
static inline int inet_pton(int af, const char *src, void *dst)
{
    switch (af) {
#ifdef MODULE_IPV4_ADDR
        case AF_INET:
            if (ipv4_addr_from_str(dst, src) == NULL) {
                return 0;
            }
            break;
#endif
#ifdef MODULE_IPV6_ADDR
        case AF_INET6:
            if (ipv6_addr_from_str(dst, src) == NULL) {
                return 0;
            }
            break;
#endif
        default:
            (void)src;
            (void)dst;
            errno = EAFNOSUPPORT;
            return -1;
    }
    return 1;
}

#ifdef __cplusplus
}
#endif

/**
 * @}
 */
#endif /* ARPA_INET_H */