]> git.ipfire.org Git - thirdparty/binutils-gdb.git/blame - gdb/utils.h
Adjust linker test for arm-vxworks in wake of patch for PR 20815.
[thirdparty/binutils-gdb.git] / gdb / utils.h
CommitLineData
48faced0
DE
1/* *INDENT-OFF* */ /* ATTRIBUTE_PRINTF confuses indent, avoid running it
2 for now. */
3/* I/O, string, cleanup, and other random utilities for GDB.
618f726f 4 Copyright (C) 1986-2016 Free Software Foundation, Inc.
48faced0
DE
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
af880d85 24#include "exceptions.h"
b7b633e9 25#include "common/scoped_restore.h"
48faced0
DE
26
27extern void initialize_utils (void);
28
29/* String utilities. */
30
31extern int sevenbit_strings;
32
48faced0
DE
33extern int strcmp_iw (const char *, const char *);
34
35extern int strcmp_iw_ordered (const char *, const char *);
36
37extern int streq (const char *, const char *);
38
39extern int subset_compare (char *, char *);
40
48faced0
DE
41int compare_positive_ints (const void *ap, const void *bp);
42int compare_strings (const void *ap, const void *bp);
43
48faced0
DE
44/* A wrapper for bfd_errmsg to produce a more helpful error message
45 in the case of bfd_error_file_ambiguously recognized.
46 MATCHING, if non-NULL, is the corresponding argument to
47 bfd_check_format_matches, and will be freed. */
48
49extern const char *gdb_bfd_errmsg (bfd_error_type error_tag, char **matching);
bd712aed
DE
50
51/* Reset the prompt_for_continue clock. */
52void reset_prompt_for_continue_wait_time (void);
53/* Return the time spent in prompt_for_continue. */
54struct timeval get_prompt_for_continue_wait_time (void);
48faced0
DE
55\f
56/* Parsing utilites. */
57
c0939df1 58extern int parse_pid_to_attach (const char *args);
48faced0 59
d7561cbb 60extern int parse_escape (struct gdbarch *, const char **);
48faced0
DE
61
62char **gdb_buildargv (const char *);
63\f
64/* Cleanup utilities. */
65
66extern struct cleanup *make_cleanup_freeargv (char **);
67
48faced0
DE
68struct ui_file;
69extern struct cleanup *make_cleanup_ui_file_delete (struct ui_file *);
70
71struct ui_out;
72extern struct cleanup *
73 make_cleanup_ui_out_redirect_pop (struct ui_out *uiout);
74
75struct section_addr_info;
76extern struct cleanup *(make_cleanup_free_section_addr_info
77 (struct section_addr_info *));
78
ca095836 79/* For make_cleanup_close see common/filestuff.h. */
48faced0
DE
80
81extern struct cleanup *make_cleanup_fclose (FILE *file);
82
83extern struct cleanup *make_cleanup_bfd_unref (bfd *abfd);
84
85struct obstack;
86extern struct cleanup *make_cleanup_obstack_free (struct obstack *obstack);
87
88extern struct cleanup *make_cleanup_restore_integer (int *variable);
89extern struct cleanup *make_cleanup_restore_uinteger (unsigned int *variable);
90
91struct target_ops;
92extern struct cleanup *make_cleanup_unpush_target (struct target_ops *ops);
93
48faced0
DE
94extern struct cleanup *make_cleanup_value_free_to_mark (struct value *);
95extern struct cleanup *make_cleanup_value_free (struct value *);
96
97struct so_list;
98extern struct cleanup *make_cleanup_free_so (struct so_list *so);
99
5b12a61c
JK
100extern struct cleanup *make_cleanup_restore_current_language (void);
101
48faced0
DE
102extern struct cleanup *make_cleanup_htab_delete (htab_t htab);
103
410a0ff2
SDJ
104struct parser_state;
105extern struct cleanup *make_cleanup_clear_parser_state
106 (struct parser_state **p);
107
48faced0
DE
108extern void free_current_contents (void *);
109
48faced0
DE
110extern void init_page_info (void);
111
112extern struct cleanup *make_cleanup_restore_page_info (void);
113extern struct cleanup *
114 set_batch_flag_and_make_cleanup_restore_page_info (void);
115
116extern struct cleanup *make_bpstat_clear_actions_cleanup (void);
117\f
118/* Path utilities. */
119
120extern char *gdb_realpath (const char *);
121
4856b6bc
JK
122extern char *gdb_realpath_keepfile (const char *);
123
04affae3
JK
124extern char *gdb_abspath (const char *);
125
48faced0
DE
126extern int gdb_filename_fnmatch (const char *pattern, const char *string,
127 int flags);
128
129extern void substitute_path_component (char **stringp, const char *from,
130 const char *to);
131
132char *ldirname (const char *filename);
cce0e923
DE
133
134extern int count_path_elements (const char *path);
135
136extern const char *strip_leading_path_elements (const char *path, int n);
48faced0
DE
137\f
138/* GDB output, ui_file utilities. */
139
140struct ui_file;
141
48faced0
DE
142extern int query (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
143extern int nquery (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
144extern int yquery (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
145
146extern void begin_line (void);
147
148extern void wrap_here (char *);
149
150extern void reinitialize_more_filter (void);
151
74da6f00
PA
152extern int pagination_enabled;
153
79aa2fe8
PA
154extern struct ui_file **current_ui_gdb_stdout_ptr (void);
155extern struct ui_file **current_ui_gdb_stdin_ptr (void);
156extern struct ui_file **current_ui_gdb_stderr_ptr (void);
157extern struct ui_file **current_ui_gdb_stdlog_ptr (void);
158
159/* The current top level's ui_file streams. */
160
48faced0 161/* Normal results */
79aa2fe8 162#define gdb_stdout (*current_ui_gdb_stdout_ptr ())
48faced0 163/* Input stream */
79aa2fe8 164#define gdb_stdin (*current_ui_gdb_stdin_ptr ())
48faced0 165/* Serious error notifications */
79aa2fe8 166#define gdb_stderr (*current_ui_gdb_stderr_ptr ())
48faced0
DE
167/* Log/debug/trace messages that should bypass normal stdout/stderr
168 filtering. For moment, always call this stream using
169 *_unfiltered. In the very near future that restriction shall be
170 removed - either call shall be unfiltered. (cagney 1999-06-13). */
79aa2fe8
PA
171#define gdb_stdlog (*current_ui_gdb_stdlog_ptr ())
172
173/* Truly global ui_file streams. These are all defined in main.c. */
174
48faced0
DE
175/* Target output that should bypass normal stdout/stderr filtering.
176 For moment, always call this stream using *_unfiltered. In the
177 very near future that restriction shall be removed - either call
178 shall be unfiltered. (cagney 1999-07-02). */
179extern struct ui_file *gdb_stdtarg;
180extern struct ui_file *gdb_stdtargerr;
181extern struct ui_file *gdb_stdtargin;
182
d6e5e7f7
PP
183/* Set the screen dimensions to WIDTH and HEIGHT. */
184
185extern void set_screen_width_and_height (int width, int height);
186
48faced0
DE
187/* More generic printf like operations. Filtered versions may return
188 non-locally on error. */
189
190extern void fputs_filtered (const char *, struct ui_file *);
191
192extern void fputs_unfiltered (const char *, struct ui_file *);
193
194extern int fputc_filtered (int c, struct ui_file *);
195
196extern int fputc_unfiltered (int c, struct ui_file *);
197
198extern int putchar_filtered (int c);
199
200extern int putchar_unfiltered (int c);
201
202extern void puts_filtered (const char *);
203
204extern void puts_unfiltered (const char *);
205
206extern void puts_filtered_tabular (char *string, int width, int right);
207
208extern void puts_debug (char *prefix, char *string, char *suffix);
209
210extern void vprintf_filtered (const char *, va_list) ATTRIBUTE_PRINTF (1, 0);
211
212extern void vfprintf_filtered (struct ui_file *, const char *, va_list)
213 ATTRIBUTE_PRINTF (2, 0);
214
215extern void fprintf_filtered (struct ui_file *, const char *, ...)
216 ATTRIBUTE_PRINTF (2, 3);
217
218extern void fprintfi_filtered (int, struct ui_file *, const char *, ...)
219 ATTRIBUTE_PRINTF (3, 4);
220
221extern void printf_filtered (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
222
223extern void printfi_filtered (int, const char *, ...) ATTRIBUTE_PRINTF (2, 3);
224
225extern void vprintf_unfiltered (const char *, va_list) ATTRIBUTE_PRINTF (1, 0);
226
227extern void vfprintf_unfiltered (struct ui_file *, const char *, va_list)
228 ATTRIBUTE_PRINTF (2, 0);
229
230extern void fprintf_unfiltered (struct ui_file *, const char *, ...)
231 ATTRIBUTE_PRINTF (2, 3);
232
233extern void printf_unfiltered (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
234
235extern void print_spaces (int, struct ui_file *);
236
237extern void print_spaces_filtered (int, struct ui_file *);
238
239extern char *n_spaces (int);
240
241extern void fputstr_filtered (const char *str, int quotr,
242 struct ui_file * stream);
243
244extern void fputstr_unfiltered (const char *str, int quotr,
245 struct ui_file * stream);
246
247extern void fputstrn_filtered (const char *str, int n, int quotr,
248 struct ui_file * stream);
249
250extern void fputstrn_unfiltered (const char *str, int n, int quotr,
251 struct ui_file * stream);
252
2437fd32
GB
253/* Return nonzero if filtered printing is initialized. */
254extern int filtered_printing_initialized (void);
255
48faced0 256/* Display the host ADDR on STREAM formatted as ``0x%x''. */
b80c3053
PA
257extern void gdb_print_host_address_1 (const void *addr, struct ui_file *stream);
258
259/* Wrapper that avoids adding a pointless cast to all callers. */
260#define gdb_print_host_address(ADDR, STREAM) \
261 gdb_print_host_address_1 ((const void *) ADDR, STREAM)
48faced0 262
48faced0
DE
263/* Convert CORE_ADDR to string in platform-specific manner.
264 This is usually formatted similar to 0x%lx. */
265extern const char *paddress (struct gdbarch *gdbarch, CORE_ADDR addr);
266
267/* Return a string representation in hexadecimal notation of ADDRESS,
268 which is suitable for printing. */
269
270extern const char *print_core_address (struct gdbarch *gdbarch,
271 CORE_ADDR address);
272
273/* Callback hash_f and eq_f for htab_create_alloc or htab_create_alloc_ex. */
274extern hashval_t core_addr_hash (const void *ap);
275extern int core_addr_eq (const void *ap, const void *bp);
276
48faced0
DE
277extern CORE_ADDR string_to_core_addr (const char *my_string);
278
48faced0
DE
279extern void fprintf_symbol_filtered (struct ui_file *, const char *,
280 enum language, int);
281
598d3636
JK
282extern void throw_perror_with_name (enum errors errcode, const char *string)
283 ATTRIBUTE_NORETURN;
48faced0 284
7c647d61
JB
285extern void perror_warning_with_name (const char *string);
286
48faced0
DE
287extern void print_sys_errmsg (const char *, int);
288\f
289/* Warnings and error messages. */
290
291extern void (*deprecated_error_begin_hook) (void);
292
48faced0
DE
293/* Message to be printed before the warning message, when a warning occurs. */
294
295extern char *warning_pre_print;
296
48faced0
DE
297extern void error_stream (struct ui_file *) ATTRIBUTE_NORETURN;
298
57fcfb1b
GB
299extern void demangler_vwarning (const char *file, int line,
300 const char *, va_list ap)
301 ATTRIBUTE_PRINTF (3, 0);
302
303extern void demangler_warning (const char *file, int line,
304 const char *, ...) ATTRIBUTE_PRINTF (3, 4);
305
48faced0
DE
306\f
307/* Misc. utilities. */
308
309/* Allocation and deallocation functions for the libiberty hash table
310 which use obstacks. */
311void *hashtab_obstack_allocate (void *data, size_t size, size_t count);
312void dummy_obstack_deallocate (void *object, void *data);
313
314#ifdef HAVE_WAITPID
315extern pid_t wait_to_die_with_timeout (pid_t pid, int *status, int timeout);
316#endif
317
318extern int producer_is_gcc_ge_4 (const char *producer);
cc7039d3 319extern int producer_is_gcc (const char *producer, int *major, int *minor);
48faced0 320
48faced0
DE
321extern int myread (int, char *, int);
322
323/* Ensure that V is aligned to an N byte boundary (B's assumed to be a
324 power of 2). Round up/down when necessary. Examples of correct
325 use include:
326
327 addr = align_up (addr, 8); -- VALUE needs 8 byte alignment
328 write_memory (addr, value, len);
329 addr += len;
330
331 and:
332
333 sp = align_down (sp - len, 16); -- Keep SP 16 byte aligned
334 write_memory (sp, value, len);
335
336 Note that uses such as:
337
338 write_memory (addr, value, len);
339 addr += align_up (len, 8);
340
341 and:
342
343 sp -= align_up (len, 8);
344 write_memory (sp, value, len);
345
346 are typically not correct as they don't ensure that the address (SP
347 or ADDR) is correctly aligned (relying on previous alignment to
348 keep things right). This is also why the methods are called
349 "align_..." instead of "round_..." as the latter reads better with
350 this incorrect coding style. */
351
352extern ULONGEST align_up (ULONGEST v, int n);
353extern ULONGEST align_down (ULONGEST v, int n);
354
eae7090b
GB
355/* Resource limits used by getrlimit and setrlimit. */
356
357enum resource_limit_kind
358 {
359 LIMIT_CUR,
360 LIMIT_MAX
361 };
362
363/* Check whether GDB will be able to dump core using the dump_core
364 function. Returns zero if GDB cannot or should not dump core.
365 If LIMIT_KIND is LIMIT_CUR the user's soft limit will be respected.
366 If LIMIT_KIND is LIMIT_MAX only the hard limit will be respected. */
367
368extern int can_dump_core (enum resource_limit_kind limit_kind);
369
370/* Print a warning that we cannot dump core. */
371
372extern void warn_cant_dump_core (const char *reason);
373
374/* Dump core trying to increase the core soft limit to hard limit
375 first. */
376
377extern void dump_core (void);
378
7c50a931
DE
379/* Return the hex string form of LENGTH bytes of DATA.
380 Space for the result is malloc'd, caller must free. */
381
382extern char *make_hex_string (const gdb_byte *data, size_t length);
383
48faced0 384#endif /* UTILS_H */