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!= (std::nullptr_t)
190 return m_argv != NULL;
193 bool operator== (std::nullptr_t)
195 return m_argv == NULL;
200 /* The wrapped array. */
206 /* Cleanup utilities. */
208 struct section_addr_info;
209 extern struct cleanup *(make_cleanup_free_section_addr_info
210 (struct section_addr_info *));
212 /* For make_cleanup_close see common/filestuff.h. */
215 extern struct cleanup *make_cleanup_unpush_target (struct target_ops *ops);
217 extern struct cleanup *make_cleanup_value_free_to_mark (struct value *);
218 extern struct cleanup *make_cleanup_value_free (struct value *);
220 /* A deleter for a hash table. */
223 void operator() (htab *ptr) const
229 /* A unique_ptr wrapper for htab_t. */
230 typedef std::unique_ptr<htab, htab_deleter> htab_up;
232 extern void free_current_contents (void *);
234 extern void init_page_info (void);
236 /* Temporarily set BATCH_FLAG and the associated unlimited terminal size.
237 Restore when destroyed. */
239 struct set_batch_flag_and_restore_page_info
243 set_batch_flag_and_restore_page_info ();
244 ~set_batch_flag_and_restore_page_info ();
246 DISABLE_COPY_AND_ASSIGN (set_batch_flag_and_restore_page_info);
250 /* Note that this doesn't use scoped_restore, because it's important
251 to control the ordering of operations in the destruction, and it
252 was simpler to avoid introducing a new ad hoc class. */
253 unsigned m_save_lines_per_page;
254 unsigned m_save_chars_per_line;
255 int m_save_batch_flag;
258 extern struct cleanup *make_bpstat_clear_actions_cleanup (void);
260 /* Path utilities. */
262 extern gdb::unique_xmalloc_ptr<char> gdb_realpath (const char *);
264 extern gdb::unique_xmalloc_ptr<char> gdb_realpath_keepfile (const char *);
266 extern gdb::unique_xmalloc_ptr<char> gdb_abspath (const char *);
268 extern int gdb_filename_fnmatch (const char *pattern, const char *string,
271 extern void substitute_path_component (char **stringp, const char *from,
274 std::string ldirname (const char *filename);
276 extern int count_path_elements (const char *path);
278 extern const char *strip_leading_path_elements (const char *path, int n);
280 /* GDB output, ui_file utilities. */
284 extern int query (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
285 extern int nquery (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
286 extern int yquery (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
288 extern void begin_line (void);
290 extern void wrap_here (const char *);
292 extern void reinitialize_more_filter (void);
294 extern int pagination_enabled;
296 extern struct ui_file **current_ui_gdb_stdout_ptr (void);
297 extern struct ui_file **current_ui_gdb_stdin_ptr (void);
298 extern struct ui_file **current_ui_gdb_stderr_ptr (void);
299 extern struct ui_file **current_ui_gdb_stdlog_ptr (void);
301 /* The current top level's ui_file streams. */
304 #define gdb_stdout (*current_ui_gdb_stdout_ptr ())
306 #define gdb_stdin (*current_ui_gdb_stdin_ptr ())
307 /* Serious error notifications */
308 #define gdb_stderr (*current_ui_gdb_stderr_ptr ())
309 /* Log/debug/trace messages that should bypass normal stdout/stderr
310 filtering. For moment, always call this stream using
311 *_unfiltered. In the very near future that restriction shall be
312 removed - either call shall be unfiltered. (cagney 1999-06-13). */
313 #define gdb_stdlog (*current_ui_gdb_stdlog_ptr ())
315 /* Truly global ui_file streams. These are all defined in main.c. */
317 /* Target output that should bypass normal stdout/stderr filtering.
318 For moment, always call this stream using *_unfiltered. In the
319 very near future that restriction shall be removed - either call
320 shall be unfiltered. (cagney 1999-07-02). */
321 extern struct ui_file *gdb_stdtarg;
322 extern struct ui_file *gdb_stdtargerr;
323 extern struct ui_file *gdb_stdtargin;
325 /* Set the screen dimensions to WIDTH and HEIGHT. */
327 extern void set_screen_width_and_height (int width, int height);
329 /* More generic printf like operations. Filtered versions may return
330 non-locally on error. */
332 extern void fputs_filtered (const char *, struct ui_file *);
334 extern void fputs_unfiltered (const char *, struct ui_file *);
336 extern int fputc_filtered (int c, struct ui_file *);
338 extern int fputc_unfiltered (int c, struct ui_file *);
340 extern int putchar_filtered (int c);
342 extern int putchar_unfiltered (int c);
344 extern void puts_filtered (const char *);
346 extern void puts_unfiltered (const char *);
348 extern void puts_filtered_tabular (char *string, int width, int right);
350 extern void puts_debug (char *prefix, char *string, char *suffix);
352 extern void vprintf_filtered (const char *, va_list) ATTRIBUTE_PRINTF (1, 0);
354 extern void vfprintf_filtered (struct ui_file *, const char *, va_list)
355 ATTRIBUTE_PRINTF (2, 0);
357 extern void fprintf_filtered (struct ui_file *, const char *, ...)
358 ATTRIBUTE_PRINTF (2, 3);
360 extern void fprintfi_filtered (int, struct ui_file *, const char *, ...)
361 ATTRIBUTE_PRINTF (3, 4);
363 extern void printf_filtered (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
365 extern void printfi_filtered (int, const char *, ...) ATTRIBUTE_PRINTF (2, 3);
367 extern void vprintf_unfiltered (const char *, va_list) ATTRIBUTE_PRINTF (1, 0);
369 extern void vfprintf_unfiltered (struct ui_file *, const char *, va_list)
370 ATTRIBUTE_PRINTF (2, 0);
372 extern void fprintf_unfiltered (struct ui_file *, const char *, ...)
373 ATTRIBUTE_PRINTF (2, 3);
375 extern void printf_unfiltered (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
377 extern void print_spaces (int, struct ui_file *);
379 extern void print_spaces_filtered (int, struct ui_file *);
381 extern char *n_spaces (int);
383 extern void fputstr_filtered (const char *str, int quotr,
384 struct ui_file * stream);
386 extern void fputstr_unfiltered (const char *str, int quotr,
387 struct ui_file * stream);
389 extern void fputstrn_filtered (const char *str, int n, int quotr,
390 struct ui_file * stream);
392 extern void fputstrn_unfiltered (const char *str, int n, int quotr,
393 struct ui_file * stream);
395 /* Return nonzero if filtered printing is initialized. */
396 extern int filtered_printing_initialized (void);
398 /* Display the host ADDR on STREAM formatted as ``0x%x''. */
399 extern void gdb_print_host_address_1 (const void *addr, struct ui_file *stream);
401 /* Wrapper that avoids adding a pointless cast to all callers. */
402 #define gdb_print_host_address(ADDR, STREAM) \
403 gdb_print_host_address_1 ((const void *) ADDR, STREAM)
405 /* Convert CORE_ADDR to string in platform-specific manner.
406 This is usually formatted similar to 0x%lx. */
407 extern const char *paddress (struct gdbarch *gdbarch, CORE_ADDR addr);
409 /* Return a string representation in hexadecimal notation of ADDRESS,
410 which is suitable for printing. */
412 extern const char *print_core_address (struct gdbarch *gdbarch,
415 /* Callback hash_f and eq_f for htab_create_alloc or htab_create_alloc_ex. */
416 extern hashval_t core_addr_hash (const void *ap);
417 extern int core_addr_eq (const void *ap, const void *bp);
419 extern CORE_ADDR string_to_core_addr (const char *my_string);
421 extern void fprintf_symbol_filtered (struct ui_file *, const char *,
424 extern void throw_perror_with_name (enum errors errcode, const char *string)
427 extern void perror_warning_with_name (const char *string);
429 extern void print_sys_errmsg (const char *, int);
431 /* Warnings and error messages. */
433 extern void (*deprecated_error_begin_hook) (void);
435 /* Message to be printed before the warning message, when a warning occurs. */
437 extern const char *warning_pre_print;
439 extern void error_stream (const string_file &) ATTRIBUTE_NORETURN;
441 extern void demangler_vwarning (const char *file, int line,
442 const char *, va_list ap)
443 ATTRIBUTE_PRINTF (3, 0);
445 extern void demangler_warning (const char *file, int line,
446 const char *, ...) ATTRIBUTE_PRINTF (3, 4);
449 /* Misc. utilities. */
451 /* Allocation and deallocation functions for the libiberty hash table
452 which use obstacks. */
453 void *hashtab_obstack_allocate (void *data, size_t size, size_t count);
454 void dummy_obstack_deallocate (void *object, void *data);
457 extern pid_t wait_to_die_with_timeout (pid_t pid, int *status, int timeout);
460 extern int myread (int, char *, int);
462 /* Ensure that V is aligned to an N byte boundary (B's assumed to be a
463 power of 2). Round up/down when necessary. Examples of correct
466 addr = align_up (addr, 8); -- VALUE needs 8 byte alignment
467 write_memory (addr, value, len);
472 sp = align_down (sp - len, 16); -- Keep SP 16 byte aligned
473 write_memory (sp, value, len);
475 Note that uses such as:
477 write_memory (addr, value, len);
478 addr += align_up (len, 8);
482 sp -= align_up (len, 8);
483 write_memory (sp, value, len);
485 are typically not correct as they don't ensure that the address (SP
486 or ADDR) is correctly aligned (relying on previous alignment to
487 keep things right). This is also why the methods are called
488 "align_..." instead of "round_..." as the latter reads better with
489 this incorrect coding style. */
491 extern ULONGEST align_up (ULONGEST v, int n);
492 extern ULONGEST align_down (ULONGEST v, int n);
494 /* Resource limits used by getrlimit and setrlimit. */
496 enum resource_limit_kind
502 /* Check whether GDB will be able to dump core using the dump_core
503 function. Returns zero if GDB cannot or should not dump core.
504 If LIMIT_KIND is LIMIT_CUR the user's soft limit will be respected.
505 If LIMIT_KIND is LIMIT_MAX only the hard limit will be respected. */
507 extern int can_dump_core (enum resource_limit_kind limit_kind);
509 /* Print a warning that we cannot dump core. */
511 extern void warn_cant_dump_core (const char *reason);
513 /* Dump core trying to increase the core soft limit to hard limit
516 extern void dump_core (void);
518 /* Return the hex string form of LENGTH bytes of DATA.
519 Space for the result is malloc'd, caller must free. */
521 extern char *make_hex_string (const gdb_byte *data, size_t length);