espressif/openthread
1
0
Fork 0
mirror of https://github.com/espressif/openthread.git synced 2026-08-03 17:37:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

[ip6] update otNetifAddress.mNext to be pointer to const (#9519)

Browse Source 
This commit contains the following smaller changes in `Ip6` and its
public APIs:

- Updates the `otNetifAddress.mNext` field to be a pointer to `const`.
  This prevents users of OT APIs from modifying addresses as they
  iterate over the list of addresses. The `otNetifMulticastAddress`
  structure already uses this model.

- Adds new API `otIp6HasUnicastAddress()` to check whether or not a
  unicast IPv6 address is assigned to the Thread interface. This is
  used to simplify CLI and `posix/platform/netif.cpp`.

- Fixes the returned error from `otIp6AddUnicastAddress()` to be
  `OT_ERROR_INVALID_ARGS` when the address is a Thread internal
  address, to match the documentation.

- Fixes documentation and style in `ip6.h`.
This commit is contained in:
Abtin Keshavarzian
2023-10-12 13:39:30 -07:00
committed by GitHub
parent fc307401a6
commit 094bae0e57
7 changed files with 55 additions and 57 deletions
Download Patch File Download Diff File Expand all files Collapse all files
include/openthread/instance.h
+1 -1
View File
@@ -53,7 +53,7 @@ extern "C" {
* @note This number versions both OpenThread platform and user APIs.
*
*/
#define OPENTHREAD_API_VERSION (364)
#define OPENTHREAD_API_VERSION (365)
/**
* @addtogroup api-instance
include/openthread/ip6.h
+28 -13
View File
@@ -144,6 +144,8 @@ struct otIp6Address
typedef struct otIp6Address otIp6Address;
/**
* @struct otIp6Prefix
*
* Represents an IPv6 prefix.
*
*/
@@ -178,15 +180,15 @@ enum
*/
typedef struct otNetifAddress
{
otIp6Address mAddress; ///< The IPv6 unicast address.
uint8_t mPrefixLength; ///< The Prefix length (in bits).
uint8_t mAddressOrigin; ///< The IPv6 address origin.
bool mPreferred : 1; ///< TRUE if the address is preferred, FALSE otherwise.
bool mValid : 1; ///< TRUE if the address is valid, FALSE otherwise.
bool mScopeOverrideValid : 1; ///< TRUE if the mScopeOverride value is valid, FALSE otherwise.
unsigned int mScopeOverride : 4; ///< The IPv6 scope of this address.
bool mRloc : 1; ///< TRUE if the address is an RLOC, FALSE otherwise.
struct otNetifAddress *mNext; ///< A pointer to the next network interface address.
otIp6Address mAddress; ///< The IPv6 unicast address.
uint8_t mPrefixLength; ///< The Prefix length (in bits).
uint8_t mAddressOrigin; ///< The IPv6 address origin.
bool mPreferred : 1; ///< TRUE if the address is preferred, FALSE otherwise.
bool mValid : 1; ///< TRUE if the address is valid, FALSE otherwise.
bool mScopeOverrideValid : 1; ///< TRUE if the mScopeOverride value is valid, FALSE otherwise.
unsigned int mScopeOverride : 4; ///< The IPv6 scope of this address.
bool mRloc : 1; ///< TRUE if the address is an RLOC, FALSE otherwise.
const struct otNetifAddress *mNext; ///< A pointer to the next network interface address.
} otNetifAddress;
/**
@@ -296,6 +298,7 @@ bool otIp6IsEnabled(otInstance *aInstance);
* @retval OT_ERROR_NONE Successfully added (or updated) the Network Interface Address.
* @retval OT_ERROR_INVALID_ARGS The IP Address indicated by @p aAddress is an internal address.
* @retval OT_ERROR_NO_BUFS The Network Interface is already storing the maximum allowed external addresses.
*
*/
otError otIp6AddUnicastAddress(otInstance *aInstance, const otNetifAddress *aAddress);
@@ -308,6 +311,7 @@ otError otIp6AddUnicastAddress(otInstance *aInstance, const otNetifAddress *aAdd
* @retval OT_ERROR_NONE Successfully removed the Network Interface Address.
* @retval OT_ERROR_INVALID_ARGS The IP Address indicated by @p aAddress is an internal address.
* @retval OT_ERROR_NOT_FOUND The IP Address indicated by @p aAddress was not found.
*
*/
otError otIp6RemoveUnicastAddress(otInstance *aInstance, const otIp6Address *aAddress);
@@ -317,9 +321,22 @@ otError otIp6RemoveUnicastAddress(otInstance *aInstance, const otIp6Address *aAd
* @param[in] aInstance A pointer to an OpenThread instance.
*
* @returns A pointer to the first Network Interface Address.
*
*/
const otNetifAddress *otIp6GetUnicastAddresses(otInstance *aInstance);
/**
* Indicates whether or not a unicast IPv6 address is assigned to the Thread interface.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aAddress A pointer to the unicast address.
*
* @retval TRUE If @p aAddress is assigned to the Thread interface.
* @retval FALSE If @p aAddress is not assigned to the Thread interface.
*
*/
bool otIp6HasUnicastAddress(otInstance *aInstance, const otIp6Address *aAddress);
/**
* Subscribes the Thread interface to a Network Interface Multicast Address.
*
@@ -450,8 +467,6 @@ typedef void (*otIp6ReceiveCallback)(otMessage *aMessage, void *aContext);
void otIp6SetReceiveCallback(otInstance *aInstance, otIp6ReceiveCallback aCallback, void *aCallbackContext);
/**
* @struct otIp6AddressInfo
*
* Represents IPv6 address information.
*
*/
@@ -528,7 +543,7 @@ void otIp6SetReceiveFilterEnabled(otInstance *aInstance, bool aEnabled);
* @retval OT_ERROR_INVALID_SOURCE_ADDRESS Source address is invalid, e.g. an anycast address or a multicast address.
* @retval OT_ERROR_PARSE Encountered a malformed header when processing the message.
* @retval OT_ERROR_INVALID_ARGS The message's metadata is invalid, e.g. the message uses
* `OT_MESSAGE_ORIGIN_THREAD_NETIF` as the origin.
* `OT_MESSAGE_ORIGIN_THREAD_NETIF` as the origin.
*
*/
otError otIp6Send(otInstance *aInstance, otMessage *aMessage);
@@ -849,7 +864,7 @@ otError otIp6RegisterMulticastListeners(otInstance *
/**
* Sets the Mesh Local IID (for test purpose).
*
* `OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE` must be enabled.
* Requires `OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE`.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aIid A pointer to the Mesh Local IID to set.
src/cli/cli.cpp
+1 -16
View File
@@ -6068,23 +6068,8 @@ template <> otError Interpreter::Process<Cmd("ping")>(Arg aArgs[])
SuccessOrExit(error = aArgs[1].ParseAsIp6Address(config.mSource));
#if !OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE
{
bool valid = false;
const otNetifAddress *unicastAddrs = otIp6GetUnicastAddresses(GetInstancePtr());
for (const otNetifAddress *addr = unicastAddrs; addr; addr = addr->mNext)
{
if (otIp6IsAddressEqual(&addr->mAddress, &config.mSource))
{
valid = true;
break;
}
}
VerifyOrExit(valid, error = OT_ERROR_INVALID_ARGS);
}
VerifyOrExit(otIp6HasUnicastAddress(GetInstancePtr(), &config.mSource), error = OT_ERROR_INVALID_ARGS);
#endif
aArgs += 2;
}
src/core/api/ip6_api.cpp
+5
View File
@@ -75,6 +75,11 @@ const otNetifAddress *otIp6GetUnicastAddresses(otInstance *aInstance)
return AsCoreType(aInstance).Get<ThreadNetif>().GetUnicastAddresses().GetHead();
}
bool otIp6HasUnicastAddress(otInstance *aInstance, const otIp6Address *aAddress)
{
return AsCoreType(aInstance).Get<ThreadNetif>().HasUnicastAddress(AsCoreType(aAddress));
}
otError otIp6AddUnicastAddress(otInstance *aInstance, const otNetifAddress *aAddress)
{
return AsCoreType(aInstance).Get<ThreadNetif>().AddExternalUnicastAddress(AsCoreType(aAddress));
src/core/net/netif.cpp
+1 -1
View File
@@ -424,7 +424,7 @@ Error Netif::AddExternalUnicastAddress(const UnicastAddress &aAddress)
if (entry != nullptr)
{
VerifyOrExit(IsUnicastAddressExternal(*entry), error = kErrorAlready);
VerifyOrExit(IsUnicastAddressExternal(*entry), error = kErrorInvalidArgs);
entry->mPrefixLength = aAddress.mPrefixLength;
entry->mAddressOrigin = aAddress.mAddressOrigin;
src/core/net/netif.hpp
+18 -2
View File
@@ -215,6 +215,22 @@ public:
*/
AddressOrigin GetOrigin(void) const { return static_cast<AddressOrigin>(mAddressOrigin); }
/**
* Returns the next unicast address.
*
* @returns A pointer to the next unicast address.
*
*/
const UnicastAddress *GetNext(void) const { return static_cast<const UnicastAddress *>(mNext); }
/**
* Returns the next unicast address.
*
* @returns A pointer to the next unicast address.
*
*/
UnicastAddress *GetNext(void) { return static_cast<UnicastAddress *>(AsNonConst(mNext)); }
private:
bool Matches(const Address &aAddress) const { return GetAddress() == aAddress; }
};
@@ -412,7 +428,7 @@ public:
*
* @param[in] aAddress A reference to the unicast address.
*
* @retval TRUE If @p aAddress is assigned to the network interface,
* @retval TRUE If @p aAddress is assigned to the network interface.
* @retval FALSE If @p aAddress is not assigned to the network interface.
*
*/
@@ -423,7 +439,7 @@ public:
*
* @param[in] aAddress A reference to the unicast address.
*
* @retval TRUE If @p aAddress is assigned to the network interface,
* @retval TRUE If @p aAddress is assigned to the network interface.
* @retval FALSE If @p aAddress is not assigned to the network interface.
*
*/
src/posix/platform/netif.cpp
+1 -24
View File
@@ -291,26 +291,6 @@ static bool sIsSyncingState = false;
#define OPENTHREAD_POSIX_LOG_TUN_PACKETS 0
#if !defined(__linux__)
static bool UnicastAddressIsSubscribed(otInstance *aInstance, const otNetifAddress *netAddr)
{
const otNetifAddress *address = otIp6GetUnicastAddresses(aInstance);
while (address != nullptr)
{
if (memcmp(address->mAddress.mFields.m8, netAddr->mAddress.mFields.m8, sizeof(address->mAddress.mFields.m8)) ==
0)
{
return true;
}
address = address->mNext;
}
return false;
}
#endif
#if defined(__APPLE__) || defined(__NetBSD__) || defined(__FreeBSD__)
static const uint8_t allOnes[] = {0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF};
@@ -1435,14 +1415,11 @@ static void processNetifAddrEvent(otInstance *aInstance, struct rt_msghdr *rtm)
if (!addr.IsMulticast())
{
otNetifAddress netAddr;
bool subscribed;
netAddr.mAddress = addr;
netAddr.mPrefixLength = NetmaskToPrefixLength(&netmask);
subscribed = UnicastAddressIsSubscribed(aInstance, &netAddr);
if (subscribed)
if (otIp6HasUnicastAddress(aInstance, &addr))
{
logAddrEvent(/* isAdd */ true, addr, OT_ERROR_ALREADY);
error = OT_ERROR_NONE;