Commit | Line | Data |
---|---|---|
48faced0 DE |
1 | /* *INDENT-OFF* */ /* ATTRIBUTE_PRINTF confuses indent, avoid running it |
2 | for now. */ | |
3 | /* I/O, string, cleanup, and other random utilities for GDB. | |
61baf725 | 4 | Copyright (C) 1986-2017 Free Software Foundation, Inc. |
48faced0 DE |
5 | |
6 | This file is part of GDB. | |
7 | ||
8 | This program is free software; you can redistribute it and/or modify | |
9 | it under the terms of the GNU General Public License as published by | |
10 | the Free Software Foundation; either version 3 of the License, or | |
11 | (at your option) any later version. | |
12 | ||
13 | This program is distributed in the hope that it will be useful, | |
14 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
15 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
16 | GNU General Public License for more details. | |
17 | ||
18 | You should have received a copy of the GNU General Public License | |
19 | along with this program. If not, see <http://www.gnu.org/licenses/>. */ | |
20 | ||
21 | #ifndef UTILS_H | |
22 | #define UTILS_H | |
23 | ||
af880d85 | 24 | #include "exceptions.h" |
b7b633e9 | 25 | #include "common/scoped_restore.h" |
dcb07cfa | 26 | #include <chrono> |
48faced0 DE |
27 | |
28 | extern void initialize_utils (void); | |
29 | ||
30 | /* String utilities. */ | |
31 | ||
32 | extern int sevenbit_strings; | |
33 | ||
48faced0 DE |
34 | extern int strcmp_iw (const char *, const char *); |
35 | ||
36 | extern int strcmp_iw_ordered (const char *, const char *); | |
37 | ||
38 | extern int streq (const char *, const char *); | |
39 | ||
a121b7c1 | 40 | extern int subset_compare (const char *, const char *); |
48faced0 | 41 | |
48faced0 DE |
42 | int compare_positive_ints (const void *ap, const void *bp); |
43 | int compare_strings (const void *ap, const void *bp); | |
44 | ||
48faced0 DE |
45 | /* A wrapper for bfd_errmsg to produce a more helpful error message |
46 | in the case of bfd_error_file_ambiguously recognized. | |
47 | MATCHING, if non-NULL, is the corresponding argument to | |
48 | bfd_check_format_matches, and will be freed. */ | |
49 | ||
50 | extern const char *gdb_bfd_errmsg (bfd_error_type error_tag, char **matching); | |
bd712aed DE |
51 | |
52 | /* Reset the prompt_for_continue clock. */ | |
53 | void reset_prompt_for_continue_wait_time (void); | |
54 | /* Return the time spent in prompt_for_continue. */ | |
dcb07cfa | 55 | std::chrono::steady_clock::duration get_prompt_for_continue_wait_time (); |
48faced0 DE |
56 | \f |
57 | /* Parsing utilites. */ | |
58 | ||
c0939df1 | 59 | extern int parse_pid_to_attach (const char *args); |
48faced0 | 60 | |
d7561cbb | 61 | extern int parse_escape (struct gdbarch *, const char **); |
48faced0 DE |
62 | |
63 | char **gdb_buildargv (const char *); | |
64 | \f | |
65 | /* Cleanup utilities. */ | |
66 | ||
67 | extern struct cleanup *make_cleanup_freeargv (char **); | |
68 | ||
48faced0 DE |
69 | struct ui_out; |
70 | extern struct cleanup * | |
71 | make_cleanup_ui_out_redirect_pop (struct ui_out *uiout); | |
72 | ||
73 | struct section_addr_info; | |
74 | extern struct cleanup *(make_cleanup_free_section_addr_info | |
75 | (struct section_addr_info *)); | |
76 | ||
ca095836 | 77 | /* For make_cleanup_close see common/filestuff.h. */ |
48faced0 DE |
78 | |
79 | extern struct cleanup *make_cleanup_fclose (FILE *file); | |
80 | ||
48faced0 DE |
81 | extern struct cleanup *make_cleanup_restore_integer (int *variable); |
82 | extern struct cleanup *make_cleanup_restore_uinteger (unsigned int *variable); | |
83 | ||
84 | struct target_ops; | |
85 | extern struct cleanup *make_cleanup_unpush_target (struct target_ops *ops); | |
86 | ||
48faced0 DE |
87 | extern struct cleanup *make_cleanup_value_free_to_mark (struct value *); |
88 | extern struct cleanup *make_cleanup_value_free (struct value *); | |
89 | ||
90 | struct so_list; | |
91 | extern struct cleanup *make_cleanup_free_so (struct so_list *so); | |
92 | ||
5b12a61c JK |
93 | extern struct cleanup *make_cleanup_restore_current_language (void); |
94 | ||
6349f452 TT |
95 | /* A deleter for a hash table. */ |
96 | struct htab_deleter | |
97 | { | |
98 | void operator() (htab *ptr) const | |
99 | { | |
100 | htab_delete (ptr); | |
101 | } | |
102 | }; | |
103 | ||
104 | /* A unique_ptr wrapper for htab_t. */ | |
105 | typedef std::unique_ptr<htab, htab_deleter> htab_up; | |
106 | ||
410a0ff2 SDJ |
107 | struct parser_state; |
108 | extern struct cleanup *make_cleanup_clear_parser_state | |
109 | (struct parser_state **p); | |
110 | ||
48faced0 DE |
111 | extern void free_current_contents (void *); |
112 | ||
48faced0 DE |
113 | extern void init_page_info (void); |
114 | ||
115 | extern struct cleanup *make_cleanup_restore_page_info (void); | |
116 | extern struct cleanup * | |
117 | set_batch_flag_and_make_cleanup_restore_page_info (void); | |
118 | ||
119 | extern struct cleanup *make_bpstat_clear_actions_cleanup (void); | |
120 | \f | |
121 | /* Path utilities. */ | |
122 | ||
123 | extern char *gdb_realpath (const char *); | |
124 | ||
4856b6bc JK |
125 | extern char *gdb_realpath_keepfile (const char *); |
126 | ||
04affae3 JK |
127 | extern char *gdb_abspath (const char *); |
128 | ||
48faced0 DE |
129 | extern int gdb_filename_fnmatch (const char *pattern, const char *string, |
130 | int flags); | |
131 | ||
132 | extern void substitute_path_component (char **stringp, const char *from, | |
133 | const char *to); | |
134 | ||
d721ba37 | 135 | std::string ldirname (const char *filename); |
cce0e923 DE |
136 | |
137 | extern int count_path_elements (const char *path); | |
138 | ||
139 | extern const char *strip_leading_path_elements (const char *path, int n); | |
48faced0 DE |
140 | \f |
141 | /* GDB output, ui_file utilities. */ | |
142 | ||
143 | struct ui_file; | |
144 | ||
48faced0 DE |
145 | extern int query (const char *, ...) ATTRIBUTE_PRINTF (1, 2); |
146 | extern int nquery (const char *, ...) ATTRIBUTE_PRINTF (1, 2); | |
147 | extern int yquery (const char *, ...) ATTRIBUTE_PRINTF (1, 2); | |
148 | ||
149 | extern void begin_line (void); | |
150 | ||
d2c0eef4 | 151 | extern void wrap_here (const char *); |
48faced0 DE |
152 | |
153 | extern void reinitialize_more_filter (void); | |
154 | ||
74da6f00 PA |
155 | extern int pagination_enabled; |
156 | ||
79aa2fe8 PA |
157 | extern struct ui_file **current_ui_gdb_stdout_ptr (void); |
158 | extern struct ui_file **current_ui_gdb_stdin_ptr (void); | |
159 | extern struct ui_file **current_ui_gdb_stderr_ptr (void); | |
160 | extern struct ui_file **current_ui_gdb_stdlog_ptr (void); | |
161 | ||
162 | /* The current top level's ui_file streams. */ | |
163 | ||
48faced0 | 164 | /* Normal results */ |
79aa2fe8 | 165 | #define gdb_stdout (*current_ui_gdb_stdout_ptr ()) |
48faced0 | 166 | /* Input stream */ |
79aa2fe8 | 167 | #define gdb_stdin (*current_ui_gdb_stdin_ptr ()) |
48faced0 | 168 | /* Serious error notifications */ |
79aa2fe8 | 169 | #define gdb_stderr (*current_ui_gdb_stderr_ptr ()) |
48faced0 DE |
170 | /* Log/debug/trace messages that should bypass normal stdout/stderr |
171 | filtering. For moment, always call this stream using | |
172 | *_unfiltered. In the very near future that restriction shall be | |
173 | removed - either call shall be unfiltered. (cagney 1999-06-13). */ | |
79aa2fe8 PA |
174 | #define gdb_stdlog (*current_ui_gdb_stdlog_ptr ()) |
175 | ||
176 | /* Truly global ui_file streams. These are all defined in main.c. */ | |
177 | ||
48faced0 DE |
178 | /* Target output that should bypass normal stdout/stderr filtering. |
179 | For moment, always call this stream using *_unfiltered. In the | |
180 | very near future that restriction shall be removed - either call | |
181 | shall be unfiltered. (cagney 1999-07-02). */ | |
182 | extern struct ui_file *gdb_stdtarg; | |
183 | extern struct ui_file *gdb_stdtargerr; | |
184 | extern struct ui_file *gdb_stdtargin; | |
185 | ||
d6e5e7f7 PP |
186 | /* Set the screen dimensions to WIDTH and HEIGHT. */ |
187 | ||
188 | extern void set_screen_width_and_height (int width, int height); | |
189 | ||
48faced0 DE |
190 | /* More generic printf like operations. Filtered versions may return |
191 | non-locally on error. */ | |
192 | ||
193 | extern void fputs_filtered (const char *, struct ui_file *); | |
194 | ||
195 | extern void fputs_unfiltered (const char *, struct ui_file *); | |
196 | ||
197 | extern int fputc_filtered (int c, struct ui_file *); | |
198 | ||
199 | extern int fputc_unfiltered (int c, struct ui_file *); | |
200 | ||
201 | extern int putchar_filtered (int c); | |
202 | ||
203 | extern int putchar_unfiltered (int c); | |
204 | ||
205 | extern void puts_filtered (const char *); | |
206 | ||
207 | extern void puts_unfiltered (const char *); | |
208 | ||
209 | extern void puts_filtered_tabular (char *string, int width, int right); | |
210 | ||
211 | extern void puts_debug (char *prefix, char *string, char *suffix); | |
212 | ||
213 | extern void vprintf_filtered (const char *, va_list) ATTRIBUTE_PRINTF (1, 0); | |
214 | ||
215 | extern void vfprintf_filtered (struct ui_file *, const char *, va_list) | |
216 | ATTRIBUTE_PRINTF (2, 0); | |
217 | ||
218 | extern void fprintf_filtered (struct ui_file *, const char *, ...) | |
219 | ATTRIBUTE_PRINTF (2, 3); | |
220 | ||
221 | extern void fprintfi_filtered (int, struct ui_file *, const char *, ...) | |
222 | ATTRIBUTE_PRINTF (3, 4); | |
223 | ||
224 | extern void printf_filtered (const char *, ...) ATTRIBUTE_PRINTF (1, 2); | |
225 | ||
226 | extern void printfi_filtered (int, const char *, ...) ATTRIBUTE_PRINTF (2, 3); | |
227 | ||
228 | extern void vprintf_unfiltered (const char *, va_list) ATTRIBUTE_PRINTF (1, 0); | |
229 | ||
230 | extern void vfprintf_unfiltered (struct ui_file *, const char *, va_list) | |
231 | ATTRIBUTE_PRINTF (2, 0); | |
232 | ||
233 | extern void fprintf_unfiltered (struct ui_file *, const char *, ...) | |
234 | ATTRIBUTE_PRINTF (2, 3); | |
235 | ||
236 | extern void printf_unfiltered (const char *, ...) ATTRIBUTE_PRINTF (1, 2); | |
237 | ||
238 | extern void print_spaces (int, struct ui_file *); | |
239 | ||
240 | extern void print_spaces_filtered (int, struct ui_file *); | |
241 | ||
242 | extern char *n_spaces (int); | |
243 | ||
244 | extern void fputstr_filtered (const char *str, int quotr, | |
245 | struct ui_file * stream); | |
246 | ||
247 | extern void fputstr_unfiltered (const char *str, int quotr, | |
248 | struct ui_file * stream); | |
249 | ||
250 | extern void fputstrn_filtered (const char *str, int n, int quotr, | |
251 | struct ui_file * stream); | |
252 | ||
253 | extern void fputstrn_unfiltered (const char *str, int n, int quotr, | |
254 | struct ui_file * stream); | |
255 | ||
2437fd32 GB |
256 | /* Return nonzero if filtered printing is initialized. */ |
257 | extern int filtered_printing_initialized (void); | |
258 | ||
48faced0 | 259 | /* Display the host ADDR on STREAM formatted as ``0x%x''. */ |
b80c3053 PA |
260 | extern void gdb_print_host_address_1 (const void *addr, struct ui_file *stream); |
261 | ||
262 | /* Wrapper that avoids adding a pointless cast to all callers. */ | |
263 | #define gdb_print_host_address(ADDR, STREAM) \ | |
264 | gdb_print_host_address_1 ((const void *) ADDR, STREAM) | |
48faced0 | 265 | |
48faced0 DE |
266 | /* Convert CORE_ADDR to string in platform-specific manner. |
267 | This is usually formatted similar to 0x%lx. */ | |
268 | extern const char *paddress (struct gdbarch *gdbarch, CORE_ADDR addr); | |
269 | ||
270 | /* Return a string representation in hexadecimal notation of ADDRESS, | |
271 | which is suitable for printing. */ | |
272 | ||
273 | extern const char *print_core_address (struct gdbarch *gdbarch, | |
274 | CORE_ADDR address); | |
275 | ||
276 | /* Callback hash_f and eq_f for htab_create_alloc or htab_create_alloc_ex. */ | |
277 | extern hashval_t core_addr_hash (const void *ap); | |
278 | extern int core_addr_eq (const void *ap, const void *bp); | |
279 | ||
48faced0 DE |
280 | extern CORE_ADDR string_to_core_addr (const char *my_string); |
281 | ||
48faced0 DE |
282 | extern void fprintf_symbol_filtered (struct ui_file *, const char *, |
283 | enum language, int); | |
284 | ||
598d3636 JK |
285 | extern void throw_perror_with_name (enum errors errcode, const char *string) |
286 | ATTRIBUTE_NORETURN; | |
48faced0 | 287 | |
7c647d61 JB |
288 | extern void perror_warning_with_name (const char *string); |
289 | ||
48faced0 DE |
290 | extern void print_sys_errmsg (const char *, int); |
291 | \f | |
292 | /* Warnings and error messages. */ | |
293 | ||
294 | extern void (*deprecated_error_begin_hook) (void); | |
295 | ||
48faced0 DE |
296 | /* Message to be printed before the warning message, when a warning occurs. */ |
297 | ||
69bbf465 | 298 | extern const char *warning_pre_print; |
48faced0 | 299 | |
d7e74731 | 300 | extern void error_stream (const string_file &) ATTRIBUTE_NORETURN; |
48faced0 | 301 | |
57fcfb1b GB |
302 | extern void demangler_vwarning (const char *file, int line, |
303 | const char *, va_list ap) | |
304 | ATTRIBUTE_PRINTF (3, 0); | |
305 | ||
306 | extern void demangler_warning (const char *file, int line, | |
307 | const char *, ...) ATTRIBUTE_PRINTF (3, 4); | |
308 | ||
48faced0 DE |
309 | \f |
310 | /* Misc. utilities. */ | |
311 | ||
312 | /* Allocation and deallocation functions for the libiberty hash table | |
313 | which use obstacks. */ | |
314 | void *hashtab_obstack_allocate (void *data, size_t size, size_t count); | |
315 | void dummy_obstack_deallocate (void *object, void *data); | |
316 | ||
317 | #ifdef HAVE_WAITPID | |
318 | extern pid_t wait_to_die_with_timeout (pid_t pid, int *status, int timeout); | |
319 | #endif | |
320 | ||
321 | extern int producer_is_gcc_ge_4 (const char *producer); | |
cc7039d3 | 322 | extern int producer_is_gcc (const char *producer, int *major, int *minor); |
48faced0 | 323 | |
48faced0 DE |
324 | extern int myread (int, char *, int); |
325 | ||
326 | /* Ensure that V is aligned to an N byte boundary (B's assumed to be a | |
327 | power of 2). Round up/down when necessary. Examples of correct | |
328 | use include: | |
329 | ||
330 | addr = align_up (addr, 8); -- VALUE needs 8 byte alignment | |
331 | write_memory (addr, value, len); | |
332 | addr += len; | |
333 | ||
334 | and: | |
335 | ||
336 | sp = align_down (sp - len, 16); -- Keep SP 16 byte aligned | |
337 | write_memory (sp, value, len); | |
338 | ||
339 | Note that uses such as: | |
340 | ||
341 | write_memory (addr, value, len); | |
342 | addr += align_up (len, 8); | |
343 | ||
344 | and: | |
345 | ||
346 | sp -= align_up (len, 8); | |
347 | write_memory (sp, value, len); | |
348 | ||
349 | are typically not correct as they don't ensure that the address (SP | |
350 | or ADDR) is correctly aligned (relying on previous alignment to | |
351 | keep things right). This is also why the methods are called | |
352 | "align_..." instead of "round_..." as the latter reads better with | |
353 | this incorrect coding style. */ | |
354 | ||
355 | extern ULONGEST align_up (ULONGEST v, int n); | |
356 | extern ULONGEST align_down (ULONGEST v, int n); | |
357 | ||
eae7090b GB |
358 | /* Resource limits used by getrlimit and setrlimit. */ |
359 | ||
360 | enum resource_limit_kind | |
361 | { | |
362 | LIMIT_CUR, | |
363 | LIMIT_MAX | |
364 | }; | |
365 | ||
366 | /* Check whether GDB will be able to dump core using the dump_core | |
367 | function. Returns zero if GDB cannot or should not dump core. | |
368 | If LIMIT_KIND is LIMIT_CUR the user's soft limit will be respected. | |
369 | If LIMIT_KIND is LIMIT_MAX only the hard limit will be respected. */ | |
370 | ||
371 | extern int can_dump_core (enum resource_limit_kind limit_kind); | |
372 | ||
373 | /* Print a warning that we cannot dump core. */ | |
374 | ||
375 | extern void warn_cant_dump_core (const char *reason); | |
376 | ||
377 | /* Dump core trying to increase the core soft limit to hard limit | |
378 | first. */ | |
379 | ||
380 | extern void dump_core (void); | |
381 | ||
7c50a931 DE |
382 | /* Return the hex string form of LENGTH bytes of DATA. |
383 | Space for the result is malloc'd, caller must free. */ | |
384 | ||
385 | extern char *make_hex_string (const gdb_byte *data, size_t length); | |
386 | ||
48faced0 | 387 | #endif /* UTILS_H */ |