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 \f
  90 /* Cleanup utilities.  */
  91
  92 extern struct cleanup *make_cleanup_freeargv (char **);
  93
  94 struct ui_out;
  95 extern struct cleanup *
  96   make_cleanup_ui_out_redirect_pop (struct ui_out *uiout);
  97
  98 struct section_addr_info;
  99 extern struct cleanup *(make_cleanup_free_section_addr_info
 100                         (struct section_addr_info *));
 101
 102 /* For make_cleanup_close see common/filestuff.h.  */
 103
 104 extern struct cleanup *make_cleanup_fclose (FILE *file);
 105
 106 extern struct cleanup *make_cleanup_restore_integer (int *variable);
 107 extern struct cleanup *make_cleanup_restore_uinteger (unsigned int *variable);
 108
 109 struct target_ops;
 110 extern struct cleanup *make_cleanup_unpush_target (struct target_ops *ops);
 111
 112 extern struct cleanup *make_cleanup_value_free_to_mark (struct value *);
 113 extern struct cleanup *make_cleanup_value_free (struct value *);
 114
 115 struct so_list;
 116 extern struct cleanup *make_cleanup_free_so (struct so_list *so);
 117
 118 extern struct cleanup *make_cleanup_restore_current_language (void);
 119
 120 /* A deleter for a hash table.  */
 121 struct htab_deleter
 122 {
 123   void operator() (htab *ptr) const
 124   {
 125     htab_delete (ptr);
 126   }
 127 };
 128
 129 /* A unique_ptr wrapper for htab_t.  */
 130 typedef std::unique_ptr<htab, htab_deleter> htab_up;
 131
 132 struct parser_state;
 133 extern struct cleanup *make_cleanup_clear_parser_state
 134   (struct parser_state **p);
 135
 136 extern void free_current_contents (void *);
 137
 138 extern void init_page_info (void);
 139
 140 extern struct cleanup *make_cleanup_restore_page_info (void);
 141 extern struct cleanup *
 142   set_batch_flag_and_make_cleanup_restore_page_info (void);
 143
 144 extern struct cleanup *make_bpstat_clear_actions_cleanup (void);
 145 \f
 146 /* Path utilities.  */
 147
 148 extern char *gdb_realpath (const char *);
 149
 150 extern char *gdb_realpath_keepfile (const char *);
 151
 152 extern char *gdb_abspath (const char *);
 153
 154 extern int gdb_filename_fnmatch (const char *pattern, const char *string,
 155                                  int flags);
 156
 157 extern void substitute_path_component (char **stringp, const char *from,
 158                                        const char *to);
 159
 160 std::string ldirname (const char *filename);
 161
 162 extern int count_path_elements (const char *path);
 163
 164 extern const char *strip_leading_path_elements (const char *path, int n);
 165 \f
 166 /* GDB output, ui_file utilities.  */
 167
 168 struct ui_file;
 169
 170 extern int query (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
 171 extern int nquery (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
 172 extern int yquery (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
 173
 174 extern void begin_line (void);
 175
 176 extern void wrap_here (const char *);
 177
 178 extern void reinitialize_more_filter (void);
 179
 180 extern int pagination_enabled;
 181
 182 extern struct ui_file **current_ui_gdb_stdout_ptr (void);
 183 extern struct ui_file **current_ui_gdb_stdin_ptr (void);
 184 extern struct ui_file **current_ui_gdb_stderr_ptr (void);
 185 extern struct ui_file **current_ui_gdb_stdlog_ptr (void);
 186
 187 /* The current top level's ui_file streams.  */
 188
 189 /* Normal results */
 190 #define gdb_stdout (*current_ui_gdb_stdout_ptr ())
 191 /* Input stream */
 192 #define gdb_stdin (*current_ui_gdb_stdin_ptr ())
 193 /* Serious error notifications */
 194 #define gdb_stderr (*current_ui_gdb_stderr_ptr ())
 195 /* Log/debug/trace messages that should bypass normal stdout/stderr
 196    filtering.  For moment, always call this stream using
 197    *_unfiltered.  In the very near future that restriction shall be
 198    removed - either call shall be unfiltered.  (cagney 1999-06-13).  */
 199 #define gdb_stdlog (*current_ui_gdb_stdlog_ptr ())
 200
 201 /* Truly global ui_file streams.  These are all defined in main.c.  */
 202
 203 /* Target output that should bypass normal stdout/stderr filtering.
 204    For moment, always call this stream using *_unfiltered.  In the
 205    very near future that restriction shall be removed - either call
 206    shall be unfiltered.  (cagney 1999-07-02).  */
 207 extern struct ui_file *gdb_stdtarg;
 208 extern struct ui_file *gdb_stdtargerr;
 209 extern struct ui_file *gdb_stdtargin;
 210
 211 /* Set the screen dimensions to WIDTH and HEIGHT.  */
 212
 213 extern void set_screen_width_and_height (int width, int height);
 214
 215 /* More generic printf like operations.  Filtered versions may return
 216    non-locally on error.  */
 217
 218 extern void fputs_filtered (const char *, struct ui_file *);
 219
 220 extern void fputs_unfiltered (const char *, struct ui_file *);
 221
 222 extern int fputc_filtered (int c, struct ui_file *);
 223
 224 extern int fputc_unfiltered (int c, struct ui_file *);
 225
 226 extern int putchar_filtered (int c);
 227
 228 extern int putchar_unfiltered (int c);
 229
 230 extern void puts_filtered (const char *);
 231
 232 extern void puts_unfiltered (const char *);
 233
 234 extern void puts_filtered_tabular (char *string, int width, int right);
 235
 236 extern void puts_debug (char *prefix, char *string, char *suffix);
 237
 238 extern void vprintf_filtered (const char *, va_list) ATTRIBUTE_PRINTF (1, 0);
 239
 240 extern void vfprintf_filtered (struct ui_file *, const char *, va_list)
 241   ATTRIBUTE_PRINTF (2, 0);
 242
 243 extern void fprintf_filtered (struct ui_file *, const char *, ...)
 244   ATTRIBUTE_PRINTF (2, 3);
 245
 246 extern void fprintfi_filtered (int, struct ui_file *, const char *, ...)
 247   ATTRIBUTE_PRINTF (3, 4);
 248
 249 extern void printf_filtered (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
 250
 251 extern void printfi_filtered (int, const char *, ...) ATTRIBUTE_PRINTF (2, 3);
 252
 253 extern void vprintf_unfiltered (const char *, va_list) ATTRIBUTE_PRINTF (1, 0);
 254
 255 extern void vfprintf_unfiltered (struct ui_file *, const char *, va_list)
 256   ATTRIBUTE_PRINTF (2, 0);
 257
 258 extern void fprintf_unfiltered (struct ui_file *, const char *, ...)
 259   ATTRIBUTE_PRINTF (2, 3);
 260
 261 extern void printf_unfiltered (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
 262
 263 extern void print_spaces (int, struct ui_file *);
 264
 265 extern void print_spaces_filtered (int, struct ui_file *);
 266
 267 extern char *n_spaces (int);
 268
 269 extern void fputstr_filtered (const char *str, int quotr,
 270                               struct ui_file * stream);
 271
 272 extern void fputstr_unfiltered (const char *str, int quotr,
 273                                 struct ui_file * stream);
 274
 275 extern void fputstrn_filtered (const char *str, int n, int quotr,
 276                                struct ui_file * stream);
 277
 278 extern void fputstrn_unfiltered (const char *str, int n, int quotr,
 279                                  struct ui_file * stream);
 280
 281 /* Return nonzero if filtered printing is initialized.  */
 282 extern int filtered_printing_initialized (void);
 283
 284 /* Display the host ADDR on STREAM formatted as ``0x%x''.  */
 285 extern void gdb_print_host_address_1 (const void *addr, struct ui_file *stream);
 286
 287 /* Wrapper that avoids adding a pointless cast to all callers.  */
 288 #define gdb_print_host_address(ADDR, STREAM) \
 289   gdb_print_host_address_1 ((const void *) ADDR, STREAM)
 290
 291 /* Convert CORE_ADDR to string in platform-specific manner.
 292    This is usually formatted similar to 0x%lx.  */
 293 extern const char *paddress (struct gdbarch *gdbarch, CORE_ADDR addr);
 294
 295 /* Return a string representation in hexadecimal notation of ADDRESS,
 296    which is suitable for printing.  */
 297
 298 extern const char *print_core_address (struct gdbarch *gdbarch,
 299                                        CORE_ADDR address);
 300
 301 /* Callback hash_f and eq_f for htab_create_alloc or htab_create_alloc_ex.  */
 302 extern hashval_t core_addr_hash (const void *ap);
 303 extern int core_addr_eq (const void *ap, const void *bp);
 304
 305 extern CORE_ADDR string_to_core_addr (const char *my_string);
 306
 307 extern void fprintf_symbol_filtered (struct ui_file *, const char *,
 308                                      enum language, int);
 309
 310 extern void throw_perror_with_name (enum errors errcode, const char *string)
 311   ATTRIBUTE_NORETURN;
 312
 313 extern void perror_warning_with_name (const char *string);
 314
 315 extern void print_sys_errmsg (const char *, int);
 316 \f
 317 /* Warnings and error messages.  */
 318
 319 extern void (*deprecated_error_begin_hook) (void);
 320
 321 /* Message to be printed before the warning message, when a warning occurs.  */
 322
 323 extern const char *warning_pre_print;
 324
 325 extern void error_stream (const string_file &) ATTRIBUTE_NORETURN;
 326
 327 extern void demangler_vwarning (const char *file, int line,
 328                                const char *, va_list ap)
 329      ATTRIBUTE_PRINTF (3, 0);
 330
 331 extern void demangler_warning (const char *file, int line,
 332                               const char *, ...) ATTRIBUTE_PRINTF (3, 4);
 333
 334 \f
 335 /* Misc. utilities.  */
 336
 337 /* Allocation and deallocation functions for the libiberty hash table
 338    which use obstacks.  */
 339 void *hashtab_obstack_allocate (void *data, size_t size, size_t count);
 340 void dummy_obstack_deallocate (void *object, void *data);
 341
 342 #ifdef HAVE_WAITPID
 343 extern pid_t wait_to_die_with_timeout (pid_t pid, int *status, int timeout);
 344 #endif
 345
 346 extern int producer_is_gcc_ge_4 (const char *producer);
 347 extern int producer_is_gcc (const char *producer, int *major, int *minor);
 348
 349 extern int myread (int, char *, int);
 350
 351 /* Ensure that V is aligned to an N byte boundary (B's assumed to be a
 352    power of 2).  Round up/down when necessary.  Examples of correct
 353    use include:
 354
 355    addr = align_up (addr, 8); -- VALUE needs 8 byte alignment
 356    write_memory (addr, value, len);
 357    addr += len;
 358
 359    and:
 360
 361    sp = align_down (sp - len, 16); -- Keep SP 16 byte aligned
 362    write_memory (sp, value, len);
 363
 364    Note that uses such as:
 365
 366    write_memory (addr, value, len);
 367    addr += align_up (len, 8);
 368
 369    and:
 370
 371    sp -= align_up (len, 8);
 372    write_memory (sp, value, len);
 373
 374    are typically not correct as they don't ensure that the address (SP
 375    or ADDR) is correctly aligned (relying on previous alignment to
 376    keep things right).  This is also why the methods are called
 377    "align_..." instead of "round_..." as the latter reads better with
 378    this incorrect coding style.  */
 379
 380 extern ULONGEST align_up (ULONGEST v, int n);
 381 extern ULONGEST align_down (ULONGEST v, int n);
 382
 383 /* Resource limits used by getrlimit and setrlimit.  */
 384
 385 enum resource_limit_kind
 386   {
 387     LIMIT_CUR,
 388     LIMIT_MAX
 389   };
 390
 391 /* Check whether GDB will be able to dump core using the dump_core
 392    function.  Returns zero if GDB cannot or should not dump core.
 393    If LIMIT_KIND is LIMIT_CUR the user's soft limit will be respected.
 394    If LIMIT_KIND is LIMIT_MAX only the hard limit will be respected.  */
 395
 396 extern int can_dump_core (enum resource_limit_kind limit_kind);
 397
 398 /* Print a warning that we cannot dump core.  */
 399
 400 extern void warn_cant_dump_core (const char *reason);
 401
 402 /* Dump core trying to increase the core soft limit to hard limit
 403    first.  */
 404
 405 extern void dump_core (void);
 406
 407 /* Return the hex string form of LENGTH bytes of DATA.
 408    Space for the result is malloc'd, caller must free.  */
 409
 410 extern char *make_hex_string (const gdb_byte *data, size_t length);
 411
 412 #endif /* UTILS_H */