1 #ifndef HEADER_CURL_SETUP_H
2 #define HEADER_CURL_SETUP_H
3 /***************************************************************************
5 * Project ___| | | | _ \| |
7 * | (__| |_| | _ <| |___
8 * \___|\___/|_| \_\_____|
10 * Copyright (C) 1998 - 2016, Daniel Stenberg, <daniel@haxx.se>, et al.
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.
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.
20 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
21 * KIND, either express or implied.
23 ***************************************************************************/
26 * Define WIN32 when build target is Win32 API
29 #if (defined(_WIN32) || defined(__WIN32__)) && !defined(WIN32) && \
30 !defined(__SYMBIAN32__)
35 * Include configuration script results or hand-crafted
36 * configuration file for platforms which lack config tool.
41 #include "curl_config.h"
43 #else /* HAVE_CONFIG_H */
46 # include "config-win32ce.h"
49 # include "config-win32.h"
53 #if defined(macintosh) && defined(__MRC__)
54 # include "config-mac.h"
58 # include "config-riscos.h"
62 # include "config-amigaos.h"
66 # include "config-symbian.h"
70 # include "config-os400.h"
74 # include "config-tpf.h"
78 # include "config-vxworks.h"
81 #endif /* HAVE_CONFIG_H */
83 /* ================================================================ */
84 /* Definition of preprocessor macros/symbols which modify compiler */
85 /* behavior or generated code characteristics must be done here, */
86 /* as appropriate, before any system header file is included. It is */
87 /* also possible to have them defined in the config file included */
88 /* before this point. As a result of all this we frown inclusion of */
89 /* system header files in our config files, avoid this at any cost. */
90 /* ================================================================ */
93 * AIX 4.3 and newer needs _THREAD_SAFE defined to build
94 * proper reentrant code. Others may also need it.
97 #ifdef NEED_THREAD_SAFE
104 * Tru64 needs _REENTRANT set for a few function prototypes and
105 * things to appear in the system header files. Unixware needs it
106 * to build proper reentrant code. Others may also need it.
109 #ifdef NEED_REENTRANT
115 /* Solaris needs this to get a POSIX-conformant getpwuid_r */
116 #if defined(sun) || defined(__sun)
117 # ifndef _POSIX_PTHREAD_SEMANTICS
118 # define _POSIX_PTHREAD_SEMANTICS 1
122 /* ================================================================ */
123 /* If you need to include a system header file for your platform, */
124 /* please, do it beyond the point further indicated in this file. */
125 /* ================================================================ */
128 * libcurl's external interface definitions are also used internally,
129 * and might also include required system header files to define them.
132 #include <curl/curlbuild.h>
135 * Compile time sanity checks must also be done when building the library.
138 #include <curl/curlrules.h>
141 * Ensure that no one is using the old SIZEOF_CURL_OFF_T macro
144 #ifdef SIZEOF_CURL_OFF_T
145 # error "SIZEOF_CURL_OFF_T shall not be defined!"
146 Error Compilation_aborted_SIZEOF_CURL_OFF_T_shall_not_be_defined
150 * Disable other protocols when http is the only one desired.
154 # ifndef CURL_DISABLE_TFTP
155 # define CURL_DISABLE_TFTP
157 # ifndef CURL_DISABLE_FTP
158 # define CURL_DISABLE_FTP
160 # ifndef CURL_DISABLE_LDAP
161 # define CURL_DISABLE_LDAP
163 # ifndef CURL_DISABLE_TELNET
164 # define CURL_DISABLE_TELNET
166 # ifndef CURL_DISABLE_DICT
167 # define CURL_DISABLE_DICT
169 # ifndef CURL_DISABLE_FILE
170 # define CURL_DISABLE_FILE
172 # ifndef CURL_DISABLE_RTSP
173 # define CURL_DISABLE_RTSP
175 # ifndef CURL_DISABLE_POP3
176 # define CURL_DISABLE_POP3
178 # ifndef CURL_DISABLE_IMAP
179 # define CURL_DISABLE_IMAP
181 # ifndef CURL_DISABLE_SMTP
182 # define CURL_DISABLE_SMTP
184 # ifndef CURL_DISABLE_RTMP
185 # define CURL_DISABLE_RTMP
187 # ifndef CURL_DISABLE_GOPHER
188 # define CURL_DISABLE_GOPHER
190 # ifndef CURL_DISABLE_SMB
191 # define CURL_DISABLE_SMB
196 * When http is disabled rtsp is not supported.
199 #if defined(CURL_DISABLE_HTTP) && !defined(CURL_DISABLE_RTSP)
200 # define CURL_DISABLE_RTSP
203 /* ================================================================ */
204 /* No system header file shall be included in this file before this */
205 /* point. The only allowed ones are those included from curlbuild.h */
206 /* ================================================================ */
209 * OS/400 setup file includes some system headers.
213 # include "setup-os400.h"
217 * VMS setup file includes some system headers.
221 # include "setup-vms.h"
225 * Use getaddrinfo to resolve the IPv4 address literal. If the current network
226 * interface doesn’t support IPv4, but supports IPv6, NAT64, and DNS64,
227 * performing this task will result in a synthesized IPv6 address.
230 #define USE_RESOLVE_ON_IPS 1
234 * Include header files for windows builds before redefining anything.
235 * Use this preprocessor block only to include or exclude windows.h,
236 * winsock2.h, ws2tcpip.h or winsock.h. Any other windows thing belongs
237 * to any other further and independent block. Under Cygwin things work
238 * just as under linux (e.g. <sys/socket.h>) and the winsock headers should
239 * never be included when __CYGWIN__ is defined. configure script takes
240 * care of this, not defining HAVE_WINDOWS_H, HAVE_WINSOCK_H, HAVE_WINSOCK2_H,
241 * neither HAVE_WS2TCPIP_H when __CYGWIN__ is defined.
244 #ifdef HAVE_WINDOWS_H
245 # if defined(UNICODE) && !defined(_UNICODE)
248 # if defined(_UNICODE) && !defined(UNICODE)
251 # ifndef WIN32_LEAN_AND_MEAN
252 # define WIN32_LEAN_AND_MEAN
254 # include <windows.h>
255 # ifdef HAVE_WINSOCK2_H
256 # include <winsock2.h>
257 # ifdef HAVE_WS2TCPIP_H
258 # include <ws2tcpip.h>
261 # ifdef HAVE_WINSOCK_H
262 # include <winsock.h>
267 typedef wchar_t *(*curl_wcsdup_callback)(const wchar_t *str);
272 * Define USE_WINSOCK to 2 if we have and use WINSOCK2 API, else
273 * define USE_WINSOCK to 1 if we have and use WINSOCK API, else
274 * undefine USE_WINSOCK.
279 #ifdef HAVE_WINSOCK2_H
280 # define USE_WINSOCK 2
282 # ifdef HAVE_WINSOCK_H
283 # define USE_WINSOCK 1
288 # include <lwip/init.h>
289 # include <lwip/sockets.h>
290 # include <lwip/netdb.h>
293 #ifdef HAVE_EXTRA_STRICMP_H
294 # include <extra/stricmp.h>
297 #ifdef HAVE_EXTRA_STRDUP_H
298 # include <extra/strdup.h>
302 # include <strings.h> /* for bzero, strcasecmp, and strncasecmp */
303 # include <string.h> /* for strcpy and strlen */
304 # include <stdlib.h> /* for rand and srand */
305 # include <sys/socket.h> /* for select and ioctl*/
306 # include <netdb.h> /* for in_addr_t definition */
307 # include <tpf/sysapi.h> /* for tpf_process_signals */
308 /* change which select is used for libcurl */
309 # define select(a,b,c,d,e) tpf_select_libcurl(a,b,c,d,e)
313 # include <sockLib.h> /* for generic BSD socket functions */
314 # include <ioLib.h> /* for basic I/O interface functions */
319 # include <exec/types.h>
320 # include <exec/execbase.h>
321 # include <proto/exec.h>
322 # include <proto/dos.h>
323 # define select(a,b,c,d,e) WaitSelect(a,b,c,d,e,0)
332 #ifdef __TANDEM /* for nsr-tandem-nsk systems */
336 #ifndef STDC_HEADERS /* no standard C headers! */
337 #include <curl/stdcheaders.h>
341 # include <sys/types.h>
343 # define sys_nerr EILSEQ
347 * Salford-C kludge section (mostly borrowed from wxWidgets).
350 #pragma suppress 353 /* Possible nested comments */
351 #pragma suppress 593 /* Define not used */
352 #pragma suppress 61 /* enum has no name */
353 #pragma suppress 106 /* unnamed, unused parameter */
358 * Large file (>2Gb) support using WIN32 functions.
361 #ifdef USE_WIN32_LARGE_FILES
363 # include <sys/types.h>
364 # include <sys/stat.h>
366 # define lseek(fdes,offset,whence) _lseeki64(fdes, offset, whence)
368 # define fstat(fdes,stp) _fstati64(fdes, stp)
370 # define stat(fname,stp) _stati64(fname, stp)
371 # define struct_stat struct _stati64
372 # define LSEEK_ERROR (__int64)-1
376 * Small file (<2Gb) support using WIN32 functions.
379 #ifdef USE_WIN32_SMALL_FILES
381 # include <sys/types.h>
382 # include <sys/stat.h>
385 # define lseek(fdes,offset,whence) _lseek(fdes, (long)offset, whence)
386 # define fstat(fdes,stp) _fstat(fdes, stp)
387 # define stat(fname,stp) _stat(fname, stp)
388 # define struct_stat struct _stat
390 # define LSEEK_ERROR (long)-1
394 # define struct_stat struct stat
398 # define LSEEK_ERROR (off_t)-1
402 * Default sizeof(off_t) in case it hasn't been defined in config file.
406 # if defined(__VMS) && !defined(__VAX)
407 # if defined(_LARGEFILE)
408 # define SIZEOF_OFF_T 8
410 # elif defined(__OS400__) && defined(__ILEC400__)
411 # if defined(_LARGE_FILES)
412 # define SIZEOF_OFF_T 8
414 # elif defined(__MVS__) && defined(__IBMC__)
415 # if defined(_LP64) || defined(_LARGE_FILES)
416 # define SIZEOF_OFF_T 8
418 # elif defined(__370__) && defined(__IBMC__)
419 # if defined(_LP64) || defined(_LARGE_FILES)
420 # define SIZEOF_OFF_T 8
423 # ifndef SIZEOF_OFF_T
424 # define SIZEOF_OFF_T 4
429 * Arg 2 type for gethostname in case it hasn't been defined in config file.
432 #ifndef GETHOSTNAME_TYPE_ARG2
434 # define GETHOSTNAME_TYPE_ARG2 int
436 # define GETHOSTNAME_TYPE_ARG2 size_t
440 /* Below we define some functions. They should
442 4. set the SIGALRM signal timeout
443 5. set dir/file naming defines
448 # define DIR_CHAR "\\"
449 # define DOT_CHAR "_"
453 # ifdef MSDOS /* Watt-32 */
455 # include <sys/ioctl.h>
456 # define select(n,r,w,x,t) select_s(n,r,w,x,t)
457 # define ioctl(x,y,z) ioctlsocket(x,y,(char *)(z))
469 /* Minix 3 versions up to at least 3.1.3 are missing these prototypes */
470 extern char * strtok_r(char *s, const char *delim, char **last);
471 extern struct tm * gmtime_r(const time_t * const timep, struct tm *tmp);
474 # define DIR_CHAR "/"
476 # define DOT_CHAR "."
481 # define DOT_CHAR "_"
484 # ifndef fileno /* sunos 4 have this as a macro! */
485 int fileno(FILE *stream);
491 * msvc 6.0 requires PSDK in order to have INET6_ADDRSTRLEN
492 * defined in ws2tcpip.h as well as to provide IPv6 support.
493 * Does not apply if lwIP is used.
496 #if defined(_MSC_VER) && !defined(__POCC__) && !defined(USE_LWIPSOCK)
497 # if !defined(HAVE_WS2TCPIP_H) || \
498 ((_MSC_VER < 1300) && !defined(INET6_ADDRSTRLEN))
499 # undef HAVE_GETADDRINFO_THREADSAFE
500 # undef HAVE_FREEADDRINFO
501 # undef HAVE_GETADDRINFO
502 # undef HAVE_GETNAMEINFO
507 /* ---------------------------------------------------------------- */
508 /* resolver specialty compile-time defines */
509 /* CURLRES_* defines to use in the host*.c sources */
510 /* ---------------------------------------------------------------- */
513 * lcc-win32 doesn't have _beginthreadex(), lacks threads support.
516 #if defined(__LCC__) && defined(WIN32)
517 # undef USE_THREADS_POSIX
518 # undef USE_THREADS_WIN32
522 * MSVC threads support requires a multi-threaded runtime library.
523 * _beginthreadex() is not available in single-threaded ones.
526 #if defined(_MSC_VER) && !defined(__POCC__) && !defined(_MT)
527 # undef USE_THREADS_POSIX
528 # undef USE_THREADS_WIN32
532 * Mutually exclusive CURLRES_* definitions.
536 # define CURLRES_ASYNCH
537 # define CURLRES_ARES
538 /* now undef the stock libc functions just to avoid them being used */
539 # undef HAVE_GETADDRINFO
540 # undef HAVE_FREEADDRINFO
541 # undef HAVE_GETHOSTBYNAME
542 #elif defined(USE_THREADS_POSIX) || defined(USE_THREADS_WIN32)
543 # define CURLRES_ASYNCH
544 # define CURLRES_THREADED
546 # define CURLRES_SYNCH
550 # define CURLRES_IPV6
552 # define CURLRES_IPV4
555 /* ---------------------------------------------------------------- */
558 * When using WINSOCK, TELNET protocol requires WINSOCK2 API.
561 #if defined(USE_WINSOCK) && (USE_WINSOCK != 2)
562 # define CURL_DISABLE_TELNET 1
566 * msvc 6.0 does not have struct sockaddr_storage and
567 * does not define IPPROTO_ESP in winsock2.h. But both
568 * are available if PSDK is properly installed.
571 #if defined(_MSC_VER) && !defined(__POCC__)
572 # if !defined(HAVE_WINSOCK2_H) || ((_MSC_VER < 1300) && !defined(IPPROTO_ESP))
573 # undef HAVE_STRUCT_SOCKADDR_STORAGE
578 * Intentionally fail to build when using msvc 6.0 without PSDK installed.
579 * The brave of heart can circumvent this, defining ALLOW_MSVC6_WITHOUT_PSDK
580 * in lib/config-win32.h although absolutely discouraged and unsupported.
583 #if defined(_MSC_VER) && !defined(__POCC__)
584 # if !defined(HAVE_WINDOWS_H) || ((_MSC_VER < 1300) && !defined(_FILETIME_))
585 # if !defined(ALLOW_MSVC6_WITHOUT_PSDK)
586 # error MSVC 6.0 requires "February 2003 Platform SDK" a.k.a. \
587 "Windows Server 2003 PSDK"
589 # define CURL_DISABLE_LDAP 1
595 int netware_init(void);
596 #ifndef __NOVELL_LIBC__
597 #include <sys/bsdskt.h>
598 #include <sys/timeval.h>
602 #if defined(HAVE_LIBIDN) && defined(HAVE_TLD_H)
603 /* The lib was present and the tld.h header (which is missing in libidn 0.3.X
604 but we only work with libidn 0.4.1 or later) */
608 #ifndef SIZEOF_TIME_T
609 /* assume default size of time_t to be 32 bit */
610 #define SIZEOF_TIME_T 4
613 #define LIBIDN_REQUIRED_VERSION "0.4.1"
615 #if defined(USE_GNUTLS) || defined(USE_OPENSSL) || defined(USE_NSS) || \
616 defined(USE_POLARSSL) || defined(USE_AXTLS) || defined(USE_MBEDTLS) || \
617 defined(USE_CYASSL) || defined(USE_SCHANNEL) || \
618 defined(USE_DARWINSSL) || defined(USE_GSKIT)
619 #define USE_SSL /* SSL support has been enabled */
622 /* Single point where USE_SPNEGO definition might be defined */
623 #if !defined(CURL_DISABLE_CRYPTO_AUTH) && \
624 (defined(HAVE_GSSAPI) || defined(USE_WINDOWS_SSPI))
628 /* Single point where USE_KERBEROS5 definition might be defined */
629 #if !defined(CURL_DISABLE_CRYPTO_AUTH) && \
630 (defined(HAVE_GSSAPI) || defined(USE_WINDOWS_SSPI))
631 #define USE_KERBEROS5
634 /* Single point where USE_NTLM definition might be defined */
635 #if !defined(CURL_DISABLE_NTLM) && !defined(CURL_DISABLE_CRYPTO_AUTH)
636 #if defined(USE_OPENSSL) || defined(USE_WINDOWS_SSPI) || \
637 defined(USE_GNUTLS) || defined(USE_MBEDTLS) || defined(USE_NSS) || \
638 defined(USE_DARWINSSL) || defined(USE_OS400CRYPTO) || \
639 defined(USE_WIN32_CRYPTO)
645 /* non-configure builds may define CURL_WANTS_CA_BUNDLE_ENV */
646 #if defined(CURL_WANTS_CA_BUNDLE_ENV) && !defined(CURL_CA_BUNDLE)
647 #define CURL_CA_BUNDLE getenv("CURL_CA_BUNDLE")
651 * Provide a mechanism to silence picky compilers, such as gcc 4.6+.
652 * Parameters should of course normally not be unused, but for example when
653 * we have multiple implementations of the same interface it may happen.
656 #if defined(__GNUC__) && ((__GNUC__ >= 3) || \
657 ((__GNUC__ == 2) && defined(__GNUC_MINOR__) && (__GNUC_MINOR__ >= 7)))
658 # define UNUSED_PARAM __attribute__((__unused__))
659 # define WARN_UNUSED_RESULT __attribute__((warn_unused_result))
661 # define UNUSED_PARAM /*NOTHING*/
662 # define WARN_UNUSED_RESULT
666 * Include macros and defines that should only be processed once.
669 #ifndef HEADER_CURL_SETUP_ONCE_H
670 #include "curl_setup_once.h"
674 * Definition of our NOP statement Object-like macro
677 #ifndef Curl_nop_stmt
678 # define Curl_nop_stmt do { } WHILE_FALSE
682 * Ensure that Winsock and lwIP TCP/IP stacks are not mixed.
685 #if defined(__LWIP_OPT_H__) || defined(LWIP_HDR_OPT_H)
686 # if defined(SOCKET) || \
687 defined(USE_WINSOCK) || \
688 defined(HAVE_WINSOCK_H) || \
689 defined(HAVE_WINSOCK2_H) || \
690 defined(HAVE_WS2TCPIP_H)
691 # error "Winsock and lwIP TCP/IP stack definitions shall not coexist!"
696 * Portable symbolic names for Winsock shutdown() mode flags.
700 # define SHUT_RD 0x00
701 # define SHUT_WR 0x01
702 # define SHUT_RDWR 0x02
705 /* Define S_ISREG if not defined by system headers, f.e. MSVC */
706 #if !defined(S_ISREG) && defined(S_IFMT) && defined(S_IFREG)
707 #define S_ISREG(m) (((m) & S_IFMT) == S_IFREG)
710 /* Define S_ISDIR if not defined by system headers, f.e. MSVC */
711 #if !defined(S_ISDIR) && defined(S_IFMT) && defined(S_IFDIR)
712 #define S_ISDIR(m) (((m) & S_IFMT) == S_IFDIR)
715 /* In Windows the default file mode is text but an application can override it.
716 Therefore we specify it explicitly. https://github.com/curl/curl/pull/258
718 #if defined(WIN32) || defined(MSDOS)
719 #define FOPEN_READTEXT "rt"
720 #define FOPEN_WRITETEXT "wt"
721 #elif defined(__CYGWIN__)
722 /* Cygwin has specific behavior we need to address when WIN32 is not defined.
723 https://cygwin.com/cygwin-ug-net/using-textbinary.html
724 For write we want our output to have line endings of LF and be compatible with
725 other Cygwin utilities. For read we want to handle input that may have line
726 endings either CRLF or LF so 't' is appropriate.
728 #define FOPEN_READTEXT "rt"
729 #define FOPEN_WRITETEXT "w"
731 #define FOPEN_READTEXT "r"
732 #define FOPEN_WRITETEXT "w"
735 /* WinSock destroys recv() buffer when send() failed.
736 * Enabled automatically for Windows and for Cygwin as Cygwin sockets are
737 * wrappers for WinSock sockets. https://github.com/curl/curl/issues/657
738 * Define DONT_USE_RECV_BEFORE_SEND_WORKAROUND to force disable workaround.
740 #if !defined(DONT_USE_RECV_BEFORE_SEND_WORKAROUND)
741 # if defined(WIN32) || defined(__CYGWIN__)
742 # define USE_RECV_BEFORE_SEND_WORKAROUND
744 #else /* DONT_USE_RECV_BEFORE_SEND_WORKAROUNDS */
745 # ifdef USE_RECV_BEFORE_SEND_WORKAROUND
746 # undef USE_RECV_BEFORE_SEND_WORKAROUND
748 #endif /* DONT_USE_RECV_BEFORE_SEND_WORKAROUNDS */
750 /* Detect Windows App environment which has a restricted access
751 * to the Win32 APIs. */
752 # if defined(_WIN32_WINNT) && (_WIN32_WINNT >= 0x0602)
753 # include <winapifamily.h>
754 # if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP) && \
755 !WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP)
756 # define CURL_WINDOWS_APP
760 #endif /* HEADER_CURL_SETUP_H */