ut0ut.c 12.8 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14
/*******************************************************************
Various utilities for Innobase.

(c) 1994, 1995 Innobase Oy

Created 5/11/1994 Heikki Tuuri
********************************************************************/

#include "ut0ut.h"

#ifdef UNIV_NONINL
#include "ut0ut.ic"
#endif

15
#include <stdarg.h>
unknown's avatar
unknown committed
16
#include <string.h>
17

18 19 20 21
#include "ut0sort.h"

ibool	ut_always_false	= FALSE;

22 23 24 25 26 27 28 29 30 31
/*********************************************************************
Get the quote character to be used in SQL identifiers.
This definition must match the one in sql/ha_innodb.cc! */

char
mysql_get_identifier_quote_char(void);
/*=================================*/
				/* out: quote character to be
				used in SQL identifiers */

32
/************************************************************
unknown's avatar
unknown committed
33 34 35 36 37
On the 64-bit Windows we substitute the format string
%l -> %I64
because we define ulint as unsigned __int64 and lint as __int64 on Windows,
and both the Microsoft and Intel C compilers require the format string
%I64 in that case instead of %l. */
38

unknown's avatar
unknown committed
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
int
ut_printf(
/*======*/
			     /* out: the number of characters written, or
			     negative in case of an error */
        const char* format,  /* in: format of prints */
        ...)                 /* in: arguments to be printed */
{
        va_list	args;
	ulint	len;
	char*	format_end;
	char*	newformat;	
	char*	ptr;
	char*	newptr;
	int	ret;
	char	format_buf_in_stack[500];

	len = strlen(format);

	if (len > 250) {
		newformat = malloc(2 * len);
	} else {
		newformat = format_buf_in_stack;
	}

	format_end = (char*)format + len;

	ptr = (char*)format;
	newptr = newformat;

#if defined(__WIN__) && (defined(WIN64) || defined(_WIN64))
	/* Replace %l with %I64 if it is not preceded with '\' */

	while (ptr < format_end) {
		if (*ptr == '%' && *(ptr + 1) == 'l'
		    && (ptr == format || *(ptr - 1) != '\\')) {
			
			memcpy(newptr, "%I64", 4);
			ptr += 2;
			newptr += 4;
		} else {
			*newptr = *ptr;
			ptr++;
			newptr++;
		}
	}

	*newptr = '\0';
	
	ut_a(newptr < newformat + 2 * len);
#else
	strcpy(newformat, format);
#endif
        va_start(args, format);

        ret = vprintf((const char*)newformat, args);

        va_end(args);

	if (newformat != format_buf_in_stack) {
		free(newformat);
	}

        return(ret);
}

/************************************************************
On the 64-bit Windows we substitute the format string
%l -> %I64
because we define ulint as unsigned __int64 and lint as __int64 on Windows,
and both the Microsoft and Intel C compilers require the format string
%I64 in that case instead of %l. */

int
113 114
ut_sprintf(
/*=======*/
unknown's avatar
unknown committed
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
			     /* out: the number of characters written, or
			     negative in case of an error */
	char*	    buf,     /* in: buffer where to print */
        const char* format,  /* in: format of prints */
        ...)                 /* in: arguments to be printed */
{
        va_list	args;
	ulint	len;
	char*	format_end;
	char*	newformat;	
	char*	ptr;
	char*	newptr;
	int	ret;
	char	format_buf_in_stack[500];

	len = strlen(format);

	if (len > 250) {
		newformat = malloc(2 * len);
	} else {
		newformat = format_buf_in_stack;
	}

	format_end = (char*)format + len;

	ptr = (char*)format;
	newptr = newformat;

#if defined(__WIN__) && (defined(WIN64) || defined(_WIN64))
	/* Replace %l with %I64 if it is not preceded with '\' */

	while (ptr < format_end) {
		if (*ptr == '%' && *(ptr + 1) == 'l'
		    && (ptr == format || *(ptr - 1) != '\\')) {
			
			memcpy(newptr, "%I64", 4);
			ptr += 2;
			newptr += 4;
		} else {
			*newptr = *ptr;
			ptr++;
			newptr++;
		}
	}

	*newptr = '\0';
	
	ut_a(newptr < newformat + 2 * len);
#else
	strcpy(newformat, format);
#endif
        va_start(args, format);

        ret = vsprintf(buf, (const char*)newformat, args);

        va_end(args);

	if (newformat != format_buf_in_stack) {
		free(newformat);
	}

        return(ret);
}

/************************************************************
On the 64-bit Windows we substitute the format string
%l -> %I64
because we define ulint as unsigned __int64 and lint as __int64 on Windows,
and both the Microsoft and Intel C compilers require the format string
%I64 in that case instead of %l. */

int
ut_fprintf(
/*=======*/
			     /* out: the number of characters written, or
			     negative in case of an error */
	FILE*	    stream,  /* in: stream where to print */
192 193 194
        const char* format,  /* in: format of prints */
        ...)                 /* in: arguments to be printed */
{
unknown's avatar
unknown committed
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
        va_list	args;
	ulint	len;
	char*	format_end;
	char*	newformat;	
	char*	ptr;
	char*	newptr;
	int	ret;
	char	format_buf_in_stack[500];

	len = strlen(format);

	if (len > 250) {
		newformat = malloc(2 * len);
	} else {
		newformat = format_buf_in_stack;
	}

	format_end = (char*)format + len;

	ptr = (char*)format;
	newptr = newformat;

#if defined(__WIN__) && (defined(WIN64) || defined(_WIN64))
	/* Replace %l with %I64 if it is not preceded with '\' */

	while (ptr < format_end) {
		if (*ptr == '%' && *(ptr + 1) == 'l'
		    && (ptr == format || *(ptr - 1) != '\\')) {
			
			memcpy(newptr, "%I64", 4);
			ptr += 2;
			newptr += 4;
		} else {
			*newptr = *ptr;
			ptr++;
			newptr++;
		}
	}

	*newptr = '\0';
	
	ut_a(newptr < newformat + 2 * len);
#else
	strcpy(newformat, format);
#endif
240 241
        va_start(args, format);

unknown's avatar
unknown committed
242
        ret = vfprintf(stream, (const char*)newformat, args);
243 244 245

        va_end(args);

unknown's avatar
unknown committed
246 247 248 249 250
	if (newformat != format_buf_in_stack) {
		free(newformat);
	}

        return(ret);
251 252
}

unknown's avatar
unknown committed
253 254 255 256 257 258 259 260 261 262 263
/************************************************************
Gets the high 32 bits in a ulint. That is makes a shift >> 32,
but since there seem to be compiler bugs in both gcc and Visual C++,
we do this by a special conversion. */

ulint
ut_get_high32(
/*==========*/
			/* out: a >> 32 */
	ulint	a)	/* in: ulint */
{
264
#if SIZEOF_LONG == 4
unknown's avatar
unknown committed
265 266
	UT_NOT_USED(a);

267 268
	return 0;
#else
unknown's avatar
unknown committed
269
	return(a >> 32);
270
#endif
unknown's avatar
unknown committed
271 272
}

273
/************************************************************
unknown's avatar
unknown committed
274
The following function returns elapsed CPU time in milliseconds. */
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

ulint
ut_clock(void)
{
	return((clock() * 1000) / CLOCKS_PER_SEC);
}

/**************************************************************
Returns system time. We do not specify the format of the time returned:
the only way to manipulate it is to use the function ut_difftime. */

ib_time_t
ut_time(void)
/*=========*/
{
	return(time(NULL));
}

/**************************************************************
Returns the difference of two times in seconds. */

double
ut_difftime(
/*========*/
				/* out: time2 - time1 expressed in seconds */
	ib_time_t	time2,	/* in: time */
	ib_time_t	time1)	/* in: time */
{
	return(difftime(time2, time1));
}

306 307 308 309 310 311 312 313
/**************************************************************
Prints a timestamp to a file. */

void
ut_print_timestamp(
/*===============*/
	FILE*  file) /* in: file where to print */
{
314
#ifdef __WIN__
unknown's avatar
unknown committed
315
  	SYSTEMTIME cal_tm;
316

unknown's avatar
unknown committed
317
  	GetLocalTime(&cal_tm);
318

unknown's avatar
unknown committed
319
  	fprintf(file,"%02d%02d%02d %2d:%02d:%02d",
320 321 322 323 324 325 326
	  (int)cal_tm.wYear % 100,
	  (int)cal_tm.wMonth,
	  (int)cal_tm.wDay,
	  (int)cal_tm.wHour,
	  (int)cal_tm.wMinute,
	  (int)cal_tm.wSecond);
#else
unknown's avatar
unknown committed
327 328 329
	struct tm  cal_tm;
  	struct tm* cal_tm_ptr;
  	time_t     tm;
330

unknown's avatar
unknown committed
331
  	time(&tm);
332

333
#ifdef HAVE_LOCALTIME_R
unknown's avatar
unknown committed
334 335
  	localtime_r(&tm, &cal_tm);
  	cal_tm_ptr = &cal_tm;
336
#else
unknown's avatar
unknown committed
337
  	cal_tm_ptr = localtime(&tm);
338
#endif
unknown's avatar
unknown committed
339
  	fprintf(file,"%02d%02d%02d %2d:%02d:%02d",
340
	  cal_tm_ptr->tm_year % 100,
unknown's avatar
unknown committed
341
	  cal_tm_ptr->tm_mon + 1,
342 343 344 345
	  cal_tm_ptr->tm_mday,
	  cal_tm_ptr->tm_hour,
	  cal_tm_ptr->tm_min,
	  cal_tm_ptr->tm_sec);
346
#endif
347 348
}

unknown's avatar
unknown committed
349
/**************************************************************
350
Sprintfs a timestamp to a buffer, 13..14 chars plus terminating NUL. */
unknown's avatar
unknown committed
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

void
ut_sprintf_timestamp(
/*=================*/
	char*	buf) /* in: buffer where to sprintf */
{
#ifdef __WIN__
  	SYSTEMTIME cal_tm;

  	GetLocalTime(&cal_tm);

  	sprintf(buf, "%02d%02d%02d %2d:%02d:%02d",
	  (int)cal_tm.wYear % 100,
	  (int)cal_tm.wMonth,
	  (int)cal_tm.wDay,
	  (int)cal_tm.wHour,
	  (int)cal_tm.wMinute,
	  (int)cal_tm.wSecond);
#else
	struct tm  cal_tm;
  	struct tm* cal_tm_ptr;
  	time_t     tm;

  	time(&tm);

#ifdef HAVE_LOCALTIME_R
  	localtime_r(&tm, &cal_tm);
  	cal_tm_ptr = &cal_tm;
#else
  	cal_tm_ptr = localtime(&tm);
#endif
  	sprintf(buf, "%02d%02d%02d %2d:%02d:%02d",
	  cal_tm_ptr->tm_year % 100,
	  cal_tm_ptr->tm_mon + 1,
	  cal_tm_ptr->tm_mday,
	  cal_tm_ptr->tm_hour,
	  cal_tm_ptr->tm_min,
	  cal_tm_ptr->tm_sec);
#endif
}

unknown's avatar
unknown committed
392
/**************************************************************
unknown's avatar
unknown committed
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
Sprintfs a timestamp to a buffer with no spaces and with ':' characters
replaced by '_'. */

void
ut_sprintf_timestamp_without_extra_chars(
/*=====================================*/
	char*	buf) /* in: buffer where to sprintf */
{
#ifdef __WIN__
  	SYSTEMTIME cal_tm;

  	GetLocalTime(&cal_tm);

  	sprintf(buf, "%02d%02d%02d_%2d_%02d_%02d",
	  (int)cal_tm.wYear % 100,
	  (int)cal_tm.wMonth,
	  (int)cal_tm.wDay,
	  (int)cal_tm.wHour,
	  (int)cal_tm.wMinute,
	  (int)cal_tm.wSecond);
#else
	struct tm  cal_tm;
  	struct tm* cal_tm_ptr;
  	time_t     tm;

  	time(&tm);

#ifdef HAVE_LOCALTIME_R
  	localtime_r(&tm, &cal_tm);
  	cal_tm_ptr = &cal_tm;
#else
  	cal_tm_ptr = localtime(&tm);
#endif
  	sprintf(buf, "%02d%02d%02d_%2d_%02d_%02d",
	  cal_tm_ptr->tm_year % 100,
	  cal_tm_ptr->tm_mon + 1,
	  cal_tm_ptr->tm_mday,
	  cal_tm_ptr->tm_hour,
	  cal_tm_ptr->tm_min,
	  cal_tm_ptr->tm_sec);
#endif
}

/**************************************************************
unknown's avatar
unknown committed
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
Returns current year, month, day. */

void
ut_get_year_month_day(
/*==================*/
	ulint*	year,	/* out: current year */
	ulint*	month,	/* out: month */
	ulint*	day)	/* out: day */
{
#ifdef __WIN__
  	SYSTEMTIME cal_tm;

  	GetLocalTime(&cal_tm);

  	*year = (ulint)cal_tm.wYear;
  	*month = (ulint)cal_tm.wMonth;
  	*day = (ulint)cal_tm.wDay;
#else
  	struct tm* cal_tm_ptr;
  	time_t     tm;

  	time(&tm);

  	cal_tm_ptr = localtime(&tm);

unknown's avatar
unknown committed
462
  	*year = (ulint)cal_tm_ptr->tm_year + 1900;
unknown's avatar
unknown committed
463 464 465 466 467
  	*month = (ulint)cal_tm_ptr->tm_mon + 1;
  	*day = (ulint)cal_tm_ptr->tm_mday;
#endif
}

468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486
/*****************************************************************
Runs an idle loop on CPU. The argument gives the desired delay
in microseconds on 100 MHz Pentium + Visual C++. */

ulint
ut_delay(
/*=====*/
			/* out: dummy value */
	ulint	delay)	/* in: delay in microseconds on 100 MHz Pentium */
{
	ulint	i, j;

	j = 0;

	for (i = 0; i < delay * 50; i++) {
		j += i;
	}

	if (ut_always_false) {
487
		ut_always_false = (ibool) j;
488 489 490 491 492 493 494 495 496 497 498
	}
	
	return(j);
}	

/*****************************************************************
Prints the contents of a memory buffer in hex and ascii. */

void
ut_print_buf(
/*=========*/
499 500 501
	FILE*		file,	/* in: file where to print */
	const byte*	buf,	/* in: memory buffer */
	ulint		len)	/* in: length of the buffer */
502
{
503 504
	const byte*	data;
	ulint		i;
505

506
	fprintf(file, " len %lu; hex ", len);
507

508
	for (data = buf, i = 0; i < len; i++) {
unknown's avatar
unknown committed
509
		fprintf(file, "%02lx", (ulong)*data++);
510 511
	}

512
	fputs("; asc ", file);
513 514 515 516

	data = buf;

	for (i = 0; i < len; i++) {
517 518
		int	c = (int) *data++;
		putc(isprint(c) ? c : ' ', file);
519 520
	}

521
	putc(';', file);
522 523 524 525 526 527 528 529 530 531 532 533
}

/****************************************************************
Sort function for ulint arrays. */

void
ut_ulint_sort(ulint* arr, ulint* aux_arr, ulint low, ulint high)
/*============================================================*/
{
	UT_SORT_FUNCTION_BODY(ut_ulint_sort, arr, aux_arr, low, high,
								ut_ulint_cmp);
}
unknown's avatar
unknown committed
534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556

/*****************************************************************
Calculates fast the number rounded up to the nearest power of 2. */

ulint
ut_2_power_up(
/*==========*/
			/* out: first power of 2 which is >= n */
	ulint	n)	/* in: number != 0 */
{
	ulint	res;

	res = 1;

	ut_ad(n > 0);

	while (res < n) {
		res = res * 2;
	}

	return(res);
}

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

/**************************************************************************
Outputs a NUL-terminated string, quoted as an SQL identifier. */

void
ut_print_name(
/*==========*/
	FILE*		f,	/* in: output stream */
	const char*	name)	/* in: name to print */
{
	ut_print_namel(f, name, strlen(name));
}

/**************************************************************************
Outputs a fixed-length string, quoted as an SQL identifier. */

void
ut_print_namel(
/*==========*/
	FILE*		f,	/* in: output stream */
	const char*	name,	/* in: name to print */
	ulint		namelen)/* in: length of name */
{
	const char*	s = name;
	const char*	e = s + namelen;
	char		q = mysql_get_identifier_quote_char();
	putc(q, f);
	while (s < e) {
		int	c = *s++;
		if (c == q) {
			putc(c, f);
		}
		putc(c, f);
	}
	putc(q, f);
}

/**************************************************************************
Catenate files. */

void
ut_copy_file(
/*=========*/
	FILE*	dest,	/* in: output file */
	FILE*	src)	/* in: input file to be appended to output */
{
	long	len = ftell(src);
	char	buf[4096];

	rewind(src);
	do {
		size_t	maxs =
			len < (long) sizeof buf ? (size_t) len : sizeof buf;
		size_t	size = fread(buf, 1, maxs, src);
		fwrite(buf, 1, size, dest);
		len -= size;
		if (size < maxs) {
			break;
		}
	} while (len > 0);
}