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