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_output.hpp" 42 43 namespace ot { 44 namespace Cli { 45 46 /** 47 * This class implements the Network Data CLI. 48 * 49 */ 50 class NetworkData : private OutputWrapper 51 { 52 public: 53 typedef Utils::CmdLineParser::Arg Arg; 54 55 /** 56 * This constant specifies the string size for representing Network Data prefix/route entry flags. 57 * 58 * BorderRouter (OnMeshPrefix) TLV uses `uint16_t` for its flags and ExternalRoute uses `uint8_t`, though some of 59 * the bits are not currently used and reserved for future, so 17 chars string (16 flags plus null char at end of 60 * string) covers current and future flags. 61 * 62 */ 63 static constexpr uint16_t kFlagsStringSize = 17; 64 65 typedef char FlagsString[kFlagsStringSize]; ///< Flags String type (char array of `kFlagsStringSize`). 66 67 /** 68 * Constructor 69 * 70 * @param[in] aOutput The CLI console output context 71 * 72 */ NetworkData(Output & aOutput)73 explicit NetworkData(Output &aOutput) 74 : OutputWrapper(aOutput) 75 { 76 } 77 78 /** 79 * This method interprets a list of CLI arguments. 80 * 81 * @param[in] aArgs An array of command line arguments. 82 * 83 */ 84 otError Process(Arg aArgs[]); 85 86 /** 87 * This method outputs the prefix config. 88 * 89 * @param[in] aConfig The prefix config. 90 * 91 */ 92 void OutputPrefix(const otBorderRouterConfig &aConfig); 93 94 /** 95 * This method outputs the route config. 96 * 97 * @param[in] aConfig The route config. 98 * 99 */ 100 void OutputRoute(const otExternalRouteConfig &aConfig); 101 102 /** 103 * This method outputs the service config. 104 * 105 * @param[in] aConfig The service config. 106 * 107 */ 108 void OutputService(const otServiceConfig &aConfig); 109 110 /** 111 * This method converts the flags from a given prefix config to string. 112 * 113 * @param[in] aConfig The prefix config. 114 * @param[out] aString The string to populate from @a Config flags. 115 * 116 */ 117 static void PrefixFlagsToString(const otBorderRouterConfig &aConfig, FlagsString &aString); 118 119 /** 120 * This method converts the flags from a given route config to string. 121 * 122 * @param[in] aConfig The route config. 123 * @param[out] aString The string to populate from @a Config flags. 124 * 125 */ 126 static void RouteFlagsToString(const otExternalRouteConfig &aConfig, FlagsString &aString); 127 128 private: 129 using Command = CommandEntry<NetworkData>; 130 131 template <CommandId kCommandId> otError Process(Arg aArgs[]); 132 133 otError GetNextPrefix(otNetworkDataIterator *aIterator, otBorderRouterConfig *aConfig, bool aLocal); 134 otError GetNextRoute(otNetworkDataIterator *aIterator, otExternalRouteConfig *aConfig, bool aLocal); 135 otError GetNextService(otNetworkDataIterator *aIterator, otServiceConfig *aConfig, bool aLocal); 136 137 otError OutputBinary(bool aLocal); 138 void OutputPrefixes(bool aLocal); 139 void OutputRoutes(bool aLocal); 140 void OutputServices(bool aLocal); 141 }; 142 143 } // namespace Cli 144 } // namespace ot 145 146 #endif // CLI_NETWORK_DATA_HPP_ 147