util.h 11.1 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 11
#include "common.h"

12 13 14 15
#ifndef GIT_WIN32
# include <ctype.h>
#endif

16 17
#include "git2/buffer.h"

18
#include "buffer.h"
19
#include "common.h"
20
#include "strnlen.h"
21
#include "thread.h"
22

23
#define ARRAY_SIZE(x) (sizeof(x)/sizeof(x[0]))
Vicent Marti committed
24
#define bitsizeof(x) (CHAR_BIT * sizeof(x))
Vicent Marti committed
25
#define MSB(x, bits) ((x) & (~0ULL << (bitsizeof(x) - (bits))))
26 27 28
#ifndef min
# define min(a,b) ((a) < (b) ? (a) : (b))
#endif
29 30 31
#ifndef max
# define max(a,b) ((a) > (b) ? (a) : (b))
#endif
32

33 34 35 36 37 38 39 40 41 42 43
#if defined(__GNUC__)
# define GIT_CONTAINER_OF(ptr, type, member) \
	__builtin_choose_expr( \
	    __builtin_offsetof(type, member) == 0 && \
	    __builtin_types_compatible_p(typeof(&((type *) 0)->member), typeof(ptr)), \
		((type *) (ptr)), \
		(void)0)
#else
# define GIT_CONTAINER_OF(ptr, type, member) (type *)(ptr)
#endif

44 45
#define GIT_DATE_RFC2822_SZ  32

46 47 48 49 50 51 52 53 54
/**
 * Return the length of a constant string.
 * We are aware that `strlen` performs the same task and is usually
 * optimized away by the compiler, whilst being safer because it returns
 * valid values when passed a pointer instead of a constant string; however
 * this macro will transparently work with wide-char and single-char strings.
 */
#define CONST_STRLEN(x) ((sizeof(x)/sizeof(x[0])) - 1)

55 56 57 58 59 60
#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))

61
extern int git__prefixcmp(const char *str, const char *prefix);
62
extern int git__prefixcmp_icase(const char *str, const char *prefix);
63
extern int git__prefixncmp(const char *str, size_t str_n, const char *prefix);
64
extern int git__prefixncmp_icase(const char *str, size_t str_n, const char *prefix);
65
extern int git__suffixcmp(const char *str, const char *suffix);
66

67 68 69 70 71
GIT_INLINE(int) git__signum(int val)
{
	return ((val > 0) - (val < 0));
}

72 73 74
extern int git__strntol32(int32_t *n, const char *buff, size_t buff_len, const char **end_buf, int base);
extern int git__strntol64(int64_t *n, const char *buff, size_t buff_len, const char **end_buf, int base);

75

76
extern void git__hexdump(const char *buffer, size_t n);
77 78 79 80 81 82 83 84 85
extern uint32_t git__hash(const void *key, int len, uint32_t seed);

/* 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

86
extern char *git__strtok(char **end, const char *sep);
87
extern char *git__strsep(char **end, const char *sep);
88

89
extern void git__strntolower(char *str, size_t len);
90 91
extern void git__strtolower(char *str);

92 93 94 95 96 97 98 99 100
#ifdef GIT_WIN32
GIT_INLINE(int) git__tolower(int c)
{
	return (c >= 'A' && c <= 'Z') ? (c + 32) : c;
}
#else
# define git__tolower(a) tolower(a)
#endif

101 102
extern size_t git__linenlen(const char *buffer, size_t buffer_len);

103 104 105
GIT_INLINE(const char *) git__next_line(const char *s)
{
	while (*s && *s != '\n') s++;
Russell Belfer committed
106
	while (*s == '\n' || *s == '\r') s++;
107 108 109
	return s;
}

110 111 112 113 114 115 116 117 118 119 120 121 122 123 124
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;
}

125 126 127
extern const void * git__memmem(const void *haystack, size_t haystacklen,
				const void *needle, size_t needlelen);

128 129 130 131
typedef int (*git__tsort_cmp)(const void *a, const void *b);

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

132
typedef int (*git__sort_r_cmp)(const void *a, const void *b, void *payload);
133 134

extern void git__tsort_r(
135
	void **dst, size_t size, git__sort_r_cmp cmp, void *payload);
136 137

extern void git__qsort_r(
138 139
	void *els, size_t nel, size_t elsize, git__sort_r_cmp cmp, void *payload);

140 141 142
/**
 * @param position If non-NULL, this will be set to the position where the
 * 		element is or would be inserted if not found.
143
 * @return 0 if found; GIT_ENOTFOUND if not found
144
 */
145 146 147 148
extern int git__bsearch(
	void **array,
	size_t array_len,
	const void *key,
149 150 151 152 153 154 155 156 157
	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,
158
	size_t *position);
159

romkatv committed
160 161 162
#define git__strcmp strcmp
#define git__strncmp strncmp

163
extern int git__strcmp_cb(const void *a, const void *b);
164
extern int git__strcasecmp_cb(const void *a, const void *b);
165

166 167 168
extern int git__strcasecmp(const char *a, const char *b);
extern int git__strncasecmp(const char *a, const char *b, size_t sz);

169 170
extern int git__strcasesort_cmp(const char *a, const char *b);

171
typedef struct {
172
	git_atomic32 refcount;
173 174 175 176 177 178
	void *owner;
} git_refcount;

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

#define GIT_REFCOUNT_INC(r) { \
179
	git_atomic32_inc(&(r)->rc.refcount);	\
180 181 182
}

#define GIT_REFCOUNT_DEC(_r, do_free) { \
183
	git_refcount *r = &(_r)->rc; \
184
	int val = git_atomic32_dec(&r->refcount); \
185
	if (val <= 0 && r->owner == NULL) { do_free(_r); } \
186 187 188
}

#define GIT_REFCOUNT_OWN(r, o) { \
189
	(void)git_atomic_swap((r)->rc.owner, o); \
190 191
}

192
#define GIT_REFCOUNT_OWNER(r) git_atomic_load((r)->rc.owner)
193

194
#define GIT_REFCOUNT_VAL(r) git_atomic32_get((r)->rc.refcount)
195 196


nulltoken committed
197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219
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];
}
220

schu committed
221 222 223
GIT_INLINE(int) git__ishex(const char *str)
{
	unsigned i;
224
	for (i=0; str[i] != '\0'; i++)
schu committed
225 226 227 228 229
		if (git__fromhex(str[i]) < 0)
			return 0;
	return 1;
}

230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246
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;
}

247 248
GIT_INLINE(bool) git__isupper(int c)
{
Linquize committed
249
	return (c >= 'A' && c <= 'Z');
250 251 252 253
}

GIT_INLINE(bool) git__isalpha(int c)
{
Linquize committed
254
	return ((c >= 'A' && c <= 'Z') || (c >= 'a' && c <= 'z'));
255 256
}

nulltoken committed
257 258
GIT_INLINE(bool) git__isdigit(int c)
{
Linquize committed
259
	return (c >= '0' && c <= '9');
nulltoken committed
260 261
}

262 263
GIT_INLINE(bool) git__isspace(int c)
{
264
	return (c == ' ' || c == '\t' || c == '\n' || c == '\f' || c == '\r' || c == '\v');
265 266
}

267 268
GIT_INLINE(bool) git__isspace_nonlf(int c)
{
269
	return (c == ' ' || c == '\t' || c == '\f' || c == '\r' || c == '\v');
270 271
}

272 273 274 275 276
GIT_INLINE(bool) git__iswildcard(int c)
{
	return (c == '*' || c == '?' || c == '[');
}

277 278 279 280 281
GIT_INLINE(bool) git__isxdigit(int c)
{
	return ((c >= '0' && c <= '9') || (c >= 'a' && c <= 'f') || (c >= 'A' && c <= 'F'));
}

282
/*
283
 * Parse a string value as a boolean, just like Core Git does.
284 285 286 287 288 289
 *
 * 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);

290 291 292 293 294 295 296 297
/*
 * Parse a string into a value as a git_time_t.
 *
 * Sample valid input:
 * - "yesterday"
 * - "July 17, 2003"
 * - "2003-7-17 08:23"
 */
298
extern int git__date_parse(git_time_t *out, const char *date);
299

300
/*
301 302 303 304 305 306 307 308 309 310
 * 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);

/*
311
 * Unescapes a string in-place.
Russell Belfer committed
312
 *
313 314 315 316 317 318
 * Edge cases behavior:
 * - "jackie\" -> "jacky\"
 * - "chan\\" -> "chan\"
 */
extern size_t git__unescape(char *str);

319
/*
320 321 322 323 324 325 326 327 328 329 330
 * Iterate through an UTF-8 string, yielding one
 * codepoint at a time.
 *
 * @param str current position in the string
 * @param str_len size left in the string; -1 if the string is NULL-terminated
 * @param dst pointer where to store the current codepoint
 * @return length in bytes of the read codepoint; -1 if the codepoint was invalid
 */
extern int git__utf8_iterate(const uint8_t *str, int str_len, int32_t *dst);

/*
331 332 333 334 335 336 337 338 339 340
 * Iterate through an UTF-8 string and stops after finding any invalid UTF-8
 * codepoints.
 *
 * @param str string to scan
 * @param str_len size of the string
 * @return length in bytes of the string that contains valid data
 */
extern size_t git__utf8_valid_buf_length(const uint8_t *str, size_t str_len);

/*
341 342
 * Safely zero-out memory, making sure that the compiler
 * doesn't optimize away the operation.
343
 */
yorah committed
344 345 346 347 348 349 350 351 352 353 354
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
}
355

356 357 358 359
#ifdef GIT_WIN32

GIT_INLINE(double) git__timer(void)
{
360
	/* GetTickCount64 returns the number of milliseconds that have
361
	 * elapsed since the system was started. */
362
	return (double) GetTickCount64() / (double) 1000;
363 364 365 366 367 368
}

#elif __APPLE__

#include <mach/mach_time.h>

369
GIT_INLINE(double) git__timer(void)
370 371 372 373 374 375 376 377 378 379
{
   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;
   }

380
   return (double)time * scaling_factor / 1.0E9;
381 382
}

383 384 385 386 387 388 389 390 391 392 393
#elif defined(AMIGA)

#include <proto/timer.h>

GIT_INLINE(double) git__timer(void)
{
	struct TimeVal tv;
	ITimer->GetUpTime(&tv);
	return (double)tv.Seconds + (double)tv.Microseconds / 1.0E6;
}

394 395 396 397 398 399 400 401 402
#else

#include <sys/time.h>

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

	if (clock_gettime(CLOCK_MONOTONIC, &tp) == 0) {
403
		return (double) tp.tv_sec + (double) tp.tv_nsec / 1.0E9;
404 405 406 407 408
	} else {
		/* Fall back to using gettimeofday */
		struct timeval tv;
		struct timezone tz;
		gettimeofday(&tv, &tz);
409
		return (double)tv.tv_sec + (double)tv.tv_usec / 1.0E6;
410 411 412 413 414
	}
}

#endif

415 416
extern int git__getenv(git_buf *out, const char *name);

417 418
extern int git__online_cpus(void);

419 420
GIT_INLINE(int) git__noop(void) { return 0; }

421 422
#include "alloc.h"

423
#endif