Constants.hpp 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767
  1. /*
  2. * Copyright (c)2013-2020 ZeroTier, Inc.
  3. *
  4. * Use of this software is governed by the Business Source License included
  5. * in the LICENSE.TXT file in the project's root directory.
  6. *
  7. * Change Date: 2026-01-01
  8. *
  9. * On the date above, in accordance with the Business Source License, use
  10. * of this software will be governed by version 2.0 of the Apache License.
  11. */
  12. /****/
  13. #ifndef ZT_CONSTANTS_HPP
  14. #define ZT_CONSTANTS_HPP
  15. #include "../include/ZeroTierOne.h"
  16. //
  17. // This include file also auto-detects and canonicalizes some environment
  18. // information defines:
  19. //
  20. // __LINUX__
  21. // __APPLE__
  22. // __BSD__ (OSX also defines this)
  23. // __UNIX_LIKE__ (Linux, BSD, etc.)
  24. // __WINDOWS__
  25. //
  26. // Also makes sure __BYTE_ORDER is defined reasonably.
  27. //
  28. #ifndef ZT_INLINE
  29. #define ZT_INLINE inline
  30. #endif
  31. #define restrict
  32. // Hack: make sure __GCC__ is defined on old GCC compilers
  33. #ifndef __GCC__
  34. #if defined(__GCC_HAVE_SYNC_COMPARE_AND_SWAP_1) || defined(__GCC_HAVE_SYNC_COMPARE_AND_SWAP_2) || defined(__GCC_HAVE_SYNC_COMPARE_AND_SWAP_4)
  35. #define __GCC__
  36. #endif
  37. #endif
  38. #if defined(__linux__) || defined(linux) || defined(__LINUX__) || defined(__linux)
  39. #ifndef __LINUX__
  40. #define __LINUX__
  41. #endif
  42. #ifndef __UNIX_LIKE__
  43. #define __UNIX_LIKE__
  44. #endif
  45. #include <endian.h>
  46. #if (defined(__amd64) || defined(__amd64__) || defined(__x86_64) || defined(__x86_64__) || defined(__AMD64) || defined(__AMD64__) || defined(_M_X64) || defined(__aarch64__))
  47. #ifdef ZT_SSO_SUPPORTED
  48. #define ZT_SSO_ENABLED 1
  49. #endif
  50. #endif
  51. #endif
  52. #ifdef __APPLE__
  53. #ifdef ZT_SSO_SUPPORTED
  54. #define ZT_SSO_ENABLED 1
  55. #endif
  56. #define likely(x) __builtin_expect((x), 1)
  57. #define unlikely(x) __builtin_expect((x), 0)
  58. #include <TargetConditionals.h>
  59. #ifndef __UNIX_LIKE__
  60. #define __UNIX_LIKE__
  61. #endif
  62. #ifndef __BSD__
  63. #define __BSD__
  64. #endif
  65. #include <machine/endian.h>
  66. #endif
  67. #if defined(__FreeBSD__) || defined(__OpenBSD__) || defined(__NetBSD__)
  68. #ifdef ZT_SSO_SUPPORTED
  69. #define ZT_SSO_ENABLED 0
  70. #endif
  71. #ifndef __UNIX_LIKE__
  72. #define __UNIX_LIKE__
  73. #endif
  74. #ifndef __BSD__
  75. #define __BSD__
  76. #endif
  77. #include <machine/endian.h>
  78. #ifndef __BYTE_ORDER
  79. #define __BYTE_ORDER _BYTE_ORDER
  80. #define __LITTLE_ENDIAN _LITTLE_ENDIAN
  81. #define __BIG_ENDIAN _BIG_ENDIAN
  82. #endif
  83. #endif
  84. #if defined(_WIN32) || defined(_WIN64)
  85. #ifdef ZT_SSO_SUPPORTED
  86. #define ZT_SSO_ENABLED 1
  87. #endif
  88. #ifndef __WINDOWS__
  89. #define __WINDOWS__
  90. #endif
  91. #ifndef NOMINMAX
  92. #define NOMINMAX
  93. #endif
  94. #pragma warning(disable : 4290)
  95. #pragma warning(disable : 4996)
  96. #pragma warning(disable : 4101)
  97. #undef __UNIX_LIKE__
  98. #undef __BSD__
  99. #include <windows.h>
  100. #include <winsock2.h>
  101. #endif
  102. #ifdef __NetBSD__
  103. #ifndef RTF_MULTICAST
  104. #define RTF_MULTICAST 0x20000000
  105. #endif
  106. #endif
  107. #if (defined(__amd64) || defined(__amd64__) || defined(__x86_64) || defined(__x86_64__) || defined(__AMD64) || defined(__AMD64__) || defined(_M_X64))
  108. #define ZT_ARCH_X64 1
  109. #include <emmintrin.h>
  110. #include <immintrin.h>
  111. #include <xmmintrin.h>
  112. #endif
  113. #if (defined(__ARM_NEON) || defined(__ARM_NEON__) || defined(ZT_ARCH_ARM_HAS_NEON))
  114. #if (defined(__APPLE__) && ! defined(__LP64__)) || (defined(__ANDROID__) && defined(__arm__))
  115. #ifdef ZT_ARCH_ARM_HAS_NEON
  116. #undef ZT_ARCH_ARM_HAS_NEON
  117. #endif
  118. #else
  119. #ifndef ZT_ARCH_ARM_HAS_NEON
  120. #define ZT_ARCH_ARM_HAS_NEON 1
  121. #endif
  122. #include <arm_neon.h>
  123. /*#include <arm_acle.h>*/
  124. #endif
  125. #endif
  126. #ifndef ZT_ARCH_ARM_HAS_CRYPTO
  127. #if defined(__ARM_FEATURE_CRYPTO)
  128. // ARM Cryptography Extension
  129. #define ZT_ARCH_ARM_HAS_CRYPTO
  130. #endif
  131. #endif
  132. // Define ZT_NO_TYPE_PUNNING to disable reckless casts on anything other than x86/x64.
  133. #if (! (defined(__amd64__) || defined(__amd64) || defined(__x86_64__) || defined(__x86_64) || defined(_M_AMD64) || defined(_M_X64) || defined(i386) || defined(__i386) || defined(__i386__) || defined(__i486__) || defined(__i586__) \
  134. || defined(__i686__) || defined(_M_IX86) || defined(__X86__) || defined(_X86_) || defined(__I86__) || defined(__INTEL__) || defined(__386)))
  135. #ifndef ZT_NO_TYPE_PUNNING
  136. #define ZT_NO_TYPE_PUNNING 1
  137. #endif
  138. #endif
  139. #ifdef ZT_NO_TYPE_PUNNING
  140. #ifndef ZT_NO_UNALIGNED_ACCESS
  141. #define ZT_NO_UNALIGNED_ACCESS 1
  142. #endif
  143. #endif
  144. // Assume little endian if not defined
  145. #if (defined(__APPLE__) || defined(__WINDOWS__)) && (! defined(__BYTE_ORDER))
  146. #undef __BYTE_ORDER
  147. #undef __LITTLE_ENDIAN
  148. #undef __BIG_ENDIAN
  149. #define __BIG_ENDIAN 4321
  150. #define __LITTLE_ENDIAN 1234
  151. #define __BYTE_ORDER 1234
  152. #endif
  153. #ifdef __WINDOWS__
  154. #define ZT_PATH_SEPARATOR '\\'
  155. #define ZT_PATH_SEPARATOR_S "\\"
  156. #define ZT_EOL_S "\r\n"
  157. #else
  158. #define ZT_PATH_SEPARATOR '/'
  159. #define ZT_PATH_SEPARATOR_S "/"
  160. #define ZT_EOL_S "\n"
  161. #endif
  162. #ifndef __BYTE_ORDER
  163. #include <endian.h>
  164. #endif
  165. #if (defined(__GNUC__) && (__GNUC__ >= 3)) || (defined(__INTEL_COMPILER) && (__INTEL_COMPILER >= 800)) || defined(__clang__)
  166. #ifndef likely
  167. #define likely(x) __builtin_expect((x), 1)
  168. #endif
  169. #ifndef unlikely
  170. #define unlikely(x) __builtin_expect((x), 0)
  171. #endif
  172. #else
  173. #ifndef likely
  174. #define likely(x) (x)
  175. #endif
  176. #ifndef unlikely
  177. #define unlikely(x) (x)
  178. #endif
  179. #endif
  180. #ifdef __WINDOWS__
  181. #define ZT_PACKED_STRUCT(D) __pragma(pack(push, 1)) D __pragma(pack(pop))
  182. #else
  183. #define ZT_PACKED_STRUCT(D) D __attribute__((packed))
  184. #endif
  185. #if defined(_WIN32)
  186. #define ZT_PLATFORM_NAME "windows" // Windows
  187. #elif defined(_WIN64)
  188. #define ZT_PLATFORM_NAME "windows" // Windows
  189. #elif defined(__CYGWIN__)
  190. #define ZT_PLATFORM_NAME "windows" // Windows (Cygwin POSIX under Microsoft Window)
  191. #elif defined(__ANDROID__)
  192. #define ZT_PLATFORM_NAME "android" // Android (implies Linux, so it must come first)
  193. #elif defined(__linux__)
  194. #define ZT_PLATFORM_NAME "linux" // Debian, Ubuntu, Gentoo, Fedora, openSUSE, RedHat, Centos and other
  195. #elif defined(__unix__) || ! defined(__APPLE__) && defined(__MACH__)
  196. #include <sys/param.h>
  197. #if defined(BSD)
  198. #define ZT_PLATFORM_NAME "bsd" // FreeBSD, NetBSD, OpenBSD, DragonFly BSD
  199. #endif
  200. #elif defined(__hpux)
  201. #define ZT_PLATFORM_NAME "hp-ux" // HP-UX
  202. #elif defined(_AIX)
  203. #define ZT_PLATFORM_NAME "aix" // IBM AIX
  204. #elif defined(__APPLE__) && defined(__MACH__) // Apple OSX and iOS (Darwin)
  205. #include <TargetConditionals.h>
  206. #if defined(TARGET_IPHONE_SIMULATOR) && TARGET_IPHONE_SIMULATOR == 1
  207. #define ZT_PLATFORM_NAME "ios_sim" // Apple iOS
  208. #elif defined(TARGET_OS_IPAD) && TARGET_OS_IPAD == 1
  209. #define ZT_PLATFORM_NAME "ios_ipad"
  210. #elif defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE == 1
  211. #define ZT_PLATFORM_NAME "ios_iphone" // Apple iOS
  212. #elif defined(TARGET_OS_MAC) && TARGET_OS_MAC == 1
  213. #define ZT_PLATFORM_NAME "macos" // Apple OSX
  214. #endif
  215. #elif defined(__sun) && defined(__SVR4)
  216. #define ZT_PLATFORM_NAME "solaris" // Oracle Solaris, Open Indiana
  217. #else
  218. #define ZT_PLATFORM_NAME "unknown"
  219. #endif
  220. #ifndef ZT_PLATFORM_NAME
  221. #define ZT_PLATFORM_NAME "unknown"
  222. #endif
  223. #if defined(__amd64) || defined(__amd64__) || defined(__x86_64) || defined(__x86_64__) || defined(__AMD64) || defined(__AMD64__) || defined(_M_X64) || defined(_M_AMD64)
  224. #define ZT_ARCH_NAME "x86_64"
  225. #elif defined(__i386__) || defined(__i486__) || defined(__i586__) || defined(__i686__) || defined(_X86_) || defined(_M_IX86) || defined(__X86__) || defined(__I86__) || defined(_M_I86)
  226. #define ZT_ARCH_NAME "x86"
  227. #elif defined(__aarch64__) || defined(__AARCH64EL__) || defined(_M_ARM64)
  228. #define ZT_ARCH_NAME "arm64"
  229. #elif defined(__arm__) || defined(__TARGET_ARCH_ARM) || defined(_ARM) || defined(_M_ARM) || defined(_M_ARMT) || defined(__arm) || defined(__thumb__)
  230. #define ZT_ARCH_NAME "arm"
  231. #elif defined(__loongarch__) || defined(_LOONGARCH_ARCH)
  232. #define ZT_ARCH_NAME "loongarch"
  233. #elif defined(__mips__) || defined(__MIPS__)
  234. #define ZT_ARCH_NAME "mips"
  235. #elif defined(__riscv) || defined(__riscv_xlen)
  236. #define ZT_ARCH_NAME "riscv"
  237. #elif defined(__powerpc__) || defined(__powerpc64__) || defined(__ppc__) || defined(__ppc64__) || defined(_M_PPC)
  238. #define ZT_ARCH_NAME "powerpc"
  239. #elif defined(__s390__) || defined(__s390x__) || defined(__zarch__)
  240. #define ZT_ARCH_NAME "s390"
  241. #else
  242. #define ZT_ARCH_NAME "unknown"
  243. #endif
  244. #ifndef ZT_ARCH_NAME
  245. #define ZT_ARCH_NAME "unknown"
  246. #endif
  247. #define ZT_TARGET_NAME (ZT_PLATFORM_NAME "/" ZT_ARCH_NAME)
  248. /**
  249. * Length of a ZeroTier address in bytes
  250. */
  251. #define ZT_ADDRESS_LENGTH 5
  252. /**
  253. * Length of a hexadecimal ZeroTier address
  254. */
  255. #define ZT_ADDRESS_LENGTH_HEX 10
  256. /**
  257. * Size of symmetric key (only the first 32 bits are used for some ciphers)
  258. */
  259. #define ZT_SYMMETRIC_KEY_SIZE 48
  260. /**
  261. * Addresses beginning with this byte are reserved for the joy of in-band signaling
  262. */
  263. #define ZT_ADDRESS_RESERVED_PREFIX 0xff
  264. /**
  265. * Default MTU used for Ethernet tap device
  266. */
  267. #define ZT_DEFAULT_MTU 2800
  268. /**
  269. * Maximum number of packet fragments we'll support (protocol max: 16)
  270. */
  271. #define ZT_MAX_PACKET_FRAGMENTS 7
  272. /**
  273. * Size of RX queue
  274. */
  275. #define ZT_RX_QUEUE_SIZE 32
  276. /**
  277. * Size of TX queue
  278. */
  279. #define ZT_TX_QUEUE_SIZE 32
  280. /**
  281. * Minimum delay between timer task checks to prevent thrashing
  282. */
  283. #define ZT_CORE_TIMER_TASK_GRANULARITY 60
  284. /**
  285. * How often Topology::clean() and Network::clean() and similar are called, in ms
  286. */
  287. #define ZT_HOUSEKEEPING_PERIOD 30000
  288. /**
  289. * Delay between WHOIS retries in ms
  290. */
  291. #define ZT_WHOIS_RETRY_DELAY 500
  292. /**
  293. * Transmit queue entry timeout
  294. */
  295. #define ZT_TRANSMIT_QUEUE_TIMEOUT 5000
  296. /**
  297. * Receive queue entry timeout
  298. */
  299. #define ZT_RECEIVE_QUEUE_TIMEOUT 5000
  300. /**
  301. * Maximum number of ZT hops allowed (this is not IP hops/TTL)
  302. *
  303. * The protocol allows up to 7, but we limit it to something smaller.
  304. */
  305. #define ZT_RELAY_MAX_HOPS 3
  306. /**
  307. * Expire time for multicast 'likes' and indirect multicast memberships in ms
  308. */
  309. #define ZT_MULTICAST_LIKE_EXPIRE 600000
  310. /**
  311. * Period for multicast LIKE announcements
  312. */
  313. #define ZT_MULTICAST_ANNOUNCE_PERIOD 60000
  314. /**
  315. * Delay between explicit MULTICAST_GATHER requests for a given multicast channel
  316. */
  317. #define ZT_MULTICAST_EXPLICIT_GATHER_DELAY (ZT_MULTICAST_LIKE_EXPIRE / 10)
  318. /**
  319. * Timeout for outgoing multicasts
  320. *
  321. * This is how long we wait for explicit or implicit gather results.
  322. */
  323. #define ZT_MULTICAST_TRANSMIT_TIMEOUT 5000
  324. /**
  325. * Delay between checks of peer pings, etc., and also related housekeeping tasks
  326. */
  327. #define ZT_PING_CHECK_INTERVAL 5000
  328. /**
  329. * How often the local.conf file is checked for changes (service, should be moved there)
  330. */
  331. #define ZT_LOCAL_CONF_FILE_CHECK_INTERVAL 10000
  332. /**
  333. * How frequently to send heartbeats over in-use paths
  334. */
  335. #define ZT_PATH_HEARTBEAT_PERIOD 14000
  336. /**
  337. * Do not accept HELLOs over a given path more often than this
  338. */
  339. #define ZT_PATH_HELLO_RATE_LIMIT 1000
  340. /**
  341. * Delay between full-fledge pings of directly connected peers
  342. */
  343. #define ZT_PEER_PING_PERIOD 60000
  344. /**
  345. * Paths are considered expired if they have not sent us a real packet in this long
  346. */
  347. #define ZT_PEER_PATH_EXPIRATION ((ZT_PEER_PING_PERIOD * 4) + 3000)
  348. /**
  349. * How often to retry expired paths that we're still remembering
  350. */
  351. #define ZT_PEER_EXPIRED_PATH_TRIAL_PERIOD (ZT_PEER_PING_PERIOD * 10)
  352. /**
  353. * Outgoing packets are only used for QoS/ACK statistical sampling if their
  354. * packet ID is divisible by this integer. This is to provide a mechanism for
  355. * both peers to agree on which packets need special treatment without having
  356. * to exchange information. Changing this value would be a breaking change and
  357. * would necessitate a protocol version upgrade. Since each incoming and
  358. * outgoing packet ID is checked against this value its evaluation is of the
  359. * form:
  360. *
  361. * (id & (divisor - 1)) == 0, thus the divisor must be a power of 2.
  362. *
  363. * This value is set at (16) so that given a normally-distributed RNG output
  364. * we will sample 1/16th (or ~6.25%) of packets.
  365. */
  366. #define ZT_QOS_ACK_DIVISOR 0x2
  367. /**
  368. * Time horizon for VERB_QOS_MEASUREMENT and VERB_ACK packet processing cutoff
  369. */
  370. #define ZT_QOS_ACK_CUTOFF_TIME 30000
  371. /**
  372. * Maximum number of VERB_QOS_MEASUREMENT and VERB_ACK packets allowed to be
  373. * processed within cutoff time. Separate totals are kept for each type but
  374. * the limit is the same for both.
  375. *
  376. * This limits how often this peer will compute statistical estimates
  377. * of various QoS measures from a VERB_QOS_MEASUREMENT or VERB_ACK packets to
  378. * CUTOFF_LIMIT times per CUTOFF_TIME milliseconds per peer to prevent
  379. * this from being useful for DOS amplification attacks.
  380. */
  381. #define ZT_QOS_ACK_CUTOFF_LIMIT 128
  382. /**
  383. * Minimum acceptable size for a VERB_QOS_MEASUREMENT packet
  384. */
  385. #define ZT_QOS_MIN_PACKET_SIZE (8 + 1)
  386. /**
  387. * Maximum acceptable size for a VERB_QOS_MEASUREMENT packet
  388. */
  389. #define ZT_QOS_MAX_PACKET_SIZE 1400
  390. /**
  391. * How many ID:sojourn time pairs are in a single QoS packet
  392. */
  393. #define ZT_QOS_TABLE_SIZE ((ZT_QOS_MAX_PACKET_SIZE * 8) / (64 + 16))
  394. /**
  395. * Maximum number of packets we monitor for ACK information at any given time
  396. */
  397. #define ZT_ACK_MAX_PENDING_RECORDS (32 * 1024)
  398. /**
  399. * Maximum number of packets we monitor for QoS information at any given time
  400. */
  401. #define ZT_QOS_MAX_PENDING_RECORDS (ZT_QOS_TABLE_SIZE * 3)
  402. /**
  403. * Interval used for rate-limiting the computation of path quality estimates.
  404. */
  405. #define ZT_QOS_COMPUTE_INTERVAL 1000
  406. /**
  407. * Number of samples to consider when processing real-time path statistics
  408. */
  409. #define ZT_QOS_SHORTTERM_SAMPLE_WIN_SIZE 64
  410. /**
  411. * Number of samples required before statistics summaries are computed
  412. */
  413. #define ZT_QOS_SHORTTERM_SAMPLE_WIN_MIN_REQ_SIZE 4
  414. /**
  415. * Max allowable time spent in any queue (in ms)
  416. */
  417. #define ZT_AQM_TARGET 5
  418. /**
  419. * Time period where the time spent in the queue by a packet should fall below.
  420. * target at least once. (in ms)
  421. */
  422. #define ZT_AQM_INTERVAL 100
  423. /**
  424. * The number of bytes that each queue is allowed to send during each DRR cycle.
  425. * This approximates a single-byte-based fairness queuing scheme.
  426. */
  427. #define ZT_AQM_QUANTUM ZT_DEFAULT_MTU
  428. /**
  429. * The maximum total number of packets that can be queued among all
  430. * active/inactive, old/new queues.
  431. */
  432. #define ZT_AQM_MAX_ENQUEUED_PACKETS 1024
  433. /**
  434. * Number of QoS queues (buckets)
  435. */
  436. #define ZT_AQM_NUM_BUCKETS 9
  437. /**
  438. * All unspecified traffic is put in this bucket. Anything in a bucket with a
  439. * smaller value is de-prioritized. Anything in a bucket with a higher value is
  440. prioritized over other traffic.
  441. */
  442. #define ZT_AQM_DEFAULT_BUCKET 0
  443. /**
  444. * Timeout for overall peer activity (measured from last receive)
  445. */
  446. #ifndef ZT_SDK
  447. #define ZT_PEER_ACTIVITY_TIMEOUT 500000
  448. #else
  449. #define ZT_PEER_ACTIVITY_TIMEOUT 30000
  450. #endif
  451. /**
  452. * General rate limit timeout for multiple packet types (HELLO, etc.)
  453. */
  454. #define ZT_PEER_GENERAL_INBOUND_RATE_LIMIT 500
  455. /**
  456. * General limit for max RTT for requests over the network
  457. */
  458. #define ZT_GENERAL_RTT_LIMIT 5000
  459. /**
  460. * Delay between requests for updated network autoconf information
  461. *
  462. * Don't lengthen this as it affects things like QoS / uptime monitoring
  463. * via ZeroTier Central. This is the heartbeat, basically.
  464. */
  465. #define ZT_NETWORK_AUTOCONF_DELAY 60000
  466. /**
  467. * Minimum interval between attempts by relays to unite peers
  468. *
  469. * When a relay gets a packet destined for another peer, it sends both peers
  470. * a RENDEZVOUS message no more than this often. This instructs the peers
  471. * to attempt NAT-t and gives each the other's corresponding IP:port pair.
  472. */
  473. #define ZT_MIN_UNITE_INTERVAL 30000
  474. /**
  475. * How often should peers try memorized or statically defined paths?
  476. */
  477. #define ZT_TRY_MEMORIZED_PATH_INTERVAL 30000
  478. /**
  479. * Sanity limit on maximum bridge routes
  480. *
  481. * If the number of bridge routes exceeds this, we cull routes from the
  482. * bridges with the most MACs behind them until it doesn't. This is a
  483. * sanity limit to prevent memory-filling DOS attacks, nothing more. No
  484. * physical LAN has anywhere even close to this many nodes. Note that this
  485. * does not limit the size of ZT virtual LANs, only bridge routing.
  486. */
  487. #define ZT_MAX_BRIDGE_ROUTES 67108864
  488. /**
  489. * If there is no known L2 bridging route, spam to up to this many active bridges
  490. */
  491. #define ZT_MAX_BRIDGE_SPAM 32
  492. /**
  493. * Interval between direct path pushes in milliseconds
  494. */
  495. #define ZT_DIRECT_PATH_PUSH_INTERVAL 15000
  496. /**
  497. * Interval between direct path pushes in milliseconds if we already have a path
  498. */
  499. #define ZT_DIRECT_PATH_PUSH_INTERVAL_HAVEPATH 120000
  500. /**
  501. * Time horizon for push direct paths cutoff
  502. */
  503. #define ZT_PUSH_DIRECT_PATHS_CUTOFF_TIME 30000
  504. /**
  505. * Drainage constants for VERB_ECHO rate-limiters
  506. */
  507. #define ZT_ECHO_CUTOFF_LIMIT ((1000 / ZT_CORE_TIMER_TASK_GRANULARITY) * ZT_MAX_PEER_NETWORK_PATHS)
  508. #define ZT_ECHO_DRAINAGE_DIVISOR (1000 / ZT_ECHO_CUTOFF_LIMIT)
  509. /**
  510. * Drainage constants for VERB_QOS rate-limiters
  511. */
  512. #define ZT_QOS_CUTOFF_LIMIT ((1000 / ZT_CORE_TIMER_TASK_GRANULARITY) * ZT_MAX_PEER_NETWORK_PATHS)
  513. #define ZT_QOS_DRAINAGE_DIVISOR (1000 / ZT_QOS_CUTOFF_LIMIT)
  514. /**
  515. * Drainage constants for VERB_ACK rate-limiters
  516. */
  517. #define ZT_ACK_CUTOFF_LIMIT 128
  518. #define ZT_ACK_DRAINAGE_DIVISOR (1000 / ZT_ACK_CUTOFF_LIMIT)
  519. #define ZT_BOND_DEFAULT_REFRACTORY_PERIOD 8000
  520. #define ZT_BOND_MAX_REFRACTORY_PERIOD 600000
  521. /**
  522. * Maximum number of direct path pushes within cutoff time
  523. *
  524. * This limits response to PUSH_DIRECT_PATHS to CUTOFF_LIMIT responses
  525. * per CUTOFF_TIME milliseconds per peer to prevent this from being
  526. * useful for DOS amplification attacks.
  527. */
  528. #define ZT_PUSH_DIRECT_PATHS_CUTOFF_LIMIT 8
  529. /**
  530. * Maximum number of paths per IP scope (e.g. global, link-local) and family (e.g. v4/v6)
  531. */
  532. #define ZT_PUSH_DIRECT_PATHS_MAX_PER_SCOPE_AND_FAMILY 8
  533. /**
  534. * Rate limit for network credential pushes from peer.
  535. */
  536. #define ZT_PEER_CREDENTIALS_RATE_LIMIT 1000
  537. /**
  538. * Rate limit for responding to peer credential requests
  539. */
  540. #define ZT_PEER_CREDENTIALS_REQUEST_RATE_LIMIT 1000
  541. /**
  542. * WHOIS rate limit (we allow these to be pretty fast)
  543. */
  544. #define ZT_PEER_WHOIS_RATE_LIMIT 100
  545. /**
  546. * General rate limit for other kinds of rate-limited packets (HELLO, credential request, etc.) both inbound and outbound
  547. */
  548. #define ZT_PEER_GENERAL_RATE_LIMIT 1000
  549. /**
  550. * Minimum allowed amount of time between flow/path optimizations (anti-flapping)
  551. */
  552. #define ZT_BOND_OPTIMIZE_INTERVAL 15000
  553. /**
  554. * Maximum number of flows allowed before we start forcibly forgetting old ones
  555. */
  556. #define ZT_FLOW_MAX_COUNT (1024 * 64)
  557. /**
  558. * How often we emit a bond summary for each bond
  559. */
  560. #define ZT_BOND_STATUS_INTERVAL 30000
  561. /**
  562. * How long before we consider a path to be dead in the general sense. This is
  563. * used while searching for default or alternative paths to try in the absence
  564. * of direct guidance from the user or a selection policy.
  565. */
  566. #define ZT_BOND_FAILOVER_DEFAULT_INTERVAL 5000
  567. /**
  568. * Anything below this value gets into thrashing territory since we divide
  569. * this value by ZT_BOND_ECHOS_PER_FAILOVER_INTERVAL to send ECHOs often.
  570. */
  571. #define ZT_BOND_FAILOVER_MIN_INTERVAL 500
  572. /**
  573. * How many times per failover interval that an ECHO is sent. This should be
  574. * at least 2. Anything more then 4 starts to increase overhead significantly.
  575. */
  576. #define ZT_BOND_ECHOS_PER_FAILOVER_INTERVAL 3
  577. /**
  578. * A defensive timer to prevent path quality metrics from being
  579. * processed too often.
  580. */
  581. #define ZT_BOND_BACKGROUND_TASK_MIN_INTERVAL ZT_CORE_TIMER_TASK_GRANULARITY
  582. /**
  583. * How often a bonding policy's background tasks are processed,
  584. * some need more frequent attention than others.
  585. */
  586. #define ZT_BOND_ACTIVE_BACKUP_CHECK_INTERVAL ZT_CORE_TIMER_TASK_GRANULARITY
  587. /**
  588. * Time horizon for path negotiation paths cutoff
  589. */
  590. #define ZT_PATH_NEGOTIATION_CUTOFF_TIME 60000
  591. /**
  592. * Maximum number of path negotiations within cutoff time
  593. *
  594. * This limits response to PATH_NEGOTIATION to CUTOFF_LIMIT responses
  595. * per CUTOFF_TIME milliseconds per peer to prevent this from being
  596. * useful for DOS amplification attacks.
  597. */
  598. #define ZT_PATH_NEGOTIATION_CUTOFF_LIMIT 8
  599. /**
  600. * How many times a peer will attempt to petition another peer to synchronize its
  601. * traffic to the same path before giving up and surrendering to the other peer's preference.
  602. */
  603. #define ZT_PATH_NEGOTIATION_TRY_COUNT 3
  604. /**
  605. * How much greater the quality of a path should be before an
  606. * optimization procedure triggers a switch.
  607. */
  608. #define ZT_BOND_ACTIVE_BACKUP_OPTIMIZE_MIN_THRESHOLD 0.10
  609. /**
  610. * Artificially inflates the failover score for paths which meet
  611. * certain non-performance-related policy ranking criteria.
  612. */
  613. #define ZT_BOND_FAILOVER_HANDICAP_PREFERRED 500
  614. #define ZT_BOND_FAILOVER_HANDICAP_PRIMARY 1000
  615. #define ZT_BOND_FAILOVER_HANDICAP_NEGOTIATED 5000
  616. /**
  617. * An indicator that no flow is to be associated with the given packet
  618. */
  619. #define ZT_QOS_NO_FLOW -1
  620. /**
  621. * Don't do expensive identity validation more often than this
  622. *
  623. * IPv4 and IPv6 address prefixes are hashed down to 14-bit (0-16383) integers
  624. * using the first 24 bits for IPv4 or the first 48 bits for IPv6. These are
  625. * then rate limited to one identity validation per this often milliseconds.
  626. */
  627. #if (defined(__amd64) || defined(__amd64__) || defined(__x86_64) || defined(__x86_64__) || defined(__AMD64) || defined(__AMD64__) || defined(_M_X64) || defined(_M_AMD64))
  628. // AMD64 machines can do anywhere from one every 50ms to one every 10ms. This provides plenty of margin.
  629. #define ZT_IDENTITY_VALIDATION_SOURCE_RATE_LIMIT 2000
  630. #else
  631. #if (defined(__i386__) || defined(__i486__) || defined(__i586__) || defined(__i686__) || defined(_M_IX86) || defined(_X86_) || defined(__I86__))
  632. // 32-bit Intel machines usually average about one every 100ms
  633. #define ZT_IDENTITY_VALIDATION_SOURCE_RATE_LIMIT 5000
  634. #else
  635. // This provides a safe margin for ARM, MIPS, etc. that usually average one every 250-400ms
  636. #define ZT_IDENTITY_VALIDATION_SOURCE_RATE_LIMIT 10000
  637. #endif
  638. #endif
  639. /**
  640. * How long is a path or peer considered to have a trust relationship with us (for e.g. relay policy) since last trusted established packet?
  641. */
  642. #define ZT_TRUST_EXPIRATION 600000
  643. /**
  644. * Desired buffer size for UDP sockets (used in service and osdep but defined here)
  645. */
  646. #define ZT_UDP_DESIRED_BUF_SIZE 1048576
  647. /**
  648. * Desired / recommended min stack size for threads (used on some platforms to reset thread stack size)
  649. */
  650. #define ZT_THREAD_MIN_STACK_SIZE 1048576
  651. // Exceptions thrown in core ZT code
  652. #define ZT_EXCEPTION_OUT_OF_BOUNDS 100
  653. #define ZT_EXCEPTION_OUT_OF_MEMORY 101
  654. #define ZT_EXCEPTION_PRIVATE_KEY_REQUIRED 102
  655. #define ZT_EXCEPTION_INVALID_ARGUMENT 103
  656. #define ZT_EXCEPTION_INVALID_IDENTITY 104
  657. #define ZT_EXCEPTION_INVALID_SERIALIZED_DATA_INVALID_TYPE 200
  658. #define ZT_EXCEPTION_INVALID_SERIALIZED_DATA_OVERFLOW 201
  659. #define ZT_EXCEPTION_INVALID_SERIALIZED_DATA_INVALID_CRYPTOGRAPHIC_TOKEN 202
  660. #define ZT_EXCEPTION_INVALID_SERIALIZED_DATA_BAD_ENCODING 203
  661. #endif