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 <openthread/history_tracker.h>
39
40 #include "common/as_core_type.hpp"
41 #include "common/locator_getters.hpp"
42 #include "utils/history_tracker.hpp"
43
44 using namespace ot;
45
otHistoryTrackerInitIterator(otHistoryTrackerIterator * aIterator)46 void otHistoryTrackerInitIterator(otHistoryTrackerIterator *aIterator)
47 {
48 AsCoreType(aIterator).Init();
49 }
50
otHistoryTrackerIterateNetInfoHistory(otInstance * aInstance,otHistoryTrackerIterator * aIterator,uint32_t * aEntryAge)51 const otHistoryTrackerNetworkInfo *otHistoryTrackerIterateNetInfoHistory(otInstance * aInstance,
52 otHistoryTrackerIterator *aIterator,
53 uint32_t * aEntryAge)
54 {
55 return AsCoreType(aInstance).Get<Utils::HistoryTracker>().IterateNetInfoHistory(AsCoreType(aIterator), *aEntryAge);
56 }
57
otHistoryTrackerIterateUnicastAddressHistory(otInstance * aInstance,otHistoryTrackerIterator * aIterator,uint32_t * aEntryAge)58 const otHistoryTrackerUnicastAddressInfo *otHistoryTrackerIterateUnicastAddressHistory(
59 otInstance * aInstance,
60 otHistoryTrackerIterator *aIterator,
61 uint32_t * aEntryAge)
62 {
63 return AsCoreType(aInstance).Get<Utils::HistoryTracker>().IterateUnicastAddressHistory(AsCoreType(aIterator),
64 *aEntryAge);
65 }
66
otHistoryTrackerIterateMulticastAddressHistory(otInstance * aInstance,otHistoryTrackerIterator * aIterator,uint32_t * aEntryAge)67 const otHistoryTrackerMulticastAddressInfo *otHistoryTrackerIterateMulticastAddressHistory(
68 otInstance * aInstance,
69 otHistoryTrackerIterator *aIterator,
70 uint32_t * aEntryAge)
71 {
72 return AsCoreType(aInstance).Get<Utils::HistoryTracker>().IterateMulticastAddressHistory(AsCoreType(aIterator),
73 *aEntryAge);
74 }
75
otHistoryTrackerIterateRxHistory(otInstance * aInstance,otHistoryTrackerIterator * aIterator,uint32_t * aEntryAge)76 const otHistoryTrackerMessageInfo *otHistoryTrackerIterateRxHistory(otInstance * aInstance,
77 otHistoryTrackerIterator *aIterator,
78 uint32_t * aEntryAge)
79 {
80 return AsCoreType(aInstance).Get<Utils::HistoryTracker>().IterateRxHistory(AsCoreType(aIterator), *aEntryAge);
81 }
82
otHistoryTrackerIterateTxHistory(otInstance * aInstance,otHistoryTrackerIterator * aIterator,uint32_t * aEntryAge)83 const otHistoryTrackerMessageInfo *otHistoryTrackerIterateTxHistory(otInstance * aInstance,
84 otHistoryTrackerIterator *aIterator,
85 uint32_t * aEntryAge)
86 {
87 return AsCoreType(aInstance).Get<Utils::HistoryTracker>().IterateTxHistory(AsCoreType(aIterator), *aEntryAge);
88 }
89
otHistoryTrackerIterateNeighborHistory(otInstance * aInstance,otHistoryTrackerIterator * aIterator,uint32_t * aEntryAge)90 const otHistoryTrackerNeighborInfo *otHistoryTrackerIterateNeighborHistory(otInstance * aInstance,
91 otHistoryTrackerIterator *aIterator,
92 uint32_t * aEntryAge)
93 {
94 return AsCoreType(aInstance).Get<Utils::HistoryTracker>().IterateNeighborHistory(AsCoreType(aIterator), *aEntryAge);
95 }
96
otHistoryTrackerIterateOnMeshPrefixHistory(otInstance * aInstance,otHistoryTrackerIterator * aIterator,uint32_t * aEntryAge)97 const otHistoryTrackerOnMeshPrefixInfo *otHistoryTrackerIterateOnMeshPrefixHistory(otInstance * aInstance,
98 otHistoryTrackerIterator *aIterator,
99 uint32_t * aEntryAge)
100 {
101 return AsCoreType(aInstance).Get<Utils::HistoryTracker>().IterateOnMeshPrefixHistory(AsCoreType(aIterator),
102 *aEntryAge);
103 }
104
otHistoryTrackerIterateExternalRouteHistory(otInstance * aInstance,otHistoryTrackerIterator * aIterator,uint32_t * aEntryAge)105 const otHistoryTrackerExternalRouteInfo *otHistoryTrackerIterateExternalRouteHistory(
106 otInstance * aInstance,
107 otHistoryTrackerIterator *aIterator,
108 uint32_t * aEntryAge)
109 {
110 return AsCoreType(aInstance).Get<Utils::HistoryTracker>().IterateExternalRouteHistory(AsCoreType(aIterator),
111 *aEntryAge);
112 }
113
otHistoryTrackerEntryAgeToString(uint32_t aEntryAge,char * aBuffer,uint16_t aSize)114 void otHistoryTrackerEntryAgeToString(uint32_t aEntryAge, char *aBuffer, uint16_t aSize)
115 {
116 Utils::HistoryTracker::EntryAgeToString(aEntryAge, aBuffer, aSize);
117 }
118
119 #endif // OPENTHREAD_CONFIG_HISTORY_TRACKER_ENABLE
120