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