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-2020 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 "gdbsupport/scoped_restore.h"
  26 #include <chrono>
  27
  28 #ifdef HAVE_LIBXXHASH
  29 #include <xxhash.h>
  30 #endif
  31
  32 struct completion_match_for_lcd;
  33 class compiled_regex;
  34
  35 /* String utilities.  */
  36
  37 extern bool sevenbit_strings;
  38
  39 /* Modes of operation for strncmp_iw_with_mode.  */
  40
  41 enum class strncmp_iw_mode
  42 {
  43 /* Do a strcmp() type operation on STRING1 and STRING2, ignoring any
  44    differences in whitespace.  Returns 0 if they match, non-zero if
  45    they don't (slightly different than strcmp()'s range of return
  46    values).  */
  47   NORMAL,
  48
  49   /* Like NORMAL, but also apply the strcmp_iw hack.  I.e.,
  50      string1=="FOO(PARAMS)" matches string2=="FOO".  */
  51   MATCH_PARAMS,
  52 };
  53
  54 /* Helper for strcmp_iw and strncmp_iw.  Exported so that languages
  55    can implement both NORMAL and MATCH_PARAMS variants in a single
  56    function and defer part of the work to strncmp_iw_with_mode.
  57
  58    LANGUAGE is used to implement some context-sensitive
  59    language-specific comparisons.  For example, for C++,
  60    "string1=operator()" should not match "string2=operator" even in
  61    MATCH_PARAMS mode.
  62
  63    MATCH_FOR_LCD is passed down so that the function can mark parts of
  64    the symbol name as ignored for completion matching purposes (e.g.,
  65    to handle abi tags).  */
  66 extern int strncmp_iw_with_mode
  67   (const char *string1, const char *string2, size_t string2_len,
  68    strncmp_iw_mode mode, enum language language,
  69    completion_match_for_lcd *match_for_lcd = NULL);
  70
  71 /* Do a strncmp() type operation on STRING1 and STRING2, ignoring any
  72    differences in whitespace.  STRING2_LEN is STRING2's length.
  73    Returns 0 if STRING1 matches STRING2_LEN characters of STRING2,
  74    non-zero otherwise (slightly different than strncmp()'s range of
  75    return values).  Note: passes language_minimal to
  76    strncmp_iw_with_mode, and should therefore be avoided if a more
  77    suitable language is available.  */
  78 extern int strncmp_iw (const char *string1, const char *string2,
  79                        size_t string2_len);
  80
  81 /* Do a strcmp() type operation on STRING1 and STRING2, ignoring any
  82    differences in whitespace.  Returns 0 if they match, non-zero if
  83    they don't (slightly different than strcmp()'s range of return
  84    values).
  85
  86    As an extra hack, string1=="FOO(ARGS)" matches string2=="FOO".
  87    This "feature" is useful when searching for matching C++ function
  88    names (such as if the user types 'break FOO', where FOO is a
  89    mangled C++ function).
  90
  91    Note: passes language_minimal to strncmp_iw_with_mode, and should
  92    therefore be avoided if a more suitable language is available.  */
  93 extern int strcmp_iw (const char *string1, const char *string2);
  94
  95 extern int strcmp_iw_ordered (const char *, const char *);
  96
  97 /* Return true if the strings are equal.  */
  98
  99 extern bool streq (const char *, const char *);
 100
 101 /* A variant of streq that is suitable for use as an htab
 102    callback.  */
 103
 104 extern int streq_hash (const void *, const void *);
 105
 106 extern int subset_compare (const char *, const char *);
 107
 108 /* Compare C strings for std::sort.  */
 109
 110 static inline bool
 111 compare_cstrings (const char *str1, const char *str2)
 112 {
 113   return strcmp (str1, str2) < 0;
 114 }
 115
 116 /* A wrapper for bfd_errmsg to produce a more helpful error message
 117    in the case of bfd_error_file_ambiguously recognized.
 118    MATCHING, if non-NULL, is the corresponding argument to
 119    bfd_check_format_matches, and will be freed.  */
 120
 121 extern std::string gdb_bfd_errmsg (bfd_error_type error_tag, char **matching);
 122
 123 /* Reset the prompt_for_continue clock.  */
 124 void reset_prompt_for_continue_wait_time (void);
 125 /* Return the time spent in prompt_for_continue.  */
 126 std::chrono::steady_clock::duration get_prompt_for_continue_wait_time ();
 127 \f
 128 /* Parsing utilities.  */
 129
 130 extern int parse_pid_to_attach (const char *args);
 131
 132 extern int parse_escape (struct gdbarch *, const char **);
 133
 134 /* A wrapper for an array of char* that was allocated in the way that
 135    'buildargv' does, and should be freed with 'freeargv'.  */
 136
 137 class gdb_argv
 138 {
 139 public:
 140
 141   /* A constructor that initializes to NULL.  */
 142
 143   gdb_argv ()
 144     : m_argv (NULL)
 145   {
 146   }
 147
 148   /* A constructor that calls buildargv on STR.  STR may be NULL, in
 149      which case this object is initialized with a NULL array.  */
 150
 151   explicit gdb_argv (const char *str)
 152     : m_argv (NULL)
 153   {
 154     reset (str);
 155   }
 156
 157   /* A constructor that takes ownership of an existing array.  */
 158
 159   explicit gdb_argv (char **array)
 160     : m_argv (array)
 161   {
 162   }
 163
 164   gdb_argv (const gdb_argv &) = delete;
 165   gdb_argv &operator= (const gdb_argv &) = delete;
 166
 167   ~gdb_argv ()
 168   {
 169     freeargv (m_argv);
 170   }
 171
 172   /* Call buildargv on STR, storing the result in this object.  Any
 173      previous state is freed.  STR may be NULL, in which case this
 174      object is reset with a NULL array.  If buildargv fails due to
 175      out-of-memory, call malloc_failure.  Therefore, the value is
 176      guaranteed to be non-NULL, unless the parameter itself is
 177      NULL.  */
 178
 179   void reset (const char *str);
 180
 181   /* Return the underlying array.  */
 182
 183   char **get ()
 184   {
 185     return m_argv;
 186   }
 187
 188   /* Return the underlying array, transferring ownership to the
 189      caller.  */
 190
 191   ATTRIBUTE_UNUSED_RESULT char **release ()
 192   {
 193     char **result = m_argv;
 194     m_argv = NULL;
 195     return result;
 196   }
 197
 198   /* Return the number of items in the array.  */
 199
 200   int count () const
 201   {
 202     return countargv (m_argv);
 203   }
 204
 205   /* Index into the array.  */
 206
 207   char *operator[] (int arg)
 208   {
 209     gdb_assert (m_argv != NULL);
 210     return m_argv[arg];
 211   }
 212
 213   /* The iterator type.  */
 214
 215   typedef char **iterator;
 216
 217   /* Return an iterator pointing to the start of the array.  */
 218
 219   iterator begin ()
 220   {
 221     return m_argv;
 222   }
 223
 224   /* Return an iterator pointing to the end of the array.  */
 225
 226   iterator end ()
 227   {
 228     return m_argv + count ();
 229   }
 230
 231   bool operator!= (std::nullptr_t)
 232   {
 233     return m_argv != NULL;
 234   }
 235
 236   bool operator== (std::nullptr_t)
 237   {
 238     return m_argv == NULL;
 239   }
 240
 241 private:
 242
 243   /* The wrapped array.  */
 244
 245   char **m_argv;
 246 };
 247
 248 \f
 249 /* Cleanup utilities.  */
 250
 251 /* A deleter for a hash table.  */
 252 struct htab_deleter
 253 {
 254   void operator() (htab *ptr) const
 255   {
 256     htab_delete (ptr);
 257   }
 258 };
 259
 260 /* A unique_ptr wrapper for htab_t.  */
 261 typedef std::unique_ptr<htab, htab_deleter> htab_up;
 262
 263 extern void init_page_info (void);
 264
 265 /* Temporarily set BATCH_FLAG and the associated unlimited terminal size.
 266    Restore when destroyed.  */
 267
 268 struct set_batch_flag_and_restore_page_info
 269 {
 270 public:
 271
 272   set_batch_flag_and_restore_page_info ();
 273   ~set_batch_flag_and_restore_page_info ();
 274
 275   DISABLE_COPY_AND_ASSIGN (set_batch_flag_and_restore_page_info);
 276
 277 private:
 278
 279   /* Note that this doesn't use scoped_restore, because it's important
 280      to control the ordering of operations in the destruction, and it
 281      was simpler to avoid introducing a new ad hoc class.  */
 282   unsigned m_save_lines_per_page;
 283   unsigned m_save_chars_per_line;
 284   int m_save_batch_flag;
 285 };
 286
 287 \f
 288 /* Path utilities.  */
 289
 290 extern int gdb_filename_fnmatch (const char *pattern, const char *string,
 291                                  int flags);
 292
 293 extern void substitute_path_component (char **stringp, const char *from,
 294                                        const char *to);
 295
 296 std::string ldirname (const char *filename);
 297
 298 extern int count_path_elements (const char *path);
 299
 300 extern const char *strip_leading_path_elements (const char *path, int n);
 301 \f
 302 /* GDB output, ui_file utilities.  */
 303
 304 struct ui_file;
 305
 306 extern int query (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
 307 extern int nquery (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
 308 extern int yquery (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
 309
 310 extern void begin_line (void);
 311
 312 extern void wrap_here (const char *);
 313
 314 extern void reinitialize_more_filter (void);
 315
 316 extern bool pagination_enabled;
 317
 318 extern struct ui_file **current_ui_gdb_stdout_ptr (void);
 319 extern struct ui_file **current_ui_gdb_stdin_ptr (void);
 320 extern struct ui_file **current_ui_gdb_stderr_ptr (void);
 321 extern struct ui_file **current_ui_gdb_stdlog_ptr (void);
 322
 323 /* The current top level's ui_file streams.  */
 324
 325 /* Normal results */
 326 #define gdb_stdout (*current_ui_gdb_stdout_ptr ())
 327 /* Input stream */
 328 #define gdb_stdin (*current_ui_gdb_stdin_ptr ())
 329 /* Serious error notifications */
 330 #define gdb_stderr (*current_ui_gdb_stderr_ptr ())
 331 /* Log/debug/trace messages that should bypass normal stdout/stderr
 332    filtering.  For moment, always call this stream using
 333    *_unfiltered.  In the very near future that restriction shall be
 334    removed - either call shall be unfiltered.  (cagney 1999-06-13).  */
 335 #define gdb_stdlog (*current_ui_gdb_stdlog_ptr ())
 336
 337 /* Truly global ui_file streams.  These are all defined in main.c.  */
 338
 339 /* Target output that should bypass normal stdout/stderr filtering.
 340    For moment, always call this stream using *_unfiltered.  In the
 341    very near future that restriction shall be removed - either call
 342    shall be unfiltered.  (cagney 1999-07-02).  */
 343 extern struct ui_file *gdb_stdtarg;
 344 extern struct ui_file *gdb_stdtargerr;
 345 extern struct ui_file *gdb_stdtargin;
 346
 347 /* Set the screen dimensions to WIDTH and HEIGHT.  */
 348
 349 extern void set_screen_width_and_height (int width, int height);
 350
 351 /* More generic printf like operations.  Filtered versions may return
 352    non-locally on error.  As an extension over plain printf, these
 353    support some GDB-specific format specifiers.  Particularly useful
 354    here are the styling formatters: '%p[', '%p]' and '%ps'.  See
 355    ui_out::message for details.  */
 356
 357 extern void fputs_filtered (const char *, struct ui_file *);
 358
 359 extern void fputs_unfiltered (const char *, struct ui_file *);
 360
 361 extern int fputc_filtered (int c, struct ui_file *);
 362
 363 extern int fputc_unfiltered (int c, struct ui_file *);
 364
 365 extern int putchar_filtered (int c);
 366
 367 extern int putchar_unfiltered (int c);
 368
 369 extern void puts_filtered (const char *);
 370
 371 extern void puts_unfiltered (const char *);
 372
 373 extern void puts_filtered_tabular (char *string, int width, int right);
 374
 375 extern void puts_debug (char *prefix, char *string, char *suffix);
 376
 377 extern void vprintf_filtered (const char *, va_list) ATTRIBUTE_PRINTF (1, 0);
 378
 379 extern void vfprintf_filtered (struct ui_file *, const char *, va_list)
 380   ATTRIBUTE_PRINTF (2, 0);
 381
 382 extern void fprintf_filtered (struct ui_file *, const char *, ...)
 383   ATTRIBUTE_PRINTF (2, 3);
 384
 385 extern void fprintfi_filtered (int, struct ui_file *, const char *, ...)
 386   ATTRIBUTE_PRINTF (3, 4);
 387
 388 extern void printf_filtered (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
 389
 390 extern void printfi_filtered (int, const char *, ...) ATTRIBUTE_PRINTF (2, 3);
 391
 392 extern void vprintf_unfiltered (const char *, va_list) ATTRIBUTE_PRINTF (1, 0);
 393
 394 extern void vfprintf_unfiltered (struct ui_file *, const char *, va_list)
 395   ATTRIBUTE_PRINTF (2, 0);
 396
 397 extern void fprintf_unfiltered (struct ui_file *, const char *, ...)
 398   ATTRIBUTE_PRINTF (2, 3);
 399
 400 extern void printf_unfiltered (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
 401
 402 extern void print_spaces (int, struct ui_file *);
 403
 404 extern void print_spaces_filtered (int, struct ui_file *);
 405
 406 extern char *n_spaces (int);
 407
 408 extern void fputstr_filtered (const char *str, int quotr,
 409                               struct ui_file * stream);
 410
 411 extern void fputstr_unfiltered (const char *str, int quotr,
 412                                 struct ui_file * stream);
 413
 414 extern void fputstrn_filtered (const char *str, int n, int quotr,
 415                                struct ui_file * stream);
 416
 417 typedef int (*do_fputc_ftype) (int c, ui_file *stream);
 418
 419 extern void fputstrn_unfiltered (const char *str, int n, int quotr,
 420                                  do_fputc_ftype do_fputc,
 421                                  struct ui_file * stream);
 422
 423 /* Return nonzero if filtered printing is initialized.  */
 424 extern int filtered_printing_initialized (void);
 425
 426 /* Like fprintf_filtered, but styles the output according to STYLE,
 427    when appropriate.  */
 428
 429 extern void fprintf_styled (struct ui_file *stream,
 430                             const ui_file_style &style,
 431                             const char *fmt,
 432                             ...)
 433   ATTRIBUTE_PRINTF (3, 4);
 434
 435 extern void vfprintf_styled (struct ui_file *stream,
 436                              const ui_file_style &style,
 437                              const char *fmt,
 438                              va_list args)
 439   ATTRIBUTE_PRINTF (3, 0);
 440
 441 /* Like vfprintf_styled, but do not process gdb-specific format
 442    specifiers.  */
 443 extern void vfprintf_styled_no_gdbfmt (struct ui_file *stream,
 444                                        const ui_file_style &style,
 445                                        bool filter,
 446                                        const char *fmt, va_list args)
 447   ATTRIBUTE_PRINTF (4, 0);
 448
 449 /* Like fputs_filtered, but styles the output according to STYLE, when
 450    appropriate.  */
 451
 452 extern void fputs_styled (const char *linebuffer,
 453                           const ui_file_style &style,
 454                           struct ui_file *stream);
 455
 456 /* Unfiltered variant of fputs_styled.  */
 457
 458 extern void fputs_styled_unfiltered (const char *linebuffer,
 459                                      const ui_file_style &style,
 460                                      struct ui_file *stream);
 461
 462 /* Like fputs_styled, but uses highlight_style to highlight the
 463    parts of STR that match HIGHLIGHT.  */
 464
 465 extern void fputs_highlighted (const char *str, const compiled_regex &highlight,
 466                                struct ui_file *stream);
 467
 468 /* Reset the terminal style to the default, if needed.  */
 469
 470 extern void reset_terminal_style (struct ui_file *stream);
 471
 472 /* Display the host ADDR on STREAM formatted as ``0x%x''.  */
 473 extern void gdb_print_host_address_1 (const void *addr, struct ui_file *stream);
 474
 475 /* Wrapper that avoids adding a pointless cast to all callers.  */
 476 #define gdb_print_host_address(ADDR, STREAM) \
 477   gdb_print_host_address_1 ((const void *) ADDR, STREAM)
 478
 479 /* Return the address only having significant bits.  */
 480 extern CORE_ADDR address_significant (gdbarch *gdbarch, CORE_ADDR addr);
 481
 482 /* Convert CORE_ADDR to string in platform-specific manner.
 483    This is usually formatted similar to 0x%lx.  */
 484 extern const char *paddress (struct gdbarch *gdbarch, CORE_ADDR addr);
 485
 486 /* Return a string representation in hexadecimal notation of ADDRESS,
 487    which is suitable for printing.  */
 488
 489 extern const char *print_core_address (struct gdbarch *gdbarch,
 490                                        CORE_ADDR address);
 491
 492 /* Callback hash_f and eq_f for htab_create_alloc or htab_create_alloc_ex.  */
 493 extern hashval_t core_addr_hash (const void *ap);
 494 extern int core_addr_eq (const void *ap, const void *bp);
 495
 496 extern CORE_ADDR string_to_core_addr (const char *my_string);
 497
 498 extern void fprintf_symbol_filtered (struct ui_file *, const char *,
 499                                      enum language, int);
 500
 501 extern void throw_perror_with_name (enum errors errcode, const char *string)
 502   ATTRIBUTE_NORETURN;
 503
 504 extern void perror_warning_with_name (const char *string);
 505
 506 extern void print_sys_errmsg (const char *, int);
 507 \f
 508 /* Warnings and error messages.  */
 509
 510 extern void (*deprecated_error_begin_hook) (void);
 511
 512 /* Message to be printed before the warning message, when a warning occurs.  */
 513
 514 extern const char *warning_pre_print;
 515
 516 extern void error_stream (const string_file &) ATTRIBUTE_NORETURN;
 517
 518 extern void demangler_vwarning (const char *file, int line,
 519                                const char *, va_list ap)
 520      ATTRIBUTE_PRINTF (3, 0);
 521
 522 extern void demangler_warning (const char *file, int line,
 523                               const char *, ...) ATTRIBUTE_PRINTF (3, 4);
 524
 525 \f
 526 /* Misc. utilities.  */
 527
 528 /* Allocation and deallocation functions for the libiberty hash table
 529    which use obstacks.  */
 530 void *hashtab_obstack_allocate (void *data, size_t size, size_t count);
 531 void dummy_obstack_deallocate (void *object, void *data);
 532
 533 #ifdef HAVE_WAITPID
 534 extern pid_t wait_to_die_with_timeout (pid_t pid, int *status, int timeout);
 535 #endif
 536
 537 extern int myread (int, char *, int);
 538
 539 /* Resource limits used by getrlimit and setrlimit.  */
 540
 541 enum resource_limit_kind
 542   {
 543     LIMIT_CUR,
 544     LIMIT_MAX
 545   };
 546
 547 /* Check whether GDB will be able to dump core using the dump_core
 548    function.  Returns zero if GDB cannot or should not dump core.
 549    If LIMIT_KIND is LIMIT_CUR the user's soft limit will be respected.
 550    If LIMIT_KIND is LIMIT_MAX only the hard limit will be respected.  */
 551
 552 extern int can_dump_core (enum resource_limit_kind limit_kind);
 553
 554 /* Print a warning that we cannot dump core.  */
 555
 556 extern void warn_cant_dump_core (const char *reason);
 557
 558 /* Dump core trying to increase the core soft limit to hard limit
 559    first.  */
 560
 561 extern void dump_core (void);
 562
 563 /* Copy NBITS bits from SOURCE to DEST starting at the given bit
 564    offsets.  Use the bit order as specified by BITS_BIG_ENDIAN.
 565    Source and destination buffers must not overlap.  */
 566
 567 extern void copy_bitwise (gdb_byte *dest, ULONGEST dest_offset,
 568                           const gdb_byte *source, ULONGEST source_offset,
 569                           ULONGEST nbits, int bits_big_endian);
 570
 571 /* A fast hashing function.  This can be used to hash data in a fast way
 572    when the length is known.  If no fast hashing library is available, falls
 573    back to iterative_hash from libiberty.  START_VALUE can be set to
 574    continue hashing from a previous value.  */
 575
 576 static inline unsigned int
 577 fast_hash (const void *ptr, size_t len, unsigned int start_value = 0)
 578 {
 579 #ifdef HAVE_LIBXXHASH
 580   return XXH64 (ptr, len, start_value);
 581 #else
 582   return iterative_hash (ptr, len, start_value);
 583 #endif
 584 }
 585
 586 #endif /* UTILS_H */