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 /* Modes of operation for strncmp_iw_with_mode.  */
  35
  36 enum class strncmp_iw_mode
  37 {
  38 /* Do a strcmp() type operation on STRING1 and STRING2, ignoring any
  39    differences in whitespace.  Returns 0 if they match, non-zero if
  40    they don't (slightly different than strcmp()'s range of return
  41    values).  */
  42   NORMAL,
  43
  44   /* Like NORMAL, but also apply the strcmp_iw hack.  I.e.,
  45      string1=="FOO(PARAMS)" matches string2=="FOO".  */
  46   MATCH_PARAMS,
  47 };
  48
  49 /* Helper for strcmp_iw and strncmp_iw.  Exported so that languages
  50    can implement both NORMAL and MATCH_PARAMS variants in a single
  51    function and defer part of the work to strncmp_iw_with_mode.  */
  52 extern int strncmp_iw_with_mode (const char *string1,
  53                                  const char *string2,
  54                                  size_t string2_len,
  55                                  strncmp_iw_mode mode);
  56
  57 /* Do a strncmp() type operation on STRING1 and STRING2, ignoring any
  58    differences in whitespace.  STRING2_LEN is STRING2's length.
  59    Returns 0 if STRING1 matches STRING2_LEN characters of STRING2,
  60    non-zero otherwise (slightly different than strncmp()'s range of
  61    return values).  */
  62 extern int strncmp_iw (const char *string1, const char *string2,
  63                        size_t string2_len);
  64
  65 /* Do a strcmp() type operation on STRING1 and STRING2, ignoring any
  66    differences in whitespace.  Returns 0 if they match, non-zero if
  67    they don't (slightly different than strcmp()'s range of return
  68    values).
  69
  70    As an extra hack, string1=="FOO(ARGS)" matches string2=="FOO".
  71    This "feature" is useful when searching for matching C++ function
  72    names (such as if the user types 'break FOO', where FOO is a
  73    mangled C++ function).  */
  74 extern int strcmp_iw (const char *string1, const char *string2);
  75
  76 extern int strcmp_iw_ordered (const char *, const char *);
  77
  78 extern int streq (const char *, const char *);
  79
  80 extern int subset_compare (const char *, const char *);
  81
  82 int compare_positive_ints (const void *ap, const void *bp);
  83 int compare_strings (const void *ap, const void *bp);
  84
  85 /* Compare C strings for std::sort.  */
  86
  87 static inline bool
  88 compare_cstrings (const char *str1, const char *str2)
  89 {
  90   return strcmp (str1, str2) < 0;
  91 }
  92
  93 /* A wrapper for bfd_errmsg to produce a more helpful error message
  94    in the case of bfd_error_file_ambiguously recognized.
  95    MATCHING, if non-NULL, is the corresponding argument to
  96    bfd_check_format_matches, and will be freed.  */
  97
  98 extern const char *gdb_bfd_errmsg (bfd_error_type error_tag, char **matching);
  99
 100 /* Reset the prompt_for_continue clock.  */
 101 void reset_prompt_for_continue_wait_time (void);
 102 /* Return the time spent in prompt_for_continue.  */
 103 std::chrono::steady_clock::duration get_prompt_for_continue_wait_time ();
 104 \f
 105 /* Parsing utilites.  */
 106
 107 extern int parse_pid_to_attach (const char *args);
 108
 109 extern int parse_escape (struct gdbarch *, const char **);
 110
 111 /* A wrapper for an array of char* that was allocated in the way that
 112    'buildargv' does, and should be freed with 'freeargv'.  */
 113
 114 class gdb_argv
 115 {
 116 public:
 117
 118   /* A constructor that initializes to NULL.  */
 119
 120   gdb_argv ()
 121     : m_argv (NULL)
 122   {
 123   }
 124
 125   /* A constructor that calls buildargv on STR.  STR may be NULL, in
 126      which case this object is initialized with a NULL array.  If
 127      buildargv fails due to out-of-memory, call malloc_failure.
 128      Therefore, the value is guaranteed to be non-NULL, unless the
 129      parameter itself is NULL.  */
 130
 131   explicit gdb_argv (const char *str)
 132     : m_argv (NULL)
 133   {
 134     reset (str);
 135   }
 136
 137   /* A constructor that takes ownership of an existing array.  */
 138
 139   explicit gdb_argv (char **array)
 140     : m_argv (array)
 141   {
 142   }
 143
 144   gdb_argv (const gdb_argv &) = delete;
 145   gdb_argv &operator= (const gdb_argv &) = delete;
 146
 147   ~gdb_argv ()
 148   {
 149     freeargv (m_argv);
 150   }
 151
 152   /* Call buildargv on STR, storing the result in this object.  Any
 153      previous state is freed.  STR may be NULL, in which case this
 154      object is reset with a NULL array.  If buildargv fails due to
 155      out-of-memory, call malloc_failure.  Therefore, the value is
 156      guaranteed to be non-NULL, unless the parameter itself is
 157      NULL.  */
 158
 159   void reset (const char *str);
 160
 161   /* Return the underlying array.  */
 162
 163   char **get ()
 164   {
 165     return m_argv;
 166   }
 167
 168   /* Return the underlying array, transferring ownership to the
 169      caller.  */
 170
 171   char **release ()
 172   {
 173     char **result = m_argv;
 174     m_argv = NULL;
 175     return result;
 176   }
 177
 178   /* Return the number of items in the array.  */
 179
 180   int count () const
 181   {
 182     return countargv (m_argv);
 183   }
 184
 185   /* Index into the array.  */
 186
 187   char *operator[] (int arg)
 188   {
 189     gdb_assert (m_argv != NULL);
 190     return m_argv[arg];
 191   }
 192
 193   /* The iterator type.  */
 194
 195   typedef char **iterator;
 196
 197   /* Return an iterator pointing to the start of the array.  */
 198
 199   iterator begin ()
 200   {
 201     return m_argv;
 202   }
 203
 204   /* Return an iterator pointing to the end of the array.  */
 205
 206   iterator end ()
 207   {
 208     return m_argv + count ();
 209   }
 210
 211   bool operator!= (std::nullptr_t)
 212   {
 213     return m_argv != NULL;
 214   }
 215
 216   bool operator== (std::nullptr_t)
 217   {
 218     return m_argv == NULL;
 219   }
 220
 221 private:
 222
 223   /* The wrapped array.  */
 224
 225   char **m_argv;
 226 };
 227
 228 \f
 229 /* Cleanup utilities.  */
 230
 231 struct section_addr_info;
 232 extern struct cleanup *make_cleanup_free_section_addr_info
 233                        (struct section_addr_info *);
 234
 235 /* For make_cleanup_close see common/filestuff.h.  */
 236
 237 struct target_ops;
 238 extern struct cleanup *make_cleanup_unpush_target (struct target_ops *ops);
 239
 240 extern struct cleanup *make_cleanup_value_free_to_mark (struct value *);
 241
 242 /* A deleter for a hash table.  */
 243 struct htab_deleter
 244 {
 245   void operator() (htab *ptr) const
 246   {
 247     htab_delete (ptr);
 248   }
 249 };
 250
 251 /* A unique_ptr wrapper for htab_t.  */
 252 typedef std::unique_ptr<htab, htab_deleter> htab_up;
 253
 254 extern void free_current_contents (void *);
 255
 256 extern void init_page_info (void);
 257
 258 /* Temporarily set BATCH_FLAG and the associated unlimited terminal size.
 259    Restore when destroyed.  */
 260
 261 struct set_batch_flag_and_restore_page_info
 262 {
 263 public:
 264
 265   set_batch_flag_and_restore_page_info ();
 266   ~set_batch_flag_and_restore_page_info ();
 267
 268   DISABLE_COPY_AND_ASSIGN (set_batch_flag_and_restore_page_info);
 269
 270 private:
 271
 272   /* Note that this doesn't use scoped_restore, because it's important
 273      to control the ordering of operations in the destruction, and it
 274      was simpler to avoid introducing a new ad hoc class.  */
 275   unsigned m_save_lines_per_page;
 276   unsigned m_save_chars_per_line;
 277   int m_save_batch_flag;
 278 };
 279
 280 extern struct cleanup *make_bpstat_clear_actions_cleanup (void);
 281 \f
 282 /* Path utilities.  */
 283
 284 extern gdb::unique_xmalloc_ptr<char> gdb_realpath (const char *);
 285
 286 extern gdb::unique_xmalloc_ptr<char> gdb_realpath_keepfile (const char *);
 287
 288 extern gdb::unique_xmalloc_ptr<char> gdb_abspath (const char *);
 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 int 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.  */
 353
 354 extern void fputs_filtered (const char *, struct ui_file *);
 355
 356 extern void fputs_unfiltered (const char *, struct ui_file *);
 357
 358 extern int fputc_filtered (int c, struct ui_file *);
 359
 360 extern int fputc_unfiltered (int c, struct ui_file *);
 361
 362 extern int putchar_filtered (int c);
 363
 364 extern int putchar_unfiltered (int c);
 365
 366 extern void puts_filtered (const char *);
 367
 368 extern void puts_unfiltered (const char *);
 369
 370 extern void puts_filtered_tabular (char *string, int width, int right);
 371
 372 extern void puts_debug (char *prefix, char *string, char *suffix);
 373
 374 extern void vprintf_filtered (const char *, va_list) ATTRIBUTE_PRINTF (1, 0);
 375
 376 extern void vfprintf_filtered (struct ui_file *, const char *, va_list)
 377   ATTRIBUTE_PRINTF (2, 0);
 378
 379 extern void fprintf_filtered (struct ui_file *, const char *, ...)
 380   ATTRIBUTE_PRINTF (2, 3);
 381
 382 extern void fprintfi_filtered (int, struct ui_file *, const char *, ...)
 383   ATTRIBUTE_PRINTF (3, 4);
 384
 385 extern void printf_filtered (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
 386
 387 extern void printfi_filtered (int, const char *, ...) ATTRIBUTE_PRINTF (2, 3);
 388
 389 extern void vprintf_unfiltered (const char *, va_list) ATTRIBUTE_PRINTF (1, 0);
 390
 391 extern void vfprintf_unfiltered (struct ui_file *, const char *, va_list)
 392   ATTRIBUTE_PRINTF (2, 0);
 393
 394 extern void fprintf_unfiltered (struct ui_file *, const char *, ...)
 395   ATTRIBUTE_PRINTF (2, 3);
 396
 397 extern void printf_unfiltered (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
 398
 399 extern void print_spaces (int, struct ui_file *);
 400
 401 extern void print_spaces_filtered (int, struct ui_file *);
 402
 403 extern char *n_spaces (int);
 404
 405 extern void fputstr_filtered (const char *str, int quotr,
 406                               struct ui_file * stream);
 407
 408 extern void fputstr_unfiltered (const char *str, int quotr,
 409                                 struct ui_file * stream);
 410
 411 extern void fputstrn_filtered (const char *str, int n, int quotr,
 412                                struct ui_file * stream);
 413
 414 extern void fputstrn_unfiltered (const char *str, int n, int quotr,
 415                                  struct ui_file * stream);
 416
 417 /* Return nonzero if filtered printing is initialized.  */
 418 extern int filtered_printing_initialized (void);
 419
 420 /* Display the host ADDR on STREAM formatted as ``0x%x''.  */
 421 extern void gdb_print_host_address_1 (const void *addr, struct ui_file *stream);
 422
 423 /* Wrapper that avoids adding a pointless cast to all callers.  */
 424 #define gdb_print_host_address(ADDR, STREAM) \
 425   gdb_print_host_address_1 ((const void *) ADDR, STREAM)
 426
 427 /* Convert CORE_ADDR to string in platform-specific manner.
 428    This is usually formatted similar to 0x%lx.  */
 429 extern const char *paddress (struct gdbarch *gdbarch, CORE_ADDR addr);
 430
 431 /* Return a string representation in hexadecimal notation of ADDRESS,
 432    which is suitable for printing.  */
 433
 434 extern const char *print_core_address (struct gdbarch *gdbarch,
 435                                        CORE_ADDR address);
 436
 437 /* Callback hash_f and eq_f for htab_create_alloc or htab_create_alloc_ex.  */
 438 extern hashval_t core_addr_hash (const void *ap);
 439 extern int core_addr_eq (const void *ap, const void *bp);
 440
 441 extern CORE_ADDR string_to_core_addr (const char *my_string);
 442
 443 extern void fprintf_symbol_filtered (struct ui_file *, const char *,
 444                                      enum language, int);
 445
 446 extern void throw_perror_with_name (enum errors errcode, const char *string)
 447   ATTRIBUTE_NORETURN;
 448
 449 extern void perror_warning_with_name (const char *string);
 450
 451 extern void print_sys_errmsg (const char *, int);
 452 \f
 453 /* Warnings and error messages.  */
 454
 455 extern void (*deprecated_error_begin_hook) (void);
 456
 457 /* Message to be printed before the warning message, when a warning occurs.  */
 458
 459 extern const char *warning_pre_print;
 460
 461 extern void error_stream (const string_file &) ATTRIBUTE_NORETURN;
 462
 463 extern void demangler_vwarning (const char *file, int line,
 464                                const char *, va_list ap)
 465      ATTRIBUTE_PRINTF (3, 0);
 466
 467 extern void demangler_warning (const char *file, int line,
 468                               const char *, ...) ATTRIBUTE_PRINTF (3, 4);
 469
 470 \f
 471 /* Misc. utilities.  */
 472
 473 /* Allocation and deallocation functions for the libiberty hash table
 474    which use obstacks.  */
 475 void *hashtab_obstack_allocate (void *data, size_t size, size_t count);
 476 void dummy_obstack_deallocate (void *object, void *data);
 477
 478 #ifdef HAVE_WAITPID
 479 extern pid_t wait_to_die_with_timeout (pid_t pid, int *status, int timeout);
 480 #endif
 481
 482 extern int myread (int, char *, int);
 483
 484 /* Ensure that V is aligned to an N byte boundary (B's assumed to be a
 485    power of 2).  Round up/down when necessary.  Examples of correct
 486    use include:
 487
 488    addr = align_up (addr, 8); -- VALUE needs 8 byte alignment
 489    write_memory (addr, value, len);
 490    addr += len;
 491
 492    and:
 493
 494    sp = align_down (sp - len, 16); -- Keep SP 16 byte aligned
 495    write_memory (sp, value, len);
 496
 497    Note that uses such as:
 498
 499    write_memory (addr, value, len);
 500    addr += align_up (len, 8);
 501
 502    and:
 503
 504    sp -= align_up (len, 8);
 505    write_memory (sp, value, len);
 506
 507    are typically not correct as they don't ensure that the address (SP
 508    or ADDR) is correctly aligned (relying on previous alignment to
 509    keep things right).  This is also why the methods are called
 510    "align_..." instead of "round_..." as the latter reads better with
 511    this incorrect coding style.  */
 512
 513 extern ULONGEST align_up (ULONGEST v, int n);
 514 extern ULONGEST align_down (ULONGEST v, int n);
 515
 516 /* Resource limits used by getrlimit and setrlimit.  */
 517
 518 enum resource_limit_kind
 519   {
 520     LIMIT_CUR,
 521     LIMIT_MAX
 522   };
 523
 524 /* Check whether GDB will be able to dump core using the dump_core
 525    function.  Returns zero if GDB cannot or should not dump core.
 526    If LIMIT_KIND is LIMIT_CUR the user's soft limit will be respected.
 527    If LIMIT_KIND is LIMIT_MAX only the hard limit will be respected.  */
 528
 529 extern int can_dump_core (enum resource_limit_kind limit_kind);
 530
 531 /* Print a warning that we cannot dump core.  */
 532
 533 extern void warn_cant_dump_core (const char *reason);
 534
 535 /* Dump core trying to increase the core soft limit to hard limit
 536    first.  */
 537
 538 extern void dump_core (void);
 539
 540 /* Return the hex string form of LENGTH bytes of DATA.
 541    Space for the result is malloc'd, caller must free.  */
 542
 543 extern char *make_hex_string (const gdb_byte *data, size_t length);
 544
 545 #endif /* UTILS_H */