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"
26 extern void initialize_utils (void);
28 /* String utilities. */
30 extern int sevenbit_strings
;
32 extern int strcmp_iw (const char *, const char *);
34 extern int strcmp_iw_ordered (const char *, const char *);
36 extern int streq (const char *, const char *);
38 extern int subset_compare (char *, char *);
40 int compare_positive_ints (const void *ap
, const void *bp
);
41 int compare_strings (const void *ap
, const void *bp
);
43 /* A wrapper for bfd_errmsg to produce a more helpful error message
44 in the case of bfd_error_file_ambiguously recognized.
45 MATCHING, if non-NULL, is the corresponding argument to
46 bfd_check_format_matches, and will be freed. */
48 extern const char *gdb_bfd_errmsg (bfd_error_type error_tag
, char **matching
);
50 /* Reset the prompt_for_continue clock. */
51 void reset_prompt_for_continue_wait_time (void);
52 /* Return the time spent in prompt_for_continue. */
53 struct timeval
get_prompt_for_continue_wait_time (void);
55 /* Parsing utilites. */
57 extern int parse_pid_to_attach (const char *args
);
59 extern int parse_escape (struct gdbarch
*, const char **);
61 char **gdb_buildargv (const char *);
63 /* Cleanup utilities. */
65 extern struct cleanup
*make_cleanup_freeargv (char **);
68 extern struct cleanup
*make_cleanup_dyn_string_delete (struct dyn_string
*);
71 extern struct cleanup
*make_cleanup_ui_file_delete (struct ui_file
*);
74 extern struct cleanup
*
75 make_cleanup_ui_out_redirect_pop (struct ui_out
*uiout
);
77 struct section_addr_info
;
78 extern struct cleanup
*(make_cleanup_free_section_addr_info
79 (struct section_addr_info
*));
81 /* For make_cleanup_close see common/filestuff.h. */
83 extern struct cleanup
*make_cleanup_fclose (FILE *file
);
85 extern struct cleanup
*make_cleanup_bfd_unref (bfd
*abfd
);
88 extern struct cleanup
*make_cleanup_obstack_free (struct obstack
*obstack
);
90 extern struct cleanup
*make_cleanup_restore_integer (int *variable
);
91 extern struct cleanup
*make_cleanup_restore_uinteger (unsigned int *variable
);
94 extern struct cleanup
*make_cleanup_unpush_target (struct target_ops
*ops
);
97 extern struct cleanup
*
98 make_cleanup_restore_ui_out (struct ui_out
**variable
);
99 extern struct cleanup
*
100 make_cleanup_restore_ui_file (struct ui_file
**variable
);
102 extern struct cleanup
*make_cleanup_value_free_to_mark (struct value
*);
103 extern struct cleanup
*make_cleanup_value_free (struct value
*);
106 extern struct cleanup
*make_cleanup_free_so (struct so_list
*so
);
108 extern struct cleanup
*make_cleanup_restore_current_language (void);
110 extern struct cleanup
*make_cleanup_htab_delete (htab_t htab
);
113 extern struct cleanup
*make_cleanup_clear_parser_state
114 (struct parser_state
**p
);
116 extern void free_current_contents (void *);
118 extern void init_page_info (void);
120 extern struct cleanup
*make_cleanup_restore_page_info (void);
121 extern struct cleanup
*
122 set_batch_flag_and_make_cleanup_restore_page_info (void);
124 extern struct cleanup
*make_bpstat_clear_actions_cleanup (void);
126 /* Path utilities. */
128 extern char *gdb_realpath (const char *);
130 extern char *gdb_realpath_keepfile (const char *);
132 extern char *gdb_abspath (const char *);
134 extern int gdb_filename_fnmatch (const char *pattern
, const char *string
,
137 extern void substitute_path_component (char **stringp
, const char *from
,
140 char *ldirname (const char *filename
);
142 extern int count_path_elements (const char *path
);
144 extern const char *strip_leading_path_elements (const char *path
, int n
);
146 /* GDB output, ui_file utilities. */
150 extern int query (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
151 extern int nquery (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
152 extern int yquery (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
154 extern void begin_line (void);
156 extern void wrap_here (char *);
158 extern void reinitialize_more_filter (void);
160 extern int pagination_enabled
;
162 extern struct ui_file
**current_ui_gdb_stdout_ptr (void);
163 extern struct ui_file
**current_ui_gdb_stdin_ptr (void);
164 extern struct ui_file
**current_ui_gdb_stderr_ptr (void);
165 extern struct ui_file
**current_ui_gdb_stdlog_ptr (void);
167 /* The current top level's ui_file streams. */
170 #define gdb_stdout (*current_ui_gdb_stdout_ptr ())
172 #define gdb_stdin (*current_ui_gdb_stdin_ptr ())
173 /* Serious error notifications */
174 #define gdb_stderr (*current_ui_gdb_stderr_ptr ())
175 /* Log/debug/trace messages that should bypass normal stdout/stderr
176 filtering. For moment, always call this stream using
177 *_unfiltered. In the very near future that restriction shall be
178 removed - either call shall be unfiltered. (cagney 1999-06-13). */
179 #define gdb_stdlog (*current_ui_gdb_stdlog_ptr ())
181 /* Truly global ui_file streams. These are all defined in main.c. */
183 /* Target output that should bypass normal stdout/stderr filtering.
184 For moment, always call this stream using *_unfiltered. In the
185 very near future that restriction shall be removed - either call
186 shall be unfiltered. (cagney 1999-07-02). */
187 extern struct ui_file
*gdb_stdtarg
;
188 extern struct ui_file
*gdb_stdtargerr
;
189 extern struct ui_file
*gdb_stdtargin
;
191 /* Set the screen dimensions to WIDTH and HEIGHT. */
193 extern void set_screen_width_and_height (int width
, int height
);
195 /* More generic printf like operations. Filtered versions may return
196 non-locally on error. */
198 extern void fputs_filtered (const char *, struct ui_file
*);
200 extern void fputs_unfiltered (const char *, struct ui_file
*);
202 extern int fputc_filtered (int c
, struct ui_file
*);
204 extern int fputc_unfiltered (int c
, struct ui_file
*);
206 extern int putchar_filtered (int c
);
208 extern int putchar_unfiltered (int c
);
210 extern void puts_filtered (const char *);
212 extern void puts_unfiltered (const char *);
214 extern void puts_filtered_tabular (char *string
, int width
, int right
);
216 extern void puts_debug (char *prefix
, char *string
, char *suffix
);
218 extern void vprintf_filtered (const char *, va_list) ATTRIBUTE_PRINTF (1, 0);
220 extern void vfprintf_filtered (struct ui_file
*, const char *, va_list)
221 ATTRIBUTE_PRINTF (2, 0);
223 extern void fprintf_filtered (struct ui_file
*, const char *, ...)
224 ATTRIBUTE_PRINTF (2, 3);
226 extern void fprintfi_filtered (int, struct ui_file
*, const char *, ...)
227 ATTRIBUTE_PRINTF (3, 4);
229 extern void printf_filtered (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
231 extern void printfi_filtered (int, const char *, ...) ATTRIBUTE_PRINTF (2, 3);
233 extern void vprintf_unfiltered (const char *, va_list) ATTRIBUTE_PRINTF (1, 0);
235 extern void vfprintf_unfiltered (struct ui_file
*, const char *, va_list)
236 ATTRIBUTE_PRINTF (2, 0);
238 extern void fprintf_unfiltered (struct ui_file
*, const char *, ...)
239 ATTRIBUTE_PRINTF (2, 3);
241 extern void printf_unfiltered (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
243 extern void print_spaces (int, struct ui_file
*);
245 extern void print_spaces_filtered (int, struct ui_file
*);
247 extern char *n_spaces (int);
249 extern void fputstr_filtered (const char *str
, int quotr
,
250 struct ui_file
* stream
);
252 extern void fputstr_unfiltered (const char *str
, int quotr
,
253 struct ui_file
* stream
);
255 extern void fputstrn_filtered (const char *str
, int n
, int quotr
,
256 struct ui_file
* stream
);
258 extern void fputstrn_unfiltered (const char *str
, int n
, int quotr
,
259 struct ui_file
* stream
);
261 /* Return nonzero if filtered printing is initialized. */
262 extern int filtered_printing_initialized (void);
264 /* Display the host ADDR on STREAM formatted as ``0x%x''. */
265 extern void gdb_print_host_address_1 (const void *addr
, struct ui_file
*stream
);
267 /* Wrapper that avoids adding a pointless cast to all callers. */
268 #define gdb_print_host_address(ADDR, STREAM) \
269 gdb_print_host_address_1 ((const void *) ADDR, STREAM)
271 /* Convert CORE_ADDR to string in platform-specific manner.
272 This is usually formatted similar to 0x%lx. */
273 extern const char *paddress (struct gdbarch
*gdbarch
, CORE_ADDR addr
);
275 /* Return a string representation in hexadecimal notation of ADDRESS,
276 which is suitable for printing. */
278 extern const char *print_core_address (struct gdbarch
*gdbarch
,
281 /* Callback hash_f and eq_f for htab_create_alloc or htab_create_alloc_ex. */
282 extern hashval_t
core_addr_hash (const void *ap
);
283 extern int core_addr_eq (const void *ap
, const void *bp
);
285 extern CORE_ADDR
string_to_core_addr (const char *my_string
);
287 extern void fprintf_symbol_filtered (struct ui_file
*, const char *,
290 extern void throw_perror_with_name (enum errors errcode
, const char *string
)
293 extern void perror_warning_with_name (const char *string
);
295 extern void print_sys_errmsg (const char *, int);
297 /* Warnings and error messages. */
299 extern void (*deprecated_error_begin_hook
) (void);
301 /* Message to be printed before the warning message, when a warning occurs. */
303 extern char *warning_pre_print
;
305 extern void error_stream (struct ui_file
*) ATTRIBUTE_NORETURN
;
307 extern void demangler_vwarning (const char *file
, int line
,
308 const char *, va_list ap
)
309 ATTRIBUTE_PRINTF (3, 0);
311 extern void demangler_warning (const char *file
, int line
,
312 const char *, ...) ATTRIBUTE_PRINTF (3, 4);
315 /* Misc. utilities. */
317 /* Allocation and deallocation functions for the libiberty hash table
318 which use obstacks. */
319 void *hashtab_obstack_allocate (void *data
, size_t size
, size_t count
);
320 void dummy_obstack_deallocate (void *object
, void *data
);
323 extern pid_t
wait_to_die_with_timeout (pid_t pid
, int *status
, int timeout
);
326 extern int producer_is_gcc_ge_4 (const char *producer
);
327 extern int producer_is_gcc (const char *producer
, int *major
, int *minor
);
329 extern int myread (int, char *, int);
331 /* Ensure that V is aligned to an N byte boundary (B's assumed to be a
332 power of 2). Round up/down when necessary. Examples of correct
335 addr = align_up (addr, 8); -- VALUE needs 8 byte alignment
336 write_memory (addr, value, len);
341 sp = align_down (sp - len, 16); -- Keep SP 16 byte aligned
342 write_memory (sp, value, len);
344 Note that uses such as:
346 write_memory (addr, value, len);
347 addr += align_up (len, 8);
351 sp -= align_up (len, 8);
352 write_memory (sp, value, len);
354 are typically not correct as they don't ensure that the address (SP
355 or ADDR) is correctly aligned (relying on previous alignment to
356 keep things right). This is also why the methods are called
357 "align_..." instead of "round_..." as the latter reads better with
358 this incorrect coding style. */
360 extern ULONGEST
align_up (ULONGEST v
, int n
);
361 extern ULONGEST
align_down (ULONGEST v
, int n
);
363 /* Resource limits used by getrlimit and setrlimit. */
365 enum resource_limit_kind
371 /* Check whether GDB will be able to dump core using the dump_core
372 function. Returns zero if GDB cannot or should not dump core.
373 If LIMIT_KIND is LIMIT_CUR the user's soft limit will be respected.
374 If LIMIT_KIND is LIMIT_MAX only the hard limit will be respected. */
376 extern int can_dump_core (enum resource_limit_kind limit_kind
);
378 /* Print a warning that we cannot dump core. */
380 extern void warn_cant_dump_core (const char *reason
);
382 /* Dump core trying to increase the core soft limit to hard limit
385 extern void dump_core (void);
387 /* Return the hex string form of LENGTH bytes of DATA.
388 Space for the result is malloc'd, caller must free. */
390 extern char *make_hex_string (const gdb_byte
*data
, size_t length
);