/*
 *  Copyright (c) 2021-22, The OpenThread Authors.
 *  All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions are met:
 *  1. Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *  2. Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution.
 *  3. Neither the name of the copyright holder nor the
 *     names of its contributors may be used to endorse or promote products
 *     derived from this software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 *  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 *  POSSIBILITY OF SUCH DAMAGE.
 */

/**
 * @file
 *   This file includes compile-time configurations for Border Routing Manager.
 */

#ifndef OT_CORE_CONFIG_BORDER_ROUTING_H_
#define OT_CORE_CONFIG_BORDER_ROUTING_H_

/**
 * @addtogroup config-border-routing
 *
 * @brief
 *   This module includes configuration variables for Border Routing Manager.
 *
 * @{
 */

/**
 * @def OPENTHREAD_CONFIG_BORDER_ROUTING_ENABLE
 *
 * Define to 1 to enable Border Routing Manager feature.
 */
#ifndef OPENTHREAD_CONFIG_BORDER_ROUTING_ENABLE
#define OPENTHREAD_CONFIG_BORDER_ROUTING_ENABLE 0
#endif

/**
 * @def OPENTHREAD_CONFIG_BORDER_ROUTING_USE_HEAP_ENABLE
 *
 * Define to 1 to allow using heap by Routing Manager.
 *
 * When enabled heap allocated entries will be used to track discovered prefix table contain information about
 * discovered routers and the advertised on-link prefixes on infra link.
 *
 * When disabled pre-allocated pools are used instead where max number of entries are specified by
 * `OPENTHREAD_CONFIG_BORDER_ROUTING_MAX_DISCOVERED_ROUTERS` and `MAX_DISCOVERED_PREFIXES` configurations.
 */
#ifndef OPENTHREAD_CONFIG_BORDER_ROUTING_USE_HEAP_ENABLE
#define OPENTHREAD_CONFIG_BORDER_ROUTING_USE_HEAP_ENABLE 1
#endif

/**
 * @def OPENTHREAD_CONFIG_BORDER_ROUTING_TRACK_PEER_BR_INFO_ENABLE
 *
 * Define to 1 to allow the Routing Manager to track information (e.g., advertised prefixes) about peer Thread
 * Border Routers that are connected to the same Thread network.
 *
 * When enabled, the Routing Manager will maintain a record of advertised RIO/PIO prefixes discovered from received
 * Router Advertisements of peer BRs. These entries are disregarded in decision-making (e.g., selecting favored
 * on-link prefix or determining which route to publish in the Thread Network Data).
 *
 * It is recommended to enable this feature alongside `OPENTHREAD_CONFIG_BORDER_ROUTING_USE_HEAP_ENABLE`.
 */
#ifndef OPENTHREAD_CONFIG_BORDER_ROUTING_TRACK_PEER_BR_INFO_ENABLE
#define OPENTHREAD_CONFIG_BORDER_ROUTING_TRACK_PEER_BR_INFO_ENABLE OPENTHREAD_CONFIG_BORDER_ROUTING_USE_HEAP_ENABLE
#endif

/**
 * @def OPENTHREAD_CONFIG_BORDER_ROUTING_MULTI_AIL_DETECTION_ENABLE
 *
 * Define to 1 to enable Multiple Adjacent Infrastructure Links (AILs) detection feature.
 *
 * The detection mechanism operates as follows: The detector monitors the number of peer BRs listed in the Thread
 * Network Data (see `otBorderRoutingCountPeerBrs()`) and compares this count with the number of peer BRs discovered
 * by processing received Router Advertisement (RA) messages on its connected AIL. If the count derived from Network
 * Data consistently exceeds the count derived from RAs for a detection duration of 10 minutes, it concludes that BRs
 * are likely connected to different AILs. To clear state a shorter window of 1 minute is used.
 *
 * See `otBorderRoutingIsMultiAilDetected()` for more details.
 */
#ifndef OPENTHREAD_CONFIG_BORDER_ROUTING_MULTI_AIL_DETECTION_ENABLE
#define OPENTHREAD_CONFIG_BORDER_ROUTING_MULTI_AIL_DETECTION_ENABLE OPENTHREAD_CONFIG_BORDER_ROUTING_USE_HEAP_ENABLE
#endif

/**
 * @def OPENTHREAD_CONFIG_BORDER_ROUTING_MULTI_AIL_DETECTION_AUTO_ENABLE_MODE
 *
 * Specifies the "Auto Enable Mode" for Multi-AIL Detection feature.
 *
 * When "Auto Enable Mode" is set, the Multi-AIL Detector is enabled by default and starts running and monitoring
 * when the infrastructure interface network is initialized and become active/running. If this mode is disabled, the
 * detector will be in a disabled state initially and must be explicitly enabled using the public API
 * `otBorderRoutingSetMultiAilDetectionEnabled()`.
 */
#ifndef OPENTHREAD_CONFIG_BORDER_ROUTING_MULTI_AIL_DETECTION_AUTO_ENABLE_MODE
#define OPENTHREAD_CONFIG_BORDER_ROUTING_MULTI_AIL_DETECTION_AUTO_ENABLE_MODE 1
#endif

/**
 * @def OPENTHREAD_CONFIG_BORDER_ROUTING_REACHABILITY_CHECK_ICMP6_ERROR_ENABLE
 *
 * Define to 1 to allow Routing Manager to check for reachability of messages being forwarded by the BR and determine
 * whether to send an ICMPv6 Destination Unreachable error back to the sender.
 *
 * Specifically, if the Border Router (BR) decides to forward a unicast IPv6 message outside the AIL and the message's
 * source address matches a BR-generated ULA OMR prefix (with low preference), and the destination is unreachable
 * using this source address, then an ICMPv6 Destination Unreachable message is sent back to the sender.
 *
 * For example, this situation can occur when a local, non-infrastructure-derived ULA OMR prefix is published alongside
 * a `::/0` route (due to discovered PIO/RIO prefixes by the BR). A Thread mesh device may try to reach addresses
 * beyond the local AIL (e.g., the global internet) using its ULA OMR address as source, which would be unreachable.
 *
 * Alternatively, this functionality may be implemented within the platform layer, in which case this configuration
 * should be disabled. Note that the platform layer is always responsible for implementing generation of "ICMPv6
 * Destination Unreachable - No Route" messages. This reachability function will only generate "ICMPv6 Destination
 * Unreachable - Communication Administratively Prohibited" messages for specific cases  where there may be a
 * default route to the destination but the source address type prohibits usable communication with this destination.
 */
#ifndef OPENTHREAD_CONFIG_BORDER_ROUTING_REACHABILITY_CHECK_ICMP6_ERROR_ENABLE
#define OPENTHREAD_CONFIG_BORDER_ROUTING_REACHABILITY_CHECK_ICMP6_ERROR_ENABLE 1
#endif

/**
 * @def OPENTHREAD_CONFIG_BORDER_ROUTING_MAX_DISCOVERED_ROUTERS
 *
 * Specifies maximum number of routers (on infra link) to track by routing manager.
 *
 * Applicable only when heap allocation is not used, i.e., `OPENTHREAD_CONFIG_BORDER_ROUTING_USE_HEAP_ENABLE` is
 * disabled.
 */
#ifndef OPENTHREAD_CONFIG_BORDER_ROUTING_MAX_DISCOVERED_ROUTERS
#define OPENTHREAD_CONFIG_BORDER_ROUTING_MAX_DISCOVERED_ROUTERS 16
#endif

/**
 * @def OPENTHREAD_CONFIG_BORDER_ROUTING_MAX_DISCOVERED_PREFIXES
 *
 * Specifies maximum number of discovered prefixes (on-link prefixes on the infra link) maintained by routing manager.
 *
 * Applicable only when heap allocation is not used, i.e., `OPENTHREAD_CONFIG_BORDER_ROUTING_USE_HEAP_ENABLE` is
 * disabled.
 */
#ifndef OPENTHREAD_CONFIG_BORDER_ROUTING_MAX_DISCOVERED_PREFIXES
#define OPENTHREAD_CONFIG_BORDER_ROUTING_MAX_DISCOVERED_PREFIXES 64
#endif

/**
 * @def OPENTHREAD_CONFIG_BORDER_ROUTING_MAX_ON_MESH_PREFIXES
 *
 * Specifies maximum number of on-mesh prefixes (discovered from Thread Network Data) that are included as Route Info
 * Option in emitted Router Advertisement messages.
 */
#ifndef OPENTHREAD_CONFIG_BORDER_ROUTING_MAX_ON_MESH_PREFIXES
#define OPENTHREAD_CONFIG_BORDER_ROUTING_MAX_ON_MESH_PREFIXES 16
#endif

/**
 * @def OPENTHREAD_CONFIG_BORDER_ROUTING_MAX_OLD_ON_LINK_PREFIXES
 *
 * Specifies maximum number of old local on-link prefixes (being deprecated) maintained by routing manager.
 */
#ifndef OPENTHREAD_CONFIG_BORDER_ROUTING_MAX_OLD_ON_LINK_PREFIXES
#define OPENTHREAD_CONFIG_BORDER_ROUTING_MAX_OLD_ON_LINK_PREFIXES 3
#endif

/**
 * @def OPENTHREAD_CONFIG_BORDER_ROUTING_ROUTER_ACTIVE_CHECK_TIMEOUT
 *
 * Specifies the timeout in msec for a discovered router on infra link side.
 *
 * This parameter is related to mechanism to check that a discovered router is still active.
 *
 * After this timeout elapses since the last received message (a Router or Neighbor Advertisement) from the router,
 * routing manager will start sending Neighbor Solidification (NS) probes to the router to check that it is still
 * active.
 *
 * This parameter can be considered to large value to practically disable this behavior.
 */
#ifndef OPENTHREAD_CONFIG_BORDER_ROUTING_ROUTER_ACTIVE_CHECK_TIMEOUT
#define OPENTHREAD_CONFIG_BORDER_ROUTING_ROUTER_ACTIVE_CHECK_TIMEOUT (60 * 1000) // (in msec).
#endif

/**
 * @def OPENTHREAD_CONFIG_BORDER_ROUTING_DHCP6_PD_ENABLE
 *
 * Define to 1 to enable the Border Routing Manager's DHCPv6 Prefix Delegation feature.
 *
 * When enabled, the Routing Manager will track and use delegated DHCPv6 prefix(es) for use as an OMR
 * (Off-Mesh-Routable) prefix within the Thread network.
 *
 * The configuration `OPENTHREAD_CONFIG_BORDER_ROUTING_DHCP6_PD_CLIENT_ENABLE` (which enables the OpenThread native
 * DHCPv6 PD client) controls how the PD prefixes are acquired:
 *
 * - If the built-in OpenThread DHCPv6 PD client is disabled, the platform will be responsible for acquiring the PD
 *   prefix. The platform layer is expected to interact with DHCPv6 servers and provide the delegated PD prefix(es)
 *   through platform APIs such as `otPlatBorderRoutingProcessIcmp6Ra()` or `otPlatBorderRoutingProcessDhcp6PdPrefix()`
 *   (refer to `include/platform/border_routing.h` for a more detailed description of these APIs).
 *
 * - If the built-in OpenThread DHCPv6 PD client is enabled, the functionality is implemented and provided by the
 *   OpenThread core itself, which acts as a DHCPv6 client and interacts with DHCPv6 servers directly.
 */
#ifndef OPENTHREAD_CONFIG_BORDER_ROUTING_DHCP6_PD_ENABLE
#define OPENTHREAD_CONFIG_BORDER_ROUTING_DHCP6_PD_ENABLE 0
#endif

/**
 * @def OPENTHREAD_CONFIG_BORDER_ROUTING_DHCP6_PD_CLIENT_ENABLE
 *
 * Define to 1 to enable the Border Router's built-in OpenThread DHCPv6 Prefix Delegation (PD) client feature.
 *
 * See `OPENTHREAD_CONFIG_BORDER_ROUTING_DHCP6_PD_ENABLE` for how this is used.
 */
#ifndef OPENTHREAD_CONFIG_BORDER_ROUTING_DHCP6_PD_CLIENT_ENABLE
#define OPENTHREAD_CONFIG_BORDER_ROUTING_DHCP6_PD_CLIENT_ENABLE 0
#endif

/**
 * @def OPENTHREAD_CONFIG_BORDER_ROUTING_DHCP6_PD_CLIENT_MIN_LIFETIME
 *
 * This parameter sets the minimum preferred lifetime (in seconds) for the Border Router's built-in OpenThread
 * DHCPv6 Prefix Delegation (PD) client feature. The default value is suggested based on:
 * https://datatracker.ietf.org/doc/draft-ietf-snac-simple/.
 */
#ifndef OPENTHREAD_CONFIG_BORDER_ROUTING_DHCP6_PD_CLIENT_MIN_LIFETIME
#define OPENTHREAD_CONFIG_BORDER_ROUTING_DHCP6_PD_CLIENT_MIN_LIFETIME (30 * 60)
#endif

/**
 * @def OPENTHREAD_CONFIG_BORDER_ROUTING_DHCP6_PD_CLIENT_MAX_LIFETIME
 *
 * This parameter sets the maximum preferred lifetime (in seconds) for the Border Router's built-in OpenThread
 * DHCPv6 Prefix Delegation (PD) client feature.
 */
#ifndef OPENTHREAD_CONFIG_BORDER_ROUTING_DHCP6_PD_CLIENT_MAX_LIFETIME
#define OPENTHREAD_CONFIG_BORDER_ROUTING_DHCP6_PD_CLIENT_MAX_LIFETIME (4 * 60 * 60)
#endif

/**
 * @def OPENTHREAD_CONFIG_BORDER_ROUTING_TESTING_API_ENABLE
 *
 * Define to 1 to enable testing related APIs to be provided by the `RoutingManager`.
 *
 * This is intended for testing only. Production devices SHOULD set this to zero.
 */
#ifndef OPENTHREAD_CONFIG_BORDER_ROUTING_TESTING_API_ENABLE
#define OPENTHREAD_CONFIG_BORDER_ROUTING_TESTING_API_ENABLE 0
#endif

/**
 * @def OPENTHREAD_CONFIG_BORDER_ROUTING_MOCK_PLAT_APIS_ENABLE
 *
 * Define to 1 to add mock (empty) implementation of infra-if platform APIs.
 *
 * This is intended for generating code size report only and should not be used otherwise.
 */
#ifndef OPENTHREAD_CONFIG_BORDER_ROUTING_MOCK_PLAT_APIS_ENABLE
#define OPENTHREAD_CONFIG_BORDER_ROUTING_MOCK_PLAT_APIS_ENABLE 0
#endif

/**
 * @}
 */

#endif // OT_CORE_CONFIG_BORDER_ROUTING_H_
