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