util.h 10.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 12 13
#ifndef GIT_WIN32
# include <ctype.h>
#endif

14
#include "str.h"
15
#include "git2_util.h"
16
#include "strnlen.h"
17
#include "thread.h"
18

19
#define ARRAY_SIZE(x) (sizeof(x)/sizeof(x[0]))
Vicent Marti committed
20
#define bitsizeof(x) (CHAR_BIT * sizeof(x))
21
#define MSB(x, bits) ((x) & (~UINT64_C(0) << (bitsizeof(x) - (bits))))
22 23 24
#ifndef min
# define min(a,b) ((a) < (b) ? (a) : (b))
#endif
25 26 27
#ifndef max
# define max(a,b) ((a) > (b) ? (a) : (b))
#endif
28

29 30 31 32
#if defined(__GNUC__)
# define GIT_CONTAINER_OF(ptr, type, member) \
	__builtin_choose_expr( \
	    __builtin_offsetof(type, member) == 0 && \
33
	    __builtin_types_compatible_p(__typeof__(&((type *) 0)->member), __typeof__(ptr)), \
34 35 36 37 38 39
		((type *) (ptr)), \
		(void)0)
#else
# define GIT_CONTAINER_OF(ptr, type, member) (type *)(ptr)
#endif

40 41 42 43 44 45 46 47 48
/**
 * 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)

49 50 51 52 53 54
#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))

55
extern int git__prefixcmp(const char *str, const char *prefix);
56
extern int git__prefixcmp_icase(const char *str, const char *prefix);
57
extern int git__prefixncmp(const char *str, size_t str_n, const char *prefix);
58
extern int git__prefixncmp_icase(const char *str, size_t str_n, const char *prefix);
59
extern int git__suffixcmp(const char *str, const char *suffix);
60

61 62 63 64 65
GIT_INLINE(int) git__signum(int val)
{
	return ((val > 0) - (val < 0));
}

66 67 68
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);

69

70
extern void git__hexdump(const char *buffer, size_t n);
71 72 73 74 75 76 77 78 79
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

80
extern char *git__strtok(char **end, const char *sep);
81
extern char *git__strsep(char **end, const char *sep);
82

83
extern void git__strntolower(char *str, size_t len);
84 85
extern void git__strtolower(char *str);

86 87 88 89 90 91 92 93 94
#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

95 96
extern size_t git__linenlen(const char *buffer, size_t buffer_len);

97 98 99
GIT_INLINE(const char *) git__next_line(const char *s)
{
	while (*s && *s != '\n') s++;
Russell Belfer committed
100
	while (*s == '\n' || *s == '\r') s++;
101 102 103
	return s;
}

104 105 106 107 108 109 110 111 112 113 114 115 116 117 118
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;
}

119 120 121
extern const void * git__memmem(const void *haystack, size_t haystacklen,
				const void *needle, size_t needlelen);

122 123 124 125
typedef int (*git__tsort_cmp)(const void *a, const void *b);

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

126
typedef int (*git__sort_r_cmp)(const void *a, const void *b, void *payload);
127 128

extern void git__tsort_r(
129
	void **dst, size_t size, git__sort_r_cmp cmp, void *payload);
130 131

extern void git__qsort_r(
132 133
	void *els, size_t nel, size_t elsize, git__sort_r_cmp cmp, void *payload);

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

romkatv committed
154 155 156
#define git__strcmp strcmp
#define git__strncmp strncmp

157
extern int git__strcmp_cb(const void *a, const void *b);
158
extern int git__strcasecmp_cb(const void *a, const void *b);
159

160 161 162
extern int git__strcasecmp(const char *a, const char *b);
extern int git__strncasecmp(const char *a, const char *b, size_t sz);

163 164
extern int git__strcasesort_cmp(const char *a, const char *b);

165 166 167 168 169 170 171 172 173 174 175
/*
 * Compare some NUL-terminated `a` to a possibly non-NUL terminated
 * `b` of length `b_len`; like `strncmp` but ensuring that
 * `strlen(a) == b_len` as well.
 */
GIT_INLINE(int) git__strlcmp(const char *a, const char *b, size_t b_len)
{
	int cmp = strncmp(a, b, b_len);
	return cmp ? cmp : (int)a[b_len];
}

176
typedef struct {
177
	git_atomic32 refcount;
178 179 180 181 182 183
	void *owner;
} git_refcount;

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

#define GIT_REFCOUNT_INC(r) { \
184
	git_atomic32_inc(&(r)->rc.refcount);	\
185 186 187
}

#define GIT_REFCOUNT_DEC(_r, do_free) { \
188
	git_refcount *r = &(_r)->rc; \
189
	int val = git_atomic32_dec(&r->refcount); \
190
	if (val <= 0 && r->owner == NULL) { do_free(_r); } \
191 192 193
}

#define GIT_REFCOUNT_OWN(r, o) { \
194
	(void)git_atomic_swap((r)->rc.owner, o); \
195 196
}

197
#define GIT_REFCOUNT_OWNER(r) git_atomic_load((r)->rc.owner)
198

199
#define GIT_REFCOUNT_VAL(r) git_atomic32_get((r)->rc.refcount)
200 201


nulltoken committed
202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224
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];
}
225

schu committed
226 227 228
GIT_INLINE(int) git__ishex(const char *str)
{
	unsigned i;
229
	for (i=0; str[i] != '\0'; i++)
schu committed
230 231 232 233 234
		if (git__fromhex(str[i]) < 0)
			return 0;
	return 1;
}

235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251
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;
}

252 253
GIT_INLINE(bool) git__isupper(int c)
{
Linquize committed
254
	return (c >= 'A' && c <= 'Z');
255 256 257 258
}

GIT_INLINE(bool) git__isalpha(int c)
{
Linquize committed
259
	return ((c >= 'A' && c <= 'Z') || (c >= 'a' && c <= 'z'));
260 261
}

nulltoken committed
262 263
GIT_INLINE(bool) git__isdigit(int c)
{
Linquize committed
264
	return (c >= '0' && c <= '9');
nulltoken committed
265 266
}

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

272 273
GIT_INLINE(bool) git__isspace_nonlf(int c)
{
274
	return (c == ' ' || c == '\t' || c == '\f' || c == '\r' || c == '\v');
275 276
}

277 278 279 280 281
GIT_INLINE(bool) git__iswildcard(int c)
{
	return (c == '*' || c == '?' || c == '[');
}

282 283 284 285 286
GIT_INLINE(bool) git__isxdigit(int c)
{
	return ((c >= '0' && c <= '9') || (c >= 'a' && c <= 'f') || (c >= 'A' && c <= 'F'));
}

287
/*
288
 * Parse a string value as a boolean, just like Core Git does.
289 290 291 292 293 294
 *
 * 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);

295
/*
296
 * Unescapes a string in-place.
Russell Belfer committed
297
 *
298 299 300 301 302 303
 * Edge cases behavior:
 * - "jackie\" -> "jacky\"
 * - "chan\\" -> "chan\"
 */
extern size_t git__unescape(char *str);

304
/*
305 306
 * Safely zero-out memory, making sure that the compiler
 * doesn't optimize away the operation.
307
 */
yorah committed
308 309 310 311 312 313 314 315 316 317 318
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
}
319

320 321 322 323
#ifdef GIT_WIN32

GIT_INLINE(double) git__timer(void)
{
324
	/* GetTickCount64 returns the number of milliseconds that have
325
	 * elapsed since the system was started. */
326
	return (double) GetTickCount64() / (double) 1000;
327 328 329 330 331 332
}

#elif __APPLE__

#include <mach/mach_time.h>

333
GIT_INLINE(double) git__timer(void)
334 335 336 337 338 339 340 341 342 343
{
   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;
   }

344
   return (double)time * scaling_factor / 1.0E9;
345 346
}

347
#elif defined(__amigaos4__)
348 349 350 351 352 353 354 355 356 357

#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;
}

358 359 360 361 362 363
#else

#include <sys/time.h>

GIT_INLINE(double) git__timer(void)
{
364
	struct timeval tv;
365

366 367 368
#ifdef CLOCK_MONOTONIC
	struct timespec tp;
	if (clock_gettime(CLOCK_MONOTONIC, &tp) == 0)
369
		return (double) tp.tv_sec + (double) tp.tv_nsec / 1.0E9;
370 371 372 373 374
#endif

	/* Fall back to using gettimeofday */
	gettimeofday(&tv, NULL);
	return (double)tv.tv_sec + (double)tv.tv_usec / 1.0E6;
375 376 377 378
}

#endif

379
extern int git__getenv(git_str *out, const char *name);
380

381 382
extern int git__online_cpus(void);

383
GIT_INLINE(int) git__noop(void) { return 0; }
384
GIT_INLINE(int) git__noop_args(void *a, ...) { GIT_UNUSED(a); return 0; }
385

386 387
#include "alloc.h"

388
#endif