odb.h 1.96 KB
Newer Older
Vicent Marti committed
1
/*
schu committed
2
 * Copyright (C) 2009-2012 the libgit2 contributors
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 "git2/odb.h"
#include "git2/oid.h"
Vicent Marti committed
12
#include "git2/types.h"
13 14

#include "vector.h"
Vicent Marti committed
15
#include "cache.h"
16
#include "posix.h"
17

18 19
#define GIT_OBJECTS_DIR "objects/"
#define GIT_OBJECT_DIR_MODE 0777
20
#define GIT_OBJECT_FILE_MODE 0444
21

Vicent Marti committed
22 23
/* DO NOT EXPORT */
typedef struct {
Vicent Marti committed
24 25 26
	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
27 28 29 30 31 32 33 34 35
} git_rawobj;

/* EXPORT */
struct git_odb_object {
	git_cached_obj cached;
	git_rawobj raw;
};

/* EXPORT */
36
struct git_odb {
37
	git_refcount rc;
38
	git_vector backends;
Vicent Marti committed
39
	git_cache cache;
40 41
};

42 43 44 45
/*
 * Hash a git_rawobj internally.
 * The `git_rawobj` is supposed to be previously initialized
 */
46
int git_odb__hashobj(git_oid *id, git_rawobj *obj);
47 48 49 50 51 52 53 54 55 56 57

/*
 * 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
 */
58
int git_odb__hashfd(git_oid *out, git_file fd, size_t size, git_otype type);
59

60 61 62 63 64 65 66 67 68 69
/*
 * 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`.
 *
 * The hash type for this call is always `GIT_OBJ_BLOB` because symlinks may only
 * point to blobs.
 */
int git_odb__hashlink(git_oid *out, const char *path);

70 71 72
/*
 * Generate a GIT_ENOTFOUND error for the ODB.
 */
Russell Belfer committed
73
int git_odb__error_notfound(const char *message, const git_oid *oid);
74 75 76 77 78 79

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

80
#endif