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-2016 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"
27 extern void initialize_utils (void);
29 /* String utilities. */
31 extern int sevenbit_strings
;
33 extern int strcmp_iw (const char *, const char *);
35 extern int strcmp_iw_ordered (const char *, const char *);
37 extern int streq (const char *, const char *);
39 extern int subset_compare (char *, char *);
41 int compare_positive_ints (const void *ap
, const void *bp
);
42 int compare_strings (const void *ap
, const void *bp
);
44 /* A wrapper for bfd_errmsg to produce a more helpful error message
45 in the case of bfd_error_file_ambiguously recognized.
46 MATCHING, if non-NULL, is the corresponding argument to
47 bfd_check_format_matches, and will be freed. */
49 extern const char *gdb_bfd_errmsg (bfd_error_type error_tag
, char **matching
);
51 /* Reset the prompt_for_continue clock. */
52 void reset_prompt_for_continue_wait_time (void);
53 /* Return the time spent in prompt_for_continue. */
54 struct timeval
get_prompt_for_continue_wait_time (void);
56 /* Parsing utilites. */
58 extern int parse_pid_to_attach (const char *args
);
60 extern int parse_escape (struct gdbarch
*, const char **);
62 char **gdb_buildargv (const char *);
64 /* Cleanup utilities. */
66 extern struct cleanup
*make_cleanup_freeargv (char **);
69 extern struct cleanup
*make_cleanup_ui_file_delete (struct ui_file
*);
72 extern struct cleanup
*
73 make_cleanup_ui_out_redirect_pop (struct ui_out
*uiout
);
75 struct section_addr_info
;
76 extern struct cleanup
*(make_cleanup_free_section_addr_info
77 (struct section_addr_info
*));
79 /* For make_cleanup_close see common/filestuff.h. */
81 extern struct cleanup
*make_cleanup_fclose (FILE *file
);
83 extern struct cleanup
*make_cleanup_bfd_unref (bfd
*abfd
);
86 extern struct cleanup
*make_cleanup_obstack_free (struct obstack
*obstack
);
88 extern struct cleanup
*make_cleanup_restore_integer (int *variable
);
89 extern struct cleanup
*make_cleanup_restore_uinteger (unsigned int *variable
);
92 extern struct cleanup
*make_cleanup_unpush_target (struct target_ops
*ops
);
94 extern struct cleanup
*make_cleanup_value_free_to_mark (struct value
*);
95 extern struct cleanup
*make_cleanup_value_free (struct value
*);
98 extern struct cleanup
*make_cleanup_free_so (struct so_list
*so
);
100 extern struct cleanup
*make_cleanup_restore_current_language (void);
102 extern struct cleanup
*make_cleanup_htab_delete (htab_t htab
);
105 extern struct cleanup
*make_cleanup_clear_parser_state
106 (struct parser_state
**p
);
108 extern void free_current_contents (void *);
110 extern void init_page_info (void);
112 extern struct cleanup
*make_cleanup_restore_page_info (void);
113 extern struct cleanup
*
114 set_batch_flag_and_make_cleanup_restore_page_info (void);
116 extern struct cleanup
*make_bpstat_clear_actions_cleanup (void);
118 /* Path utilities. */
120 extern char *gdb_realpath (const char *);
122 extern char *gdb_realpath_keepfile (const char *);
124 extern char *gdb_abspath (const char *);
126 extern int gdb_filename_fnmatch (const char *pattern
, const char *string
,
129 extern void substitute_path_component (char **stringp
, const char *from
,
132 char *ldirname (const char *filename
);
134 extern int count_path_elements (const char *path
);
136 extern const char *strip_leading_path_elements (const char *path
, int n
);
138 /* GDB output, ui_file utilities. */
142 extern int query (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
143 extern int nquery (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
144 extern int yquery (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
146 extern void begin_line (void);
148 extern void wrap_here (char *);
150 extern void reinitialize_more_filter (void);
152 extern int pagination_enabled
;
154 extern struct ui_file
**current_ui_gdb_stdout_ptr (void);
155 extern struct ui_file
**current_ui_gdb_stdin_ptr (void);
156 extern struct ui_file
**current_ui_gdb_stderr_ptr (void);
157 extern struct ui_file
**current_ui_gdb_stdlog_ptr (void);
159 /* The current top level's ui_file streams. */
162 #define gdb_stdout (*current_ui_gdb_stdout_ptr ())
164 #define gdb_stdin (*current_ui_gdb_stdin_ptr ())
165 /* Serious error notifications */
166 #define gdb_stderr (*current_ui_gdb_stderr_ptr ())
167 /* Log/debug/trace messages that should bypass normal stdout/stderr
168 filtering. For moment, always call this stream using
169 *_unfiltered. In the very near future that restriction shall be
170 removed - either call shall be unfiltered. (cagney 1999-06-13). */
171 #define gdb_stdlog (*current_ui_gdb_stdlog_ptr ())
173 /* Truly global ui_file streams. These are all defined in main.c. */
175 /* Target output that should bypass normal stdout/stderr filtering.
176 For moment, always call this stream using *_unfiltered. In the
177 very near future that restriction shall be removed - either call
178 shall be unfiltered. (cagney 1999-07-02). */
179 extern struct ui_file
*gdb_stdtarg
;
180 extern struct ui_file
*gdb_stdtargerr
;
181 extern struct ui_file
*gdb_stdtargin
;
183 /* Set the screen dimensions to WIDTH and HEIGHT. */
185 extern void set_screen_width_and_height (int width
, int height
);
187 /* More generic printf like operations. Filtered versions may return
188 non-locally on error. */
190 extern void fputs_filtered (const char *, struct ui_file
*);
192 extern void fputs_unfiltered (const char *, struct ui_file
*);
194 extern int fputc_filtered (int c
, struct ui_file
*);
196 extern int fputc_unfiltered (int c
, struct ui_file
*);
198 extern int putchar_filtered (int c
);
200 extern int putchar_unfiltered (int c
);
202 extern void puts_filtered (const char *);
204 extern void puts_unfiltered (const char *);
206 extern void puts_filtered_tabular (char *string
, int width
, int right
);
208 extern void puts_debug (char *prefix
, char *string
, char *suffix
);
210 extern void vprintf_filtered (const char *, va_list) ATTRIBUTE_PRINTF (1, 0);
212 extern void vfprintf_filtered (struct ui_file
*, const char *, va_list)
213 ATTRIBUTE_PRINTF (2, 0);
215 extern void fprintf_filtered (struct ui_file
*, const char *, ...)
216 ATTRIBUTE_PRINTF (2, 3);
218 extern void fprintfi_filtered (int, struct ui_file
*, const char *, ...)
219 ATTRIBUTE_PRINTF (3, 4);
221 extern void printf_filtered (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
223 extern void printfi_filtered (int, const char *, ...) ATTRIBUTE_PRINTF (2, 3);
225 extern void vprintf_unfiltered (const char *, va_list) ATTRIBUTE_PRINTF (1, 0);
227 extern void vfprintf_unfiltered (struct ui_file
*, const char *, va_list)
228 ATTRIBUTE_PRINTF (2, 0);
230 extern void fprintf_unfiltered (struct ui_file
*, const char *, ...)
231 ATTRIBUTE_PRINTF (2, 3);
233 extern void printf_unfiltered (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
235 extern void print_spaces (int, struct ui_file
*);
237 extern void print_spaces_filtered (int, struct ui_file
*);
239 extern char *n_spaces (int);
241 extern void fputstr_filtered (const char *str
, int quotr
,
242 struct ui_file
* stream
);
244 extern void fputstr_unfiltered (const char *str
, int quotr
,
245 struct ui_file
* stream
);
247 extern void fputstrn_filtered (const char *str
, int n
, int quotr
,
248 struct ui_file
* stream
);
250 extern void fputstrn_unfiltered (const char *str
, int n
, int quotr
,
251 struct ui_file
* stream
);
253 /* Return nonzero if filtered printing is initialized. */
254 extern int filtered_printing_initialized (void);
256 /* Display the host ADDR on STREAM formatted as ``0x%x''. */
257 extern void gdb_print_host_address_1 (const void *addr
, struct ui_file
*stream
);
259 /* Wrapper that avoids adding a pointless cast to all callers. */
260 #define gdb_print_host_address(ADDR, STREAM) \
261 gdb_print_host_address_1 ((const void *) ADDR, STREAM)
263 /* Convert CORE_ADDR to string in platform-specific manner.
264 This is usually formatted similar to 0x%lx. */
265 extern const char *paddress (struct gdbarch
*gdbarch
, CORE_ADDR addr
);
267 /* Return a string representation in hexadecimal notation of ADDRESS,
268 which is suitable for printing. */
270 extern const char *print_core_address (struct gdbarch
*gdbarch
,
273 /* Callback hash_f and eq_f for htab_create_alloc or htab_create_alloc_ex. */
274 extern hashval_t
core_addr_hash (const void *ap
);
275 extern int core_addr_eq (const void *ap
, const void *bp
);
277 extern CORE_ADDR
string_to_core_addr (const char *my_string
);
279 extern void fprintf_symbol_filtered (struct ui_file
*, const char *,
282 extern void throw_perror_with_name (enum errors errcode
, const char *string
)
285 extern void perror_warning_with_name (const char *string
);
287 extern void print_sys_errmsg (const char *, int);
289 /* Warnings and error messages. */
291 extern void (*deprecated_error_begin_hook
) (void);
293 /* Message to be printed before the warning message, when a warning occurs. */
295 extern char *warning_pre_print
;
297 extern void error_stream (struct ui_file
*) ATTRIBUTE_NORETURN
;
299 extern void demangler_vwarning (const char *file
, int line
,
300 const char *, va_list ap
)
301 ATTRIBUTE_PRINTF (3, 0);
303 extern void demangler_warning (const char *file
, int line
,
304 const char *, ...) ATTRIBUTE_PRINTF (3, 4);
307 /* Misc. utilities. */
309 /* Allocation and deallocation functions for the libiberty hash table
310 which use obstacks. */
311 void *hashtab_obstack_allocate (void *data
, size_t size
, size_t count
);
312 void dummy_obstack_deallocate (void *object
, void *data
);
315 extern pid_t
wait_to_die_with_timeout (pid_t pid
, int *status
, int timeout
);
318 extern int producer_is_gcc_ge_4 (const char *producer
);
319 extern int producer_is_gcc (const char *producer
, int *major
, int *minor
);
321 extern int myread (int, char *, int);
323 /* Ensure that V is aligned to an N byte boundary (B's assumed to be a
324 power of 2). Round up/down when necessary. Examples of correct
327 addr = align_up (addr, 8); -- VALUE needs 8 byte alignment
328 write_memory (addr, value, len);
333 sp = align_down (sp - len, 16); -- Keep SP 16 byte aligned
334 write_memory (sp, value, len);
336 Note that uses such as:
338 write_memory (addr, value, len);
339 addr += align_up (len, 8);
343 sp -= align_up (len, 8);
344 write_memory (sp, value, len);
346 are typically not correct as they don't ensure that the address (SP
347 or ADDR) is correctly aligned (relying on previous alignment to
348 keep things right). This is also why the methods are called
349 "align_..." instead of "round_..." as the latter reads better with
350 this incorrect coding style. */
352 extern ULONGEST
align_up (ULONGEST v
, int n
);
353 extern ULONGEST
align_down (ULONGEST v
, int n
);
355 /* Resource limits used by getrlimit and setrlimit. */
357 enum resource_limit_kind
363 /* Check whether GDB will be able to dump core using the dump_core
364 function. Returns zero if GDB cannot or should not dump core.
365 If LIMIT_KIND is LIMIT_CUR the user's soft limit will be respected.
366 If LIMIT_KIND is LIMIT_MAX only the hard limit will be respected. */
368 extern int can_dump_core (enum resource_limit_kind limit_kind
);
370 /* Print a warning that we cannot dump core. */
372 extern void warn_cant_dump_core (const char *reason
);
374 /* Dump core trying to increase the core soft limit to hard limit
377 extern void dump_core (void);
379 /* Return the hex string form of LENGTH bytes of DATA.
380 Space for the result is malloc'd, caller must free. */
382 extern char *make_hex_string (const gdb_byte
*data
, size_t length
);