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