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