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