1 /* *INDENT-OFF* */ /* ATTRIBUTE_PRINTF confuses indent, avoid running it
3 /* I/O, string, cleanup, and other random utilities for GDB.
4 Copyright (C) 1986-2017 Free Software Foundation, Inc.
6 This file is part of GDB.
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.
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.
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/>. */
24 #include "exceptions.h"
25 #include "common/scoped_restore.h"
28 extern void initialize_utils (void);
30 /* String utilities. */
32 extern int sevenbit_strings;
34 /* Do a strncmp() type operation on STRING1 and STRING2, ignoring any
35 differences in whitespace. STRING2_LEN is STRING2's length.
36 Returns 0 if STRING1 matches STRING2_LEN characters of STRING2,
37 non-zero otherwise (slightly different than strncmp()'s range of
39 extern int strncmp_iw (const char *string1, const char *string2,
42 /* Do a strcmp() type operation on STRING1 and STRING2, ignoring any
43 differences in whitespace. Returns 0 if they match, non-zero if
44 they don't (slightly different than strcmp()'s range of return
47 As an extra hack, string1=="FOO(ARGS)" matches string2=="FOO".
48 This "feature" is useful when searching for matching C++ function
49 names (such as if the user types 'break FOO', where FOO is a
50 mangled C++ function). */
51 extern int strcmp_iw (const char *string1, const char *string2);
53 extern int strcmp_iw_ordered (const char *, const char *);
55 extern int streq (const char *, const char *);
57 extern int subset_compare (const char *, const char *);
59 int compare_positive_ints (const void *ap, const void *bp);
60 int compare_strings (const void *ap, const void *bp);
62 /* Compare C strings for std::sort. */
65 compare_cstrings (const char *str1, const char *str2)
67 return strcmp (str1, str2) < 0;
70 /* A wrapper for bfd_errmsg to produce a more helpful error message
71 in the case of bfd_error_file_ambiguously recognized.
72 MATCHING, if non-NULL, is the corresponding argument to
73 bfd_check_format_matches, and will be freed. */
75 extern const char *gdb_bfd_errmsg (bfd_error_type error_tag, char **matching);
77 /* Reset the prompt_for_continue clock. */
78 void reset_prompt_for_continue_wait_time (void);
79 /* Return the time spent in prompt_for_continue. */
80 std::chrono::steady_clock::duration get_prompt_for_continue_wait_time ();
82 /* Parsing utilites. */
84 extern int parse_pid_to_attach (const char *args);
86 extern int parse_escape (struct gdbarch *, const char **);
88 char **gdb_buildargv (const char *);
90 /* Cleanup utilities. */
92 extern struct cleanup *make_cleanup_freeargv (char **);
95 extern struct cleanup *
96 make_cleanup_ui_out_redirect_pop (struct ui_out *uiout);
98 struct section_addr_info;
99 extern struct cleanup *(make_cleanup_free_section_addr_info
100 (struct section_addr_info *));
102 /* For make_cleanup_close see common/filestuff.h. */
104 extern struct cleanup *make_cleanup_restore_integer (int *variable);
105 extern struct cleanup *make_cleanup_restore_uinteger (unsigned int *variable);
108 extern struct cleanup *make_cleanup_unpush_target (struct target_ops *ops);
110 extern struct cleanup *make_cleanup_value_free_to_mark (struct value *);
111 extern struct cleanup *make_cleanup_value_free (struct value *);
114 extern struct cleanup *make_cleanup_free_so (struct so_list *so);
116 /* A deleter for a hash table. */
119 void operator() (htab *ptr) const
125 /* A unique_ptr wrapper for htab_t. */
126 typedef std::unique_ptr<htab, htab_deleter> htab_up;
129 extern struct cleanup *make_cleanup_clear_parser_state
130 (struct parser_state **p);
132 extern void free_current_contents (void *);
134 extern void init_page_info (void);
136 extern struct cleanup *make_cleanup_restore_page_info (void);
137 extern struct cleanup *
138 set_batch_flag_and_make_cleanup_restore_page_info (void);
140 extern struct cleanup *make_bpstat_clear_actions_cleanup (void);
142 /* Path utilities. */
144 extern char *gdb_realpath (const char *);
146 extern char *gdb_realpath_keepfile (const char *);
148 extern char *gdb_abspath (const char *);
150 extern int gdb_filename_fnmatch (const char *pattern, const char *string,
153 extern void substitute_path_component (char **stringp, const char *from,
156 std::string ldirname (const char *filename);
158 extern int count_path_elements (const char *path);
160 extern const char *strip_leading_path_elements (const char *path, int n);
162 /* GDB output, ui_file utilities. */
166 extern int query (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
167 extern int nquery (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
168 extern int yquery (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
170 extern void begin_line (void);
172 extern void wrap_here (const char *);
174 extern void reinitialize_more_filter (void);
176 extern int pagination_enabled;
178 extern struct ui_file **current_ui_gdb_stdout_ptr (void);
179 extern struct ui_file **current_ui_gdb_stdin_ptr (void);
180 extern struct ui_file **current_ui_gdb_stderr_ptr (void);
181 extern struct ui_file **current_ui_gdb_stdlog_ptr (void);
183 /* The current top level's ui_file streams. */
186 #define gdb_stdout (*current_ui_gdb_stdout_ptr ())
188 #define gdb_stdin (*current_ui_gdb_stdin_ptr ())
189 /* Serious error notifications */
190 #define gdb_stderr (*current_ui_gdb_stderr_ptr ())
191 /* Log/debug/trace messages that should bypass normal stdout/stderr
192 filtering. For moment, always call this stream using
193 *_unfiltered. In the very near future that restriction shall be
194 removed - either call shall be unfiltered. (cagney 1999-06-13). */
195 #define gdb_stdlog (*current_ui_gdb_stdlog_ptr ())
197 /* Truly global ui_file streams. These are all defined in main.c. */
199 /* Target output that should bypass normal stdout/stderr filtering.
200 For moment, always call this stream using *_unfiltered. In the
201 very near future that restriction shall be removed - either call
202 shall be unfiltered. (cagney 1999-07-02). */
203 extern struct ui_file *gdb_stdtarg;
204 extern struct ui_file *gdb_stdtargerr;
205 extern struct ui_file *gdb_stdtargin;
207 /* Set the screen dimensions to WIDTH and HEIGHT. */
209 extern void set_screen_width_and_height (int width, int height);
211 /* More generic printf like operations. Filtered versions may return
212 non-locally on error. */
214 extern void fputs_filtered (const char *, struct ui_file *);
216 extern void fputs_unfiltered (const char *, struct ui_file *);
218 extern int fputc_filtered (int c, struct ui_file *);
220 extern int fputc_unfiltered (int c, struct ui_file *);
222 extern int putchar_filtered (int c);
224 extern int putchar_unfiltered (int c);
226 extern void puts_filtered (const char *);
228 extern void puts_unfiltered (const char *);
230 extern void puts_filtered_tabular (char *string, int width, int right);
232 extern void puts_debug (char *prefix, char *string, char *suffix);
234 extern void vprintf_filtered (const char *, va_list) ATTRIBUTE_PRINTF (1, 0);
236 extern void vfprintf_filtered (struct ui_file *, const char *, va_list)
237 ATTRIBUTE_PRINTF (2, 0);
239 extern void fprintf_filtered (struct ui_file *, const char *, ...)
240 ATTRIBUTE_PRINTF (2, 3);
242 extern void fprintfi_filtered (int, struct ui_file *, const char *, ...)
243 ATTRIBUTE_PRINTF (3, 4);
245 extern void printf_filtered (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
247 extern void printfi_filtered (int, const char *, ...) ATTRIBUTE_PRINTF (2, 3);
249 extern void vprintf_unfiltered (const char *, va_list) ATTRIBUTE_PRINTF (1, 0);
251 extern void vfprintf_unfiltered (struct ui_file *, const char *, va_list)
252 ATTRIBUTE_PRINTF (2, 0);
254 extern void fprintf_unfiltered (struct ui_file *, const char *, ...)
255 ATTRIBUTE_PRINTF (2, 3);
257 extern void printf_unfiltered (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
259 extern void print_spaces (int, struct ui_file *);
261 extern void print_spaces_filtered (int, struct ui_file *);
263 extern char *n_spaces (int);
265 extern void fputstr_filtered (const char *str, int quotr,
266 struct ui_file * stream);
268 extern void fputstr_unfiltered (const char *str, int quotr,
269 struct ui_file * stream);
271 extern void fputstrn_filtered (const char *str, int n, int quotr,
272 struct ui_file * stream);
274 extern void fputstrn_unfiltered (const char *str, int n, int quotr,
275 struct ui_file * stream);
277 /* Return nonzero if filtered printing is initialized. */
278 extern int filtered_printing_initialized (void);
280 /* Display the host ADDR on STREAM formatted as ``0x%x''. */
281 extern void gdb_print_host_address_1 (const void *addr, struct ui_file *stream);
283 /* Wrapper that avoids adding a pointless cast to all callers. */
284 #define gdb_print_host_address(ADDR, STREAM) \
285 gdb_print_host_address_1 ((const void *) ADDR, STREAM)
287 /* Convert CORE_ADDR to string in platform-specific manner.
288 This is usually formatted similar to 0x%lx. */
289 extern const char *paddress (struct gdbarch *gdbarch, CORE_ADDR addr);
291 /* Return a string representation in hexadecimal notation of ADDRESS,
292 which is suitable for printing. */
294 extern const char *print_core_address (struct gdbarch *gdbarch,
297 /* Callback hash_f and eq_f for htab_create_alloc or htab_create_alloc_ex. */
298 extern hashval_t core_addr_hash (const void *ap);
299 extern int core_addr_eq (const void *ap, const void *bp);
301 extern CORE_ADDR string_to_core_addr (const char *my_string);
303 extern void fprintf_symbol_filtered (struct ui_file *, const char *,
306 extern void throw_perror_with_name (enum errors errcode, const char *string)
309 extern void perror_warning_with_name (const char *string);
311 extern void print_sys_errmsg (const char *, int);
313 /* Warnings and error messages. */
315 extern void (*deprecated_error_begin_hook) (void);
317 /* Message to be printed before the warning message, when a warning occurs. */
319 extern const char *warning_pre_print;
321 extern void error_stream (const string_file &) ATTRIBUTE_NORETURN;
323 extern void demangler_vwarning (const char *file, int line,
324 const char *, va_list ap)
325 ATTRIBUTE_PRINTF (3, 0);
327 extern void demangler_warning (const char *file, int line,
328 const char *, ...) ATTRIBUTE_PRINTF (3, 4);
331 /* Misc. utilities. */
333 /* Allocation and deallocation functions for the libiberty hash table
334 which use obstacks. */
335 void *hashtab_obstack_allocate (void *data, size_t size, size_t count);
336 void dummy_obstack_deallocate (void *object, void *data);
339 extern pid_t wait_to_die_with_timeout (pid_t pid, int *status, int timeout);
342 extern int producer_is_gcc_ge_4 (const char *producer);
343 extern int producer_is_gcc (const char *producer, int *major, int *minor);
345 extern int myread (int, char *, int);
347 /* Ensure that V is aligned to an N byte boundary (B's assumed to be a
348 power of 2). Round up/down when necessary. Examples of correct
351 addr = align_up (addr, 8); -- VALUE needs 8 byte alignment
352 write_memory (addr, value, len);
357 sp = align_down (sp - len, 16); -- Keep SP 16 byte aligned
358 write_memory (sp, value, len);
360 Note that uses such as:
362 write_memory (addr, value, len);
363 addr += align_up (len, 8);
367 sp -= align_up (len, 8);
368 write_memory (sp, value, len);
370 are typically not correct as they don't ensure that the address (SP
371 or ADDR) is correctly aligned (relying on previous alignment to
372 keep things right). This is also why the methods are called
373 "align_..." instead of "round_..." as the latter reads better with
374 this incorrect coding style. */
376 extern ULONGEST align_up (ULONGEST v, int n);
377 extern ULONGEST align_down (ULONGEST v, int n);
379 /* Resource limits used by getrlimit and setrlimit. */
381 enum resource_limit_kind
387 /* Check whether GDB will be able to dump core using the dump_core
388 function. Returns zero if GDB cannot or should not dump core.
389 If LIMIT_KIND is LIMIT_CUR the user's soft limit will be respected.
390 If LIMIT_KIND is LIMIT_MAX only the hard limit will be respected. */
392 extern int can_dump_core (enum resource_limit_kind limit_kind);
394 /* Print a warning that we cannot dump core. */
396 extern void warn_cant_dump_core (const char *reason);
398 /* Dump core trying to increase the core soft limit to hard limit
401 extern void dump_core (void);
403 /* Return the hex string form of LENGTH bytes of DATA.
404 Space for the result is malloc'd, caller must free. */
406 extern char *make_hex_string (const gdb_byte *data, size_t length);