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-2015 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 ULONGEST
strtoulst (const char *num
, const char **trailer
, int base
);
42 int compare_positive_ints (const void *ap
, const void *bp
);
43 int compare_strings (const void *ap
, const void *bp
);
45 /* A wrapper for bfd_errmsg to produce a more helpful error message
46 in the case of bfd_error_file_ambiguously recognized.
47 MATCHING, if non-NULL, is the corresponding argument to
48 bfd_check_format_matches, and will be freed. */
50 extern const char *gdb_bfd_errmsg (bfd_error_type error_tag
, char **matching
);
52 /* Reset the prompt_for_continue clock. */
53 void reset_prompt_for_continue_wait_time (void);
54 /* Return the time spent in prompt_for_continue. */
55 struct timeval
get_prompt_for_continue_wait_time (void);
57 /* Parsing utilites. */
59 extern int parse_pid_to_attach (const char *args
);
61 extern int parse_escape (struct gdbarch
*, const char **);
63 char **gdb_buildargv (const char *);
65 /* Cleanup utilities. */
67 extern struct cleanup
*make_cleanup_freeargv (char **);
70 extern struct cleanup
*make_cleanup_dyn_string_delete (struct dyn_string
*);
73 extern struct cleanup
*make_cleanup_ui_file_delete (struct ui_file
*);
76 extern struct cleanup
*
77 make_cleanup_ui_out_redirect_pop (struct ui_out
*uiout
);
79 struct section_addr_info
;
80 extern struct cleanup
*(make_cleanup_free_section_addr_info
81 (struct section_addr_info
*));
83 extern struct cleanup
*make_cleanup_close (int fd
);
85 extern struct cleanup
*make_cleanup_fclose (FILE *file
);
87 extern struct cleanup
*make_cleanup_bfd_unref (bfd
*abfd
);
90 extern struct cleanup
*make_cleanup_obstack_free (struct obstack
*obstack
);
92 extern struct cleanup
*make_cleanup_restore_integer (int *variable
);
93 extern struct cleanup
*make_cleanup_restore_uinteger (unsigned int *variable
);
96 extern struct cleanup
*make_cleanup_unpush_target (struct target_ops
*ops
);
98 extern struct cleanup
*
99 make_cleanup_restore_ui_file (struct ui_file
**variable
);
101 extern struct cleanup
*make_cleanup_value_free_to_mark (struct value
*);
102 extern struct cleanup
*make_cleanup_value_free (struct value
*);
105 extern struct cleanup
*make_cleanup_free_so (struct so_list
*so
);
107 extern struct cleanup
*make_cleanup_restore_current_language (void);
109 extern struct cleanup
*make_cleanup_htab_delete (htab_t htab
);
112 extern struct cleanup
*make_cleanup_clear_parser_state
113 (struct parser_state
**p
);
115 extern void free_current_contents (void *);
117 extern void init_page_info (void);
119 extern struct cleanup
*make_cleanup_restore_page_info (void);
120 extern struct cleanup
*
121 set_batch_flag_and_make_cleanup_restore_page_info (void);
123 extern struct cleanup
*make_bpstat_clear_actions_cleanup (void);
125 /* Path utilities. */
127 extern char *gdb_realpath (const char *);
129 extern char *gdb_realpath_keepfile (const char *);
131 extern char *gdb_abspath (const char *);
133 extern int gdb_filename_fnmatch (const char *pattern
, const char *string
,
136 extern void substitute_path_component (char **stringp
, const char *from
,
139 char *ldirname (const char *filename
);
141 /* GDB output, ui_file utilities. */
145 extern int query (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
146 extern int nquery (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
147 extern int yquery (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
149 extern void begin_line (void);
151 extern void wrap_here (char *);
153 extern void reinitialize_more_filter (void);
155 extern int pagination_enabled
;
157 /* Global ui_file streams. These are all defined in main.c. */
159 extern struct ui_file
*gdb_stdout
;
161 extern struct ui_file
*gdb_stdin
;
162 /* Serious error notifications */
163 extern struct ui_file
*gdb_stderr
;
164 /* Log/debug/trace messages that should bypass normal stdout/stderr
165 filtering. For moment, always call this stream using
166 *_unfiltered. In the very near future that restriction shall be
167 removed - either call shall be unfiltered. (cagney 1999-06-13). */
168 extern struct ui_file
*gdb_stdlog
;
169 /* Target output that should bypass normal stdout/stderr filtering.
170 For moment, always call this stream using *_unfiltered. In the
171 very near future that restriction shall be removed - either call
172 shall be unfiltered. (cagney 1999-07-02). */
173 extern struct ui_file
*gdb_stdtarg
;
174 extern struct ui_file
*gdb_stdtargerr
;
175 extern struct ui_file
*gdb_stdtargin
;
177 /* More generic printf like operations. Filtered versions may return
178 non-locally on error. */
180 extern void fputs_filtered (const char *, struct ui_file
*);
182 extern void fputs_unfiltered (const char *, struct ui_file
*);
184 extern int fputc_filtered (int c
, struct ui_file
*);
186 extern int fputc_unfiltered (int c
, struct ui_file
*);
188 extern int putchar_filtered (int c
);
190 extern int putchar_unfiltered (int c
);
192 extern void puts_filtered (const char *);
194 extern void puts_unfiltered (const char *);
196 extern void puts_filtered_tabular (char *string
, int width
, int right
);
198 extern void puts_debug (char *prefix
, char *string
, char *suffix
);
200 extern void vprintf_filtered (const char *, va_list) ATTRIBUTE_PRINTF (1, 0);
202 extern void vfprintf_filtered (struct ui_file
*, const char *, va_list)
203 ATTRIBUTE_PRINTF (2, 0);
205 extern void fprintf_filtered (struct ui_file
*, const char *, ...)
206 ATTRIBUTE_PRINTF (2, 3);
208 extern void fprintfi_filtered (int, struct ui_file
*, const char *, ...)
209 ATTRIBUTE_PRINTF (3, 4);
211 extern void printf_filtered (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
213 extern void printfi_filtered (int, const char *, ...) ATTRIBUTE_PRINTF (2, 3);
215 extern void vprintf_unfiltered (const char *, va_list) ATTRIBUTE_PRINTF (1, 0);
217 extern void vfprintf_unfiltered (struct ui_file
*, const char *, va_list)
218 ATTRIBUTE_PRINTF (2, 0);
220 extern void fprintf_unfiltered (struct ui_file
*, const char *, ...)
221 ATTRIBUTE_PRINTF (2, 3);
223 extern void printf_unfiltered (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
225 extern void print_spaces (int, struct ui_file
*);
227 extern void print_spaces_filtered (int, struct ui_file
*);
229 extern char *n_spaces (int);
231 extern void fputstr_filtered (const char *str
, int quotr
,
232 struct ui_file
* stream
);
234 extern void fputstr_unfiltered (const char *str
, int quotr
,
235 struct ui_file
* stream
);
237 extern void fputstrn_filtered (const char *str
, int n
, int quotr
,
238 struct ui_file
* stream
);
240 extern void fputstrn_unfiltered (const char *str
, int n
, int quotr
,
241 struct ui_file
* stream
);
243 /* Return nonzero if filtered printing is initialized. */
244 extern int filtered_printing_initialized (void);
246 /* Display the host ADDR on STREAM formatted as ``0x%x''. */
247 extern void gdb_print_host_address (const void *addr
, struct ui_file
*stream
);
249 /* Convert CORE_ADDR to string in platform-specific manner.
250 This is usually formatted similar to 0x%lx. */
251 extern const char *paddress (struct gdbarch
*gdbarch
, CORE_ADDR addr
);
253 /* Return a string representation in hexadecimal notation of ADDRESS,
254 which is suitable for printing. */
256 extern const char *print_core_address (struct gdbarch
*gdbarch
,
259 /* Callback hash_f and eq_f for htab_create_alloc or htab_create_alloc_ex. */
260 extern hashval_t
core_addr_hash (const void *ap
);
261 extern int core_addr_eq (const void *ap
, const void *bp
);
263 extern CORE_ADDR
string_to_core_addr (const char *my_string
);
265 extern void fprintf_symbol_filtered (struct ui_file
*, const char *,
268 extern void throw_perror_with_name (enum errors errcode
, const char *string
)
271 extern void perror_warning_with_name (const char *string
);
273 extern void print_sys_errmsg (const char *, int);
275 /* Warnings and error messages. */
277 extern void (*deprecated_error_begin_hook
) (void);
279 /* Message to be printed before the warning message, when a warning occurs. */
281 extern char *warning_pre_print
;
283 extern void error_stream (struct ui_file
*) ATTRIBUTE_NORETURN
;
285 extern void demangler_vwarning (const char *file
, int line
,
286 const char *, va_list ap
)
287 ATTRIBUTE_PRINTF (3, 0);
289 extern void demangler_warning (const char *file
, int line
,
290 const char *, ...) ATTRIBUTE_PRINTF (3, 4);
293 /* Misc. utilities. */
295 /* Allocation and deallocation functions for the libiberty hash table
296 which use obstacks. */
297 void *hashtab_obstack_allocate (void *data
, size_t size
, size_t count
);
298 void dummy_obstack_deallocate (void *object
, void *data
);
301 extern pid_t
wait_to_die_with_timeout (pid_t pid
, int *status
, int timeout
);
304 extern int producer_is_gcc_ge_4 (const char *producer
);
305 extern int producer_is_gcc (const char *producer
, int *major
, int *minor
);
307 extern int myread (int, char *, int);
309 /* Ensure that V is aligned to an N byte boundary (B's assumed to be a
310 power of 2). Round up/down when necessary. Examples of correct
313 addr = align_up (addr, 8); -- VALUE needs 8 byte alignment
314 write_memory (addr, value, len);
319 sp = align_down (sp - len, 16); -- Keep SP 16 byte aligned
320 write_memory (sp, value, len);
322 Note that uses such as:
324 write_memory (addr, value, len);
325 addr += align_up (len, 8);
329 sp -= align_up (len, 8);
330 write_memory (sp, value, len);
332 are typically not correct as they don't ensure that the address (SP
333 or ADDR) is correctly aligned (relying on previous alignment to
334 keep things right). This is also why the methods are called
335 "align_..." instead of "round_..." as the latter reads better with
336 this incorrect coding style. */
338 extern ULONGEST
align_up (ULONGEST v
, int n
);
339 extern ULONGEST
align_down (ULONGEST v
, int n
);
341 /* Resource limits used by getrlimit and setrlimit. */
343 enum resource_limit_kind
349 /* Check whether GDB will be able to dump core using the dump_core
350 function. Returns zero if GDB cannot or should not dump core.
351 If LIMIT_KIND is LIMIT_CUR the user's soft limit will be respected.
352 If LIMIT_KIND is LIMIT_MAX only the hard limit will be respected. */
354 extern int can_dump_core (enum resource_limit_kind limit_kind
);
356 /* Print a warning that we cannot dump core. */
358 extern void warn_cant_dump_core (const char *reason
);
360 /* Dump core trying to increase the core soft limit to hard limit
363 extern void dump_core (void);
365 /* Return the hex string form of LENGTH bytes of DATA.
366 Space for the result is malloc'd, caller must free. */
368 extern char *make_hex_string (const gdb_byte
*data
, size_t length
);