filebuf.c 10.4 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 "filebuf.h"
#include "fileops.h"

static const size_t WRITE_BUFFER_SIZE = (4096 * 2);

13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42
enum buferr_t {
	BUFERR_OK = 0,
	BUFERR_WRITE,
	BUFERR_ZLIB,
	BUFERR_MEM
};

#define ENSURE_BUF_OK(buf) if ((buf)->last_error != BUFERR_OK) { return -1; }

static int verify_last_error(git_filebuf *file)
{
	switch (file->last_error) {
	case BUFERR_WRITE:
		giterr_set(GITERR_OS, "Failed to write out file");
		return -1;

	case BUFERR_MEM:
		giterr_set_oom();
		return -1;

	case BUFERR_ZLIB:
		giterr_set(GITERR_ZLIB,
			"Buffer error when writing out ZLib data");
		return -1;

	default:
		return 0;
	}
}

43
static int lock_file(git_filebuf *file, int flags, mode_t mode)
44
{
45
	if (git_path_exists(file->path_lock) == true) {
46
		if (flags & GIT_FILEBUF_FORCE)
Vicent Marti committed
47
			p_unlink(file->path_lock);
48
		else {
49
			giterr_clear(); /* actual OS error code just confuses */
50 51
			giterr_set(GITERR_OS,
				"Failed to lock file '%s' for writing", file->path_lock);
52
			return GIT_ELOCKED;
53
		}
54 55
	}

56 57
	/* create path to the file buffer is required */
	if (flags & GIT_FILEBUF_FORCE) {
58
		/* XXX: Should dirmode here be configurable? Or is 0777 always fine? */
59
		file->fd = git_futils_creat_locked_withpath(file->path_lock, 0777, mode);
60
	} else {
61
		file->fd = git_futils_creat_locked(file->path_lock, mode);
62
	}
63 64

	if (file->fd < 0)
65
		return file->fd;
66

67 68
	file->fd_is_open = true;

69
	if ((flags & GIT_FILEBUF_APPEND) && git_path_exists(file->path_original) == true) {
70
		git_file source;
71
		char buffer[FILEIO_BUFSIZE];
Vicent Marti committed
72
		ssize_t read_bytes;
73

Vicent Marti committed
74
		source = p_open(file->path_original, O_RDONLY);
75 76
		if (source < 0) {
			giterr_set(GITERR_OS,
77 78
				"Failed to open file '%s' for reading",
				file->path_original);
79 80
			return -1;
		}
81

Vicent Marti committed
82
		while ((read_bytes = p_read(source, buffer, sizeof(buffer))) > 0) {
Vicent Marti committed
83
			p_write(file->fd, buffer, read_bytes);
84 85
			if (file->compute_digest)
				git_hash_update(&file->digest, buffer, read_bytes);
86 87
		}

Vicent Marti committed
88
		p_close(source);
Vicent Marti committed
89 90 91 92 93

		if (read_bytes < 0) {
			giterr_set(GITERR_OS, "Failed to read file '%s'", file->path_original);
			return -1;
		}
94 95
	}

96
	return 0;
97 98 99 100
}

void git_filebuf_cleanup(git_filebuf *file)
{
101
	if (file->fd_is_open && file->fd >= 0)
Vicent Marti committed
102
		p_close(file->fd);
103

104
	if (file->created_lock && !file->did_rename && file->path_lock && git_path_exists(file->path_lock))
Vicent Marti committed
105
		p_unlink(file->path_lock);
106

107 108 109
	if (file->compute_digest) {
		git_hash_ctx_cleanup(&file->digest);
		file->compute_digest = 0;
110
	}
111

112 113
	if (file->buffer)
		git__free(file->buffer);
114

115 116 117 118 119 120 121 122 123 124
	/* use the presence of z_buf to decide if we need to deflateEnd */
	if (file->z_buf) {
		git__free(file->z_buf);
		deflateEnd(&file->zs);
	}

	if (file->path_original)
		git__free(file->path_original);
	if (file->path_lock)
		git__free(file->path_lock);
125

126 127
	memset(file, 0x0, sizeof(git_filebuf));
	file->fd = -1;
128 129
}

Vicent Marti committed
130
GIT_INLINE(int) flush_buffer(git_filebuf *file)
131
{
Vicent Marti committed
132 133 134 135
	int result = file->write(file, file->buffer, file->buf_pos);
	file->buf_pos = 0;
	return result;
}
136

137 138 139 140 141
int git_filebuf_flush(git_filebuf *file)
{
	return flush_buffer(file);
}

142
static int write_normal(git_filebuf *file, void *source, size_t len)
Vicent Marti committed
143 144
{
	if (len > 0) {
145 146 147 148 149
		if (p_write(file->fd, (void *)source, len) < 0) {
			file->last_error = BUFERR_WRITE;
			return -1;
		}

150 151
		if (file->compute_digest)
			git_hash_update(&file->digest, source, len);
152 153
	}

154
	return 0;
155 156
}

157
static int write_deflate(git_filebuf *file, void *source, size_t len)
Vicent Marti committed
158 159 160 161
{
	z_stream *zs = &file->zs;

	if (len > 0 || file->flush_mode == Z_FINISH) {
162
		zs->next_in = source;
163
		zs->avail_in = (uInt)len;
Vicent Marti committed
164 165

		do {
166
			size_t have;
Vicent Marti committed
167 168

			zs->next_out = file->z_buf;
169
			zs->avail_out = (uInt)file->buf_size;
Vicent Marti committed
170

171 172 173 174
			if (deflate(zs, file->flush_mode) == Z_STREAM_ERROR) {
				file->last_error = BUFERR_ZLIB;
				return -1;
			}
Vicent Marti committed
175

176
			have = file->buf_size - (size_t)zs->avail_out;
Vicent Marti committed
177

178 179 180 181
			if (p_write(file->fd, file->z_buf, have) < 0) {
				file->last_error = BUFERR_WRITE;
				return -1;
			}
Vicent Marti committed
182

183
		} while (zs->avail_out == 0);
Vicent Marti committed
184 185 186

		assert(zs->avail_in == 0);

187 188
		if (file->compute_digest)
			git_hash_update(&file->digest, source, len);
Vicent Marti committed
189 190
	}

191
	return 0;
Vicent Marti committed
192 193
}

194
int git_filebuf_open(git_filebuf *file, const char *path, int flags, mode_t mode)
195
{
196
	int compression, error = -1;
197
	size_t path_len, alloc_len;
198

199 200 201 202
	/* opening an already open buffer is a programming error;
	 * assert that this never happens instead of returning
	 * an error code */
	assert(file && path && file->buffer == NULL);
203

204 205
	memset(file, 0x0, sizeof(git_filebuf));

206 207 208
	if (flags & GIT_FILEBUF_DO_NOT_BUFFER)
		file->do_not_buffer = true;

209 210 211
	file->buf_size = WRITE_BUFFER_SIZE;
	file->buf_pos = 0;
	file->fd = -1;
212
	file->last_error = BUFERR_OK;
213

Vicent Marti committed
214
	/* Allocate the main cache buffer */
215 216 217 218
	if (!file->do_not_buffer) {
		file->buffer = git__malloc(file->buf_size);
		GITERR_CHECK_ALLOC(file->buffer);
	}
219

Vicent Marti committed
220 221
	/* If we are hashing on-write, allocate a new hash context */
	if (flags & GIT_FILEBUF_HASH_CONTENTS) {
222
		file->compute_digest = 1;
223

224
		if (git_hash_ctx_init(&file->digest) < 0)
225
			goto cleanup;
226 227
	}

228
	compression = flags >> GIT_FILEBUF_DEFLATE_SHIFT;
229

230 231
	/* If we are deflating on-write, */
	if (compression != 0) {
Vicent Marti committed
232
		/* Initialize the ZLib stream */
233
		if (deflateInit(&file->zs, compression) != Z_OK) {
234
			giterr_set(GITERR_ZLIB, "Failed to initialize zlib");
Vicent Marti committed
235 236
			goto cleanup;
		}
237

Vicent Marti committed
238 239
		/* Allocate the Zlib cache buffer */
		file->z_buf = git__malloc(file->buf_size);
240
		GITERR_CHECK_ALLOC(file->z_buf);
Vicent Marti committed
241 242 243 244 245 246

		/* Never flush */
		file->flush_mode = Z_NO_FLUSH;
		file->write = &write_deflate;
	} else {
		file->write = &write_normal;
247 248
	}

Vicent Marti committed
249 250
	/* If we are writing to a temp file */
	if (flags & GIT_FILEBUF_TEMPORARY) {
251
		git_buf tmp_path = GIT_BUF_INIT;
Vicent Marti committed
252 253

		/* Open the file as temporary for locking */
254
		file->fd = git_futils_mktmp(&tmp_path, path, mode);
255

Vicent Marti committed
256
		if (file->fd < 0) {
257
			git_buf_free(&tmp_path);
Vicent Marti committed
258 259
			goto cleanup;
		}
260
		file->fd_is_open = true;
261
		file->created_lock = true;
Vicent Marti committed
262 263 264

		/* No original path */
		file->path_original = NULL;
265
		file->path_lock = git_buf_detach(&tmp_path);
266
		GITERR_CHECK_ALLOC(file->path_lock);
Vicent Marti committed
267 268 269 270 271
	} else {
		path_len = strlen(path);

		/* Save the original path of the file */
		file->path_original = git__strdup(path);
272
		GITERR_CHECK_ALLOC(file->path_original);
Vicent Marti committed
273 274

		/* create the locking path by appending ".lock" to the original */
275 276
		GITERR_CHECK_ALLOC_ADD(&alloc_len, path_len, GIT_FILELOCK_EXTLENGTH);
		file->path_lock = git__malloc(alloc_len);
277
		GITERR_CHECK_ALLOC(file->path_lock);
Vicent Marti committed
278 279 280 281 282

		memcpy(file->path_lock, file->path_original, path_len);
		memcpy(file->path_lock + path_len, GIT_FILELOCK_EXTENSION, GIT_FILELOCK_EXTLENGTH);

		/* open the file for locking */
283
		if ((error = lock_file(file, flags, mode)) < 0)
Vicent Marti committed
284
			goto cleanup;
285 286

		file->created_lock = true;
Vicent Marti committed
287
	}
288

289
	return 0;
290 291 292

cleanup:
	git_filebuf_cleanup(file);
293
	return error;
294 295 296 297
}

int git_filebuf_hash(git_oid *oid, git_filebuf *file)
{
298
	assert(oid && file && file->compute_digest);
299

300 301 302 303
	flush_buffer(file);

	if (verify_last_error(file) < 0)
		return -1;
304

305 306 307
	git_hash_final(oid, &file->digest);
	git_hash_ctx_cleanup(&file->digest);
	file->compute_digest = 0;
308

309
	return 0;
310 311
}

312
int git_filebuf_commit_at(git_filebuf *file, const char *path)
Vicent Marti committed
313
{
314
	git__free(file->path_original);
Vicent Marti committed
315
	file->path_original = git__strdup(path);
316
	GITERR_CHECK_ALLOC(file->path_original);
Vicent Marti committed
317

318
	return git_filebuf_commit(file);
Vicent Marti committed
319 320
}

321
int git_filebuf_commit(git_filebuf *file)
322
{
Vicent Marti committed
323 324
	/* temporary files cannot be committed */
	assert(file && file->path_original);
Vicent Marti committed
325 326

	file->flush_mode = Z_FINISH;
327 328 329 330
	flush_buffer(file);

	if (verify_last_error(file) < 0)
		goto on_error;
331

332
	file->fd_is_open = false;
333

334 335 336 337 338 339 340
	if (p_close(file->fd) < 0) {
		giterr_set(GITERR_OS, "Failed to close file at '%s'", file->path_lock);
		goto on_error;
	}

	file->fd = -1;

341 342 343 344
	if (p_rename(file->path_lock, file->path_original) < 0) {
		giterr_set(GITERR_OS, "Failed to rename lockfile to '%s'", file->path_original);
		goto on_error;
	}
345

346 347
	file->did_rename = true;

348
	git_filebuf_cleanup(file);
349 350 351 352 353
	return 0;

on_error:
	git_filebuf_cleanup(file);
	return -1;
354 355
}

Vicent Marti committed
356
GIT_INLINE(void) add_to_cache(git_filebuf *file, const void *buf, size_t len)
357 358 359 360 361
{
	memcpy(file->buffer + file->buf_pos, buf, len);
	file->buf_pos += len;
}

Vicent Marti committed
362
int git_filebuf_write(git_filebuf *file, const void *buff, size_t len)
363
{
Vicent Marti committed
364
	const unsigned char *buf = buff;
365

366 367
	ENSURE_BUF_OK(file);

368 369 370
	if (file->do_not_buffer)
		return file->write(file, (void *)buff, len);

371 372 373 374 375 376
	for (;;) {
		size_t space_left = file->buf_size - file->buf_pos;

		/* cache if it's small */
		if (space_left > len) {
			add_to_cache(file, buf, len);
377
			return 0;
378 379
		}

380
		add_to_cache(file, buf, space_left);
381 382
		if (flush_buffer(file) < 0)
			return -1;
383

384 385
		len -= space_left;
		buf += space_left;
386 387 388 389 390 391 392 393 394
	}
}

int git_filebuf_reserve(git_filebuf *file, void **buffer, size_t len)
{
	size_t space_left = file->buf_size - file->buf_pos;

	*buffer = NULL;

395 396 397 398 399 400
	ENSURE_BUF_OK(file);

	if (len > file->buf_size) {
		file->last_error = BUFERR_MEM;
		return -1;
	}
401 402

	if (space_left <= len) {
403 404
		if (flush_buffer(file) < 0)
			return -1;
405 406 407 408 409
	}

	*buffer = (file->buffer + file->buf_pos);
	file->buf_pos += len;

410
	return 0;
411 412
}

413 414 415
int git_filebuf_printf(git_filebuf *file, const char *format, ...)
{
	va_list arglist;
416
	size_t space_left, len, alloclen;
417
	int written, res;
418
	char *tmp_buffer;
419

420 421
	ENSURE_BUF_OK(file);

422 423 424 425
	space_left = file->buf_size - file->buf_pos;

	do {
		va_start(arglist, format);
426
		written = p_vsnprintf((char *)file->buffer + file->buf_pos, space_left, format, arglist);
427 428
		va_end(arglist);

429
		if (written < 0) {
430 431 432
			file->last_error = BUFERR_MEM;
			return -1;
		}
433

434 435
		len = written;
		if (len + 1 <= space_left) {
436
			file->buf_pos += len;
437
			return 0;
438
		}
439

440 441
		if (flush_buffer(file) < 0)
			return -1;
442

443 444
		space_left = file->buf_size - file->buf_pos;

445
	} while (len + 1 <= space_left);
446

447 448
	if (GIT_ADD_SIZET_OVERFLOW(&alloclen, len, 1) ||
		!(tmp_buffer = git__malloc(alloclen))) {
449 450 451
		file->last_error = BUFERR_MEM;
		return -1;
	}
452 453

	va_start(arglist, format);
454
	written = p_vsnprintf(tmp_buffer, len + 1, format, arglist);
455 456
	va_end(arglist);

457
	if (written < 0) {
458
		git__free(tmp_buffer);
459 460
		file->last_error = BUFERR_MEM;
		return -1;
461 462
	}

463
	res = git_filebuf_write(file, tmp_buffer, len);
464
	git__free(tmp_buffer);
465

466
	return res;
467 468
}

469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491
int git_filebuf_stats(time_t *mtime, size_t *size, git_filebuf *file)
{
	int res;
	struct stat st;

	if (file->fd_is_open)
		res = p_fstat(file->fd, &st);
	else
		res = p_stat(file->path_original, &st);

	if (res < 0) {
		giterr_set(GITERR_OS, "Could not get stat info for '%s'",
			file->path_original);
		return res;
	}

	if (mtime)
		*mtime = st.st_mtime;
	if (size)
		*size = (size_t)st.st_size;

	return 0;
}