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 /* A wrapper for an array of char* that was allocated in the way that
89 'buildargv' does, and should be freed with 'freeargv'. */
95 /* A constructor that initializes to NULL. */
102 /* A constructor that calls buildargv on STR. STR may be NULL, in
103 which case this object is initialized with a NULL array. If
104 buildargv fails due to out-of-memory, call malloc_failure.
105 Therefore, the value is guaranteed to be non-NULL, unless the
106 parameter itself is NULL. */
108 explicit gdb_argv (const char *str)
114 /* A constructor that takes ownership of an existing array. */
116 explicit gdb_argv (char **array)
121 gdb_argv (const gdb_argv &) = delete;
122 gdb_argv &operator= (const gdb_argv &) = delete;
129 /* Call buildargv on STR, storing the result in this object. Any
130 previous state is freed. STR may be NULL, in which case this
131 object is reset with a NULL array. If buildargv fails due to
132 out-of-memory, call malloc_failure. Therefore, the value is
133 guaranteed to be non-NULL, unless the parameter itself is
136 void reset (const char *str);
138 /* Return the underlying array. */
145 /* Return the underlying array, transferring ownership to the
150 char **result = m_argv;
155 /* Return the number of items in the array. */
159 return countargv (m_argv);
162 /* Index into the array. */
164 char *operator[] (int arg)
166 gdb_assert (m_argv != NULL);
170 /* The iterator type. */
172 typedef char **iterator;
174 /* Return an iterator pointing to the start of the array. */
181 /* Return an iterator pointing to the end of the array. */
185 return m_argv + count ();
188 bool operator!= (nullptr_t)
190 return m_argv != NULL;
193 bool operator== (nullptr_t)
195 return m_argv == NULL;
200 /* The wrapped array. */
206 /* Cleanup utilities. */
209 extern struct cleanup *
210 make_cleanup_ui_out_redirect_pop (struct ui_out *uiout);
212 struct section_addr_info;
213 extern struct cleanup *(make_cleanup_free_section_addr_info
214 (struct section_addr_info *));
216 /* For make_cleanup_close see common/filestuff.h. */
218 extern struct cleanup *make_cleanup_restore_integer (int *variable);
219 extern struct cleanup *make_cleanup_restore_uinteger (unsigned int *variable);
222 extern struct cleanup *make_cleanup_unpush_target (struct target_ops *ops);
224 extern struct cleanup *make_cleanup_value_free_to_mark (struct value *);
225 extern struct cleanup *make_cleanup_value_free (struct value *);
227 /* A deleter for a hash table. */
230 void operator() (htab *ptr) const
236 /* A unique_ptr wrapper for htab_t. */
237 typedef std::unique_ptr<htab, htab_deleter> htab_up;
240 extern struct cleanup *make_cleanup_clear_parser_state
241 (struct parser_state **p);
243 extern void free_current_contents (void *);
245 extern void init_page_info (void);
247 extern struct cleanup *make_cleanup_restore_page_info (void);
248 extern struct cleanup *
249 set_batch_flag_and_make_cleanup_restore_page_info (void);
251 extern struct cleanup *make_bpstat_clear_actions_cleanup (void);
253 /* Path utilities. */
255 extern char *gdb_realpath (const char *);
257 extern char *gdb_realpath_keepfile (const char *);
259 extern char *gdb_abspath (const char *);
261 extern int gdb_filename_fnmatch (const char *pattern, const char *string,
264 extern void substitute_path_component (char **stringp, const char *from,
267 std::string ldirname (const char *filename);
269 extern int count_path_elements (const char *path);
271 extern const char *strip_leading_path_elements (const char *path, int n);
273 /* GDB output, ui_file utilities. */
277 extern int query (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
278 extern int nquery (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
279 extern int yquery (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
281 extern void begin_line (void);
283 extern void wrap_here (const char *);
285 extern void reinitialize_more_filter (void);
287 extern int pagination_enabled;
289 extern struct ui_file **current_ui_gdb_stdout_ptr (void);
290 extern struct ui_file **current_ui_gdb_stdin_ptr (void);
291 extern struct ui_file **current_ui_gdb_stderr_ptr (void);
292 extern struct ui_file **current_ui_gdb_stdlog_ptr (void);
294 /* The current top level's ui_file streams. */
297 #define gdb_stdout (*current_ui_gdb_stdout_ptr ())
299 #define gdb_stdin (*current_ui_gdb_stdin_ptr ())
300 /* Serious error notifications */
301 #define gdb_stderr (*current_ui_gdb_stderr_ptr ())
302 /* Log/debug/trace messages that should bypass normal stdout/stderr
303 filtering. For moment, always call this stream using
304 *_unfiltered. In the very near future that restriction shall be
305 removed - either call shall be unfiltered. (cagney 1999-06-13). */
306 #define gdb_stdlog (*current_ui_gdb_stdlog_ptr ())
308 /* Truly global ui_file streams. These are all defined in main.c. */
310 /* Target output that should bypass normal stdout/stderr filtering.
311 For moment, always call this stream using *_unfiltered. In the
312 very near future that restriction shall be removed - either call
313 shall be unfiltered. (cagney 1999-07-02). */
314 extern struct ui_file *gdb_stdtarg;
315 extern struct ui_file *gdb_stdtargerr;
316 extern struct ui_file *gdb_stdtargin;
318 /* Set the screen dimensions to WIDTH and HEIGHT. */
320 extern void set_screen_width_and_height (int width, int height);
322 /* More generic printf like operations. Filtered versions may return
323 non-locally on error. */
325 extern void fputs_filtered (const char *, struct ui_file *);
327 extern void fputs_unfiltered (const char *, struct ui_file *);
329 extern int fputc_filtered (int c, struct ui_file *);
331 extern int fputc_unfiltered (int c, struct ui_file *);
333 extern int putchar_filtered (int c);
335 extern int putchar_unfiltered (int c);
337 extern void puts_filtered (const char *);
339 extern void puts_unfiltered (const char *);
341 extern void puts_filtered_tabular (char *string, int width, int right);
343 extern void puts_debug (char *prefix, char *string, char *suffix);
345 extern void vprintf_filtered (const char *, va_list) ATTRIBUTE_PRINTF (1, 0);
347 extern void vfprintf_filtered (struct ui_file *, const char *, va_list)
348 ATTRIBUTE_PRINTF (2, 0);
350 extern void fprintf_filtered (struct ui_file *, const char *, ...)
351 ATTRIBUTE_PRINTF (2, 3);
353 extern void fprintfi_filtered (int, struct ui_file *, const char *, ...)
354 ATTRIBUTE_PRINTF (3, 4);
356 extern void printf_filtered (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
358 extern void printfi_filtered (int, const char *, ...) ATTRIBUTE_PRINTF (2, 3);
360 extern void vprintf_unfiltered (const char *, va_list) ATTRIBUTE_PRINTF (1, 0);
362 extern void vfprintf_unfiltered (struct ui_file *, const char *, va_list)
363 ATTRIBUTE_PRINTF (2, 0);
365 extern void fprintf_unfiltered (struct ui_file *, const char *, ...)
366 ATTRIBUTE_PRINTF (2, 3);
368 extern void printf_unfiltered (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
370 extern void print_spaces (int, struct ui_file *);
372 extern void print_spaces_filtered (int, struct ui_file *);
374 extern char *n_spaces (int);
376 extern void fputstr_filtered (const char *str, int quotr,
377 struct ui_file * stream);
379 extern void fputstr_unfiltered (const char *str, int quotr,
380 struct ui_file * stream);
382 extern void fputstrn_filtered (const char *str, int n, int quotr,
383 struct ui_file * stream);
385 extern void fputstrn_unfiltered (const char *str, int n, int quotr,
386 struct ui_file * stream);
388 /* Return nonzero if filtered printing is initialized. */
389 extern int filtered_printing_initialized (void);
391 /* Display the host ADDR on STREAM formatted as ``0x%x''. */
392 extern void gdb_print_host_address_1 (const void *addr, struct ui_file *stream);
394 /* Wrapper that avoids adding a pointless cast to all callers. */
395 #define gdb_print_host_address(ADDR, STREAM) \
396 gdb_print_host_address_1 ((const void *) ADDR, STREAM)
398 /* Convert CORE_ADDR to string in platform-specific manner.
399 This is usually formatted similar to 0x%lx. */
400 extern const char *paddress (struct gdbarch *gdbarch, CORE_ADDR addr);
402 /* Return a string representation in hexadecimal notation of ADDRESS,
403 which is suitable for printing. */
405 extern const char *print_core_address (struct gdbarch *gdbarch,
408 /* Callback hash_f and eq_f for htab_create_alloc or htab_create_alloc_ex. */
409 extern hashval_t core_addr_hash (const void *ap);
410 extern int core_addr_eq (const void *ap, const void *bp);
412 extern CORE_ADDR string_to_core_addr (const char *my_string);
414 extern void fprintf_symbol_filtered (struct ui_file *, const char *,
417 extern void throw_perror_with_name (enum errors errcode, const char *string)
420 extern void perror_warning_with_name (const char *string);
422 extern void print_sys_errmsg (const char *, int);
424 /* Warnings and error messages. */
426 extern void (*deprecated_error_begin_hook) (void);
428 /* Message to be printed before the warning message, when a warning occurs. */
430 extern const char *warning_pre_print;
432 extern void error_stream (const string_file &) ATTRIBUTE_NORETURN;
434 extern void demangler_vwarning (const char *file, int line,
435 const char *, va_list ap)
436 ATTRIBUTE_PRINTF (3, 0);
438 extern void demangler_warning (const char *file, int line,
439 const char *, ...) ATTRIBUTE_PRINTF (3, 4);
442 /* Misc. utilities. */
444 /* Allocation and deallocation functions for the libiberty hash table
445 which use obstacks. */
446 void *hashtab_obstack_allocate (void *data, size_t size, size_t count);
447 void dummy_obstack_deallocate (void *object, void *data);
450 extern pid_t wait_to_die_with_timeout (pid_t pid, int *status, int timeout);
453 extern int producer_is_gcc_ge_4 (const char *producer);
454 extern int producer_is_gcc (const char *producer, int *major, int *minor);
456 extern int myread (int, char *, int);
458 /* Ensure that V is aligned to an N byte boundary (B's assumed to be a
459 power of 2). Round up/down when necessary. Examples of correct
462 addr = align_up (addr, 8); -- VALUE needs 8 byte alignment
463 write_memory (addr, value, len);
468 sp = align_down (sp - len, 16); -- Keep SP 16 byte aligned
469 write_memory (sp, value, len);
471 Note that uses such as:
473 write_memory (addr, value, len);
474 addr += align_up (len, 8);
478 sp -= align_up (len, 8);
479 write_memory (sp, value, len);
481 are typically not correct as they don't ensure that the address (SP
482 or ADDR) is correctly aligned (relying on previous alignment to
483 keep things right). This is also why the methods are called
484 "align_..." instead of "round_..." as the latter reads better with
485 this incorrect coding style. */
487 extern ULONGEST align_up (ULONGEST v, int n);
488 extern ULONGEST align_down (ULONGEST v, int n);
490 /* Resource limits used by getrlimit and setrlimit. */
492 enum resource_limit_kind
498 /* Check whether GDB will be able to dump core using the dump_core
499 function. Returns zero if GDB cannot or should not dump core.
500 If LIMIT_KIND is LIMIT_CUR the user's soft limit will be respected.
501 If LIMIT_KIND is LIMIT_MAX only the hard limit will be respected. */
503 extern int can_dump_core (enum resource_limit_kind limit_kind);
505 /* Print a warning that we cannot dump core. */
507 extern void warn_cant_dump_core (const char *reason);
509 /* Dump core trying to increase the core soft limit to hard limit
512 extern void dump_core (void);
514 /* Return the hex string form of LENGTH bytes of DATA.
515 Space for the result is malloc'd, caller must free. */
517 extern char *make_hex_string (const gdb_byte *data, size_t length);