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 extern int strcmp_iw (const char *, const char *);
36 extern int strcmp_iw_ordered (const char *, const char *);
38 extern int streq (const char *, const char *);
40 extern int subset_compare (char *, char *);
42 int compare_positive_ints (const void *ap, const void *bp);
43 int compare_strings (const void *ap, const void *bp);
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. */
50 extern const char *gdb_bfd_errmsg (bfd_error_type error_tag, char **matching);
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. */
55 std::chrono::steady_clock::duration get_prompt_for_continue_wait_time ();
57 /* Parsing utilites. */
59 extern int parse_pid_to_attach (const char *args);
61 extern int parse_escape (struct gdbarch *, const char **);
63 char **gdb_buildargv (const char *);
65 /* Cleanup utilities. */
67 extern struct cleanup *make_cleanup_freeargv (char **);
70 extern struct cleanup *make_cleanup_ui_file_delete (struct ui_file *);
73 extern struct cleanup *
74 make_cleanup_ui_out_redirect_pop (struct ui_out *uiout);
76 struct section_addr_info;
77 extern struct cleanup *(make_cleanup_free_section_addr_info
78 (struct section_addr_info *));
80 /* For make_cleanup_close see common/filestuff.h. */
82 extern struct cleanup *make_cleanup_fclose (FILE *file);
85 extern struct cleanup *make_cleanup_obstack_free (struct obstack *obstack);
87 extern struct cleanup *make_cleanup_restore_integer (int *variable);
88 extern struct cleanup *make_cleanup_restore_uinteger (unsigned int *variable);
91 extern struct cleanup *make_cleanup_unpush_target (struct target_ops *ops);
93 extern struct cleanup *make_cleanup_value_free_to_mark (struct value *);
94 extern struct cleanup *make_cleanup_value_free (struct value *);
97 extern struct cleanup *make_cleanup_free_so (struct so_list *so);
99 extern struct cleanup *make_cleanup_restore_current_language (void);
101 /* A deleter for a hash table. */
104 void operator() (htab *ptr) const
110 /* A unique_ptr wrapper for htab_t. */
111 typedef std::unique_ptr<htab, htab_deleter> htab_up;
114 extern struct cleanup *make_cleanup_clear_parser_state
115 (struct parser_state **p);
117 extern void free_current_contents (void *);
119 extern void init_page_info (void);
121 extern struct cleanup *make_cleanup_restore_page_info (void);
122 extern struct cleanup *
123 set_batch_flag_and_make_cleanup_restore_page_info (void);
125 extern struct cleanup *make_bpstat_clear_actions_cleanup (void);
127 /* Path utilities. */
129 extern char *gdb_realpath (const char *);
131 extern char *gdb_realpath_keepfile (const char *);
133 extern char *gdb_abspath (const char *);
135 extern int gdb_filename_fnmatch (const char *pattern, const char *string,
138 extern void substitute_path_component (char **stringp, const char *from,
141 char *ldirname (const char *filename);
143 extern int count_path_elements (const char *path);
145 extern const char *strip_leading_path_elements (const char *path, int n);
147 /* GDB output, ui_file utilities. */
151 extern int query (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
152 extern int nquery (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
153 extern int yquery (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
155 extern void begin_line (void);
157 extern void wrap_here (const char *);
159 extern void reinitialize_more_filter (void);
161 extern int pagination_enabled;
163 extern struct ui_file **current_ui_gdb_stdout_ptr (void);
164 extern struct ui_file **current_ui_gdb_stdin_ptr (void);
165 extern struct ui_file **current_ui_gdb_stderr_ptr (void);
166 extern struct ui_file **current_ui_gdb_stdlog_ptr (void);
168 /* The current top level's ui_file streams. */
171 #define gdb_stdout (*current_ui_gdb_stdout_ptr ())
173 #define gdb_stdin (*current_ui_gdb_stdin_ptr ())
174 /* Serious error notifications */
175 #define gdb_stderr (*current_ui_gdb_stderr_ptr ())
176 /* Log/debug/trace messages that should bypass normal stdout/stderr
177 filtering. For moment, always call this stream using
178 *_unfiltered. In the very near future that restriction shall be
179 removed - either call shall be unfiltered. (cagney 1999-06-13). */
180 #define gdb_stdlog (*current_ui_gdb_stdlog_ptr ())
182 /* Truly global ui_file streams. These are all defined in main.c. */
184 /* Target output that should bypass normal stdout/stderr filtering.
185 For moment, always call this stream using *_unfiltered. In the
186 very near future that restriction shall be removed - either call
187 shall be unfiltered. (cagney 1999-07-02). */
188 extern struct ui_file *gdb_stdtarg;
189 extern struct ui_file *gdb_stdtargerr;
190 extern struct ui_file *gdb_stdtargin;
192 /* Return a null stream. */
193 extern struct ui_file *null_stream (void);
195 /* Set the screen dimensions to WIDTH and HEIGHT. */
197 extern void set_screen_width_and_height (int width, int height);
199 /* More generic printf like operations. Filtered versions may return
200 non-locally on error. */
202 extern void fputs_filtered (const char *, struct ui_file *);
204 extern void fputs_unfiltered (const char *, struct ui_file *);
206 extern int fputc_filtered (int c, struct ui_file *);
208 extern int fputc_unfiltered (int c, struct ui_file *);
210 extern int putchar_filtered (int c);
212 extern int putchar_unfiltered (int c);
214 extern void puts_filtered (const char *);
216 extern void puts_unfiltered (const char *);
218 extern void puts_filtered_tabular (char *string, int width, int right);
220 extern void puts_debug (char *prefix, char *string, char *suffix);
222 extern void vprintf_filtered (const char *, va_list) ATTRIBUTE_PRINTF (1, 0);
224 extern void vfprintf_filtered (struct ui_file *, const char *, va_list)
225 ATTRIBUTE_PRINTF (2, 0);
227 extern void fprintf_filtered (struct ui_file *, const char *, ...)
228 ATTRIBUTE_PRINTF (2, 3);
230 extern void fprintfi_filtered (int, struct ui_file *, const char *, ...)
231 ATTRIBUTE_PRINTF (3, 4);
233 extern void printf_filtered (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
235 extern void printfi_filtered (int, const char *, ...) ATTRIBUTE_PRINTF (2, 3);
237 extern void vprintf_unfiltered (const char *, va_list) ATTRIBUTE_PRINTF (1, 0);
239 extern void vfprintf_unfiltered (struct ui_file *, const char *, va_list)
240 ATTRIBUTE_PRINTF (2, 0);
242 extern void fprintf_unfiltered (struct ui_file *, const char *, ...)
243 ATTRIBUTE_PRINTF (2, 3);
245 extern void printf_unfiltered (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
247 extern void print_spaces (int, struct ui_file *);
249 extern void print_spaces_filtered (int, struct ui_file *);
251 extern char *n_spaces (int);
253 extern void fputstr_filtered (const char *str, int quotr,
254 struct ui_file * stream);
256 extern void fputstr_unfiltered (const char *str, int quotr,
257 struct ui_file * stream);
259 extern void fputstrn_filtered (const char *str, int n, int quotr,
260 struct ui_file * stream);
262 extern void fputstrn_unfiltered (const char *str, int n, int quotr,
263 struct ui_file * stream);
265 /* Return nonzero if filtered printing is initialized. */
266 extern int filtered_printing_initialized (void);
268 /* Display the host ADDR on STREAM formatted as ``0x%x''. */
269 extern void gdb_print_host_address_1 (const void *addr, struct ui_file *stream);
271 /* Wrapper that avoids adding a pointless cast to all callers. */
272 #define gdb_print_host_address(ADDR, STREAM) \
273 gdb_print_host_address_1 ((const void *) ADDR, STREAM)
275 /* Convert CORE_ADDR to string in platform-specific manner.
276 This is usually formatted similar to 0x%lx. */
277 extern const char *paddress (struct gdbarch *gdbarch, CORE_ADDR addr);
279 /* Return a string representation in hexadecimal notation of ADDRESS,
280 which is suitable for printing. */
282 extern const char *print_core_address (struct gdbarch *gdbarch,
285 /* Callback hash_f and eq_f for htab_create_alloc or htab_create_alloc_ex. */
286 extern hashval_t core_addr_hash (const void *ap);
287 extern int core_addr_eq (const void *ap, const void *bp);
289 extern CORE_ADDR string_to_core_addr (const char *my_string);
291 extern void fprintf_symbol_filtered (struct ui_file *, const char *,
294 extern void throw_perror_with_name (enum errors errcode, const char *string)
297 extern void perror_warning_with_name (const char *string);
299 extern void print_sys_errmsg (const char *, int);
301 /* Warnings and error messages. */
303 extern void (*deprecated_error_begin_hook) (void);
305 /* Message to be printed before the warning message, when a warning occurs. */
307 extern char *warning_pre_print;
309 extern void error_stream (struct ui_file *) ATTRIBUTE_NORETURN;
311 extern void demangler_vwarning (const char *file, int line,
312 const char *, va_list ap)
313 ATTRIBUTE_PRINTF (3, 0);
315 extern void demangler_warning (const char *file, int line,
316 const char *, ...) ATTRIBUTE_PRINTF (3, 4);
319 /* Misc. utilities. */
321 /* Allocation and deallocation functions for the libiberty hash table
322 which use obstacks. */
323 void *hashtab_obstack_allocate (void *data, size_t size, size_t count);
324 void dummy_obstack_deallocate (void *object, void *data);
327 extern pid_t wait_to_die_with_timeout (pid_t pid, int *status, int timeout);
330 extern int producer_is_gcc_ge_4 (const char *producer);
331 extern int producer_is_gcc (const char *producer, int *major, int *minor);
333 extern int myread (int, char *, int);
335 /* Ensure that V is aligned to an N byte boundary (B's assumed to be a
336 power of 2). Round up/down when necessary. Examples of correct
339 addr = align_up (addr, 8); -- VALUE needs 8 byte alignment
340 write_memory (addr, value, len);
345 sp = align_down (sp - len, 16); -- Keep SP 16 byte aligned
346 write_memory (sp, value, len);
348 Note that uses such as:
350 write_memory (addr, value, len);
351 addr += align_up (len, 8);
355 sp -= align_up (len, 8);
356 write_memory (sp, value, len);
358 are typically not correct as they don't ensure that the address (SP
359 or ADDR) is correctly aligned (relying on previous alignment to
360 keep things right). This is also why the methods are called
361 "align_..." instead of "round_..." as the latter reads better with
362 this incorrect coding style. */
364 extern ULONGEST align_up (ULONGEST v, int n);
365 extern ULONGEST align_down (ULONGEST v, int n);
367 /* Resource limits used by getrlimit and setrlimit. */
369 enum resource_limit_kind
375 /* Check whether GDB will be able to dump core using the dump_core
376 function. Returns zero if GDB cannot or should not dump core.
377 If LIMIT_KIND is LIMIT_CUR the user's soft limit will be respected.
378 If LIMIT_KIND is LIMIT_MAX only the hard limit will be respected. */
380 extern int can_dump_core (enum resource_limit_kind limit_kind);
382 /* Print a warning that we cannot dump core. */
384 extern void warn_cant_dump_core (const char *reason);
386 /* Dump core trying to increase the core soft limit to hard limit
389 extern void dump_core (void);
391 /* Return the hex string form of LENGTH bytes of DATA.
392 Space for the result is malloc'd, caller must free. */
394 extern char *make_hex_string (const gdb_byte *data, size_t length);