curl_setup_once.h 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499
  1. #ifndef HEADER_CURL_SETUP_ONCE_H
  2. #define HEADER_CURL_SETUP_ONCE_H
  3. /***************************************************************************
  4. * _ _ ____ _
  5. * Project ___| | | | _ \| |
  6. * / __| | | | |_) | |
  7. * | (__| |_| | _ <| |___
  8. * \___|\___/|_| \_\_____|
  9. *
  10. * Copyright (C) 1998 - 2020, 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.haxx.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. ***************************************************************************/
  24. /*
  25. * Inclusion of common header files.
  26. */
  27. #include <stdio.h>
  28. #include <stdlib.h>
  29. #include <string.h>
  30. #include <stdarg.h>
  31. #include <ctype.h>
  32. #ifdef HAVE_ERRNO_H
  33. #include <errno.h>
  34. #endif
  35. #ifdef HAVE_SYS_TYPES_H
  36. #include <sys/types.h>
  37. #endif
  38. #ifdef NEED_MALLOC_H
  39. #include <malloc.h>
  40. #endif
  41. #ifdef NEED_MEMORY_H
  42. #include <memory.h>
  43. #endif
  44. #ifdef HAVE_SYS_STAT_H
  45. #include <sys/stat.h>
  46. #endif
  47. #ifdef HAVE_SYS_TIME_H
  48. #include <sys/time.h>
  49. #ifdef TIME_WITH_SYS_TIME
  50. #include <time.h>
  51. #endif
  52. #else
  53. #ifdef HAVE_TIME_H
  54. #include <time.h>
  55. #endif
  56. #endif
  57. #ifdef WIN32
  58. #include <io.h>
  59. #include <fcntl.h>
  60. #endif
  61. #if defined(HAVE_STDBOOL_H) && defined(HAVE_BOOL_T)
  62. #include <stdbool.h>
  63. #endif
  64. #ifdef HAVE_UNISTD_H
  65. #include <unistd.h>
  66. #endif
  67. #ifdef __hpux
  68. # if !defined(_XOPEN_SOURCE_EXTENDED) || defined(_KERNEL)
  69. # ifdef _APP32_64BIT_OFF_T
  70. # define OLD_APP32_64BIT_OFF_T _APP32_64BIT_OFF_T
  71. # undef _APP32_64BIT_OFF_T
  72. # else
  73. # undef OLD_APP32_64BIT_OFF_T
  74. # endif
  75. # endif
  76. #endif
  77. #ifdef HAVE_SYS_SOCKET_H
  78. #include <sys/socket.h>
  79. #endif
  80. #ifdef __hpux
  81. # if !defined(_XOPEN_SOURCE_EXTENDED) || defined(_KERNEL)
  82. # ifdef OLD_APP32_64BIT_OFF_T
  83. # define _APP32_64BIT_OFF_T OLD_APP32_64BIT_OFF_T
  84. # undef OLD_APP32_64BIT_OFF_T
  85. # endif
  86. # endif
  87. #endif
  88. /*
  89. * Definition of timeval struct for platforms that don't have it.
  90. */
  91. #ifndef HAVE_STRUCT_TIMEVAL
  92. struct timeval {
  93. long tv_sec;
  94. long tv_usec;
  95. };
  96. #endif
  97. /*
  98. * If we have the MSG_NOSIGNAL define, make sure we use
  99. * it as the fourth argument of function send()
  100. */
  101. #ifdef HAVE_MSG_NOSIGNAL
  102. #define SEND_4TH_ARG MSG_NOSIGNAL
  103. #else
  104. #define SEND_4TH_ARG 0
  105. #endif
  106. #if defined(__minix)
  107. /* Minix doesn't support recv on TCP sockets */
  108. #define sread(x,y,z) (ssize_t)read((RECV_TYPE_ARG1)(x), \
  109. (RECV_TYPE_ARG2)(y), \
  110. (RECV_TYPE_ARG3)(z))
  111. #elif defined(HAVE_RECV)
  112. /*
  113. * The definitions for the return type and arguments types
  114. * of functions recv() and send() belong and come from the
  115. * configuration file. Do not define them in any other place.
  116. *
  117. * HAVE_RECV is defined if you have a function named recv()
  118. * which is used to read incoming data from sockets. If your
  119. * function has another name then don't define HAVE_RECV.
  120. *
  121. * If HAVE_RECV is defined then RECV_TYPE_ARG1, RECV_TYPE_ARG2,
  122. * RECV_TYPE_ARG3, RECV_TYPE_ARG4 and RECV_TYPE_RETV must also
  123. * be defined.
  124. *
  125. * HAVE_SEND is defined if you have a function named send()
  126. * which is used to write outgoing data on a connected socket.
  127. * If yours has another name then don't define HAVE_SEND.
  128. *
  129. * If HAVE_SEND is defined then SEND_TYPE_ARG1, SEND_QUAL_ARG2,
  130. * SEND_TYPE_ARG2, SEND_TYPE_ARG3, SEND_TYPE_ARG4 and
  131. * SEND_TYPE_RETV must also be defined.
  132. */
  133. #if !defined(RECV_TYPE_ARG1) || \
  134. !defined(RECV_TYPE_ARG2) || \
  135. !defined(RECV_TYPE_ARG3) || \
  136. !defined(RECV_TYPE_ARG4) || \
  137. !defined(RECV_TYPE_RETV)
  138. /* */
  139. Error Missing_definition_of_return_and_arguments_types_of_recv
  140. /* */
  141. #else
  142. #define sread(x,y,z) (ssize_t)recv((RECV_TYPE_ARG1)(x), \
  143. (RECV_TYPE_ARG2)(y), \
  144. (RECV_TYPE_ARG3)(z), \
  145. (RECV_TYPE_ARG4)(0))
  146. #endif
  147. #else /* HAVE_RECV */
  148. #ifndef sread
  149. /* */
  150. Error Missing_definition_of_macro_sread
  151. /* */
  152. #endif
  153. #endif /* HAVE_RECV */
  154. #if defined(__minix)
  155. /* Minix doesn't support send on TCP sockets */
  156. #define swrite(x,y,z) (ssize_t)write((SEND_TYPE_ARG1)(x), \
  157. (SEND_TYPE_ARG2)(y), \
  158. (SEND_TYPE_ARG3)(z))
  159. #elif defined(HAVE_SEND)
  160. #if !defined(SEND_TYPE_ARG1) || \
  161. !defined(SEND_QUAL_ARG2) || \
  162. !defined(SEND_TYPE_ARG2) || \
  163. !defined(SEND_TYPE_ARG3) || \
  164. !defined(SEND_TYPE_ARG4) || \
  165. !defined(SEND_TYPE_RETV)
  166. /* */
  167. Error Missing_definition_of_return_and_arguments_types_of_send
  168. /* */
  169. #else
  170. #define swrite(x,y,z) (ssize_t)send((SEND_TYPE_ARG1)(x), \
  171. (SEND_QUAL_ARG2 SEND_TYPE_ARG2)(y), \
  172. (SEND_TYPE_ARG3)(z), \
  173. (SEND_TYPE_ARG4)(SEND_4TH_ARG))
  174. #endif
  175. #else /* HAVE_SEND */
  176. #ifndef swrite
  177. /* */
  178. Error Missing_definition_of_macro_swrite
  179. /* */
  180. #endif
  181. #endif /* HAVE_SEND */
  182. #if 0
  183. #if defined(HAVE_RECVFROM)
  184. /*
  185. * Currently recvfrom is only used on udp sockets.
  186. */
  187. #if !defined(RECVFROM_TYPE_ARG1) || \
  188. !defined(RECVFROM_TYPE_ARG2) || \
  189. !defined(RECVFROM_TYPE_ARG3) || \
  190. !defined(RECVFROM_TYPE_ARG4) || \
  191. !defined(RECVFROM_TYPE_ARG5) || \
  192. !defined(RECVFROM_TYPE_ARG6) || \
  193. !defined(RECVFROM_TYPE_RETV)
  194. /* */
  195. Error Missing_definition_of_return_and_arguments_types_of_recvfrom
  196. /* */
  197. #else
  198. #define sreadfrom(s,b,bl,f,fl) (ssize_t)recvfrom((RECVFROM_TYPE_ARG1) (s), \
  199. (RECVFROM_TYPE_ARG2 *)(b), \
  200. (RECVFROM_TYPE_ARG3) (bl), \
  201. (RECVFROM_TYPE_ARG4) (0), \
  202. (RECVFROM_TYPE_ARG5 *)(f), \
  203. (RECVFROM_TYPE_ARG6 *)(fl))
  204. #endif
  205. #else /* HAVE_RECVFROM */
  206. #ifndef sreadfrom
  207. /* */
  208. Error Missing_definition_of_macro_sreadfrom
  209. /* */
  210. #endif
  211. #endif /* HAVE_RECVFROM */
  212. #ifdef RECVFROM_TYPE_ARG6_IS_VOID
  213. # define RECVFROM_ARG6_T int
  214. #else
  215. # define RECVFROM_ARG6_T RECVFROM_TYPE_ARG6
  216. #endif
  217. #endif /* if 0 */
  218. /*
  219. * Function-like macro definition used to close a socket.
  220. */
  221. #if defined(HAVE_CLOSESOCKET)
  222. # define sclose(x) closesocket((x))
  223. #elif defined(HAVE_CLOSESOCKET_CAMEL)
  224. # define sclose(x) CloseSocket((x))
  225. #elif defined(HAVE_CLOSE_S)
  226. # define sclose(x) close_s((x))
  227. #elif defined(USE_LWIPSOCK)
  228. # define sclose(x) lwip_close((x))
  229. #else
  230. # define sclose(x) close((x))
  231. #endif
  232. /*
  233. * Stack-independent version of fcntl() on sockets:
  234. */
  235. #if defined(USE_LWIPSOCK)
  236. # define sfcntl lwip_fcntl
  237. #else
  238. # define sfcntl fcntl
  239. #endif
  240. #define TOLOWER(x) (tolower((int) ((unsigned char)x)))
  241. /*
  242. * 'bool' stuff compatible with HP-UX headers.
  243. */
  244. #if defined(__hpux) && !defined(HAVE_BOOL_T)
  245. typedef int bool;
  246. # define false 0
  247. # define true 1
  248. # define HAVE_BOOL_T
  249. #endif
  250. /*
  251. * 'bool' exists on platforms with <stdbool.h>, i.e. C99 platforms.
  252. * On non-C99 platforms there's no bool, so define an enum for that.
  253. * On C99 platforms 'false' and 'true' also exist. Enum uses a
  254. * global namespace though, so use bool_false and bool_true.
  255. */
  256. #ifndef HAVE_BOOL_T
  257. typedef enum {
  258. bool_false = 0,
  259. bool_true = 1
  260. } bool;
  261. /*
  262. * Use a define to let 'true' and 'false' use those enums. There
  263. * are currently no use of true and false in libcurl proper, but
  264. * there are some in the examples. This will cater for any later
  265. * code happening to use true and false.
  266. */
  267. # define false bool_false
  268. # define true bool_true
  269. # define HAVE_BOOL_T
  270. #endif
  271. /*
  272. * Redefine TRUE and FALSE too, to catch current use. With this
  273. * change, 'bool found = 1' will give a warning on MIPSPro, but
  274. * 'bool found = TRUE' will not. Change tested on IRIX/MIPSPro,
  275. * AIX 5.1/Xlc, Tru64 5.1/cc, w/make test too.
  276. */
  277. #ifndef TRUE
  278. #define TRUE true
  279. #endif
  280. #ifndef FALSE
  281. #define FALSE false
  282. #endif
  283. #include "curl_ctype.h"
  284. /*
  285. * Typedef to 'int' if sig_atomic_t is not an available 'typedefed' type.
  286. */
  287. #ifndef HAVE_SIG_ATOMIC_T
  288. typedef int sig_atomic_t;
  289. #define HAVE_SIG_ATOMIC_T
  290. #endif
  291. /*
  292. * Convenience SIG_ATOMIC_T definition
  293. */
  294. #ifdef HAVE_SIG_ATOMIC_T_VOLATILE
  295. #define SIG_ATOMIC_T static sig_atomic_t
  296. #else
  297. #define SIG_ATOMIC_T static volatile sig_atomic_t
  298. #endif
  299. /*
  300. * Default return type for signal handlers.
  301. */
  302. #ifndef RETSIGTYPE
  303. #define RETSIGTYPE void
  304. #endif
  305. /*
  306. * Macro used to include code only in debug builds.
  307. */
  308. #ifdef DEBUGBUILD
  309. #define DEBUGF(x) x
  310. #else
  311. #define DEBUGF(x) do { } while(0)
  312. #endif
  313. /*
  314. * Macro used to include assertion code only in debug builds.
  315. */
  316. #undef DEBUGASSERT
  317. #if defined(DEBUGBUILD) && defined(HAVE_ASSERT_H)
  318. #define DEBUGASSERT(x) assert(x)
  319. #else
  320. #define DEBUGASSERT(x) do { } while(0)
  321. #endif
  322. /*
  323. * Macro SOCKERRNO / SET_SOCKERRNO() returns / sets the *socket-related* errno
  324. * (or equivalent) on this platform to hide platform details to code using it.
  325. */
  326. #ifdef USE_WINSOCK
  327. #define SOCKERRNO ((int)WSAGetLastError())
  328. #define SET_SOCKERRNO(x) (WSASetLastError((int)(x)))
  329. #else
  330. #define SOCKERRNO (errno)
  331. #define SET_SOCKERRNO(x) (errno = (x))
  332. #endif
  333. /*
  334. * Portable error number symbolic names defined to Winsock error codes.
  335. */
  336. #ifdef USE_WINSOCK
  337. #undef EBADF /* override definition in errno.h */
  338. #define EBADF WSAEBADF
  339. #undef EINTR /* override definition in errno.h */
  340. #define EINTR WSAEINTR
  341. #undef EINVAL /* override definition in errno.h */
  342. #define EINVAL WSAEINVAL
  343. #undef EWOULDBLOCK /* override definition in errno.h */
  344. #define EWOULDBLOCK WSAEWOULDBLOCK
  345. #undef EINPROGRESS /* override definition in errno.h */
  346. #define EINPROGRESS WSAEINPROGRESS
  347. #undef EALREADY /* override definition in errno.h */
  348. #define EALREADY WSAEALREADY
  349. #undef ENOTSOCK /* override definition in errno.h */
  350. #define ENOTSOCK WSAENOTSOCK
  351. #undef EDESTADDRREQ /* override definition in errno.h */
  352. #define EDESTADDRREQ WSAEDESTADDRREQ
  353. #undef EMSGSIZE /* override definition in errno.h */
  354. #define EMSGSIZE WSAEMSGSIZE
  355. #undef EPROTOTYPE /* override definition in errno.h */
  356. #define EPROTOTYPE WSAEPROTOTYPE
  357. #undef ENOPROTOOPT /* override definition in errno.h */
  358. #define ENOPROTOOPT WSAENOPROTOOPT
  359. #undef EPROTONOSUPPORT /* override definition in errno.h */
  360. #define EPROTONOSUPPORT WSAEPROTONOSUPPORT
  361. #define ESOCKTNOSUPPORT WSAESOCKTNOSUPPORT
  362. #undef EOPNOTSUPP /* override definition in errno.h */
  363. #define EOPNOTSUPP WSAEOPNOTSUPP
  364. #define EPFNOSUPPORT WSAEPFNOSUPPORT
  365. #undef EAFNOSUPPORT /* override definition in errno.h */
  366. #define EAFNOSUPPORT WSAEAFNOSUPPORT
  367. #undef EADDRINUSE /* override definition in errno.h */
  368. #define EADDRINUSE WSAEADDRINUSE
  369. #undef EADDRNOTAVAIL /* override definition in errno.h */
  370. #define EADDRNOTAVAIL WSAEADDRNOTAVAIL
  371. #undef ENETDOWN /* override definition in errno.h */
  372. #define ENETDOWN WSAENETDOWN
  373. #undef ENETUNREACH /* override definition in errno.h */
  374. #define ENETUNREACH WSAENETUNREACH
  375. #undef ENETRESET /* override definition in errno.h */
  376. #define ENETRESET WSAENETRESET
  377. #undef ECONNABORTED /* override definition in errno.h */
  378. #define ECONNABORTED WSAECONNABORTED
  379. #undef ECONNRESET /* override definition in errno.h */
  380. #define ECONNRESET WSAECONNRESET
  381. #undef ENOBUFS /* override definition in errno.h */
  382. #define ENOBUFS WSAENOBUFS
  383. #undef EISCONN /* override definition in errno.h */
  384. #define EISCONN WSAEISCONN
  385. #undef ENOTCONN /* override definition in errno.h */
  386. #define ENOTCONN WSAENOTCONN
  387. #define ESHUTDOWN WSAESHUTDOWN
  388. #define ETOOMANYREFS WSAETOOMANYREFS
  389. #undef ETIMEDOUT /* override definition in errno.h */
  390. #define ETIMEDOUT WSAETIMEDOUT
  391. #undef ECONNREFUSED /* override definition in errno.h */
  392. #define ECONNREFUSED WSAECONNREFUSED
  393. #undef ELOOP /* override definition in errno.h */
  394. #define ELOOP WSAELOOP
  395. #ifndef ENAMETOOLONG /* possible previous definition in errno.h */
  396. #define ENAMETOOLONG WSAENAMETOOLONG
  397. #endif
  398. #define EHOSTDOWN WSAEHOSTDOWN
  399. #undef EHOSTUNREACH /* override definition in errno.h */
  400. #define EHOSTUNREACH WSAEHOSTUNREACH
  401. #ifndef ENOTEMPTY /* possible previous definition in errno.h */
  402. #define ENOTEMPTY WSAENOTEMPTY
  403. #endif
  404. #define EPROCLIM WSAEPROCLIM
  405. #define EUSERS WSAEUSERS
  406. #define EDQUOT WSAEDQUOT
  407. #define ESTALE WSAESTALE
  408. #define EREMOTE WSAEREMOTE
  409. #endif
  410. /*
  411. * Macro argv_item_t hides platform details to code using it.
  412. */
  413. #ifdef __VMS
  414. #define argv_item_t __char_ptr32
  415. #elif defined(_UNICODE)
  416. #define argv_item_t wchar_t *
  417. #else
  418. #define argv_item_t char *
  419. #endif
  420. /*
  421. * We use this ZERO_NULL to avoid picky compiler warnings,
  422. * when assigning a NULL pointer to a function pointer var.
  423. */
  424. #define ZERO_NULL 0
  425. #endif /* HEADER_CURL_SETUP_ONCE_H */