odb.h 3.43 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 16

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

21 22
#define GIT_OBJECTS_DIR "objects/"
#define GIT_OBJECT_DIR_MODE 0777
23
#define GIT_OBJECT_FILE_MODE 0444
24

25 26
extern bool git_odb__strict_hash_verification;

Vicent Marti committed
27 28
/* DO NOT EXPORT */
typedef struct {
Vicent Marti committed
29 30 31
	void *data;			/**< Raw, decompressed object data. */
	size_t len;			/**< Total number of bytes in data. */
	git_otype type;		/**< Type of this object. */
Vicent Marti committed
32 33 34 35 36
} git_rawobj;

/* EXPORT */
struct git_odb_object {
	git_cached_obj cached;
Vicent Marti committed
37
	void *buffer;
Vicent Marti committed
38 39 40
};

/* EXPORT */
41
struct git_odb {
42
	git_refcount rc;
43
	git_vector backends;
44
	git_cache own_cache;
45
	unsigned int do_fsync :1;
46 47
};

48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63
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);

64 65 66 67
/*
 * Hash a git_rawobj internally.
 * The `git_rawobj` is supposed to be previously initialized
 */
68
int git_odb__hashobj(git_oid *id, git_rawobj *obj);
69 70

/*
71 72
 * Format the object header such as it would appear in the on-disk object
 */
73
int git_odb__format_object_header(size_t *out_len, char *hdr, size_t hdr_size, git_off_t obj_len, git_otype obj_type);
74
/*
75 76 77 78 79 80 81 82 83
 * 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
 */
84
int git_odb__hashfd(git_oid *out, git_file fd, size_t size, git_otype type);
85

86
/*
87 88 89 90
 * 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(
91
	git_oid *out, git_file fd, size_t len, git_otype type, git_filter_list *fl);
92 93 94 95 96

/*
 * 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`.
97
 *
98 99
 * The hash type for this call is always `GIT_OBJ_BLOB` because symlinks may
 * only point to blobs.
100 101 102
 */
int git_odb__hashlink(git_oid *out, const char *path);

103 104 105 106 107 108
/**
 * Generate a GIT_EMISMATCH error for the ODB.
 */
int git_odb__error_mismatch(
	const git_oid *expected, const git_oid *actual);

109 110 111
/*
 * Generate a GIT_ENOTFOUND error for the ODB.
 */
112 113
int git_odb__error_notfound(
	const char *message, const git_oid *oid, size_t oid_len);
114 115 116 117 118 119

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

120 121 122 123 124 125 126 127
/*
 * Attempt to read object header or just return whole object if it could
 * not be read.
 */
int git_odb__read_header_or_object(
	git_odb_object **out, size_t *len_p, git_otype *type_p,
	git_odb *db, const git_oid *id);

128 129 130
/* freshen an entry in the object database */
int git_odb__freshen(git_odb *db, const git_oid *id);

131 132 133
/* fully free the object; internal method, DO NOT EXPORT */
void git_odb_object__free(void *object);

134
#endif