threading.md 4.74 KB
Newer Older
Etienne Samson committed
1
Threading in libgit2
2 3
==================

Etienne Samson committed
4
Unless otherwise specified, libgit2 objects cannot be safely accessed by
5
multiple threads simultaneously.
Etienne Samson committed
6 7

There are also caveats on the cryptographic libraries libgit2 or its
8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
dependencies link to (more on this later). For libgit2 itself,
provided you take the following into consideration you won't run into
issues:

Sharing objects
---------------

Use an object from a single thread at a time. Most data structures do
not guard against concurrent access themselves. This is because they
are rarely used in isolation and it makes more sense to synchronize
access via a larger lock or similar mechanism.

There are some objects which are read-only/immutable and are thus safe
to share across threads, such as references and configuration
snapshots.

24 25 26
The `git_odb` object uses locking internally, and is thread-safe to use from
multiple threads simultaneously.

27 28 29
Error messages
--------------

30
The error message is thread-local. The `git_error_last()` call must
31 32
happen on the same thread as the error in order to get the
message. Often this will be the case regardless, but if you use
Ben Chatelain committed
33
something like the [GCD](http://en.wikipedia.org/wiki/Grand_Central_Dispatch)
Etienne Samson committed
34
on macOS (where code is executed on an arbitrary thread), the code
Ben Chatelain committed
35 36
must make sure to retrieve the error code on the thread where the error
happened.
37

Etienne Samson committed
38
Threading and cryptographic libraries
39 40 41 42 43 44 45 46 47 48
=======================================

On Windows
----------

When built as a native Windows DLL, libgit2 uses WinCNG and WinHTTP,
both of which are thread-safe. You do not need to do anything special.

When using libssh2 which itself uses WinCNG, there are no special
steps necessary. If you are using a MinGW or similar environment where
49
libssh2 uses OpenSSL or libgcrypt, then the general case affects
50 51
you.

Etienne Samson committed
52
On macOS
53 54
-----------

Etienne Samson committed
55 56
By default we make use of CommonCrypto and SecureTransport for cryptographic
support. These are thread-safe and you do not need to do anything special.
57 58 59 60 61 62 63

Note that libssh2 may still use OpenSSL itself. In that case, the
general case still affects you if you use ssh.

General Case
------------

64 65 66 67 68
libgit2 will default to OpenSSL for HTTPS transport (except on Windows and
macOS, as mentioned above).  On any system, mbedTLS _may_ be optionally
enabled as the security provider.  OpenSSL is thread-safe starting at
version 1.1.0. If your copy of libgit2 is linked against that version,
you do not need to take any further steps.
69 70 71 72 73 74 75

Older versions of OpenSSL are made to be thread-implementation agnostic, and the
users of the library must set which locking function it should use. libgit2
cannot know what to set as the user of libgit2 may also be using OpenSSL independently and
the locking settings must then live outside the lifetime of libgit2.

Even if libgit2 doesn't use OpenSSL directly, OpenSSL can still be used by
Etienne Samson committed
76
libssh2 depending on the configuration. If OpenSSL is used by
77 78
more than one library, you only need to set up threading for OpenSSL once.

Etienne Samson committed
79
If libgit2 is linked against OpenSSL < 1.1.0, it provides a last-resort convenience function
80
`git_openssl_set_locking()` (available in `sys/openssl.h`) to use the
81 82 83
platform-native mutex mechanisms to perform the locking, which you can use
if you do not want to use OpenSSL outside of libgit2, or you
know that libgit2 will outlive the rest of the operations. It is then not
84
safe to use OpenSSL multi-threaded after libgit2's shutdown function
85 86
has been called.  Note `git_openssl_set_locking()` only works if
libgit2 uses OpenSSL directly - if OpenSSL is only used as a dependency
Etienne Samson committed
87
of libssh2 as described above, `git_openssl_set_locking()` is a no-op.
88 89 90

If your programming language offers a package/bindings for OpenSSL,
you should very strongly prefer to use that in order to set up
91
locking, as they provide a level of coordination which is impossible
92
when using this function.
93 94 95

See the
[OpenSSL documentation](https://www.openssl.org/docs/crypto/threads.html)
96 97
on threading for more details, and http://trac.libssh2.org/wiki/MultiThreading
for a specific example of providing the threading callbacks.
98

99 100
libssh2 may be linked against OpenSSL or libgcrypt. If it uses OpenSSL,
see the above paragraphs. If it uses libgcrypt, then you need to
101
set up its locking before using it multi-threaded. libgit2 has no
102
direct connection to libgcrypt and thus has no convenience functions for
103 104 105 106 107 108 109 110
it (but libgcrypt has macros). Read libgcrypt's
[threading documentation for more information](http://www.gnupg.org/documentation/manuals/gcrypt/Multi_002dThreading.html)

It is your responsibility as an application author or packager to know
what your dependencies are linked against and to take the appropriate
steps to ensure the cryptographic libraries are thread-safe. We agree
that this situation is far from ideal but at this time it is something
the application authors need to deal with.