curl_setup.h 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886
  1. #ifndef HEADER_CURL_SETUP_H
  2. #define HEADER_CURL_SETUP_H
  3. /***************************************************************************
  4. * _ _ ____ _
  5. * Project ___| | | | _ \| |
  6. * / __| | | | |_) | |
  7. * | (__| |_| | _ <| |___
  8. * \___|\___/|_| \_\_____|
  9. *
  10. * Copyright (C) Daniel Stenberg, <[email protected]>, et al.
  11. *
  12. * This software is licensed as described in the file COPYING, which
  13. * you should have received as part of this distribution. The terms
  14. * are also available at https://curl.se/docs/copyright.html.
  15. *
  16. * You may opt to use, copy, modify, merge, publish, distribute and/or sell
  17. * copies of the Software, and permit persons to whom the Software is
  18. * furnished to do so, under the terms of the COPYING file.
  19. *
  20. * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  21. * KIND, either express or implied.
  22. *
  23. * SPDX-License-Identifier: curl
  24. *
  25. ***************************************************************************/
  26. #if defined(BUILDING_LIBCURL) && !defined(CURL_NO_OLDIES)
  27. #define CURL_NO_OLDIES
  28. #endif
  29. /* FIXME: Delete this once the warnings have been fixed. */
  30. #if !defined(CURL_WARN_SIGN_CONVERSION)
  31. #ifdef __GNUC__
  32. #pragma GCC diagnostic ignored "-Wsign-conversion"
  33. #endif
  34. #endif
  35. /* Set default _WIN32_WINNT */
  36. #ifdef __MINGW32__
  37. #include <_mingw.h>
  38. #endif
  39. /*
  40. * Disable Visual Studio warnings:
  41. * 4127 "conditional expression is constant"
  42. */
  43. #ifdef _MSC_VER
  44. #pragma warning(disable:4127)
  45. #endif
  46. #ifdef _WIN32
  47. /*
  48. * Don't include unneeded stuff in Windows headers to avoid compiler
  49. * warnings and macro clashes.
  50. * Make sure to define this macro before including any Windows headers.
  51. */
  52. # ifndef WIN32_LEAN_AND_MEAN
  53. # define WIN32_LEAN_AND_MEAN
  54. # endif
  55. # ifndef NOGDI
  56. # define NOGDI
  57. # endif
  58. /* Detect Windows App environment which has a restricted access
  59. * to the Win32 APIs. */
  60. # if (defined(_WIN32_WINNT) && (_WIN32_WINNT >= 0x0602)) || \
  61. defined(WINAPI_FAMILY)
  62. # include <winapifamily.h>
  63. # if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP) && \
  64. !WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP)
  65. # define CURL_WINDOWS_APP
  66. # endif
  67. # endif
  68. #endif
  69. /*
  70. * Include configuration script results or hand-crafted
  71. * configuration file for platforms which lack config tool.
  72. */
  73. #ifdef HAVE_CONFIG_H
  74. #include "curl_config.h"
  75. #else /* HAVE_CONFIG_H */
  76. #ifdef _WIN32_WCE
  77. # include "config-win32ce.h"
  78. #else
  79. # ifdef _WIN32
  80. # include "config-win32.h"
  81. # endif
  82. #endif
  83. #ifdef macintosh
  84. # include "config-mac.h"
  85. #endif
  86. #ifdef __riscos__
  87. # include "config-riscos.h"
  88. #endif
  89. #ifdef __AMIGA__
  90. # include "config-amigaos.h"
  91. #endif
  92. #ifdef __OS400__
  93. # include "config-os400.h"
  94. #endif
  95. #ifdef __PLAN9__
  96. # include "config-plan9.h"
  97. #endif
  98. #ifdef MSDOS
  99. # include "config-dos.h"
  100. #endif
  101. #endif /* HAVE_CONFIG_H */
  102. /* ================================================================ */
  103. /* Definition of preprocessor macros/symbols which modify compiler */
  104. /* behavior or generated code characteristics must be done here, */
  105. /* as appropriate, before any system header file is included. It is */
  106. /* also possible to have them defined in the config file included */
  107. /* before this point. As a result of all this we frown inclusion of */
  108. /* system header files in our config files, avoid this at any cost. */
  109. /* ================================================================ */
  110. /*
  111. * AIX 4.3 and newer needs _THREAD_SAFE defined to build
  112. * proper reentrant code. Others may also need it.
  113. */
  114. #ifdef NEED_THREAD_SAFE
  115. # ifndef _THREAD_SAFE
  116. # define _THREAD_SAFE
  117. # endif
  118. #endif
  119. /*
  120. * Tru64 needs _REENTRANT set for a few function prototypes and
  121. * things to appear in the system header files. Unixware needs it
  122. * to build proper reentrant code. Others may also need it.
  123. */
  124. #ifdef NEED_REENTRANT
  125. # ifndef _REENTRANT
  126. # define _REENTRANT
  127. # endif
  128. #endif
  129. /* Solaris needs this to get a POSIX-conformant getpwuid_r */
  130. #if defined(sun) || defined(__sun)
  131. # ifndef _POSIX_PTHREAD_SEMANTICS
  132. # define _POSIX_PTHREAD_SEMANTICS 1
  133. # endif
  134. #endif
  135. /* ================================================================ */
  136. /* If you need to include a system header file for your platform, */
  137. /* please, do it beyond the point further indicated in this file. */
  138. /* ================================================================ */
  139. /*
  140. * Disable other protocols when http is the only one desired.
  141. */
  142. #ifdef HTTP_ONLY
  143. # ifndef CURL_DISABLE_DICT
  144. # define CURL_DISABLE_DICT
  145. # endif
  146. # ifndef CURL_DISABLE_FILE
  147. # define CURL_DISABLE_FILE
  148. # endif
  149. # ifndef CURL_DISABLE_FTP
  150. # define CURL_DISABLE_FTP
  151. # endif
  152. # ifndef CURL_DISABLE_GOPHER
  153. # define CURL_DISABLE_GOPHER
  154. # endif
  155. # ifndef CURL_DISABLE_IMAP
  156. # define CURL_DISABLE_IMAP
  157. # endif
  158. # ifndef CURL_DISABLE_LDAP
  159. # define CURL_DISABLE_LDAP
  160. # endif
  161. # ifndef CURL_DISABLE_LDAPS
  162. # define CURL_DISABLE_LDAPS
  163. # endif
  164. # ifndef CURL_DISABLE_MQTT
  165. # define CURL_DISABLE_MQTT
  166. # endif
  167. # ifndef CURL_DISABLE_POP3
  168. # define CURL_DISABLE_POP3
  169. # endif
  170. # ifndef CURL_DISABLE_RTSP
  171. # define CURL_DISABLE_RTSP
  172. # endif
  173. # ifndef CURL_DISABLE_SMB
  174. # define CURL_DISABLE_SMB
  175. # endif
  176. # ifndef CURL_DISABLE_SMTP
  177. # define CURL_DISABLE_SMTP
  178. # endif
  179. # ifndef CURL_DISABLE_TELNET
  180. # define CURL_DISABLE_TELNET
  181. # endif
  182. # ifndef CURL_DISABLE_TFTP
  183. # define CURL_DISABLE_TFTP
  184. # endif
  185. #endif
  186. /*
  187. * When http is disabled rtsp is not supported.
  188. */
  189. #if defined(CURL_DISABLE_HTTP) && !defined(CURL_DISABLE_RTSP)
  190. # define CURL_DISABLE_RTSP
  191. #endif
  192. /*
  193. * When HTTP is disabled, disable HTTP-only features
  194. */
  195. #if defined(CURL_DISABLE_HTTP)
  196. # define CURL_DISABLE_ALTSVC 1
  197. # define CURL_DISABLE_COOKIES 1
  198. # define CURL_DISABLE_BASIC_AUTH 1
  199. # define CURL_DISABLE_BEARER_AUTH 1
  200. # define CURL_DISABLE_AWS 1
  201. # define CURL_DISABLE_DOH 1
  202. # define CURL_DISABLE_FORM_API 1
  203. # define CURL_DISABLE_HEADERS_API 1
  204. # define CURL_DISABLE_HSTS 1
  205. # define CURL_DISABLE_HTTP_AUTH 1
  206. #endif
  207. /* ================================================================ */
  208. /* No system header file shall be included in this file before this */
  209. /* point. */
  210. /* ================================================================ */
  211. /*
  212. * OS/400 setup file includes some system headers.
  213. */
  214. #ifdef __OS400__
  215. # include "setup-os400.h"
  216. #endif
  217. /*
  218. * VMS setup file includes some system headers.
  219. */
  220. #ifdef __VMS
  221. # include "setup-vms.h"
  222. #endif
  223. /*
  224. * Windows setup file includes some system headers.
  225. */
  226. #ifdef _WIN32
  227. # include "setup-win32.h"
  228. #endif
  229. #include <curl/system.h>
  230. /* Helper macro to expand and concatenate two macros.
  231. * Direct macros concatenation does not work because macros
  232. * are not expanded before direct concatenation.
  233. */
  234. #define CURL_CONC_MACROS_(A,B) A ## B
  235. #define CURL_CONC_MACROS(A,B) CURL_CONC_MACROS_(A,B)
  236. /* curl uses its own printf() function internally. It understands the GNU
  237. * format. Use this format, so that is matches the GNU format attribute we
  238. * use with the mingw compiler, allowing it to verify them at compile-time.
  239. */
  240. #ifdef __MINGW32__
  241. # undef CURL_FORMAT_CURL_OFF_T
  242. # undef CURL_FORMAT_CURL_OFF_TU
  243. # define CURL_FORMAT_CURL_OFF_T "lld"
  244. # define CURL_FORMAT_CURL_OFF_TU "llu"
  245. #endif
  246. /* based on logic in "curl/mprintf.h" */
  247. #if (defined(__GNUC__) || defined(__clang__)) && \
  248. defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L) && \
  249. !defined(CURL_NO_FMT_CHECKS)
  250. #if defined(__MINGW32__) && !defined(__clang__)
  251. #define CURL_PRINTF(fmt, arg) \
  252. __attribute__((format(gnu_printf, fmt, arg)))
  253. #else
  254. #define CURL_PRINTF(fmt, arg) \
  255. __attribute__((format(__printf__, fmt, arg)))
  256. #endif
  257. #else
  258. #define CURL_PRINTF(fmt, arg)
  259. #endif
  260. /*
  261. * Use getaddrinfo to resolve the IPv4 address literal. If the current network
  262. * interface doesn't support IPv4, but supports IPv6, NAT64, and DNS64,
  263. * performing this task will result in a synthesized IPv6 address.
  264. */
  265. #if defined(__APPLE__) && !defined(USE_ARES)
  266. #include <TargetConditionals.h>
  267. #define USE_RESOLVE_ON_IPS 1
  268. # if TARGET_OS_MAC && !(defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE) && \
  269. defined(ENABLE_IPV6)
  270. # define CURL_MACOS_CALL_COPYPROXIES 1
  271. # endif
  272. #endif
  273. #ifdef USE_LWIPSOCK
  274. # include <lwip/init.h>
  275. # include <lwip/sockets.h>
  276. # include <lwip/netdb.h>
  277. #endif
  278. #ifdef HAVE_EXTRA_STRICMP_H
  279. # include <extra/stricmp.h>
  280. #endif
  281. #ifdef HAVE_EXTRA_STRDUP_H
  282. # include <extra/strdup.h>
  283. #endif
  284. #ifdef __AMIGA__
  285. # ifdef __amigaos4__
  286. # define __USE_INLINE__
  287. /* use our own resolver which uses runtime feature detection */
  288. # define CURLRES_AMIGA
  289. /* getaddrinfo() currently crashes bsdsocket.library, so disable */
  290. # undef HAVE_GETADDRINFO
  291. # if !(defined(__NEWLIB__) || \
  292. (defined(__CLIB2__) && defined(__THREAD_SAFE)))
  293. /* disable threaded resolver with clib2 - requires newlib or clib-ts */
  294. # undef USE_THREADS_POSIX
  295. # endif
  296. # endif
  297. # include <exec/types.h>
  298. # include <exec/execbase.h>
  299. # include <proto/exec.h>
  300. # include <proto/dos.h>
  301. # include <unistd.h>
  302. # if defined(HAVE_PROTO_BSDSOCKET_H) && \
  303. (!defined(__amigaos4__) || defined(USE_AMISSL))
  304. /* use bsdsocket.library directly, instead of libc networking functions */
  305. # define _SYS_MBUF_H /* m_len define clashes with curl */
  306. # include <proto/bsdsocket.h>
  307. # ifdef __amigaos4__
  308. int Curl_amiga_select(int nfds, fd_set *readfds, fd_set *writefds,
  309. fd_set *errorfds, struct timeval *timeout);
  310. # define select(a,b,c,d,e) Curl_amiga_select(a,b,c,d,e)
  311. # else
  312. # define select(a,b,c,d,e) WaitSelect(a,b,c,d,e,0)
  313. # endif
  314. /* must not use libc's fcntl() on bsdsocket.library sockfds! */
  315. # undef HAVE_FCNTL
  316. # undef HAVE_FCNTL_O_NONBLOCK
  317. # else
  318. /* use libc networking and hence close() and fnctl() */
  319. # undef HAVE_CLOSESOCKET_CAMEL
  320. # undef HAVE_IOCTLSOCKET_CAMEL
  321. # endif
  322. /*
  323. * In clib2 arpa/inet.h warns that some prototypes may clash
  324. * with bsdsocket.library. This avoids the definition of those.
  325. */
  326. # define __NO_NET_API
  327. #endif
  328. #include <stdio.h>
  329. #include <assert.h>
  330. #ifdef __TANDEM /* for ns*-tandem-nsk systems */
  331. # if ! defined __LP64
  332. # include <floss.h> /* FLOSS is only used for 32-bit builds. */
  333. # endif
  334. #endif
  335. #ifndef STDC_HEADERS /* no standard C headers! */
  336. #include <curl/stdcheaders.h>
  337. #endif
  338. /*
  339. * Large file (>2Gb) support using WIN32 functions.
  340. */
  341. #ifdef USE_WIN32_LARGE_FILES
  342. # include <io.h>
  343. # include <sys/types.h>
  344. # include <sys/stat.h>
  345. # undef lseek
  346. # define lseek(fdes,offset,whence) _lseeki64(fdes, offset, whence)
  347. # undef fstat
  348. # define fstat(fdes,stp) _fstati64(fdes, stp)
  349. # undef stat
  350. # define stat(fname,stp) curlx_win32_stat(fname, stp)
  351. # define struct_stat struct _stati64
  352. # define LSEEK_ERROR (__int64)-1
  353. # define open curlx_win32_open
  354. # define fopen(fname,mode) curlx_win32_fopen(fname, mode)
  355. # define access(fname,mode) curlx_win32_access(fname, mode)
  356. int curlx_win32_open(const char *filename, int oflag, ...);
  357. int curlx_win32_stat(const char *path, struct_stat *buffer);
  358. FILE *curlx_win32_fopen(const char *filename, const char *mode);
  359. int curlx_win32_access(const char *path, int mode);
  360. #endif
  361. /*
  362. * Small file (<2Gb) support using WIN32 functions.
  363. */
  364. #ifdef USE_WIN32_SMALL_FILES
  365. # include <io.h>
  366. # include <sys/types.h>
  367. # include <sys/stat.h>
  368. # ifndef _WIN32_WCE
  369. # undef lseek
  370. # define lseek(fdes,offset,whence) _lseek(fdes, (long)offset, whence)
  371. # define fstat(fdes,stp) _fstat(fdes, stp)
  372. # define stat(fname,stp) curlx_win32_stat(fname, stp)
  373. # define struct_stat struct _stat
  374. # define open curlx_win32_open
  375. # define fopen(fname,mode) curlx_win32_fopen(fname, mode)
  376. # define access(fname,mode) curlx_win32_access(fname, mode)
  377. int curlx_win32_stat(const char *path, struct_stat *buffer);
  378. int curlx_win32_open(const char *filename, int oflag, ...);
  379. FILE *curlx_win32_fopen(const char *filename, const char *mode);
  380. int curlx_win32_access(const char *path, int mode);
  381. # endif
  382. # define LSEEK_ERROR (long)-1
  383. #endif
  384. #ifndef struct_stat
  385. # define struct_stat struct stat
  386. #endif
  387. #ifndef LSEEK_ERROR
  388. # define LSEEK_ERROR (off_t)-1
  389. #endif
  390. #ifndef SIZEOF_TIME_T
  391. /* assume default size of time_t to be 32 bit */
  392. #define SIZEOF_TIME_T 4
  393. #endif
  394. #ifndef SIZEOF_CURL_SOCKET_T
  395. /* configure and cmake check and set the define */
  396. # ifdef _WIN64
  397. # define SIZEOF_CURL_SOCKET_T 8
  398. # else
  399. /* default guess */
  400. # define SIZEOF_CURL_SOCKET_T 4
  401. # endif
  402. #endif
  403. #if SIZEOF_CURL_SOCKET_T < 8
  404. # define CURL_FORMAT_SOCKET_T "d"
  405. #elif defined(__MINGW32__)
  406. # define CURL_FORMAT_SOCKET_T "zd"
  407. #else
  408. # define CURL_FORMAT_SOCKET_T "qd"
  409. #endif
  410. /*
  411. * Default sizeof(off_t) in case it hasn't been defined in config file.
  412. */
  413. #ifndef SIZEOF_OFF_T
  414. # if defined(__VMS) && !defined(__VAX)
  415. # if defined(_LARGEFILE)
  416. # define SIZEOF_OFF_T 8
  417. # endif
  418. # elif defined(__OS400__) && defined(__ILEC400__)
  419. # if defined(_LARGE_FILES)
  420. # define SIZEOF_OFF_T 8
  421. # endif
  422. # elif defined(__MVS__) && defined(__IBMC__)
  423. # if defined(_LP64) || defined(_LARGE_FILES)
  424. # define SIZEOF_OFF_T 8
  425. # endif
  426. # elif defined(__370__) && defined(__IBMC__)
  427. # if defined(_LP64) || defined(_LARGE_FILES)
  428. # define SIZEOF_OFF_T 8
  429. # endif
  430. # endif
  431. # ifndef SIZEOF_OFF_T
  432. # define SIZEOF_OFF_T 4
  433. # endif
  434. #endif
  435. #if (SIZEOF_CURL_OFF_T < 8)
  436. #error "too small curl_off_t"
  437. #else
  438. /* assume SIZEOF_CURL_OFF_T == 8 */
  439. # define CURL_OFF_T_MAX CURL_OFF_T_C(0x7FFFFFFFFFFFFFFF)
  440. #endif
  441. #define CURL_OFF_T_MIN (-CURL_OFF_T_MAX - CURL_OFF_T_C(1))
  442. #if (SIZEOF_CURL_OFF_T != 8)
  443. # error "curl_off_t must be exactly 64 bits"
  444. #else
  445. typedef unsigned CURL_TYPEOF_CURL_OFF_T curl_uint64_t;
  446. # ifndef CURL_SUFFIX_CURL_OFF_TU
  447. # error "CURL_SUFFIX_CURL_OFF_TU must be defined"
  448. # endif
  449. # define CURL_UINT64_SUFFIX CURL_SUFFIX_CURL_OFF_TU
  450. # define CURL_UINT64_C(val) CURL_CONC_MACROS(val,CURL_UINT64_SUFFIX)
  451. #endif
  452. #if (SIZEOF_TIME_T == 4)
  453. # ifdef HAVE_TIME_T_UNSIGNED
  454. # define TIME_T_MAX UINT_MAX
  455. # define TIME_T_MIN 0
  456. # else
  457. # define TIME_T_MAX INT_MAX
  458. # define TIME_T_MIN INT_MIN
  459. # endif
  460. #else
  461. # ifdef HAVE_TIME_T_UNSIGNED
  462. # define TIME_T_MAX 0xFFFFFFFFFFFFFFFF
  463. # define TIME_T_MIN 0
  464. # else
  465. # define TIME_T_MAX 0x7FFFFFFFFFFFFFFF
  466. # define TIME_T_MIN (-TIME_T_MAX - 1)
  467. # endif
  468. #endif
  469. #ifndef SIZE_T_MAX
  470. /* some limits.h headers have this defined, some don't */
  471. #if defined(SIZEOF_SIZE_T) && (SIZEOF_SIZE_T > 4)
  472. #define SIZE_T_MAX 18446744073709551615U
  473. #else
  474. #define SIZE_T_MAX 4294967295U
  475. #endif
  476. #endif
  477. #ifndef SSIZE_T_MAX
  478. /* some limits.h headers have this defined, some don't */
  479. #if defined(SIZEOF_SIZE_T) && (SIZEOF_SIZE_T > 4)
  480. #define SSIZE_T_MAX 9223372036854775807
  481. #else
  482. #define SSIZE_T_MAX 2147483647
  483. #endif
  484. #endif
  485. /*
  486. * Arg 2 type for gethostname in case it hasn't been defined in config file.
  487. */
  488. #ifndef GETHOSTNAME_TYPE_ARG2
  489. # ifdef USE_WINSOCK
  490. # define GETHOSTNAME_TYPE_ARG2 int
  491. # else
  492. # define GETHOSTNAME_TYPE_ARG2 size_t
  493. # endif
  494. #endif
  495. /* Below we define some functions. They should
  496. 4. set the SIGALRM signal timeout
  497. 5. set dir/file naming defines
  498. */
  499. #ifdef _WIN32
  500. # define DIR_CHAR "\\"
  501. #else /* _WIN32 */
  502. # ifdef MSDOS /* Watt-32 */
  503. # include <sys/ioctl.h>
  504. # define select(n,r,w,x,t) select_s(n,r,w,x,t)
  505. # define ioctl(x,y,z) ioctlsocket(x,y,(char *)(z))
  506. # include <tcp.h>
  507. # ifdef word
  508. # undef word
  509. # endif
  510. # ifdef byte
  511. # undef byte
  512. # endif
  513. # endif /* MSDOS */
  514. # ifdef __minix
  515. /* Minix 3 versions up to at least 3.1.3 are missing these prototypes */
  516. extern char *strtok_r(char *s, const char *delim, char **last);
  517. extern struct tm *gmtime_r(const time_t * const timep, struct tm *tmp);
  518. # endif
  519. # define DIR_CHAR "/"
  520. #endif /* _WIN32 */
  521. /* ---------------------------------------------------------------- */
  522. /* resolver specialty compile-time defines */
  523. /* CURLRES_* defines to use in the host*.c sources */
  524. /* ---------------------------------------------------------------- */
  525. /*
  526. * MSVC threads support requires a multi-threaded runtime library.
  527. * _beginthreadex() is not available in single-threaded ones.
  528. */
  529. #if defined(_MSC_VER) && !defined(_MT)
  530. # undef USE_THREADS_POSIX
  531. # undef USE_THREADS_WIN32
  532. #endif
  533. /*
  534. * Mutually exclusive CURLRES_* definitions.
  535. */
  536. #if defined(ENABLE_IPV6) && defined(HAVE_GETADDRINFO)
  537. # define CURLRES_IPV6
  538. #elif defined(ENABLE_IPV6) && (defined(_WIN32) || defined(__CYGWIN__))
  539. /* assume on Windows that IPv6 without getaddrinfo is a broken build */
  540. # error "Unexpected build: IPv6 is enabled but getaddrinfo was not found."
  541. #else
  542. # define CURLRES_IPV4
  543. #endif
  544. #ifdef USE_ARES
  545. # define CURLRES_ASYNCH
  546. # define CURLRES_ARES
  547. /* now undef the stock libc functions just to avoid them being used */
  548. # undef HAVE_GETADDRINFO
  549. # undef HAVE_FREEADDRINFO
  550. #elif defined(USE_THREADS_POSIX) || defined(USE_THREADS_WIN32)
  551. # define CURLRES_ASYNCH
  552. # define CURLRES_THREADED
  553. #else
  554. # define CURLRES_SYNCH
  555. #endif
  556. /* ---------------------------------------------------------------- */
  557. #if defined(HAVE_LIBIDN2) && defined(HAVE_IDN2_H) && !defined(USE_WIN32_IDN)
  558. /* The lib and header are present */
  559. #define USE_LIBIDN2
  560. #endif
  561. #if defined(USE_LIBIDN2) && defined(USE_WIN32_IDN)
  562. #error "Both libidn2 and WinIDN are enabled, choose one."
  563. #endif
  564. #define LIBIDN_REQUIRED_VERSION "0.4.1"
  565. #if defined(USE_GNUTLS) || defined(USE_OPENSSL) || defined(USE_MBEDTLS) || \
  566. defined(USE_WOLFSSL) || defined(USE_SCHANNEL) || defined(USE_SECTRANSP) || \
  567. defined(USE_BEARSSL) || defined(USE_RUSTLS)
  568. #define USE_SSL /* SSL support has been enabled */
  569. #endif
  570. /* Single point where USE_SPNEGO definition might be defined */
  571. #if !defined(CURL_DISABLE_NEGOTIATE_AUTH) && \
  572. (defined(HAVE_GSSAPI) || defined(USE_WINDOWS_SSPI))
  573. #define USE_SPNEGO
  574. #endif
  575. /* Single point where USE_KERBEROS5 definition might be defined */
  576. #if !defined(CURL_DISABLE_KERBEROS_AUTH) && \
  577. (defined(HAVE_GSSAPI) || defined(USE_WINDOWS_SSPI))
  578. #define USE_KERBEROS5
  579. #endif
  580. /* Single point where USE_NTLM definition might be defined */
  581. #if !defined(CURL_DISABLE_NTLM)
  582. # if defined(USE_OPENSSL) || defined(USE_MBEDTLS) || \
  583. defined(USE_GNUTLS) || defined(USE_SECTRANSP) || \
  584. defined(USE_OS400CRYPTO) || defined(USE_WIN32_CRYPTO) || \
  585. (defined(USE_WOLFSSL) && defined(HAVE_WOLFSSL_DES_ECB_ENCRYPT))
  586. # define USE_CURL_NTLM_CORE
  587. # endif
  588. # if defined(USE_CURL_NTLM_CORE) || defined(USE_WINDOWS_SSPI)
  589. # define USE_NTLM
  590. # endif
  591. #endif
  592. #ifdef CURL_WANTS_CA_BUNDLE_ENV
  593. #error "No longer supported. Set CURLOPT_CAINFO at runtime instead."
  594. #endif
  595. #if defined(USE_LIBSSH2) || defined(USE_LIBSSH) || defined(USE_WOLFSSH)
  596. #define USE_SSH
  597. #endif
  598. /*
  599. * Provide a mechanism to silence picky compilers, such as gcc 4.6+.
  600. * Parameters should of course normally not be unused, but for example when
  601. * we have multiple implementations of the same interface it may happen.
  602. */
  603. #if defined(__GNUC__) && ((__GNUC__ >= 3) || \
  604. ((__GNUC__ == 2) && defined(__GNUC_MINOR__) && (__GNUC_MINOR__ >= 7)))
  605. # define UNUSED_PARAM __attribute__((__unused__))
  606. # define WARN_UNUSED_RESULT __attribute__((warn_unused_result))
  607. #else
  608. # define UNUSED_PARAM /* NOTHING */
  609. # define WARN_UNUSED_RESULT
  610. #endif
  611. /* noreturn attribute */
  612. #if !defined(CURL_NORETURN)
  613. #if (defined(__GNUC__) && (__GNUC__ >= 3)) || defined(__clang__)
  614. # define CURL_NORETURN __attribute__((__noreturn__))
  615. #elif defined(_MSC_VER) && (_MSC_VER >= 1200)
  616. # define CURL_NORETURN __declspec(noreturn)
  617. #else
  618. # define CURL_NORETURN
  619. #endif
  620. #endif
  621. /* fallthrough attribute */
  622. #if !defined(FALLTHROUGH)
  623. #if (defined(__GNUC__) && __GNUC__ >= 7) || \
  624. (defined(__clang__) && __clang_major__ >= 10)
  625. # define FALLTHROUGH() __attribute__((fallthrough))
  626. #else
  627. # define FALLTHROUGH() do {} while (0)
  628. #endif
  629. #endif
  630. /*
  631. * Include macros and defines that should only be processed once.
  632. */
  633. #ifndef HEADER_CURL_SETUP_ONCE_H
  634. #include "curl_setup_once.h"
  635. #endif
  636. /*
  637. * Definition of our NOP statement Object-like macro
  638. */
  639. #ifndef Curl_nop_stmt
  640. # define Curl_nop_stmt do { } while(0)
  641. #endif
  642. /*
  643. * Ensure that Winsock and lwIP TCP/IP stacks are not mixed.
  644. */
  645. #if defined(__LWIP_OPT_H__) || defined(LWIP_HDR_OPT_H)
  646. # if defined(SOCKET) || defined(USE_WINSOCK)
  647. # error "WinSock and lwIP TCP/IP stack definitions shall not coexist!"
  648. # endif
  649. #endif
  650. /*
  651. * shutdown() flags for systems that don't define them
  652. */
  653. #ifndef SHUT_RD
  654. #define SHUT_RD 0x00
  655. #endif
  656. #ifndef SHUT_WR
  657. #define SHUT_WR 0x01
  658. #endif
  659. #ifndef SHUT_RDWR
  660. #define SHUT_RDWR 0x02
  661. #endif
  662. /* Define S_ISREG if not defined by system headers, e.g. MSVC */
  663. #if !defined(S_ISREG) && defined(S_IFMT) && defined(S_IFREG)
  664. #define S_ISREG(m) (((m) & S_IFMT) == S_IFREG)
  665. #endif
  666. /* Define S_ISDIR if not defined by system headers, e.g. MSVC */
  667. #if !defined(S_ISDIR) && defined(S_IFMT) && defined(S_IFDIR)
  668. #define S_ISDIR(m) (((m) & S_IFMT) == S_IFDIR)
  669. #endif
  670. /* In Windows the default file mode is text but an application can override it.
  671. Therefore we specify it explicitly. https://github.com/curl/curl/pull/258
  672. */
  673. #if defined(_WIN32) || defined(MSDOS)
  674. #define FOPEN_READTEXT "rt"
  675. #define FOPEN_WRITETEXT "wt"
  676. #define FOPEN_APPENDTEXT "at"
  677. #elif defined(__CYGWIN__)
  678. /* Cygwin has specific behavior we need to address when WIN32 is not defined.
  679. https://cygwin.com/cygwin-ug-net/using-textbinary.html
  680. For write we want our output to have line endings of LF and be compatible with
  681. other Cygwin utilities. For read we want to handle input that may have line
  682. endings either CRLF or LF so 't' is appropriate.
  683. */
  684. #define FOPEN_READTEXT "rt"
  685. #define FOPEN_WRITETEXT "w"
  686. #define FOPEN_APPENDTEXT "a"
  687. #else
  688. #define FOPEN_READTEXT "r"
  689. #define FOPEN_WRITETEXT "w"
  690. #define FOPEN_APPENDTEXT "a"
  691. #endif
  692. /* for systems that don't detect this in configure */
  693. #ifndef CURL_SA_FAMILY_T
  694. # if defined(HAVE_SA_FAMILY_T)
  695. # define CURL_SA_FAMILY_T sa_family_t
  696. # elif defined(HAVE_ADDRESS_FAMILY)
  697. # define CURL_SA_FAMILY_T ADDRESS_FAMILY
  698. # else
  699. /* use a sensible default */
  700. # define CURL_SA_FAMILY_T unsigned short
  701. # endif
  702. #endif
  703. /* Some convenience macros to get the larger/smaller value out of two given.
  704. We prefix with CURL to prevent name collisions. */
  705. #define CURLMAX(x,y) ((x)>(y)?(x):(y))
  706. #define CURLMIN(x,y) ((x)<(y)?(x):(y))
  707. /* A convenience macro to provide both the string literal and the length of
  708. the string literal in one go, useful for functions that take "string,len"
  709. as their argument */
  710. #define STRCONST(x) x,sizeof(x)-1
  711. /* Some versions of the Android SDK is missing the declaration */
  712. #if defined(HAVE_GETPWUID_R) && defined(HAVE_DECL_GETPWUID_R_MISSING)
  713. struct passwd;
  714. int getpwuid_r(uid_t uid, struct passwd *pwd, char *buf,
  715. size_t buflen, struct passwd **result);
  716. #endif
  717. #ifdef DEBUGBUILD
  718. #define UNITTEST
  719. #else
  720. #define UNITTEST static
  721. #endif
  722. /* Hyper supports HTTP2 also, but Curl's integration with Hyper does not */
  723. #if defined(USE_NGHTTP2)
  724. #define USE_HTTP2
  725. #endif
  726. #if (defined(USE_NGTCP2) && defined(USE_NGHTTP3)) || \
  727. (defined(USE_OPENSSL_QUIC) && defined(USE_NGHTTP3)) || \
  728. defined(USE_QUICHE) || defined(USE_MSH3)
  729. #ifdef CURL_WITH_MULTI_SSL
  730. #error "Multi-SSL combined with QUIC is not supported"
  731. #endif
  732. #define ENABLE_QUIC
  733. #define USE_HTTP3
  734. #endif
  735. /* Certain Windows implementations are not aligned with what curl expects,
  736. so always use the local one on this platform. E.g. the mingw-w64
  737. implementation can return wrong results for non-ASCII inputs. */
  738. #if defined(HAVE_BASENAME) && defined(_WIN32)
  739. #undef HAVE_BASENAME
  740. #endif
  741. #if defined(USE_UNIX_SOCKETS) && defined(_WIN32)
  742. # if !defined(UNIX_PATH_MAX)
  743. /* Replicating logic present in afunix.h
  744. (distributed with newer Windows 10 SDK versions only) */
  745. # define UNIX_PATH_MAX 108
  746. /* !checksrc! disable TYPEDEFSTRUCT 1 */
  747. typedef struct sockaddr_un {
  748. ADDRESS_FAMILY sun_family;
  749. char sun_path[UNIX_PATH_MAX];
  750. } SOCKADDR_UN, *PSOCKADDR_UN;
  751. # define WIN32_SOCKADDR_UN
  752. # endif
  753. #endif
  754. /* OpenSSLv3 marks DES, MD5 and ENGINE functions deprecated but we have no
  755. replacements (yet) so tell the compiler to not warn for them. */
  756. #ifdef USE_OPENSSL
  757. #define OPENSSL_SUPPRESS_DEPRECATED
  758. #endif
  759. #endif /* HEADER_CURL_SETUP_H */