oid.c 7.94 KB
Newer Older
1
/*
schu committed
2
 * Copyright (C) 2009-2012 the libgit2 contributors
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
#include "common.h"
9
#include "git2/oid.h"
10
#include "repository.h"
11
#include <string.h>
12
#include <limits.h>
13

14
static char to_hex[] = "0123456789abcdef";
15

16 17 18 19 20 21
static int oid_error_invalid(const char *msg)
{
	giterr_set(GITERR_INVALID, "Unable to parse OID - %s", msg);
	return -1;
}

22
int git_oid_fromstrn(git_oid *out, const char *str, size_t length)
23
{
24
	size_t p;
25
	int v;
26 27 28 29

	if (length > GIT_OID_HEXSZ)
		length = GIT_OID_HEXSZ;

30
	for (p = 0; p < length - 1; p += 2) {
nulltoken committed
31 32
		v = (git__fromhex(str[p + 0]) << 4)
				| git__fromhex(str[p + 1]);
33

34
		if (v < 0)
35
			return oid_error_invalid("contains invalid characters");
36 37

		out->id[p / 2] = (unsigned char)v;
38
	}
39

40
	if (length % 2) {
nulltoken committed
41
		v = (git__fromhex(str[p + 0]) << 4);
42
		if (v < 0)
43
			return oid_error_invalid("contains invalid characters");
44

45 46 47 48
		out->id[p / 2] = (unsigned char)v;
		p += 2;
	}

49
	memset(out->id + p / 2, 0, (GIT_OID_HEXSZ - p) / 2);
50

51
	return 0;
52
}
53

54 55 56 57 58
int git_oid_fromstr(git_oid *out, const char *str)
{
	return git_oid_fromstrn(out, str, GIT_OID_HEXSZ);
}

59
GIT_INLINE(char) *fmt_one(char *str, unsigned int val)
60 61 62 63 64 65 66 67
{
	*str++ = to_hex[val >> 4];
	*str++ = to_hex[val & 0xf];
	return str;
}

void git_oid_fmt(char *str, const git_oid *oid)
{
68
	size_t i;
69 70 71 72 73 74 75

	for (i = 0; i < sizeof(oid->id); i++)
		str = fmt_one(str, oid->id[i]);
}

void git_oid_pathfmt(char *str, const git_oid *oid)
{
76
	size_t i;
77 78 79 80 81 82 83 84 85

	str = fmt_one(str, oid->id[0]);
	*str++ = '/';
	for (i = 1; i < sizeof(oid->id); i++)
		str = fmt_one(str, oid->id[i]);
}

char *git_oid_allocfmt(const git_oid *oid)
{
86
	char *str = git__malloc(GIT_OID_HEXSZ + 1);
87 88 89 90 91 92
	if (!str)
		return NULL;
	git_oid_fmt(str, oid);
	str[GIT_OID_HEXSZ] = '\0';
	return str;
}
93

94
char *git_oid_tostr(char *out, size_t n, const git_oid *oid)
95 96 97 98 99 100
{
	char str[GIT_OID_HEXSZ];

	if (!out || n == 0 || !oid)
		return "";

Vicent Marti committed
101
	n--; /* allow room for terminating NUL */
102 103 104

	if (n > 0) {
		git_oid_fmt(str, oid);
105 106 107
		if (n > GIT_OID_HEXSZ)
			n = GIT_OID_HEXSZ;
		memcpy(out, str, n);
108 109 110 111 112 113 114
	}

	out[n] = '\0';

	return out;
}

115 116 117
int git_oid__parse(
	git_oid *oid, const char **buffer_out,
	const char *buffer_end, const char *header)
118 119 120 121
{
	const size_t sha_len = GIT_OID_HEXSZ;
	const size_t header_len = strlen(header);

122
	const char *buffer = *buffer_out;
123 124

	if (buffer + (header_len + sha_len + 1) > buffer_end)
125
		return -1;
126 127

	if (memcmp(buffer, header, header_len) != 0)
128
		return -1;
129 130

	if (buffer[header_len + sha_len] != '\n')
131
		return -1;
132

133 134
	if (git_oid_fromstr(oid, buffer + header_len) < 0)
		return -1;
135 136 137

	*buffer_out = buffer + (header_len + sha_len + 1);

138
	return 0;
139 140
}

141 142 143 144 145 146 147 148 149 150
void git_oid__writebuf(git_buf *buf, const char *header, const git_oid *oid)
{
	char hex_oid[GIT_OID_HEXSZ];

	git_oid_fmt(hex_oid, oid);
	git_buf_puts(buf, header);
	git_buf_put(buf, hex_oid, GIT_OID_HEXSZ);
	git_buf_putc(buf, '\n');
}

Vicent Marti committed
151
void git_oid_fromraw(git_oid *out, const unsigned char *raw)
152 153 154 155 156 157 158 159 160
{
	memcpy(out->id, raw, sizeof(out->id));
}

void git_oid_cpy(git_oid *out, const git_oid *src)
{
	memcpy(out->id, src->id, sizeof(out->id));
}

161
int git_oid_ncmp(const git_oid *oid_a, const git_oid *oid_b, size_t len)
162
{
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178
	const unsigned char *a = oid_a->id;
	const unsigned char *b = oid_b->id;

	do {
		if (*a != *b)
			return 1;
		a++;
		b++;
		len -= 2;
	} while (len > 1);

	if (len)
		if ((*a ^ *b) & 0xf0)
			return 1;

	return 0;
179 180
}

181 182 183 184
int git_oid_streq(const git_oid *a, const char *str)
{
	git_oid id;

185 186
	if (git_oid_fromstr(&id, str) < 0)
		return -1;
187

188
	return git_oid_cmp(a, &id) == 0 ? 0 : -1;
189 190
}

191 192 193 194 195 196 197 198 199 200
int git_oid_iszero(const git_oid *oid_a)
{
	const unsigned char *a = oid_a->id;
	unsigned int i;
	for (i = 0; i < GIT_OID_RAWSZ; ++i, ++a)
		if (*a != 0)
			return 0;
	return 1;
}

201 202 203 204 205 206 207 208 209 210 211 212 213 214 215
typedef short node_index;

typedef union {
	const char *tail;
	node_index children[16];
} trie_node;

struct git_oid_shorten {
	trie_node *nodes;
	size_t node_count, size;
	int min_length, full;
};

static int resize_trie(git_oid_shorten *self, size_t new_size)
{
216
	self->nodes = git__realloc(self->nodes, new_size * sizeof(trie_node));
217
	GITERR_CHECK_ALLOC(self->nodes);
218 219 220 221 222 223

	if (new_size > self->size) {
		memset(&self->nodes[self->size], 0x0, (new_size - self->size) * sizeof(trie_node));
	}

	self->size = new_size;
224
	return 0;
225 226 227 228 229 230 231 232
}

static trie_node *push_leaf(git_oid_shorten *os, node_index idx, int push_at, const char *oid)
{
	trie_node *node, *leaf;
	node_index idx_leaf;

	if (os->node_count >= os->size) {
233
		if (resize_trie(os, os->size * 2) < 0)
234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254
			return NULL;
	}

	idx_leaf = (node_index)os->node_count++;

	if (os->node_count == SHRT_MAX)
		os->full = 1;

	node = &os->nodes[idx];
	node->children[push_at] = -idx_leaf;

	leaf = &os->nodes[idx_leaf];
	leaf->tail = oid;

	return node;
}

git_oid_shorten *git_oid_shorten_new(size_t min_length)
{
	git_oid_shorten *os;

255 256
	assert((size_t)((int)min_length) == min_length);

257
	os = git__calloc(1, sizeof(git_oid_shorten));
258 259 260
	if (os == NULL)
		return NULL;

261
	if (resize_trie(os, 16) < 0) {
262
		git__free(os);
263 264 265 266
		return NULL;
	}

	os->node_count = 1;
267
	os->min_length = (int)min_length;
268 269 270 271 272 273

	return os;
}

void git_oid_shorten_free(git_oid_shorten *os)
{
274 275
	git__free(os->nodes);
	git__free(os);
276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294
}


/*
 * What wizardry is this?
 *
 * This is just a memory-optimized trie: basically a very fancy
 * 16-ary tree, which is used to store the prefixes of the OID
 * strings.
 *
 * Read more: http://en.wikipedia.org/wiki/Trie
 *
 * Magic that happens in this method:
 *
 *	- Each node in the trie is an union, so it can work both as
 *	a normal node, or as a leaf.
 *
 *	- Each normal node points to 16 children (one for each possible
 *	character in the oid). This is *not* stored in an array of
295
 *	pointers, because in a 64-bit arch this would be sucking
296
 *	16*sizeof(void*) = 128 bytes of memory per node, which is
297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324
 *	insane. What we do is store Node Indexes, and use these indexes
 *	to look up each node in the om->index array. These indexes are
 *	signed shorts, so this limits the amount of unique OIDs that
 *	fit in the structure to about 20000 (assuming a more or less uniform
 *	distribution).
 *
 *	- All the nodes in om->index array are stored contiguously in
 *	memory, and each of them is 32 bytes, so we fit 2x nodes per
 *	cache line. Convenient for speed.
 *
 *	- To differentiate the leafs from the normal nodes, we store all
 *	the indexes towards a leaf as a negative index (indexes to normal
 *	nodes are positives). When we find that one of the children for
 *	a node has a negative value, that means it's going to be a leaf.
 *	This reduces the amount of indexes we have by two, but also reduces
 *	the size of each node by 1-4 bytes (the amount we would need to
 *	add a `is_leaf` field): this is good because it allows the nodes
 *	to fit cleanly in cache lines.
 *
 *	- Once we reach an empty children, instead of continuing to insert
 *	new nodes for each remaining character of the OID, we store a pointer
 *	to the tail in the leaf; if the leaf is reached again, we turn it
 *	into a normal node and use the tail to create a new leaf.
 *
 *	This is a pretty good balance between performance and memory usage.
 */
int git_oid_shorten_add(git_oid_shorten *os, const char *text_oid)
{
325 326
	int i;
	bool is_leaf;
327 328 329
	node_index idx;

	if (os->full)
330
		return -1;
331

332 333 334
	if (text_oid == NULL)
		return os->min_length;

335
	idx = 0;
336
	is_leaf = false;
337 338

	for (i = 0; i < GIT_OID_HEXSZ; ++i) {
nulltoken committed
339
		int c = git__fromhex(text_oid[i]);
340 341
		trie_node *node;

342 343 344 345
		if (c == -1) {
			giterr_set(GITERR_INVALID, "Unable to shorten OID - invalid hex value");
			return -1;
		}
346 347 348 349 350 351 352 353 354

		node = &os->nodes[idx];

		if (is_leaf) {
			const char *tail;

			tail = node->tail;
			node->tail = NULL;

nulltoken committed
355
			node = push_leaf(os, idx, git__fromhex(tail[0]), &tail[1]);
356
			GITERR_CHECK_ALLOC(node);
357 358 359 360
		}

		if (node->children[c] == 0) {
			if (push_leaf(os, idx, c, &text_oid[i + 1]) == NULL)
361
				return -1;
362 363 364 365
			break;
		}

		idx = node->children[c];
366
		is_leaf = false;
367 368 369

		if (idx < 0) {
			node->children[c] = idx = -idx;
370
			is_leaf = true;
371 372 373 374 375 376 377 378 379
		}
	}

	if (++i > os->min_length)
		os->min_length = i;

	return os->min_length;
}