~drizzle-trunk/drizzle/development

/*****************************************************************************

Copyright (c) 1994, 2009, Innobase Oy. All Rights Reserved.

Copyright (c) 2009, Sun Microsystems, Inc.

Portions of this file contain modifications contributed and copyrighted by

Sun Microsystems, Inc. Those modifications are gratefully acknowledged and

are described briefly in the InnoDB documentation. The contributions by

Sun Microsystems are incorporated with their permission, and subject to the

conditions contained in the file COPYING.Sun_Microsystems.

This program is free software; you can redistribute it and/or modify it under

the terms of the GNU General Public License as published by the Free Software

Foundation; version 2 of the License.

This program is distributed in the hope that it will be useful, but WITHOUT

ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS

FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with

this program; if not, write to the Free Software Foundation, Inc., 59 Temple

Place, Suite 330, Boston, MA 02111-1307 USA

*****************************************************************************/

/***************************************************************//**

@file ut/ut0ut.c

Various utilities for Innobase.

Created 5/11/1994 Heikki Tuuri

********************************************************************/

#include "ut0ut.h"

#ifdef UNIV_NONINL

#include "ut0ut.ic"

#endif

#include <stdarg.h>

#include <string.h>

#include <ctype.h>

#ifndef UNIV_HOTBACKUP

# include "trx0trx.h"

# if defined(BUILD_DRIZZLE)

#  include "drizzled/common.h"

#  if TIME_WITH_SYS_TIME

#   include <sys/time.h>

#   include <time.h>

#  else

#   if HAVE_SYS_TIME_H

#    include <sys/time.h>

#   else

#    include <time.h>

#   endif

#  endif

# else

#  include "ha_prototypes.h"

#  include "mysql_com.h" /* NAME_LEN */

# endif /* DRIZZLE */

#endif /* UNIV_HOTBACKUP */

#include <errno.h>

#include <assert.h>

/** A constant to prevent the compiler from optimizing ut_delay() away. */

UNIV_INTERN ibool	ut_always_false	= FALSE;

#ifdef __WIN__

/*****************************************************************//**

NOTE: The Windows epoch starts from 1601/01/01 whereas the Unix

epoch starts from 1970/1/1. For selection of constant see:

http://support.microsoft.com/kb/167296/ */

#define WIN_TO_UNIX_DELTA_USEC  ((ib_int64_t) 11644473600000000ULL)

/*****************************************************************//**

This is the Windows version of gettimeofday(2).

@return	0 if all OK else -1 */

static

int

ut_gettimeofday(

/*============*/

	struct timeval*	tv,	/*!< out: Values are relative to Unix epoch */

	void*		tz)	/*!< in: not used */

{

	FILETIME	ft;

	ib_int64_t	tm;

	if (!tv) {

		errno = EINVAL;

		return(-1);

	}

	GetSystemTimeAsFileTime(&ft);

	tm = (ib_int64_t) ft.dwHighDateTime << 32;

	tm |= ft.dwLowDateTime;

	ut_a(tm >= 0);	/* If tm wraps over to negative, the quotient / 10

			does not work */

	tm /= 10;	/* Convert from 100 nsec periods to usec */

	/* If we don't convert to the Unix epoch the value for

	struct timeval::tv_sec will overflow.*/

	tm -= WIN_TO_UNIX_DELTA_USEC;

	tv->tv_sec  = (long) (tm / 1000000L);

	tv->tv_usec = (long) (tm % 1000000L);

	return(0);

}

#else

/** An alias for gettimeofday(2).  On Microsoft Windows, we have to

reimplement this function. */

#define	ut_gettimeofday		gettimeofday

#endif

/********************************************************//**

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.

@return	a >> 32 */

UNIV_INTERN

ulint

ut_get_high32(

/*==========*/

	ulint	a)	/*!< in: ulint */

{

	ib_int64_t	i;

	i = (ib_int64_t)a;

	i = i >> 32;

	return((ulint)i);

}

/**********************************************************//**

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.

@return	system time */

UNIV_INTERN

ib_time_t

ut_time(void)

/*=========*/

{

	return(time(NULL));

}

/**********************************************************//**

Returns system time.

Upon successful completion, the value 0 is returned; otherwise the

value -1 is returned and the global variable errno is set to indicate the

error.

@return	0 on success, -1 otherwise */

UNIV_INTERN

int

ut_usectime(

/*========*/

	ulint*	sec,	/*!< out: seconds since the Epoch */

	ulint*	ms)	/*!< out: microseconds since the Epoch+*sec */

{

	struct timeval	tv;

	int		ret;

	int		errno_gettimeofday;

	int		i;

	for (i = 0; i < 10; i++) {

		ret = ut_gettimeofday(&tv, NULL);

		if (ret == -1) {

			errno_gettimeofday = errno;

			ut_print_timestamp(stderr);

			fprintf(stderr, "  InnoDB: gettimeofday(): %s\n",

				strerror(errno_gettimeofday));

			os_thread_sleep(100000);  /* 0.1 sec */

			errno = errno_gettimeofday;

		} else {

			break;

		}

	}

	if (ret != -1) {

		*sec = (ulint) tv.tv_sec;

		*ms  = (ulint) tv.tv_usec;

	}

	return(ret);

}

/**********************************************************//**

Returns the number of microseconds since epoch. Similar to

time(3), the return value is also stored in *tloc, provided

that tloc is non-NULL.

@return	us since epoch */

UNIV_INTERN

ullint

ut_time_us(

/*=======*/

	ullint*	tloc)	/*!< out: us since epoch, if non-NULL */

{

	struct timeval	tv;

	ullint		us;

	ut_gettimeofday(&tv, NULL);

	us = (ullint) tv.tv_sec * 1000000 + tv.tv_usec;

	if (tloc != NULL) {

		*tloc = us;

	}

	return(us);

}

/**********************************************************//**

Returns the difference of two times in seconds.

@return	time2 - time1 expressed in seconds */

UNIV_INTERN

double

ut_difftime(

/*========*/

	ib_time_t	time2,	/*!< in: time */

	ib_time_t	time1)	/*!< in: time */

{

	return(difftime(time2, time1));

}

/**********************************************************//**

Prints a timestamp to a file. */

UNIV_INTERN

void

ut_print_timestamp(

/*===============*/

	FILE*  file) /*!< in: file where to print */

{

#ifdef __WIN__

	SYSTEMTIME cal_tm;

	GetLocalTime(&cal_tm);

	fprintf(file,"%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

	fprintf(file,"%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

}

/**********************************************************//**

Sprintfs a timestamp to a buffer, 13..14 chars plus terminating NUL. */

UNIV_INTERN

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

}

#ifdef UNIV_HOTBACKUP

/**********************************************************//**

Sprintfs a timestamp to a buffer with no spaces and with ':' characters

replaced by '_'. */

UNIV_INTERN

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

}

/**********************************************************//**

Returns current year, month, day. */

UNIV_INTERN

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;

	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

	*year = (ulint)cal_tm_ptr->tm_year + 1900;

	*month = (ulint)cal_tm_ptr->tm_mon + 1;

	*day = (ulint)cal_tm_ptr->tm_mday;

#endif

}

#endif /* UNIV_HOTBACKUP */

#ifndef UNIV_HOTBACKUP

/*************************************************************//**

Runs an idle loop on CPU. The argument gives the desired delay

in microseconds on 100 MHz Pentium + Visual C++.

@return	dummy value */

UNIV_INTERN

ulint

ut_delay(

/*=====*/

	ulint	delay)	/*!< in: delay in microseconds on 100 MHz Pentium */

{

	ulint	i, j;

	j = 0;

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

		j += i;

		UT_RELAX_CPU();

	}

	if (ut_always_false) {

		ut_always_false = (ibool) j;

	}

	return(j);

}

#endif /* !UNIV_HOTBACKUP */

/*************************************************************//**

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

UNIV_INTERN

void

ut_print_buf(

/*=========*/

	FILE*		file,	/*!< in: file where to print */

	const void*	buf,	/*!< in: memory buffer */

	ulint		len)	/*!< in: length of the buffer */

{

	const byte*	data;

	ulint		i;

	UNIV_MEM_ASSERT_RW(buf, len);

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

	for (data = (const byte*)buf, i = 0; i < len; i++) {

		fprintf(file, "%02lx", (ulong)*data++);

	}

	fputs("; asc ", file);

	data = (const byte*)buf;

	for (i = 0; i < len; i++) {

		int	c = (int) *data++;

		putc(isprint(c) ? c : ' ', file);

	}

	putc(';', file);

}

/*************************************************************//**

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

@return	first power of 2 which is >= n */

UNIV_INTERN

ulint

ut_2_power_up(

/*==========*/

	ulint	n)	/*!< in: number != 0 */

{

	ulint	res;

	res = 1;

	ut_ad(n > 0);

	while (res < n) {

		res = res * 2;

	}

	return(res);

}

/**********************************************************************//**

Outputs a NUL-terminated file name, quoted with apostrophes. */

UNIV_INTERN

void

ut_print_filename(

/*==============*/

	FILE*		f,	/*!< in: output stream */

	const char*	name)	/*!< in: name to print */

{

	putc('\'', f);

	for (;;) {

		int	c = *name++;

		switch (c) {

		case 0:

			goto done;

		case '\'':

			putc(c, f);

			/* fall through */

		default:

			putc(c, f);

		}

	}

done:

	putc('\'', f);

}

#ifndef UNIV_HOTBACKUP

/**********************************************************************//**

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

If the string contains a slash '/', the string will be

output as two identifiers separated by a period (.),

as in SQL database_name.identifier. */

UNIV_INTERN

void

ut_print_name(

/*==========*/

	FILE*		f,	/*!< in: output stream */

	trx_t*		trx,	/*!< in: transaction */

	ibool		table_id,/*!< in: TRUE=print a table name,

				FALSE=print other identifier */

	const char*	name)	/*!< in: name to print */

{

	ut_print_namel(f, trx, table_id, name, strlen(name));

}

/**********************************************************************//**

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

If the string contains a slash '/', the string will be

output as two identifiers separated by a period (.),

as in SQL database_name.identifier. */

UNIV_INTERN

void

ut_print_namel(

/*===========*/

	FILE*		f,	/*!< in: output stream */

	trx_t*		trx,	/*!< in: transaction (NULL=no quotes) */

	ibool		table_id,/*!< in: TRUE=print a table name,

				FALSE=print other identifier */

	const char*	name,	/*!< in: name to print */

	ulint		namelen)/*!< in: length of name */

{

	/* 2 * NAME_LEN for database and table name,

	and some slack for the #mysql50# prefix and quotes */

	char		buf[3 * NAME_LEN];

	const char*	bufend;

	bufend = innobase_convert_name(buf, sizeof buf,

				       name, namelen,

				       trx ? trx->mysql_thd : NULL,

				       table_id);

	ssize_t ret= fwrite(buf, 1, bufend - buf, f);

	assert(ret==bufend-buf);  

}

/**********************************************************************//**

Catenate files. */

UNIV_INTERN

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);

		size_t ret= fwrite(buf, 1, size, dest);

		assert(ret==size);

		len -= (long) size;

		if (size < maxs) {

			break;

		}

	} while (len > 0);

}

#endif /* !UNIV_HOTBACKUP */

#ifdef __WIN__

# include <stdarg.h>

/**********************************************************************//**

A substitute for snprintf(3), formatted output conversion into

a limited buffer.

@return number of characters that would have been printed if the size

were unlimited, not including the terminating '\0'. */

UNIV_INTERN

int

ut_snprintf(

/*========*/

	char*		str,	/*!< out: string */

	size_t		size,	/*!< in: str size */

	const char*	fmt,	/*!< in: format */

	...)			/*!< in: format values */

{

	int	res;

	va_list	ap1;

	va_list	ap2;

	va_start(ap1, fmt);

	va_start(ap2, fmt);

	res = _vscprintf(fmt, ap1);

	ut_a(res != -1);

	if (size > 0) {

		_vsnprintf(str, size, fmt, ap2);

		if ((size_t) res >= size) {

			str[size - 1] = '\0';

		}

	}

	va_end(ap1);

	va_end(ap2);

	return(res);

}

#endif /* __WIN__ */