[netif] remove multicast promiscuous mode configuration

Since 74c833b was introduced all IPv6 multicast packets are passed to the host. Previously used promiscuous mode configuration is now unused. This commit removes the dead code and corresponding elements as there is no use case for them at the moment (and they can confuse a user). Signed-off-by: Konrad Derda <[email protected]>
konradderda · Jun 4, 2024 · d69bc5d · d69bc5d
1 parent ea61703
commit d69bc5d
Show file tree

Hide file tree

Showing 7 changed files with 1 addition and 84 deletions.
diff --git a/include/openthread/instance.h b/include/openthread/instance.h
@@ -53,7 +53,7 @@ extern "C" {
  * @note This number versions both OpenThread platform and user APIs.
  *
  */
-#define OPENTHREAD_API_VERSION (417)
+#define OPENTHREAD_API_VERSION (418)
 
 /**
  * @addtogroup api-instance

diff --git a/include/openthread/ip6.h b/include/openthread/ip6.h
@@ -381,27 +381,6 @@ otError otIp6UnsubscribeMulticastAddress(otInstance *aInstance, const otIp6Addre
  */
 const otNetifMulticastAddress *otIp6GetMulticastAddresses(otInstance *aInstance);
 
-/**
- * Checks if multicast promiscuous mode is enabled on the Thread interface.
- *
- * @param[in]  aInstance A pointer to an OpenThread instance.
- *
- * @sa otIp6SetMulticastPromiscuousEnabled
- *
- */
-bool otIp6IsMulticastPromiscuousEnabled(otInstance *aInstance);
-
-/**
- * Enables or disables multicast promiscuous mode on the Thread interface.
- *
- * @param[in]  aInstance  A pointer to an OpenThread instance.
- * @param[in]  aEnabled   TRUE to enable Multicast Promiscuous mode, FALSE otherwise.
- *
- * @sa otIp6IsMulticastPromiscuousEnabled
- *
- */
-void otIp6SetMulticastPromiscuousEnabled(otInstance *aInstance, bool aEnabled);
-
 /**
  * Allocate a new message buffer for sending an IPv6 message.
  *

diff --git a/src/cli/cli.cpp b/src/cli/cli.cpp
@@ -3365,35 +3365,6 @@ template <> otError Interpreter::Process<Cmd("ipmaddr")>(Arg aArgs[])
         SuccessOrExit(error = aArgs[1].ParseAsIp6Address(address));
         error = otIp6UnsubscribeMulticastAddress(GetInstancePtr(), &address);
     }
-    /**
-     * @cli ipmaddr promiscuous
-     * @code
-     * ipmaddr promiscuous
-     * Disabled
-     * Done
-     * @endcode
-     * @par api_copy
-     * #otIp6IsMulticastPromiscuousEnabled
-     */
-    else if (aArgs[0] == "promiscuous")
-    {
-        /**
-         * @cli ipmaddr promiscuous (enable,disable)
-         * @code
-         * ipmaddr promiscuous enable
-         * Done
-         * @endcode
-         * @code
-         * ipmaddr promiscuous disable
-         * Done
-         * @endcode
-         * @cparam ipmaddr promiscuous @ca{enable|disable}
-         * @par api_copy
-         * #otIp6SetMulticastPromiscuousEnabled
-         */
-        error =
-            ProcessEnableDisable(aArgs + 1, otIp6IsMulticastPromiscuousEnabled, otIp6SetMulticastPromiscuousEnabled);
-    }
     /**
      * @cli ipmaddr llatn
      * @code

diff --git a/src/core/api/ip6_api.cpp b/src/core/api/ip6_api.cpp
@@ -105,16 +105,6 @@ otError otIp6UnsubscribeMulticastAddress(otInstance *aInstance, const otIp6Addre
     return AsCoreType(aInstance).Get<ThreadNetif>().UnsubscribeExternalMulticast(AsCoreType(aAddress));
 }
 
-bool otIp6IsMulticastPromiscuousEnabled(otInstance *aInstance)
-{
-    return AsCoreType(aInstance).Get<ThreadNetif>().IsMulticastPromiscuousEnabled();
-}
-
-void otIp6SetMulticastPromiscuousEnabled(otInstance *aInstance, bool aEnabled)
-{
-    AsCoreType(aInstance).Get<ThreadNetif>().SetMulticastPromiscuous(aEnabled);
-}
-
 void otIp6SetReceiveCallback(otInstance *aInstance, otIp6ReceiveCallback aCallback, void *aCallbackContext)
 {
     AsCoreType(aInstance).Get<Ip6::Ip6>().SetReceiveDatagramCallback(aCallback, aCallbackContext);

diff --git a/src/core/net/ip6.cpp b/src/core/net/ip6.cpp
@@ -1122,10 +1122,6 @@ Error Ip6::HandleDatagram(OwnedPtr<Message> aMessagePtr, bool aIsReassembled)
         {
             receive = true;
         }
-        else if (Get<ThreadNetif>().IsMulticastPromiscuousEnabled())
-        {
-            forwardHost = true;
-        }
     }
     else
     {

diff --git a/src/core/net/netif.cpp b/src/core/net/netif.cpp
@@ -85,7 +85,6 @@ const otNetifMulticastAddress Netif::kLinkLocalAllRoutersMulticastAddress = {
 
 Netif::Netif(Instance &aInstance)
     : InstanceLocator(aInstance)
-    , mMulticastPromiscuous(false)
 {
 }
 

diff --git a/src/core/net/netif.hpp b/src/core/net/netif.hpp
@@ -612,23 +612,6 @@ class Netif : public InstanceLocator, private NonCopyable
      */
     void UnsubscribeAllExternalMulticastAddresses(void);
 
-    /**
-     * Checks if multicast promiscuous mode is enabled on the network interface.
-     *
-     * @retval TRUE   If the multicast promiscuous mode is enabled.
-     * @retval FALSE  If the multicast promiscuous mode is disabled.
-     *
-     */
-    bool IsMulticastPromiscuousEnabled(void) const { return mMulticastPromiscuous; }
-
-    /**
-     * Enables multicast promiscuous mode on the network interface.
-     *
-     * @param[in]  aEnabled  TRUE if Multicast Promiscuous mode is enabled, FALSE otherwise.
-     *
-     */
-    void SetMulticastPromiscuous(bool aEnabled) { mMulticastPromiscuous = aEnabled; }
-
     /**
      * Enables range-based `for` loop iteration over external multicast addresses on the Netif that matches
      * a given IPv6 address type filter.
@@ -702,7 +685,6 @@ class Netif : public InstanceLocator, private NonCopyable
 
     LinkedList<UnicastAddress>   mUnicastAddresses;
     LinkedList<MulticastAddress> mMulticastAddresses;
-    bool                         mMulticastPromiscuous;
 
     Callback<otIp6AddressCallback> mAddressCallback;
-Original file line number
+Diff line change
@@ Expand Up @@
             {
                 receive = true;
             }
-            else if (Get<ThreadNetif>().IsMulticastPromiscuousEnabled())
-            {
-                forwardHost = true;
-            }
         }
         else
         {
@@ Expand Down @@