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 char **gdb_buildargv (const char *);
  89
  90 /* A wrapper for an array of char* that was allocated in the way that
  91    'buildargv' does, and should be freed with 'freeargv'.  */
  92
  93 class gdb_argv
  94 {
  95 public:
  96
  97   /* A constructor that initializes to NULL.  */
  98
  99   gdb_argv ()
 100     : m_argv (NULL)
 101   {
 102   }
 103
 104   /* A constructor that calls buildargv on STR.  STR may be NULL, in
 105      which case this object is initialized with a NULL array.  If
 106      buildargv fails due to out-of-memory, call malloc_failure.
 107      Therefore, the value is guaranteed to be non-NULL, unless the
 108      parameter itself is NULL.  */
 109
 110   explicit gdb_argv (const char *str)
 111     : m_argv (NULL)
 112   {
 113     reset (str);
 114   }
 115
 116   /* A constructor that takes ownership of an existing array.  */
 117
 118   explicit gdb_argv (char **array)
 119     : m_argv (array)
 120   {
 121   }
 122
 123   gdb_argv (const gdb_argv &) = delete;
 124   gdb_argv &operator= (const gdb_argv &) = delete;
 125
 126   ~gdb_argv ()
 127   {
 128     freeargv (m_argv);
 129   }
 130
 131   /* Call buildargv on STR, storing the result in this object.  Any
 132      previous state is freed.  STR may be NULL, in which case this
 133      object is reset with a NULL array.  If buildargv fails due to
 134      out-of-memory, call malloc_failure.  Therefore, the value is
 135      guaranteed to be non-NULL, unless the parameter itself is
 136      NULL.  */
 137
 138   void reset (const char *str);
 139
 140   /* Return the underlying array.  */
 141
 142   char **get ()
 143   {
 144     return m_argv;
 145   }
 146
 147   /* Return the underlying array, transferring ownership to the
 148      caller.  */
 149
 150   char **release ()
 151   {
 152     char **result = m_argv;
 153     m_argv = NULL;
 154     return result;
 155   }
 156
 157   /* Return the number of items in the array.  */
 158
 159   int count () const
 160   {
 161     return countargv (m_argv);
 162   }
 163
 164   /* Index into the array.  */
 165
 166   char *operator[] (int arg)
 167   {
 168     gdb_assert (m_argv != NULL);
 169     return m_argv[arg];
 170   }
 171
 172   /* The iterator type.  */
 173
 174   typedef char **iterator;
 175
 176   /* Return an iterator pointing to the start of the array.  */
 177
 178   iterator begin ()
 179   {
 180     return m_argv;
 181   }
 182
 183   /* Return an iterator pointing to the end of the array.  */
 184
 185   iterator end ()
 186   {
 187     return m_argv + count ();
 188   }
 189
 190   bool operator!= (nullptr_t)
 191   {
 192     return m_argv != NULL;
 193   }
 194
 195   bool operator== (nullptr_t)
 196   {
 197     return m_argv == NULL;
 198   }
 199
 200 private:
 201
 202   /* The wrapped array.  */
 203
 204   char **m_argv;
 205 };
 206
 207 \f
 208 /* Cleanup utilities.  */
 209
 210 extern struct cleanup *make_cleanup_freeargv (char **);
 211
 212 struct ui_out;
 213 extern struct cleanup *
 214   make_cleanup_ui_out_redirect_pop (struct ui_out *uiout);
 215
 216 struct section_addr_info;
 217 extern struct cleanup *(make_cleanup_free_section_addr_info
 218                         (struct section_addr_info *));
 219
 220 /* For make_cleanup_close see common/filestuff.h.  */
 221
 222 extern struct cleanup *make_cleanup_restore_integer (int *variable);
 223 extern struct cleanup *make_cleanup_restore_uinteger (unsigned int *variable);
 224
 225 struct target_ops;
 226 extern struct cleanup *make_cleanup_unpush_target (struct target_ops *ops);
 227
 228 extern struct cleanup *make_cleanup_value_free_to_mark (struct value *);
 229 extern struct cleanup *make_cleanup_value_free (struct value *);
 230
 231 /* A deleter for a hash table.  */
 232 struct htab_deleter
 233 {
 234   void operator() (htab *ptr) const
 235   {
 236     htab_delete (ptr);
 237   }
 238 };
 239
 240 /* A unique_ptr wrapper for htab_t.  */
 241 typedef std::unique_ptr<htab, htab_deleter> htab_up;
 242
 243 struct parser_state;
 244 extern struct cleanup *make_cleanup_clear_parser_state
 245   (struct parser_state **p);
 246
 247 extern void free_current_contents (void *);
 248
 249 extern void init_page_info (void);
 250
 251 extern struct cleanup *make_cleanup_restore_page_info (void);
 252 extern struct cleanup *
 253   set_batch_flag_and_make_cleanup_restore_page_info (void);
 254
 255 extern struct cleanup *make_bpstat_clear_actions_cleanup (void);
 256 \f
 257 /* Path utilities.  */
 258
 259 extern char *gdb_realpath (const char *);
 260
 261 extern char *gdb_realpath_keepfile (const char *);
 262
 263 extern char *gdb_abspath (const char *);
 264
 265 extern int gdb_filename_fnmatch (const char *pattern, const char *string,
 266                                  int flags);
 267
 268 extern void substitute_path_component (char **stringp, const char *from,
 269                                        const char *to);
 270
 271 std::string ldirname (const char *filename);
 272
 273 extern int count_path_elements (const char *path);
 274
 275 extern const char *strip_leading_path_elements (const char *path, int n);
 276 \f
 277 /* GDB output, ui_file utilities.  */
 278
 279 struct ui_file;
 280
 281 extern int query (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
 282 extern int nquery (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
 283 extern int yquery (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
 284
 285 extern void begin_line (void);
 286
 287 extern void wrap_here (const char *);
 288
 289 extern void reinitialize_more_filter (void);
 290
 291 extern int pagination_enabled;
 292
 293 extern struct ui_file **current_ui_gdb_stdout_ptr (void);
 294 extern struct ui_file **current_ui_gdb_stdin_ptr (void);
 295 extern struct ui_file **current_ui_gdb_stderr_ptr (void);
 296 extern struct ui_file **current_ui_gdb_stdlog_ptr (void);
 297
 298 /* The current top level's ui_file streams.  */
 299
 300 /* Normal results */
 301 #define gdb_stdout (*current_ui_gdb_stdout_ptr ())
 302 /* Input stream */
 303 #define gdb_stdin (*current_ui_gdb_stdin_ptr ())
 304 /* Serious error notifications */
 305 #define gdb_stderr (*current_ui_gdb_stderr_ptr ())
 306 /* Log/debug/trace messages that should bypass normal stdout/stderr
 307    filtering.  For moment, always call this stream using
 308    *_unfiltered.  In the very near future that restriction shall be
 309    removed - either call shall be unfiltered.  (cagney 1999-06-13).  */
 310 #define gdb_stdlog (*current_ui_gdb_stdlog_ptr ())
 311
 312 /* Truly global ui_file streams.  These are all defined in main.c.  */
 313
 314 /* Target output that should bypass normal stdout/stderr filtering.
 315    For moment, always call this stream using *_unfiltered.  In the
 316    very near future that restriction shall be removed - either call
 317    shall be unfiltered.  (cagney 1999-07-02).  */
 318 extern struct ui_file *gdb_stdtarg;
 319 extern struct ui_file *gdb_stdtargerr;
 320 extern struct ui_file *gdb_stdtargin;
 321
 322 /* Set the screen dimensions to WIDTH and HEIGHT.  */
 323
 324 extern void set_screen_width_and_height (int width, int height);
 325
 326 /* More generic printf like operations.  Filtered versions may return
 327    non-locally on error.  */
 328
 329 extern void fputs_filtered (const char *, struct ui_file *);
 330
 331 extern void fputs_unfiltered (const char *, struct ui_file *);
 332
 333 extern int fputc_filtered (int c, struct ui_file *);
 334
 335 extern int fputc_unfiltered (int c, struct ui_file *);
 336
 337 extern int putchar_filtered (int c);
 338
 339 extern int putchar_unfiltered (int c);
 340
 341 extern void puts_filtered (const char *);
 342
 343 extern void puts_unfiltered (const char *);
 344
 345 extern void puts_filtered_tabular (char *string, int width, int right);
 346
 347 extern void puts_debug (char *prefix, char *string, char *suffix);
 348
 349 extern void vprintf_filtered (const char *, va_list) ATTRIBUTE_PRINTF (1, 0);
 350
 351 extern void vfprintf_filtered (struct ui_file *, const char *, va_list)
 352   ATTRIBUTE_PRINTF (2, 0);
 353
 354 extern void fprintf_filtered (struct ui_file *, const char *, ...)
 355   ATTRIBUTE_PRINTF (2, 3);
 356
 357 extern void fprintfi_filtered (int, struct ui_file *, const char *, ...)
 358   ATTRIBUTE_PRINTF (3, 4);
 359
 360 extern void printf_filtered (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
 361
 362 extern void printfi_filtered (int, const char *, ...) ATTRIBUTE_PRINTF (2, 3);
 363
 364 extern void vprintf_unfiltered (const char *, va_list) ATTRIBUTE_PRINTF (1, 0);
 365
 366 extern void vfprintf_unfiltered (struct ui_file *, const char *, va_list)
 367   ATTRIBUTE_PRINTF (2, 0);
 368
 369 extern void fprintf_unfiltered (struct ui_file *, const char *, ...)
 370   ATTRIBUTE_PRINTF (2, 3);
 371
 372 extern void printf_unfiltered (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
 373
 374 extern void print_spaces (int, struct ui_file *);
 375
 376 extern void print_spaces_filtered (int, struct ui_file *);
 377
 378 extern char *n_spaces (int);
 379
 380 extern void fputstr_filtered (const char *str, int quotr,
 381                               struct ui_file * stream);
 382
 383 extern void fputstr_unfiltered (const char *str, int quotr,
 384                                 struct ui_file * stream);
 385
 386 extern void fputstrn_filtered (const char *str, int n, int quotr,
 387                                struct ui_file * stream);
 388
 389 extern void fputstrn_unfiltered (const char *str, int n, int quotr,
 390                                  struct ui_file * stream);
 391
 392 /* Return nonzero if filtered printing is initialized.  */
 393 extern int filtered_printing_initialized (void);
 394
 395 /* Display the host ADDR on STREAM formatted as ``0x%x''.  */
 396 extern void gdb_print_host_address_1 (const void *addr, struct ui_file *stream);
 397
 398 /* Wrapper that avoids adding a pointless cast to all callers.  */
 399 #define gdb_print_host_address(ADDR, STREAM) \
 400   gdb_print_host_address_1 ((const void *) ADDR, STREAM)
 401
 402 /* Convert CORE_ADDR to string in platform-specific manner.
 403    This is usually formatted similar to 0x%lx.  */
 404 extern const char *paddress (struct gdbarch *gdbarch, CORE_ADDR addr);
 405
 406 /* Return a string representation in hexadecimal notation of ADDRESS,
 407    which is suitable for printing.  */
 408
 409 extern const char *print_core_address (struct gdbarch *gdbarch,
 410                                        CORE_ADDR address);
 411
 412 /* Callback hash_f and eq_f for htab_create_alloc or htab_create_alloc_ex.  */
 413 extern hashval_t core_addr_hash (const void *ap);
 414 extern int core_addr_eq (const void *ap, const void *bp);
 415
 416 extern CORE_ADDR string_to_core_addr (const char *my_string);
 417
 418 extern void fprintf_symbol_filtered (struct ui_file *, const char *,
 419                                      enum language, int);
 420
 421 extern void throw_perror_with_name (enum errors errcode, const char *string)
 422   ATTRIBUTE_NORETURN;
 423
 424 extern void perror_warning_with_name (const char *string);
 425
 426 extern void print_sys_errmsg (const char *, int);
 427 \f
 428 /* Warnings and error messages.  */
 429
 430 extern void (*deprecated_error_begin_hook) (void);
 431
 432 /* Message to be printed before the warning message, when a warning occurs.  */
 433
 434 extern const char *warning_pre_print;
 435
 436 extern void error_stream (const string_file &) ATTRIBUTE_NORETURN;
 437
 438 extern void demangler_vwarning (const char *file, int line,
 439                                const char *, va_list ap)
 440      ATTRIBUTE_PRINTF (3, 0);
 441
 442 extern void demangler_warning (const char *file, int line,
 443                               const char *, ...) ATTRIBUTE_PRINTF (3, 4);
 444
 445 \f
 446 /* Misc. utilities.  */
 447
 448 /* Allocation and deallocation functions for the libiberty hash table
 449    which use obstacks.  */
 450 void *hashtab_obstack_allocate (void *data, size_t size, size_t count);
 451 void dummy_obstack_deallocate (void *object, void *data);
 452
 453 #ifdef HAVE_WAITPID
 454 extern pid_t wait_to_die_with_timeout (pid_t pid, int *status, int timeout);
 455 #endif
 456
 457 extern int producer_is_gcc_ge_4 (const char *producer);
 458 extern int producer_is_gcc (const char *producer, int *major, int *minor);
 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 */