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