docs/libcurl/libcurl-thread.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 2015 - 2017, Daniel Stenberg, <daniel@haxx.se>, et al.
   9 .\" *
  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 https://curl.haxx.se/docs/copyright.html.
  13 .\" *
  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.
  17 .\" *
  18 .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  19 .\" * KIND, either express or implied.
  20 .\" *
  21 .\" **************************************************************************
  22 .\"
  23 .TH libcurl-thread 3 "August 08, 2017" "libcurl 7.59.0" "libcurl thread safety"
  24
  25 .SH NAME
  26 libcurl-thread \- libcurl thread safety
  27 .SH "Multi-threading with libcurl"
  28 libcurl is thread safe but has no internal thread synchronization. You may have
  29 to provide your own locking should you meet any of the thread safety exceptions
  30 below.
  31
  32 \fBHandles.\fP You must \fBnever\fP share the same handle in multiple threads.
  33 You can pass the handles around among threads, but you must never use a single
  34 handle from more than one thread at any given time.
  35
  36 \fBShared objects.\fP You can share certain data between multiple handles by
  37 using the share interface but you must provide your own locking and set
  38 \fIcurl_share_setopt(3)\fP CURLSHOPT_LOCKFUNC and CURLSHOPT_UNLOCKFUNC.
  39 .SH TLS
  40 If you are accessing HTTPS or FTPS URLs in a multi-threaded manner, you are
  41 then of course using the underlying SSL library multi-threaded and those libs
  42 might have their own requirements on this issue.  You may need to provide one
  43 or two functions to allow it to function properly:
  44 .IP OpenSSL
  45 OpenSSL 1.1.0 "can be safely used in multi-threaded applications provided that
  46 support for the underlying OS threading API is built-in."
  47
  48 https://www.openssl.org/docs/manmaster/crypto/threads.html#DESCRIPTION
  49
  50 OpenSSL <= 1.0.2 the user must set callbacks.
  51
  52 https://www.openssl.org/docs/man1.0.2/crypto/threads.html#DESCRIPTION
  53
  54 https://curl.haxx.se/libcurl/c/opensslthreadlock.html
  55
  56 .IP GnuTLS
  57 https://gnutls.org/manual/html_node/Thread-safety.html
  58 .IP NSS
  59 thread-safe already without anything required.
  60 .IP PolarSSL
  61 Required actions unknown.
  62 .IP yassl
  63 Required actions unknown.
  64 .IP axTLS
  65 Required actions unknown.
  66 .IP Secure-Transport
  67 The engine is used by libcurl in a way that is fully thread-safe.
  68 .IP WinSSL
  69 The engine is used by libcurl in a way that is fully thread-safe.
  70 .IP wolfSSL
  71 The engine is used by libcurl in a way that is fully thread-safe.
  72 .IP BoringSSL
  73 The engine is used by libcurl in a way that is fully thread-safe.
  74 .SH "Other areas of caution"
  75 .IP Signals
  76 Signals are used for timing out name resolves (during DNS lookup) - when built
  77 without using either the c-ares or threaded resolver backends. When using
  78 multiple threads you should set the \fICURLOPT_NOSIGNAL(3)\fP option to 1L for
  79 all handles. Everything will or might work fine except that timeouts are not
  80 honored during the DNS lookup - which you can work around by building libcurl
  81 with c-ares or threaded-resolver support. c-ares is a library that provides
  82 asynchronous name resolves. On some platforms, libcurl simply will not
  83 function properly multi-threaded unless the \fICURLOPT_NOSIGNAL(3)\fP option is
  84 set.
  85 .IP "Name resolving"
  86 \fBgethostby* functions and other system calls.\fP These functions, provided
  87 by your operating system, must be thread safe. It is very important that
  88 libcurl can find and use thread safe versions of these and other system calls,
  89 as otherwise it can't function fully thread safe. Some operating systems are
  90 known to have faulty thread implementations. We have previously received
  91 problem reports on *BSD (at least in the past, they may be working fine these
  92 days).  Some operating systems that are known to have solid and working thread
  93 support are Linux, Solaris and Windows.
  94 .IP "curl_global_* functions"
  95 These functions are not thread safe. If you are using libcurl with multiple
  96 threads it is especially important that before use you call
  97 \fIcurl_global_init(3)\fP or \fIcurl_global_init_mem(3)\fP to explicitly
  98 initialize the library and its dependents, rather than rely on the "lazy"
  99 fail-safe initialization that takes place the first time
 100 \fIcurl_easy_init(3)\fP is called. For an in-depth explanation refer to
 101 \fIlibcurl(3)\fP section \fBGLOBAL CONSTANTS\fP.
 102 .IP "Memory functions"
 103 These functions, provided either by your operating system or your own
 104 replacements, must be thread safe. You can use \fIcurl_global_init_mem(3)\fP
 105 to set your own replacement memory functions.
 106 .IP "Non-safe functions"
 107 \fICURLOPT_DNS_USE_GLOBAL_CACHE(3)\fP is not thread-safe.