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
*);
219 /* A deleter for a hash table. */
222 void operator() (htab
*ptr
) const
228 /* A unique_ptr wrapper for htab_t. */
229 typedef std::unique_ptr
<htab
, htab_deleter
> htab_up
;
231 extern void free_current_contents (void *);
233 extern void init_page_info (void);
235 /* Temporarily set BATCH_FLAG and the associated unlimited terminal size.
236 Restore when destroyed. */
238 struct set_batch_flag_and_restore_page_info
242 set_batch_flag_and_restore_page_info ();
243 ~set_batch_flag_and_restore_page_info ();
245 DISABLE_COPY_AND_ASSIGN (set_batch_flag_and_restore_page_info
);
249 /* Note that this doesn't use scoped_restore, because it's important
250 to control the ordering of operations in the destruction, and it
251 was simpler to avoid introducing a new ad hoc class. */
252 unsigned m_save_lines_per_page
;
253 unsigned m_save_chars_per_line
;
254 int m_save_batch_flag
;
257 extern struct cleanup
*make_bpstat_clear_actions_cleanup (void);
259 /* Path utilities. */
261 extern gdb::unique_xmalloc_ptr
<char> gdb_realpath (const char *);
263 extern gdb::unique_xmalloc_ptr
<char> gdb_realpath_keepfile (const char *);
265 extern gdb::unique_xmalloc_ptr
<char> gdb_abspath (const char *);
267 extern int gdb_filename_fnmatch (const char *pattern
, const char *string
,
270 extern void substitute_path_component (char **stringp
, const char *from
,
273 std::string
ldirname (const char *filename
);
275 extern int count_path_elements (const char *path
);
277 extern const char *strip_leading_path_elements (const char *path
, int n
);
279 /* GDB output, ui_file utilities. */
283 extern int query (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
284 extern int nquery (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
285 extern int yquery (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
287 extern void begin_line (void);
289 extern void wrap_here (const char *);
291 extern void reinitialize_more_filter (void);
293 extern int pagination_enabled
;
295 extern struct ui_file
**current_ui_gdb_stdout_ptr (void);
296 extern struct ui_file
**current_ui_gdb_stdin_ptr (void);
297 extern struct ui_file
**current_ui_gdb_stderr_ptr (void);
298 extern struct ui_file
**current_ui_gdb_stdlog_ptr (void);
300 /* The current top level's ui_file streams. */
303 #define gdb_stdout (*current_ui_gdb_stdout_ptr ())
305 #define gdb_stdin (*current_ui_gdb_stdin_ptr ())
306 /* Serious error notifications */
307 #define gdb_stderr (*current_ui_gdb_stderr_ptr ())
308 /* Log/debug/trace messages that should bypass normal stdout/stderr
309 filtering. For moment, always call this stream using
310 *_unfiltered. In the very near future that restriction shall be
311 removed - either call shall be unfiltered. (cagney 1999-06-13). */
312 #define gdb_stdlog (*current_ui_gdb_stdlog_ptr ())
314 /* Truly global ui_file streams. These are all defined in main.c. */
316 /* Target output that should bypass normal stdout/stderr filtering.
317 For moment, always call this stream using *_unfiltered. In the
318 very near future that restriction shall be removed - either call
319 shall be unfiltered. (cagney 1999-07-02). */
320 extern struct ui_file
*gdb_stdtarg
;
321 extern struct ui_file
*gdb_stdtargerr
;
322 extern struct ui_file
*gdb_stdtargin
;
324 /* Set the screen dimensions to WIDTH and HEIGHT. */
326 extern void set_screen_width_and_height (int width
, int height
);
328 /* More generic printf like operations. Filtered versions may return
329 non-locally on error. */
331 extern void fputs_filtered (const char *, struct ui_file
*);
333 extern void fputs_unfiltered (const char *, struct ui_file
*);
335 extern int fputc_filtered (int c
, struct ui_file
*);
337 extern int fputc_unfiltered (int c
, struct ui_file
*);
339 extern int putchar_filtered (int c
);
341 extern int putchar_unfiltered (int c
);
343 extern void puts_filtered (const char *);
345 extern void puts_unfiltered (const char *);
347 extern void puts_filtered_tabular (char *string
, int width
, int right
);
349 extern void puts_debug (char *prefix
, char *string
, char *suffix
);
351 extern void vprintf_filtered (const char *, va_list) ATTRIBUTE_PRINTF (1, 0);
353 extern void vfprintf_filtered (struct ui_file
*, const char *, va_list)
354 ATTRIBUTE_PRINTF (2, 0);
356 extern void fprintf_filtered (struct ui_file
*, const char *, ...)
357 ATTRIBUTE_PRINTF (2, 3);
359 extern void fprintfi_filtered (int, struct ui_file
*, const char *, ...)
360 ATTRIBUTE_PRINTF (3, 4);
362 extern void printf_filtered (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
364 extern void printfi_filtered (int, const char *, ...) ATTRIBUTE_PRINTF (2, 3);
366 extern void vprintf_unfiltered (const char *, va_list) ATTRIBUTE_PRINTF (1, 0);
368 extern void vfprintf_unfiltered (struct ui_file
*, const char *, va_list)
369 ATTRIBUTE_PRINTF (2, 0);
371 extern void fprintf_unfiltered (struct ui_file
*, const char *, ...)
372 ATTRIBUTE_PRINTF (2, 3);
374 extern void printf_unfiltered (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
376 extern void print_spaces (int, struct ui_file
*);
378 extern void print_spaces_filtered (int, struct ui_file
*);
380 extern char *n_spaces (int);
382 extern void fputstr_filtered (const char *str
, int quotr
,
383 struct ui_file
* stream
);
385 extern void fputstr_unfiltered (const char *str
, int quotr
,
386 struct ui_file
* stream
);
388 extern void fputstrn_filtered (const char *str
, int n
, int quotr
,
389 struct ui_file
* stream
);
391 extern void fputstrn_unfiltered (const char *str
, int n
, int quotr
,
392 struct ui_file
* stream
);
394 /* Return nonzero if filtered printing is initialized. */
395 extern int filtered_printing_initialized (void);
397 /* Display the host ADDR on STREAM formatted as ``0x%x''. */
398 extern void gdb_print_host_address_1 (const void *addr
, struct ui_file
*stream
);
400 /* Wrapper that avoids adding a pointless cast to all callers. */
401 #define gdb_print_host_address(ADDR, STREAM) \
402 gdb_print_host_address_1 ((const void *) ADDR, STREAM)
404 /* Convert CORE_ADDR to string in platform-specific manner.
405 This is usually formatted similar to 0x%lx. */
406 extern const char *paddress (struct gdbarch
*gdbarch
, CORE_ADDR addr
);
408 /* Return a string representation in hexadecimal notation of ADDRESS,
409 which is suitable for printing. */
411 extern const char *print_core_address (struct gdbarch
*gdbarch
,
414 /* Callback hash_f and eq_f for htab_create_alloc or htab_create_alloc_ex. */
415 extern hashval_t
core_addr_hash (const void *ap
);
416 extern int core_addr_eq (const void *ap
, const void *bp
);
418 extern CORE_ADDR
string_to_core_addr (const char *my_string
);
420 extern void fprintf_symbol_filtered (struct ui_file
*, const char *,
423 extern void throw_perror_with_name (enum errors errcode
, const char *string
)
426 extern void perror_warning_with_name (const char *string
);
428 extern void print_sys_errmsg (const char *, int);
430 /* Warnings and error messages. */
432 extern void (*deprecated_error_begin_hook
) (void);
434 /* Message to be printed before the warning message, when a warning occurs. */
436 extern const char *warning_pre_print
;
438 extern void error_stream (const string_file
&) ATTRIBUTE_NORETURN
;
440 extern void demangler_vwarning (const char *file
, int line
,
441 const char *, va_list ap
)
442 ATTRIBUTE_PRINTF (3, 0);
444 extern void demangler_warning (const char *file
, int line
,
445 const char *, ...) ATTRIBUTE_PRINTF (3, 4);
448 /* Misc. utilities. */
450 /* Allocation and deallocation functions for the libiberty hash table
451 which use obstacks. */
452 void *hashtab_obstack_allocate (void *data
, size_t size
, size_t count
);
453 void dummy_obstack_deallocate (void *object
, void *data
);
456 extern pid_t
wait_to_die_with_timeout (pid_t pid
, int *status
, int timeout
);
459 extern int myread (int, char *, int);
461 /* Ensure that V is aligned to an N byte boundary (B's assumed to be a
462 power of 2). Round up/down when necessary. Examples of correct
465 addr = align_up (addr, 8); -- VALUE needs 8 byte alignment
466 write_memory (addr, value, len);
471 sp = align_down (sp - len, 16); -- Keep SP 16 byte aligned
472 write_memory (sp, value, len);
474 Note that uses such as:
476 write_memory (addr, value, len);
477 addr += align_up (len, 8);
481 sp -= align_up (len, 8);
482 write_memory (sp, value, len);
484 are typically not correct as they don't ensure that the address (SP
485 or ADDR) is correctly aligned (relying on previous alignment to
486 keep things right). This is also why the methods are called
487 "align_..." instead of "round_..." as the latter reads better with
488 this incorrect coding style. */
490 extern ULONGEST
align_up (ULONGEST v
, int n
);
491 extern ULONGEST
align_down (ULONGEST v
, int n
);
493 /* Resource limits used by getrlimit and setrlimit. */
495 enum resource_limit_kind
501 /* Check whether GDB will be able to dump core using the dump_core
502 function. Returns zero if GDB cannot or should not dump core.
503 If LIMIT_KIND is LIMIT_CUR the user's soft limit will be respected.
504 If LIMIT_KIND is LIMIT_MAX only the hard limit will be respected. */
506 extern int can_dump_core (enum resource_limit_kind limit_kind
);
508 /* Print a warning that we cannot dump core. */
510 extern void warn_cant_dump_core (const char *reason
);
512 /* Dump core trying to increase the core soft limit to hard limit
515 extern void dump_core (void);
517 /* Return the hex string form of LENGTH bytes of DATA.
518 Space for the result is malloc'd, caller must free. */
520 extern char *make_hex_string (const gdb_byte
*data
, size_t length
);