Rationalize "fatal" error handling outside of gdbserver
[external/binutils.git] / gdb / utils.h
1 /* *INDENT-OFF* */ /* ATTRIBUTE_PRINTF confuses indent, avoid running it
2                       for now.  */
3 /* I/O, string, cleanup, and other random utilities for GDB.
4    Copyright (C) 1986-2014 Free Software Foundation, Inc.
5
6    This file is part of GDB.
7
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.
12
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.
17
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/>.  */
20
21 #ifndef UTILS_H
22 #define UTILS_H
23
24 #include "cleanups.h"
25 #include "exceptions.h"
26 #include "print-utils.h"
27
28 extern void initialize_utils (void);
29
30 /* String utilities.  */
31
32 extern int sevenbit_strings;
33
34 extern int strcmp_iw (const char *, const char *);
35
36 extern int strcmp_iw_ordered (const char *, const char *);
37
38 extern int streq (const char *, const char *);
39
40 extern int subset_compare (char *, char *);
41
42 ULONGEST strtoulst (const char *num, const char **trailer, int base);
43
44 int compare_positive_ints (const void *ap, const void *bp);
45 int compare_strings (const void *ap, const void *bp);
46
47 /* This is defined in *-hdep.c, e.g., posix-hdep.c.  */
48 extern char *safe_strerror (int);
49
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.  */
54
55 extern const char *gdb_bfd_errmsg (bfd_error_type error_tag, char **matching);
56
57 /* Reset the prompt_for_continue clock.  */
58 void reset_prompt_for_continue_wait_time (void);
59 /* Return the time spent in prompt_for_continue.  */
60 struct timeval get_prompt_for_continue_wait_time (void);
61 \f
62 /* Parsing utilites.  */
63
64 extern int parse_pid_to_attach (const char *args);
65
66 extern int parse_escape (struct gdbarch *, const char **);
67
68 char **gdb_buildargv (const char *);
69 \f
70 /* Cleanup utilities.  */
71
72 extern struct cleanup *make_cleanup_freeargv (char **);
73
74 struct dyn_string;
75 extern struct cleanup *make_cleanup_dyn_string_delete (struct dyn_string *);
76
77 struct ui_file;
78 extern struct cleanup *make_cleanup_ui_file_delete (struct ui_file *);
79
80 struct ui_out;
81 extern struct cleanup *
82   make_cleanup_ui_out_redirect_pop (struct ui_out *uiout);
83
84 struct section_addr_info;
85 extern struct cleanup *(make_cleanup_free_section_addr_info 
86                         (struct section_addr_info *));
87
88 extern struct cleanup *make_cleanup_close (int fd);
89
90 extern struct cleanup *make_cleanup_fclose (FILE *file);
91
92 extern struct cleanup *make_cleanup_bfd_unref (bfd *abfd);
93
94 struct obstack;
95 extern struct cleanup *make_cleanup_obstack_free (struct obstack *obstack);
96
97 extern struct cleanup *make_cleanup_restore_integer (int *variable);
98 extern struct cleanup *make_cleanup_restore_uinteger (unsigned int *variable);
99
100 struct target_ops;
101 extern struct cleanup *make_cleanup_unpush_target (struct target_ops *ops);
102
103 extern struct cleanup *
104   make_cleanup_restore_ui_file (struct ui_file **variable);
105
106 extern struct cleanup *make_cleanup_value_free_to_mark (struct value *);
107 extern struct cleanup *make_cleanup_value_free (struct value *);
108
109 struct so_list;
110 extern struct cleanup *make_cleanup_free_so (struct so_list *so);
111
112 extern struct cleanup *make_cleanup_restore_current_language (void);
113
114 extern struct cleanup *make_cleanup_htab_delete (htab_t htab);
115
116 struct parser_state;
117 extern struct cleanup *make_cleanup_clear_parser_state
118   (struct parser_state **p);
119
120 extern void free_current_contents (void *);
121
122 extern void init_page_info (void);
123
124 extern struct cleanup *make_cleanup_restore_page_info (void);
125 extern struct cleanup *
126   set_batch_flag_and_make_cleanup_restore_page_info (void);
127
128 extern struct cleanup *make_bpstat_clear_actions_cleanup (void);
129 \f
130 /* Path utilities.  */
131
132 extern char *gdb_realpath (const char *);
133
134 extern char *gdb_realpath_keepfile (const char *);
135
136 extern char *gdb_abspath (const char *);
137
138 extern int gdb_filename_fnmatch (const char *pattern, const char *string,
139                                  int flags);
140
141 extern void substitute_path_component (char **stringp, const char *from,
142                                        const char *to);
143
144 char *ldirname (const char *filename);
145 \f
146 /* GDB output, ui_file utilities.  */
147
148 struct ui_file;
149
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);
153
154 extern void begin_line (void);
155
156 extern void wrap_here (char *);
157
158 extern void reinitialize_more_filter (void);
159
160 extern int pagination_enabled;
161
162 /* Global ui_file streams.  These are all defined in main.c.  */
163 /* Normal results */
164 extern struct ui_file *gdb_stdout;
165 /* Input stream */
166 extern struct ui_file *gdb_stdin;
167 /* Serious error notifications */
168 extern struct ui_file *gdb_stderr;
169 /* Log/debug/trace messages that should bypass normal stdout/stderr
170    filtering.  For moment, always call this stream using
171    *_unfiltered.  In the very near future that restriction shall be
172    removed - either call shall be unfiltered.  (cagney 1999-06-13).  */
173 extern struct ui_file *gdb_stdlog;
174 /* Target output that should bypass normal stdout/stderr filtering.
175    For moment, always call this stream using *_unfiltered.  In the
176    very near future that restriction shall be removed - either call
177    shall be unfiltered.  (cagney 1999-07-02).  */
178 extern struct ui_file *gdb_stdtarg;
179 extern struct ui_file *gdb_stdtargerr;
180 extern struct ui_file *gdb_stdtargin;
181
182 /* More generic printf like operations.  Filtered versions may return
183    non-locally on error.  */
184
185 extern void fputs_filtered (const char *, struct ui_file *);
186
187 extern void fputs_unfiltered (const char *, struct ui_file *);
188
189 extern int fputc_filtered (int c, struct ui_file *);
190
191 extern int fputc_unfiltered (int c, struct ui_file *);
192
193 extern int putchar_filtered (int c);
194
195 extern int putchar_unfiltered (int c);
196
197 extern void puts_filtered (const char *);
198
199 extern void puts_unfiltered (const char *);
200
201 extern void puts_filtered_tabular (char *string, int width, int right);
202
203 extern void puts_debug (char *prefix, char *string, char *suffix);
204
205 extern void vprintf_filtered (const char *, va_list) ATTRIBUTE_PRINTF (1, 0);
206
207 extern void vfprintf_filtered (struct ui_file *, const char *, va_list)
208   ATTRIBUTE_PRINTF (2, 0);
209
210 extern void fprintf_filtered (struct ui_file *, const char *, ...)
211   ATTRIBUTE_PRINTF (2, 3);
212
213 extern void fprintfi_filtered (int, struct ui_file *, const char *, ...)
214   ATTRIBUTE_PRINTF (3, 4);
215
216 extern void printf_filtered (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
217
218 extern void printfi_filtered (int, const char *, ...) ATTRIBUTE_PRINTF (2, 3);
219
220 extern void vprintf_unfiltered (const char *, va_list) ATTRIBUTE_PRINTF (1, 0);
221
222 extern void vfprintf_unfiltered (struct ui_file *, const char *, va_list)
223   ATTRIBUTE_PRINTF (2, 0);
224
225 extern void fprintf_unfiltered (struct ui_file *, const char *, ...)
226   ATTRIBUTE_PRINTF (2, 3);
227
228 extern void printf_unfiltered (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
229
230 extern void print_spaces (int, struct ui_file *);
231
232 extern void print_spaces_filtered (int, struct ui_file *);
233
234 extern char *n_spaces (int);
235
236 extern void fputstr_filtered (const char *str, int quotr,
237                               struct ui_file * stream);
238
239 extern void fputstr_unfiltered (const char *str, int quotr,
240                                 struct ui_file * stream);
241
242 extern void fputstrn_filtered (const char *str, int n, int quotr,
243                                struct ui_file * stream);
244
245 extern void fputstrn_unfiltered (const char *str, int n, int quotr,
246                                  struct ui_file * stream);
247
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);
250
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);
254
255 /* Return a string representation in hexadecimal notation of ADDRESS,
256    which is suitable for printing.  */
257
258 extern const char *print_core_address (struct gdbarch *gdbarch,
259                                        CORE_ADDR address);
260
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);
264
265 extern CORE_ADDR string_to_core_addr (const char *my_string);
266
267 extern void fprintf_symbol_filtered (struct ui_file *, const char *,
268                                      enum language, int);
269
270 extern void throw_perror_with_name (enum errors errcode, const char *string)
271   ATTRIBUTE_NORETURN;
272 extern void perror_with_name (const char *) ATTRIBUTE_NORETURN;
273
274 extern void perror_warning_with_name (const char *string);
275
276 extern void print_sys_errmsg (const char *, int);
277 \f
278 /* Warnings and error messages.  */
279
280 extern void (*deprecated_error_begin_hook) (void);
281
282 /* Message to be printed before the warning message, when a warning occurs.  */
283
284 extern char *warning_pre_print;
285
286 extern void verror (const char *fmt, va_list ap)
287      ATTRIBUTE_NORETURN ATTRIBUTE_PRINTF (1, 0);
288
289 extern void error (const char *fmt, ...)
290      ATTRIBUTE_NORETURN ATTRIBUTE_PRINTF (1, 2);
291
292 extern void error_stream (struct ui_file *) ATTRIBUTE_NORETURN;
293
294 extern void internal_verror (const char *file, int line, const char *,
295                              va_list ap)
296      ATTRIBUTE_NORETURN ATTRIBUTE_PRINTF (3, 0);
297
298 extern void internal_vwarning (const char *file, int line,
299                                const char *, va_list ap)
300      ATTRIBUTE_PRINTF (3, 0);
301
302 extern void internal_warning (const char *file, int line,
303                               const char *, ...) ATTRIBUTE_PRINTF (3, 4);
304
305 extern void warning (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
306
307 extern void vwarning (const char *, va_list args) ATTRIBUTE_PRINTF (1, 0);
308
309 extern void demangler_vwarning (const char *file, int line,
310                                const char *, va_list ap)
311      ATTRIBUTE_PRINTF (3, 0);
312
313 extern void demangler_warning (const char *file, int line,
314                               const char *, ...) ATTRIBUTE_PRINTF (3, 4);
315
316 \f
317 /* Misc. utilities.  */
318
319 /* Allocation and deallocation functions for the libiberty hash table
320    which use obstacks.  */
321 void *hashtab_obstack_allocate (void *data, size_t size, size_t count);
322 void dummy_obstack_deallocate (void *object, void *data);
323
324 #ifdef HAVE_WAITPID
325 extern pid_t wait_to_die_with_timeout (pid_t pid, int *status, int timeout);
326 #endif
327
328 extern int producer_is_gcc_ge_4 (const char *producer);
329
330 extern int myread (int, char *, int);
331
332 /* Ensure that V is aligned to an N byte boundary (B's assumed to be a
333    power of 2).  Round up/down when necessary.  Examples of correct
334    use include:
335
336    addr = align_up (addr, 8); -- VALUE needs 8 byte alignment
337    write_memory (addr, value, len);
338    addr += len;
339
340    and:
341
342    sp = align_down (sp - len, 16); -- Keep SP 16 byte aligned
343    write_memory (sp, value, len);
344
345    Note that uses such as:
346
347    write_memory (addr, value, len);
348    addr += align_up (len, 8);
349
350    and:
351
352    sp -= align_up (len, 8);
353    write_memory (sp, value, len);
354
355    are typically not correct as they don't ensure that the address (SP
356    or ADDR) is correctly aligned (relying on previous alignment to
357    keep things right).  This is also why the methods are called
358    "align_..." instead of "round_..." as the latter reads better with
359    this incorrect coding style.  */
360
361 extern ULONGEST align_up (ULONGEST v, int n);
362 extern ULONGEST align_down (ULONGEST v, int n);
363
364 /* Sign extend VALUE.  BIT is the (1-based) index of the bit in VALUE
365    to sign-extend.  */
366
367 extern LONGEST gdb_sign_extend (LONGEST value, int bit);
368
369 /* Resource limits used by getrlimit and setrlimit.  */
370
371 enum resource_limit_kind
372   {
373     LIMIT_CUR,
374     LIMIT_MAX
375   };
376
377 /* Check whether GDB will be able to dump core using the dump_core
378    function.  Returns zero if GDB cannot or should not dump core.
379    If LIMIT_KIND is LIMIT_CUR the user's soft limit will be respected.
380    If LIMIT_KIND is LIMIT_MAX only the hard limit will be respected.  */
381
382 extern int can_dump_core (enum resource_limit_kind limit_kind);
383
384 /* Print a warning that we cannot dump core.  */
385
386 extern void warn_cant_dump_core (const char *reason);
387
388 /* Dump core trying to increase the core soft limit to hard limit
389    first.  */
390
391 extern void dump_core (void);
392
393 #endif /* UTILS_H */