1 /* 2 * Copyright (c) 2021, 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 Network Data Publisher. 32 * 33 */ 34 35 #ifndef CONFIG_NETDATA_PUBLISHER_H_ 36 #define CONFIG_NETDATA_PUBLISHER_H_ 37 38 #include "config/border_router.h" 39 #include "config/border_routing.h" 40 #include "config/srp_server.h" 41 42 /** 43 * @def OPENTHREAD_CONFIG_NETDATA_PUBLISHER_ENABLE 44 * 45 * Define to 1 to enable Network Data Publisher. 46 * 47 * Network Data Publisher provides mechanisms to limit the number of similar Service and/or Prefix (on-mesh prefix 48 * or external route) entries in the Thread Network Data by monitoring the Network Data and managing if or when to add 49 * or remove entries. 50 * 51 */ 52 #ifndef OPENTHREAD_CONFIG_NETDATA_PUBLISHER_ENABLE 53 #define OPENTHREAD_CONFIG_NETDATA_PUBLISHER_ENABLE \ 54 (OPENTHREAD_CONFIG_SRP_SERVER_ENABLE || OPENTHREAD_CONFIG_BORDER_ROUTING_ENABLE) 55 #endif 56 57 /** 58 * @def OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_DELAY_TO_ADD 59 * 60 * Specifies the maximum value (in milliseconds) of the random delay used before adding an entry in the Thread Network 61 * Data. 62 * 63 */ 64 #ifndef OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_DELAY_TO_ADD 65 #define OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_DELAY_TO_ADD 3500 66 #endif 67 68 /** 69 * @def OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_DELAY_TO_REMOVE 70 * 71 * Specifies the maximum value (in milliseconds) of the random wait time used before removing an entry from the Thread 72 * Network Data. 73 * 74 */ 75 #ifndef OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_DELAY_TO_REMOVE 76 #define OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_DELAY_TO_REMOVE 15000 77 #endif 78 79 /** 80 * @def OPENTHREAD_CONFIG_NETDATA_PUBLISHER_EXTRA_DELAY_TIME_TO_REMOVE_PREFERRED 81 * 82 * Specifies the extra wait time (in milliseconds) used when removing a preferred entry. 83 * 84 * When removing entries, certain entries are preferred over others. How the preference is determined depends on the 85 * entry type (e.g., (for DNS/SRP service entries associated with smaller RLOC16 or smaller IPv6 address are preferred). 86 * If the `Publisher` determines that its own entry is a preferred one, it adds the above extra wait time in addition 87 * to the random wait selected based on `OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_DELAY_TO_REMOVE` before removing 88 * its entry. This gives higher chance for a non-preferred entry from another device to be removed before removing a 89 * preferred entry which helps towards quicker convergence of the process to the desired number of entries. 90 * 91 * It is recommended that `OPENTHREAD_CONFIG_NETDATA_PUBLISHER_EXTRA_DELAY_TIME_TO_REMOVE_PREFERRED` to be set to a 92 * value larger than `OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_DELAY_TO_REMOVE` to ensure that non-preferred entries 93 * are removed first. 94 * 95 */ 96 #ifndef OPENTHREAD_CONFIG_NETDATA_PUBLISHER_EXTRA_DELAY_TIME_TO_REMOVE_PREFERRED 97 #define OPENTHREAD_CONFIG_NETDATA_PUBLISHER_EXTRA_DELAY_TIME_TO_REMOVE_PREFERRED 16000 98 #endif 99 100 /** 101 * @def OPENTHREAD_CONFIG_NETDATA_PUBLISHER_DESIRED_NUM_ANYCAST_DNS_SRP_SERVICE_ENTRIES 102 * 103 * Specifies the desired number of "DNS/SRP Service Anycast Address" entries in the Thread Network Data. 104 * 105 * Publisher attempts to limit the number of such entries to this value. 106 * 107 */ 108 #ifndef OPENTHREAD_CONFIG_NETDATA_PUBLISHER_DESIRED_NUM_ANYCAST_DNS_SRP_SERVICE_ENTRIES 109 #define OPENTHREAD_CONFIG_NETDATA_PUBLISHER_DESIRED_NUM_ANYCAST_DNS_SRP_SERVICE_ENTRIES 8 110 #endif 111 112 /** 113 * @def OPENTHREAD_CONFIG_NETDATA_PUBLISHER_DESIRED_NUM_UNICAST_DNS_SRP_SERVICE_ENTRIES 114 * 115 * Specifies the desired number of "DNS/SRP Service Anycast Address" entries in the Thread Network Data. 116 * 117 * Publisher attempts to limit the number of such entries to this value. 118 * 119 */ 120 #ifndef OPENTHREAD_CONFIG_NETDATA_PUBLISHER_DESIRED_NUM_UNICAST_DNS_SRP_SERVICE_ENTRIES 121 #define OPENTHREAD_CONFIG_NETDATA_PUBLISHER_DESIRED_NUM_UNICAST_DNS_SRP_SERVICE_ENTRIES 2 122 #endif 123 124 /** 125 * @def OPENTHREAD_CONFIG_NETDATA_PUBLISHER_DESIRED_NUM_ON_MESH_PREFIX_ENTRIES 126 * 127 * Specifies the desired number of matching On-mesh Prefix entries in the Thread Network Data. 128 * 129 * Publisher attempts to limit the number of matching entries to this value. 130 * 131 */ 132 #ifndef OPENTHREAD_CONFIG_NETDATA_PUBLISHER_DESIRED_NUM_ON_MESH_PREFIX_ENTRIES 133 #define OPENTHREAD_CONFIG_NETDATA_PUBLISHER_DESIRED_NUM_ON_MESH_PREFIX_ENTRIES 3 134 #endif 135 136 /** 137 * @def OPENTHREAD_CONFIG_NETDATA_PUBLISHER_DESIRED_NUM_EXTERNAL_ROUTE_ENTRIES 138 * 139 * Specifies the desired number of matching External Route entries in the Thread Network Data. 140 * 141 * Publisher attempts to limit the number of matching entries to this value. 142 * 143 */ 144 #ifndef OPENTHREAD_CONFIG_NETDATA_PUBLISHER_DESIRED_NUM_EXTERNAL_ROUTE_ENTRIES 145 #define OPENTHREAD_CONFIG_NETDATA_PUBLISHER_DESIRED_NUM_EXTERNAL_ROUTE_ENTRIES 10 146 #endif 147 148 /** 149 * @def OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_PREFIX_ENTRIES 150 * 151 * Specifies maximum number of prefix (on-mesh prefix or external route) entries reserved by Publisher for use by 152 * user (through OT public APIs). 153 * 154 */ 155 #ifndef OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_PREFIX_ENTRIES 156 #define OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_PREFIX_ENTRIES 3 157 #endif 158 159 #endif // CONFIG_NETDATA_PUBLISHER_H_ 160
