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 extern struct cleanup *make_cleanup_restore_current_language (void);
118 /* A deleter for a hash table. */
121 void operator() (htab *ptr) const
127 /* A unique_ptr wrapper for htab_t. */
128 typedef std::unique_ptr<htab, htab_deleter> htab_up;
131 extern struct cleanup *make_cleanup_clear_parser_state
132 (struct parser_state **p);
134 extern void free_current_contents (void *);
136 extern void init_page_info (void);
138 extern struct cleanup *make_cleanup_restore_page_info (void);
139 extern struct cleanup *
140 set_batch_flag_and_make_cleanup_restore_page_info (void);
142 extern struct cleanup *make_bpstat_clear_actions_cleanup (void);
144 /* Path utilities. */
146 extern char *gdb_realpath (const char *);
148 extern char *gdb_realpath_keepfile (const char *);
150 extern char *gdb_abspath (const char *);
152 extern int gdb_filename_fnmatch (const char *pattern, const char *string,
155 extern void substitute_path_component (char **stringp, const char *from,
158 std::string ldirname (const char *filename);
160 extern int count_path_elements (const char *path);
162 extern const char *strip_leading_path_elements (const char *path, int n);
164 /* GDB output, ui_file utilities. */
168 extern int query (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
169 extern int nquery (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
170 extern int yquery (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
172 extern void begin_line (void);
174 extern void wrap_here (const char *);
176 extern void reinitialize_more_filter (void);
178 extern int pagination_enabled;
180 extern struct ui_file **current_ui_gdb_stdout_ptr (void);
181 extern struct ui_file **current_ui_gdb_stdin_ptr (void);
182 extern struct ui_file **current_ui_gdb_stderr_ptr (void);
183 extern struct ui_file **current_ui_gdb_stdlog_ptr (void);
185 /* The current top level's ui_file streams. */
188 #define gdb_stdout (*current_ui_gdb_stdout_ptr ())
190 #define gdb_stdin (*current_ui_gdb_stdin_ptr ())
191 /* Serious error notifications */
192 #define gdb_stderr (*current_ui_gdb_stderr_ptr ())
193 /* Log/debug/trace messages that should bypass normal stdout/stderr
194 filtering. For moment, always call this stream using
195 *_unfiltered. In the very near future that restriction shall be
196 removed - either call shall be unfiltered. (cagney 1999-06-13). */
197 #define gdb_stdlog (*current_ui_gdb_stdlog_ptr ())
199 /* Truly global ui_file streams. These are all defined in main.c. */
201 /* Target output that should bypass normal stdout/stderr filtering.
202 For moment, always call this stream using *_unfiltered. In the
203 very near future that restriction shall be removed - either call
204 shall be unfiltered. (cagney 1999-07-02). */
205 extern struct ui_file *gdb_stdtarg;
206 extern struct ui_file *gdb_stdtargerr;
207 extern struct ui_file *gdb_stdtargin;
209 /* Set the screen dimensions to WIDTH and HEIGHT. */
211 extern void set_screen_width_and_height (int width, int height);
213 /* More generic printf like operations. Filtered versions may return
214 non-locally on error. */
216 extern void fputs_filtered (const char *, struct ui_file *);
218 extern void fputs_unfiltered (const char *, struct ui_file *);
220 extern int fputc_filtered (int c, struct ui_file *);
222 extern int fputc_unfiltered (int c, struct ui_file *);
224 extern int putchar_filtered (int c);
226 extern int putchar_unfiltered (int c);
228 extern void puts_filtered (const char *);
230 extern void puts_unfiltered (const char *);
232 extern void puts_filtered_tabular (char *string, int width, int right);
234 extern void puts_debug (char *prefix, char *string, char *suffix);
236 extern void vprintf_filtered (const char *, va_list) ATTRIBUTE_PRINTF (1, 0);
238 extern void vfprintf_filtered (struct ui_file *, const char *, va_list)
239 ATTRIBUTE_PRINTF (2, 0);
241 extern void fprintf_filtered (struct ui_file *, const char *, ...)
242 ATTRIBUTE_PRINTF (2, 3);
244 extern void fprintfi_filtered (int, struct ui_file *, const char *, ...)
245 ATTRIBUTE_PRINTF (3, 4);
247 extern void printf_filtered (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
249 extern void printfi_filtered (int, const char *, ...) ATTRIBUTE_PRINTF (2, 3);
251 extern void vprintf_unfiltered (const char *, va_list) ATTRIBUTE_PRINTF (1, 0);
253 extern void vfprintf_unfiltered (struct ui_file *, const char *, va_list)
254 ATTRIBUTE_PRINTF (2, 0);
256 extern void fprintf_unfiltered (struct ui_file *, const char *, ...)
257 ATTRIBUTE_PRINTF (2, 3);
259 extern void printf_unfiltered (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
261 extern void print_spaces (int, struct ui_file *);
263 extern void print_spaces_filtered (int, struct ui_file *);
265 extern char *n_spaces (int);
267 extern void fputstr_filtered (const char *str, int quotr,
268 struct ui_file * stream);
270 extern void fputstr_unfiltered (const char *str, int quotr,
271 struct ui_file * stream);
273 extern void fputstrn_filtered (const char *str, int n, int quotr,
274 struct ui_file * stream);
276 extern void fputstrn_unfiltered (const char *str, int n, int quotr,
277 struct ui_file * stream);
279 /* Return nonzero if filtered printing is initialized. */
280 extern int filtered_printing_initialized (void);
282 /* Display the host ADDR on STREAM formatted as ``0x%x''. */
283 extern void gdb_print_host_address_1 (const void *addr, struct ui_file *stream);
285 /* Wrapper that avoids adding a pointless cast to all callers. */
286 #define gdb_print_host_address(ADDR, STREAM) \
287 gdb_print_host_address_1 ((const void *) ADDR, STREAM)
289 /* Convert CORE_ADDR to string in platform-specific manner.
290 This is usually formatted similar to 0x%lx. */
291 extern const char *paddress (struct gdbarch *gdbarch, CORE_ADDR addr);
293 /* Return a string representation in hexadecimal notation of ADDRESS,
294 which is suitable for printing. */
296 extern const char *print_core_address (struct gdbarch *gdbarch,
299 /* Callback hash_f and eq_f for htab_create_alloc or htab_create_alloc_ex. */
300 extern hashval_t core_addr_hash (const void *ap);
301 extern int core_addr_eq (const void *ap, const void *bp);
303 extern CORE_ADDR string_to_core_addr (const char *my_string);
305 extern void fprintf_symbol_filtered (struct ui_file *, const char *,
308 extern void throw_perror_with_name (enum errors errcode, const char *string)
311 extern void perror_warning_with_name (const char *string);
313 extern void print_sys_errmsg (const char *, int);
315 /* Warnings and error messages. */
317 extern void (*deprecated_error_begin_hook) (void);
319 /* Message to be printed before the warning message, when a warning occurs. */
321 extern const char *warning_pre_print;
323 extern void error_stream (const string_file &) ATTRIBUTE_NORETURN;
325 extern void demangler_vwarning (const char *file, int line,
326 const char *, va_list ap)
327 ATTRIBUTE_PRINTF (3, 0);
329 extern void demangler_warning (const char *file, int line,
330 const char *, ...) ATTRIBUTE_PRINTF (3, 4);
333 /* Misc. utilities. */
335 /* Allocation and deallocation functions for the libiberty hash table
336 which use obstacks. */
337 void *hashtab_obstack_allocate (void *data, size_t size, size_t count);
338 void dummy_obstack_deallocate (void *object, void *data);
341 extern pid_t wait_to_die_with_timeout (pid_t pid, int *status, int timeout);
344 extern int producer_is_gcc_ge_4 (const char *producer);
345 extern int producer_is_gcc (const char *producer, int *major, int *minor);
347 extern int myread (int, char *, int);
349 /* Ensure that V is aligned to an N byte boundary (B's assumed to be a
350 power of 2). Round up/down when necessary. Examples of correct
353 addr = align_up (addr, 8); -- VALUE needs 8 byte alignment
354 write_memory (addr, value, len);
359 sp = align_down (sp - len, 16); -- Keep SP 16 byte aligned
360 write_memory (sp, value, len);
362 Note that uses such as:
364 write_memory (addr, value, len);
365 addr += align_up (len, 8);
369 sp -= align_up (len, 8);
370 write_memory (sp, value, len);
372 are typically not correct as they don't ensure that the address (SP
373 or ADDR) is correctly aligned (relying on previous alignment to
374 keep things right). This is also why the methods are called
375 "align_..." instead of "round_..." as the latter reads better with
376 this incorrect coding style. */
378 extern ULONGEST align_up (ULONGEST v, int n);
379 extern ULONGEST align_down (ULONGEST v, int n);
381 /* Resource limits used by getrlimit and setrlimit. */
383 enum resource_limit_kind
389 /* Check whether GDB will be able to dump core using the dump_core
390 function. Returns zero if GDB cannot or should not dump core.
391 If LIMIT_KIND is LIMIT_CUR the user's soft limit will be respected.
392 If LIMIT_KIND is LIMIT_MAX only the hard limit will be respected. */
394 extern int can_dump_core (enum resource_limit_kind limit_kind);
396 /* Print a warning that we cannot dump core. */
398 extern void warn_cant_dump_core (const char *reason);
400 /* Dump core trying to increase the core soft limit to hard limit
403 extern void dump_core (void);
405 /* Return the hex string form of LENGTH bytes of DATA.
406 Space for the result is malloc'd, caller must free. */
408 extern char *make_hex_string (const gdb_byte *data, size_t length);