1 /***************************************************************************
3 * Project ___| | | | _ \| |
5 * | (__| |_| | _ <| |___
6 * \___|\___/|_| \_\_____|
8 * Copyright (C) 1998 - 2013, Daniel Stenberg, <daniel@haxx.se>, et al.
10 * This software is licensed as described in the file COPYING, which
11 * you should have received as part of this distribution. The terms
12 * are also available at http://curl.haxx.se/docs/copyright.html.
14 * You may opt to use, copy, modify, merge, publish, distribute and/or sell
15 * copies of the Software, and permit persons to whom the Software is
16 * furnished to do so, under the terms of the COPYING file.
18 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
19 * KIND, either express or implied.
21 ***************************************************************************/
23 #include "curl_setup.h"
26 * See comment in curl_memory.h for the explanation of this sanity check.
29 #ifdef CURLX_NO_MEMORY_CALLBACKS
30 #error "libcurl shall not ever be built with CURLX_NO_MEMORY_CALLBACKS defined"
33 #ifdef HAVE_NETINET_IN_H
34 #include <netinet/in.h>
39 #ifdef HAVE_ARPA_INET_H
40 #include <arpa/inet.h>
45 #ifdef HAVE_SYS_IOCTL_H
46 #include <sys/ioctl.h>
49 #ifdef HAVE_SYS_PARAM_H
50 #include <sys/param.h>
53 #if defined(HAVE_SIGNAL_H) && defined(HAVE_SIGACTION) && defined(USE_OPENSSL)
54 #define SIGPIPE_IGNORE 1
60 #include <curl/curl.h>
68 #include "curl_memory.h"
72 #include "sendf.h" /* for failf function prototype */
73 #include "curl_ntlm.h"
74 #include "connect.h" /* for Curl_getconnectinfo */
77 #include "non-ascii.h"
79 #include "conncache.h"
82 #define _MPRINTF_REPLACE /* use our functions only */
83 #include <curl/mprintf.h>
85 /* The last #include file should be: */
89 struct sigpipe_ignore {
90 struct sigaction old_pipe_act;
94 #define SIGPIPE_VARIABLE(x) struct sigpipe_ignore x
97 * sigpipe_ignore() makes sure we ignore SIGPIPE while running libcurl
98 * internals, and then sigpipe_restore() will restore the situation when we
99 * return from libcurl again.
101 static void sigpipe_ignore(struct SessionHandle *data,
102 struct sigpipe_ignore *ig)
104 /* get a local copy of no_signal because the SessionHandle might not be
105 around when we restore */
106 ig->no_signal = data->set.no_signal;
107 if(!data->set.no_signal) {
108 struct sigaction action;
109 /* first, extract the existing situation */
110 memset(&ig->old_pipe_act, 0, sizeof(struct sigaction));
111 sigaction(SIGPIPE, NULL, &ig->old_pipe_act);
112 action = ig->old_pipe_act;
113 /* ignore this signal */
114 action.sa_handler = SIG_IGN;
115 sigaction(SIGPIPE, &action, NULL);
120 * sigpipe_restore() puts back the outside world's opinion of signal handler
121 * and SIGPIPE handling. It MUST only be called after a corresponding
122 * sigpipe_ignore() was used.
124 static void sigpipe_restore(struct sigpipe_ignore *ig)
127 /* restore the outside state */
128 sigaction(SIGPIPE, &ig->old_pipe_act, NULL);
132 /* for systems without sigaction */
133 #define sigpipe_ignore(x,y) Curl_nop_stmt
134 #define sigpipe_restore(x) Curl_nop_stmt
135 #define SIGPIPE_VARIABLE(x)
138 /* win32_cleanup() is for win32 socket cleanup functionality, the opposite
140 static void win32_cleanup(void)
145 #ifdef USE_WINDOWS_SSPI
146 Curl_sspi_global_cleanup();
150 /* win32_init() performs win32 socket initialization to properly setup the
151 stack to allow networking */
152 static CURLcode win32_init(void)
155 WORD wVersionRequested;
159 #if defined(ENABLE_IPV6) && (USE_WINSOCK < 2)
160 Error IPV6_requires_winsock2
163 wVersionRequested = MAKEWORD(USE_WINSOCK, USE_WINSOCK);
165 res = WSAStartup(wVersionRequested, &wsaData);
168 /* Tell the user that we couldn't find a useable */
170 return CURLE_FAILED_INIT;
172 /* Confirm that the Windows Sockets DLL supports what we need.*/
173 /* Note that if the DLL supports versions greater */
174 /* than wVersionRequested, it will still return */
175 /* wVersionRequested in wVersion. wHighVersion contains the */
176 /* highest supported version. */
178 if(LOBYTE( wsaData.wVersion ) != LOBYTE(wVersionRequested) ||
179 HIBYTE( wsaData.wVersion ) != HIBYTE(wVersionRequested) ) {
180 /* Tell the user that we couldn't find a useable */
184 return CURLE_FAILED_INIT;
186 /* The Windows Sockets DLL is acceptable. Proceed. */
187 #elif defined(USE_LWIPSOCK)
191 #ifdef USE_WINDOWS_SSPI
193 CURLcode err = Curl_sspi_global_init();
204 * Initialise use of IDNA library.
205 * It falls back to ASCII if $CHARSET isn't defined. This doesn't work for
206 * idna_to_ascii_lz().
208 static void idna_init (void)
214 if(!getenv("CHARSET") && cp > 0) {
215 snprintf(buf, sizeof(buf), "CHARSET=cp%u", cp);
222 #endif /* USE_LIBIDN */
224 /* true globals -- for curl_global_init() and curl_global_cleanup() */
225 static unsigned int initialized;
226 static long init_flags;
229 * strdup (and other memory functions) is redefined in complicated
230 * ways, but at this point it must be defined as the system-supplied strdup
231 * so the callback pointer is initialized correctly.
233 #if defined(_WIN32_WCE)
234 #define system_strdup _strdup
235 #elif !defined(HAVE_STRDUP)
236 #define system_strdup curlx_strdup
238 #define system_strdup strdup
241 #if defined(_MSC_VER) && defined(_DLL) && !defined(__POCC__)
242 # pragma warning(disable:4232) /* MSVC extension, dllimport identity */
245 #ifndef __SYMBIAN32__
247 * If a memory-using function (like curl_getenv) is used before
248 * curl_global_init() is called, we need to have these pointers set already.
250 curl_malloc_callback Curl_cmalloc = (curl_malloc_callback)malloc;
251 curl_free_callback Curl_cfree = (curl_free_callback)free;
252 curl_realloc_callback Curl_crealloc = (curl_realloc_callback)realloc;
253 curl_strdup_callback Curl_cstrdup = (curl_strdup_callback)system_strdup;
254 curl_calloc_callback Curl_ccalloc = (curl_calloc_callback)calloc;
255 #if defined(WIN32) && defined(UNICODE)
256 curl_wcsdup_callback Curl_cwcsdup = (curl_wcsdup_callback)_wcsdup;
260 * Symbian OS doesn't support initialization to code in writeable static data.
261 * Initialization will occur in the curl_global_init() call.
263 curl_malloc_callback Curl_cmalloc;
264 curl_free_callback Curl_cfree;
265 curl_realloc_callback Curl_crealloc;
266 curl_strdup_callback Curl_cstrdup;
267 curl_calloc_callback Curl_ccalloc;
270 #if defined(_MSC_VER) && defined(_DLL) && !defined(__POCC__)
271 # pragma warning(default:4232) /* MSVC extension, dllimport identity */
275 * curl_global_init() globally initializes cURL given a bitwise set of the
276 * different features of what to initialize.
278 CURLcode curl_global_init(long flags)
283 /* Setup the default memory functions here (again) */
284 Curl_cmalloc = (curl_malloc_callback)malloc;
285 Curl_cfree = (curl_free_callback)free;
286 Curl_crealloc = (curl_realloc_callback)realloc;
287 Curl_cstrdup = (curl_strdup_callback)system_strdup;
288 Curl_ccalloc = (curl_calloc_callback)calloc;
289 #if defined(WIN32) && defined(UNICODE)
290 Curl_cwcsdup = (curl_wcsdup_callback)_wcsdup;
293 if(flags & CURL_GLOBAL_SSL)
294 if(!Curl_ssl_init()) {
295 DEBUGF(fprintf(stderr, "Error: Curl_ssl_init failed\n"));
296 return CURLE_FAILED_INIT;
299 if(flags & CURL_GLOBAL_WIN32)
300 if(win32_init() != CURLE_OK) {
301 DEBUGF(fprintf(stderr, "Error: win32_init failed\n"));
302 return CURLE_FAILED_INIT;
306 if(!Curl_amiga_init()) {
307 DEBUGF(fprintf(stderr, "Error: Curl_amiga_init failed\n"));
308 return CURLE_FAILED_INIT;
314 DEBUGF(fprintf(stderr, "Warning: LONG namespace not available\n"));
322 if(Curl_resolver_global_init() != CURLE_OK) {
323 DEBUGF(fprintf(stderr, "Error: resolver_global_init failed\n"));
324 return CURLE_FAILED_INIT;
327 #if defined(USE_LIBSSH2) && defined(HAVE_LIBSSH2_INIT)
328 if(libssh2_init(0)) {
329 DEBUGF(fprintf(stderr, "Error: libssh2_init failed\n"));
330 return CURLE_FAILED_INIT;
334 if(flags & CURL_GLOBAL_ACK_EINTR)
343 * curl_global_init_mem() globally initializes cURL and also registers the
344 * user provided callback routines.
346 CURLcode curl_global_init_mem(long flags, curl_malloc_callback m,
347 curl_free_callback f, curl_realloc_callback r,
348 curl_strdup_callback s, curl_calloc_callback c)
350 CURLcode code = CURLE_OK;
352 /* Invalid input, return immediately */
353 if(!m || !f || !r || !s || !c)
354 return CURLE_FAILED_INIT;
356 /* Already initialized, don't do it again */
360 /* Call the actual init function first */
361 code = curl_global_init(flags);
362 if(code == CURLE_OK) {
374 * curl_global_cleanup() globally cleanups cURL, uses the value of
375 * "init_flags" to determine what needs to be cleaned up and what doesn't.
377 void curl_global_cleanup(void)
385 Curl_global_host_cache_dtor();
387 if(init_flags & CURL_GLOBAL_SSL)
390 Curl_resolver_global_cleanup();
392 if(init_flags & CURL_GLOBAL_WIN32)
395 Curl_amiga_cleanup();
397 #if defined(USE_LIBSSH2) && defined(HAVE_LIBSSH2_EXIT)
398 (void)libssh2_exit();
405 * curl_easy_init() is the external interface to alloc, setup and init an
406 * easy handle that is returned. If anything goes wrong, NULL is returned.
408 CURL *curl_easy_init(void)
411 struct SessionHandle *data;
413 /* Make sure we inited the global SSL stuff */
415 res = curl_global_init(CURL_GLOBAL_DEFAULT);
417 /* something in the global init failed, return nothing */
418 DEBUGF(fprintf(stderr, "Error: curl_global_init failed\n"));
423 /* We use curl_open() with undefined URL so far */
424 res = Curl_open(&data);
425 if(res != CURLE_OK) {
426 DEBUGF(fprintf(stderr, "Error: Curl_open failed\n"));
434 * curl_easy_setopt() is the external interface for setting options on an
438 #undef curl_easy_setopt
439 CURLcode curl_easy_setopt(CURL *curl, CURLoption tag, ...)
442 struct SessionHandle *data = curl;
446 return CURLE_BAD_FUNCTION_ARGUMENT;
450 ret = Curl_setopt(data, tag, arg);
457 * curl_easy_perform() is the external interface that performs a blocking
458 * transfer as previously setup.
460 * CONCEPT: This function creates a multi handle, adds the easy handle to it,
461 * runs curl_multi_perform() until the transfer is done, then detaches the
462 * easy handle, destroys the multi handle and returns the easy handle's return
465 * REALITY: it can't just create and destroy the multi handle that easily. It
466 * needs to keep it around since if this easy handle is used again by this
467 * function, the same multi handle must be re-used so that the same pools and
468 * caches can be used.
470 CURLcode curl_easy_perform(CURL *easy)
474 CURLcode code = CURLE_OK;
478 struct SessionHandle *data = easy;
479 int without_fds = 0; /* count number of consecutive returns from
480 curl_multi_wait() without any filedescriptors */
481 struct timeval before;
482 SIGPIPE_VARIABLE(pipe_st);
485 return CURLE_BAD_FUNCTION_ARGUMENT;
488 failf(data, "easy handled already used in multi handle");
489 return CURLE_FAILED_INIT;
493 multi = data->multi_easy;
495 /* this multi handle will only ever have a single easy handled attached
496 to it, so make it use minimal hashes */
497 multi = Curl_multi_handle(1, 3);
499 return CURLE_OUT_OF_MEMORY;
500 data->multi_easy = multi;
503 /* Copy the MAXCONNECTS option to the multi handle */
504 curl_multi_setopt(multi, CURLMOPT_MAXCONNECTS, data->set.maxconnects);
506 mcode = curl_multi_add_handle(multi, easy);
508 curl_multi_cleanup(multi);
509 if(mcode == CURLM_OUT_OF_MEMORY)
510 return CURLE_OUT_OF_MEMORY;
512 return CURLE_FAILED_INIT;
515 sigpipe_ignore(data, &pipe_st);
517 /* assign this after curl_multi_add_handle() since that function checks for
518 it and rejects this handle otherwise */
521 while(!done && !mcode) {
525 before = curlx_tvnow();
526 mcode = curl_multi_wait(multi, NULL, 0, 1000, &ret);
528 if(mcode == CURLM_OK) {
530 /* poll() failed not on EINTR, indicate a network problem */
531 code = CURLE_RECV_ERROR;
535 struct timeval after = curlx_tvnow();
536 /* If it returns without any filedescriptor instantly, we need to
537 avoid busy-looping during periods where it has nothing particular
539 if(curlx_tvdiff(after, before) <= 10) {
541 if(without_fds > 2) {
542 int sleep_ms = without_fds < 10 ? (1 << (without_fds-1)): 1000;
543 Curl_wait_ms(sleep_ms);
547 /* it wasn't "instant", restart counter */
551 /* got file descriptor, restart counter */
554 mcode = curl_multi_perform(multi, &still_running);
557 /* only read 'still_running' if curl_multi_perform() return OK */
558 if((mcode == CURLM_OK) && !still_running) {
559 msg = curl_multi_info_read(multi, &rc);
561 code = msg->data.result;
567 /* ignoring the return code isn't nice, but atm we can't really handle
568 a failure here, room for future improvement! */
569 (void)curl_multi_remove_handle(multi, easy);
571 sigpipe_restore(&pipe_st);
573 /* The multi handle is kept alive, owned by the easy handle */
578 * curl_easy_cleanup() is the external interface to cleaning/freeing the given
581 void curl_easy_cleanup(CURL *curl)
583 struct SessionHandle *data = (struct SessionHandle *)curl;
584 SIGPIPE_VARIABLE(pipe_st);
589 sigpipe_ignore(data, &pipe_st);
591 sigpipe_restore(&pipe_st);
595 * Store a pointed to the multi handle within the easy handle's data struct.
597 void Curl_easy_addmulti(struct SessionHandle *data,
603 void Curl_easy_initHandleData(struct SessionHandle *data)
605 memset(&data->req, 0, sizeof(struct SingleRequest));
607 data->req.maxdownload = -1;
611 * curl_easy_getinfo() is an external interface that allows an app to retrieve
612 * information from a performed transfer and similar.
614 #undef curl_easy_getinfo
615 CURLcode curl_easy_getinfo(CURL *curl, CURLINFO info, ...)
620 struct SessionHandle *data = (struct SessionHandle *)curl;
623 paramp = va_arg(arg, void *);
625 ret = Curl_getinfo(data, info, paramp);
632 * curl_easy_duphandle() is an external interface to allow duplication of a
633 * given input easy handle. The returned handle will be a new working handle
634 * with all options set exactly as the input source handle.
636 CURL *curl_easy_duphandle(CURL *incurl)
638 struct SessionHandle *data=(struct SessionHandle *)incurl;
640 struct SessionHandle *outcurl = calloc(1, sizeof(struct SessionHandle));
645 * We setup a few buffers we need. We should probably make them
646 * get setup on-demand in the code, as that would probably decrease
647 * the likeliness of us forgetting to init a buffer here in the future.
649 outcurl->state.headerbuff = malloc(HEADERSIZE);
650 if(!outcurl->state.headerbuff)
652 outcurl->state.headersize = HEADERSIZE;
654 /* copy all userdefined values */
655 if(Curl_dupset(outcurl, data) != CURLE_OK)
658 /* the connection cache is setup on demand */
659 outcurl->state.conn_cache = NULL;
661 outcurl->state.lastconnect = NULL;
663 outcurl->progress.flags = data->progress.flags;
664 outcurl->progress.callback = data->progress.callback;
667 /* If cookies are enabled in the parent handle, we enable them
668 in the clone as well! */
669 outcurl->cookies = Curl_cookie_init(data,
670 data->cookies->filename,
672 data->set.cookiesession);
673 if(!outcurl->cookies)
677 /* duplicate all values in 'change' */
678 if(data->change.cookielist) {
679 outcurl->change.cookielist =
680 Curl_slist_duplicate(data->change.cookielist);
681 if(!outcurl->change.cookielist)
685 if(data->change.url) {
686 outcurl->change.url = strdup(data->change.url);
687 if(!outcurl->change.url)
689 outcurl->change.url_alloc = TRUE;
692 if(data->change.referer) {
693 outcurl->change.referer = strdup(data->change.referer);
694 if(!outcurl->change.referer)
696 outcurl->change.referer_alloc = TRUE;
699 /* Clone the resolver handle, if present, for the new handle */
700 if(Curl_resolver_duphandle(&outcurl->state.resolver,
701 data->state.resolver) != CURLE_OK)
704 Curl_convert_setup(outcurl);
706 Curl_easy_initHandleData(outcurl);
708 outcurl->magic = CURLEASY_MAGIC_NUMBER;
710 /* we reach this point and thus we are OK */
717 curl_slist_free_all(outcurl->change.cookielist);
718 outcurl->change.cookielist = NULL;
719 Curl_safefree(outcurl->state.headerbuff);
720 Curl_safefree(outcurl->change.url);
721 Curl_safefree(outcurl->change.referer);
722 Curl_freeset(outcurl);
730 * curl_easy_reset() is an external interface that allows an app to re-
731 * initialize a session handle to the default values.
733 void curl_easy_reset(CURL *curl)
735 struct SessionHandle *data = (struct SessionHandle *)curl;
737 Curl_safefree(data->state.pathbuffer);
739 data->state.path = NULL;
741 Curl_safefree(data->state.proto.generic);
743 /* zero out UserDefined data: */
745 memset(&data->set, 0, sizeof(struct UserDefined));
746 (void)Curl_init_userdefined(&data->set);
748 /* zero out Progress data: */
749 memset(&data->progress, 0, sizeof(struct Progress));
751 /* init Handle data */
752 Curl_easy_initHandleData(data);
754 data->progress.flags |= PGRS_HIDE;
755 data->state.current_speed = -1; /* init to negative == impossible */
759 * curl_easy_pause() allows an application to pause or unpause a specific
760 * transfer and direction. This function sets the full new state for the
761 * current connection this easy handle operates on.
763 * NOTE: if you have the receiving paused and you call this function to remove
764 * the pausing, you may get your write callback called at this point.
766 * Action is a bitmask consisting of CURLPAUSE_* bits in curl/curl.h
768 CURLcode curl_easy_pause(CURL *curl, int action)
770 struct SessionHandle *data = (struct SessionHandle *)curl;
771 struct SingleRequest *k = &data->req;
772 CURLcode result = CURLE_OK;
774 /* first switch off both pause bits */
775 int newstate = k->keepon &~ (KEEP_RECV_PAUSE| KEEP_SEND_PAUSE);
777 /* set the new desired pause bits */
778 newstate |= ((action & CURLPAUSE_RECV)?KEEP_RECV_PAUSE:0) |
779 ((action & CURLPAUSE_SEND)?KEEP_SEND_PAUSE:0);
781 /* put it back in the keepon */
782 k->keepon = newstate;
784 if(!(newstate & KEEP_RECV_PAUSE) && data->state.tempwrite) {
785 /* we have a buffer for sending that we now seem to be able to deliver
786 since the receive pausing is lifted! */
788 /* get the pointer, type and length in local copies since the function may
789 return PAUSE again and then we'll get a new copy allocted and stored in
790 the tempwrite variables */
791 char *tempwrite = data->state.tempwrite;
792 char *freewrite = tempwrite; /* store this pointer to free it later */
793 size_t tempsize = data->state.tempwritesize;
794 int temptype = data->state.tempwritetype;
797 /* clear tempwrite here just to make sure it gets cleared if there's no
798 further use of it, and make sure we don't clear it after the function
799 invoke as it may have been set to a new value by then */
800 data->state.tempwrite = NULL;
802 /* since the write callback API is define to never exceed
803 CURL_MAX_WRITE_SIZE bytes in a single call, and since we may in fact
804 have more data than that in our buffer here, we must loop sending the
805 data in multiple calls until there's no data left or we get another
808 A tricky part is that the function we call will "buffer" the data
809 itself when it pauses on a particular buffer, so we may need to do some
810 extra trickery if we get a pause return here.
813 chunklen = (tempsize > CURL_MAX_WRITE_SIZE)?CURL_MAX_WRITE_SIZE:tempsize;
815 result = Curl_client_write(data->easy_conn,
816 temptype, tempwrite, chunklen);
818 /* failures abort the loop at once */
821 if(data->state.tempwrite && (tempsize - chunklen)) {
822 /* Ouch, the reading is again paused and the block we send is now
823 "cached". If this is the final chunk we can leave it like this, but
824 if we have more chunks that are cached after this, we need to free
825 the newly cached one and put back a version that is truly the entire
826 contents that is saved for later
830 /* note that tempsize is still the size as before the callback was
831 used, and thus the whole piece of data to keep */
832 newptr = realloc(data->state.tempwrite, tempsize);
835 free(data->state.tempwrite); /* free old area */
836 data->state.tempwrite = NULL;
837 result = CURLE_OUT_OF_MEMORY;
838 /* tempwrite will be freed further down */
841 data->state.tempwrite = newptr; /* store new pointer */
842 memcpy(newptr, tempwrite, tempsize);
843 data->state.tempwritesize = tempsize; /* store new size */
844 /* tempwrite will be freed further down */
845 break; /* go back to pausing until further notice */
848 tempsize -= chunklen; /* left after the call above */
849 tempwrite += chunklen; /* advance the pointer */
852 } while((result == CURLE_OK) && tempsize);
854 free(freewrite); /* this is unconditionally no longer used */
857 /* if there's no error and we're not pausing both directions, we want
858 to have this handle checked soon */
860 ((newstate&(KEEP_RECV_PAUSE|KEEP_SEND_PAUSE)) !=
861 (KEEP_RECV_PAUSE|KEEP_SEND_PAUSE)) )
862 Curl_expire(data, 1); /* get this handle going again */
868 static CURLcode easy_connection(struct SessionHandle *data,
870 struct connectdata **connp)
873 return CURLE_BAD_FUNCTION_ARGUMENT;
875 /* only allow these to be called on handles with CURLOPT_CONNECT_ONLY */
876 if(!data->set.connect_only) {
877 failf(data, "CONNECT_ONLY is required!");
878 return CURLE_UNSUPPORTED_PROTOCOL;
881 *sfd = Curl_getconnectinfo(data, connp);
883 if(*sfd == CURL_SOCKET_BAD) {
884 failf(data, "Failed to get recent socket");
885 return CURLE_UNSUPPORTED_PROTOCOL;
892 * Receives data from the connected socket. Use after successful
893 * curl_easy_perform() with CURLOPT_CONNECT_ONLY option.
894 * Returns CURLE_OK on success, error code on error.
896 CURLcode curl_easy_recv(CURL *curl, void *buffer, size_t buflen, size_t *n)
901 struct connectdata *c;
902 struct SessionHandle *data = (struct SessionHandle *)curl;
904 ret = easy_connection(data, &sfd, &c);
909 ret = Curl_read(c, sfd, buffer, buflen, &n1);
920 * Sends data over the connected socket. Use after successful
921 * curl_easy_perform() with CURLOPT_CONNECT_ONLY option.
923 CURLcode curl_easy_send(CURL *curl, const void *buffer, size_t buflen,
929 struct connectdata *c = NULL;
930 struct SessionHandle *data = (struct SessionHandle *)curl;
932 ret = easy_connection(data, &sfd, &c);
937 ret = Curl_write(c, sfd, buffer, buflen, &n1);
940 return CURLE_SEND_ERROR;
943 if((CURLE_OK == ret) && (0 == n1))