1ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
2ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--------------------------------------------------------------------*/
3ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--- Standalone libc stuff.                   pub_tool_libcbase.h ---*/
4ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--------------------------------------------------------------------*/
5ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
6ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*
7ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   This file is part of Valgrind, a dynamic binary instrumentation
8ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   framework.
9ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
10663860b1408516d02ebfcb3a9999a134e6cfb223Ben Cheng   Copyright (C) 2000-2012 Julian Seward
11ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown      jseward@acm.org
12ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
13ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   This program is free software; you can redistribute it and/or
14ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   modify it under the terms of the GNU General Public License as
15ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   published by the Free Software Foundation; either version 2 of the
16ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   License, or (at your option) any later version.
17ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
18ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   This program is distributed in the hope that it will be useful, but
19ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   WITHOUT ANY WARRANTY; without even the implied warranty of
20ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
21ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   General Public License for more details.
22ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
23ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   You should have received a copy of the GNU General Public License
24ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   along with this program; if not, write to the Free Software
25ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
26ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   02111-1307, USA.
27ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
28ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   The GNU General Public License is contained in the file COPYING.
29ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown*/
30ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
31ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#ifndef __PUB_TOOL_LIBCBASE_H
32ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#define __PUB_TOOL_LIBCBASE_H
33ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
34ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* ---------------------------------------------------------------------
35ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   Char functions.
36ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   ------------------------------------------------------------------ */
37ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
38ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern Bool VG_(isspace) ( Char c );
39ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern Bool VG_(isdigit) ( Char c );
40ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern Char VG_(tolower) ( Char c );
41ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
42ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* ---------------------------------------------------------------------
43ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   Converting strings to numbers
44ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   ------------------------------------------------------------------ */
45ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
46ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// Convert strings to numbers according to various bases.  Leading
47ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// whitespace is ignored.  A subsequent '-' or '+' is accepted.  For strtoll16,
48ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// accepts an initial "0x" or "0X" prefix, but only if it's followed by a
49ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// hex digit (if not, the '0' will be read and then it will stop on the
50ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// "x"/"X".)  If 'endptr' isn't NULL, it gets filled in with the first
51ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// non-digit char.  Returns 0 if no number could be converted, and 'endptr'
52ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// is set to the start of the string.  None of them test that the number
53ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// fits into 64 bits.
54ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown//
55ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// Nb: if you're wondering why we don't just have a single VG_(strtoll) which
56ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// takes a base, it's because I wanted it to assert if it was given a bogus
57ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// base (the standard glibc one sets 'errno' in this case).  But
58ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// m_libcbase.c doesn't import any code, not even vg_assert. --njn
59ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown//
60ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// Nb: we also don't provide VG_(atoll*);  these functions are worse than
61ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// useless because they don't do any error checking and so accept malformed
62ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// numbers and non-numbers -- eg. "123xyz" gives 123, and "foo" gives 0!
63ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// If you really want that behaviour, you can use "VG_(strtoll10)(str, NULL)".
64ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern Long  VG_(strtoll10) ( Char* str, Char** endptr );
65ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern Long  VG_(strtoll16) ( Char* str, Char** endptr );
66b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanovextern ULong  VG_(strtoull10) ( Char* str, Char** endptr );
67b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanovextern ULong  VG_(strtoull16) ( Char* str, Char** endptr );
68ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
69ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// Convert a string to a double.  After leading whitespace is ignored, a
70ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// '+' or '-' is allowed, and then it accepts a non-empty sequence of
71ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// decimal digits possibly containing a '.'.  Hexadecimal floats are not
72ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// accepted, nor are "fancy" floats (eg. "3.4e-5", "NAN").
73ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern double VG_(strtod)  ( Char* str, Char** endptr );
74ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
75ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* ---------------------------------------------------------------------
76ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   String functions and macros
77ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   ------------------------------------------------------------------ */
78ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
79ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Use this for normal null-termination-style string comparison. */
80ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#define VG_STREQ(s1,s2) ( (s1 != NULL && s2 != NULL \
81ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown                           && VG_(strcmp)((s1),(s2))==0) ? True : False )
82ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#define VG_STREQN(n,s1,s2) ( (s1 != NULL && s2 != NULL \
83ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown                             && VG_(strncmp)((s1),(s2),(n))==0) ? True : False )
84ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
85ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern SizeT VG_(strlen)         ( const Char* str );
86ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern Char* VG_(strcat)         ( Char* dest, const Char* src );
87ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern Char* VG_(strncat)        ( Char* dest, const Char* src, SizeT n );
88ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern Char* VG_(strpbrk)        ( const Char* s, const Char* accpt );
89ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern Char* VG_(strcpy)         ( Char* dest, const Char* src );
90ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern Char* VG_(strncpy)        ( Char* dest, const Char* src, SizeT ndest );
91ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern Int   VG_(strcmp)         ( const Char* s1, const Char* s2 );
92ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern Int   VG_(strcasecmp)     ( const Char* s1, const Char* s2 );
93ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern Int   VG_(strncmp)        ( const Char* s1, const Char* s2, SizeT nmax );
94ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern Int   VG_(strncasecmp)    ( const Char* s1, const Char* s2, SizeT nmax );
95ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern Char* VG_(strstr)         ( const Char* haystack, Char* needle );
96ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern Char* VG_(strcasestr)     ( const Char* haystack, Char* needle );
97ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern Char* VG_(strchr)         ( const Char* s, Char c );
98ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern Char* VG_(strrchr)        ( const Char* s, Char c );
99ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern SizeT VG_(strspn)         ( const Char* s, const Char* accpt );
100ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern SizeT VG_(strcspn)        ( const Char* s, const char* reject );
101ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
102b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov/* strtok* functions and some parsing utilities. */
103b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanovextern Char* VG_(strtok_r)       (Char* s, const Char* delim, Char** saveptr);
104b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanovextern Char* VG_(strtok)         (Char* s, const Char* delim);
105b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov
106b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov/* Parse a 32- or 64-bit hex number, including leading 0x, from string
107b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov   starting at *ppc, putting result in *result, and return True.  Or
108b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov   fail, in which case *ppc and *result are undefined, and return
109b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov   False. */
110b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanovextern Bool VG_(parse_Addr) ( UChar** ppc, Addr* result );
111b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov
112ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Like strncpy(), but if 'src' is longer than 'ndest' inserts a '\0' as the
113ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   last character. */
114ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern void  VG_(strncpy_safely) ( Char* dest, const Char* src, SizeT ndest );
115ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
116ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* ---------------------------------------------------------------------
117ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   mem* functions
118ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   ------------------------------------------------------------------ */
119ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
120ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern void* VG_(memcpy) ( void *d, const void *s, SizeT sz );
121ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern void* VG_(memmove)( void *d, const void *s, SizeT sz );
122ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern void* VG_(memset) ( void *s, Int c, SizeT sz );
123ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern Int   VG_(memcmp) ( const void* s1, const void* s2, SizeT n );
124ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
125ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Zero out up to 8 words quickly in-line.  Do not use this for blocks
126ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   of size which are unknown at compile time, since the whole point is
127ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   for it to be inlined, and then for gcc to remove all code except
128ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   for the relevant 'sz' case. */
129ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Browninline __attribute__((always_inline))
130ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownstatic void VG_(bzero_inline) ( void* s, SizeT sz )
131ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown{
132ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   if (LIKELY(0 == (((Addr)sz) & (Addr)(sizeof(UWord)-1)))
133ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown       && LIKELY(0 == (((Addr)s) & (Addr)(sizeof(UWord)-1)))) {
134ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown      UWord* p = (UWord*)s;
135ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown      switch (sz / (SizeT)sizeof(UWord)) {
136ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown          case 8: p[0] = p[1] = p[2] = p[3]
137ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown                  = p[4] = p[5] = p[6] = p[7] = 0UL; return;
138ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown          case 7: p[0] = p[1] = p[2] = p[3]
139ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown                  = p[4] = p[5] = p[6] = 0UL; return;
140ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown          case 6: p[0] = p[1] = p[2] = p[3]
141ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown                  = p[4] = p[5] = 0UL; return;
142ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown          case 5: p[0] = p[1] = p[2] = p[3] = p[4] = 0UL; return;
143ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown          case 4: p[0] = p[1] = p[2] = p[3] = 0UL; return;
144ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown          case 3: p[0] = p[1] = p[2] = 0UL; return;
145ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown          case 2: p[0] = p[1] = 0UL; return;
146ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown          case 1: p[0] = 0UL; return;
147ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown          case 0: return;
148ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown          default: break;
149ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown      }
150ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   }
151ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   VG_(memset)(s, 0, sz);
152ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown}
153ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
154ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
155ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* ---------------------------------------------------------------------
156ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   Address computation helpers
157ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   ------------------------------------------------------------------ */
158ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
159ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// Check if an address/whatever is aligned
160ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#define VG_IS_2_ALIGNED(aaa_p)    (0 == (((Addr)(aaa_p)) & ((Addr)0x1)))
161ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#define VG_IS_4_ALIGNED(aaa_p)    (0 == (((Addr)(aaa_p)) & ((Addr)0x3)))
162ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#define VG_IS_8_ALIGNED(aaa_p)    (0 == (((Addr)(aaa_p)) & ((Addr)0x7)))
163ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#define VG_IS_16_ALIGNED(aaa_p)   (0 == (((Addr)(aaa_p)) & ((Addr)0xf)))
164ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#define VG_IS_32_ALIGNED(aaa_p)   (0 == (((Addr)(aaa_p)) & ((Addr)0x1f)))
165ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#define VG_IS_WORD_ALIGNED(aaa_p) (0 == (((Addr)(aaa_p)) & ((Addr)(sizeof(Addr)-1))))
166ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#define VG_IS_PAGE_ALIGNED(aaa_p) (0 == (((Addr)(aaa_p)) & ((Addr)(VKI_PAGE_SIZE-1))))
167ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
168ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// 'a' -- the alignment -- must be a power of 2.
169ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// The latter two require the vki-*.h header to be imported also.
170ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#define VG_ROUNDDN(p, a)   ((Addr)(p) & ~((Addr)(a)-1))
171ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#define VG_ROUNDUP(p, a)   VG_ROUNDDN((p)+(a)-1, (a))
172ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#define VG_PGROUNDDN(p)    VG_ROUNDDN(p, VKI_PAGE_SIZE)
173ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#define VG_PGROUNDUP(p)    VG_ROUNDUP(p, VKI_PAGE_SIZE)
174ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
175ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* ---------------------------------------------------------------------
176ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   Misc useful functions
177ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   ------------------------------------------------------------------ */
178ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
179ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Like qsort().  The name VG_(ssort) is for historical reasons -- it used
180ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown * to be a shell sort, but is now a quicksort. */
181ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern void VG_(ssort)( void* base, SizeT nmemb, SizeT size,
182ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown                        Int (*compar)(void*, void*) );
183ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
184b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov/* Returns the base-2 logarithm of a 32 bit unsigned number.  Returns
185b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov -1 if it is not a power of two.  Nb: VG_(log2)(1) == 0. */
186ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern Int VG_(log2) ( UInt x );
187ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
188b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov/* Ditto for 64 bit unsigned numbers. */
189b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanovextern Int VG_(log2_64)( ULong x );
190b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov
191ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// A pseudo-random number generator returning a random UInt.  If pSeed
192ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// is NULL, it uses its own seed, which starts at zero.  If pSeed is
193ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// non-NULL, it uses and updates whatever pSeed points at.
194ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern UInt VG_(random) ( /*MOD*/UInt* pSeed );
195ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#define VG_RAND_MAX (1ULL << 32)
196ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
197ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#endif   // __PUB_TOOL_LIBCBASE_H
198ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
199ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--------------------------------------------------------------------*/
200ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--- end                                                          ---*/
201ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--------------------------------------------------------------------*/
202