network: modernize Mac[8,16,48,64]Address

Author: TommyPec

src/network/utils/mac16-address.cc

@@ -51,14 +51,14 @@ void
 Mac16Address::CopyFrom(const uint8_t buffer[2])
 {
     NS_LOG_FUNCTION(this << &buffer);
-    memcpy(m_address, buffer, 2);
+    std::copy(buffer, buffer + 2, m_address.begin());
 }
 
 void
 Mac16Address::CopyTo(uint8_t buffer[2]) const
 {
     NS_LOG_FUNCTION(this << &buffer);
-    memcpy(buffer, m_address, 2);
+    std::copy(m_address.begin(), m_address.end(), buffer);
 }
 
 bool
@@ -80,15 +80,15 @@ Mac16Address::ConvertFrom(const Address& address)
     NS_LOG_FUNCTION(address);
     NS_ASSERT(address.CheckCompatible(GetType(), 2));
     Mac16Address retval;
-    address.CopyTo(retval.m_address);
+    address.CopyTo(retval.m_address.data());
     return retval;
 }
 
 Address
 Mac16Address::ConvertTo() const
 {
     NS_LOG_FUNCTION(this);
-    return Address(GetType(), m_address, 2);
+    return Address(GetType(), m_address.data(), 2);
 }
 
 uint16_t
@@ -180,19 +180,16 @@ Mac16Address::IsMulticast() const
 std::ostream&
 operator<<(std::ostream& os, const Mac16Address& address)
 {
-    uint8_t ad[2];
-    address.CopyTo(ad);
-
+    std::ios_base::fmtflags ff = os.flags();
     os.setf(std::ios::hex, std::ios::basefield);
-    os.fill('0');
-    for (uint8_t i = 0; i < 1; i++)
-    {
-        os << std::setw(2) << (uint32_t)ad[i] << ":";
-    }
-    // Final byte not suffixed by ":"
-    os << std::setw(2) << (uint32_t)ad[1];
-    os.setf(std::ios::dec, std::ios::basefield);
-    os.fill(' ');
+    auto fill = os.fill('0');
+
+    os << std::setw(2) << static_cast<uint32_t>(address.m_address[0]) << ":";
+    os << std::setw(2) << static_cast<uint32_t>(address.m_address[1]);
+
+    os.flags(ff); // Restore stream flags
+    os.fill(fill);
+
     return os;
 }
 

src/network/utils/mac16-address.h

@@ -14,6 +14,8 @@
 #include "ns3/attribute-helper.h"
 #include "ns3/attribute.h"
 
+#include <array>
+#include <compare>
 #include <ostream>
 #include <stdint.h>
 
@@ -165,39 +167,21 @@ class Mac16Address
      */
     bool IsMulticast() const;
 
-  private:
-    /**
-     * @brief Return the Type of address.
-     * @return type of address
-     */
-    static uint8_t GetType();
-
-    /**
-     * @brief Equal to operator.
-     *
-     * @param a the first operand
-     * @param b the first operand
-     * @returns true if the operands are equal
-     */
-    friend bool operator==(const Mac16Address& a, const Mac16Address& b);
-
     /**
-     * @brief Not equal to operator.
+     * Spaceship comparison operator. All the other comparison operators
+     * are automatically generated from this one.
      *
-     * @param a the first operand
-     * @param b the first operand
-     * @returns true if the operands are not equal
+     * @param other address to compare to this one
+     * @returns The result of the comparison.
      */
-    friend bool operator!=(const Mac16Address& a, const Mac16Address& b);
+    constexpr std::strong_ordering operator<=>(const Mac16Address& other) const = default;
 
+  private:
     /**
-     * @brief Less than operator.
-     *
-     * @param a the first operand
-     * @param b the first operand
-     * @returns true if the operand a is less than operand b
+     * @brief Return the Type of address.
+     * @return type of address
      */
-    friend bool operator<(const Mac16Address& a, const Mac16Address& b);
+    static uint8_t GetType();
 
     /**
      * @brief Stream insertion operator.
@@ -217,30 +201,12 @@ class Mac16Address
      */
     friend std::istream& operator>>(std::istream& is, Mac16Address& address);
 
-    static uint64_t m_allocationIndex; //!< Address allocation index
-    uint8_t m_address[2]{0};           //!< Address value
+    static uint64_t m_allocationIndex;  //!< Address allocation index
+    std::array<uint8_t, 2> m_address{}; //!< Address value
 };
 
 ATTRIBUTE_HELPER_HEADER(Mac16Address);
 
-inline bool
-operator==(const Mac16Address& a, const Mac16Address& b)
-{
-    return memcmp(a.m_address, b.m_address, 2) == 0;
-}
-
-inline bool
-operator!=(const Mac16Address& a, const Mac16Address& b)
-{
-    return memcmp(a.m_address, b.m_address, 2) != 0;
-}
-
-inline bool
-operator<(const Mac16Address& a, const Mac16Address& b)
-{
-    return memcmp(a.m_address, b.m_address, 2) < 0;
-}
-
 std::ostream& operator<<(std::ostream& os, const Mac16Address& address);
 std::istream& operator>>(std::istream& is, Mac16Address& address);
 

src/network/utils/mac48-address.cc

@@ -51,14 +51,14 @@ void
 Mac48Address::CopyFrom(const uint8_t buffer[6])
 {
     NS_LOG_FUNCTION(this << &buffer);
-    std::memcpy(m_address, buffer, 6);
+    std::copy(buffer, buffer + 6, m_address.begin());
 }
 
 void
 Mac48Address::CopyTo(uint8_t buffer[6]) const
 {
     NS_LOG_FUNCTION(this << &buffer);
-    std::memcpy(buffer, m_address, 6);
+    std::copy(m_address.begin(), m_address.end(), buffer);
 }
 
 bool
@@ -78,7 +78,7 @@ Address
 Mac48Address::ConvertTo() const
 {
     NS_LOG_FUNCTION(this);
-    return Address(GetType(), m_address, 6);
+    return Address(GetType(), m_address.data(), 6);
 }
 
 Mac48Address
@@ -87,7 +87,7 @@ Mac48Address::ConvertFrom(const Address& address)
     NS_LOG_FUNCTION(&address);
     NS_ASSERT(address.CheckCompatible(GetType(), 6));
     Mac48Address retval;
-    address.CopyTo(retval.m_address);
+    address.CopyTo(retval.m_address.data());
     return retval;
 }
 
@@ -229,19 +229,20 @@ Mac48Address::GetMulticast(Ipv6Address addr)
 std::ostream&
 operator<<(std::ostream& os, const Mac48Address& address)
 {
-    uint8_t ad[6];
-    address.CopyTo(ad);
-
+    std::ios_base::fmtflags ff = os.flags();
     os.setf(std::ios::hex, std::ios::basefield);
-    os.fill('0');
-    for (uint8_t i = 0; i < 5; i++)
-    {
-        os << std::setw(2) << (uint32_t)ad[i] << ":";
-    }
-    // Final byte not suffixed by ":"
-    os << std::setw(2) << (uint32_t)ad[5];
-    os.setf(std::ios::dec, std::ios::basefield);
-    os.fill(' ');
+    auto fill = os.fill('0');
+
+    os << std::setw(2) << static_cast<uint32_t>(address.m_address[0]) << ":";
+    os << std::setw(2) << static_cast<uint32_t>(address.m_address[1]) << ":";
+    os << std::setw(2) << static_cast<uint32_t>(address.m_address[2]) << ":";
+    os << std::setw(2) << static_cast<uint32_t>(address.m_address[3]) << ":";
+    os << std::setw(2) << static_cast<uint32_t>(address.m_address[4]) << ":";
+    os << std::setw(2) << static_cast<uint32_t>(address.m_address[5]);
+
+    os.flags(ff); // Restore stream flags
+    os.fill(fill);
+
     return os;
 }
 

src/network/utils/mac48-address.h

@@ -14,6 +14,8 @@
 #include "ns3/attribute-helper.h"
 #include "ns3/attribute.h"
 
+#include <array>
+#include <compare>
 #include <ostream>
 #include <stdint.h>
 
@@ -149,39 +151,21 @@ class Mac48Address
      */
     typedef void (*TracedCallback)(Mac48Address value);
 
-  private:
-    /**
-     * @brief Return the Type of address.
-     * @return type of address
-     */
-    static uint8_t GetType();
-
-    /**
-     * @brief Equal to operator.
-     *
-     * @param a the first operand
-     * @param b the first operand
-     * @returns true if the operands are equal
-     */
-    friend bool operator==(const Mac48Address& a, const Mac48Address& b);
-
     /**
-     * @brief Not equal to operator.
+     * Spaceship comparison operator. All the other comparison operators
+     * are automatically generated from this one.
      *
-     * @param a the first operand
-     * @param b the first operand
-     * @returns true if the operands are not equal
+     * @param other address to compare to this one
+     * @returns The result of the comparison.
      */
-    friend bool operator!=(const Mac48Address& a, const Mac48Address& b);
+    constexpr std::strong_ordering operator<=>(const Mac48Address& other) const = default;
 
+  private:
     /**
-     * @brief Less than operator.
-     *
-     * @param a the first operand
-     * @param b the first operand
-     * @returns true if the operand a is less than operand b
+     * @brief Return the Type of address.
+     * @return type of address
      */
-    friend bool operator<(const Mac48Address& a, const Mac48Address& b);
+    static uint8_t GetType();
 
     /**
      * @brief Stream insertion operator.
@@ -201,30 +185,12 @@ class Mac48Address
      */
     friend std::istream& operator>>(std::istream& is, Mac48Address& address);
 
-    static uint64_t m_allocationIndex; //!< Address allocation index
-    uint8_t m_address[6]{0};           //!< Address value
+    static uint64_t m_allocationIndex;  //!< Address allocation index
+    std::array<uint8_t, 6> m_address{}; //!< Address value
 };
 
 ATTRIBUTE_HELPER_HEADER(Mac48Address);
 
-inline bool
-operator==(const Mac48Address& a, const Mac48Address& b)
-{
-    return memcmp(a.m_address, b.m_address, 6) == 0;
-}
-
-inline bool
-operator!=(const Mac48Address& a, const Mac48Address& b)
-{
-    return memcmp(a.m_address, b.m_address, 6) != 0;
-}
-
-inline bool
-operator<(const Mac48Address& a, const Mac48Address& b)
-{
-    return memcmp(a.m_address, b.m_address, 6) < 0;
-}
-
 std::ostream& operator<<(std::ostream& os, const Mac48Address& address);
 std::istream& operator>>(std::istream& is, Mac48Address& address);
 

src/network/utils/mac64-address.cc

@@ -66,14 +66,14 @@ void
 Mac64Address::CopyFrom(const uint8_t buffer[8])
 {
     NS_LOG_FUNCTION(this << &buffer);
-    std::memcpy(m_address, buffer, 8);
+    std::copy(buffer, buffer + 8, m_address.begin());
 }
 
 void
 Mac64Address::CopyTo(uint8_t buffer[8]) const
 {
     NS_LOG_FUNCTION(this << &buffer);
-    std::memcpy(buffer, m_address, 8);
+    std::copy(m_address.begin(), m_address.end(), buffer);
 }
 
 bool
@@ -95,15 +95,15 @@ Mac64Address::ConvertFrom(const Address& address)
     NS_LOG_FUNCTION(address);
     NS_ASSERT(address.CheckCompatible(GetType(), 8));
     Mac64Address retval;
-    address.CopyTo(retval.m_address);
+    address.CopyTo(retval.m_address.data());
     return retval;
 }
 
 Address
 Mac64Address::ConvertTo() const
 {
     NS_LOG_FUNCTION(this);
-    return Address(GetType(), m_address, 8);
+    return Address(GetType(), m_address.data(), 8);
 }
 
 uint64_t
@@ -164,19 +164,22 @@ Mac64Address::GetType()
 std::ostream&
 operator<<(std::ostream& os, const Mac64Address& address)
 {
-    uint8_t ad[8];
-    address.CopyTo(ad);
-
+    std::ios_base::fmtflags ff = os.flags();
     os.setf(std::ios::hex, std::ios::basefield);
-    os.fill('0');
-    for (uint8_t i = 0; i < 7; i++)
-    {
-        os << std::setw(2) << (uint32_t)ad[i] << ":";
-    }
-    // Final byte not suffixed by ":"
-    os << std::setw(2) << (uint32_t)ad[7];
-    os.setf(std::ios::dec, std::ios::basefield);
-    os.fill(' ');
+    auto fill = os.fill('0');
+
+    os << std::setw(2) << static_cast<uint32_t>(address.m_address[0]) << ":";
+    os << std::setw(2) << static_cast<uint32_t>(address.m_address[1]) << ":";
+    os << std::setw(2) << static_cast<uint32_t>(address.m_address[2]) << ":";
+    os << std::setw(2) << static_cast<uint32_t>(address.m_address[3]) << ":";
+    os << std::setw(2) << static_cast<uint32_t>(address.m_address[4]) << ":";
+    os << std::setw(2) << static_cast<uint32_t>(address.m_address[5]) << ":";
+    os << std::setw(2) << static_cast<uint32_t>(address.m_address[6]) << ":";
+    os << std::setw(2) << static_cast<uint32_t>(address.m_address[7]);
+
+    os.flags(ff); // Restore stream flags
+    os.fill(fill);
+
     return os;
 }