From 609e011dc5ad3b59661b1a7ad6171bb86846c3c5 Mon Sep 17 00:00:00 2001
From: Abtin Keshavarzian <abtink@google.com>
Date: Sat, 11 Nov 2017 17:15:29 -0800
Subject: [PATCH] [childinfo] include array of registered IPv6 addresses in
 otChildInfo (#2326)

This commit adds new fields in `otChildInfo` to include the array
of registered IPv6 addresses by the child.
---
 include/openthread/thread_ftd.h |  3 +--
 include/openthread/types.h      |  2 ++
 src/core/thread/mle_router.cpp  |  3 +++
 src/core/thread/topology.hpp    | 27 +++++++++++++++++++--------
 4 files changed, 25 insertions(+), 10 deletions(-)

diff --git a/include/openthread/thread_ftd.h b/include/openthread/thread_ftd.h
index 6cdcfc279..c7d947f8a 100644
--- a/include/openthread/thread_ftd.h
+++ b/include/openthread/thread_ftd.h
@@ -363,8 +363,7 @@ OTAPI otError OTCALL otThreadGetChildInfoById(otInstance *aInstance, uint16_t aC
  * @sa otGetMaxAllowedChildren
  *
  */
-OTAPI otError OTCALL otThreadGetChildInfoByIndex(otInstance *aInstance, uint8_t aChildIndex,
-                                                 otChildInfo *aChildInfo);
+OTAPI otError OTCALL otThreadGetChildInfoByIndex(otInstance *aInstance, uint8_t aChildIndex, otChildInfo *aChildInfo);
 
 /**
  * Get the current Router ID Sequence.
diff --git a/include/openthread/types.h b/include/openthread/types.h
index 8d88ef185..65010fc91 100644
--- a/include/openthread/types.h
+++ b/include/openthread/types.h
@@ -963,6 +963,8 @@ typedef struct
     bool           mSecureDataRequest : 1; ///< Secure Data Requests
     bool           mFullFunction : 1;      ///< Full Function Device
     bool           mFullNetworkData : 1;   ///< Full Network Data
+    uint8_t        mIp6AddressesLength;    ///< Number of entries in IPv6 address array.
+    const otIp6Address *mIp6Addresses;     ///< Array of IPv6 addresses (unused entries contain unspecified address).
 } otChildInfo;
 
 /**
diff --git a/src/core/thread/mle_router.cpp b/src/core/thread/mle_router.cpp
index a39d72d5d..e3087ea2b 100644
--- a/src/core/thread/mle_router.cpp
+++ b/src/core/thread/mle_router.cpp
@@ -3759,6 +3759,9 @@ otError MleRouter::GetChildInfo(Child &aChild, otChildInfo &aChildInfo)
     aChildInfo.mFullFunction      = aChild.IsFullThreadDevice();
     aChildInfo.mFullNetworkData   = aChild.IsFullNetworkData();
 
+    aChildInfo.mIp6AddressesLength = Child::kMaxIp6AddressPerChild;
+    aChildInfo.mIp6Addresses       = aChild.GetIp6Addresses();
+
 exit:
     return error;
 }
diff --git a/src/core/thread/topology.hpp b/src/core/thread/topology.hpp
index ce95c313a..c0a881efd 100644
--- a/src/core/thread/topology.hpp
+++ b/src/core/thread/topology.hpp
@@ -370,10 +370,21 @@ public:
      */
     void ClearIp6Addresses(void) { memset(mIp6Address, 0, sizeof(mIp6Address)); }
 
+    /**
+     * This method gets the IPv6 address array.
+     *
+     * The array contains `kMaxIp6AddressPerChild` entries. Unused address entries contain unspecified address (all
+     * zeros).
+     *
+     * @returns A pointer to the first entry of IPv6 address array.
+     *
+     */
+    const Ip6::Address *GetIp6Addresses(void) const { return mIp6Address; }
+
     /**
      * This method gets the IPv6 address at index @p aIndex.
      *
-     * @param[in]  aIndex  The index into the IPv6 address list.
+     * @param[in]  aIndex  The index into the IPv6 address array.
      *
      * @returns A reference to the IPv6 address entry at index @p aIndex.
      *
@@ -381,15 +392,15 @@ public:
     Ip6::Address &GetIp6Address(uint8_t aIndex) { return mIp6Address[aIndex]; }
 
     /**
-     * This method searches for a given IPv6 address in the child's IPv6 address list and provides the index of the
-     * address in the list if it is found.
+     * This method searches for a given IPv6 address in the child's IPv6 address array and provides the index of the
+     * address in the array if it is found.
      *
-     * @param[in]  aAddress           The IPv6 address to search for in the IPv6 address list.
+     * @param[in]  aAddress           The IPv6 address to search for in the IPv6 address array.
      * @param[out] aIndex             Pointer to variable where the index of address is provided if address is found in
-     *                                the list. @p aIndex can be set NULL if index is not required.
+     *                                the array. @p aIndex can be set NULL if index is not required.
      *
-     * @retval OT_ERROR_NONE          Successfully found the address in IPv6 address list and updated @p aIndex.
-     * @retval OT_ERROR_NOT_FOUND     Could not find the address in the list.
+     * @retval OT_ERROR_NONE          Successfully found the address in IPv6 address array and updated @p aIndex.
+     * @retval OT_ERROR_NOT_FOUND     Could not find the address in the array.
      *
      */
     otError FindIp6Address(const Ip6::Address &aAddress, uint8_t *aIndex) const;
@@ -397,7 +408,7 @@ public:
     /**
      * This method removes the address at index @p aIndex.
      *
-     * @param[in] aIndex   The index into the IPv6 address list.
+     * @param[in] aIndex   The index into the IPv6 address array.
      *
      */
     void RemoveIp6Address(uint8_t aIndex);