curl_setup.h 25 KB

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