global.c 5.3 KB
Newer Older
1
/*
Edward Thomson committed
2
 * Copyright (C) the libgit2 contributors. All rights reserved.
3 4 5 6 7 8
 *
 * This file is part of libgit2, distributed under the GNU GPL v2 with
 * a Linking Exception. For full terms see the included COPYING file.
 */
#include "common.h"
#include "global.h"
9
#include "hash.h"
10 11
#include "fileops.h"
#include "git2/threads.h"
12 13
#include "thread-utils.h"

14 15 16

git_mutex git__mwindow_mutex;

17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38
#define MAX_SHUTDOWN_CB 8

git_global_shutdown_fn git__shutdown_callbacks[MAX_SHUTDOWN_CB];
git_atomic git__n_shutdown_callbacks;

void git__on_shutdown(git_global_shutdown_fn callback)
{
	int count = git_atomic_inc(&git__n_shutdown_callbacks);
	assert(count <= MAX_SHUTDOWN_CB);
	git__shutdown_callbacks[count - 1] = callback;
}

static void git__shutdown(void)
{
	int pos;

	while ((pos = git_atomic_dec(&git__n_shutdown_callbacks)) >= 0) {
		if (git__shutdown_callbacks[pos])
			git__shutdown_callbacks[pos]();
	}
}

39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64
/**
 * Handle the global state with TLS
 *
 * If libgit2 is built with GIT_THREADS enabled,
 * the `git_threads_init()` function must be called
 * before calling any other function of the library.
 *
 * This function allocates a TLS index (using pthreads
 * or the native Win32 API) to store the global state
 * on a per-thread basis.
 *
 * Any internal method that requires global state will
 * then call `git__global_state()` which returns a pointer
 * to the global state structure; this pointer is lazily
 * allocated on each thread.
 *
 * Before shutting down the library, the
 * `git_threads_shutdown` method must be called to free
 * the previously reserved TLS index.
 *
 * If libgit2 is built without threading support, the
 * `git__global_statestate()` call returns a pointer to a single,
 * statically allocated global state. The `git_thread_`
 * functions are not available in that case.
 */

65 66 67 68 69 70 71 72
/*
 * `git_threads_init()` allows subsystems to perform global setup,
 * which may take place in the global scope.  An explicit memory
 * fence exists at the exit of `git_threads_init()`.  Without this,
 * CPU cores are free to reorder cache invalidation of `_tls_init`
 * before cache invalidation of the subsystems' newly written global
 * state.
 */
73 74 75
#if defined(GIT_THREADS) && defined(GIT_WIN32)

static DWORD _tls_index;
76
static DWORD _mutex = 0;
77
static DWORD _n_inits = 0;
78 79

static int synchronized_threads_init()
80
{
81 82
	int error;

83
	_tls_index = TlsAlloc();
Russell Belfer committed
84 85
	if (git_mutex_init(&git__mwindow_mutex))
		return -1;
86 87

	/* Initialize any other subsystems that have global state */
88 89
	if ((error = git_hash_global_init()) >= 0)
		error = git_futils_dirs_global_init();
90

91
	win32_pthread_initialize();
92

93 94 95 96 97
	return error;
}

int git_threads_init(void)
{
98 99 100 101
	int error = 0;

	/* Enter the lock */
	while (InterlockedCompareExchange(&_mutex, 1, 0)) { Sleep(0); }
102

103
	/* Only do work on a 0 -> 1 transition of the refcount */
104
	if (1 == ++_n_inits)
105
		error = synchronized_threads_init();
106

107 108 109
	/* Exit the lock */
	InterlockedExchange(&_mutex, 0);

110
	return error;
111 112
}

113
static void synchronized_threads_shutdown()
114
{
115
	/* Shut down any subsystems that have global state */
116
	git__shutdown();
117
	TlsFree(_tls_index);
118
	git_mutex_free(&git__mwindow_mutex);
119 120 121 122
}

void git_threads_shutdown(void)
{
123 124
	/* Enter the lock */
	while (InterlockedCompareExchange(&_mutex, 1, 0)) { Sleep(0); }
125

126
	/* Only do work on a 1 -> 0 transition of the refcount */
127
	if (0 == --_n_inits)
128
		synchronized_threads_shutdown();
129 130 131

	/* Exit the lock */
	InterlockedExchange(&_mutex, 0);
132 133 134 135 136 137
}

git_global_st *git__global_state(void)
{
	void *ptr;

138
	assert(_n_inits);
139

140 141 142
	if ((ptr = TlsGetValue(_tls_index)) != NULL)
		return ptr;

143
	ptr = git__malloc(sizeof(git_global_st));
144 145 146 147 148 149 150 151 152 153 154
	if (!ptr)
		return NULL;

	memset(ptr, 0x0, sizeof(git_global_st));
	TlsSetValue(_tls_index, ptr);
	return ptr;
}

#elif defined(GIT_THREADS) && defined(_POSIX_THREADS)

static pthread_key_t _tls_key;
155
static pthread_once_t _once_init = PTHREAD_ONCE_INIT;
156
static git_atomic git__n_inits;
157
int init_error = 0;
158 159 160

static void cb__free_status(void *st)
{
161
	git__free(st);
162 163
}

164
static void init_once(void)
165
{
166 167
	if ((init_error = git_mutex_init(&git__mwindow_mutex)) != 0)
		return;
168
	pthread_key_create(&_tls_key, &cb__free_status);
169 170

	/* Initialize any other subsystems that have global state */
171 172
	if ((init_error = git_hash_global_init()) >= 0)
		init_error = git_futils_dirs_global_init();
173 174

	GIT_MEMORY_BARRIER;
175
}
176

177 178 179 180 181
int git_threads_init(void)
{
	pthread_once(&_once_init, init_once);
	git_atomic_inc(&git__n_inits);
	return init_error;
182 183 184 185
}

void git_threads_shutdown(void)
{
186 187 188 189
	pthread_once_t new_once = PTHREAD_ONCE_INIT;

	if (git_atomic_dec(&git__n_inits) > 0) return;

190 191 192
	/* Shut down any subsystems that have global state */
	git__shutdown();

193 194 195
	void *ptr = pthread_getspecific(_tls_key);
	pthread_setspecific(_tls_key, NULL);
	git__free(ptr);
Russell Belfer committed
196

197
	pthread_key_delete(_tls_key);
198
	git_mutex_free(&git__mwindow_mutex);
199
	_once_init = new_once;
200 201 202 203 204 205
}

git_global_st *git__global_state(void)
{
	void *ptr;

206
	assert(git__n_inits.val);
207

208 209 210
	if ((ptr = pthread_getspecific(_tls_key)) != NULL)
		return ptr;

211
	ptr = git__malloc(sizeof(git_global_st));
212 213 214 215 216 217 218 219 220 221 222 223
	if (!ptr)
		return NULL;

	memset(ptr, 0x0, sizeof(git_global_st));
	pthread_setspecific(_tls_key, ptr);
	return ptr;
}

#else

static git_global_st __state;

224
int git_threads_init(void)
225
{
226
	/* noop */
227
	return 0;
228 229 230 231
}

void git_threads_shutdown(void)
{
232
	/* Shut down any subsystems that have global state */
233
	git__shutdown();
234 235 236 237 238 239 240 241
}

git_global_st *git__global_state(void)
{
	return &__state;
}

#endif /* GIT_THREADS */