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