1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 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 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 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 395 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 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660
|
/* common_func.c - functions used almost everywhere */
#include "common_func.h"
#include "parse_cmdline.h"
#include "version.h"
#include "win_utils.h"
#include <assert.h>
#include <ctype.h>
#include <errno.h>
#include <stdarg.h>
#include <stdlib.h>
#include <string.h>
#include <wchar.h>
#if defined( _WIN32) || defined(__CYGWIN__)
# include <windows.h>
#endif
/*=========================================================================
* String functions
*=========================================================================*/
/**
* Print a 0-terminated string representation of a 64-bit number to
* a string buffer.
*
* @param dst the string buffer to write the number to
* @param number the 64-bit number to output
* @param min_width the minimum width, the number must take
*/
void sprintI64(char* dst, uint64_t number, int min_width)
{
char buf[24]; /* internal buffer to output the number to */
size_t len;
char* p = buf + 23; /* start filling from the buffer end */
*(p--) = 0; /* last symbol should be '\0' */
if (number == 0) {
*(p--) = '0';
} else {
for (; p >= buf && number != 0; p--, number /= 10) {
*p = '0' + (char)(number % 10);
}
}
len = buf + 22 - p;
if ((size_t)min_width > len) {
memset(dst, 0x20, min_width - len); /* fill by spaces */
dst += min_width - len;
}
memcpy(dst, p + 1, len + 1); /* copy the number to the output buffer */
}
/**
* Calculate length of decimal representation of given 64-bit integer.
*
* @param num integer to calculate the length for
* @return length of decimal representation
*/
int int_len(uint64_t num)
{
int len;
for (len = 0; num; len++, num /= 10);
return (len == 0 ? 1 : len); /* note: int_len(0) == 1 */
}
/**
* Convert given string to lower case.
* The result string will be allocated by malloc.
* The allocated memory should be freed by calling free().
*
* @param str a string to convert
* @return converted string allocated by malloc
*/
char* str_tolower(const char* str)
{
char* buf = rsh_strdup(str);
char* p;
if (buf) {
for (p = buf; *p; p++) *p = tolower(*p);
}
return buf;
}
/**
* Remove spaces from the begin and the end of the string.
*
* @param str the modifiable buffer with the string
* @return trimmed string
*/
char* str_trim(char* str)
{
char* last = str + strlen(str) - 1;
while (isspace((unsigned char)*str)) str++;
while (isspace((unsigned char)*last) && last > str) *(last--) = 0;
return str;
}
/**
* Fill a buffer with NULL-terminated string consisting
* solely of a given repeated character.
*
* @param buf the modifiable buffer to fill
* @param ch the character to fill string with
* @param length the length of the string to construct
* @return the buffer
*/
char* str_set(char* buf, int ch, int length)
{
memset(buf, ch, length);
buf[length] = '\0';
return buf;
}
#ifdef _WIN32
/**
* Return wide-string obtained from the given source string by replacing its part with another string.
*
* @param src source wide-string
* @param start_pos starting position of the replacement
* @param end_pos ending position of the replacement
* @param replacement the replacement ASCII string (nullable), NULL is interpreted as empty string
* @return result of replacement, the resulting string is always allocated by malloc(),
* and must be freed by caller
*/
wchar_t* wcs_replace_n(const wchar_t* src, size_t start_pos, size_t end_pos, const char* replacement)
{
const size_t len1 = wcslen(src);
const size_t len2 = (replacement ? strlen(replacement) : 0);
size_t result_len;
size_t i;
wchar_t* result;
if (start_pos > len1)
start_pos = end_pos = len1;
else if (end_pos > len1)
end_pos = len1;
else if (start_pos > end_pos)
end_pos = start_pos;
result_len = len1 + len2 - (end_pos - start_pos);
result = (wchar_t*)rsh_malloc((result_len + 1) * sizeof(wchar_t));
memcpy(result, src, start_pos * sizeof(wchar_t));
for (i = 0; i < len2; i++)
result[start_pos + i] = (wchar_t)replacement[i];
if (end_pos < len1)
memcpy(result + start_pos + len2, src + end_pos, (len1 - end_pos) * sizeof(wchar_t));
result[result_len] = 0;
return result;
}
#endif
/**
* Return string obtained from the given source string by replacing its part with another string.
*
* @param src source string
* @param start_pos starting position of the replacement
* @param end_pos ending position of the replacement
* @param replacement the replacement string (nullable), NULL is interpreted as empty string
* @return result of replacement, the resulting string is always allocated by malloc(),
* and must be freed by caller
*/
char* str_replace_n(const char* src, size_t start_pos, size_t end_pos, const char* replacement)
{
const size_t len1 = strlen(src);
const size_t len2 = (replacement ? strlen(replacement) : 0);
size_t result_len;
char* result;
if (start_pos > len1)
start_pos = end_pos = len1;
else if (end_pos > len1)
end_pos = len1;
else if (start_pos > end_pos)
end_pos = start_pos;
result_len = len1 + len2 - (end_pos - start_pos);
result = (char*)rsh_malloc(result_len + 1);
memcpy(result, src, start_pos);
if (len2 > 0)
memcpy(result + start_pos, replacement, len2);
if (end_pos < len1)
memcpy(result + start_pos + len2, src + end_pos, len1 - end_pos);
result[result_len] = 0;
return result;
}
/**
* Check if a string is a binary string, which means the string contain
* a character with ACII code below 0x20 other than '\r', '\n', '\t'.
*
* @param str a string to check
* @return non zero if string is binary
*/
int is_binary_string(const char* str)
{
for (; *str; str++) {
if (((unsigned char)*str) < 32 && ((1 << (unsigned char)*str) & ~0x2600)) {
return 1;
}
}
return 0;
}
/**
* Count number of utf8 characters in a 0-terminated string
*
* @param str the string to measure
* @return number of utf8 characters in the string
*/
size_t count_utf8_symbols(const char* str)
{
size_t length = 0;
for (; *str; str++) {
if ((*str & 0xc0) != 0x80) length++;
}
return length;
}
/*=========================================================================
* Program version information
*=========================================================================*/
const char* get_version_string(void)
{
static const char* version_string = VERSION;
return version_string;
}
const char* get_bt_program_name(void)
{
static const char* bt_program_name = PROGRAM_NAME "/" VERSION;
return bt_program_name;
}
/*=========================================================================
* Timer functions
*=========================================================================*/
#if defined( _WIN32) || defined(__CYGWIN__)
#define get_timedelta(delta) QueryPerformanceCounter((LARGE_INTEGER*)delta)
#else
#define get_timedelta(delta) gettimeofday(delta, NULL)
#endif
void rsh_timer_start(timedelta_t* timer)
{
get_timedelta(timer);
}
uint64_t rsh_timer_stop(timedelta_t* timer)
{
timedelta_t end;
#if defined( _WIN32) || defined(__CYGWIN__)
LARGE_INTEGER frequency;
get_timedelta(&end);
*timer = end - *timer;
QueryPerformanceFrequency(&frequency);
return (uint64_t)((LONGLONG)(*timer) * 1000 / frequency.QuadPart);
#else
get_timedelta(&end);
timer->tv_sec = end.tv_sec - timer->tv_sec - (end.tv_usec >= timer->tv_usec ? 0 : 1);
timer->tv_usec = end.tv_usec + (end.tv_usec >= timer->tv_usec ? 0 : 1000000 ) - timer->tv_usec;
return ((uint64_t)(timer->tv_sec) * 1000 + timer->tv_usec / 1000);
#endif
}
unsigned rhash_get_ticks(void)
{
#if defined( _WIN32) || defined(__CYGWIN__)
return GetTickCount();
#else
struct timeval tv;
gettimeofday(&tv, NULL);
return (tv.tv_sec * 1000 + tv.tv_usec / 1000);
#endif
}
/*=========================================================================
* Custom program exit function
*=========================================================================*/
struct rhash_exit_handlers_t
{
unsigned handlers_count;
exit_handler_t handlers[4];
} rhash_exit_handlers = { 0, { 0 } };
/**
* Install a handler to be called on program exit.
*
* @param handler the hadler to add
*/
void rsh_install_exit_handler(exit_handler_t handler)
{
if (rhash_exit_handlers.handlers_count >= (sizeof(rhash_exit_handlers.handlers) / sizeof(rhash_exit_handlers.handlers[0])))
{
assert(!"to many handlers");
rsh_exit(2);
}
rhash_exit_handlers.handlers[rhash_exit_handlers.handlers_count] = handler;
rhash_exit_handlers.handlers_count++;
}
/**
* Remove the last installed exit handler.
*/
void rsh_remove_exit_handler(void)
{
if (rhash_exit_handlers.handlers_count == 0)
{
assert(rhash_exit_handlers.handlers_count > 0 && "no handlers installed");
rsh_exit(2);
}
rhash_exit_handlers.handlers_count--;
}
/**
* Call all installed exit handlers, starting from the latest one.
*
* @param code the program exit code
*/
void rsh_call_exit_handlers(void)
{
while (rhash_exit_handlers.handlers_count > 0)
rhash_exit_handlers.handlers[--rhash_exit_handlers.handlers_count]();
}
/**
* Call all installed exit handlers and exit the program.
*
* @param code the program exit code
*/
void rsh_exit(int code)
{
rsh_call_exit_handlers();
exit(code);
}
/*=========================================================================
* Error reporting functions
*=========================================================================*/
static void report_error_default(const char* srcfile, int srcline,
const char* format, ...);
void (*rsh_report_error)(const char* srcfile, int srcline,
const char* format, ...) = report_error_default;
/**
* Print given library failure to stderr.
*
* @param srcfile source file to report error on fail
* @param srcline source code line to be reported on fail
* @param format printf-formatted error message
*/
static void report_error_default(const char* srcfile, int srcline, const char* format, ...)
{
va_list ap;
rsh_fprintf(stderr, "RHash: error at %s:%u: ", srcfile, srcline);
va_start(ap, format);
rsh_vfprintf(stderr, format, ap); /* report the error to stderr */
va_end(ap);
}
/*=========================================================================
* Memory functions
*=========================================================================*/
/**
* Allocates a buffer via malloc with reporting memory error to stderr.
*
* @param size size of the block to allocate
* @param srcfile source file to report error on fail
* @param srcline source code line to be reported on fail
* @return allocated block
*/
void* rhash_malloc(size_t size, const char* srcfile, int srcline)
{
void* res = malloc(size);
if (!res) {
rsh_report_error(srcfile, srcline, "%s(%u) failed\n", "malloc", (unsigned)size);
rsh_exit(2);
}
return res;
}
/**
* Allocates a buffer via calloc with reporting memory error to stderr.
*
* @param num number of elements to be allocated
* @param size size of elements
* @param srcfile source file to report error on fail
* @param srcline source code line to be reported on fail
* @return allocated block
*/
void* rhash_calloc(size_t num, size_t size, const char* srcfile, int srcline)
{
void* res = calloc(num, size);
if (!res) {
rsh_report_error(srcfile, srcline, "calloc(%u, %u) failed\n", (unsigned)num, (unsigned)size);
rsh_exit(2);
}
return res;
}
/**
* Duplicate c-string with reporting memory error to stderr.
*
* @param str the zero-terminated string to duplicate
* @param srcfile source file to report error on fail
* @param srcline source code line to be reported on fail
* @return allocated memory buffer with copied string
*/
char* rhash_strdup(const char* str, const char* srcfile, int srcline)
{
#ifndef __STRICT_ANSI__
char* res = strdup(str);
#else
char* res = (char*)malloc(strlen(str)+1);
if (res) strcpy(res, str);
#endif
if (!res) {
rsh_report_error(srcfile, srcline, "strdup(\"%s\") failed\n", str);
rsh_exit(2);
}
return res;
}
#ifdef _WIN32
/**
* Duplicate wide string with reporting memory error to stderr.
*
* @param str the zero-terminated string to duplicate
* @param srcfile source file to report error on fail
* @param srcline source code line to be reported on fail
* @return allocated memory buffer with copied string
*/
wchar_t* rhash_wcsdup(const wchar_t* str, const char* srcfile, int srcline)
{
#ifndef __STRICT_ANSI__
wchar_t* res = wcsdup(str);
#else
wchar_t* res = (wchar_t*)malloc((wcslen(str) + 1) * sizeof(wchar_t));
if (res) wcscpy(res, str);
#endif
if (!res) {
rsh_report_error(srcfile, srcline, "wcsdup(\"%u\") failed\n", (wcslen(str) + 1));
rsh_exit(2);
}
return res;
}
#endif
/**
* Reallocates a buffer via realloc with reporting memory error to stderr.
*
* @param mem a memory block to re-allocate
* @param size the new size of the block
* @param srcfile source file to report error on fail
* @param srcline source code line to be reported on fail
* @return re-allocated memory buffer
*/
void* rhash_realloc(void* mem, size_t size, const char* srcfile, int srcline)
{
void* res = realloc(mem, size);
if (!res) {
rsh_report_error(srcfile, srcline, "realloc(%p, %u) failed\n", mem, (unsigned)size);
rsh_exit(2);
}
return res;
}
/*=========================================================================
* Containers
*=========================================================================*/
/**
* Allocate an empty vector.
*
* @param destructor pointer to the cleanup/deallocate function called
* on each element when the vector is destructed,
* NULL if items doesn't need to be freed
* @return allocated vector
*/
vector_t* rsh_vector_new(void (*destructor)(void*))
{
vector_t* ptr = (vector_t*)rsh_malloc(sizeof(vector_t));
memset(ptr, 0, sizeof(vector_t));
ptr->destructor = destructor;
return ptr;
}
/**
* Allocate an empty vector of pointers to memory blocks,
* which will be deallocated at destruction time by calling free().
*
* @return allocated vector
*/
struct vector_t* rsh_vector_new_simple(void)
{
return rsh_vector_new(free);
}
/**
* Release memory allocated by vector, but the vector structure itself.
*
* @param vect the vector to free
*/
void rsh_vector_destroy(vector_t* vect)
{
if (!vect) return;
if (vect->destructor) {
unsigned i;
for (i = 0; i < vect->size; i++) vect->destructor(vect->array[i]);
}
free(vect->array);
vect->size = vect->allocated = 0;
vect->array = 0;
}
/**
* Release all memory allocated by vector.
*
* @param vect the vector to free
*/
void rsh_vector_free(vector_t* vect)
{
rsh_vector_destroy(vect);
free(vect);
}
/**
* Add an item to vector.
*
* @param vect vector to add item to
* @param item the item to add
*/
void rsh_vector_add_ptr(vector_t* vect, void* item)
{
/* check if vect contains enough space for the next item */
if (vect->size >= vect->allocated) {
size_t size = (vect->allocated == 0 ? 128 : vect->allocated * 2);
vect->array = (void**)rsh_realloc(vect->array, size * sizeof(void*));
vect->allocated = size;
}
/* add new item to the vector */
vect->array[vect->size] = item;
vect->size++;
}
/**
* Add a sized item to vector.
*
* @param vect pointer to the vector to add item to
* @param item_size the size of a vector item
*/
void rsh_vector_add_empty(struct vector_t* vect, size_t item_size)
{
/* check if vect contains enough space for next item */
if (vect->size >= vect->allocated) {
size_t size = (vect->allocated == 0 ? 128 : vect->allocated * 2);
vect->array = (void**)rsh_realloc(vect->array, size * item_size);
vect->allocated = size;
}
vect->size++;
}
/**
* Initialize empty blocks vector.
*
* @param bvector pointer to the blocks vector
*/
void rsh_blocks_vector_init(blocks_vector_t* bvector)
{
memset(bvector, 0, sizeof(*bvector));
bvector->blocks.destructor = free;
}
/**
* Free memory allocated by blocks vector, the function
* doesn't deallocate memory additionally allocated for each element.
*
* @param bvector pointer to the blocks vector
*/
void rsh_blocks_vector_destroy(blocks_vector_t* bvector)
{
rsh_vector_destroy(&bvector->blocks);
}
/*=========================================================================
* String buffer functions
*=========================================================================*/
/**
* Allocate an empty string buffer.
*
* @return allocated string buffer
*/
strbuf_t* rsh_str_new(void)
{
strbuf_t* res = (strbuf_t*)rsh_malloc(sizeof(strbuf_t));
memset(res, 0, sizeof(strbuf_t));
return res;
}
/**
* Free memory allocated by string buffer object
*
* @param ptr pointer to the string buffer to destroy
*/
void rsh_str_free(strbuf_t* ptr)
{
if (ptr) {
free(ptr->str);
free(ptr);
}
}
/**
* Grow, if needed, internal buffer of the given string to ensure it contains
* at least new_size number bytes.
*
* @param str pointer to the string-buffer object
* @param new_size number of bytes buffer must contain
*/
void rsh_str_ensure_size(strbuf_t* str, size_t new_size)
{
if (new_size >= (size_t)str->allocated) {
if (new_size < 64) new_size = 64;
str->str = (char*)rsh_realloc(str->str, new_size);
str->allocated = new_size;
}
}
/**
* Append a sequence of single-byte characters of the specified length to
* string buffer. The array is fully copied even if it contains the '\\0'
* character. The function ensures the string buffer still contains
* null-terminated string.
*
* @param str pointer to the string buffer
* @param text the text to append
* @param length number of character to append
*/
void rsh_str_append_n(strbuf_t* str, const char* text, size_t length)
{
rsh_str_ensure_length(str, str->len + length + 1);
memcpy(str->str + str->len, text, length);
str->len += length;
str->str[str->len] = '\0';
}
/**
* Append a null-terminated string to the string string buffer.
*
* @param str pointer to the string buffer
* @param text the null-terminated string to append
*/
void rsh_str_append(strbuf_t* str, const char* text)
{
rsh_str_append_n(str, text, strlen(text));
}
|