util.h 10.7 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_util_h__
#define INCLUDE_util_h__

10
#include "common.h"
11
#include "strnlen.h"
12

13
#define ARRAY_SIZE(x) (sizeof(x)/sizeof(x[0]))
Vicent Marti committed
14
#define bitsizeof(x) (CHAR_BIT * sizeof(x))
Vicent Marti committed
15
#define MSB(x, bits) ((x) & (~0ULL << (bitsizeof(x) - (bits))))
16 17 18
#ifndef min
# define min(a,b) ((a) < (b) ? (a) : (b))
#endif
19 20 21
#ifndef max
# define max(a,b) ((a) > (b) ? (a) : (b))
#endif
22

23 24
#define GIT_DATE_RFC2822_SZ  32

25
/*
26 27 28
 * Custom memory allocation wrappers
 * that set error code and error message
 * on allocation failure
Vicent Marti committed
29
 */
30 31 32
GIT_INLINE(void *) git__malloc(size_t len)
{
	void *ptr = malloc(len);
33
	if (!ptr) giterr_set_oom();
34 35 36 37 38 39
	return ptr;
}

GIT_INLINE(void *) git__calloc(size_t nelem, size_t elsize)
{
	void *ptr = calloc(nelem, elsize);
40
	if (!ptr) giterr_set_oom();
41 42 43 44 45 46
	return ptr;
}

GIT_INLINE(char *) git__strdup(const char *str)
{
	char *ptr = strdup(str);
47
	if (!ptr) giterr_set_oom();
48 49 50
	return ptr;
}

51 52
GIT_INLINE(char *) git__strndup(const char *str, size_t n)
{
53
	size_t length = 0;
54 55
	char *ptr;

56
	length = p_strnlen(str, n);
57

Ben Straub committed
58
	ptr = (char*)git__malloc(length + 1);
59

60 61 62
	if (!ptr)
		return NULL;

63 64 65
	if (length)
		memcpy(ptr, str, length);

66
	ptr[length] = '\0';
67 68 69 70

	return ptr;
}

Ben Straub committed
71 72 73
/* NOTE: This doesn't do null or '\0' checking.  Watch those boundaries! */
GIT_INLINE(char *) git__substrdup(const char *start, size_t n)
{
74
	char *ptr = (char*)git__malloc(n+1);
Ben Straub committed
75
	memcpy(ptr, start, n);
76
	ptr[n] = '\0';
Ben Straub committed
77 78 79
	return ptr;
}

80 81 82
GIT_INLINE(void *) git__realloc(void *ptr, size_t size)
{
	void *new_ptr = realloc(ptr, size);
83
	if (!new_ptr) giterr_set_oom();
84 85
	return new_ptr;
}
86

87 88 89 90
GIT_INLINE(void) git__free(void *ptr)
{
	free(ptr);
}
91

92 93 94 95 96 97
#define STRCMP_CASESELECT(IGNORE_CASE, STR1, STR2) \
	((IGNORE_CASE) ? strcasecmp((STR1), (STR2)) : strcmp((STR1), (STR2)))

#define CASESELECT(IGNORE_CASE, ICASE, CASE) \
	((IGNORE_CASE) ? (ICASE) : (CASE))

98
extern int git__prefixcmp(const char *str, const char *prefix);
99
extern int git__prefixcmp_icase(const char *str, const char *prefix);
100
extern int git__suffixcmp(const char *str, const char *suffix);
101

102 103 104 105 106
GIT_INLINE(int) git__signum(int val)
{
	return ((val > 0) - (val < 0));
}

107 108
extern int git__strtol32(int32_t *n, const char *buff, const char **end_buf, int base);
extern int git__strtol64(int64_t *n, const char *buff, const char **end_buf, int base);
109

110
extern void git__hexdump(const char *buffer, size_t n);
111 112
extern uint32_t git__hash(const void *key, int len, uint32_t seed);

113
/** @return true if p fits into the range of a size_t */
114
GIT_INLINE(int) git__is_sizet(git_off_t p)
115 116
{
	size_t r = (size_t)p;
117
	return p == (git_off_t)r;
118 119
}

120 121 122 123 124 125 126
/** @return true if p fits into the range of a uint32_t */
GIT_INLINE(int) git__is_uint32(size_t p)
{
	uint32_t r = (uint32_t)p;
	return p == (size_t)r;
}

127 128 129 130 131 132 133
/* 32-bit cross-platform rotl */
#ifdef _MSC_VER /* use built-in method in MSVC */
#	define git__rotl(v, s) (uint32_t)_rotl(v, s)
#else /* use bitops in GCC; with o2 this gets optimized to a rotl instruction */
#	define git__rotl(v, s) (uint32_t)(((uint32_t)(v) << (s)) | ((uint32_t)(v) >> (32 - (s))))
#endif

134
extern char *git__strtok(char **end, const char *sep);
135
extern char *git__strsep(char **end, const char *sep);
136

137
extern void git__strntolower(char *str, size_t len);
138 139
extern void git__strtolower(char *str);

140 141 142
GIT_INLINE(const char *) git__next_line(const char *s)
{
	while (*s && *s != '\n') s++;
Russell Belfer committed
143
	while (*s == '\n' || *s == '\r') s++;
144 145 146
	return s;
}

147 148 149 150 151 152 153 154 155 156 157 158 159 160 161
GIT_INLINE(const void *) git__memrchr(const void *s, int c, size_t n)
{
	const unsigned char *cp;

	if (n != 0) {
		cp = (unsigned char *)s + n;
		do {
			if (*(--cp) == (unsigned char)c)
				return cp;
		} while (--n != 0);
	}

	return NULL;
}

162 163 164 165
typedef int (*git__tsort_cmp)(const void *a, const void *b);

extern void git__tsort(void **dst, size_t size, git__tsort_cmp cmp);

166
typedef int (*git__sort_r_cmp)(const void *a, const void *b, void *payload);
167 168

extern void git__tsort_r(
169
	void **dst, size_t size, git__sort_r_cmp cmp, void *payload);
170 171

extern void git__qsort_r(
172 173 174 175 176
	void *els, size_t nel, size_t elsize, git__sort_r_cmp cmp, void *payload);

extern void git__insertsort_r(
	void *els, size_t nel, size_t elsize, void *swapel,
	git__sort_r_cmp cmp, void *payload);
177

178 179 180
/**
 * @param position If non-NULL, this will be set to the position where the
 * 		element is or would be inserted if not found.
181
 * @return 0 if found; GIT_ENOTFOUND if not found
182
 */
183 184 185 186
extern int git__bsearch(
	void **array,
	size_t array_len,
	const void *key,
187 188 189 190 191 192 193 194 195
	int (*compare)(const void *key, const void *element),
	size_t *position);

extern int git__bsearch_r(
	void **array,
	size_t array_len,
	const void *key,
	int (*compare_r)(const void *key, const void *element, void *payload),
	void *payload,
196
	size_t *position);
197

198
extern int git__strcmp_cb(const void *a, const void *b);
199
extern int git__strcasecmp_cb(const void *a, const void *b);
200

201 202 203 204 205
extern int git__strcmp(const char *a, const char *b);
extern int git__strcasecmp(const char *a, const char *b);
extern int git__strncmp(const char *a, const char *b, size_t sz);
extern int git__strncasecmp(const char *a, const char *b, size_t sz);

206 207
extern int git__strcasesort_cmp(const char *a, const char *b);

208 209
#include "thread-utils.h"

210
typedef struct {
211
	git_atomic refcount;
212 213 214 215 216 217
	void *owner;
} git_refcount;

typedef void (*git_refcount_freeptr)(void *r);

#define GIT_REFCOUNT_INC(r) { \
218
	git_atomic_inc(&((git_refcount *)(r))->refcount);	\
219 220 221 222
}

#define GIT_REFCOUNT_DEC(_r, do_free) { \
	git_refcount *r = (git_refcount *)(_r); \
223 224
	int val = git_atomic_dec(&r->refcount); \
	if (val <= 0 && r->owner == NULL) { do_free(_r); } \
225 226 227 228 229 230 231 232
}

#define GIT_REFCOUNT_OWN(r, o) { \
	((git_refcount *)(r))->owner = o; \
}

#define GIT_REFCOUNT_OWNER(r) (((git_refcount *)(r))->owner)

233 234 235
#define GIT_REFCOUNT_VAL(r) git_atomic_get(&((git_refcount *)(r))->refcount)


nulltoken committed
236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258
static signed char from_hex[] = {
-1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, /* 00 */
-1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, /* 10 */
-1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, /* 20 */
 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, -1, -1, -1, -1, -1, -1, /* 30 */
-1, 10, 11, 12, 13, 14, 15, -1, -1, -1, -1, -1, -1, -1, -1, -1, /* 40 */
-1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, /* 50 */
-1, 10, 11, 12, 13, 14, 15, -1, -1, -1, -1, -1, -1, -1, -1, -1, /* 60 */
-1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, /* 70 */
-1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, /* 80 */
-1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, /* 90 */
-1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, /* a0 */
-1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, /* b0 */
-1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, /* c0 */
-1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, /* d0 */
-1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, /* e0 */
-1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, /* f0 */
};

GIT_INLINE(int) git__fromhex(char h)
{
	return from_hex[(unsigned char) h];
}
259

schu committed
260 261 262 263 264 265 266 267 268
GIT_INLINE(int) git__ishex(const char *str)
{
	unsigned i;
	for (i=0; i<strlen(str); i++)
		if (git__fromhex(str[i]) < 0)
			return 0;
	return 1;
}

269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285
GIT_INLINE(size_t) git__size_t_bitmask(size_t v)
{
	v--;
	v |= v >> 1;
	v |= v >> 2;
	v |= v >> 4;
	v |= v >> 8;
	v |= v >> 16;

	return v;
}

GIT_INLINE(size_t) git__size_t_powerof2(size_t v)
{
	return git__size_t_bitmask(v) + 1;
}

286 287
GIT_INLINE(bool) git__isupper(int c)
{
Linquize committed
288
	return (c >= 'A' && c <= 'Z');
289 290 291 292
}

GIT_INLINE(bool) git__isalpha(int c)
{
Linquize committed
293
	return ((c >= 'A' && c <= 'Z') || (c >= 'a' && c <= 'z'));
294 295
}

nulltoken committed
296 297
GIT_INLINE(bool) git__isdigit(int c)
{
Linquize committed
298
	return (c >= '0' && c <= '9');
nulltoken committed
299 300
}

301 302
GIT_INLINE(bool) git__isspace(int c)
{
Linquize committed
303
	return (c == ' ' || c == '\t' || c == '\n' || c == '\f' || c == '\r' || c == '\v' || c == 0x85 /* Unicode CR+LF */);
304 305
}

306 307 308 309 310
GIT_INLINE(bool) git__isspace_nonlf(int c)
{
	return (c == ' ' || c == '\t' || c == '\f' || c == '\r' || c == '\v' || c == 0x85 /* Unicode CR+LF */);
}

311 312 313 314 315
GIT_INLINE(bool) git__iswildcard(int c)
{
	return (c == '*' || c == '?' || c == '[');
}

316
/*
317
 * Parse a string value as a boolean, just like Core Git does.
318 319 320 321 322 323
 *
 * Valid values for true are: 'true', 'yes', 'on'
 * Valid values for false are: 'false', 'no', 'off'
 */
extern int git__parse_bool(int *out, const char *value);

324 325 326 327 328 329 330 331
/*
 * Parse a string into a value as a git_time_t.
 *
 * Sample valid input:
 * - "yesterday"
 * - "July 17, 2003"
 * - "2003-7-17 08:23"
 */
332
extern int git__date_parse(git_time_t *out, const char *date);
333

334
/*
335 336 337 338 339 340 341 342 343 344
 * Format a git_time as a RFC2822 string
 *
 * @param out buffer to store formatted date; a '\\0' terminator will automatically be added.
 * @param len size of the buffer; should be atleast `GIT_DATE_RFC2822_SZ` in size;
 * @param date the date to be formatted
 * @return 0 if successful; -1 on error
 */
extern int git__date_rfc2822_fmt(char *out, size_t len, const git_time *date);

/*
345
 * Unescapes a string in-place.
Russell Belfer committed
346
 *
347 348 349 350 351 352
 * Edge cases behavior:
 * - "jackie\" -> "jacky\"
 * - "chan\\" -> "chan\"
 */
extern size_t git__unescape(char *str);

353
/*
354 355
 * Safely zero-out memory, making sure that the compiler
 * doesn't optimize away the operation.
356
 */
yorah committed
357 358 359 360 361 362 363 364 365 366 367
GIT_INLINE(void) git__memzero(void *data, size_t size)
{
#ifdef _MSC_VER
	SecureZeroMemory((PVOID)data, size);
#else
	volatile uint8_t *scan = (volatile uint8_t *)data;

	while (size--)
		*scan++ = 0x0;
#endif
}
368

369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394
#ifdef GIT_WIN32

GIT_INLINE(double) git__timer(void)
{
	/* We need the initial tick count to detect if the tick
	 * count has rolled over. */
	static DWORD initial_tick_count = 0;

	/* GetTickCount returns the number of milliseconds that have
	 * elapsed since the system was started. */
	DWORD count = GetTickCount();

	if(initial_tick_count == 0) {
		initial_tick_count = count;
	} else if (count < initial_tick_count) {
		/* The tick count has rolled over - adjust for it. */
		count = (0xFFFFFFFF - initial_tick_count) + count;
	}

	return (double) count / (double) 1000;
}

#elif __APPLE__

#include <mach/mach_time.h>

395
GIT_INLINE(double) git__timer(void)
396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429
{
   uint64_t time = mach_absolute_time();
   static double scaling_factor = 0;

   if (scaling_factor == 0) {
       mach_timebase_info_data_t info;
       (void)mach_timebase_info(&info);
       scaling_factor = (double)info.numer / (double)info.denom;
   }

   return (double)time * scaling_factor / 1.0E-9;
}

#else

#include <sys/time.h>

GIT_INLINE(double) git__timer(void)
{
	struct timespec tp;

	if (clock_gettime(CLOCK_MONOTONIC, &tp) == 0) {
		return (double) tp.tv_sec + (double) tp.tv_nsec / 1E-9;
	} else {
		/* Fall back to using gettimeofday */
		struct timeval tv;
		struct timezone tz;
		gettimeofday(&tv, &tz);
		return (double)tv.tv_sec + (double)tv.tv_usec / 1E-6;
	}
}

#endif

430
#endif /* INCLUDE_util_h__ */