mirror of
https://github.com/RIOT-OS/RIOT.git
synced 2024-12-29 04:50:03 +01:00
134 lines
3.6 KiB
C
134 lines
3.6 KiB
C
/*
|
|
* Copyright (C) 2015 Martine Lenders <mlenders@inf.fu-berlin.de>
|
|
*
|
|
* 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.
|
|
*/
|
|
|
|
/**
|
|
* @defgroup net_ipv4_addr IPv4 addresses
|
|
* @ingroup net_ipv4
|
|
* @brief IPv4 address types and helper function
|
|
* @{
|
|
*
|
|
* @file
|
|
* @brief IPv6 address type and helper functions definitions
|
|
*
|
|
* @author Martine Lenders <mlenders@inf.fu-berlin.de>
|
|
*/
|
|
#ifndef NET_IPV4_ADDR_H
|
|
#define NET_IPV4_ADDR_H
|
|
|
|
#include <stdbool.h>
|
|
#include <stdint.h>
|
|
#include <stddef.h>
|
|
|
|
#include "byteorder.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/**
|
|
* @brief Maximum length of an IPv4 address as string.
|
|
*/
|
|
#define IPV4_ADDR_MAX_STR_LEN (sizeof("255.255.255.255"))
|
|
|
|
/**
|
|
* @brief Data type to represent an IPv4 address.
|
|
*/
|
|
typedef union {
|
|
uint8_t u8[4]; /**< as 4 8-bit unsigned integer */
|
|
network_uint32_t u32; /**< as 32-bit unsigned integer */
|
|
} ipv4_addr_t;
|
|
|
|
/**
|
|
* @brief Checks if two IPv4 addresses are equal.
|
|
*
|
|
* @param[in] a An IPv4 address.
|
|
* @param[in] b Another IPv4 address.
|
|
*
|
|
* @return true, if @p a and @p b are equal
|
|
* @return false, otherwise.
|
|
*/
|
|
static inline bool ipv4_addr_equal(const ipv4_addr_t *a, const ipv4_addr_t *b)
|
|
{
|
|
return (a->u32.u32 == b->u32.u32);
|
|
}
|
|
|
|
/**
|
|
* @brief Check if @p addr is a multicast address.
|
|
*
|
|
* @see <a href="https://www.rfc-editor.org/rfc/rfc1112.html#section-4">
|
|
* RFC 1112, section 4
|
|
* </a>
|
|
*
|
|
* @param[in] addr An IPv4 address.
|
|
*
|
|
* @return true, if @p addr is multicast address,
|
|
* @return false, otherwise.
|
|
*/
|
|
static inline bool ipv4_addr_is_multicast(const ipv4_addr_t *addr)
|
|
{
|
|
return (addr->u8[0] >= 0xE0 && addr->u8[0] <= 0xEF);
|
|
}
|
|
|
|
/**
|
|
* @brief Converts an IPv4 address to its string representation
|
|
*
|
|
* @param[out] result The resulting string representation of at least
|
|
* @ref IPV4_ADDR_MAX_STR_LEN.
|
|
* @param[in] addr An IPv4 address
|
|
* @param[in] result_len Length of @p result
|
|
*
|
|
* @return @p result, on success
|
|
* @return NULL, if @p result_len was lesser than IPV4_ADDR_MAX_STR_LEN
|
|
* @return NULL, if @p result or @p addr was NULL
|
|
*/
|
|
char *ipv4_addr_to_str(char *result, const ipv4_addr_t *addr, uint8_t result_len);
|
|
|
|
/**
|
|
* @brief Converts an IPv4 address string representation to a byte-represented
|
|
* IPv4 address
|
|
*
|
|
* @param[out] result The resulting byte representation
|
|
* @param[in] addr An IPv4 address string representation
|
|
*
|
|
* @return @p result, on success
|
|
* @return NULL, if @p addr was malformed
|
|
* @return NULL, if @p result or @p addr was NULL
|
|
*/
|
|
ipv4_addr_t *ipv4_addr_from_str(ipv4_addr_t *result, const char *addr);
|
|
|
|
/**
|
|
* @brief Converts an IPv4 address from a buffer of characters to a
|
|
* byte-represented IPv4 address
|
|
*
|
|
* @note @p addr_len should be between 0 and IPV4_ADDR_MAX_STR_LEN
|
|
*
|
|
* @param[out] result The resulting byte representation
|
|
* @param[in] addr An IPv4 address string representation
|
|
* @param[in] addr_len The amount of characters to parse
|
|
*
|
|
* @return @p result, on success
|
|
* @return NULL, if @p addr was malformed
|
|
* @return NULL, if @p result or @p addr was NULL
|
|
*/
|
|
ipv4_addr_t *ipv4_addr_from_buf(ipv4_addr_t *result, const char *addr,
|
|
size_t addr_len);
|
|
|
|
/**
|
|
* @brief Print IPv4 address to stdout
|
|
*
|
|
* @param[in] addr Pointer to ipv6_addr_t to print
|
|
*/
|
|
void ipv4_addr_print(const ipv4_addr_t *addr);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* NET_IPV4_ADDR_H */
|
|
/** @} */
|