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