filebuf.h 2.89 KB
Newer Older
Vicent Marti committed
1
/*
Edward Thomson committed
2
 * Copyright (C) the libgit2 contributors. All rights reserved.
Vicent Marti committed
3 4 5 6
 *
 * This file is part of libgit2, distributed under the GNU GPL v2 with
 * a Linking Exception. For full terms see the included COPYING file.
 */
7 8 9
#ifndef INCLUDE_filebuf_h__
#define INCLUDE_filebuf_h__

10 11
#include "common.h"

12
#include "futils.h"
13
#include "hash.h"
14
#include <zlib.h>
15 16 17 18 19

#ifdef GIT_THREADS
#	define GIT_FILEBUF_THREADS
#endif

Vicent Marti committed
20 21
#define GIT_FILEBUF_HASH_CONTENTS		(1 << 0)
#define GIT_FILEBUF_APPEND				(1 << 2)
22
#define GIT_FILEBUF_CREATE_LEADING_DIRS	(1 << 3)
Vicent Marti committed
23
#define GIT_FILEBUF_TEMPORARY			(1 << 4)
24
#define GIT_FILEBUF_DO_NOT_BUFFER		(1 << 5)
25 26
#define GIT_FILEBUF_FSYNC				(1 << 6)
#define GIT_FILEBUF_DEFLATE_SHIFT		(7)
27

28 29 30
#define GIT_FILELOCK_EXTENSION ".lock\0"
#define GIT_FILELOCK_EXTLENGTH 6

31
typedef struct git_filebuf git_filebuf;
32 33 34 35
struct git_filebuf {
	char *path_original;
	char *path_lock;

36
	int (*write)(git_filebuf *file, void *source, size_t len);
Vicent Marti committed
37

38 39
	bool compute_digest;
	git_hash_ctx digest;
40 41

	unsigned char *buffer;
Vicent Marti committed
42 43 44 45
	unsigned char *z_buf;

	z_stream zs;
	int flush_mode;
46 47 48

	size_t buf_size, buf_pos;
	git_file fd;
49
	bool fd_is_open;
50 51
	bool created_lock;
	bool did_rename;
52
	bool do_not_buffer;
53
	bool do_fsync;
54
	int last_error;
55 56
};

57 58
#define GIT_FILEBUF_INIT {0}

59 60
/*
 * The git_filebuf object lifecycle is:
61
 * - Allocate git_filebuf, preferably using GIT_FILEBUF_INIT.
62
 *
63
 * - Call git_filebuf_open() to initialize the filebuf for use.
64
 *
65
 * - Make as many calls to git_filebuf_write(), git_filebuf_printf(),
66 67 68 69
 *   git_filebuf_reserve() as you like. The error codes for these
 *   functions don't need to be checked. They are stored internally
 *   by the file buffer.
 *
70
 * - While you are writing, you may call git_filebuf_hash() to get
71 72 73
 *   the hash of all you have written so far. This function will
 *   fail if any of the previous writes to the buffer failed.
 *
74 75 76
 * - To close the git_filebuf, you may call git_filebuf_commit() or
 *   git_filebuf_commit_at() to save the file, or
 *   git_filebuf_cleanup() to abandon the file.  All of these will
77 78 79
 *   free the git_filebuf object. Likewise, all of these will fail
 *   if any of the previous writes to the buffer failed, and set
 *   an error code accordingly.
80
 */
Vicent Marti committed
81
int git_filebuf_write(git_filebuf *lock, const void *buff, size_t len);
82
int git_filebuf_reserve(git_filebuf *file, void **buff, size_t len);
83
int git_filebuf_printf(git_filebuf *file, const char *format, ...) GIT_FORMAT_PRINTF(2, 3);
84

85
int git_filebuf_open(git_filebuf *lock, const char *path, int flags, mode_t mode);
86
int git_filebuf_open_withsize(git_filebuf *file, const char *path, int flags, mode_t mode, size_t size);
87 88
int git_filebuf_commit(git_filebuf *lock);
int git_filebuf_commit_at(git_filebuf *lock, const char *path);
89 90
void git_filebuf_cleanup(git_filebuf *lock);
int git_filebuf_hash(git_oid *oid, git_filebuf *file);
91
int git_filebuf_flush(git_filebuf *file);
92
int git_filebuf_stats(time_t *mtime, size_t *size, git_filebuf *file);
93 94

#endif