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/instance.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     static_cast<Utils::HistoryTracker::Iterator *>(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     Instance &instance = *static_cast<Instance *>(aInstance);
56 
57     return instance.Get<Utils::HistoryTracker>().IterateNetInfoHistory(
58         *static_cast<Utils::HistoryTracker::Iterator *>(aIterator), *aEntryAge);
59 }
60 
otHistoryTrackerIterateRxHistory(otInstance * aInstance,otHistoryTrackerIterator * aIterator,uint32_t * aEntryAge)61 const otHistoryTrackerMessageInfo *otHistoryTrackerIterateRxHistory(otInstance *              aInstance,
62                                                                     otHistoryTrackerIterator *aIterator,
63                                                                     uint32_t *                aEntryAge)
64 {
65     Instance &instance = *static_cast<Instance *>(aInstance);
66 
67     return instance.Get<Utils::HistoryTracker>().IterateRxHistory(
68         *static_cast<Utils::HistoryTracker::Iterator *>(aIterator), *aEntryAge);
69 }
70 
otHistoryTrackerIterateTxHistory(otInstance * aInstance,otHistoryTrackerIterator * aIterator,uint32_t * aEntryAge)71 const otHistoryTrackerMessageInfo *otHistoryTrackerIterateTxHistory(otInstance *              aInstance,
72                                                                     otHistoryTrackerIterator *aIterator,
73                                                                     uint32_t *                aEntryAge)
74 {
75     Instance &instance = *static_cast<Instance *>(aInstance);
76 
77     return instance.Get<Utils::HistoryTracker>().IterateTxHistory(
78         *static_cast<Utils::HistoryTracker::Iterator *>(aIterator), *aEntryAge);
79 }
80 
otHistoryTrackerIterateNeighborHistory(otInstance * aInstance,otHistoryTrackerIterator * aIterator,uint32_t * aEntryAge)81 const otHistoryTrackerNeighborInfo *otHistoryTrackerIterateNeighborHistory(otInstance *              aInstance,
82                                                                            otHistoryTrackerIterator *aIterator,
83                                                                            uint32_t *                aEntryAge)
84 {
85     Instance &instance = *static_cast<Instance *>(aInstance);
86 
87     return instance.Get<Utils::HistoryTracker>().IterateNeighborHistory(
88         *static_cast<Utils::HistoryTracker::Iterator *>(aIterator), *aEntryAge);
89 }
90 
otHistoryTrackerEntryAgeToString(uint32_t aEntryAge,char * aBuffer,uint16_t aSize)91 void otHistoryTrackerEntryAgeToString(uint32_t aEntryAge, char *aBuffer, uint16_t aSize)
92 {
93     Utils::HistoryTracker::EntryAgeToString(aEntryAge, aBuffer, aSize);
94 }
95 
96 #endif // OPENTHREAD_CONFIG_HISTORY_TRACKER_ENABLE
97