1 /* 2 * Copyright (c) 2021-22, 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 includes compile-time configurations for Border Routing Manager. 32 * 33 */ 34 35 #ifndef CONFIG_BORDER_ROUTING_H_ 36 #define CONFIG_BORDER_ROUTING_H_ 37 38 /** 39 * @addtogroup config-border-routing 40 * 41 * @brief 42 * This module includes configuration variables for Border Routing Manager. 43 * 44 * @{ 45 * 46 */ 47 48 /** 49 * @def OPENTHREAD_CONFIG_BORDER_ROUTING_ENABLE 50 * 51 * Define to 1 to enable Border Routing Manager feature. 52 * 53 */ 54 #ifndef OPENTHREAD_CONFIG_BORDER_ROUTING_ENABLE 55 #define OPENTHREAD_CONFIG_BORDER_ROUTING_ENABLE 0 56 #endif 57 58 /** 59 * @def OPENTHREAD_CONFIG_BORDER_ROUTING_USE_HEAP_ENABLE 60 * 61 * Define to 1 to allow using heap by Routing Manager. 62 * 63 * When enabled heap allocated entries will be used to track discovered prefix table contain information about 64 * discovered routers and the advertised on-link prefixes on infra link. 65 * 66 * When disabled pre-allocated pools are used instead where max number of entries are specified by 67 * `OPENTHREAD_CONFIG_BORDER_ROUTING_MAX_DISCOVERED_ROUTERS` and `MAX_DISCOVERED_PREFIXES` configurations. 68 * 69 */ 70 #ifndef OPENTHREAD_CONFIG_BORDER_ROUTING_USE_HEAP_ENABLE 71 #define OPENTHREAD_CONFIG_BORDER_ROUTING_USE_HEAP_ENABLE 1 72 #endif 73 74 /** 75 * @def OPENTHREAD_CONFIG_BORDER_ROUTING_TRACK_PEER_BR_INFO_ENABLE 76 * 77 * Define to 1 to allow the Routing Manager to track information (e.g., advertised prefixes) about peer Thread 78 * Border Routers that are connected to the same Thread network. 79 * 80 * When enabled, the Routing Manager will maintain a record of advertised RIO/PIO prefixes discovered from received 81 * Router Advertisements of peer BRs. These entries are disregarded in decision-making (e.g., selecting favored 82 * on-link prefix or determining which route to publish in the Thread Network Data). 83 * 84 * It is recommended to enable this feature alongside `OPENTHREAD_CONFIG_BORDER_ROUTING_USE_HEAP_ENABLE`. 85 * 86 */ 87 #ifndef OPENTHREAD_CONFIG_BORDER_ROUTING_TRACK_PEER_BR_INFO_ENABLE 88 #define OPENTHREAD_CONFIG_BORDER_ROUTING_TRACK_PEER_BR_INFO_ENABLE OPENTHREAD_CONFIG_BORDER_ROUTING_USE_HEAP_ENABLE 89 #endif 90 91 /** 92 * @def OPENTHREAD_CONFIG_BORDER_ROUTING_REACHABILITY_CHECK_ICMP6_ERROR_ENABLE 93 * 94 * Define to 1 to allow Routing Manager to check for reachability of messages being forwarded by the BR and determine 95 * whether to send an ICMPv6 Destination Unreachable error back to the sender. 96 * 97 * Specifically, if the Border Router (BR) decides to forward a unicast IPv6 message outside the AIL and the message's 98 * source address matches a BR-generated ULA OMR prefix (with low preference), and the destination is unreachable 99 * using this source address, then an ICMPv6 Destination Unreachable message is sent back to the sender. 100 * 101 * For example, this situation can occur when a local, non-infrastructure-derived ULA OMR prefix is published alongside 102 * a `::/0` route (due to discovered PIO/RIO prefixes by the BR). A Thread mesh device may try to reach addresses 103 * beyond the local AIL (e.g., the global internet) using its ULA OMR address as source, which would be unreachable. 104 * 105 * Alternatively, this functionality may be implemented within the platform layer, in which case this configuration 106 * should be disabled. Note that the platform layer is always responsible for implementing generation of "ICMPv6 107 * Destination Unreachable - No Route" messages. This reachability function will only generate "ICMPv6 Destination 108 * Unreachable - Communication Administratively Prohibited" messages for specific cases where there may be a 109 * default route to the destination but the source address type prohibits usable communication with this destination. 110 * 111 */ 112 #ifndef OPENTHREAD_CONFIG_BORDER_ROUTING_REACHABILITY_CHECK_ICMP6_ERROR_ENABLE 113 #define OPENTHREAD_CONFIG_BORDER_ROUTING_REACHABILITY_CHECK_ICMP6_ERROR_ENABLE 1 114 #endif 115 116 /** 117 * @def OPENTHREAD_CONFIG_BORDER_ROUTING_MAX_DISCOVERED_ROUTERS 118 * 119 * Specifies maximum number of routers (on infra link) to track by routing manager. 120 * 121 * Applicable only when heap allocation is not used, i.e., `OPENTHREAD_CONFIG_BORDER_ROUTING_USE_HEAP_ENABLE` is 122 * disabled. 123 * 124 */ 125 #ifndef OPENTHREAD_CONFIG_BORDER_ROUTING_MAX_DISCOVERED_ROUTERS 126 #define OPENTHREAD_CONFIG_BORDER_ROUTING_MAX_DISCOVERED_ROUTERS 16 127 #endif 128 129 /** 130 * @def OPENTHREAD_CONFIG_BORDER_ROUTING_MAX_DISCOVERED_PREFIXES 131 * 132 * Specifies maximum number of discovered prefixes (on-link prefixes on the infra link) maintained by routing manager. 133 * 134 * Applicable only when heap allocation is not used, i.e., `OPENTHREAD_CONFIG_BORDER_ROUTING_USE_HEAP_ENABLE` is 135 * disabled. 136 * 137 */ 138 #ifndef OPENTHREAD_CONFIG_BORDER_ROUTING_MAX_DISCOVERED_PREFIXES 139 #define OPENTHREAD_CONFIG_BORDER_ROUTING_MAX_DISCOVERED_PREFIXES 64 140 #endif 141 142 /** 143 * @def OPENTHREAD_CONFIG_BORDER_ROUTING_MAX_ON_MESH_PREFIXES 144 * 145 * Specifies maximum number of on-mesh prefixes (discovered from Thread Network Data) that are included as Route Info 146 * Option in emitted Router Advertisement messages. 147 * 148 */ 149 #ifndef OPENTHREAD_CONFIG_BORDER_ROUTING_MAX_ON_MESH_PREFIXES 150 #define OPENTHREAD_CONFIG_BORDER_ROUTING_MAX_ON_MESH_PREFIXES 16 151 #endif 152 153 /** 154 * @def OPENTHREAD_CONFIG_BORDER_ROUTING_MAX_OLD_ON_LINK_PREFIXES 155 * 156 * Specifies maximum number of old local on-link prefixes (being deprecated) maintained by routing manager. 157 * 158 */ 159 #ifndef OPENTHREAD_CONFIG_BORDER_ROUTING_MAX_OLD_ON_LINK_PREFIXES 160 #define OPENTHREAD_CONFIG_BORDER_ROUTING_MAX_OLD_ON_LINK_PREFIXES 3 161 #endif 162 163 /** 164 * @def OPENTHREAD_CONFIG_BORDER_ROUTING_ROUTER_ACTIVE_CHECK_TIMEOUT 165 * 166 * Specifies the timeout in msec for a discovered router on infra link side. 167 * 168 * This parameter is related to mechanism to check that a discovered router is still active. 169 * 170 * After this timeout elapses since the last received message (a Router or Neighbor Advertisement) from the router, 171 * routing manager will start sending Neighbor Solidification (NS) probes to the router to check that it is still 172 * active. 173 * 174 * This parameter can be considered to large value to practically disable this behavior. 175 * 176 */ 177 #ifndef OPENTHREAD_CONFIG_BORDER_ROUTING_ROUTER_ACTIVE_CHECK_TIMEOUT 178 #define OPENTHREAD_CONFIG_BORDER_ROUTING_ROUTER_ACTIVE_CHECK_TIMEOUT (60 * 1000) // (in msec). 179 #endif 180 181 /** 182 * @def OPENTHREAD_CONFIG_BORDER_ROUTING_STUB_ROUTER_FLAG_IN_EMITTED_RA_ENABLE 183 * 184 * Define to 1 so for the routing manager to include the Flags Extension Option with Stub Router flag in the emitted 185 * Router Advertisement messages from this Border Router. 186 * 187 */ 188 #ifndef OPENTHREAD_CONFIG_BORDER_ROUTING_STUB_ROUTER_FLAG_IN_EMITTED_RA_ENABLE 189 #define OPENTHREAD_CONFIG_BORDER_ROUTING_STUB_ROUTER_FLAG_IN_EMITTED_RA_ENABLE 1 190 #endif 191 192 /** 193 * @def OPENTHREAD_CONFIG_BORDER_ROUTING_DHCP6_PD_ENABLE 194 * 195 * Specifies whether to support handling platform generated ND messages. 196 * 197 * The desired use case is the prefix will be allocated by other software on the interface, and they will advertise the 198 * assigned prefix to the thread interface via router advertisement messages. 199 * 200 */ 201 #ifndef OPENTHREAD_CONFIG_BORDER_ROUTING_DHCP6_PD_ENABLE 202 #define OPENTHREAD_CONFIG_BORDER_ROUTING_DHCP6_PD_ENABLE 0 203 #endif 204 205 /** 206 * @def OPENTHREAD_CONFIG_BORDER_ROUTING_TESTING_API_ENABLE 207 * 208 * Define to 1 to enable testing related APIs to be provided by the `RoutingManager`. 209 * 210 * This is intended for testing only. Production devices SHOULD set this to zero. 211 * 212 */ 213 #ifndef OPENTHREAD_CONFIG_BORDER_ROUTING_TESTING_API_ENABLE 214 #define OPENTHREAD_CONFIG_BORDER_ROUTING_TESTING_API_ENABLE 0 215 #endif 216 217 /** 218 * @def OPENTHREAD_CONFIG_BORDER_ROUTING_MOCK_PLAT_APIS_ENABLE 219 * 220 * Define to 1 to add mock (empty) implementation of infra-if platform APIs. 221 * 222 * This is intended for generating code size report only and should not be used otherwise. 223 * 224 */ 225 #ifndef OPENTHREAD_CONFIG_BORDER_ROUTING_MOCK_PLAT_APIS_ENABLE 226 #define OPENTHREAD_CONFIG_BORDER_ROUTING_MOCK_PLAT_APIS_ENABLE 0 227 #endif 228 229 /** 230 * @} 231 * 232 */ 233 234 #endif // CONFIG_BORDER_ROUTING_H_ 235