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