Blame src/global.c

Packit ae9e2a
/*
Packit ae9e2a
 * Copyright (C) the libgit2 contributors. All rights reserved.
Packit ae9e2a
 *
Packit ae9e2a
 * This file is part of libgit2, distributed under the GNU GPL v2 with
Packit ae9e2a
 * a Linking Exception. For full terms see the included COPYING file.
Packit ae9e2a
 */
Packit ae9e2a
#include "common.h"
Packit ae9e2a
#include "global.h"
Packit ae9e2a
#include "hash.h"
Packit ae9e2a
#include "sysdir.h"
Packit ae9e2a
#include "filter.h"
Packit ae9e2a
#include "merge_driver.h"
Packit ae9e2a
#include "curl_stream.h"
Packit ae9e2a
#include "openssl_stream.h"
Packit ae9e2a
#include "thread-utils.h"
Packit ae9e2a
#include "git2/global.h"
Packit ae9e2a
#include "transports/ssh.h"
Packit ae9e2a
Packit ae9e2a
#if defined(GIT_MSVC_CRTDBG)
Packit ae9e2a
#include "win32/w32_stack.h"
Packit ae9e2a
#include "win32/w32_crtdbg_stacktrace.h"
Packit ae9e2a
#endif
Packit ae9e2a
Packit ae9e2a
git_mutex git__mwindow_mutex;
Packit ae9e2a
Packit ae9e2a
#define MAX_SHUTDOWN_CB 10
Packit ae9e2a
Packit ae9e2a
static git_global_shutdown_fn git__shutdown_callbacks[MAX_SHUTDOWN_CB];
Packit ae9e2a
static git_atomic git__n_shutdown_callbacks;
Packit ae9e2a
static git_atomic git__n_inits;
Packit ae9e2a
char *git__user_agent;
Packit ae9e2a
char *git__ssl_ciphers;
Packit ae9e2a
Packit ae9e2a
void git__on_shutdown(git_global_shutdown_fn callback)
Packit ae9e2a
{
Packit ae9e2a
	int count = git_atomic_inc(&git__n_shutdown_callbacks);
Packit ae9e2a
	assert(count <= MAX_SHUTDOWN_CB && count > 0);
Packit ae9e2a
	git__shutdown_callbacks[count - 1] = callback;
Packit ae9e2a
}
Packit ae9e2a
Packit ae9e2a
static void git__global_state_cleanup(git_global_st *st)
Packit ae9e2a
{
Packit ae9e2a
	if (!st)
Packit ae9e2a
		return;
Packit ae9e2a
Packit ae9e2a
	git__free(st->error_t.message);
Packit ae9e2a
	st->error_t.message = NULL;
Packit ae9e2a
}
Packit ae9e2a
Packit ae9e2a
static int init_common(void)
Packit ae9e2a
{
Packit ae9e2a
	int ret;
Packit ae9e2a
Packit ae9e2a
	/* Initialize the CRT debug allocator first, before our first malloc */
Packit ae9e2a
#if defined(GIT_MSVC_CRTDBG)
Packit ae9e2a
	git_win32__crtdbg_stacktrace_init();
Packit ae9e2a
	git_win32__stack_init();
Packit ae9e2a
#endif
Packit ae9e2a
Packit ae9e2a
	/* Initialize any other subsystems that have global state */
Packit ae9e2a
	if ((ret = git_hash_global_init()) == 0 &&
Packit ae9e2a
		(ret = git_sysdir_global_init()) == 0 &&
Packit ae9e2a
		(ret = git_filter_global_init()) == 0 &&
Packit ae9e2a
		(ret = git_merge_driver_global_init()) == 0 &&
Packit ae9e2a
		(ret = git_transport_ssh_global_init()) == 0 &&
Packit ae9e2a
		(ret = git_openssl_stream_global_init()) == 0 &&
Packit ae9e2a
		(ret = git_curl_stream_global_init()) == 0)
Packit ae9e2a
		ret = git_mwindow_global_init();
Packit ae9e2a
Packit ae9e2a
	GIT_MEMORY_BARRIER;
Packit ae9e2a
Packit ae9e2a
	return ret;
Packit ae9e2a
}
Packit ae9e2a
Packit ae9e2a
static void shutdown_common(void)
Packit ae9e2a
{
Packit ae9e2a
	int pos;
Packit ae9e2a
Packit ae9e2a
	/* Shutdown subsystems that have registered */
Packit ae9e2a
	for (pos = git_atomic_get(&git__n_shutdown_callbacks);
Packit ae9e2a
		pos > 0;
Packit ae9e2a
		pos = git_atomic_dec(&git__n_shutdown_callbacks)) {
Packit ae9e2a
Packit ae9e2a
		git_global_shutdown_fn cb = git__swap(
Packit ae9e2a
			git__shutdown_callbacks[pos - 1], NULL);
Packit ae9e2a
Packit ae9e2a
		if (cb != NULL)
Packit ae9e2a
			cb();
Packit ae9e2a
	}
Packit ae9e2a
Packit ae9e2a
	git__free(git__user_agent);
Packit ae9e2a
	git__free(git__ssl_ciphers);
Packit ae9e2a
}
Packit ae9e2a
Packit ae9e2a
/**
Packit ae9e2a
 * Handle the global state with TLS
Packit ae9e2a
 *
Packit ae9e2a
 * If libgit2 is built with GIT_THREADS enabled,
Packit ae9e2a
 * the `git_libgit2_init()` function must be called
Packit ae9e2a
 * before calling any other function of the library.
Packit ae9e2a
 *
Packit ae9e2a
 * This function allocates a TLS index (using pthreads
Packit ae9e2a
 * or the native Win32 API) to store the global state
Packit ae9e2a
 * on a per-thread basis.
Packit ae9e2a
 *
Packit ae9e2a
 * Any internal method that requires global state will
Packit ae9e2a
 * then call `git__global_state()` which returns a pointer
Packit ae9e2a
 * to the global state structure; this pointer is lazily
Packit ae9e2a
 * allocated on each thread.
Packit ae9e2a
 *
Packit ae9e2a
 * Before shutting down the library, the
Packit ae9e2a
 * `git_libgit2_shutdown` method must be called to free
Packit ae9e2a
 * the previously reserved TLS index.
Packit ae9e2a
 *
Packit ae9e2a
 * If libgit2 is built without threading support, the
Packit ae9e2a
 * `git__global_statestate()` call returns a pointer to a single,
Packit ae9e2a
 * statically allocated global state. The `git_thread_`
Packit ae9e2a
 * functions are not available in that case.
Packit ae9e2a
 */
Packit ae9e2a
Packit ae9e2a
/*
Packit ae9e2a
 * `git_libgit2_init()` allows subsystems to perform global setup,
Packit ae9e2a
 * which may take place in the global scope.  An explicit memory
Packit ae9e2a
 * fence exists at the exit of `git_libgit2_init()`.  Without this,
Packit ae9e2a
 * CPU cores are free to reorder cache invalidation of `_tls_init`
Packit ae9e2a
 * before cache invalidation of the subsystems' newly written global
Packit ae9e2a
 * state.
Packit ae9e2a
 */
Packit ae9e2a
#if defined(GIT_THREADS) && defined(GIT_WIN32)
Packit ae9e2a
Packit ae9e2a
static DWORD _tls_index;
Packit ae9e2a
static volatile LONG _mutex = 0;
Packit ae9e2a
Packit ae9e2a
static int synchronized_threads_init(void)
Packit ae9e2a
{
Packit ae9e2a
	int error;
Packit ae9e2a
Packit ae9e2a
	_tls_index = TlsAlloc();
Packit ae9e2a
Packit ae9e2a
	git_threads_init();
Packit ae9e2a
Packit ae9e2a
	if (git_mutex_init(&git__mwindow_mutex))
Packit ae9e2a
		return -1;
Packit ae9e2a
Packit ae9e2a
	error = init_common();
Packit ae9e2a
Packit ae9e2a
	return error;
Packit ae9e2a
}
Packit ae9e2a
Packit ae9e2a
int git_libgit2_init(void)
Packit ae9e2a
{
Packit ae9e2a
	int ret;
Packit ae9e2a
Packit ae9e2a
	/* Enter the lock */
Packit ae9e2a
	while (InterlockedCompareExchange(&_mutex, 1, 0)) { Sleep(0); }
Packit ae9e2a
Packit ae9e2a
	/* Only do work on a 0 -> 1 transition of the refcount */
Packit ae9e2a
	if ((ret = git_atomic_inc(&git__n_inits)) == 1) {
Packit ae9e2a
		if (synchronized_threads_init() < 0)
Packit ae9e2a
			ret = -1;
Packit ae9e2a
	}
Packit ae9e2a
Packit ae9e2a
	/* Exit the lock */
Packit ae9e2a
	InterlockedExchange(&_mutex, 0);
Packit ae9e2a
Packit ae9e2a
	return ret;
Packit ae9e2a
}
Packit ae9e2a
Packit ae9e2a
int git_libgit2_shutdown(void)
Packit ae9e2a
{
Packit ae9e2a
	int ret;
Packit ae9e2a
Packit ae9e2a
	/* Enter the lock */
Packit ae9e2a
	while (InterlockedCompareExchange(&_mutex, 1, 0)) { Sleep(0); }
Packit ae9e2a
Packit ae9e2a
	/* Only do work on a 1 -> 0 transition of the refcount */
Packit ae9e2a
	if ((ret = git_atomic_dec(&git__n_inits)) == 0) {
Packit ae9e2a
		shutdown_common();
Packit ae9e2a
Packit ae9e2a
		git__free_tls_data();
Packit ae9e2a
Packit ae9e2a
		TlsFree(_tls_index);
Packit ae9e2a
		git_mutex_free(&git__mwindow_mutex);
Packit ae9e2a
Packit ae9e2a
#if defined(GIT_MSVC_CRTDBG)
Packit ae9e2a
		git_win32__crtdbg_stacktrace_cleanup();
Packit ae9e2a
		git_win32__stack_cleanup();
Packit ae9e2a
#endif
Packit ae9e2a
	}
Packit ae9e2a
Packit ae9e2a
	/* Exit the lock */
Packit ae9e2a
	InterlockedExchange(&_mutex, 0);
Packit ae9e2a
Packit ae9e2a
	return ret;
Packit ae9e2a
}
Packit ae9e2a
Packit ae9e2a
git_global_st *git__global_state(void)
Packit ae9e2a
{
Packit ae9e2a
	git_global_st *ptr;
Packit ae9e2a
Packit ae9e2a
	assert(git_atomic_get(&git__n_inits) > 0);
Packit ae9e2a
Packit ae9e2a
	if ((ptr = TlsGetValue(_tls_index)) != NULL)
Packit ae9e2a
		return ptr;
Packit ae9e2a
Packit ae9e2a
	ptr = git__calloc(1, sizeof(git_global_st));
Packit ae9e2a
	if (!ptr)
Packit ae9e2a
		return NULL;
Packit ae9e2a
Packit ae9e2a
	git_buf_init(&ptr->error_buf, 0);
Packit ae9e2a
Packit ae9e2a
	TlsSetValue(_tls_index, ptr);
Packit ae9e2a
	return ptr;
Packit ae9e2a
}
Packit ae9e2a
Packit ae9e2a
/**
Packit ae9e2a
 * Free the TLS data associated with this thread.
Packit ae9e2a
 * This should only be used by the thread as it
Packit ae9e2a
 * is exiting.
Packit ae9e2a
 */
Packit ae9e2a
void git__free_tls_data(void)
Packit ae9e2a
{
Packit ae9e2a
	void *ptr = TlsGetValue(_tls_index);
Packit ae9e2a
	if (!ptr)
Packit ae9e2a
		return;
Packit ae9e2a
Packit ae9e2a
	git__global_state_cleanup(ptr);
Packit ae9e2a
	git__free(ptr);
Packit ae9e2a
	TlsSetValue(_tls_index, NULL);
Packit ae9e2a
}
Packit ae9e2a
Packit ae9e2a
BOOL WINAPI DllMain(HINSTANCE hInstDll, DWORD fdwReason, LPVOID lpvReserved)
Packit ae9e2a
{
Packit ae9e2a
	GIT_UNUSED(hInstDll);
Packit ae9e2a
	GIT_UNUSED(lpvReserved);
Packit ae9e2a
Packit ae9e2a
	/* This is how Windows lets us know our thread is being shut down */
Packit ae9e2a
	if (fdwReason == DLL_THREAD_DETACH) {
Packit ae9e2a
		git__free_tls_data();
Packit ae9e2a
	}
Packit ae9e2a
Packit ae9e2a
	/*
Packit ae9e2a
	 * Windows pays attention to this during library loading. We don't do anything
Packit ae9e2a
	 * so we trivially succeed.
Packit ae9e2a
	 */
Packit ae9e2a
	return TRUE;
Packit ae9e2a
}
Packit ae9e2a
Packit ae9e2a
#elif defined(GIT_THREADS) && defined(_POSIX_THREADS)
Packit ae9e2a
Packit ae9e2a
static pthread_key_t _tls_key;
Packit ae9e2a
static pthread_mutex_t _init_mutex = PTHREAD_MUTEX_INITIALIZER;
Packit ae9e2a
static pthread_once_t _once_init = PTHREAD_ONCE_INIT;
Packit ae9e2a
int init_error = 0;
Packit ae9e2a
Packit ae9e2a
static void cb__free_status(void *st)
Packit ae9e2a
{
Packit ae9e2a
	git__global_state_cleanup(st);
Packit ae9e2a
	git__free(st);
Packit ae9e2a
}
Packit ae9e2a
Packit ae9e2a
static void init_once(void)
Packit ae9e2a
{
Packit ae9e2a
	if ((init_error = git_mutex_init(&git__mwindow_mutex)) != 0)
Packit ae9e2a
		return;
Packit ae9e2a
Packit ae9e2a
	pthread_key_create(&_tls_key, &cb__free_status);
Packit ae9e2a
Packit ae9e2a
	init_error = init_common();
Packit ae9e2a
}
Packit ae9e2a
Packit ae9e2a
int git_libgit2_init(void)
Packit ae9e2a
{
Packit ae9e2a
	int ret, err;
Packit ae9e2a
Packit ae9e2a
	ret = git_atomic_inc(&git__n_inits);
Packit ae9e2a
Packit ae9e2a
	if ((err = pthread_mutex_lock(&_init_mutex)) != 0)
Packit ae9e2a
		return err;
Packit ae9e2a
	err = pthread_once(&_once_init, init_once);
Packit ae9e2a
	err |= pthread_mutex_unlock(&_init_mutex);
Packit ae9e2a
Packit ae9e2a
	if (err || init_error)
Packit ae9e2a
		return err | init_error;
Packit ae9e2a
Packit ae9e2a
	return ret;
Packit ae9e2a
}
Packit ae9e2a
Packit ae9e2a
int git_libgit2_shutdown(void)
Packit ae9e2a
{
Packit ae9e2a
	void *ptr = NULL;
Packit ae9e2a
	pthread_once_t new_once = PTHREAD_ONCE_INIT;
Packit ae9e2a
	int ret;
Packit ae9e2a
Packit ae9e2a
	if ((ret = git_atomic_dec(&git__n_inits)) != 0)
Packit ae9e2a
		return ret;
Packit ae9e2a
Packit ae9e2a
	if ((ret = pthread_mutex_lock(&_init_mutex)) != 0)
Packit ae9e2a
		return ret;
Packit ae9e2a
Packit ae9e2a
	/* Shut down any subsystems that have global state */
Packit ae9e2a
	shutdown_common();
Packit ae9e2a
Packit ae9e2a
	ptr = pthread_getspecific(_tls_key);
Packit ae9e2a
	pthread_setspecific(_tls_key, NULL);
Packit ae9e2a
Packit ae9e2a
	git__global_state_cleanup(ptr);
Packit ae9e2a
	git__free(ptr);
Packit ae9e2a
Packit ae9e2a
	pthread_key_delete(_tls_key);
Packit ae9e2a
	git_mutex_free(&git__mwindow_mutex);
Packit ae9e2a
	_once_init = new_once;
Packit ae9e2a
Packit ae9e2a
	if ((ret = pthread_mutex_unlock(&_init_mutex)) != 0)
Packit ae9e2a
		return ret;
Packit ae9e2a
Packit ae9e2a
	return 0;
Packit ae9e2a
}
Packit ae9e2a
Packit ae9e2a
git_global_st *git__global_state(void)
Packit ae9e2a
{
Packit ae9e2a
	git_global_st *ptr;
Packit ae9e2a
Packit ae9e2a
	assert(git_atomic_get(&git__n_inits) > 0);
Packit ae9e2a
Packit ae9e2a
	if ((ptr = pthread_getspecific(_tls_key)) != NULL)
Packit ae9e2a
		return ptr;
Packit ae9e2a
Packit ae9e2a
	ptr = git__calloc(1, sizeof(git_global_st));
Packit ae9e2a
	if (!ptr)
Packit ae9e2a
		return NULL;
Packit ae9e2a
Packit ae9e2a
	git_buf_init(&ptr->error_buf, 0);
Packit ae9e2a
	pthread_setspecific(_tls_key, ptr);
Packit ae9e2a
	return ptr;
Packit ae9e2a
}
Packit ae9e2a
Packit ae9e2a
#else
Packit ae9e2a
Packit ae9e2a
static git_global_st __state;
Packit ae9e2a
Packit ae9e2a
int git_libgit2_init(void)
Packit ae9e2a
{
Packit ae9e2a
	int ret;
Packit ae9e2a
Packit ae9e2a
	/* Only init subsystems the first time */
Packit ae9e2a
	if ((ret = git_atomic_inc(&git__n_inits)) != 1)
Packit ae9e2a
		return ret;
Packit ae9e2a
Packit ae9e2a
	if ((ret = init_common()) < 0)
Packit ae9e2a
		return ret;
Packit ae9e2a
Packit ae9e2a
	return 1;
Packit ae9e2a
}
Packit ae9e2a
Packit ae9e2a
int git_libgit2_shutdown(void)
Packit ae9e2a
{
Packit ae9e2a
	int ret;
Packit ae9e2a
Packit ae9e2a
	/* Shut down any subsystems that have global state */
Packit ae9e2a
	if ((ret = git_atomic_dec(&git__n_inits)) == 0) {
Packit ae9e2a
		shutdown_common();
Packit ae9e2a
		git__global_state_cleanup(&__state);
Packit ae9e2a
		memset(&__state, 0, sizeof(__state));
Packit ae9e2a
	}
Packit ae9e2a
Packit ae9e2a
	return ret;
Packit ae9e2a
}
Packit ae9e2a
Packit ae9e2a
git_global_st *git__global_state(void)
Packit ae9e2a
{
Packit ae9e2a
	return &__state;
Packit ae9e2a
}
Packit ae9e2a
Packit ae9e2a
#endif /* GIT_THREADS */