mwindow.c 9.23 KB
Newer Older
1
/*
Edward Thomson committed
2
 * Copyright (C) the libgit2 contributors. All rights reserved.
3
 *
Vicent Marti committed
4 5
 * This file is part of libgit2, distributed under the GNU GPL v2 with
 * a Linking Exception. For full terms see the included COPYING file.
6 7 8 9 10 11 12
 */

#include "common.h"
#include "mwindow.h"
#include "vector.h"
#include "fileops.h"
#include "map.h"
13
#include "global.h"
14 15 16 17
#include "strmap.h"
#include "pack.h"

GIT__USE_STRMAP;
18 19 20

#define DEFAULT_WINDOW_SIZE \
	(sizeof(void*) >= 8 \
Vicent Marti committed
21
		? 1 * 1024 * 1024 * 1024 \
22 23 24
		: 32 * 1024 * 1024)

#define DEFAULT_MAPPED_LIMIT \
25
	((1024 * 1024) * (sizeof(void*) >= 8 ? 8192ULL : 256UL))
26

Vicent Marti committed
27 28
size_t git_mwindow__window_size = DEFAULT_WINDOW_SIZE;
size_t git_mwindow__mapped_limit = DEFAULT_MAPPED_LIMIT;
29

30 31 32
/* Whenever you want to read or modify this, grab git__mwindow_mutex */
static git_mwindow_ctl mem_ctl;

33 34 35 36 37
/* Global list of mwindow files, to open packs once across repos */
git_strmap *git__pack_cache = NULL;

/**
 * Run under mwindow lock
38
 */
39
int git_mwindow_files_init(void)
40
{
41 42 43
	if (git__pack_cache)
		return 0;

44 45
	git__on_shutdown(git_mwindow_files_free);

46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66
	return git_strmap_alloc(&git__pack_cache);
}

void git_mwindow_files_free(void)
{
	git_strmap *tmp = git__pack_cache;

	git__pack_cache = NULL;
	git_strmap_free(tmp);
}

int git_mwindow_get_pack(struct git_pack_file **out, const char *path)
{
	int error;
	char *packname;
	git_strmap_iter pos;
	struct git_pack_file *pack;

	if ((error = git_packfile__name(&packname, path)) < 0)
		return error;

67 68
	if (git_mutex_lock(&git__mwindow_mutex) < 0) {
		giterr_set(GITERR_OS, "failed to lock mwindow mutex");
69
		return -1;
70
	}
71 72 73

	if (git_mwindow_files_init() < 0) {
		git_mutex_unlock(&git__mwindow_mutex);
74
		git__free(packname);
75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100
		return -1;
	}

	pos = git_strmap_lookup_index(git__pack_cache, packname);
	git__free(packname);

	if (git_strmap_valid_index(git__pack_cache, pos)) {
		pack = git_strmap_value_at(git__pack_cache, pos);
		git_atomic_inc(&pack->refcount);

		git_mutex_unlock(&git__mwindow_mutex);
		*out = pack;
		return 0;
	}

	/* If we didn't find it, we need to create it */
	if ((error = git_packfile_alloc(&pack, path)) < 0) {
		git_mutex_unlock(&git__mwindow_mutex);
		return error;
	}

	git_atomic_inc(&pack->refcount);

	git_strmap_insert(git__pack_cache, pack->pack_name, pack, error);
	git_mutex_unlock(&git__mwindow_mutex);

101 102
	if (error < 0) {
		git_packfile_free(pack);
103
		return -1;
104
	}
105

106 107 108 109
	*out = pack;
	return 0;
}

110
void git_mwindow_put_pack(struct git_pack_file *pack)
111 112 113 114 115
{
	int count;
	git_strmap_iter pos;

	if (git_mutex_lock(&git__mwindow_mutex) < 0)
116
		return;
117

118 119
	/* put before get would be a corrupted state */
	assert(git__pack_cache);
120 121

	pos = git_strmap_lookup_index(git__pack_cache, pack->pack_name);
122 123
	/* if we cannot find it, the state is corrupted */
	assert(git_strmap_valid_index(git__pack_cache, pos));
124 125 126 127 128 129 130 131

	count = git_atomic_dec(&pack->refcount);
	if (count == 0) {
		git_strmap_delete_at(git__pack_cache, pos);
		git_packfile_free(pack);
	}

	git_mutex_unlock(&git__mwindow_mutex);
132
	return;
133 134 135 136
}

void git_mwindow_free_all(git_mwindow_file *mwf)
{
137 138 139 140
	if (git_mutex_lock(&git__mwindow_mutex)) {
		giterr_set(GITERR_THREAD, "unable to lock mwindow mutex");
		return;
	}
141

142 143 144 145 146 147 148 149 150 151 152 153 154 155
	git_mwindow_free_all_locked(mwf);

	git_mutex_unlock(&git__mwindow_mutex);
}

/*
 * Free all the windows in a sequence, typically because we're done
 * with the file
 */
void git_mwindow_free_all_locked(git_mwindow_file *mwf)
{
	git_mwindow_ctl *ctl = &mem_ctl;
	size_t i;

156 157 158
	/*
	 * Remove these windows from the global list
	 */
159 160 161
	for (i = 0; i < ctl->windowfiles.length; ++i){
		if (git_vector_get(&ctl->windowfiles, i) == mwf) {
			git_vector_remove(&ctl->windowfiles, i);
162 163 164 165
			break;
		}
	}

166 167 168
	if (ctl->windowfiles.length == 0) {
		git_vector_free(&ctl->windowfiles);
		ctl->windowfiles.contents = NULL;
169 170 171 172 173 174
	}

	while (mwf->windows) {
		git_mwindow *w = mwf->windows;
		assert(w->inuse_cnt == 0);

175 176
		ctl->mapped -= w->window_map.len;
		ctl->open_windows--;
177 178 179 180

		git_futils_mmap_free(&w->window_map);

		mwf->windows = w->next;
181
		git__free(w);
182 183 184 185 186 187
	}
}

/*
 * Check if a window 'win' contains the address 'offset'
 */
188
int git_mwindow_contains(git_mwindow *win, git_off_t offset)
189
{
190
	git_off_t win_off = win->offset;
191
	return win_off <= offset
192
		&& offset <= (git_off_t)(win_off + win->window_map.len);
193 194 195 196 197
}

/*
 * Find the least-recently-used window in a file
 */
198
static void git_mwindow_scan_lru(
199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222
	git_mwindow_file *mwf,
	git_mwindow **lru_w,
	git_mwindow **lru_l)
{
	git_mwindow *w, *w_l;

	for (w_l = NULL, w = mwf->windows; w; w = w->next) {
		if (!w->inuse_cnt) {
			/*
			 * If the current one is more recent than the last one,
			 * store it in the output parameter. If lru_w is NULL,
			 * it's the first loop, so store it as well.
			 */
			if (!*lru_w || w->last_used < (*lru_w)->last_used) {
				*lru_w = w;
				*lru_l = w_l;
			}
		}
		w_l = w;
	}
}

/*
 * Close the least recently used window. You should check to see if
223 224
 * the file descriptors need closing from time to time. Called under
 * lock from new_window.
225
 */
226
static int git_mwindow_close_lru(git_mwindow_file *mwf)
227
{
228
	git_mwindow_ctl *ctl = &mem_ctl;
229
	size_t i;
230
	git_mwindow *lru_w = NULL, *lru_l = NULL, **list = &mwf->windows;
231

232
	/* FIXME: Does this give us any advantage? */
233 234 235
	if(mwf->windows)
		git_mwindow_scan_lru(mwf, &lru_w, &lru_l);

236
	for (i = 0; i < ctl->windowfiles.length; ++i) {
237
		git_mwindow *last = lru_w;
238
		git_mwindow_file *cur = git_vector_get(&ctl->windowfiles, i);
239 240 241
		git_mwindow_scan_lru(cur, &lru_w, &lru_l);
		if (lru_w != last)
			list = &cur->windows;
242 243
	}

244 245 246 247
	if (!lru_w) {
		giterr_set(GITERR_OS, "Failed to close memory window. Couldn't find LRU");
		return -1;
	}
248

249 250
	ctl->mapped -= lru_w->window_map.len;
	git_futils_mmap_free(&lru_w->window_map);
251

252 253 254 255
	if (lru_l)
		lru_l->next = lru_w->next;
	else
		*list = lru_w->next;
256

257 258
	git__free(lru_w);
	ctl->open_windows--;
259

260
	return 0;
261 262
}

263
/* This gets called under lock from git_mwindow_open */
264 265 266 267 268
static git_mwindow *new_window(
	git_mwindow_file *mwf,
	git_file fd,
	git_off_t size,
	git_off_t offset)
269
{
270
	git_mwindow_ctl *ctl = &mem_ctl;
Vicent Marti committed
271
	size_t walign = git_mwindow__window_size / 2;
272
	git_off_t len;
273 274 275
	git_mwindow *w;

	w = git__malloc(sizeof(*w));
Russell Belfer committed
276

277
	if (w == NULL)
278
		return NULL;
279 280 281 282 283

	memset(w, 0x0, sizeof(*w));
	w->offset = (offset / walign) * walign;

	len = size - w->offset;
Vicent Marti committed
284 285
	if (len > (git_off_t)git_mwindow__window_size)
		len = (git_off_t)git_mwindow__window_size;
286

287
	ctl->mapped += (size_t)len;
288

Vicent Marti committed
289
	while (git_mwindow__mapped_limit < ctl->mapped &&
290
			git_mwindow_close_lru(mwf) == 0) /* nop */;
291

292
	/*
Vicent Marti committed
293
	 * We treat `mapped_limit` as a soft limit. If we can't find a
294 295 296
	 * window to close and are above the limit, we still mmap the new
	 * window.
	 */
297

298 299 300 301
	if (git_futils_mmap_ro(&w->window_map, fd, w->offset, (size_t)len) < 0) {
		git__free(w);
		return NULL;
	}
302

303 304
	ctl->mmap_calls++;
	ctl->open_windows++;
305

306 307
	if (ctl->mapped > ctl->peak_mapped)
		ctl->peak_mapped = ctl->mapped;
308

309 310
	if (ctl->open_windows > ctl->peak_open_windows)
		ctl->peak_open_windows = ctl->open_windows;
311 312 313 314 315 316 317 318

	return w;
}

/*
 * Open a new window, closing the least recenty used until we have
 * enough space. Don't forget to add it to your list
 */
319 320 321 322
unsigned char *git_mwindow_open(
	git_mwindow_file *mwf,
	git_mwindow **cursor,
	git_off_t offset,
323
	size_t extra,
324
	unsigned int *left)
325
{
326
	git_mwindow_ctl *ctl = &mem_ctl;
327 328
	git_mwindow *w = *cursor;

329 330 331 332 333
	if (git_mutex_lock(&git__mwindow_mutex)) {
		giterr_set(GITERR_THREAD, "unable to lock mwindow mutex");
		return NULL;
	}

334
	if (!w || !(git_mwindow_contains(w, offset) && git_mwindow_contains(w, offset + extra))) {
335 336 337 338 339
		if (w) {
			w->inuse_cnt--;
		}

		for (w = mwf->windows; w; w = w->next) {
340
			if (git_mwindow_contains(w, offset) &&
Vicent Martí committed
341
				git_mwindow_contains(w, offset + extra))
342 343 344 345 346 347 348 349
				break;
		}

		/*
		 * If there isn't a suitable window, we need to create a new
		 * one.
		 */
		if (!w) {
350
			w = new_window(mwf, mwf->fd, mwf->size, offset);
351 352
			if (w == NULL) {
				git_mutex_unlock(&git__mwindow_mutex);
353
				return NULL;
354
			}
355 356 357 358 359 360 361
			w->next = mwf->windows;
			mwf->windows = w;
		}
	}

	/* If we changed w, store it in the cursor */
	if (w != *cursor) {
362
		w->last_used = ctl->used_ctr++;
363 364 365 366 367 368 369
		w->inuse_cnt++;
		*cursor = w;
	}

	offset -= w->offset;

	if (left)
370
		*left = (unsigned int)(w->window_map.len - offset);
371

372
	git_mutex_unlock(&git__mwindow_mutex);
373 374 375 376 377
	return (unsigned char *) w->window_map.data + offset;
}

int git_mwindow_file_register(git_mwindow_file *mwf)
{
378 379
	git_mwindow_ctl *ctl = &mem_ctl;
	int ret;
380

381 382 383 384 385
	if (git_mutex_lock(&git__mwindow_mutex)) {
		giterr_set(GITERR_THREAD, "unable to lock mwindow mutex");
		return -1;
	}

386
	if (ctl->windowfiles.length == 0 &&
387 388
	    git_vector_init(&ctl->windowfiles, 8, NULL) < 0) {
		git_mutex_unlock(&git__mwindow_mutex);
389
		return -1;
390 391 392 393
	}

	ret = git_vector_insert(&ctl->windowfiles, mwf);
	git_mutex_unlock(&git__mwindow_mutex);
394

395
	return ret;
396 397
}

398
void git_mwindow_file_deregister(git_mwindow_file *mwf)
399
{
400
	git_mwindow_ctl *ctl = &mem_ctl;
401
	git_mwindow_file *cur;
402
	size_t i;
403

404 405
	if (git_mutex_lock(&git__mwindow_mutex))
		return;
406

407 408 409
	git_vector_foreach(&ctl->windowfiles, i, cur) {
		if (cur == mwf) {
			git_vector_remove(&ctl->windowfiles, i);
410
			git_mutex_unlock(&git__mwindow_mutex);
411
			return;
412 413
		}
	}
414
	git_mutex_unlock(&git__mwindow_mutex);
415 416
}

417 418 419 420
void git_mwindow_close(git_mwindow **window)
{
	git_mwindow *w = *window;
	if (w) {
421 422 423 424 425
		if (git_mutex_lock(&git__mwindow_mutex)) {
			giterr_set(GITERR_THREAD, "unable to lock mwindow mutex");
			return;
		}

426
		w->inuse_cnt--;
427
		git_mutex_unlock(&git__mwindow_mutex);
428 429 430
		*window = NULL;
	}
}