internet: remove Ipv4InterfaceAddress::SetBroadcast and optimize the broadcast address handling

Author: TommyPec

CHANGES.md

@@ -30,6 +30,7 @@ This file is a best-effort approach to solving this issue; we will do our best b
 * A new static function `Ipv[4,6]Address::CheckCompatible()` has been added to safely check if a string can be parsed as an IPv4 or IPv6 address.
 * (network): The address class comparison is now based on std::strong_ordering operator<=> comparison operator.
 * (network): An empty (uninitialized) Address is now printed as "00-00:00".
+* (internet): The function `Ipv4InterfaceAddress::SetBroadcast` has been removed from the codebase because the broadcast address must be built from the IP address and mask.
 
 ### Changes to build system
 

src/internet/model/ipv4-interface-address.cc

@@ -34,13 +34,11 @@ Ipv4InterfaceAddress::Ipv4InterfaceAddress(Ipv4Address local, Ipv4Mask mask)
         m_scope = HOST;
     }
     m_mask = mask;
-    m_broadcast = Ipv4Address(local.Get() | (~mask.Get()));
 }
 
 Ipv4InterfaceAddress::Ipv4InterfaceAddress(const Ipv4InterfaceAddress& o)
     : m_local(o.m_local),
       m_mask(o.m_mask),
-      m_broadcast(o.m_broadcast),
       m_scope(o.m_scope),
       m_secondary(o.m_secondary)
 {
@@ -87,18 +85,11 @@ Ipv4InterfaceAddress::GetMask() const
     return m_mask;
 }
 
-void
-Ipv4InterfaceAddress::SetBroadcast(Ipv4Address broadcast)
-{
-    NS_LOG_FUNCTION(this << broadcast);
-    m_broadcast = broadcast;
-}
-
 Ipv4Address
 Ipv4InterfaceAddress::GetBroadcast() const
 {
     NS_LOG_FUNCTION(this);
-    return m_broadcast;
+    return Ipv4Address(m_local.Get() | (~m_mask.Get()));
 }
 
 void

src/internet/model/ipv4-interface-address.h

@@ -101,16 +101,13 @@ class Ipv4InterfaceAddress
      * @param mask the network mask
      */
     void SetMask(Ipv4Mask mask);
+
     /**
      * @brief Get the network mask
      * @returns the network mask
      */
     Ipv4Mask GetMask() const;
-    /**
-     * @brief Set the broadcast address
-     * @param broadcast the broadcast address
-     */
-    void SetBroadcast(Ipv4Address broadcast);
+
     /**
      * @brief Get the broadcast address
      * @returns the broadcast address
@@ -157,8 +154,7 @@ class Ipv4InterfaceAddress
     Ipv4Address m_local; //!< Interface address
     // Note:  m_peer may be added in future when necessary
     // Ipv4Address m_peer;   // Peer destination address (in Linux:  m_address)
-    Ipv4Mask m_mask;         //!< Network mask
-    Ipv4Address m_broadcast; //!< Broadcast address
+    Ipv4Mask m_mask; //!< Network mask
 
     InterfaceAddressScope_e m_scope; //!< Address scope
     bool m_secondary;                //!< For use in multihoming
@@ -194,15 +190,15 @@ std::ostream& operator<<(std::ostream& os, const Ipv4InterfaceAddress& addr);
 inline bool
 operator==(const Ipv4InterfaceAddress& a, const Ipv4InterfaceAddress& b)
 {
-    return (a.m_local == b.m_local && a.m_mask == b.m_mask && a.m_broadcast == b.m_broadcast &&
-            a.m_scope == b.m_scope && a.m_secondary == b.m_secondary);
+    return (a.m_local == b.m_local && a.m_mask == b.m_mask && a.m_scope == b.m_scope &&
+            a.m_secondary == b.m_secondary);
 }
 
 inline bool
 operator!=(const Ipv4InterfaceAddress& a, const Ipv4InterfaceAddress& b)
 {
-    return (a.m_local != b.m_local || a.m_mask != b.m_mask || a.m_broadcast != b.m_broadcast ||
-            a.m_scope != b.m_scope || a.m_secondary != b.m_secondary);
+    return (a.m_local != b.m_local || a.m_mask != b.m_mask || a.m_scope != b.m_scope ||
+            a.m_secondary != b.m_secondary);
 }
 
 } // namespace ns3