1 /*
2 * Copyright (c) 2021, The OpenThread Authors.
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
7 * 1. Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * 2. Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
12 * 3. Neither the name of the copyright holder nor the
13 * names of its contributors may be used to endorse or promote products
14 * derived from this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
20 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26 * POSSIBILITY OF SUCH DAMAGE.
27 */
28
29 /**
30 * @file
31 * This file implements the History Tracker public APIs.
32 */
33
34 #include "openthread-core-config.h"
35
36 #if OPENTHREAD_CONFIG_HISTORY_TRACKER_ENABLE
37
38 #include "instance/instance.hpp"
39
40 using namespace ot;
41
otHistoryTrackerInitIterator(otHistoryTrackerIterator * aIterator)42 void otHistoryTrackerInitIterator(otHistoryTrackerIterator *aIterator) { AsCoreType(aIterator).Init(); }
43
otHistoryTrackerIterateNetInfoHistory(otInstance * aInstance,otHistoryTrackerIterator * aIterator,uint32_t * aEntryAge)44 const otHistoryTrackerNetworkInfo *otHistoryTrackerIterateNetInfoHistory(otInstance *aInstance,
45 otHistoryTrackerIterator *aIterator,
46 uint32_t *aEntryAge)
47 {
48 AssertPointerIsNotNull(aEntryAge);
49
50 return AsCoreType(aInstance).Get<Utils::HistoryTracker>().IterateNetInfoHistory(AsCoreType(aIterator), *aEntryAge);
51 }
52
otHistoryTrackerIterateUnicastAddressHistory(otInstance * aInstance,otHistoryTrackerIterator * aIterator,uint32_t * aEntryAge)53 const otHistoryTrackerUnicastAddressInfo *otHistoryTrackerIterateUnicastAddressHistory(
54 otInstance *aInstance,
55 otHistoryTrackerIterator *aIterator,
56 uint32_t *aEntryAge)
57 {
58 AssertPointerIsNotNull(aEntryAge);
59
60 return AsCoreType(aInstance).Get<Utils::HistoryTracker>().IterateUnicastAddressHistory(AsCoreType(aIterator),
61 *aEntryAge);
62 }
63
otHistoryTrackerIterateMulticastAddressHistory(otInstance * aInstance,otHistoryTrackerIterator * aIterator,uint32_t * aEntryAge)64 const otHistoryTrackerMulticastAddressInfo *otHistoryTrackerIterateMulticastAddressHistory(
65 otInstance *aInstance,
66 otHistoryTrackerIterator *aIterator,
67 uint32_t *aEntryAge)
68 {
69 AssertPointerIsNotNull(aEntryAge);
70
71 return AsCoreType(aInstance).Get<Utils::HistoryTracker>().IterateMulticastAddressHistory(AsCoreType(aIterator),
72 *aEntryAge);
73 }
74
otHistoryTrackerIterateRxHistory(otInstance * aInstance,otHistoryTrackerIterator * aIterator,uint32_t * aEntryAge)75 const otHistoryTrackerMessageInfo *otHistoryTrackerIterateRxHistory(otInstance *aInstance,
76 otHistoryTrackerIterator *aIterator,
77 uint32_t *aEntryAge)
78 {
79 AssertPointerIsNotNull(aEntryAge);
80
81 return AsCoreType(aInstance).Get<Utils::HistoryTracker>().IterateRxHistory(AsCoreType(aIterator), *aEntryAge);
82 }
83
otHistoryTrackerIterateTxHistory(otInstance * aInstance,otHistoryTrackerIterator * aIterator,uint32_t * aEntryAge)84 const otHistoryTrackerMessageInfo *otHistoryTrackerIterateTxHistory(otInstance *aInstance,
85 otHistoryTrackerIterator *aIterator,
86 uint32_t *aEntryAge)
87 {
88 AssertPointerIsNotNull(aEntryAge);
89
90 return AsCoreType(aInstance).Get<Utils::HistoryTracker>().IterateTxHistory(AsCoreType(aIterator), *aEntryAge);
91 }
92
otHistoryTrackerIterateNeighborHistory(otInstance * aInstance,otHistoryTrackerIterator * aIterator,uint32_t * aEntryAge)93 const otHistoryTrackerNeighborInfo *otHistoryTrackerIterateNeighborHistory(otInstance *aInstance,
94 otHistoryTrackerIterator *aIterator,
95 uint32_t *aEntryAge)
96 {
97 AssertPointerIsNotNull(aEntryAge);
98
99 return AsCoreType(aInstance).Get<Utils::HistoryTracker>().IterateNeighborHistory(AsCoreType(aIterator), *aEntryAge);
100 }
101
otHistoryTrackerIterateRouterHistory(otInstance * aInstance,otHistoryTrackerIterator * aIterator,uint32_t * aEntryAge)102 const otHistoryTrackerRouterInfo *otHistoryTrackerIterateRouterHistory(otInstance *aInstance,
103 otHistoryTrackerIterator *aIterator,
104 uint32_t *aEntryAge)
105 {
106 AssertPointerIsNotNull(aEntryAge);
107
108 return AsCoreType(aInstance).Get<Utils::HistoryTracker>().IterateRouterHistory(AsCoreType(aIterator), *aEntryAge);
109 }
110
otHistoryTrackerIterateOnMeshPrefixHistory(otInstance * aInstance,otHistoryTrackerIterator * aIterator,uint32_t * aEntryAge)111 const otHistoryTrackerOnMeshPrefixInfo *otHistoryTrackerIterateOnMeshPrefixHistory(otInstance *aInstance,
112 otHistoryTrackerIterator *aIterator,
113 uint32_t *aEntryAge)
114 {
115 AssertPointerIsNotNull(aEntryAge);
116
117 return AsCoreType(aInstance).Get<Utils::HistoryTracker>().IterateOnMeshPrefixHistory(AsCoreType(aIterator),
118 *aEntryAge);
119 }
120
otHistoryTrackerIterateExternalRouteHistory(otInstance * aInstance,otHistoryTrackerIterator * aIterator,uint32_t * aEntryAge)121 const otHistoryTrackerExternalRouteInfo *otHistoryTrackerIterateExternalRouteHistory(
122 otInstance *aInstance,
123 otHistoryTrackerIterator *aIterator,
124 uint32_t *aEntryAge)
125 {
126 AssertPointerIsNotNull(aEntryAge);
127
128 return AsCoreType(aInstance).Get<Utils::HistoryTracker>().IterateExternalRouteHistory(AsCoreType(aIterator),
129 *aEntryAge);
130 }
131
otHistoryTrackerEntryAgeToString(uint32_t aEntryAge,char * aBuffer,uint16_t aSize)132 void otHistoryTrackerEntryAgeToString(uint32_t aEntryAge, char *aBuffer, uint16_t aSize)
133 {
134 Utils::HistoryTracker::EntryAgeToString(aEntryAge, aBuffer, aSize);
135 }
136
137 #endif // OPENTHREAD_CONFIG_HISTORY_TRACKER_ENABLE
138