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