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
 219 /* A deleter for a hash table.  */
 220 struct htab_deleter
 221 {
 222   void operator() (htab *ptr) const
 223   {
 224     htab_delete (ptr);
 225   }
 226 };
 227
 228 /* A unique_ptr wrapper for htab_t.  */
 229 typedef std::unique_ptr<htab, htab_deleter> htab_up;
 230
 231 extern void free_current_contents (void *);
 232
 233 extern void init_page_info (void);
 234
 235 /* Temporarily set BATCH_FLAG and the associated unlimited terminal size.
 236    Restore when destroyed.  */
 237
 238 struct set_batch_flag_and_restore_page_info
 239 {
 240 public:
 241
 242   set_batch_flag_and_restore_page_info ();
 243   ~set_batch_flag_and_restore_page_info ();
 244
 245   DISABLE_COPY_AND_ASSIGN (set_batch_flag_and_restore_page_info);
 246
 247 private:
 248
 249   /* Note that this doesn't use scoped_restore, because it's important
 250      to control the ordering of operations in the destruction, and it
 251      was simpler to avoid introducing a new ad hoc class.  */
 252   unsigned m_save_lines_per_page;
 253   unsigned m_save_chars_per_line;
 254   int m_save_batch_flag;
 255 };
 256
 257 extern struct cleanup *make_bpstat_clear_actions_cleanup (void);
 258 \f
 259 /* Path utilities.  */
 260
 261 extern gdb::unique_xmalloc_ptr<char> gdb_realpath (const char *);
 262
 263 extern gdb::unique_xmalloc_ptr<char> gdb_realpath_keepfile (const char *);
 264
 265 extern gdb::unique_xmalloc_ptr<char> gdb_abspath (const char *);
 266
 267 extern int gdb_filename_fnmatch (const char *pattern, const char *string,
 268                                  int flags);
 269
 270 extern void substitute_path_component (char **stringp, const char *from,
 271                                        const char *to);
 272
 273 std::string ldirname (const char *filename);
 274
 275 extern int count_path_elements (const char *path);
 276
 277 extern const char *strip_leading_path_elements (const char *path, int n);
 278 \f
 279 /* GDB output, ui_file utilities.  */
 280
 281 struct ui_file;
 282
 283 extern int query (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
 284 extern int nquery (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
 285 extern int yquery (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
 286
 287 extern void begin_line (void);
 288
 289 extern void wrap_here (const char *);
 290
 291 extern void reinitialize_more_filter (void);
 292
 293 extern int pagination_enabled;
 294
 295 extern struct ui_file **current_ui_gdb_stdout_ptr (void);
 296 extern struct ui_file **current_ui_gdb_stdin_ptr (void);
 297 extern struct ui_file **current_ui_gdb_stderr_ptr (void);
 298 extern struct ui_file **current_ui_gdb_stdlog_ptr (void);
 299
 300 /* The current top level's ui_file streams.  */
 301
 302 /* Normal results */
 303 #define gdb_stdout (*current_ui_gdb_stdout_ptr ())
 304 /* Input stream */
 305 #define gdb_stdin (*current_ui_gdb_stdin_ptr ())
 306 /* Serious error notifications */
 307 #define gdb_stderr (*current_ui_gdb_stderr_ptr ())
 308 /* Log/debug/trace messages that should bypass normal stdout/stderr
 309    filtering.  For moment, always call this stream using
 310    *_unfiltered.  In the very near future that restriction shall be
 311    removed - either call shall be unfiltered.  (cagney 1999-06-13).  */
 312 #define gdb_stdlog (*current_ui_gdb_stdlog_ptr ())
 313
 314 /* Truly global ui_file streams.  These are all defined in main.c.  */
 315
 316 /* Target output that should bypass normal stdout/stderr filtering.
 317    For moment, always call this stream using *_unfiltered.  In the
 318    very near future that restriction shall be removed - either call
 319    shall be unfiltered.  (cagney 1999-07-02).  */
 320 extern struct ui_file *gdb_stdtarg;
 321 extern struct ui_file *gdb_stdtargerr;
 322 extern struct ui_file *gdb_stdtargin;
 323
 324 /* Set the screen dimensions to WIDTH and HEIGHT.  */
 325
 326 extern void set_screen_width_and_height (int width, int height);
 327
 328 /* More generic printf like operations.  Filtered versions may return
 329    non-locally on error.  */
 330
 331 extern void fputs_filtered (const char *, struct ui_file *);
 332
 333 extern void fputs_unfiltered (const char *, struct ui_file *);
 334
 335 extern int fputc_filtered (int c, struct ui_file *);
 336
 337 extern int fputc_unfiltered (int c, struct ui_file *);
 338
 339 extern int putchar_filtered (int c);
 340
 341 extern int putchar_unfiltered (int c);
 342
 343 extern void puts_filtered (const char *);
 344
 345 extern void puts_unfiltered (const char *);
 346
 347 extern void puts_filtered_tabular (char *string, int width, int right);
 348
 349 extern void puts_debug (char *prefix, char *string, char *suffix);
 350
 351 extern void vprintf_filtered (const char *, va_list) ATTRIBUTE_PRINTF (1, 0);
 352
 353 extern void vfprintf_filtered (struct ui_file *, const char *, va_list)
 354   ATTRIBUTE_PRINTF (2, 0);
 355
 356 extern void fprintf_filtered (struct ui_file *, const char *, ...)
 357   ATTRIBUTE_PRINTF (2, 3);
 358
 359 extern void fprintfi_filtered (int, struct ui_file *, const char *, ...)
 360   ATTRIBUTE_PRINTF (3, 4);
 361
 362 extern void printf_filtered (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
 363
 364 extern void printfi_filtered (int, const char *, ...) ATTRIBUTE_PRINTF (2, 3);
 365
 366 extern void vprintf_unfiltered (const char *, va_list) ATTRIBUTE_PRINTF (1, 0);
 367
 368 extern void vfprintf_unfiltered (struct ui_file *, const char *, va_list)
 369   ATTRIBUTE_PRINTF (2, 0);
 370
 371 extern void fprintf_unfiltered (struct ui_file *, const char *, ...)
 372   ATTRIBUTE_PRINTF (2, 3);
 373
 374 extern void printf_unfiltered (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
 375
 376 extern void print_spaces (int, struct ui_file *);
 377
 378 extern void print_spaces_filtered (int, struct ui_file *);
 379
 380 extern char *n_spaces (int);
 381
 382 extern void fputstr_filtered (const char *str, int quotr,
 383                               struct ui_file * stream);
 384
 385 extern void fputstr_unfiltered (const char *str, int quotr,
 386                                 struct ui_file * stream);
 387
 388 extern void fputstrn_filtered (const char *str, int n, int quotr,
 389                                struct ui_file * stream);
 390
 391 extern void fputstrn_unfiltered (const char *str, int n, int quotr,
 392                                  struct ui_file * stream);
 393
 394 /* Return nonzero if filtered printing is initialized.  */
 395 extern int filtered_printing_initialized (void);
 396
 397 /* Display the host ADDR on STREAM formatted as ``0x%x''.  */
 398 extern void gdb_print_host_address_1 (const void *addr, struct ui_file *stream);
 399
 400 /* Wrapper that avoids adding a pointless cast to all callers.  */
 401 #define gdb_print_host_address(ADDR, STREAM) \
 402   gdb_print_host_address_1 ((const void *) ADDR, STREAM)
 403
 404 /* Convert CORE_ADDR to string in platform-specific manner.
 405    This is usually formatted similar to 0x%lx.  */
 406 extern const char *paddress (struct gdbarch *gdbarch, CORE_ADDR addr);
 407
 408 /* Return a string representation in hexadecimal notation of ADDRESS,
 409    which is suitable for printing.  */
 410
 411 extern const char *print_core_address (struct gdbarch *gdbarch,
 412                                        CORE_ADDR address);
 413
 414 /* Callback hash_f and eq_f for htab_create_alloc or htab_create_alloc_ex.  */
 415 extern hashval_t core_addr_hash (const void *ap);
 416 extern int core_addr_eq (const void *ap, const void *bp);
 417
 418 extern CORE_ADDR string_to_core_addr (const char *my_string);
 419
 420 extern void fprintf_symbol_filtered (struct ui_file *, const char *,
 421                                      enum language, int);
 422
 423 extern void throw_perror_with_name (enum errors errcode, const char *string)
 424   ATTRIBUTE_NORETURN;
 425
 426 extern void perror_warning_with_name (const char *string);
 427
 428 extern void print_sys_errmsg (const char *, int);
 429 \f
 430 /* Warnings and error messages.  */
 431
 432 extern void (*deprecated_error_begin_hook) (void);
 433
 434 /* Message to be printed before the warning message, when a warning occurs.  */
 435
 436 extern const char *warning_pre_print;
 437
 438 extern void error_stream (const string_file &) ATTRIBUTE_NORETURN;
 439
 440 extern void demangler_vwarning (const char *file, int line,
 441                                const char *, va_list ap)
 442      ATTRIBUTE_PRINTF (3, 0);
 443
 444 extern void demangler_warning (const char *file, int line,
 445                               const char *, ...) ATTRIBUTE_PRINTF (3, 4);
 446
 447 \f
 448 /* Misc. utilities.  */
 449
 450 /* Allocation and deallocation functions for the libiberty hash table
 451    which use obstacks.  */
 452 void *hashtab_obstack_allocate (void *data, size_t size, size_t count);
 453 void dummy_obstack_deallocate (void *object, void *data);
 454
 455 #ifdef HAVE_WAITPID
 456 extern pid_t wait_to_die_with_timeout (pid_t pid, int *status, int timeout);
 457 #endif
 458
 459 extern int myread (int, char *, int);
 460
 461 /* Ensure that V is aligned to an N byte boundary (B's assumed to be a
 462    power of 2).  Round up/down when necessary.  Examples of correct
 463    use include:
 464
 465    addr = align_up (addr, 8); -- VALUE needs 8 byte alignment
 466    write_memory (addr, value, len);
 467    addr += len;
 468
 469    and:
 470
 471    sp = align_down (sp - len, 16); -- Keep SP 16 byte aligned
 472    write_memory (sp, value, len);
 473
 474    Note that uses such as:
 475
 476    write_memory (addr, value, len);
 477    addr += align_up (len, 8);
 478
 479    and:
 480
 481    sp -= align_up (len, 8);
 482    write_memory (sp, value, len);
 483
 484    are typically not correct as they don't ensure that the address (SP
 485    or ADDR) is correctly aligned (relying on previous alignment to
 486    keep things right).  This is also why the methods are called
 487    "align_..." instead of "round_..." as the latter reads better with
 488    this incorrect coding style.  */
 489
 490 extern ULONGEST align_up (ULONGEST v, int n);
 491 extern ULONGEST align_down (ULONGEST v, int n);
 492
 493 /* Resource limits used by getrlimit and setrlimit.  */
 494
 495 enum resource_limit_kind
 496   {
 497     LIMIT_CUR,
 498     LIMIT_MAX
 499   };
 500
 501 /* Check whether GDB will be able to dump core using the dump_core
 502    function.  Returns zero if GDB cannot or should not dump core.
 503    If LIMIT_KIND is LIMIT_CUR the user's soft limit will be respected.
 504    If LIMIT_KIND is LIMIT_MAX only the hard limit will be respected.  */
 505
 506 extern int can_dump_core (enum resource_limit_kind limit_kind);
 507
 508 /* Print a warning that we cannot dump core.  */
 509
 510 extern void warn_cant_dump_core (const char *reason);
 511
 512 /* Dump core trying to increase the core soft limit to hard limit
 513    first.  */
 514
 515 extern void dump_core (void);
 516
 517 /* Return the hex string form of LENGTH bytes of DATA.
 518    Space for the result is malloc'd, caller must free.  */
 519
 520 extern char *make_hex_string (const gdb_byte *data, size_t length);
 521
 522 #endif /* UTILS_H */