#include "univ.i"
#include "db0err.h"
#include "os0sync.h"
#include <time.h>
#include <ctype.h>
Go to the source code of this file.
|
| UNIV_INTERN ulint | ut_get_high32 (ulint a) |
| UNIV_INLINE ulint | ut_min (ulint n1, ulint n2) |
| UNIV_INLINE ulint | ut_max (ulint n1, ulint n2) |
| UNIV_INLINE void | ut_pair_min (ulint *a, ulint *b, ulint a1, ulint b1, ulint a2, ulint b2) |
| UNIV_INLINE int | ut_ulint_cmp (ulint a, ulint b) |
| UNIV_INLINE int | ut_pair_cmp (ulint a1, ulint a2, ulint b1, ulint b2) |
| UNIV_INLINE ulint | ut_2_log (ulint n) |
| UNIV_INLINE ulint | ut_2_exp (ulint n) |
| UNIV_INTERN ulint | ut_2_power_up (ulint n) __attribute__((const)) |
| UNIV_INTERN ib_time_t | ut_time (void) |
| UNIV_INTERN int | ut_usectime (ulint *sec, ulint *ms) |
| UNIV_INTERN ullint | ut_time_us (ullint *tloc) |
| UNIV_INTERN ulint | ut_time_ms (void) |
| UNIV_INTERN double | ut_difftime (ib_time_t time2, ib_time_t time1) |
| UNIV_INTERN void | ut_print_timestamp (FILE *file) |
| UNIV_INTERN void | ut_sprintf_timestamp (char *buf) |
| UNIV_INTERN ulint | ut_delay (ulint delay) |
| UNIV_INTERN void | ut_print_buf (FILE *file, const void *buf, ulint len) |
| UNIV_INTERN void | ut_print_filename (FILE *f, const char *name) |
| UNIV_INTERN void | ut_print_name (FILE *f, struct trx_struct *trx, ibool table_id, const char *name) |
| UNIV_INTERN void | ut_print_namel (FILE *f, struct trx_struct *trx, ibool table_id, const char *name, ulint namelen) |
| UNIV_INTERN void | ut_copy_file (FILE *dest, FILE *src) |
| UNIV_INTERN const char * | ut_strerr (enum db_err num) |
Various utilities
Created 1/20/1994 Heikki Tuuri
Definition in file ut0ut.h.
◆ TEMP_INDEX_PREFIX
| #define TEMP_INDEX_PREFIX '\377' |
Index name prefix in fast index creation
Definition at line 51 of file ut0ut.h.
◆ TEMP_INDEX_PREFIX_STR
| #define TEMP_INDEX_PREFIX_STR "\377" |
Index name prefix in fast index creation, as a string constant
Definition at line 53 of file ut0ut.h.
◆ ut0ut_h
◆ ut_2pow_remainder
| #define ut_2pow_remainder |
( |
| n, |
|
|
| m ) |
Value:Calculates fast the remainder of n/m when m is a power of two.
- Parameters
-
| n | in: numerator |
| m | in: denominator, must be a power of two |
- Returns
- the remainder of n/m
Definition at line 168 of file ut0ut.h.
◆ ut_2pow_round
| #define ut_2pow_round |
( |
| n, |
|
|
| m ) |
Value:((n) & ~(typeof(n))((m) - 1))
Calculates the biggest multiple of m that is not bigger than n when m is a power of two. In other words, rounds n down to m * k.
- Parameters
-
| n | in: number to round down |
| m | in: alignment, must be a power of two |
- Returns
- n rounded down to the biggest possible integer multiple of m
Definition at line 175 of file ut0ut.h.
◆ UT_BITS_IN_BYTES
| #define UT_BITS_IN_BYTES |
( |
| b | ) |
|
Value:Determine how many bytes (groups of 8 bits) are needed to store the given number of bits.
- Parameters
-
- Returns
- number of bytes (octets) needed to represent b
Definition at line 219 of file ut0ut.h.
◆ ut_calc_align
| #define ut_calc_align |
( |
| n, |
|
|
| m ) |
Value:(((n) + ((m) - 1)) & ~(typeof(n))((m) - 1))
Calculates the smallest multiple of m that is not smaller than n when m is a power of two. In other words, rounds n up to m * k.
- Parameters
-
| n | in: number to round up |
| m | in: alignment, must be a power of two |
- Returns
- n rounded up to the smallest possible integer multiple of m
Definition at line 187 of file ut0ut.h.
◆ ut_calc_align_down
| #define ut_calc_align_down |
( |
| n, |
|
|
| m ) |
Value:
#define ut_2pow_round(n, m)
Align a number down to a multiple of a power of two.
- Parameters
-
| n | in: number to round down |
| m | in: alignment, must be a power of two |
- Returns
- n rounded down to the biggest possible integer multiple of m
Definition at line 180 of file ut0ut.h.
◆ ut_is_2pow
Value:UNIV_LIKELY(!((n) & ((n) - 1)))
Determines if a number is zero or a power of two.
- Parameters
-
- Returns
- nonzero if n is zero or a power of two; zero otherwise
Definition at line 162 of file ut0ut.h.
◆ UT_RELAX_CPU
Value: do { \
volatile lint volatile_var; \
if (os_compare_and_swap_lint(&volatile_var, 0, 1)) ((void)0); \
} while (0)
Definition at line 68 of file ut0ut.h.
◆ ut_snprintf
| #define ut_snprintf snprintf |
A wrapper for snprintf(3), formatted output conversion into a limited buffer.
Definition at line 398 of file ut0ut.h.
◆ UT_WAIT_FOR
| #define UT_WAIT_FOR |
( |
| cond, |
|
|
| max_wait_us ) |
Value:do { \
ullint start_us; \
while (!(cond) \
&&
ut_time_us(NULL) - start_us < (max_wait_us)) {\
\
os_thread_sleep(2000 ); \
} \
} while (0)
UNIV_INTERN ullint ut_time_us(ullint *tloc)
Delays execution for at most max_wait_us microseconds or returns earlier if cond becomes true.
- Parameters
-
| cond | in: condition to wait for; evaluated every 2 ms |
| max_wait_us | in: maximum delay to wait, in microseconds |
Definition at line 86 of file ut0ut.h.
◆ ib_time_t
Time stamp
Definition at line 56 of file ut0ut.h.
◆ ut_2_exp()
| UNIV_INLINE ulint ut_2_exp |
( |
ulint | n | ) |
|
Calculates 2 to power n.
- Returns
- 2 to power n in: number
◆ ut_2_log()
| UNIV_INLINE ulint ut_2_log |
( |
ulint | n | ) |
|
Calculates fast the 2-logarithm of a number, rounded upward to an integer.
- Returns
- logarithm in the base 2, rounded upward in: number
◆ ut_2_power_up()
| UNIV_INTERN ulint ut_2_power_up |
( |
ulint | n | ) |
const |
Calculates fast the number rounded up to the nearest power of 2.
- Returns
- first power of 2 which is >= n
- Parameters
-
◆ ut_copy_file()
| UNIV_INTERN void ut_copy_file |
( |
FILE * | dest, |
|
|
FILE * | src ) |
Catenate files. in: input file to be appended to output
Catenate files.
- Parameters
-
| dest | in: output file |
| src | in: input file to be appended to output |
Definition at line 565 of file ut0ut.cc.
◆ ut_delay()
| UNIV_INTERN ulint ut_delay |
( |
ulint | delay | ) |
|
Runs an idle loop on CPU. The argument gives the desired delay in microseconds on 100 MHz Pentium + Visual C++.
- Returns
- dummy value in: delay in microseconds on 100 MHz Pentium
Runs an idle loop on CPU. The argument gives the desired delay in microseconds on 100 MHz Pentium + Visual C++.
- Returns
- dummy value
- Parameters
-
| delay | in: delay in microseconds on 100 MHz Pentium |
Definition at line 411 of file ut0ut.cc.
◆ ut_difftime()
Returns the difference of two times in seconds.
- Returns
- time2 - time1 expressed in seconds in: time
Returns the difference of two times in seconds.
- Returns
- time2 - time1 expressed in seconds
- Parameters
-
| time2 | in: time |
| time1 | in: time |
Definition at line 227 of file ut0ut.cc.
◆ ut_get_high32()
| UNIV_INTERN ulint ut_get_high32 |
( |
ulint | a | ) |
|
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.
- Returns
- a >> 32 in: ulint
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.
- Returns
- a >> 32
- Parameters
-
Definition at line 111 of file ut0ut.cc.
◆ ut_max()
| UNIV_INLINE ulint ut_max |
( |
ulint | n1, |
|
|
ulint | n2 ) |
Calculates the maximum of two ulints.
- Returns
- maximum in: second number
- Parameters
-
◆ ut_min()
| UNIV_INLINE ulint ut_min |
( |
ulint | n1, |
|
|
ulint | n2 ) |
Calculates the minimum of two ulints.
- Returns
- minimum in: second number
- Parameters
-
◆ ut_pair_cmp()
| UNIV_INLINE int ut_pair_cmp |
( |
ulint | a1, |
|
|
ulint | a2, |
|
|
ulint | b1, |
|
|
ulint | b2 ) |
Compares two pairs of ulints.
- Returns
- -1 if a < b, 0 if a == b, 1 if a > b in: less significant part of second pair
- Parameters
-
| a1 | in: more significant part of first pair |
| a2 | in: less significant part of first pair |
| b1 | in: more significant part of second pair |
◆ ut_pair_min()
| UNIV_INLINE void ut_pair_min |
( |
ulint * | a, |
|
|
ulint * | b, |
|
|
ulint | a1, |
|
|
ulint | b1, |
|
|
ulint | a2, |
|
|
ulint | b2 ) |
Calculates minimum of two ulint-pairs. in: less significant part of second pair
- Parameters
-
| a | out: more significant part of minimum |
| b | out: less significant part of minimum |
| a1 | in: more significant part of first pair |
| b1 | in: less significant part of first pair |
| a2 | in: more significant part of second pair |
◆ ut_print_buf()
| UNIV_INTERN void ut_print_buf |
( |
FILE * | file, |
|
|
const void * | buf, |
|
|
ulint | len ) |
Prints the contents of a memory buffer in hex and ascii. in: length of the buffer
Prints the contents of a memory buffer in hex and ascii.
- Parameters
-
| file | in: file where to print |
| buf | in: memory buffer |
| len | in: length of the buffer |
Definition at line 436 of file ut0ut.cc.
◆ ut_print_filename()
| UNIV_INTERN void ut_print_filename |
( |
FILE * | f, |
|
|
const char * | name ) |
Outputs a NUL-terminated file name, quoted with apostrophes. in: name to print
Outputs a NUL-terminated file name, quoted with apostrophes.
- Parameters
-
| f | in: output stream |
| name | in: name to print |
Definition at line 491 of file ut0ut.cc.
◆ ut_print_name()
| UNIV_INTERN void ut_print_name |
( |
FILE * | f, |
|
|
trx_t * | trx, |
|
|
ibool | table_id, |
|
|
const char * | 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. in: name to print
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.
- Parameters
-
| f | in: output stream |
| trx | in: transaction |
| table_id | in: TRUE=print a table name, FALSE=print other identifier |
| name | in: name to print |
Definition at line 520 of file ut0ut.cc.
◆ ut_print_namel()
| UNIV_INTERN void ut_print_namel |
( |
FILE * | f, |
|
|
trx_t * | trx, |
|
|
ibool | table_id, |
|
|
const char * | name, |
|
|
ulint | namelen ) |
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. in: length of 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.
- Parameters
-
| f | in: output stream |
| trx | in: transaction (NULL=no quotes) |
| table_id | in: TRUE=print a table name, FALSE=print other identifier |
| name | in: name to print |
| namelen | in: length of name |
Definition at line 538 of file ut0ut.cc.
◆ ut_print_timestamp()
| UNIV_INTERN void ut_print_timestamp |
( |
FILE * | file | ) |
|
Prints a timestamp to a file. in: file where to print
Prints a timestamp to a file.
- Parameters
-
| file | in: file where to print |
Definition at line 239 of file ut0ut.cc.
◆ ut_sprintf_timestamp()
| UNIV_INTERN void ut_sprintf_timestamp |
( |
char * | buf | ) |
|
Sprintfs a timestamp to a buffer, 13..14 chars plus terminating NUL. in: buffer where to sprintf
Sprintfs a timestamp to a buffer, 13..14 chars plus terminating NUL.
- Parameters
-
| buf | in: buffer where to sprintf |
Definition at line 282 of file ut0ut.cc.
◆ ut_strerr()
| UNIV_INTERN const char * ut_strerr |
( |
enum db_err | num | ) |
|
Convert an error number to a human readable text message. The returned string is static and should not be freed or modified.
- Returns
- string, describing the error in: error number
Convert an error number to a human readable text message. The returned string is static and should not be freed or modified.
- Returns
- string, describing the error
- Parameters
-
Definition at line 636 of file ut0ut.cc.
◆ ut_time()
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.
- Returns
- system time
Definition at line 130 of file ut0ut.cc.
◆ ut_time_ms()
| UNIV_INTERN ulint ut_time_ms |
( |
void | | ) |
|
Returns the number of milliseconds since some epoch. The value may wrap around. It should only be used for heuristic purposes.
- Returns
- ms since epoch
Definition at line 211 of file ut0ut.cc.
◆ ut_time_us()
| UNIV_INTERN ullint ut_time_us |
( |
ullint * | tloc | ) |
|
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.
- Returns
- us since epoch out: us since epoch, if non-NULL
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.
- Returns
- us since epoch
- Parameters
-
| tloc | out: us since epoch, if non-NULL |
Definition at line 186 of file ut0ut.cc.
◆ ut_ulint_cmp()
| UNIV_INLINE int ut_ulint_cmp |
( |
ulint | a, |
|
|
ulint | b ) |
Compares two ulints.
- Returns
- 1 if a > b, 0 if a == b, -1 if a < b in: ulint
- Parameters
-
◆ ut_usectime()
| UNIV_INTERN int ut_usectime |
( |
ulint * | sec, |
|
|
ulint * | ms ) |
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.
- Returns
- 0 on success, -1 otherwise out: microseconds since the Epoch+*sec
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.
- Returns
- 0 on success, -1 otherwise
- Parameters
-
| sec | out: seconds since the Epoch |
| ms | out: microseconds since the Epoch+*sec |
Definition at line 145 of file ut0ut.cc.