1 /*
2  *  Copyright (c) 2020, 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 contains definitions for Network Data CLI commands.
32  */
33 
34 #ifndef CLI_NETWORK_DATA_HPP_
35 #define CLI_NETWORK_DATA_HPP_
36 
37 #include "openthread-core-config.h"
38 
39 #include <openthread/netdata.h>
40 
41 #include "cli/cli_utils.hpp"
42 
43 namespace ot {
44 namespace Cli {
45 
46 /**
47  * Implements the Network Data CLI.
48  *
49  */
50 class NetworkData : private Utils
51 {
52 public:
53     /**
54      * This constant specifies the string size for representing Network Data prefix/route entry flags.
55      *
56      * BorderRouter (OnMeshPrefix) TLV uses `uint16_t` for its flags and ExternalRoute uses `uint8_t`, though some of
57      * the bits are not currently used and reserved for future, so 17 chars string (16 flags plus null char at end of
58      * string) covers current and future flags.
59      *
60      */
61     static constexpr uint16_t kFlagsStringSize = 17;
62 
63     typedef char FlagsString[kFlagsStringSize]; ///< Flags String type (char array of `kFlagsStringSize`).
64 
65     /**
66      * Constructor
67      *
68      * @param[in]  aInstance            The OpenThread Instance.
69      * @param[in]  aOutputImplementer   An `OutputImplementer`.
70      *
71      */
72     NetworkData(otInstance *aInstance, OutputImplementer &aOutputImplementer);
73 
74     /**
75      * Processes a CLI sub-command.
76      *
77      * @param[in]  aArgs     An array of command line arguments.
78      *
79      * @retval OT_ERROR_NONE              Successfully executed the CLI command.
80      * @retval OT_ERROR_PENDING           The CLI command was successfully started but final result is pending.
81      * @retval OT_ERROR_INVALID_COMMAND   Invalid or unknown CLI command.
82      * @retval OT_ERROR_INVALID_ARGS      Invalid arguments.
83      * @retval ...                        Error during execution of the CLI command.
84      *
85      */
86     otError Process(Arg aArgs[]);
87 
88     /**
89      * Outputs the prefix config.
90      *
91      * @param[in]  aConfig  The prefix config.
92      *
93      */
94     void OutputPrefix(const otBorderRouterConfig &aConfig);
95 
96     /**
97      * Outputs the route config.
98      *
99      * @param[in]  aConfig  The route config.
100      *
101      */
102     void OutputRoute(const otExternalRouteConfig &aConfig);
103 
104     /**
105      * Outputs the service config.
106      *
107      * @param[in]  aConfig  The service config.
108      *
109      */
110     void OutputService(const otServiceConfig &aConfig);
111 
112     /**
113      * Converts the flags from a given prefix config to string.
114      *
115      * @param[in]  aConfig  The prefix config.
116      * @param[out] aString  The string to populate from @a Config flags.
117      *
118      */
119     static void PrefixFlagsToString(const otBorderRouterConfig &aConfig, FlagsString &aString);
120 
121     /**
122      * Converts the flags from a given route config to string.
123      *
124      * @param[in]  aConfig  The route config.
125      * @param[out] aString  The string to populate from @a Config flags.
126      *
127      */
128     static void RouteFlagsToString(const otExternalRouteConfig &aConfig, FlagsString &aString);
129 
130 private:
131     using Command = CommandEntry<NetworkData>;
132 
133     static constexpr uint16_t kAnyRloc16 = 0xffff;
134 
135     template <CommandId kCommandId> otError Process(Arg aArgs[]);
136 
137     otError GetNextPrefix(otNetworkDataIterator *aIterator, otBorderRouterConfig *aConfig, bool aLocal);
138     otError GetNextRoute(otNetworkDataIterator *aIterator, otExternalRouteConfig *aConfig, bool aLocal);
139     otError GetNextService(otNetworkDataIterator *aIterator, otServiceConfig *aConfig, bool aLocal);
140 
141     otError OutputBinary(bool aLocal);
142     void    OutputNetworkData(bool aLocal, uint16_t aRloc16);
143 
144 #if OPENTHREAD_CONFIG_BORDER_ROUTER_SIGNAL_NETWORK_DATA_FULL
HandleNetdataFull(void * aContext)145     static void HandleNetdataFull(void *aContext) { static_cast<NetworkData *>(aContext)->HandleNetdataFull(); }
HandleNetdataFull(void)146     void        HandleNetdataFull(void) { mFullCallbackWasCalled = true; }
147 
148     bool mFullCallbackWasCalled;
149 #endif
150 };
151 
152 } // namespace Cli
153 } // namespace ot
154 
155 #endif // CLI_NETWORK_DATA_HPP_
156