[diag] Add network diagnostic data: definition and analysis

supported TLVs:
- Ipv6addressList
- ChildIpv6AddressList
- Mode
- ChildTable
- LeaderData
- Route64
- MacCounters
- Eui64
- ExtMacAddress
- MacAddress

include/commissioner/network_diag_data.hpp

@@ -0,0 +1,187 @@
+/*
+ *    Copyright (c) 2024, The OpenThread Commissioner Authors.
+ *    All rights reserved.
+ *
+ *    Redistribution and use in source and binary forms, with or without
+ *    modification, are permitted provided that the following conditions are met:
+ *    1. Redistributions of source code must retain the above copyright
+ *       notice, this list of conditions and the following disclaimer.
+ *    2. Redistributions in binary form must reproduce the above copyright
+ *       notice, this list of conditions and the following disclaimer in the
+ *       documentation and/or other materials provided with the distribution.
+ *    3. Neither the name of the copyright holder nor the
+ *       names of its contributors may be used to endorse or promote products
+ *       derived from this software without specific prior written permission.
+ *
+ *    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ *    AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ *    IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ *    ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ *    LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ *    CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ *    SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ *    INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ *    CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ *    ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ *    POSSIBILITY OF SUCH DAMAGE.
+ */
+
+/**
+ * @file
+ *   This file defines the types of Thread Network Diagnostic TLVs used for network diagnostics.
+ */
+
+#ifndef OT_COMM_NETWORK_DIAG_TLVS_HPP_
+#define OT_COMM_NETWORK_DIAG_TLVS_HPP_
+
+#include <cstddef>
+#include <cstdint>
+#include <stdbool.h>
+#include <string>
+#include <vector>
+
+#include "defines.hpp"
+#include "error.hpp"
+
+#define CHILD_TABLE_ENTRY_BYTES 3
+#define IPV6_ADDRESS_BYTES 16
+#define LEADER_DATA_BYTES 8
+#define MAC_COUNTERS_BYTES 36
+#define RLOC16_BYTES 2
+#define ROUTER_ID_MASK_BYTES 8
+
+namespace ot {
+
+namespace commissioner {
+
+/**
+ * @brief Mode Data
+ */
+struct ModeData
+{
+    bool mIsRxOnWhenIdleMode          = false;
+    bool mIsMtd                       = false;
+    bool mIsStableNetworkDataRequired = false;
+};
+
+/**
+ * @brief Child Entry in Child Table
+ */
+struct ChildTableEntry
+{
+    uint32_t mTimeout             = 0;
+    uint8_t  mIncomingLinkQuality = 0;
+    uint16_t mChildId             = 0;
+    ModeData mModeData;
+};
+
+/**
+ * @brief IPv6 Addresses List
+ */
+struct Ipv6AddressList
+{
+    std::vector<std::string> mIpv6Addresses;
+};
+
+/**
+ * @brief Leader Data
+ */
+struct LeaderData
+{
+    uint32_t mPartitionId       = 0;
+    uint8_t  mWeighting         = 0;
+    uint8_t  mDataVersion       = 0;
+    uint8_t  mStableDataVersion = 0;
+    uint8_t  mRouterId          = 0;
+};
+
+/**
+ * @brief Route Data Entry of RouteData in Route64
+ */
+struct RouteDataEntry
+{
+    uint8_t mRouterId            = 0;
+    uint8_t mOutgoingLinkQuality = 0;
+    uint8_t mIncomingLinkQuality = 0;
+    uint8_t mRouteCost           = 0;
+};
+
+/**
+ * @brief Route64 Data
+ */
+struct Route64
+{
+    uint8_t                     mIdSequence = 0;
+    ByteArray                   mMask;
+    std::vector<RouteDataEntry> mRouteData;
+};
+
+/**
+ * @brief Child IPv6 Address List
+ */
+struct ChildIpv6AddressList
+{
+    uint16_t        mRloc16 = 0;
+    Ipv6AddressList mIpv6AddressList;
+};
+
+/**
+ * @brief MAC Counters
+ */
+struct MacCounters
+{
+    uint32_t mIfInUnknownProtos  = 0;
+    uint32_t mIfInErrors         = 0;
+    uint32_t mIfOutErrors        = 0;
+    uint32_t mIfInUcastPkts      = 0;
+    uint32_t mIfInBroadcastPkts  = 0;
+    uint32_t mIfInDiscards       = 0;
+    uint32_t mIfOutUcastPkts     = 0;
+    uint32_t mIfOutBroadcastPkts = 0;
+    uint32_t mIfOutDiscards      = 0;
+};
+
+/**
+ * @brief network diagnostic data in TMF
+ *
+ * Each data field of Diagnostic TLVs is optional. The field is
+ * meaningful only when associative PresentFlags is included in
+ * `mPresentFlags`.
+ */
+struct NetDiagData
+{
+    ByteArray                    mExtMacAddress;
+    uint16_t                     mMacAddress = 0;
+    ModeData                     mMode;
+    Route64                      mRoute64;
+    LeaderData                   mLeaderData;
+    Ipv6AddressList              mIpv6AddressList;
+    std::vector<ChildTableEntry> mChildTable;
+    ByteArray                    mEui64;
+    ByteArray                    mTlvTypeList;
+    ChildIpv6AddressList         mChildIpv6AddressList;
+    MacCounters                  mMacCounters;
+
+    /**
+     * Indicates which fields are included in the dataset.
+     */
+    uint64_t mPresentFlags;
+
+    static constexpr uint64_t kExtMacAddressBit    = (1ull << 0);
+    static constexpr uint64_t kMacAddressBit       = (1ull << 1);
+    static constexpr uint64_t kModeBit             = (1ull << 2);
+    static constexpr uint64_t kRoute64Bit          = (1ull << 3);
+    static constexpr uint64_t kLeaderDataBit       = (1ull << 4);
+    static constexpr uint64_t kIpv6AddressBit      = (1ull << 5);
+    static constexpr uint64_t kChildTableBit       = (1ull << 6);
+    static constexpr uint64_t kEui64Bit            = (1ull << 7);
+    static constexpr uint64_t kTlvTypeBit          = (1ull << 8);
+    static constexpr uint64_t kMacCountersBit      = (1ull << 9);
+    static constexpr uint64_t kChildIpv6AddressBit = (1ull << 10);
+};
+
+} // namespace commissioner
+
+} // namespace ot
+
+#endif // OT_COMM_NETWORK_DIAG_TLVS_HPP_