odb.h 3.92 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_odb_h__
#define INCLUDE_odb_h__

10 11
#include "common.h"

12 13
#include "git2/odb.h"
#include "git2/oid.h"
Vicent Marti committed
14
#include "git2/types.h"
15
#include "git2/sys/commit_graph.h"
16

Vicent Marti committed
17
#include "cache.h"
18
#include "commit_graph.h"
19
#include "filter.h"
20 21
#include "posix.h"
#include "vector.h"
22

23 24
#define GIT_OBJECTS_DIR "objects/"
#define GIT_OBJECT_DIR_MODE 0777
25
#define GIT_OBJECT_FILE_MODE 0444
26

27 28 29
#define GIT_ODB_DEFAULT_LOOSE_PRIORITY 1
#define GIT_ODB_DEFAULT_PACKED_PRIORITY 2

30 31
extern bool git_odb__strict_hash_verification;

Vicent Marti committed
32 33
/* DO NOT EXPORT */
typedef struct {
Vicent Marti committed
34 35
	void *data;			/**< Raw, decompressed object data. */
	size_t len;			/**< Total number of bytes in data. */
36
	git_object_t type;		/**< Type of this object. */
Vicent Marti committed
37 38 39 40 41
} git_rawobj;

/* EXPORT */
struct git_odb_object {
	git_cached_obj cached;
Vicent Marti committed
42
	void *buffer;
Vicent Marti committed
43 44 45
};

/* EXPORT */
46
struct git_odb {
47
	git_refcount rc;
lhchavez committed
48
	git_mutex lock;  /* protects backends */
49
	git_vector backends;
50
	git_cache own_cache;
51
	git_commit_graph *cgraph;
52
	unsigned int do_fsync :1;
53 54
};

55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70
typedef enum {
	GIT_ODB_CAP_FROM_OWNER = -1,
} git_odb_cap_t;

/*
 * Set the capabilities for the object database.
 */
int git_odb__set_caps(git_odb *odb, int caps);

/*
 * Add the default loose and packed backends for a database.
 */
int git_odb__add_default_backends(
	git_odb *db, const char *objects_dir,
	bool as_alternates, int alternate_depth);

71 72 73 74
/*
 * Hash a git_rawobj internally.
 * The `git_rawobj` is supposed to be previously initialized
 */
75
int git_odb__hashobj(git_oid *id, git_rawobj *obj);
76 77

/*
78 79
 * Format the object header such as it would appear in the on-disk object
 */
80
int git_odb__format_object_header(size_t *out_len, char *hdr, size_t hdr_size, git_object_size_t obj_len, git_object_t obj_type);
Etienne Samson committed
81

82
/*
83 84 85 86 87 88 89 90 91
 * Hash an open file descriptor.
 * This is a performance call when the contents of a fd need to be hashed,
 * but the fd is already open and we have the size of the contents.
 *
 * Saves us some `stat` calls.
 *
 * The fd is never closed, not even on error. It must be opened and closed
 * by the caller
 */
92
int git_odb__hashfd(git_oid *out, git_file fd, size_t size, git_object_t type);
93

94
/*
95 96 97 98
 * Hash an open file descriptor applying an array of filters
 * Acts just like git_odb__hashfd with the addition of filters...
 */
int git_odb__hashfd_filtered(
99
	git_oid *out, git_file fd, size_t len, git_object_t type, git_filter_list *fl);
100 101 102 103 104

/*
 * Hash a `path`, assuming it could be a POSIX symlink: if the path is a
 * symlink, then the raw contents of the symlink will be hashed. Otherwise,
 * this will fallback to `git_odb__hashfd`.
105
 *
Etienne Samson committed
106
 * The hash type for this call is always `GIT_OBJECT_BLOB` because
107
 * symlinks may only point to blobs.
108 109 110
 */
int git_odb__hashlink(git_oid *out, const char *path);

111 112 113 114 115 116
/**
 * Generate a GIT_EMISMATCH error for the ODB.
 */
int git_odb__error_mismatch(
	const git_oid *expected, const git_oid *actual);

117 118 119
/*
 * Generate a GIT_ENOTFOUND error for the ODB.
 */
120 121
int git_odb__error_notfound(
	const char *message, const git_oid *oid, size_t oid_len);
122 123 124 125 126 127

/*
 * Generate a GIT_EAMBIGUOUS error for the ODB.
 */
int git_odb__error_ambiguous(const char *message);

128 129 130 131 132
/*
 * Attempt to read object header or just return whole object if it could
 * not be read.
 */
int git_odb__read_header_or_object(
133
	git_odb_object **out, size_t *len_p, git_object_t *type_p,
134 135
	git_odb *db, const git_oid *id);

136
/*
137 138 139
 * Attempt to get the ODB's commit-graph file. This object is still owned by
 * the ODB. If the repository does not contain a commit-graph, it will return
 * GIT_ENOTFOUND.
140
 */
141
int git_odb__get_commit_graph_file(git_commit_graph_file **out, git_odb *odb);
142

143 144 145
/* freshen an entry in the object database */
int git_odb__freshen(git_odb *db, const git_oid *id);

146 147 148
/* fully free the object; internal method, DO NOT EXPORT */
void git_odb_object__free(void *object);

149
#endif