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