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-2018 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 /* Modes of operation for strncmp_iw_with_mode. */
36 enum class strncmp_iw_mode
38 /* Do a strcmp() type operation on STRING1 and STRING2, ignoring any
39 differences in whitespace. Returns 0 if they match, non-zero if
40 they don't (slightly different than strcmp()'s range of return
44 /* Like NORMAL, but also apply the strcmp_iw hack. I.e.,
45 string1=="FOO(PARAMS)" matches string2=="FOO". */
49 /* Helper for strcmp_iw and strncmp_iw. Exported so that languages
50 can implement both NORMAL and MATCH_PARAMS variants in a single
51 function and defer part of the work to strncmp_iw_with_mode.
53 LANGUAGE is used to implement some context-sensitive
54 language-specific comparisons. For example, for C++,
55 "string1=operator()" should not match "string2=operator" even in
58 MATCH_FOR_LCD is passed down so that the function can mark parts of
59 the symbol name as ignored for completion matching purposes (e.g.,
60 to handle abi tags). */
61 extern int strncmp_iw_with_mode
62 (const char *string1, const char *string2, size_t string2_len,
63 strncmp_iw_mode mode, enum language language,
64 completion_match_for_lcd *match_for_lcd = NULL);
66 /* Do a strncmp() type operation on STRING1 and STRING2, ignoring any
67 differences in whitespace. STRING2_LEN is STRING2's length.
68 Returns 0 if STRING1 matches STRING2_LEN characters of STRING2,
69 non-zero otherwise (slightly different than strncmp()'s range of
70 return values). Note: passes language_minimal to
71 strncmp_iw_with_mode, and should therefore be avoided if a more
72 suitable language is available. */
73 extern int strncmp_iw (const char *string1, const char *string2,
76 /* Do a strcmp() type operation on STRING1 and STRING2, ignoring any
77 differences in whitespace. Returns 0 if they match, non-zero if
78 they don't (slightly different than strcmp()'s range of return
81 As an extra hack, string1=="FOO(ARGS)" matches string2=="FOO".
82 This "feature" is useful when searching for matching C++ function
83 names (such as if the user types 'break FOO', where FOO is a
84 mangled C++ function).
86 Note: passes language_minimal to strncmp_iw_with_mode, and should
87 therefore be avoided if a more suitable language is available. */
88 extern int strcmp_iw (const char *string1, const char *string2);
90 extern int strcmp_iw_ordered (const char *, const char *);
92 /* Return true if the strings are equal. */
94 extern bool streq (const char *, const char *);
96 /* A variant of streq that is suitable for use as an htab
99 extern int streq_hash (const void *, const void *);
101 extern int subset_compare (const char *, const char *);
103 int compare_positive_ints (const void *ap, const void *bp);
105 /* Compare C strings for std::sort. */
108 compare_cstrings (const char *str1, const char *str2)
110 return strcmp (str1, str2) < 0;
113 /* A wrapper for bfd_errmsg to produce a more helpful error message
114 in the case of bfd_error_file_ambiguously recognized.
115 MATCHING, if non-NULL, is the corresponding argument to
116 bfd_check_format_matches, and will be freed. */
118 extern const char *gdb_bfd_errmsg (bfd_error_type error_tag, char **matching);
120 /* Reset the prompt_for_continue clock. */
121 void reset_prompt_for_continue_wait_time (void);
122 /* Return the time spent in prompt_for_continue. */
123 std::chrono::steady_clock::duration get_prompt_for_continue_wait_time ();
125 /* Parsing utilites. */
127 extern int parse_pid_to_attach (const char *args);
129 extern int parse_escape (struct gdbarch *, const char **);
131 /* A wrapper for an array of char* that was allocated in the way that
132 'buildargv' does, and should be freed with 'freeargv'. */
138 /* A constructor that initializes to NULL. */
145 /* A constructor that calls buildargv on STR. STR may be NULL, in
146 which case this object is initialized with a NULL array. If
147 buildargv fails due to out-of-memory, call malloc_failure.
148 Therefore, the value is guaranteed to be non-NULL, unless the
149 parameter itself is NULL. */
151 explicit gdb_argv (const char *str)
157 /* A constructor that takes ownership of an existing array. */
159 explicit gdb_argv (char **array)
164 gdb_argv (const gdb_argv &) = delete;
165 gdb_argv &operator= (const gdb_argv &) = delete;
172 /* Call buildargv on STR, storing the result in this object. Any
173 previous state is freed. STR may be NULL, in which case this
174 object is reset with a NULL array. If buildargv fails due to
175 out-of-memory, call malloc_failure. Therefore, the value is
176 guaranteed to be non-NULL, unless the parameter itself is
179 void reset (const char *str);
181 /* Return the underlying array. */
188 /* Return the underlying array, transferring ownership to the
193 char **result = m_argv;
198 /* Return the number of items in the array. */
202 return countargv (m_argv);
205 /* Index into the array. */
207 char *operator[] (int arg)
209 gdb_assert (m_argv != NULL);
213 /* The iterator type. */
215 typedef char **iterator;
217 /* Return an iterator pointing to the start of the array. */
224 /* Return an iterator pointing to the end of the array. */
228 return m_argv + count ();
231 bool operator!= (std::nullptr_t)
233 return m_argv != NULL;
236 bool operator== (std::nullptr_t)
238 return m_argv == NULL;
243 /* The wrapped array. */
249 /* Cleanup utilities. */
251 /* For make_cleanup_close see common/filestuff.h. */
253 extern struct cleanup *make_cleanup_value_free_to_mark (struct value *);
255 /* A deleter for a hash table. */
258 void operator() (htab *ptr) const
264 /* A unique_ptr wrapper for htab_t. */
265 typedef std::unique_ptr<htab, htab_deleter> htab_up;
267 extern void free_current_contents (void *);
269 extern void init_page_info (void);
271 /* Temporarily set BATCH_FLAG and the associated unlimited terminal size.
272 Restore when destroyed. */
274 struct set_batch_flag_and_restore_page_info
278 set_batch_flag_and_restore_page_info ();
279 ~set_batch_flag_and_restore_page_info ();
281 DISABLE_COPY_AND_ASSIGN (set_batch_flag_and_restore_page_info);
285 /* Note that this doesn't use scoped_restore, because it's important
286 to control the ordering of operations in the destruction, and it
287 was simpler to avoid introducing a new ad hoc class. */
288 unsigned m_save_lines_per_page;
289 unsigned m_save_chars_per_line;
290 int m_save_batch_flag;
293 extern struct cleanup *make_bpstat_clear_actions_cleanup (void);
295 /* Path utilities. */
297 extern int gdb_filename_fnmatch (const char *pattern, const char *string,
300 extern void substitute_path_component (char **stringp, const char *from,
303 std::string ldirname (const char *filename);
305 extern int count_path_elements (const char *path);
307 extern const char *strip_leading_path_elements (const char *path, int n);
309 /* GDB output, ui_file utilities. */
313 extern int query (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
314 extern int nquery (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
315 extern int yquery (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
317 extern void begin_line (void);
319 extern void wrap_here (const char *);
321 extern void reinitialize_more_filter (void);
323 extern int pagination_enabled;
325 extern struct ui_file **current_ui_gdb_stdout_ptr (void);
326 extern struct ui_file **current_ui_gdb_stdin_ptr (void);
327 extern struct ui_file **current_ui_gdb_stderr_ptr (void);
328 extern struct ui_file **current_ui_gdb_stdlog_ptr (void);
330 /* The current top level's ui_file streams. */
333 #define gdb_stdout (*current_ui_gdb_stdout_ptr ())
335 #define gdb_stdin (*current_ui_gdb_stdin_ptr ())
336 /* Serious error notifications */
337 #define gdb_stderr (*current_ui_gdb_stderr_ptr ())
338 /* Log/debug/trace messages that should bypass normal stdout/stderr
339 filtering. For moment, always call this stream using
340 *_unfiltered. In the very near future that restriction shall be
341 removed - either call shall be unfiltered. (cagney 1999-06-13). */
342 #define gdb_stdlog (*current_ui_gdb_stdlog_ptr ())
344 /* Truly global ui_file streams. These are all defined in main.c. */
346 /* Target output that should bypass normal stdout/stderr filtering.
347 For moment, always call this stream using *_unfiltered. In the
348 very near future that restriction shall be removed - either call
349 shall be unfiltered. (cagney 1999-07-02). */
350 extern struct ui_file *gdb_stdtarg;
351 extern struct ui_file *gdb_stdtargerr;
352 extern struct ui_file *gdb_stdtargin;
354 /* Set the screen dimensions to WIDTH and HEIGHT. */
356 extern void set_screen_width_and_height (int width, int height);
358 /* More generic printf like operations. Filtered versions may return
359 non-locally on error. */
361 extern void fputs_filtered (const char *, struct ui_file *);
363 extern void fputs_unfiltered (const char *, struct ui_file *);
365 extern int fputc_filtered (int c, struct ui_file *);
367 extern int fputc_unfiltered (int c, struct ui_file *);
369 extern int putchar_filtered (int c);
371 extern int putchar_unfiltered (int c);
373 extern void puts_filtered (const char *);
375 extern void puts_unfiltered (const char *);
377 extern void puts_filtered_tabular (char *string, int width, int right);
379 extern void puts_debug (char *prefix, char *string, char *suffix);
381 extern void vprintf_filtered (const char *, va_list) ATTRIBUTE_PRINTF (1, 0);
383 extern void vfprintf_filtered (struct ui_file *, const char *, va_list)
384 ATTRIBUTE_PRINTF (2, 0);
386 extern void fprintf_filtered (struct ui_file *, const char *, ...)
387 ATTRIBUTE_PRINTF (2, 3);
389 extern void fprintfi_filtered (int, struct ui_file *, const char *, ...)
390 ATTRIBUTE_PRINTF (3, 4);
392 extern void printf_filtered (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
394 extern void printfi_filtered (int, const char *, ...) ATTRIBUTE_PRINTF (2, 3);
396 extern void vprintf_unfiltered (const char *, va_list) ATTRIBUTE_PRINTF (1, 0);
398 extern void vfprintf_unfiltered (struct ui_file *, const char *, va_list)
399 ATTRIBUTE_PRINTF (2, 0);
401 extern void fprintf_unfiltered (struct ui_file *, const char *, ...)
402 ATTRIBUTE_PRINTF (2, 3);
404 extern void printf_unfiltered (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
406 extern void print_spaces (int, struct ui_file *);
408 extern void print_spaces_filtered (int, struct ui_file *);
410 extern char *n_spaces (int);
412 extern void fputstr_filtered (const char *str, int quotr,
413 struct ui_file * stream);
415 extern void fputstr_unfiltered (const char *str, int quotr,
416 struct ui_file * stream);
418 extern void fputstrn_filtered (const char *str, int n, int quotr,
419 struct ui_file * stream);
421 typedef int (*do_fputc_ftype) (int c, ui_file *stream);
423 extern void fputstrn_unfiltered (const char *str, int n, int quotr,
424 do_fputc_ftype do_fputc,
425 struct ui_file * stream);
427 /* Return nonzero if filtered printing is initialized. */
428 extern int filtered_printing_initialized (void);
430 /* Display the host ADDR on STREAM formatted as ``0x%x''. */
431 extern void gdb_print_host_address_1 (const void *addr, struct ui_file *stream);
433 /* Wrapper that avoids adding a pointless cast to all callers. */
434 #define gdb_print_host_address(ADDR, STREAM) \
435 gdb_print_host_address_1 ((const void *) ADDR, STREAM)
437 /* Return the address only having significant bits. */
438 extern CORE_ADDR address_significant (gdbarch *gdbarch, CORE_ADDR addr);
440 /* Convert CORE_ADDR to string in platform-specific manner.
441 This is usually formatted similar to 0x%lx. */
442 extern const char *paddress (struct gdbarch *gdbarch, CORE_ADDR addr);
444 /* Return a string representation in hexadecimal notation of ADDRESS,
445 which is suitable for printing. */
447 extern const char *print_core_address (struct gdbarch *gdbarch,
450 /* Callback hash_f and eq_f for htab_create_alloc or htab_create_alloc_ex. */
451 extern hashval_t core_addr_hash (const void *ap);
452 extern int core_addr_eq (const void *ap, const void *bp);
454 extern CORE_ADDR string_to_core_addr (const char *my_string);
456 extern void fprintf_symbol_filtered (struct ui_file *, const char *,
459 extern void throw_perror_with_name (enum errors errcode, const char *string)
462 extern void perror_warning_with_name (const char *string);
464 extern void print_sys_errmsg (const char *, int);
466 /* Warnings and error messages. */
468 extern void (*deprecated_error_begin_hook) (void);
470 /* Message to be printed before the warning message, when a warning occurs. */
472 extern const char *warning_pre_print;
474 extern void error_stream (const string_file &) ATTRIBUTE_NORETURN;
476 extern void demangler_vwarning (const char *file, int line,
477 const char *, va_list ap)
478 ATTRIBUTE_PRINTF (3, 0);
480 extern void demangler_warning (const char *file, int line,
481 const char *, ...) ATTRIBUTE_PRINTF (3, 4);
484 /* Misc. utilities. */
486 /* Allocation and deallocation functions for the libiberty hash table
487 which use obstacks. */
488 void *hashtab_obstack_allocate (void *data, size_t size, size_t count);
489 void dummy_obstack_deallocate (void *object, void *data);
492 extern pid_t wait_to_die_with_timeout (pid_t pid, int *status, int timeout);
495 extern int myread (int, char *, int);
497 /* Ensure that V is aligned to an N byte boundary (B's assumed to be a
498 power of 2). Round up/down when necessary. Examples of correct
501 addr = align_up (addr, 8); -- VALUE needs 8 byte alignment
502 write_memory (addr, value, len);
507 sp = align_down (sp - len, 16); -- Keep SP 16 byte aligned
508 write_memory (sp, value, len);
510 Note that uses such as:
512 write_memory (addr, value, len);
513 addr += align_up (len, 8);
517 sp -= align_up (len, 8);
518 write_memory (sp, value, len);
520 are typically not correct as they don't ensure that the address (SP
521 or ADDR) is correctly aligned (relying on previous alignment to
522 keep things right). This is also why the methods are called
523 "align_..." instead of "round_..." as the latter reads better with
524 this incorrect coding style. */
526 extern ULONGEST align_up (ULONGEST v, int n);
527 extern ULONGEST align_down (ULONGEST v, int n);
529 /* Resource limits used by getrlimit and setrlimit. */
531 enum resource_limit_kind
537 /* Check whether GDB will be able to dump core using the dump_core
538 function. Returns zero if GDB cannot or should not dump core.
539 If LIMIT_KIND is LIMIT_CUR the user's soft limit will be respected.
540 If LIMIT_KIND is LIMIT_MAX only the hard limit will be respected. */
542 extern int can_dump_core (enum resource_limit_kind limit_kind);
544 /* Print a warning that we cannot dump core. */
546 extern void warn_cant_dump_core (const char *reason);
548 /* Dump core trying to increase the core soft limit to hard limit
551 extern void dump_core (void);
553 /* Return the hex string form of LENGTH bytes of DATA.
554 Space for the result is malloc'd, caller must free. */
556 extern char *make_hex_string (const gdb_byte *data, size_t length);