ipv4_addr: initial import

Makefile.dep

@@ -205,6 +205,10 @@ ifneq (,$(filter newlib,$(USEMODULE)))
   USEMODULE += uart_stdio
 endif
 
+ifneq (,$(filter ipv6_addr,$(USEMODULE)))
+  USEMODULE += ipv4_addr
+endif
+
 ifneq (,$(filter posix,$(USEMODULE)))
   USEMODULE += timex
   USEMODULE += vtimer

sys/Makefile

@@ -16,6 +16,9 @@ endif
 ifneq (,$(filter oneway_malloc,$(USEMODULE)))
     DIRS += oneway-malloc
 endif
+ifneq (,$(filter ipv4_addr,$(USEMODULE)))
+    DIRS += net/network_layer/ipv4/addr
+endif
 ifneq (,$(filter ipv6_addr,$(USEMODULE)))
     DIRS += net/network_layer/ipv6/addr
 endif

sys/include/net/ipv4.h

@@ -0,0 +1,35 @@
+/*
+ * 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    IPv4
+ * @ingroup     net
+ * @brief       IPv4 types and helper functions
+ * @{
+ *
+ * @file
+ * @brief   IPv4 type and helper function definitions
+ *
+ * @author  Martine Lenders <mlenders@inf.fu-berlin.de>
+ */
+#ifndef IPV4_H_
+#define IPV4_H_
+
+#include "net/ipv4/addr.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* IPV4_H_ */
+/** @} */

sys/include/net/ipv4/addr.h

@@ -0,0 +1,91 @@
+/*
+ * 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 IPV4_ADDR_H_
+#define IPV4_ADDR_H_
+
+#include <stdbool.h>
+#include <stdint.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(ipv4_addr_t *a, ipv4_addr_t *b)
+{
+    return (a->u32.u32 == b->u32.u32);
+}
+
+/**
+ * @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[in] 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);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* IPV4_ADDR_H_ */
+/** @} */

sys/net/network_layer/ipv4/addr/Makefile

@@ -0,0 +1,3 @@
+MODULE = ipv4_addr
+
+include $(RIOTBASE)/Makefile.base

sys/net/network_layer/ipv4/addr/ipv4_addr_from_str.c

@@ -0,0 +1,78 @@
+/*
+ * 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.
+ */
+
+/**
+ * @{
+ *
+ * @file
+ */
+
+#include <stdlib.h>
+#include <string.h>
+
+#include "net/ipv4/addr.h"
+
+#define DEC     "0123456789"
+
+/* based on inet_pton4() by Paul Vixie */
+ipv4_addr_t *ipv4_addr_from_str(ipv4_addr_t *result, const char *addr)
+{
+    uint8_t saw_digit, octets, ch;
+    uint8_t tmp[sizeof(ipv4_addr_t)], *tp;
+
+    if ((result == NULL) || (addr == NULL)) {
+        return NULL;
+    }
+
+    saw_digit = 0;
+    octets = 0;
+    *(tp = tmp) = 0;
+
+    while ((ch = *addr++) != '\0') {
+        const char *pch;
+
+        if ((pch = strchr(DEC, ch)) != NULL) {
+            uint16_t new = *tp * 10 + (uint16_t)(pch - DEC);
+
+            if (new > 255) {
+                return NULL;
+            }
+
+            *tp = new;
+
+            if (!saw_digit) {
+                if (++octets > 4) {
+                    return NULL;
+                }
+
+                saw_digit = 1;
+            }
+        }
+        else if (ch == '.' && saw_digit) {
+            if (octets == 4) {
+                return NULL;
+            }
+
+            *++tp = 0;
+            saw_digit = 0;
+        }
+        else {
+            return NULL;
+        }
+    }
+
+    if (octets < 4) {
+        return NULL;
+    }
+
+    memcpy(result, tmp, sizeof(ipv4_addr_t));
+    return result;
+}
+
+
+/** @} */

sys/net/network_layer/ipv4/addr/ipv4_addr_to_str.c

@@ -0,0 +1,52 @@
+/*
+ * 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.
+ */
+
+/**
+ * @{
+ *
+ * @file
+ */
+
+#include <stdlib.h>
+
+#include "net/ipv4/addr.h"
+
+/* based on inet_ntop4() by Paul Vixie */
+char *ipv4_addr_to_str(char *result, const ipv4_addr_t *addr, uint8_t result_len)
+{
+    uint8_t n = 0;
+    char *next = result;
+
+    if ((result == NULL) || (addr == NULL) || (result_len < IPV4_ADDR_MAX_STR_LEN)) {
+        return NULL;
+    }
+
+    do {
+        uint8_t u = addr->u8[n];
+
+        if (u > 99) {
+            *next++ = '0' + u / 100;
+            u %= 100;
+            *next++ = '0' + u / 10;
+            u %= 10;
+        }
+        else if (u > 9) {
+            *next++ = '0' + u / 10;
+            u %= 10;
+        }
+
+        *next++ = '0' + u;
+        *next++ = '.';
+        n++;
+    } while (n < 4);
+
+    *--next = '\0';
+    return result;
+}
+
+/** @} */

sys/net/network_layer/ipv6/addr/ipv6_addr_from_str.c

@@ -31,65 +31,12 @@
 #include <string.h>
 
 #include "byteorder.h"
+#include "net/ipv4/addr.h"
 #include "net/ipv6/addr.h"
 
-#define DEC     "0123456789"
 #define HEX_L   "0123456789abcdef"
 #define HEX_U   "0123456789ABCDEF"
 
-/* XXX: move this to IPv4 when we have it */
-/* based on inet_pton4() by Paul Vixie */
-static network_uint32_t *ipv4_addr_from_str(network_uint32_t *result,
-        const char *addr)
-{
-    uint8_t saw_digit, octets, ch;
-    uint8_t tmp[sizeof(network_uint32_t)], *tp;
-
-    saw_digit = 0;
-    octets = 0;
-    *(tp = tmp) = 0;
-
-    while ((ch = *addr++) != '\0') {
-        const char *pch;
-
-        if ((pch = strchr(DEC, ch)) != NULL) {
-            uint16_t new = *tp * 10 + (uint16_t)(pch - DEC);
-
-            if (new > 255) {
-                return NULL;
-            }
-
-            *tp = new;
-
-            if (!saw_digit) {
-                if (++octets > 4) {
-                    return NULL;
-                }
-
-                saw_digit = 1;
-            }
-        }
-        else if (ch == '.' && saw_digit) {
-            if (octets == 4) {
-                return NULL;
-            }
-
-            *++tp = 0;
-            saw_digit = 0;
-        }
-        else {
-            return NULL;
-        }
-    }
-
-    if (octets < 4) {
-        return NULL;
-    }
-
-    memcpy(result, tmp, sizeof(network_uint32_t));
-    return result;
-}
-
 /* based on inet_pton6() by Paul Vixie */
 ipv6_addr_t *ipv6_addr_from_str(ipv6_addr_t *result, const char *addr)
 {
@@ -157,9 +104,9 @@ ipv6_addr_t *ipv6_addr_from_str(ipv6_addr_t *result, const char *addr)
         }
 
         if (ch == '.' && (i <= sizeof(ipv6_addr_t)) &&
-            ipv4_addr_from_str((network_uint32_t *)(&(result->u8[i])),
+            ipv4_addr_from_str((ipv4_addr_t *)(&(result->u8[i])),
                                curtok) != NULL) {
-            i += sizeof(network_uint32_t);
+            i += sizeof(ipv4_addr_t);
             saw_xdigit = 0;
             break;  /* '\0' was seen by ipv4_addr_from_str(). */
         }

sys/net/network_layer/ipv6/addr/ipv6_addr_to_str.c

@@ -30,50 +30,14 @@
 #include <string.h>
 
 #include "byteorder.h"
+#include "net/ipv4/addr.h"
 #include "net/ipv6/addr.h"
 
 /* Length of an IPv6 address in 16-bit words */
 #define IPV6_ADDR_WORD_LEN  (sizeof(ipv6_addr_t) / sizeof(uint16_t))
 
-#define IPV4_ADDR_MIN_STR_LEN   (sizeof("255.255.255.255"))
-
 #define HEX_L "0123456789abcdef"
 
-/* XXX: move this to IPv4 when we have it */
-/* based on inet_ntop4() by Paul Vixie */
-static char *ipv4_addr_to_str(char *result, const network_uint32_t *addr,
-                              uint8_t result_len)
-{
-    uint8_t n = 0;
-    char *next = result;
-
-    if (result_len < IPV4_ADDR_MIN_STR_LEN) {
-        return NULL;
-    }
-
-    do {
-        uint8_t u = addr->u8[n];
-
-        if (u > 99) {
-            *next++ = '0' + u / 100;
-            u %= 100;
-            *next++ = '0' + u / 10;
-            u %= 10;
-        }
-        else if (u > 9) {
-            *next++ = '0' + u / 10;
-            u %= 10;
-        }
-
-        *next++ = '0' + u;
-        *next++ = '.';
-        n++;
-    } while (n < 4);
-
-    *--next = '\0';
-    return result;
-}
-
 /* based on inet_ntop6() by Paul Vixie */
 char *ipv6_addr_to_str(char *result, const ipv6_addr_t *addr, uint8_t result_len)
 {
@@ -142,7 +106,8 @@ char *ipv6_addr_to_str(char *result, const ipv6_addr_t *addr, uint8_t result_len
         /* Is this address an encapsulated IPv4? */
         if (i == 6 && best.base == 0 &&
             (best.len == 6 || (best.len == 5 && addr->u16[5].u16 == 0xffff))) {
-            if (!ipv4_addr_to_str(tp, &addr->u32[3], sizeof(tmp) - (tp - tmp))) {
+            if (!ipv4_addr_to_str(tp, (const ipv4_addr_t *)&addr->u32[3],
+                                  sizeof(tmp) - (tp - tmp))) {
                 return (NULL);
             }