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-2013 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 extern void initialize_utils (void);
28 /* String utilities. */
30 extern int sevenbit_strings;
32 extern char *savestring (const char *, size_t);
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 /* This is defined in *-hdep.c, e.g., posix-hdep.c. */
48 extern char *safe_strerror (int);
50 /* A wrapper for bfd_errmsg to produce a more helpful error message
51 in the case of bfd_error_file_ambiguously recognized.
52 MATCHING, if non-NULL, is the corresponding argument to
53 bfd_check_format_matches, and will be freed. */
55 extern const char *gdb_bfd_errmsg (bfd_error_type error_tag, char **matching);
57 /* Parsing utilites. */
59 extern int parse_pid_to_attach (char *args);
61 extern int parse_escape (struct gdbarch *, 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_htab_delete (htab_t htab);
109 extern void free_current_contents (void *);
111 extern struct cleanup *make_command_stats_cleanup (int);
113 extern void init_page_info (void);
115 extern struct cleanup *make_cleanup_restore_page_info (void);
116 extern struct cleanup *
117 set_batch_flag_and_make_cleanup_restore_page_info (void);
119 extern struct cleanup *make_bpstat_clear_actions_cleanup (void);
121 /* Path utilities. */
123 extern char *gdb_realpath (const char *);
125 extern char *xfullpath (const char *);
127 extern int gdb_filename_fnmatch (const char *pattern, const char *string,
130 extern void substitute_path_component (char **stringp, const char *from,
133 char *ldirname (const char *filename);
135 /* GDB output, ui_file utilities. */
139 extern void set_display_time (int);
141 extern void set_display_space (int);
143 extern int query (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
144 extern int nquery (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
145 extern int yquery (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
147 extern void begin_line (void);
149 extern void wrap_here (char *);
151 extern void reinitialize_more_filter (void);
153 /* Global ui_file streams. These are all defined in main.c. */
155 extern struct ui_file *gdb_stdout;
157 extern struct ui_file *gdb_stdin;
158 /* Serious error notifications */
159 extern struct ui_file *gdb_stderr;
160 /* Log/debug/trace messages that should bypass normal stdout/stderr
161 filtering. For moment, always call this stream using
162 *_unfiltered. In the very near future that restriction shall be
163 removed - either call shall be unfiltered. (cagney 1999-06-13). */
164 extern struct ui_file *gdb_stdlog;
165 /* Target output that should bypass normal stdout/stderr filtering.
166 For moment, always call this stream using *_unfiltered. In the
167 very near future that restriction shall be removed - either call
168 shall be unfiltered. (cagney 1999-07-02). */
169 extern struct ui_file *gdb_stdtarg;
170 extern struct ui_file *gdb_stdtargerr;
171 extern struct ui_file *gdb_stdtargin;
173 /* More generic printf like operations. Filtered versions may return
174 non-locally on error. */
176 extern void fputs_filtered (const char *, struct ui_file *);
178 extern void fputs_unfiltered (const char *, struct ui_file *);
180 extern int fputc_filtered (int c, struct ui_file *);
182 extern int fputc_unfiltered (int c, struct ui_file *);
184 extern int putchar_filtered (int c);
186 extern int putchar_unfiltered (int c);
188 extern void puts_filtered (const char *);
190 extern void puts_unfiltered (const char *);
192 extern void puts_filtered_tabular (char *string, int width, int right);
194 extern void puts_debug (char *prefix, char *string, char *suffix);
196 extern void vprintf_filtered (const char *, va_list) ATTRIBUTE_PRINTF (1, 0);
198 extern void vfprintf_filtered (struct ui_file *, const char *, va_list)
199 ATTRIBUTE_PRINTF (2, 0);
201 extern void fprintf_filtered (struct ui_file *, const char *, ...)
202 ATTRIBUTE_PRINTF (2, 3);
204 extern void fprintfi_filtered (int, struct ui_file *, const char *, ...)
205 ATTRIBUTE_PRINTF (3, 4);
207 extern void printf_filtered (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
209 extern void printfi_filtered (int, const char *, ...) ATTRIBUTE_PRINTF (2, 3);
211 extern void vprintf_unfiltered (const char *, va_list) ATTRIBUTE_PRINTF (1, 0);
213 extern void vfprintf_unfiltered (struct ui_file *, const char *, va_list)
214 ATTRIBUTE_PRINTF (2, 0);
216 extern void fprintf_unfiltered (struct ui_file *, const char *, ...)
217 ATTRIBUTE_PRINTF (2, 3);
219 extern void printf_unfiltered (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
221 extern void print_spaces (int, struct ui_file *);
223 extern void print_spaces_filtered (int, struct ui_file *);
225 extern char *n_spaces (int);
227 extern void fputstr_filtered (const char *str, int quotr,
228 struct ui_file * stream);
230 extern void fputstr_unfiltered (const char *str, int quotr,
231 struct ui_file * stream);
233 extern void fputstrn_filtered (const char *str, int n, int quotr,
234 struct ui_file * stream);
236 extern void fputstrn_unfiltered (const char *str, int n, int quotr,
237 struct ui_file * stream);
239 /* Display the host ADDR on STREAM formatted as ``0x%x''. */
240 extern void gdb_print_host_address (const void *addr, struct ui_file *stream);
242 extern const char *host_address_to_string (const void *addr);
244 /* Convert CORE_ADDR to string in platform-specific manner.
245 This is usually formatted similar to 0x%lx. */
246 extern const char *paddress (struct gdbarch *gdbarch, CORE_ADDR addr);
248 /* Return a string representation in hexadecimal notation of ADDRESS,
249 which is suitable for printing. */
251 extern const char *print_core_address (struct gdbarch *gdbarch,
254 /* Callback hash_f and eq_f for htab_create_alloc or htab_create_alloc_ex. */
255 extern hashval_t core_addr_hash (const void *ap);
256 extern int core_addr_eq (const void *ap, const void *bp);
259 extern char *plongest (LONGEST l);
260 /* %u for ULONGEST */
261 extern char *pulongest (ULONGEST l);
263 extern char *phex (ULONGEST l, int sizeof_l);
264 extern char *phex_nz (ULONGEST l, int sizeof_l);
265 extern char *int_string (LONGEST, int, int, int, int);
267 /* Convert a CORE_ADDR into a HEX string with leading zeros.
268 The output from core_addr_to_string() can be passed direct to
269 string_to_core_addr(). */
270 extern const char *core_addr_to_string (const CORE_ADDR addr);
271 extern const char *core_addr_to_string_nz (const CORE_ADDR addr);
272 extern CORE_ADDR string_to_core_addr (const char *my_string);
274 /* Return a string that contains a number formatted as a hex
276 extern char *hex_string (LONGEST);
277 extern char *hex_string_custom (LONGEST, int);
279 extern void fprintf_symbol_filtered (struct ui_file *, const char *,
282 extern void perror_with_name (const char *) ATTRIBUTE_NORETURN;
284 extern void print_sys_errmsg (const char *, int);
286 /* Warnings and error messages. */
288 extern void (*deprecated_error_begin_hook) (void);
290 /* Message to be printed before the error message, when an error occurs. */
292 extern char *error_pre_print;
294 /* Message to be printed before the error message, when an error occurs. */
296 extern char *quit_pre_print;
298 /* Message to be printed before the warning message, when a warning occurs. */
300 extern char *warning_pre_print;
302 extern void verror (const char *fmt, va_list ap)
303 ATTRIBUTE_NORETURN ATTRIBUTE_PRINTF (1, 0);
305 extern void error (const char *fmt, ...)
306 ATTRIBUTE_NORETURN ATTRIBUTE_PRINTF (1, 2);
308 extern void error_stream (struct ui_file *) ATTRIBUTE_NORETURN;
310 extern void vfatal (const char *fmt, va_list ap)
311 ATTRIBUTE_NORETURN ATTRIBUTE_PRINTF (1, 0);
313 extern void fatal (const char *fmt, ...)
314 ATTRIBUTE_NORETURN ATTRIBUTE_PRINTF (1, 2);
316 extern void internal_verror (const char *file, int line, const char *,
318 ATTRIBUTE_NORETURN ATTRIBUTE_PRINTF (3, 0);
320 extern void internal_vwarning (const char *file, int line,
321 const char *, va_list ap)
322 ATTRIBUTE_PRINTF (3, 0);
324 extern void internal_warning (const char *file, int line,
325 const char *, ...) ATTRIBUTE_PRINTF (3, 4);
327 extern void warning (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
329 extern void vwarning (const char *, va_list args) ATTRIBUTE_PRINTF (1, 0);
331 /* Misc. utilities. */
333 /* Allocation and deallocation functions for the libiberty hash table
334 which use obstacks. */
335 void *hashtab_obstack_allocate (void *data, size_t size, size_t count);
336 void dummy_obstack_deallocate (void *object, void *data);
339 extern pid_t wait_to_die_with_timeout (pid_t pid, int *status, int timeout);
342 extern int producer_is_gcc_ge_4 (const char *producer);
344 extern unsigned long gnu_debuglink_crc32 (unsigned long crc,
345 unsigned char *buf, size_t len);
347 extern int myread (int, char *, int);
349 /* Ensure that V is aligned to an N byte boundary (B's assumed to be a
350 power of 2). Round up/down when necessary. Examples of correct
353 addr = align_up (addr, 8); -- VALUE needs 8 byte alignment
354 write_memory (addr, value, len);
359 sp = align_down (sp - len, 16); -- Keep SP 16 byte aligned
360 write_memory (sp, value, len);
362 Note that uses such as:
364 write_memory (addr, value, len);
365 addr += align_up (len, 8);
369 sp -= align_up (len, 8);
370 write_memory (sp, value, len);
372 are typically not correct as they don't ensure that the address (SP
373 or ADDR) is correctly aligned (relying on previous alignment to
374 keep things right). This is also why the methods are called
375 "align_..." instead of "round_..." as the latter reads better with
376 this incorrect coding style. */
378 extern ULONGEST align_up (ULONGEST v, int n);
379 extern ULONGEST align_down (ULONGEST v, int n);