Commit | Line | Data |
---|---|---|
d26e3629 KY |
1 | /* Shared general utility routines for GDB, the GNU debugger. |
2 | ||
61baf725 | 3 | Copyright (C) 1986-2017 Free Software Foundation, Inc. |
d26e3629 KY |
4 | |
5 | This file is part of GDB. | |
6 | ||
7 | This program is free software; you can redistribute it and/or modify | |
8 | it under the terms of the GNU General Public License as published by | |
9 | the Free Software Foundation; either version 3 of the License, or | |
10 | (at your option) any later version. | |
11 | ||
12 | This program is distributed in the hope that it will be useful, | |
13 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
14 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
15 | GNU General Public License for more details. | |
16 | ||
17 | You should have received a copy of the GNU General Public License | |
18 | along with this program. If not, see <http://www.gnu.org/licenses/>. */ | |
19 | ||
727605ca | 20 | #include "common-defs.h" |
2090129c | 21 | #include "common-utils.h" |
03aef70f JK |
22 | #include "host-defs.h" |
23 | #include <ctype.h> | |
d26e3629 | 24 | |
d26e3629 KY |
25 | /* The xmalloc() (libiberty.h) family of memory management routines. |
26 | ||
27 | These are like the ISO-C malloc() family except that they implement | |
28 | consistent semantics and guard against typical memory management | |
29 | problems. */ | |
30 | ||
31 | /* NOTE: These are declared using PTR to ensure consistency with | |
32 | "libiberty.h". xfree() is GDB local. */ | |
33 | ||
34 | PTR /* ARI: PTR */ | |
35 | xmalloc (size_t size) | |
36 | { | |
37 | void *val; | |
38 | ||
39 | /* See libiberty/xmalloc.c. This function need's to match that's | |
40 | semantics. It never returns NULL. */ | |
41 | if (size == 0) | |
42 | size = 1; | |
43 | ||
44 | val = malloc (size); /* ARI: malloc */ | |
45 | if (val == NULL) | |
46 | malloc_failure (size); | |
47 | ||
48 | return val; | |
49 | } | |
50 | ||
51 | PTR /* ARI: PTR */ | |
52 | xrealloc (PTR ptr, size_t size) /* ARI: PTR */ | |
53 | { | |
54 | void *val; | |
55 | ||
56 | /* See libiberty/xmalloc.c. This function need's to match that's | |
57 | semantics. It never returns NULL. */ | |
58 | if (size == 0) | |
59 | size = 1; | |
60 | ||
61 | if (ptr != NULL) | |
62 | val = realloc (ptr, size); /* ARI: realloc */ | |
63 | else | |
64 | val = malloc (size); /* ARI: malloc */ | |
65 | if (val == NULL) | |
66 | malloc_failure (size); | |
67 | ||
68 | return val; | |
69 | } | |
70 | ||
71 | PTR /* ARI: PTR */ | |
72 | xcalloc (size_t number, size_t size) | |
73 | { | |
74 | void *mem; | |
75 | ||
76 | /* See libiberty/xmalloc.c. This function need's to match that's | |
77 | semantics. It never returns NULL. */ | |
78 | if (number == 0 || size == 0) | |
79 | { | |
80 | number = 1; | |
81 | size = 1; | |
82 | } | |
83 | ||
84 | mem = calloc (number, size); /* ARI: xcalloc */ | |
85 | if (mem == NULL) | |
86 | malloc_failure (number * size); | |
87 | ||
88 | return mem; | |
89 | } | |
90 | ||
91 | void * | |
92 | xzalloc (size_t size) | |
93 | { | |
94 | return xcalloc (1, size); | |
95 | } | |
96 | ||
97 | void | |
98 | xfree (void *ptr) | |
99 | { | |
100 | if (ptr != NULL) | |
101 | free (ptr); /* ARI: free */ | |
102 | } | |
103 | ||
51403f74 NC |
104 | void |
105 | xmalloc_failed (size_t size) | |
106 | { | |
107 | malloc_failure (size); | |
108 | } | |
109 | ||
d26e3629 KY |
110 | /* Like asprintf/vasprintf but get an internal_error if the call |
111 | fails. */ | |
112 | ||
113 | char * | |
114 | xstrprintf (const char *format, ...) | |
115 | { | |
116 | char *ret; | |
117 | va_list args; | |
118 | ||
119 | va_start (args, format); | |
120 | ret = xstrvprintf (format, args); | |
121 | va_end (args); | |
122 | return ret; | |
123 | } | |
124 | ||
125 | char * | |
126 | xstrvprintf (const char *format, va_list ap) | |
127 | { | |
128 | char *ret = NULL; | |
129 | int status = vasprintf (&ret, format, ap); | |
130 | ||
131 | /* NULL is returned when there was a memory allocation problem, or | |
132 | any other error (for instance, a bad format string). A negative | |
133 | status (the printed length) with a non-NULL buffer should never | |
134 | happen, but just to be sure. */ | |
135 | if (ret == NULL || status < 0) | |
136 | internal_error (__FILE__, __LINE__, _("vasprintf call failed")); | |
137 | return ret; | |
138 | } | |
139 | ||
d26e3629 KY |
140 | int |
141 | xsnprintf (char *str, size_t size, const char *format, ...) | |
142 | { | |
143 | va_list args; | |
144 | int ret; | |
145 | ||
146 | va_start (args, format); | |
147 | ret = vsnprintf (str, size, format, args); | |
148 | gdb_assert (ret < size); | |
149 | va_end (args); | |
150 | ||
151 | return ret; | |
152 | } | |
baea0dae | 153 | |
d4081a38 PA |
154 | /* See documentation in common-utils.h. */ |
155 | ||
156 | std::string | |
157 | string_printf (const char* fmt, ...) | |
158 | { | |
159 | va_list vp; | |
160 | int size; | |
161 | ||
162 | va_start (vp, fmt); | |
163 | size = vsnprintf (NULL, 0, fmt, vp); | |
164 | va_end (vp); | |
165 | ||
166 | std::string str (size, '\0'); | |
167 | ||
168 | /* C++11 and later guarantee std::string uses contiguous memory and | |
169 | always includes the terminating '\0'. */ | |
170 | va_start (vp, fmt); | |
171 | vsprintf (&str[0], fmt, vp); | |
172 | va_end (vp); | |
173 | ||
174 | return str; | |
175 | } | |
176 | ||
bd413795 TT |
177 | /* See documentation in common-utils.h. */ |
178 | ||
179 | std::string | |
180 | string_vprintf (const char* fmt, va_list args) | |
181 | { | |
182 | va_list vp; | |
183 | size_t size; | |
184 | ||
185 | va_copy (vp, args); | |
186 | size = vsnprintf (NULL, 0, fmt, vp); | |
187 | va_end (vp); | |
188 | ||
189 | std::string str (size, '\0'); | |
190 | ||
191 | /* C++11 and later guarantee std::string uses contiguous memory and | |
192 | always includes the terminating '\0'. */ | |
193 | vsprintf (&str[0], fmt, args); | |
194 | ||
195 | return str; | |
196 | } | |
197 | ||
baea0dae PA |
198 | char * |
199 | savestring (const char *ptr, size_t len) | |
200 | { | |
201 | char *p = (char *) xmalloc (len + 1); | |
202 | ||
203 | memcpy (p, ptr, len); | |
204 | p[len] = 0; | |
205 | return p; | |
206 | } | |
03aef70f JK |
207 | |
208 | /* The bit offset of the highest byte in a ULONGEST, for overflow | |
209 | checking. */ | |
210 | ||
211 | #define HIGH_BYTE_POSN ((sizeof (ULONGEST) - 1) * HOST_CHAR_BIT) | |
212 | ||
213 | /* True (non-zero) iff DIGIT is a valid digit in radix BASE, | |
214 | where 2 <= BASE <= 36. */ | |
215 | ||
216 | static int | |
217 | is_digit_in_base (unsigned char digit, int base) | |
218 | { | |
219 | if (!isalnum (digit)) | |
220 | return 0; | |
221 | if (base <= 10) | |
222 | return (isdigit (digit) && digit < base + '0'); | |
223 | else | |
224 | return (isdigit (digit) || tolower (digit) < base - 10 + 'a'); | |
225 | } | |
226 | ||
227 | static int | |
228 | digit_to_int (unsigned char c) | |
229 | { | |
230 | if (isdigit (c)) | |
231 | return c - '0'; | |
232 | else | |
233 | return tolower (c) - 'a' + 10; | |
234 | } | |
235 | ||
236 | /* As for strtoul, but for ULONGEST results. */ | |
237 | ||
238 | ULONGEST | |
239 | strtoulst (const char *num, const char **trailer, int base) | |
240 | { | |
241 | unsigned int high_part; | |
242 | ULONGEST result; | |
243 | int minus = 0; | |
244 | int i = 0; | |
245 | ||
246 | /* Skip leading whitespace. */ | |
247 | while (isspace (num[i])) | |
248 | i++; | |
249 | ||
250 | /* Handle prefixes. */ | |
251 | if (num[i] == '+') | |
252 | i++; | |
253 | else if (num[i] == '-') | |
254 | { | |
255 | minus = 1; | |
256 | i++; | |
257 | } | |
258 | ||
259 | if (base == 0 || base == 16) | |
260 | { | |
261 | if (num[i] == '0' && (num[i + 1] == 'x' || num[i + 1] == 'X')) | |
262 | { | |
263 | i += 2; | |
264 | if (base == 0) | |
265 | base = 16; | |
266 | } | |
267 | } | |
268 | ||
269 | if (base == 0 && num[i] == '0') | |
270 | base = 8; | |
271 | ||
272 | if (base == 0) | |
273 | base = 10; | |
274 | ||
275 | if (base < 2 || base > 36) | |
276 | { | |
277 | errno = EINVAL; | |
278 | return 0; | |
279 | } | |
280 | ||
281 | result = high_part = 0; | |
282 | for (; is_digit_in_base (num[i], base); i += 1) | |
283 | { | |
284 | result = result * base + digit_to_int (num[i]); | |
285 | high_part = high_part * base + (unsigned int) (result >> HIGH_BYTE_POSN); | |
286 | result &= ((ULONGEST) 1 << HIGH_BYTE_POSN) - 1; | |
287 | if (high_part > 0xff) | |
288 | { | |
289 | errno = ERANGE; | |
290 | result = ~ (ULONGEST) 0; | |
291 | high_part = 0; | |
292 | minus = 0; | |
293 | break; | |
294 | } | |
295 | } | |
296 | ||
297 | if (trailer != NULL) | |
298 | *trailer = &num[i]; | |
299 | ||
300 | result = result + ((ULONGEST) high_part << HIGH_BYTE_POSN); | |
301 | if (minus) | |
302 | return -result; | |
303 | else | |
304 | return result; | |
305 | } | |
306 | ||
41548caa | 307 | /* See documentation in common-utils.h. */ |
03aef70f JK |
308 | |
309 | char * | |
310 | skip_spaces (char *chp) | |
311 | { | |
312 | if (chp == NULL) | |
313 | return NULL; | |
314 | while (*chp && isspace (*chp)) | |
315 | chp++; | |
316 | return chp; | |
317 | } | |
318 | ||
319 | /* A const-correct version of the above. */ | |
320 | ||
321 | const char * | |
f1735a53 | 322 | skip_spaces (const char *chp) |
03aef70f JK |
323 | { |
324 | if (chp == NULL) | |
325 | return NULL; | |
326 | while (*chp && isspace (*chp)) | |
327 | chp++; | |
328 | return chp; | |
329 | } | |
330 | ||
41548caa | 331 | /* See documentation in common-utils.h. */ |
03aef70f JK |
332 | |
333 | const char * | |
f1735a53 | 334 | skip_to_space (const char *chp) |
03aef70f JK |
335 | { |
336 | if (chp == NULL) | |
337 | return NULL; | |
338 | while (*chp && !isspace (*chp)) | |
339 | chp++; | |
340 | return chp; | |
341 | } | |
7c5ded6a | 342 | |
f1735a53 TT |
343 | /* See documentation in common-utils.h. */ |
344 | ||
345 | char * | |
346 | skip_to_space (char *chp) | |
347 | { | |
348 | return (char *) skip_to_space ((const char *) chp); | |
349 | } | |
350 | ||
7c5ded6a SDJ |
351 | /* See common/common-utils.h. */ |
352 | ||
353 | void | |
354 | free_vector_argv (std::vector<char *> &v) | |
355 | { | |
356 | for (char *el : v) | |
357 | xfree (el); | |
358 | ||
359 | v.clear (); | |
360 | } | |
2090129c SDJ |
361 | |
362 | /* See common/common-utils.h. */ | |
363 | ||
364 | std::string | |
365 | stringify_argv (const std::vector<char *> &args) | |
366 | { | |
367 | std::string ret; | |
368 | ||
2f91880f | 369 | if (!args.empty () && args[0] != NULL) |
2090129c SDJ |
370 | { |
371 | for (auto s : args) | |
372 | if (s != NULL) | |
373 | { | |
374 | ret += s; | |
375 | ret += ' '; | |
376 | } | |
377 | ||
378 | /* Erase the last whitespace. */ | |
379 | ret.erase (ret.end () - 1); | |
380 | } | |
381 | ||
382 | return ret; | |
383 | } |