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